AppiumTestDistribution · saikrishna321 · Feb 12, 2024 · Jan 22, 2024 · Jan 22, 2024 · Jan 22, 2024
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - dashboard-module
+
+jobs:
+  buildWithSubmodule:
+    name: Build with Submodule
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [18, 20]
+
+    steps:
+    - name: Checkout repository with submodules
+      uses: actions/checkout@v3
+      with:
+        submodules: recursive
+        token: ${{ secrets.PAT_TOKEN }}
+    - name: Run script
+      run: |
+        # Add your script commands here
+        npm ci
+        npm run bundle
+
+  buildWithOutSubmodule:
+    name: Build with Out Submodule
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [18, 20]
+
+    steps:
+      - name: Checkout repository with submodules
+        uses: actions/checkout@v3
+      - name: Run script
+        run: |
+          npm ci
+          npm run bundle
+
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "src/modules"]
+	path = src/modules
+	url = https://github.com/AppiumTestDistribution/device-farm-pro.git
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -1,22 +1,19 @@
 trigger:
-- main
+- dashboard-module
 
 jobs:
- - job: UnitTest
+ - job: UnitTest  
    pool:
      vmImage: 'macOS-latest'
-
    steps:
     - task: [email protected]
       inputs:
-       versionSpec: '16.x'
-
+       versionSpec: '20.x'
+    - template: templates/pipeline.yml
     - script: |
-        npm ci
         npm test
       displayName: 'npm test'
     - script: |
-        npm ci
         npm run prettier-check
       displayName: 'Prettier check'
 
@@ -27,12 +24,8 @@ jobs:
    steps:
     - task: [email protected]
       inputs:
-       versionSpec: '16.x'
-
-    - script: |
-        npm ci
-      displayName: 'npm install'
-
+       versionSpec: '20.x'
+    - template: templates/pipeline.yml
     - bash: |
         echo "y" | $ANDROID_HOME/tools/bin/sdkmanager --install 'system-images;android-27;google_apis;x86'
       displayName: "install Android image"
@@ -72,9 +65,8 @@ jobs:
     - task: [email protected]
       inputs:
        versionSpec: '16.x'
-
+    - template: templates/pipeline.yml
     - script: |
-        npm ci
         npm run test-e2e
       displayName: 'E2E Test'
 
@@ -85,8 +77,8 @@ jobs:
    steps:
     - task: [email protected]
       inputs:
-       versionSpec: '16.x'
-
+       versionSpec: '20.x'
+    - template: templates/pipeline.yml
     - bash: |
         echo "y" | $ANDROID_HOME/tools/bin/sdkmanager --install 'system-images;android-27;google_apis;x86'
       displayName: "install Android image"
@@ -105,8 +97,6 @@ jobs:
         $ANDROID_HOME/platform-tools/adb devices
       displayName: "start Android emulator"
     - script: |
-        npm ci
-
         npm run test-e2e-hubnode
       displayName: 'E2E Hub and Node Test'
 
@@ -117,11 +107,9 @@ jobs:
    steps:
     - task: [email protected]
       inputs:
-       versionSpec: '16.x'
-
+       versionSpec: '20.x'
+    - template: templates/pipeline.yml
     - script: |
-        npm ci
-
         npm run test-e2e-browserstack
       displayName: 'E2E Test'
 
@@ -132,11 +120,9 @@ jobs:
    steps:
     - task: [email protected]
       inputs:
-       versionSpec: '16.x'
-
+       versionSpec: '20.x'
+    - template: templates/pipeline.yml
     - script: |
-        npm ci
-
         npm run test-e2e-pcloudy
       displayName: 'E2E Test'
 
@@ -147,11 +133,9 @@ jobs:
    steps:
     - task: [email protected]
       inputs:
-       versionSpec: '16.x'
-
+       versionSpec: '20.x'
+    - template: templates/pipeline.yml
     - script: |
-        npm ci
-
         export CLOUD_USERNAME=$BS_USERNAME
         export CLOUD_KEY=$BS_PASSWORD
         export BS_ANDROID_CLOUD_APP=$BS_ANDROID_CLOUD_APP
@@ -165,10 +149,9 @@ jobs:
    steps:
      - task: [email protected]
        inputs:
-         versionSpec: '16.x'
-
+         versionSpec: '20.x'
+     - template: templates/pipeline.yml
      - script: |
-         npm ci
          export CLOUD_USERNAME=$BS_USERNAME
          export CLOUD_KEY=$BS_PASSWORD
          export BS_IOS_CLOUD_APP=$BS_IOS_CLOUD_APP
@@ -199,10 +182,9 @@ jobs:
    steps:
      - task: [email protected]
        inputs:
-         versionSpec: '16.x'
-
+         versionSpec: '20.x'
+     - template: templates/pipeline.yml
      - script: |
-         npm ci
          export CLOUD_USERNAME=$LT_USERNAME
          export CLOUD_KEY=$LT_PASSWORD
          export LT_CLOUD_APP=$LT_CLOUD_APP

diff --git a/docs/capabilities.md b/docs/capabilities.md
@@ -2,15 +2,18 @@
 title: Capabilities
 ---
 
-| Capability Name                  | Description                                                                                                                                                                                                                                                        |
-|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| appium:iPhoneOnly                | Allocate only iPhone simulators for execution when to true. Default value is `false`.                                                                                                                                                                              |
-| appium:iPadOnly                  | Allocate only iPad simulators for execution when to true. Default value is `false`.                                                                                                                                                                                |
-| appium:deviceAvailabilityTimeout | When create session requests are more than available connected devices, plugin waits for a certain interval for device availability before it timeout. Default value is `180000` milliseconds.                                                                     |
-| appium:deviceRetryInterval       | When create session requests are more than available connected devices, plugin polls for device availability in certain intervals. Default value is `10000` milliseconds.                                                                                          |
-| appium:udids                     | Comma separated list of device udid's to execute tests only on specific devices `appium:udids: device1UDID,device2UDID`                                                                                                                                            |
-| appium:platformName              | Requests asession for the provided platform name. Valid options are `iOS`, `tvOS`, or `Android`, ex: `'appium:platformName': tvOS`                                                                                                                                 |
-| appium:platformVersion           | This capability is used to filter devices/simulators based on SDK. Only devices/simulators that are an exact match with the platformVerson would be considered for test run. `appium:platformVersion` is optional argument. ex: `'appium:platformVersion': 16.1.1` |
-| appium:minSDK                    | This capability is used to filter devices/simulators based on SDK. Devices/Simulators with SDK greater then or equal to minSDK would only be considered for test run. `appium:minSDK` is optional argument. ex: `'appium:minSDK': 15`                              |
-| appium:maxSDK                    | This capability is used to filter devices/simulators based on SDK. Devices/Simulators with SDK less then or equal to maxSDK would only be considered for test run. `appium:maxSDK` is optional argument. ex: `'appium:maxSDK': 15`                                 |
-| appium:filterByHost              | This capability is used to filter devices/simulators based on node IP. This will only consider devices from specific node. `host` is optional argument. ex: `'host': '192.168.0.226',`                                                                      |
+| Capability Name              | Description                                                                                                                                                                                                                                                        |
+|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| df:build                     | Allocate a build name in dashboard. Default value is `null`.                                                                                                                                                                                                       |
+| df:record_video              | Enable video recording for the session. Default value is `true`.                                                                                                                                                                                                   |
+| df:iPhoneOnly                | Allocate only iPhone simulators for execution when to true. Default value is `false`.                                                                                                                                                                              |
+| df:iPadOnly                  | Allocate only iPad simulators for execution when to true. Default value is `false`.                                                                                                                                                                                |
+| df:deviceAvailabilityTimeout | When create session requests are more than available connected devices, plugin waits for a certain interval for device availability before it timeout. Default value is `180000` milliseconds.                                                                     |
+| df:deviceRetryInterval       | When create session requests are more than available connected devices, plugin polls for device availability in certain intervals. Default value is `10000` milliseconds.                                                                                          |
+| df:udids                     | Comma separated list of device udid's to execute tests only on specific devices `df:udids: device1UDID,device2UDID`                                                                                                                                                |
+| appium:platformName          | Requests asession for the provided platform name. Valid options are `iOS`, `tvOS`, or `Android`, ex: `'appium:platformName': tvOS`                                                                                                                                 |
+| appium:platformVersion       | This capability is used to filter devices/simulators based on SDK. Only devices/simulators that are an exact match with the platformVerson would be considered for test run. `appium:platformVersion` is optional argument. ex: `'appium:platformVersion': 16.1.1` |
+| df:minSDK                    | This capability is used to filter devices/simulators based on SDK. Devices/Simulators with SDK greater then or equal to minSDK would only be considered for test run. `df:minSDK` is optional argument. ex: `'appium:minSDK': 15`                                  |
+| df:maxSDK                    | This capability is used to filter devices/simulators based on SDK. Devices/Simulators with SDK less then or equal to maxSDK would only be considered for test run. `df:maxSDK` is optional argument. ex: `'appium:maxSDK': 15`                                     |
+| df:filterByHost              | This capability is used to filter devices/simulators based on node IP. This will only consider devices from specific node. `df:options` is optional argument. ex: `'filterByHost': '192.168.0.226',`                                                               |
+| df:options                   | Set all device farm related capabilities as object. `df:options` is optional argument. ex: `'df:options': { filterByHost: '192.168.0.226', record_video: true },`                                                                                                  |
diff --git a/docs/setup.md b/docs/setup.md
@@ -43,3 +43,27 @@ User can block/unblock devices from Dashboard manually. These devices will not b
 
 Once automation picks the device user cannot manually unblock, it's responsible for the automation script.
 
+## Dashboard
+
+To reflect the test status on dashboard. 
+
+WDIO
+```
+      await driver.executeScript('devicefarm: setSessionStatus', [
+        {
+          status: 'passed', //passed or failed
+        },
+      ]);
+```
+
+
+To reflect the test name on dashboard.
+
+WDIO 
+```
+      await driver.executeScript('devicefarm: setSessionName', [
+        {
+          name: 'Test Name',
+        },
+      ]);
+```