gasp-xyz / gasp-e2e

Mangata tests :microscope::scientist:

Mangata E2E Tests

This project has been created to test individual and combined API functionalities that Mangata exchange offers.

---

How to setup

1. Install node (v18.16.1 ) (we try to support nvm stable version )
2. Clone the code
3. Run yarn in the root folder.
4. Install Jest test framework globally: yarn global add jest -g

Setup with Dev Container

1. Follow the instructions to setup a local node and export the API_URL according to the node web socket.

• ie: export API_URL=ws://127.0.0.1:9949

Working with Dev Containers ( Dev containers are no longer maintained, PRs are welcomed )

Basically all system and project dependencies should be added to .devcontainer/Dockerfile so all developer dependencies are tracked in version control and available to anyone.

Troubleshooting ( Dev containers are no longer maintained, PRs are welcomed )

So somehow we now have essentially a distributed system for developing and that brings its own problems. If you get stuck, tear down chain running in docker-compose, spin it back up, and rebuild the devcontainer.

1. Close vscode
2. docker-compose -f devops/dockerfiles/docker-compose.yml down
3. docker-compose -f devops/dockerfiles/docker-compose.yml up
4. Re-open vscode
5. ctrl+shift+p and search for Remote-Containers: Rebuild and Reopen in Container

---

How to build

1. yarn

How to run esLint

1. Follow the mangata eslint installation guide here
2. yarn eslint

How to configure

If you run test on your machine first you need to set using yarn.

1. Clone /mangata-e2e and then delete folder /node_modules and file yarn.lock
2. Run yarn in /mangata-e2e. This command begin installation and creating necessary files for yarn.
3. If process will finish correct you'll see folder /node_modules and file yarn.lock

After each running you need to configure some parameters for test. Use this pattern (don't forget to add parameters instead of <text in the same brackets>):

export TEST_SUDO_NAME=//<You need insert name here> && export TEST_PALLET_ADDRESS=5EYCAe5XGPRojsCSi9p1ZZQ5qgeJGFcTxPxrsFRzkASu6bT2 && export E2E_XYK_PALLET_ADDRESS=5EYCAe5XGPRojsCSi9p1ZZQ5qgeJGFcTxPxrsFRzkASu6bT2 && export E2E_TREASURY_PALLET_ADDRESS=5EYCAe5ijiYfyeZ2JJCGq56LmPyNRAKzpG4QkoQkkQNB5e6Z && export E2E_TREASURY_BURN_PALLET_ADDRESS=5EYCAe5ijiYfyeZ2JJezKNMZfdbiFMyQc4YVzxaiMebAZBcm && API_URL=ws://<You need insert url here>

Node tests ( no UI )

To point to the right environment or instance, you need to export the following environment variables:

1. E2E_XYK_PALLET_ADDRESS: This contains the address to the pallet wallet. export E2E_XYK_PALLET_ADDRESS='PalletAddressComesHere' more info available in mangate-node: node/src/chain_spec.rs
2. TEST_SUDO_NAME: This contains the name of sudo user to perform required sudo operations. export TEST_SUDO_NAME='//nameOfTheUser' more info available in mangata-node: node/src/chain_spec.rs
3. API_URL: Points the API to the right environment. The default will be localhost (ws://127.0.0.1:9944). export API_URL='ws://127.0.0.1:9944'
4. TEST_USER_NAME: Contains the name of the user for CI/CD validation tests. Default is //Alice (address 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY) export TEST_USER_NAME='//Alice'
5. LOG_LEVEL: Handles the test log_levels:[error,warn,info,http,verbose,debug,silly] , default: info.

---

Node tests ( UI )

1. API_URL: UI tests need the API to do and setup some internal stuff. export API_URL='wss://staging.testnode.mangata.finance:9945'
2. UI_URL : UI tests need a UI to test with. Important that the tested UI points to the same API_URL you exported before . export UI_URL='https://staging.mangata.finance/'
3. MNEMONIC_META: In order to setup Metamask extension, we need the mnemonic for that account. This is available as a secret in Github .export MNEMONIC_META='dismiss blabla bla .. trumpet' ( Ask Gonzalo :) )

How to run

After that env. variables have been exported, you can run all tests with the command jest or ./node_modules/.bin/jest

You can specify the command --runInBand if you don't want to run the tests in parallel

UPDATE: Since ESM module upgrades, you need to specify certain flags for jest. For example: node --experimental-specifier-resolution=node --loader ts-node/esm --experimental-vm-modules node_modules/jest/bin/jest.js --verbose --ci test/story/story.LP.test.ts

There are also some configurations to run tests,

• npm run test-parallel : Run the tests (for @paralell group) that can be parallelized.

• npm run test-sequential : Run tests (for @sequential group) that can not be parallelized so they will run one after the other.

• npm run test-ui : Run tests (from test/ui/ folder). They contain UI tests.

Finally, there are groups that can be ran instead.

These are ran like so: jest --group=sequential. Multiple groups can be ran like jest --group=group1 --group=group2.

At the moment groups are split between testing configurations (parallel, sequential, etc) and pallets (api, asset, liquidity, sudo, etc). They can be found in docstrings at the top of any test file.

How to run in a docker setup

There exist a possibility to run test pointing to a dockerize setup. You only need to :

1. Follow the instructions in mangata-node to setup a local environment. Here is a personal hint:

yarn global add @open-web3/parachain-launch -g
cd <mangata-node local path goes here >/devops/parachain-launch
cd output
docker-compose down -v
cd ..
rm -rf output
cd <mangata-node local path goes here >/devops/parachain-launch/
nvim ./config.yml
npx @open-web3/parachain-launch generate config.yml --yes
cd output
docker-compose down -v
docker-compose up -d --build

2. Point to that node (ip can be obtained from the docker-compose) exporting API_URL='ws://172.16.238.10:9944.
3. Run any test yarn test-sequential.

Reports reports reports!

Reports are now in TestMo: https://mangata-finance.testmo.net/

How to setup on Windows

• Follow all the steps from here
• Install yarn and do yarn install
• Install nvm: curl -sL https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.0/install.sh -o install_nvm.sh
• Install latest node version: nvm install v18.12.1
• (Optional) sudo cp /home/<usr>/.nvm/versions/node/v18.12.1/bin/node /usr/bin/
• Install Jest extension ( into wsl )
• Install python: apt-get install python
• You need to check version before you will be debugging test. Use nvm version (or nvm ls) and yarn --version
• If version of nvm on your local machine is lower than v18.12.1 as default, you need to fix this: nvm alias default v18.12.1
• Debug test