status-im
/
cs-codex-dist-tests
mirror of
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
188 Commits 46 Branches 0 Tags 5.2 MiB
C# 99.1%
Shell 0.5%
Dockerfile 0.4%
Go to file
benbierens b92c1b970d
Sets up support for internal and external container addresses 		2023-06-01 09:35:18 +02:00
.github/workflows Add Docker builds 2023-05-28 23:10:17 +03:00
DistTestCore Sets up support for internal and external container addresses 2023-06-01 09:35:18 +02:00
KubernetesWorkflow Sets up support for internal and external container addresses 2023-06-01 09:35:18 +02:00
Logging Fixes issue where invalid log-replace statements cause test crash 2023-05-31 14:49:06 +02:00
LongTests pushes codex loglevel to configuration 2023-05-31 13:34:12 +02:00
Nethereum Sets up support for internal and external container addresses 2023-06-01 09:35:18 +02:00
Tests Sets up support for internal and external container addresses 2023-06-01 09:35:18 +02:00
Utils Clearly distinguishes between peer-connections that can't be made and problems with the node-to-test link. 2023-05-31 13:15:41 +02:00
docker Fix Docker repository link (#6) 2023-05-29 11:46:26 +03:00
.gitignore ADD Parallel download Tests 2023-04-19 12:34:46 +02:00
CONTRIBUTINGTESTS.MD Setup and contributing instructions 2023-05-01 16:26:26 +02:00
LOCALSETUP.MD Fixed some typos 2023-05-02 07:46:17 +02:00
README.md Merge branch 'master' into fix/check-network-policies 2023-05-30 23:03:00 +03:00
codexnode-manifest.yml Use codexstorage/nim-codex Docker images 2023-05-30 22:45:41 +03:00
cs-codex-dist-testing.sln Removes old backend 2023-04-17 07:56:08 +02:00

README.md

Distributed System Tests for Nim-Codex

Using a common dotnet unit-test framework and a few other libraries, this project allows you to write tests that use multiple Codex node instances in various configurations to test the distributed system in a controlled, reproducible environment.

Nim-Codex: https://github.com/codex-storage/nim-codex Dotnet: v6.0 Kubernetes: v1.25.4 Dotnet-kubernetes SDK: v10.1.4 https://github.com/kubernetes-client/csharp Nethereum: v4.14.0

Tests

Tests are devided into two assemblies: /Tests and /LongTests. /Tests is to be used for tests that take several minutes to hours to execute. /LongTests is to be used for tests that take hours to days to execute.

TODO: All tests will eventually be running as part of a dedicated CI pipeline and kubernetes cluster. Currently, we're developing these tests and the infra-code to support it by running the whole thing locally.

Test logs

Because tests potentially take a long time to run, logging is in place to help you investigate failures afterwards. Should a test fail, all Codex terminal output (as well as metrics if they have been enabled) will be downloaded and stored along with a detailed, step-by-step log of the test. If something's gone wrong and you're here to discover the details, head for the logs.

How to contribute tests

An important goal of the test infra is to provide a simple, accessible way for developers to write their tests. If you want to contribute tests for Codex, please follow the steps HERE.

Run the tests on your machine

Creating tests is much easier when you can debug them on your local system. This is possible, but requires some set-up. If you want to be able to run the tests on your local system, follow the steps HERE. Please note that tests which require explicit node locations cannot be executed locally. (Well, you could comment out the location statements and then it would probably work. But that might impact the validity/usefulness of the test.)

Missing functionality

Surely the test-infra doesn't do everything we'll need it to do. If you're running into a limitation and would like to request a new feature for the test-infra, please create an issue.