tokenbridge/oracle-e2e/README.md

# POA TokenBridge / Oracle-E2E

End to end tests for the POA TokenBridge [Oracle](../oracle/README.md).

## Prerequisites

To run the tests you need to have
[Docker](https://www.docker.com/community-edition) and
[Docker Compose](https://docs.docker.com/compose/install/) installed.
If you are on Linux, it's also recommended that you [create a docker group and
add your user to it](https://docs.docker.com/install/linux/linux-postinstall/),
so that you can use the CLI without sudo.

## Running

To run the bridge end-to-end tests, you just have to run:

```
./run-tests.sh
```

If this is the first time that you do this, it will take some time to build the
docker images, but the next time they will be cached.

## How it works

The script starts several containers and then use them to run the tests. These
services are:

- Two parity nodes with the InstanSeal engine, representing the home and foreign
  chains.
- A Redis container.
- A RabbitMQ container.
- The bridge (without doing anything at first)
- The container for the end-to-end tests (also without doing anything)

Afterwards, contracts will be deployed to the respective chains, all the bridge
scripts will be executed (using the bridge service) and tests (using the e2e
service) will be executed. The last process exit code will be used as the result
of the testing suite.

## Debugging

Sometimes you may need to look into what happened in each service after running
the tests. For doing this, comment out the `docker-compose down` line in the
`run-tests.sh` file, and all the containers will be kept running after the
script finishes. Some things you can do:

- Connect to the home chain using `http://localhost:8541` as the URL.
- Connect to the foreign chain using `http://localhost:8542` as the URL.
- Open the RabbitMQ Management service (go to `http://localhost:15672` in the
  browser and log in with username/password `guest/guest`).
- Inspect the logs using `docker logs CONTAINER`. You can obtain the container
  name with the `docker ps` command.
Cosistent TokenBridge naming (#159) 2019-07-19 10:18:51 +03:00			`# POA TokenBridge / Oracle-E2E`
Added token-bridge repository from tag 1.3.0-rc0 2019-05-06 14:12:53 +03:00
Cosistent TokenBridge naming (#159) 2019-07-19 10:18:51 +03:00			`End to end tests for the POA TokenBridge [Oracle](../oracle/README.md).`
Added token-bridge repository from tag 1.3.0-rc0 2019-05-06 14:12:53 +03:00
			`## Prerequisites`

			`To run the tests you need to have`
			`[Docker](https://www.docker.com/community-edition) and`
			`[Docker Compose](https://docs.docker.com/compose/install/) installed.`
			`If you are on Linux, it's also recommended that you [create a docker group and`
			`add your user to it](https://docs.docker.com/install/linux/linux-postinstall/),`
			`so that you can use the CLI without sudo.`

			`## Running`

Extract oracle/e2e (#45) * Moved oracle/e2e to oracle-e2e * Update build path in docker-compose * Update link to e2e in oracle * Introduce oracle-e2e workspace. * Updated script and readme * Integrated oracle-e2e into CI. 2019-05-15 14:51:21 +03:00			`To run the bridge end-to-end tests, you just have to run:`
Added token-bridge repository from tag 1.3.0-rc0 2019-05-06 14:12:53 +03:00
			```
Updates after deployment test (#75) * Force ln to mitigate error when postinstall is repeated * Update readme * Using yarn in place of npm run * Changed env order - home first * Removed gh-pages UI deploy * Readme cosmetics * Removed duplicate bridge overview * Update readme * Update repository address * Update readme * Changed NPM to Yarn everywhere * Update readme * Using tokenbridge monorepo in deployment instead of token-bridge * Update ui/README.md Co-Authored-By: Andrew Gross <andogro@gmail.com> * Revert and/or change as per @akolotov explanation * Removed checkWorker3 that was used in legacy bridge-rust-v1-native-to-erc * Update deployment/oracle/README.md Co-Authored-By: Alexander Kolotov <alexandr.kolotov@gmail.com> * Apply suggestions from code review Co-Authored-By: Alexander Kolotov <alexandr.kolotov@gmail.com> * Update root readme and Update sub-repo readmes to point to root monorepository initialization. * Removed obsolete GET /stuckTransfers * Remove stuckTransfers * Use shell instead of unmaintained docker_service module. Update naming in templates. 2019-05-31 15:54:32 +03:00			`./run-tests.sh`
Added token-bridge repository from tag 1.3.0-rc0 2019-05-06 14:12:53 +03:00			```

			`If this is the first time that you do this, it will take some time to build the`
			`docker images, but the next time they will be cached.`

			`## How it works`

			`The script starts several containers and then use them to run the tests. These`
			`services are:`

			`- Two parity nodes with the InstanSeal engine, representing the home and foreign`
			`chains.`
			`- A Redis container.`
			`- A RabbitMQ container.`
			`- The bridge (without doing anything at first)`
			`- The container for the end-to-end tests (also without doing anything)`

			`Afterwards, contracts will be deployed to the respective chains, all the bridge`
			`scripts will be executed (using the bridge service) and tests (using the e2e`
			`service) will be executed. The last process exit code will be used as the result`
			`of the testing suite.`

			`## Debugging`

			`Sometimes you may need to look into what happened in each service after running`
			the tests. For doing this, comment out the `docker-compose down` line in the
			`run-tests.sh` file, and all the containers will be kept running after the
			`script finishes. Some things you can do:`

			- Connect to the home chain using `http://localhost:8541` as the URL.
			- Connect to the foreign chain using `http://localhost:8542` as the URL.
			- Open the RabbitMQ Management service (go to `http://localhost:15672` in the
			browser and log in with username/password `guest/guest`).
			- Inspect the logs using `docker logs CONTAINER`. You can obtain the container
			name with the `docker ps` command.