Initial commit Sample Repo

.github/workflows/reviewing_changes.yml

@@ -0,0 +1,122 @@
+# This job is to test different npm profiles in main branch against Pull Requests raised
+# This workflow targets Jest-js
+
+name: Jest Appium SDK Test workflow on workflow_dispatch
+
+on:
+  workflow_dispatch:
+    inputs:
+      commit_sha:
+        description: 'The full commit id to build'
+        required: true
+      package_url:
+        description: 'Staging package url'
+        required: false
+
+jobs:
+  comment-run:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      max-parallel: 3
+      matrix:
+        node: ['14', '16', '18', '20']
+        os: [ macos-latest, windows-latest, ubuntu-latest ]
+    name: Jest-js Repo ${{ matrix.node }} - ${{ matrix.os }} Sample
+    env:
+      BROWSERSTACK_USERNAME: ${{ secrets.BROWSERSTACK_USERNAME }}
+      BROWSERSTACK_ACCESS_KEY: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
+      PACKAGE_URL: ${{ github.event.inputs.package_url }}
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.inputs.commit_sha }}
+      - uses: actions/github-script@98814c53be79b1d30f795b907e553d8679345975
+        id: status-check-in-progress
+        env:
+          job_name: Jest-js Repo ${{ matrix.node }} - ${{ matrix.os }} Sample
+          commit_sha: ${{ github.event.inputs.commit_sha }}
+        with:
+          github-token: ${{ github.token }}
+          script: |
+            const result = await github.rest.checks.create({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              name: process.env.job_name,
+              head_sha: process.env.commit_sha,
+              status: 'in_progress'
+            }).catch((err) => ({status: err.status, response: err.response}));
+            console.log(`The status-check response : ${result.status} Response : ${JSON.stringify(result.response)}`)
+            if (result.status !== 201) {
+              console.log('Failed to create check run')
+            }
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Setup staging npm package
+        if: ${{ github.event.inputs.package_url != '' }}
+        run: |
+          echo 'Publishing tar.gz to local registry'
+          curl -o staging_package.tgz "$PACKAGE_URL"
+          npm install [email protected] -g
+          verdaccio &
+          npm config set registry http://localhost:4873
+          npm install -g npm-cli-adduser && npm-cli-adduser -u dummy -p dummy -e [email protected] -r http://localhost:4873
+          npm publish staging_package.tgz --registry http://localhost:4873/
+        shell: bash
+
+      - name: Install dependencies for android
+        run: |
+          cd android
+          npm install
+
+      - name: Run sample tests for android
+        run: |
+          cd android
+          npm run sample-test
+
+      - name: Run local tests for android
+        run: |
+          cd android
+          npm run sample-local-test
+
+      - name: Install dependencies for ios
+        run: |
+          cd ios
+          npm install
+
+      - name: Run sample tests for ios
+        run: |
+          cd ios
+          npm run sample-test
+
+      - name: Run local tests for ios
+        run: |
+          cd ios
+          npm run sample-local-test
+
+      - if: always()
+        uses: actions/github-script@98814c53be79b1d30f795b907e553d8679345975
+        id: status-check-completed
+        env:
+          conclusion: ${{ job.status }}
+          job_name: Jest-js Repo ${{ matrix.node }} - ${{ matrix.os }} Sample
+          commit_sha: ${{ github.event.inputs.commit_sha }}
+        with:
+          github-token: ${{ github.token }}
+          script: |
+            const result = await github.rest.checks.create({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            name: process.env.job_name,
+            head_sha: process.env.commit_sha,
+            status: 'completed',
+            conclusion: process.env.conclusion
+            }).catch((err) => ({status: err.status, response: err.response}));
+            console.log(`The status-check response : ${result.status} Response : ${JSON.stringify(result.response)}`)
+            if (result.status !== 201) {
+              console.log('Failed to create check run')
+            }

.gitignore

@@ -0,0 +1,8 @@
+node_modules/
+**/.DS_Store
+local.log
+log/
+browserstack.err
+
+.vscode/
+.env

README.md

@@ -1,2 +1,67 @@
 # jest-appium-app-browserstack
 This repository demonstrates how to run Appium tests in Jest on BrowserStack App Automate.
+
+## Setup
+
+### Requirements
+
+1. Node.js
+
+    - If not installed, install Node.js from [here](https://nodejs.org/en/download/)
+
+    - Ensure you have node & npm installed by running `node -v` & `npm -v`
+
+### Install the dependencies
+
+For Android tests, run the following command in project's base directory :
+
+```
+cd android
+npm install
+```
+Or,
+
+For dependencies for iOS tests, run following command in project's base directory :
+```
+cd ios
+npm install
+```
+## Getting Started
+
+Getting Started with Appium tests in NodeJS mocha on BrowserStack couldn't be easier!
+
+### Run your first test :
+
+Open `Android` or in `ios` folder
+
+- If you have uploaded your app then add the app id to the `browserstack.yml` config file, or you can directly specify the path to your app in the `browserstack.yml` file.
+
+- Run `npm run sample-test`
+
+- You can access the test execution results, and debugging information such as video recording, network logs on [App Automate dashboard](https://app-automate.browserstack.com/dashboard)
+
+---
+
+### **Use Local testing for apps that access resources hosted in development or testing environments :**
+
+Open `Android` or in `ios` folder
+
+- Ensure that `browserstackLocal` capability is set to `true` in the `browserstack.yml` file.
+
+- If you have uploaded your app then add the app id to the `browserstack.yml` config file, or you can directly specify the path to your app in the `browserstack.yml` file.
+
+- Run `npm run sample-local-test`
+
+- You can access the test execution results, and debugging information such as video recording, network logs on [App Automate dashboard](https://app-automate.browserstack.com/dashboard)
+
+## Integration with other NodeJS frameworks
+
+For other NodeJS frameworks samples, refer to following repositories :
+
+- [WebdriverIO](https://github.com/browserstack/webdriverio-appium-app-browserstack)
+
+Note: For other test frameworks supported by App-Automate refer our [Developer documentation](https://www.browserstack.com/docs/)
+
+## Getting Help
+
+If you are running into any issues or have any queries, please check [Browserstack Support page](https://www.browserstack.com/support/app-automate) or [get in touch with us](https://www.browserstack.com/contact?ref=help).

android/browserstack.yml

@@ -0,0 +1,67 @@
+# =============================
+# Set BrowserStack Credentials
+# =============================
+# Add your BrowserStack userName and acccessKey here or set BROWSERSTACK_USERNAME and
+# BROWSERSTACK_ACCESS_KEY as env variables
+userName: BROWSERSTACK_USERNAME
+accessKey: BROWSERSTACK_ACCESS_KEY
+
+# ======================
+# BrowserStack Reporting
+# ======================
+# The following capabilities are used to set up reporting on BrowserStack:
+# Set 'projectName' to the name of your project. Example, Marketing Website
+projectName: BrowserStack Samples
+# Set `buildName` as the name of the job / testsuite being run
+buildName: browserstack build
+# `buildIdentifier` is a unique id to differentiate every execution that gets appended to
+# buildName. Choose your buildIdentifier format from the available expressions:
+# ${BUILD_NUMBER} (Default): Generates an incremental counter with every execution
+# ${DATE_TIME}: Generates a Timestamp with every execution. Eg. 05-Nov-19:30
+# Read more about buildIdentifiers here -> https://www.browserstack.com/docs/automate/selenium/organize-tests
+buildIdentifier: '#${BUILD_NUMBER}' # Supports strings along with either/both ${expression}
+
+source: jest-js:appium-sample-main:v1.0
+
+# Set `app` to define the app that is to be used for testing. 
+# It can either take the id of any uploaded app or the path of the app directly.
+app: ./WikipediaSample.apk
+# app: ./LocalSample.apk #For running local tests
+
+# =======================================
+# Platforms (Browsers / Devices to test)
+# =======================================
+# Platforms object contains all the browser / device combinations you want to test on.
+# Entire list available here -> (https://www.browserstack.com/list-of-browsers-and-platforms/automate)
+
+platforms:
+  - deviceName: Samsung Galaxy S22 Ultra
+    osVersion: 12.0
+    platformName: android
+  - deviceName: OnePlus 11R
+    osVersion: 13.0
+    platformName: android
+  - deviceName: Google Pixel 6 Pro
+    osVersion: 12.0
+    platformName: android
+
+# ==========================================
+# BrowserStack Local
+# (For localhost, staging/private websites)
+# ==========================================
+# Set browserStackLocal to true if your website under test is not accessible publicly over the internet
+# Learn more about how BrowserStack Local works here -> https://www.browserstack.com/docs/automate/selenium/local-testing-introduction
+browserstackLocal: true # <boolean> (Default false)
+#browserStackLocalOptions:
+#Options to be passed to BrowserStack local in-case of advanced configurations
+#  localIdentifier: # <string> (Default: null) Needed if you need to run multiple instances of local.
+#  forceLocal: true  # <boolean> (Default: false) Set to true if you need to resolve all your traffic via BrowserStack Local tunnel.
+# Entire list of arguments available here -> https://www.browserstack.com/docs/automate/selenium/manage-incoming-connections
+
+# ===================
+# Debugging features
+# ===================
+debug: false # <boolean> # Set to true if you need screenshots for every selenium command ran
+networkLogs: false # <boolean> Set to true to enable HAR logs capturing
+consoleLogs: errors # <string> Remote browser's console debug levels to be printed (Default: errors)
+# Available options are `disable`, `errors`, `warnings`, `info`, `verbose` (Default: errors)

android/jest.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+  coverageProvider: "v8",
+  maxConcurrency: 5,
+  maxWorkers: 5,
+  roots: ["src"],
+  testMatch: ["**/*.test.js"],
+  testPathIgnorePatterns: ["/node_modules/"],
+  testTimeout: 60 * 1000,
+};