Integration tests for `testnet.polykey.io` #441

emmacasolin · 2022-08-11T00:28:46Z

Description

Adding a suite of integration tests for interacting with a deployed agent at testnet.polykey.io. These will go under tests/integration/testnet.

Issues Fixed

Tasks

1. Add diagrams to existing NAT tests
2. Create new subdirectory tests/integration/testnet
~~[ ] 3. Write tests as specified in Integration Tests for testnet.polykey.com Polykey-CLI#71~~

Required tests:

Connecting to testnet.polykey.io seed node (by setting as seed node during pk agent start)
~~[ ] Verification of seed node in local keynode's NodeGraph (pk nodes getall)~~
~~[ ] Sending notification to seed node (expect failure because no trust established, but this shouldn't show up locally)~~
~~[ ] Establishing trust of seed node with local keynode (pk identities trust)~~
~~[ ] Verifying node has been added to seed node's gestalt graph after trust has been established (pk identities get/list)~~
~~[ ] Sending notification to seed node, and verifying seed node received (will need to connect to testnet and run pk notifications read)~~
Pinging the seed node
Pinging another node through the seed node

Final checklist

ghost · 2022-08-11T00:29:53Z

👇 Click on the image for a new way to code review

Make big changes easier — review code in small groups of related files
Know where to start — see the whole change at a glance
Take a code tour — explore the change with an interactive tour
Make comments and review — all fully sync’ed with github

Try it now!

Legend

CMCDragonkai · 2022-08-11T05:06:57Z

Ok so these will be the first directory grouped integration tests with respect to #435. So far you don't need to "reuse" any tests from tests/nat right as #435 isn't done yet.

emmacasolin · 2022-08-12T00:15:33Z

How should the testnet be specified as a seed node in these tests? Using --network=testnet isn't working for me, and specifying the deployed nodes individually using --seed-nodes would be too brittle since the deployed agents change relatively frequently.

emmacasolin · 2022-08-12T06:54:46Z

One problem with our testnet NAT tests is that the testnet needs to coordinate signalling between two network namespaces running on a single real machine. This essentially becomes a double NAT.

                                           Testnet
                                      ┌───────────────┐
                                      │               │
                                      │ ┌───────────┐ │
                                      │ │ SeedNode  │ │
                                      │ └───────────┘ │
                                      │   HOST:PORT   │
                                      │               │
                                      └───────────────┘

    Real Computer
┌──────────────────────────────────────────────────────────────────────────────────────────┐
│                                                                                          │
│                                       ┌──────────┐                                       │
│                                       │ Real NAT │                                       │
│                                       └──────────┘                                       │
│                                                                                          │
│  ┌────────────────────────────────────────────────────────────────────────────────────┐  │
│  │                                                                                    │  │
│  │               Namespace1                                  Namespace2               │  │
│  │ ┌────────────────────────────────────┐      ┌────────────────────────────────────┐ │  │
│  │ │                                    │      │                                    │ │  │
│  │ │   ┌────────┐        ┌─────────┐    │      │    ┌─────────┐        ┌────────┐   │ │  │
│  │ │   │ Agent1 ├────────┤ Router1 │    │      │    │ Router2 ├────────┤ Agent2 │   │ │  │
│  │ │   └────────┘        └─────────┘    │      │    └─────────┘        └────────┘   │ │  │
│  │ │ 10.0.0.2:55551   192.168.0.1:55555 │      │ 192.168.0.2:55555   10.0.0.2:55552 │ │  │
│  │ │                                    │      │                                    │ │  │
│  │ └────────────────────────────────────┘      └────────────────────────────────────┘ │  │
│  │                                                                                    │  │
│  └────────────────────────────────────────────────────────────────────────────────────┘  │
│                                                                                          │
│                                                                                          │
└──────────────────────────────────────────────────────────────────────────────────────────┘

The two namespaces each have their own IPs, but the real computer only has one. We need a way for the namespaces to communicate with eachother through this virtual NAT, keeping in mind that this communication may be intercepted by the real system's NAT.

There are two solutions I can think of here.

Create additional iptables rules on the network namespaces, something like a DNAT rule, to modify packets in some way to allow them to reach their destination (the other namespace). This could get confusing though.
It may be possible to get around this by creating direct veth links between the real computer and namespaces to aid with packet forwarding, but I'm not sure if this would work. Note that something like this would be required anyway for any agent inside a namespace to communicate with the testnet, since network namespaces are not automatically linked to the real network (and consequently the internet).

CMCDragonkai · 2022-08-12T06:57:02Z

How should the testnet be specified as a seed node in these tests? Using --network=testnet isn't working for me, and specifying the deployed nodes individually using --seed-nodes would be too brittle since the deployed agents change relatively frequently.

We will need to solve this in #403 and #285.

CMCDragonkai · 2022-09-13T01:09:39Z

This will rebase on top of #445 and will be next.

CMCDragonkai · 2022-09-13T01:10:03Z

Assuming all bugs are fixed.

CMCDragonkai · 2022-09-26T09:58:41Z

@tegefaulkes can you put up the list here in the PR description about all the tests that been disabled due to getting staging passing (from #411).

In this PR we will re-enable all of those tests, but after fixing everything.

tegefaulkes · 2022-09-27T02:29:07Z

Maybe they should be re-enabled in the PRs addressing the issues we disabled them for?

tegefaulkes · 2022-10-26T08:17:25Z

I've re-based on staging.

CMCDragonkai · 2022-10-26T08:21:47Z

tests/integration/testnet/testnetNAT.test.ts

+  test.todo('EIM to testnet.polykey.io', async () => {
+    // Local agent behind EIM NAT can ping testnet.polykey.io
+  });
+  test.todo('EDM to testnet.polykey.io', async () => {
+    // Local agent behind EDM NAT can ping testnet.polykey.io
+  });
+  test.todo('DMZ to EIM via testnet.polykey.io', async () => {
+    // Local agent behind DMZ can ping local agent behind EIM NAT using seed
+    // node signaller (and can ping back)
+  });
+  test.todo('DMZ to EDM via testnet.polykey.io', async () => {
+    // Local agent behind DMZ cannot ping local agent behind EDM NAT using seed
+    // node signaller (but can using relay) (and can ping back)
+  });
+  test.todo('EIM to EIM via testnet.polykey.io', async () => {
+    // Local agent behind EIM can ping local agent behind EIM NAT using seed
+    // node signaller (and can ping back)
+  });
+  test.todo('EIM to EDM via testnet.polykey.io', async () => {
+    // Local agent behind EIM cannot ping local agent behind EDM NAT using seed
+    // node signaller (but can using relay) (and can ping back)
+  });
+  test.todo('EDM to EDM via testnet.polykey.io', async () => {
+    // Local agent behind EDM cannot ping local agent behind EDM NAT using seed
+    // node signaller (but can using relay) (and can ping back)
+  });


These tests would all be moved to a sort of Polykey-Simulation repository. As we cannot control the firewall and NAT situation of the test runner in these unit tests.

CMCDragonkai · 2022-10-27T06:07:37Z

Remember to extract out the tests that will go into a simulation suite, and then tick off the tasks above too (and cross out ones that will be punted to the simulation suite).

tegefaulkes · 2022-10-27T06:29:21Z

I changed Integration Tests for testnet.polykey.com Polykey-CLI#71 to related since we want to merge this early and that's still being worked on.
The stub tests have been moved to a new branch called old_441_code.
This PR has been reduced to 2 tests, One for a local node to connect to and ping a seed node. The other has two nodes connect to the seed node and ping each other.

CMCDragonkai · 2022-10-27T06:32:19Z

Don't keep it in a separate branch. We often delete branches for pruning and we may lose that code. It's better to archive that, or create a new repo just for that. Let's put it into this repo https://gitlab.com/MatrixAI/Engineering/Polykey/Polykey-Simulation.

CMCDragonkai · 2022-10-27T06:33:22Z

Also copy any of the remaining tasks into the README:

[ ] Verification of seed node in local keynode's NodeGraph (pk nodes getall)
[ ] Sending notification to seed node (expect failure because no trust established, but this shouldn't show up locally)
[ ] Establishing trust of seed node with local keynode (pk identities trust)
[ ] Verifying node has been added to seed node's gestalt graph after trust has been established (pk identities get/list)
[ ] Sending notification to seed node, and verifying seed node received (will need to connect to testnet and run pk notifications read)

tegefaulkes · 2022-10-27T06:46:58Z

I moved it to the Polykey-Simulation gitlab repo

emmacasolin added the development Standard development label Aug 11, 2022

emmacasolin self-assigned this Aug 11, 2022

emmacasolin mentioned this pull request Aug 11, 2022

Add diagrams to NAT Traversal tests #388

Closed

11 tasks

emmacasolin force-pushed the feature-testnet-tests branch from b5e638d to 66fc3ea Compare August 11, 2022 00:53

CMCDragonkai mentioned this pull request Sep 8, 2022

Integrate TaskManager into NodeGraph and Discovery #445

Merged

15 tasks

CMCDragonkai assigned tegefaulkes and unassigned emmacasolin Sep 13, 2022

CMCDragonkai mentioned this pull request Sep 26, 2022

ci: merge staging to master #411

Merged

This was referenced May 15, 2023

Integration Tests for testnet.polykey.com MatrixAI/Polykey-CLI#71

Closed

Manual Testing of testnet.polykey.io #487

Closed

feat: diagrams for EIM and EDM NAT tests

1510854

tegefaulkes force-pushed the feature-testnet-tests branch from 0803541 to debbf15 Compare October 26, 2022 08:17

CMCDragonkai reviewed Oct 26, 2022

View reviewed changes

tegefaulkes force-pushed the feature-testnet-tests branch from 8c9011c to af4dc63 Compare October 27, 2022 04:40

feat: added tests for entering the testnet

833c65d

tegefaulkes force-pushed the feature-testnet-tests branch from af4dc63 to 833c65d Compare October 27, 2022 06:18

tegefaulkes added a commit that referenced this pull request Oct 27, 2022

removed stubs from #441

6a2da5e

tegefaulkes marked this pull request as ready for review October 27, 2022 06:38

tegefaulkes merged commit bb9f39b into staging Oct 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Integration tests for `testnet.polykey.io` #441

Integration tests for `testnet.polykey.io` #441

emmacasolin commented Aug 11, 2022 •

edited by tegefaulkes

Loading

ghost commented Aug 11, 2022 •

edited by ghost

Loading

CMCDragonkai commented Aug 11, 2022

emmacasolin commented Aug 12, 2022

emmacasolin commented Aug 12, 2022

CMCDragonkai commented Aug 12, 2022

CMCDragonkai commented Sep 13, 2022

CMCDragonkai commented Sep 13, 2022

CMCDragonkai commented Sep 26, 2022 •

edited

Loading

tegefaulkes commented Sep 27, 2022

tegefaulkes commented Oct 26, 2022

CMCDragonkai Oct 26, 2022

CMCDragonkai commented Oct 27, 2022

tegefaulkes commented Oct 27, 2022

CMCDragonkai commented Oct 27, 2022

CMCDragonkai commented Oct 27, 2022

tegefaulkes commented Oct 27, 2022

Integration tests for testnet.polykey.io #441

Integration tests for testnet.polykey.io #441

Conversation

emmacasolin commented Aug 11, 2022 • edited by tegefaulkes Loading

Description

Issues Fixed

Tasks

Final checklist

ghost commented Aug 11, 2022 • edited by ghost Loading

Legend

CMCDragonkai commented Aug 11, 2022

emmacasolin commented Aug 12, 2022

emmacasolin commented Aug 12, 2022

CMCDragonkai commented Aug 12, 2022

CMCDragonkai commented Sep 13, 2022

CMCDragonkai commented Sep 13, 2022

CMCDragonkai commented Sep 26, 2022 • edited Loading

tegefaulkes commented Sep 27, 2022

tegefaulkes commented Oct 26, 2022

CMCDragonkai Oct 26, 2022

Choose a reason for hiding this comment

CMCDragonkai commented Oct 27, 2022

tegefaulkes commented Oct 27, 2022

CMCDragonkai commented Oct 27, 2022

CMCDragonkai commented Oct 27, 2022

tegefaulkes commented Oct 27, 2022

Integration tests for `testnet.polykey.io` #441

Integration tests for `testnet.polykey.io` #441

emmacasolin commented Aug 11, 2022 •

edited by tegefaulkes

Loading

ghost commented Aug 11, 2022 •

edited by ghost

Loading

CMCDragonkai commented Sep 26, 2022 •

edited

Loading