add hg action

avito-tech · Nov 1, 2023 · 59427d7 · 59427d7
1 parent 1afa8f3
commit 59427d7
Show file tree

Hide file tree

Showing 30 changed files with 2,156 additions and 1,551 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,15 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": "standard-with-typescript",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "rules": {
+        "no-shadow": "off",
+        "@typescript-eslint/no-shadow": ["error"]
+    }
+}
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
diff --git a/.github/linters/.eslintrc.yml b/.github/linters/.eslintrc.yml
@@ -79,5 +79,7 @@ rules:
     '@typescript-eslint/semi': ['error', 'never'],
     '@typescript-eslint/space-before-function-paren': 'off',
     '@typescript-eslint/type-annotation-spacing': 'error',
-    '@typescript-eslint/unbound-method': 'error'
+    '@typescript-eslint/unbound-method': 'error',
+    'no-shadow': 'off',
+    '@typescript-eslint/no-shadow': [ 'error' ]
   }
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -21,7 +21,7 @@ jobs:
         id: setup-node
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 21.0.0
           cache: npm
 
       - name: Install Dependencies
@@ -39,22 +39,3 @@ jobs:
       - name: Test
         id: npm-ci-test
         run: npm run ci-test
-
-  test-action:
-    name: GitHub Actions Test
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        id: checkout
-        uses: actions/checkout@v4
-
-      - name: Test Local Action
-        id: test-action
-        uses: ./
-        with:
-          milliseconds: 1000
-
-      - name: Print Output
-        id: output
-        run: echo "${{ steps.test-action.outputs.time }}"
diff --git a/.github/workflows/tetst-e-action.yml b/.github/workflows/tetst-e-action.yml
@@ -0,0 +1,32 @@
+name: Test e-action
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches-ignore:
+      - main
+
+jobs:
+  e-action:
+    runs-on: ubuntu-latest
+    name: hello
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v4
+
+      - name: Run tests
+        id: emcee
+        uses: ./
+        with:
+          emcee_token: ${{ secrets.EMCEE_TOKEN }}
+          app_path: https://emcee.cloud/api/v1/file/download/0ecf3b28-a6e6-4c41-9762-55fdd107c6aa#app-debug.apk
+          tests_path: https://emcee-cloud-backend.k.avito.ru/file/download/29ca9838-195a-4ae3-8870-9099b3b03169#app-debug-androidTest.apk
+          platform: android
+          device_os_version: 27
+          download_reports: allure
+      # Use the output from the `hello` step
+      - name: Get the output time
+        run: echo "The time was ${{ steps.emcee.outputs.reports_path }}"
diff --git a/CODEOWNERS b/CODEOWNERS
diff --git a/README.md b/README.md
@@ -1,199 +1,106 @@
-# Create a JavaScript Action Using TypeScript
 
-[![GitHub Super-Linter](https://github.com/actions/typescript-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
-![CI](https://github.com/actions/typescript-action/actions/workflows/ci.yml/badge.svg)
+# Emcee.cloud action
 
-Use this template to bootstrap the creation of a TypeScript action. :rocket:
+[![GitHub Super-Linter](https://github.com/JasperJhons/e-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
+![coverage](badges/coverage.svg)
 
-This template includes compilation support, tests, a validation workflow,
-publishing, and versioning guidance.
+This action implements basic API calls for [emcee.cloud](https://emcee.cloud/)
 
-If you are new, there's also a simpler introduction in the
-[Hello world JavaScript action repository](https://github.com/actions/hello-world-javascript-action).
+Full documentation available [here](https://emcee.cloud/docs/)
 
-## Create Your Own Action
+With this action you can do the following:
 
-To create your own action, you can use this repository as a template! Just
-follow the below instructions:
+- Upload your test artifacts to [emcee.cloud](https://emcee.cloud/) (*optional*)
+- Create new Test Run
+- Wait until the end of Test Run (*optional*)
+- Download Test report artifacts on Test Run completion
+(*requires waiting until the end*)
 
-1. Click the **Use this template** button at the top of the repository
-1. Select **Create a new repository**
-1. Select an owner and name for your new repository
-1. Click **Create repository**
-1. Clone your new repository
+## Inputs
 
-## Initial Setup
-
-After you've cloned the repository to your local machine or codespace, you'll
-need to perform some initial setup steps before you can develop your action.
-
-> [!NOTE]
+> [!IMPORTANT]
+> Important note about `iOS`
 >
-> You'll need to have a reasonably modern version of
-> [Node.js](https://nodejs.org) handy. If you are using a version manager like
-> [`nodenv`](https://github.com/nodenv/nodenv) or
-> [`nvm`](https://github.com/nvm-sh/nvm), you can run `nodenv install` in the
-> root of your repository to install the version specified in
-> [`package.json`](./package.json). Otherwise, 20.x or later should work!
-
-1. :hammer_and_wrench: Install the dependencies
-
-   ```bash
-   npm install
-   ```
-
-1. :building_construction: Package the TypeScript for distribution
-
-   ```bash
-   npm run bundle
-   ```
-
-1. :white_check_mark: Run the tests
-
-   ```bash
-   $ npm test
+> All `iOS` artifacts must be packed in `zip`
+>
+> Any URL/Paths to any ZIP archive is expected to contain a reference to a file
+> inside that archive.
+>
+>[Read more](https://github.com/avito-tech/Emcee/wiki/URL-Handling)
 
-   PASS  ./index.test.js
-     ✓ throws invalid number (3ms)
-     ✓ wait 500 ms (504ms)
-     ✓ test runs (95ms)
+### `emcee_token`
 
-   ...
-   ```
+**Required** [Token for emcee.cloud API](https://docs.emcee.cloud/cloud/profile/#api-tokens)
 
-## Update the Action Metadata
+### `platform`
 
-The [`action.yml`](action.yml) file defines metadata about your action, such as
-input(s) and output(s). For details about this file, see
-[Metadata syntax for GitHub Actions](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions).
+**Required** `iOS` or `Android`
 
-When you copy this repository, update `action.yml` with the name, description,
-inputs, and outputs for your action.
+### `device_os_version`
 
-## Update the Action Code
+**Required** Device os version or Android API level.
 
-The [`src/`](./src/) directory is the heart of your action! This contains the
-source code that will be run when your action is invoked. You can replace the
-contents of this directory with your own code.
+### `app_path`
 
-There are a few things to keep in mind when writing your action code:
+(*Optional*) URL or PATH to App under tests. Default: `empty`.
 
-- Most GitHub Actions toolkit and CI/CD operations are processed asynchronously.
-  In `main.ts`, you will see that the action is run in an `async` function.
+You can specify several values separated by commas. (ex. `url1,path1,url2`).
 
-  ```javascript
-  import * as core from '@actions/core'
-  //...
+### `tests_path`
 
-  async function run() {
-    try {
-      //...
-    } catch (error) {
-      core.setFailed(error.message)
-    }
-  }
-  ```
+(*Optional*) URL or PATH to binary with tests. Default: `empty`.
 
-  For more information about the GitHub Actions toolkit, see the
-  [documentation](https://github.com/actions/toolkit/blob/master/README.md).
+You can specify several values separated by commas. (ex. `url1,path1,url2`)
 
-So, what are you waiting for? Go ahead and start customizing your action!
+### `runner_path`
 
-1. Create a new branch
+(*Optional*) Default: `empty`.
 
-   ```bash
-   git checkout -b releases/v1
-   ```
+For `iOS`: URL or PATH to test runner binary.
+You can specify several values separated by commas. (ex. `url1,path1,url2`).
 
-1. Replace the contents of `src/` with your action code
-1. Add tests to `__tests__/` for your source code
-1. Format, test, and build the action
+For `Android`: Test Runner class (default)
 
-   ```bash
-   npm run all
-   ```
+### `test_plan_path`
 
-   > [!WARNING]
-   >
-   > This step is important! It will run [`ncc`](https://github.com/vercel/ncc)
-   > to build the final JavaScript action code with all dependencies included.
-   > If you do not run this step, your action will not work correctly when it is
-   > used in a workflow. This step also includes the `--license` option for
-   > `ncc`, which will create a license file for all of the production node
-   > modules used in your project.
+(*Optional*)(*iOS only*) URL or PATH to test XCTestRun file. Default: `empty`.
 
-1. Commit your changes
+### `envs`
 
-   ```bash
-   git add .
-   git commit -m "My first action is ready!"
-   ```
+(*Optional*) Comma separated envs ex.`ENV1=value1,ENV2=value2`
 
-1. Push them to your repository
+### `wait_for_end`
 
-   ```bash
-   git push -u origin releases/v1
-   ```
+(*Optional*) Blocking your flow and waiting for the tests to complete. Default: `true`
 
-1. Create a pull request and get feedback on your action
-1. Merge the pull request into the `main` branch
+### `download_reports`
 
-Your action is now published! :rocket:
+(*Optional*) Comma separated list of reports to be downloaded upon completion.
+ex:`allure,junit` Works only with `wait_for_end:true`
 
-For information about versioning your action, see
-[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-in the GitHub Actions toolkit.
+## Outputs
 
-## Validate the Action
+### `run_id`
 
-You can now validate the action by referencing it in a workflow file. For
-example, [`ci.yml`](./.github/workflows/ci.yml) demonstrates how to reference an
-action in the same repository.
+Test Run ID on [emcee.cloud](https://emcee.cloud/)
 
-```yaml
-steps:
-  - name: Checkout
-    id: checkout
-    uses: actions/checkout@v3
-
-  - name: Test Local Action
-    id: test-action
-    uses: ./
-    with:
-      milliseconds: 1000
-
-  - name: Print Output
-    id: output
-    run: echo "${{ steps.test-action.outputs.time }}"
-```
+### `run_url`
 
-For example workflow runs, check out the
-[Actions tab](https://github.com/actions/typescript-action/actions)! :rocket:
+Test Run URL on [emcee.cloud](https://emcee.cloud/)
 
-## Usage
+### `reports_path`
 
-After testing, you can create version tag(s) that developers can use to
-reference different stable versions of your action. For more information, see
-[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-in the GitHub Actions toolkit.
+The directory into which reports were saved
 
-To include the action in a workflow in another repository, you can use the
-`uses` syntax with the `@` symbol to reference a specific branch, tag, or commit
-hash.
+## Example usage
 
 ```yaml
-steps:
-  - name: Checkout
-    id: checkout
-    uses: actions/checkout@v3
-
-  - name: Test Local Action
-    id: test-action
-    uses: actions/typescript-action@v1 # Commit with the `v1` tag
-    with:
-      milliseconds: 1000
-
-  - name: Print Output
-    id: output
-    run: echo "${{ steps.test-action.outputs.time }}"
+        uses: ./
+        with:
+          emcee_token: ${{ secrets.EMCEE_TOKEN }}
+          app_path: http://emcee.cloud/api/v1/file/download/123#app-debug.apk
+          tests_path: ./556b821d-d1e4-4a0a-ba5b-3696862a9353#app-debug-androidTest.apk
+          platform: android
+          device_os_version: 27
+          download_reports: allure
 ```