Go to file
benbierens 5aff8c6f6d
setting up subcommands.
2023-10-24 14:07:15 +02:00
.github/workflows updates ci command 2023-09-21 14:42:45 +02:00
Framework Merge branch 'master' into feature/public-testnet-deploying 2023-10-24 09:42:37 +02:00
ProjectPlugins Removes codexdeployment from input of discord bot. 2023-10-24 13:48:24 +02:00
Tests Logs continuous test config at startup. 2023-10-23 14:17:52 +02:00
Tools setting up subcommands. 2023-10-24 14:07:15 +02:00
docker Pass a command during automated tests run (#65) 2023-09-19 17:53:15 +03:00
docs Update Continuous-Tests documentation (#67) 2023-09-25 20:04:06 +03:00
.gitignore ADD Parallel download Tests 2023-04-19 12:34:46 +02:00
CONTRIBUTINGPLUGINS.MD Updates the docs 2023-09-21 14:39:41 +02:00
CONTRIBUTINGTESTS.MD Updates the docs 2023-09-21 14:39:41 +02:00
README.md Updates READMEs 2023-09-29 10:19:59 +02:00
codexnode-manifest.yml Use codexstorage/nim-codex Docker images 2023-05-30 22:45:41 +03:00
cs-codex-dist-testing.sln Setting up codex discord bot plugin 2023-10-24 09:51:29 +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: v7.0
Kubernetes: v1.25.4
Dotnet-kubernetes SDK: v10.1.4 https://github.com/kubernetes-client/csharp
Nethereum: v4.14.0

Tests/CodexTests and Tests/CodexLongTests

These are test assemblies that use NUnit3 to perform tests against transient Codex nodes. Read more HERE

Tests/ContinousTests

A console application that runs tests in an endless loop against a persistent deployment of Codex nodes. Read more HERE

Tools/CodexNetDeployer

A console application that can deploy Codex nodes. Read more HERE

Framework architecture

The framework is designed to be extended by project-specific plugins. These plugins contribute functionality and abstractions to the framework. Users of the framework use these to perform tasks such as testing and deploying. Architecture

How to contribute a plugin

If you want to add support for your project to the testing framework, follow the steps HERE

How to contribute tests

If you want to contribute tests, 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.