Automation api tests (#4586)

* fix tests for Installer
* fix non-smoke pull test run
* update api manual workflow
* updated documentation for tests: provide list of tests in smoke pull
* add daily tests run
* added tests for change password
* added tests for policy tests
* Update README.md
* update docs
---------
Co-authored-by: Alexander Pyatakov <[email protected]>

Author: Celiant

.github/workflows/api.yml

@@ -1,135 +1,124 @@
-# Guardian test automation
+# Guardian Test Automation
 
 ## Description
-The /e2e-tests folder comprises guardian Cypress test automation framework and automated UI and API tests
-- [Software requirements](#software-requirements)
-- [Installation](#installation)
-- [Configuration](#configuration)
-- [Usage](#usage)
-
-## Software requirements
-- Node.js 12 or 14 and above
-- Follow steps from the [README](https://github.com/hashgraph/guardian/blob/main/README.md) to install and deploy Guardian application
+The `/e2e-tests` folder comprises the Guardian Cypress test automation framework and automated UI and API tests.
 
+When running API tests, remember that they depend on each other. It is recommended to run them sequentially, following the order specified in the `/e2e-tests` folder.
 
-## Configuration 
-In cypress.env.json file update `authorization` key with `access_key` value which will be assigned to the RootAuthority after registartation (bearerAuth)
-If you manually built every component in guardian, set the propper url to `api-server` key.
+- [Software Requirements](#software-requirements)
+- [Installation](#installation)
+- [Configuration](#installation)
+- [Usage](#usage)
+- [Report](#report)
 
+## Software Requirements
+- Node.js 20 and above
+- Follow steps from the [README](https://github.com/hashgraph/guardian/blob/main/README.md) to install and deploy the Guardian application.
 
 ## Installation
 
-### Automatic with Docker
-
-From /e2e-tests folder:
-
-   ```shell
-   docker-compose build 
-   ```
-
-To run all tests sequentially in Docker use:
-
-   ```shell
-   docker-compose run cypress-tests
-   ```
-
-With specific port:
-   ```shell
-   docker-compose run cypress-tests -e PORT=3000
-   ```
-
 ### Manual
-From /e2e-tests folder run the following command to install Cypress: 
+From the `/e2e-tests` folder, run the following command to install Cypress:
 
 `npm install cypress --save-dev`
 
+## Configuration
+
+If you built the Guardian in Docker, set the `portApi` variable in `cypress.env.json` file.
 
 ## Usage
 
-To run a specific test from UI you can open Cypress dashboard by running the following command from /e2e-tests folder:
+To run a specific test from the UI, you can open the Cypress dashboard by running the following command from the `/e2e-tests` folder:
 
 `npx cypress open`
 
-To run all tests sequentially use:
+To run all tests sequentially, use:
 
 `npx cypress run`
 
-For a single test use:
+For a single test, use:
 
-`npx cypress run --spec path/to/file.cy.js`
+`npx cypress run --spec "path/to/file.cy.js"`
 
-## Run by tag
-To run only the specs that have any tests tagged "@tag":
+### Run By Tag
+To run only the specs that have any tests tagged "tag":
 
-`npx cypress run --env grepTags=@tag,grepFilterSpecs=true`
+`npx cypress run --env "grepTags=tag,grepFilterSpecs=true"`
 
-where @tag can be:
+where `tag` can be:
 - accounts - all tests for accounts operations
+- analytics - all tests for analytics operations
+- artifacts - - all tests for artifacts operations
+- contracs - all tests for contracs operations
 - demo - all tests for demo operations
 - external - all tests for external operations
-- ipfs - all tests for ipfs operations
-- logs - - all tests for logs operations
+- ipfs - all tests for IPFS operations
+- logs - - all tests for log operations
+- modules - - all tests for modules operations
 - policies - all tests for policies operations
-- dry-run - all tests for dry-run operations
 - profilies - all tests for profilies operations
 - schemas - all tests for schemas operations
-- settings - all tests for settings operations
+- settings - - all tests for settings operations
+- tags - all tests for tags operations
 - tokens - all tests for tokens operations
 - trustchains - all tests for trustchains operations
 
-
-To run in Docker
-   ```shell
-   TAG=<TEST-TAG> docker-compose run --entrypoint="npm run test-tag" cypress-tests
-   ```
-
-## UI tests (Policies)
+### UI Tests (Policies)
 
 Only iREC5, iREC7 and Verra3 policies are covered.
 
-A command
+The following command runs all UI tests in an interactive dashboard that allows you to see the status of the tests while they are running and simultaneously view the application under test.
 
    ```shell
     npm run ui-only
    ```
 
-runs all ui tests in a interactive dashboard that allows you to see the status of the tests while they are running and at the same time view the application under test. 
-
-
-To run a UI test for specific policy you can open Cypress dashboard by running the following command from /e2e-tests folder:
+To run a UI test for a specific policy, you can open the Cypress dashboard by running the following command from the `/e2e-tests` folder:
 
 `npx cypress open`
 
-and then select test under ui-tests/specs/policies 
-
-## Smoke pull of API-tests
+and then select a test under `ui-tests/specs/policies`.
 
-The pull runs after any commit in guardian repository automatically.
+### API Tests
 
-This command from /e2e-tests directory
+The following command runs all API tests.
 
    ```shell
-    npm run smoke-pull
+    npm run api-tests
    ```
 
-runs smoke pull locally. 
+To run a API test for a specific functionality, you can open the Cypress dashboard by running the following command from the `/e2e-tests` folder:
+
+`npx cypress open`
+
+and then select a test under `/api-tests`.
 
-Functionality testing by this pull:
+### Smoke Pull of API Tests
 
-- login by Standard Registry user
-- register and login as new user
-- sends data from an external source(IPFS external node)
-- get current settings
-- set settings
-- get, import(file and IPFS) and delete modules
-- get, upload and delete artifacts
-- get, import, delete, dry-run and publish policies(i-Rec2, i-Rec4, Remote GHG Policy)
-- get, create, publish, freeze\unfreeze, associate\disassociate and grant\revoke KYC tokens
-- get, import(file and IPFS), publish, delete schemas
-- compare modules, policies, schemas and tools
-- create contracts, create retire pools, approve wipe contrat requests, create retire requests
-- create contract, module, policy and schema tags
+The pull runs automatically after any commit in the Guardian repository.
 
-## Report 
+The following command from the `/e2e-tests` directory runs smoke pull locally.
+
+   ```shell
+    npm run smoke-pull
+   ```
 
-After launching the tests a folder `cypress/reports` will be generated in which you can find the `index.html` file, after opening it in the browser, you can see the details of the launch of the tests.
+Functionality covered by this pull includes:
+
+- Login by Standard Registry user
+- Register and login as a new user
+- Send data from an external source (IPFS external node)
+- Get current settings
+- Set settings
+- Get, import (file and IPFS), and delete modules
+- Get, upload, and delete artifacts
+- Get, import, delete, dry-run, and publish policies (iREC2, iREC4, Remote GHG Policy)
+- Get, create, publish, freeze/unfreeze, associate/disassociate, and grant/revoke KYC tokens
+- Get, import (file and IPFS), publish, and delete schemas
+- Compare modules, policies, schemas, and tools
+- Create contracts, create retire pools, approve wipe contract requests, and create retire requests
+- Create contract, module, policy, and schema tags
+
+## Report
+
+After launching the tests, a folder `cypress/reports` will be generated. Inside you can find the `index.html` file. Opening this file in a browser allows you to see the details of the test run.