Integration Tests for Docker - Convert `tests/bin` using mocks to using CLI, PolykeyAgent conversion

tegefaulkes commented 2 years ago

Specification

Due to time constraints not all of the tests could be made functional for the docker integration tests. The tests are disabled until we can convert them.

Due to our docker/dind setup we have limitations on what tests could work. This is mainly due to networking constraints. For a client to connect to an agent in the CI tests we require that both the client and agent run as a docker container inside the dind. Due to this we can't use any mocking or a polykeyAgent running inside the test thread.

Where we are using a 'PolykeyAgentwe will need to replace it with an agent running in a docker container using a pkXSwitch function. This means any modification to the agent will be done through a bin command run with a pkXSwitch command as well. Mocking will not be possible and any test using such will have to be disabled for docker tests.

A full list of tests to convert will be provided soon.

Additional context

Related MatrixAI/Polykey#391 Related MatrixAI/Polykey-CLI#10 Related MatrixAI/Polykey#407

Tasks

[ ] 1. convert all test files using createPolykeyAgent to spawn an agent
[ ] 2. Expand this with a list of all test files where this can be done.

tegefaulkes commented 2 years ago

lists of tests that were disabled:

tests/bin/identities - mocked browser + agent + provider
tests/bin/keys
- tests/bin/keys/renew.test.ts - key mocking
- tests/bin/keys/reset.test.ts - key mocking
tests/bin/nodes/add.test.ts - mocking ping node
tests/bin/nodes/claim.test.ts - agent
tests/bin/nodes/find.test.ts - connected agents
tests/bin/nodes/ping.test.ts - connected agents
tests/bin/secrets/secrets.test.ts - agent
tests/bin/vaults/vaults.test.ts - agent, mocking
tests/bin/utils.retryAuthentication.test.ts - no spawnng in tests
tests/bin/utils.test.ts - no spawning

tegefaulkes commented 2 years ago

There is a plan to change up how the implementation tests are set up. Currently we filter the tests based on boolean conditions. We're looking at defining each test as an arrow function, then we can define multiple test suites by importing them and setting them up with the test methods.

This will depend on that.

CMCDragonkai commented 1 year ago

Moving to Polykey-CLI.

CMCDragonkai commented 10 months ago

The big integration testing epic is in https://github.com/MatrixAI/Polykey-CLI/issues/71.

I'm going to move that to here. Since integration testing doesn't actually occur on Polykey the library.

MatrixAI / Polykey-CLI