Added Tutorials and Example test for auth

Author: emmanuelandre

KITE-AppRTC-Test/src/main/java/org/webrtc/kite/apprtc/checks/BitrateCheck.java

@@ -21,6 +21,7 @@
 import io.cosmosoftware.kite.steps.TestCheck;
 import org.openqa.selenium.WebDriver;
 import org.webrtc.kite.apprtc.pages.AppRTCMeetingPage;
+import org.webrtc.kite.stats.StatsUtils;
 
 import javax.json.Json;
 import javax.json.JsonArray;
@@ -59,7 +60,7 @@ protected void step() throws KiteTestException {
         .add(stat)
         .build();
     // Get a stats array of the selected stat for 5 seconds
-    JsonObject stats = appRTCMeetingPage.getStatOvertime(
+    JsonObject stats = StatsUtils.getStatOvertime(
       webDriver, FIVE_SECOND_INTERVAL, ONE_SECOND_INTERVAL, selectedStat).build();
     double avgBitrate = computeBitrate(stats.getJsonArray("statsArray"), stat, mediaType);
     System.out.println("avgBitrate lah =>>>>>> " + avgBitrate);

KITE-AppRTC-Test/src/main/java/org/webrtc/kite/apprtc/pages/AppRTCMeetingPage.java

@@ -54,7 +54,7 @@ protected void step() throws KiteTestException {
     }
     LinkedHashMap<String, String> results = new LinkedHashMap<>();
     try {
-      JsonObject stats = getPCStatOvertime(webDriver, getStatsConfig).get(0);
+      JsonObject stats = appRTCMeetingPage.getPCStatOvertime(webDriver, getStatsConfig).get(0);
       JsonObject statsSummary = appRTCMeetingPage.buildstatSummary(stats, getStatsConfig.getJsonArray("selectedStats"));
       results = appRTCMeetingPage.statsHashMap(statsSummary);
       Reporter.getInstance().jsonAttachment(report, "getStatsRaw", stats);

KITE-AppRTC-Test/src/main/java/org/webrtc/kite/apprtc/steps/GetStatsStep.java

@@ -71,8 +71,6 @@ public static void run(TestConf testConf) {
     try {
       List<Tuple> tupleList = Configurator.getInstance()
         .buildTuples(testConf.getTupleSize(), testConf.isPermute(), testConf.isRegression());
-
-      tupleList.addAll(Configurator.getInstance().getCustomBrowserMatrix());
 
       service.submit(new TestRunThread(testConf, tupleList)).get();
     } catch (Exception e) {

KITE-Engine/src/main/java/org/webrtc/kite/Engine.java

@@ -75,20 +75,20 @@ private KiteBaseTest buildTest() throws ClassNotFoundException, NoSuchMethodExce
     KiteBaseTest test = testConf.isJavascript()
       ? new KiteJsTest(testConf.getTestImpl())
       : (KiteBaseTest) Class.forName(this.testConf.getTestImpl()).getConstructor().newInstance();
+    
     phases = getPhases(testConf.isLoadTest());
     test.setCloseWebDrivers(testConf.isCloseWebDrivers());
     test.setPhases(phases);
     test.setSuite(testSuite.getName());
-  
 
     test.setConfigFilePath(Configurator.getInstance().getConfigFilePath());
     test.setInstrumentation(Configurator.getInstance().getInstrumentation());
-    test.setParentSuite(Configurator.getInstance().getName());
-    
+    test.setNetworks(Configurator.getInstance().getNetworks());
+    test.setParentSuite(Configurator.getInstance().getName());    
     test.setLogger(testConf.getLogger());
     test.setDescription(testConf.getDescription());
     test.setPayload(testConf.getPayload());
-
+    test.setRemoteAddress(Configurator.getInstance().getRemoteAddress());
     test.setEndPointList(tuple);
 
     if (testConf.isLoadTest()) {

KITE-Engine/src/main/java/org/webrtc/kite/TestManager.java

@@ -18,6 +18,7 @@
 
 import io.cosmosoftware.kite.exception.KiteTestException;
 import io.cosmosoftware.kite.instrumentation.Instrumentation;
+import io.cosmosoftware.kite.instrumentation.NetworkProfileHashMap;
 import io.cosmosoftware.kite.report.Reporter;
 import org.apache.log4j.Logger;
 import org.webrtc.kite.exception.KiteInsufficientValueException;
@@ -60,16 +61,16 @@ public class Configurator {
   private String name;
   private String commandName;
   private String configFilePath;
-  private boolean customMatrixOnly = false;
   private boolean skipSame = false;
   private long timeStamp = System.currentTimeMillis();
   private JsonObject jsonConfigObject;
   private ConfigHandler configHandler;
-  private List<Tuple> customBrowserMatrix = new ArrayList<>();
   private List<JsonObject> testObjectList;
   private List<JsonObject> customMatrix;
   private List<JsonObject> remoteObjectList = null;
   private Instrumentation instrumentation = null;
+  private NetworkProfileHashMap networks = null;
+  private String instrumentUrl = null;
 
   private Configurator() {
   }
@@ -135,8 +136,6 @@ public void buildConfig()
         throw new KiteInsufficientValueException("Less than one browser or app object.");
       }
 
-      this.customMatrixOnly = jsonConfigObject.getBoolean("customMatrixOnly", this.customMatrixOnly);
-  
       this.customMatrix = (List<JsonObject>)
         throwNoKeyOrBadValueException(jsonConfigObject, "matrix", JsonArray.class, true);
 
@@ -169,24 +168,33 @@ public void buildConfig()
       new ConfigHandler(permute, callbackURL, remoteObjectList, testObjectList,
         browserObjectList, appObjectList);
 
-    String instrumentUrl = jsonConfigObject.getString("instrumentUrl", null);
+    this.instrumentUrl = jsonConfigObject.getString("instrumentUrl", null);
     if (instrumentUrl != null) {
       try {
         String instrumentFile = System.getProperty("java.io.tmpdir") + "instrumentation.json";
         if (instrumentUrl.contains("://")) {
           //if this is a url, then download it
-          downloadFile(instrumentUrl, instrumentFile);
+          downloadFile(this.instrumentUrl, instrumentFile);
         } else {
           //otherwise assume it can be read directly.
-          instrumentFile = instrumentUrl;
+          instrumentFile = this.instrumentUrl;
         }
         JsonObject instrumentObject = readJsonFile(instrumentFile);
-        this.instrumentation = new Instrumentation(instrumentObject);
+        this.instrumentation = new Instrumentation(instrumentObject, instrumentUrl, getRemoteAddress());
       } catch (KiteTestException e) {
         logger.error(getStackTrace(e));
       }
     }
-    skipSame = jsonConfigObject.getBoolean("skipSame", skipSame);
+    JsonArray networksArray =  jsonConfigObject.containsKey("networks") ?  jsonConfigObject.getJsonArray("networks"):null;
+    if (networksArray != null ) {
+      try {
+        this.networks = new NetworkProfileHashMap(networksArray);
+      } catch (Exception e) {
+        logger.error(getStackTrace(e));
+      }
+
+    }
+    skipSame =  jsonConfigObject.getBoolean("skipSame", skipSame);
     logger.info("Finished reading the configuration file");
   }
 
@@ -204,17 +212,16 @@ public List<Tuple> buildTuples(int tupleSize, boolean permute, boolean regressio
       listOfTuples.add(new Tuple());
     } else {
       if (this.customMatrix != null) {
+        List<Tuple> customBrowserMatrix = new ArrayList<>();
         for (JsonStructure structure : this.customMatrix) {
           JsonArray jsonArray = (JsonArray) structure;
           Tuple tuple = new Tuple();
           for (int i = 0; i < jsonArray.size(); i++) {
             tuple.add(this.configHandler.getEndPointList().get(jsonArray.getInt(i)));
           }
-          this.customBrowserMatrix.add(tuple);
+          customBrowserMatrix.add(tuple);
         }
-        
-        if (this.customMatrixOnly)
-          return null;
+        return customBrowserMatrix;
       }
 
       List<EndPoint> endPointList = this.configHandler.getEndPointList();
@@ -234,9 +241,8 @@ public List<Tuple> buildTuples(int tupleSize, boolean permute, boolean regressio
           || (skipSame && tuple.stream().distinct().limit(2).count() <= 1)) {
           listOfTuples.remove(tuple);
         }
-      }
-      
-      Collections.shuffle(listOfTuples);
+      }      
+      //Collections.shuffle(listOfTuples);
     }
     return listOfTuples;
   }
@@ -275,15 +281,6 @@ public void setConfigFilePath(String configFilePath) {
   public ConfigHandler getConfigHandler() {
     return this.configHandler;
   }
-  
-  /**
-   * getCustomBrowserMatrix
-   *
-   * @return the custom browser matrix
-   */
-  public List<Tuple> getCustomBrowserMatrix() {
-    return this.customBrowserMatrix;
-  }
 
   /**
    * Gets instance.
@@ -297,6 +294,12 @@ public static Configurator getInstance() {
   public Instrumentation getInstrumentation() {
     return instrumentation;
   }
+
+  public String getInstrumentUrl() { return this.instrumentUrl; }
+
+  public NetworkProfileHashMap getNetworks() {
+    return networks;
+  }
 
   /**
    * Gets name.
@@ -314,7 +317,7 @@ public String getName() {
    */
   public String getRemoteAddress() {
     if (remoteObjectList != null && remoteObjectList.size() > 0) {
-      return remoteObjectList.get(0).getString("remoteAddress");
+      return remoteObjectList.get(0).getString("remoteAddress").split("/")[2].split(":")[0];
     }
     return null;
   }
@@ -337,15 +340,6 @@ public long getTimeStamp() {
     return this.timeStamp;
   }
 
-  /**
-   * isCustomerMatrixOnly
-   *
-   * @return  true if the test is using custom matrix only
-   */
-  public boolean isCustomMatrixOnly() {
-    return customMatrixOnly;
-  }
-  
   /**
    * Build a list of tuple from given endpoints list, permutation or combination
    *

KITE-Engine/src/main/java/org/webrtc/kite/config/Configurator.java

@@ -0,0 +1,30 @@
+{
+  "name": "Kite Test Example with Allure reporting",
+  "remotes": [
+    {
+      "type": "local",
+      "remoteAddress": "http://localhost:4444/wd/hub"
+    }
+  ],
+  "tests": [
+    {
+      "name": "KiteExampleAuthTest %ts",
+      "tupleSize": 1,
+      "description": "This example test opens gmail page, sign in and verifies it.",
+      "testImpl": "org.webrtc.kite.example.KiteExampleAuthTest",
+      "payload" : {
+        "test1": "ONE",
+        "test2": "TWO"
+      }
+    }
+  ],
+  "browsers": [
+    {
+      "browserName": "chrome",
+      "version": "74",
+      "platform": "localhost",
+      "flags": []
+    }
+  ],
+  "apps":[]
+}

KITE-Example-Test/configs/auth.local.config.json

@@ -8,7 +8,7 @@
   ],
   "tests": [
     {
-      "name": "JS KiteExampleTest %ts",
+      "name": "JS KiteExampleSearchTest %ts",
       "tupleSize": 1,
       "description": "This example test opens google and searches for Cosmo Software Consulting and verify the first result",
       "testImpl": "Example.js",

KITE-Example-Test/configs/js.example.config.json

@@ -1,5 +1,5 @@
 {
-  "name": "Kite Test Example with Allure reporting",
+  "name": "Kite Test Search Example with Allure reporting",
   "remotes": [
     {
       "type": "local",
@@ -8,10 +8,10 @@
   ],
   "tests": [
     {
-      "name": "KiteExampleTest %ts",
+      "name": "KiteExampleSearchTest %ts",
       "tupleSize": 1,
       "description": "This example test opens google and searches for Cosmo Software Consulting and verify the first result",
-      "testImpl": "org.webrtc.kite.example.KiteExampleTest",
+      "testImpl": "org.webrtc.kite.example.KiteExampleSearchTest",
       "payload" : {
         "test1": "ONE",
         "test2": "TWO"

KITE-Example-Test/configs/local.config.json renamed to KITE-Example-Test/configs/search.local.config.json

@@ -0,0 +1,22 @@
+package org.webrtc.kite.example;
+
+import org.webrtc.kite.example.checks.GmailSignInCheck;
+import org.webrtc.kite.example.checks.GoogleFirstResultCheck;
+import org.webrtc.kite.example.steps.GmailSignInStep;
+import org.webrtc.kite.example.steps.GoogleSearchStep;
+import org.webrtc.kite.tests.KiteBaseTest;
+import org.webrtc.kite.tests.TestRunner;
+
+public class KiteExampleAuthTest extends KiteBaseTest {
+
+  
+  @Override
+  protected void payloadHandling() {}
+
+  @Override
+  public void populateTestSteps(TestRunner runner) {
+    runner.addStep(new GmailSignInStep(runner.getWebDriver()));
+    runner.addStep(new GmailSignInCheck(runner.getWebDriver()));
+  }
+
+}