Merge pull request #16 from ITArray/1.4.2-documentation

1.4.2 documentation

Author: dzaiats

readme.md

@@ -1,7 +1,7 @@
-[![Build Status](https://travis-ci.org/ITArray/Automotion.svg?branch=1.4.2-update)](https://travis-ci.org/ITArray/Automotion)
+[![Build Status](https://travis-ci.org/ITArray/Automotion.svg?branch=master)](https://travis-ci.org/ITArray/Automotion)
 
 # Automotion #
-![alt tag](http://visual.itarray.net/images/Automotion.jpg)
+![alt tag](https://www.itarray.net/wp-content/uploads/2016/12/Automotion-2.jpg)
 
 ##### Example: https://github.com/ITArray/automotion-example
 ### Steps to connect ###
@@ -40,12 +40,12 @@
     * For Web local run:       
 
             IS_LOCAL=True
-            BROWSER=Firefox|Chrome|IE|Safari
+            BROWSER=Firefox|Chrome|IE|Safari|EDGE
 
     * For Web remote run:
 
             IS_REMOTE=True
-            BROWSER=Firefox|Chrome|IE|Safari
+            BROWSER=Firefox|Chrome|IE|Safari|EDGE
             EXECUTOR=http://{host}:{port}/wd/hub
             (optional available with Chrome only) MOBILE_DEVICE_EMULATION=Google Nexus 5|Apple iPhone 6|Samsung Galaxy S5
 
@@ -79,10 +79,10 @@
             EXECUTOR=http://{host}:{port}/wd/hub
             DEVICE=Device name or ID
 
-### Possibilities ###
+### Responsive UI Validation ###
  - Responsive UI Validator allows to validate UI on web or mobile page using lots of criterias. Also it allows tu build thr HTMl report after validation.
 
-            ResponsiveUIValidator uiValidator = new    ResponsiveUIValidator(driver);
+            ResponsiveUIValidator uiValidator = new ResponsiveUIValidator(driver);
 
 
             boolean result = uiValidator.init()
@@ -106,7 +106,146 @@
 
 
             uiValidator.generateReport();
+            
+ - Description for each methods available in the framework:
+    
+    * Init method:
+    
+            init(); // Method that defines start of new validation. Needs to be called each time before calling findElement(), findElements()
+            
+            init("Scenario name"); // Method that defines start of new validation with specified name of scenario. Needs to be called each time before calling findElement(), findElements()
+            
+            setColorForRootElement(Color color); // Set color for main element. This color will be used for highlighting element in results
+            
+            setColorForHighlightedElements(Color color); // Set color for compared elements. This color will be used for highlighting elements in results
+            
+            setLinesColor(Color color); // Set color for grid lines. This color will be used for the lines of alignment grid in results
+            
+            findElement(WebElement element, String readableNameOfElement); // Main method to specify which element we want to validate (can be called only findElement() OR findElements() for single validation)
+            
+            findElements(List<WebElement> elements); // Main method to specify the list of elements that we want to validate (can be called only findElement() OR findElements() for single validation)
+    
+    * For single element findElement({element}, "name"):
+    
+            insideOf(WebElement containerElement, String readableContainerName); // Verify that element is located inside of specified element
+         
+            withLeftElement(WebElement element); // Verify that element which located left to is correct
+        
+            withLeftElement(WebElement element, int minMargin, int maxMargin); // Verify that element which located left to is correct with specified margins
+        
+            withRightElement(WebElement element); // Verify that element which located right to is correct
+        
+            withRightElement(WebElement element, int minMargin, int maxMargin); // Verify that element which located right to is correct with specified margins
+        
+            withTopElement(WebElement element); // Verify that element which located top to is correct
+        
+            withTopElement(WebElement element, int minMargin, int maxMargin); // Verify that element which located top to is correct with specified margins
+        
+            withBottomElement(WebElement element); // Verify that element which located bottom to is correct
+        
+            withBottomElement(WebElement element, int minMargin, int maxMargin); // Verify that element which located bottom to is correct with specified margins
+        
+            notOverlapWith(WebElement element, String readableName); // Verify that element is NOT overlapped with specified element
+        
+            overlapWith(WebElement element, String readableName); // Verify that element is overlapped with specified element
+        
+            notOverlapWith(List<WebElement> elements); // Verify that element is NOT overlapped with every element is the list
+        
+            sameOffsetLeftAs(WebElement element, String readableName); // Verify that element has the same left offset as specified element
+        
+            sameOffsetLeftAs(List<WebElement> elements); // Verify that element has the same left offset as every element is the list
+        
+            sameOffsetRightAs(WebElement element, String readableName); // Verify that element has the same right offset as specified element
+        
+            sameOffsetRightAs(List<WebElement> elements); // Verify that element has the same right offset as every element is the list
+        
+            sameOffsetTopAs(WebElement element, String readableName); // Verify that element has the same top offset as specified element
+        
+            sameOffsetTopAs(List<WebElement> elements); // Verify that element has the same top offset as every element is the list
+        
+            sameOffsetBottomAs(WebElement element, String readableName); // Verify that element has the same bottom offset as specified element
+        
+            sameOffsetBottomAs(List<WebElement> elements); // Verify that element has the same bottom offset as every element is the list
+        
+            sameWidthAs(WebElement element, String readableName); // Verify that element has the same width as specified element
+        
+            sameWidthAs(List<WebElement> elements); // Verify that element has the same width as every element in the list
+        
+            minWidth(int width); // Verify that width of element is not less than specified
+        
+            maxWidth(int width); // Verify that width of element is not bigger than specified
+        
+            widthBetween(int min, int max); // Verify that width of element is in range
+        
+            sameHeightAs(WebElement element, String readableName); // Verify that element has the same height as specified element
+        
+            sameHeightAs(List<WebElement> elements); // Verify that element has the same height as every element in the list
+        
+            minHeight(int height); // Verify that height of element is not less than specified
+        
+            maxHeight(int height); // Verify that height of element is not bigger than specified
+        
+            sameSizeAs(WebElement element, String readableName); // Verify that element has the same size as specified element
+        
+            sameSizeAs(List<WebElement> elements); // Verify that element has the same size as every element in the list
+        
+            heightBetween(int min, int max); // Verify that height of element is in range
+        
+            minOffset(int top, int right, int bottom, int left); // Verify that min offset of element is not less than (min value is -10000)
+        
+            maxOffset(int top, int right, int bottom, int left); // Verify that max offset of element is not bigger than (min value is -10000)
+        
+            withCssValue(String cssProperty, String... args); // Verify that element has correct CSS values
+        
+            withoutCssValue(String cssProperty, String... args); // Verify that concrete CSS values are absent for specified element
+        
+            equalLeftRightOffset(); // Verify that element has equal left and right offsets (e.g. Bootstrap container)
+        
+            equalTopBottomOffset(); // Verify that element has equal top and bottom offset (aligned vertically in center)
+         
+            changeMetricsUnitsTo(ResponsiveUIValidator.Units units); // Change units to Pixels or % (Units.PX, Units.PERCENT)
+
+    * For list of elements findElements({element}):
+            
+            insideOf(WebElement containerElement, String readableContainerName); // Verify that elements are located inside of specified element
+            
+            alignedAsGrid(int horizontalGridSize); // Verify that elements are aligned in a grid view width specified amount of columns
+            
+            alignedAsGrid(int horizontalGridSize, int verticalGridSize); // Verify that elements are aligned in a grid view width specified amount of columns and rows
+            
+            areNotOverlappedWithEachOther(); // Verify that every element in the list is not overlapped with another element from this list
+            
+            withSameSize(); // Verify that elements in the list have the same size
+            
+            withSameWidth(); // Verify that elements in the list have the same width
+            
+            withSameHeight(); // Verify that elements in the list have the same height
+            
+            sameRightOffset(); // Verify that elements in the list have the right offset
+            
+            sameLeftOffset(); // Verify that elements in the list have the same left offset
+            
+            sameTopOffset(); // Verify that elements in the list have the same top offset
+            
+            sameBottomOffset(); // Verify that elements in the list have the same bottom offset
+            
+            equalLeftRightOffset(); // Verify that every element in the list have equal right and left offset (aligned horizontally in center)
+            
+            equalTopBottomOffset(); // Verify that every element in the list have equal top and bottom offset (aligned vertically in center)
+            
+            changeMetricsUnitsTo(ResponsiveUIValidator.Units units); // Change units to Pixels or % (Units.PX, Units.PERCENT)
+           
+    * Generating results:
+    
+            drawMap(); // Methods needs to be called to collect all the results in JSON file and screenshots
+            
+            validate(); // Call method to summarize and validate the results (can be called with drawMap(). In this case result will be only True or False)
+            
+            generateReport(); // Call method to generate HTML report
+            
+            generateReport("file report name"); // Call method to generate HTML report with specified file report name
 
+### Possibilities ###
  - Verification that elements are aligned correctly on the web or mobile page
     * Elements horizontally are aligned correctly:
 
@@ -177,6 +316,7 @@
             DriverHelper.scrollUpMobileElement(AppiumDriver driver, MobileElement element)
             DriverHelper.scrollDownMobileElement(AppiumDriver driver, MobileElement element, int duration) - duration not less than 500ms
             DriverHelper.scrollUpMobileElement(AppiumDriver driver, MobileElement element, int duration) - duration not less than 500ms
+            DriverHelper.zoomInOutPage(WebDriver driver, int zoomPercent) - zoom In/Out the page
 
             DriverHelper.hideKeyboard(AppiumDriver driver) - super method that perform hiding of keyboard for Android and iOS
 

src/main/java/http/helpers/TextFinder.java

@@ -10,6 +10,13 @@ public class TextFinder {
 
     private static double DERIVATION = 0.3;
 
+    /**
+     * Smart Text finder that allows to fins piece of corrupted text
+     *
+     * @param pattern
+     * @param text
+     * @return
+     */
     public static boolean textIsFound(String pattern, String text) {
         pattern = pattern.toLowerCase();
         text = text.toLowerCase();
@@ -81,10 +88,15 @@ public static boolean textIsFound(String pattern, String text) {
         }
     }
 
-    public static void setDerivation(int derivation){
-        if (derivation > 1){
+    /**
+     * Set derivation for text searching
+     *
+     * @param derivation
+     */
+    public static void setDerivation(int derivation) {
+        if (derivation > 1) {
             derivation = 1;
-        }else if (derivation < 0){
+        } else if (derivation < 0) {
             derivation = 0;
         }
         DERIVATION = derivation;