vacp2p
/
cs-codex-dist-tests
mirror of https://github.com/vacp2p/cs-codex-dist-tests.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Distributed System Tests for Nim-Codex
138 Commits 1 Branch 0 Tags 1.3 MiB
C# 99.6%
Shell 0.4%
Go to file
benbierens 085c4431a2
Setup and contributing instructions 		2023-05-01 16:26:26 +02:00
DistTestCore Cleanup and support for automatic bootstrap tests 2023-05-01 11:14:42 +02:00
KubernetesWorkflow Much nicer logging by means of container name-override and long-id log replacements 2023-04-30 10:56:19 +02:00
Logging Much nicer logging by means of container name-override and long-id log replacements 2023-04-30 10:56:19 +02:00
LongTests Removes BringOnline method 2023-04-25 12:52:11 +02:00
Nethereum Supports multiple codex nodes from a single geth companion node. 2023-04-26 11:12:33 +02:00
Tests Setup and contributing instructions 2023-05-01 16:26:26 +02:00
Utils Adds debug logging support 2023-04-25 11:31:15 +02: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 Setup and contributing instructions 2023-05-01 16:26:26 +02:00
README.md Setup and contributing instructions 2023-05-01 16:26:26 +02:00
codexnode-manifest.yml example yml 2023-03-23 12:36:36 +01: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, reproducable environment.

Nim-Codex: https://github.com/status-im/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 details, 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 an 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.