-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'feature/dmsg' of https://github.com/evanlinjin/skywire …
…into feature/dmsg
- Loading branch information
Showing
37 changed files
with
1,191 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,274 @@ | ||
| # Interactive test environments | ||
|
|
||
| ## Table of contents | ||
|
|
||
| - [Interactive test environments](#interactive-test-environments) | ||
| - [Table of contents](#table-of-contents) | ||
| - [Code structure](#code-structure) | ||
| - [Dependencies](#dependencies) | ||
| - [Environments & scenarios](#environments--scenarios) | ||
| - [Base Environment](#base-environment) | ||
| - [Generic Test Environment](#generic-test-environment) | ||
| - [SSH Test Environment](#ssh-test-environment) | ||
| - [Proxy test environment](#proxy-test-environment) | ||
| - [Preparation](#preparation) | ||
| - [Scenario. Proxy test #1](#scenario-proxy-test-1) | ||
| - [Notes & recipes](#notes--recipes) | ||
| - [Delays](#delays) | ||
| - [Tmux for new users](#tmux-for-new-users) | ||
| - [Guidelines for new test creation](#guidelines-for-new-test-creation) | ||
|
|
||
| ## Code structure | ||
|
|
||
| ```text | ||
| integration | ||
| ├── generic # Generic environmnent | ||
| │ ├── env-vars.sh # | ||
| │ ├── nodeA.json # | ||
| │ └── nodeC.json # | ||
| ├── messaging # Messaging testing environment | ||
| │ ├── env-vars.sh # | ||
| │ ├── nodeA.json # | ||
| │ └── nodeC.json # | ||
| ├── proxy # Proxy testing environment | ||
| │ ├── env-vars.sh # | ||
| │ ├── nodeA.json # | ||
| │ └── nodeC.json # | ||
| ├── ssh # ssh testing environment | ||
| │ ├── env-vars.sh # | ||
| │ ├── nodeA.json # | ||
| │ └── nodeC.json #S | ||
| ├── InteractiveEnvironments.md # You're reading it | ||
| ├── intermediary-nodeB.json # NodeB configurationS | ||
| ├── run-base-env.sh # base environment in detached tmux session | ||
| ├── run-generic-env.sh # generic environment in tmux | ||
| ├── run-proxy-env.sh # proxy environment in tmux | ||
| ├── run-ssh-env.sh # ssh environment in tmuxS | ||
| ├── start-restart-nodeB.sh # script for restart in cycle NodeB | ||
| ├── startup.sh # add transports between nodes | ||
| ├── tear-down.sh # tear down everything | ||
| ├── test-messaging-loop.sh # Test script for messaging in infinite loop | ||
| ├── test-messaging.sh # Test one message between NodeA-NodeC, NodeC-NodeA | ||
| ├── test-proxy.sh # Test script for proxy | ||
| ├── test-ssh.sh # Test script for ssh | ||
| ``` | ||
|
|
||
| ## Dependencies | ||
|
|
||
| 1. `tmux` (required for `integration/run-*-env.sh` scripts) | ||
| 2. `jq` (required for `integration/*/env-vars.sh` scripts) | ||
| 3. `bash` v3.x or greater (or compatible shell) | ||
|
|
||
| **Notes for Mac OSX users** | ||
|
|
||
| 1. Running `tmux` in `iterm2` is known to be faulty. Consider switching to an alternative terminal emulator. | ||
| 2. To install `jq` and `tmux` via brew: `brew install jq tmux` | ||
|
|
||
|
|
||
| ## Environments & scenarios | ||
|
|
||
| ### Base Environment | ||
|
|
||
| Base environment with `skywire-services` running on localhost | ||
|
|
||
| Usage: | ||
| - as base for other environments as `source ./intergration/run-base-env.sh` in other `run-*-env.sh` scripts | ||
| - standalone: `./integration/run-base-env.sh && tmux attach -t skywire` | ||
|
|
||
| ### Generic Test Environment | ||
|
|
||
| The generic test environment will define the following: | ||
|
|
||
| - skywire-services running on localhost | ||
| - 3 skywire-nodes: | ||
| - NodeA, NodeC running all apps | ||
| - NodeB - intermediary node without apps | ||
|
|
||
| **Run** | ||
|
|
||
| ```bash | ||
| # Tear down everything | ||
| $ make integration-teardown | ||
|
|
||
| # Start all services and nodes | ||
| $ make integration-run-generic | ||
|
|
||
| # Adds pre-defined transports | ||
| $ make integration-startup | ||
| ``` | ||
|
|
||
| **Stop** | ||
|
|
||
| This is the recommended way to stop environment: | ||
|
|
||
| ```bash | ||
| $ tmux kill-session -t skywire | ||
| ``` | ||
|
|
||
| And optionally: | ||
|
|
||
| ```bash | ||
| $ make integration-teardown | ||
| ``` | ||
|
|
||
| **Commands** | ||
|
|
||
| Instead of `../skywire/skywire-cli --rpc localhost:port [command]`, one can use: | ||
|
|
||
| - `CLI_A node ls-tp` - list transports from nodeA | ||
| - `CLI_B node add-tp $PK_A` - add transport on nodeB to nodeA | ||
|
|
||
| Consult with `./integration/env-vars.sh` for details. | ||
|
|
||
| **Tests** | ||
|
|
||
| These tests assume that the generic environment is running (via the aforementioned steps). | ||
|
|
||
| - **TEST 1: Send messages back and forth once.** | ||
| ```bash | ||
| # To be run in the 'shell' tab of tmux. | ||
| ./integration/test-messaging.sh | ||
| ``` | ||
| - **TEST 2: Test send/receive with unstable NodeB.** | ||
| 1. Stop NodeB by switching to the 7th tmux window (`Ctrl+B` & `6`) and sending SIGTERM (`Ctrl-C`). | ||
| 2. Run the following in the same window: | ||
| ```bash | ||
| $ ./integration/start-restart-nodeB.sh | ||
| ``` | ||
| 3. Switch to the `shell` window and run: | ||
| ```bash | ||
| ./integration/test-messaging-loop.sh | ||
| ``` | ||
|
|
||
| **Detailed Description** | ||
|
|
||
| The following steps will be performed: | ||
|
|
||
| 1. copy sw*.json and start-restart-nodeB.sh into skywire directory | ||
| 2. Create 9 tmux windows: | ||
| 1. MSGD: messaging-discovery | ||
| 2. MSG: messaging-server | ||
| 3. TRD: transport-discovery | ||
| 4. RF: route-finder | ||
| 5. SN: setup-node | ||
| 6. NodeA: first skywire-node running with generic/nodeA.json | ||
| 7. NodeB: first skywire-node running with intermediary-nodeB.json | ||
| 8. NodeC: first skywire-node running with generic/nodeC.json | ||
| 9. shell: new shell for interactive exploration | ||
| 3. ENV-vars in shell-window: | ||
| 1. $MSG_PK, $SN_PK - public keys of messaging-server and setup-node | ||
| 2. $PK_A, $PK_B, $PK_C - public keys of node_A, node_B, node_C | ||
| 3. $RPC_A, $RPC_B, $RPC_C - `--rpc` param for ../skywire/skywire-cli | ||
| 4. $CHAT_A, $CHAT_B - addresses and ports for `skychat`-apps on node_A and node_C | ||
| 4. Aliases in shell-window: `CLI_A`, `CLI_B`, `CLI_C` | ||
|
|
||
| ### SSH Test Environment | ||
|
|
||
| The SSH Test Environment will define the following: | ||
|
|
||
| - skywire-services running on localhost | ||
| - 3 skywire-nodes: | ||
| - NodeA - running `SSH` app | ||
| - NodeB - intermediary node without apps | ||
| - NodeC - running `SSH-client` app | ||
|
|
||
| **Run** | ||
|
|
||
| ```bash | ||
| # Tear down everything | ||
| $ make integration-teardown | ||
| # Prerequisite | ||
| $ echo $PK_C > ~/.therealssh/authorized_keys | ||
| # Start all services and nodes | ||
| $ make integration-run-ssh | ||
| # Adds pre-defined transports | ||
| $ make integration-startup | ||
| ``` | ||
|
|
||
| **Tests** | ||
|
|
||
| - **TEST 1** | ||
| 1. Run `./integration/run-ssh-env.sh` - it will run: | ||
| 1. skywire-services on localhost | ||
| 2. NodeA with configured `SSH` app | ||
| 3. NodeB - intermediary | ||
| 4. NodeC with configured `SSH-client` app | ||
| 2. Run `./integration/test-ssh.sh` which will run in cycle: | ||
| 1. `./SSH-cli $PK_A "export n=1; loop -n $n echo A"` | ||
| 2. kill all skywire-nodes | ||
| 3. Collect logs | ||
| 4. Increase n by power of 2 | ||
| 5. Repeat | ||
|
|
||
| ### Proxy test environment | ||
|
|
||
| The proxy test environment will define the following: | ||
|
|
||
| - skywire-services running on localhost | ||
| - 3 skywire-nodes: | ||
| - NodeA - running `SSH` app | ||
| - NodeB - intermediary node without apps | ||
| - NodeC - running `SSH-client` app | ||
|
|
||
| #### Preparation | ||
|
|
||
| It's really tricky to make socks5 proxy work now from clean start. | ||
| Because `socksproxy-client` needs: | ||
| - transport to NodeA | ||
| - NodeA must be running **before** start of `socksproxy-client` | ||
| Recipe for clean start: | ||
| 1. Run `make integration-teardown` | ||
| 2. Start `./integration/run-proxy-env.sh` | ||
| 3. Run `make integration-startup` | ||
| 4. Stop NodeA, NodeB, NodeC | ||
| 5. Restart all nodes | ||
| 6. Wait for message in NodeC logs about successful start of | ||
| socksproxy-client | ||
| 7. Check `lsof -i :9999` that it's really started | ||
| 8. Check `curl -v --retry 5 --retry-connrefused 1 --connect-timeout 5 -x socks5://123456:@localhost:9999 https://www.google.com` | ||
|
|
||
|
|
||
| #### Scenario. Proxy test #1 | ||
|
|
||
| 1. `./integration/run-proxy-env.sh` | ||
| 2. In `shell` window run: `./integration/test-proxy.sh` | ||
| 3. Examine `./logs/proxy` | ||
|
|
||
| ## Notes & recipes | ||
|
|
||
| ### Delays | ||
|
|
||
| It's possible that a service could start earlier or later than needed. | ||
| Examine windows, in case of failed service - restart it (E.g. `KeyUp`-`Enter`) | ||
| Problem still exists in proxy test environment: | ||
| - NodeC cannot start `SSH-client` when NodeA is still starting `SSH` | ||
| ### Tmux for new users | ||
| 1. Read `man tmux` | ||
| 2. Run `tmux list-keys` | ||
| 3. Find your `send-prefix` key: `tmux list-keys | grep send-prefix` | ||
| 4. Use this prefix for switching between windows | ||
| ### Guidelines for new test creation | ||
| 1. **Decide**: | ||
| - new test is new scenario in existing environments | ||
| - or new environment with new scenario | ||
| 2. If existing environment is sufficient: | ||
| - create new script in `./integration` with name `test-[name of test].sh` | ||
| - use existing `./integration/run*.sh` for inspiration | ||
| - add section describing this scenario in this document | ||
| 3. In case of need in special environment: | ||
| - `cp -r ./integration/generic ./integration/[new environment]` | ||
| - `cp ./integraton/run-generic-env.sh ./integration/run-[new environment].sh` | ||
| - modify whats needed | ||
| - add section describing new environment and scenario(s) in this document |
Oops, something went wrong.