codex-storage
/
cs-codex-dist-tests
mirror of https://github.com/codex-storage/cs-codex-dist-tests.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Distributed System Tests for Nim-Codex
1,087 Commits 46 Branches 0 Tags 6 MiB
C# 99.1%
Shell 0.5%
Dockerfile 0.4%
Go to file
Ben ba43fd90c6
Adds admin option to set custom replacements 		2024-06-27 11:16:17 +02:00
.github/workflows Sets up docker image for creating keys 2024-06-19 14:04:27 +02:00
Framework Disables role rewards (not configured in real server) 2024-06-26 11:27:19 +02:00
ProjectPlugins Adds events formatter 2024-06-27 10:07:10 +02:00
Tests Updates to new Codex image. Fixes tests 2024-06-21 11:29:05 +02:00
Tools Adds admin option to set custom replacements 2024-06-27 11:16:17 +02:00
docker Update Runners Jobs nodeSelector (#86) 2023-11-27 19:22:28 +02: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 Overdue readme updates 2024-03-27 15:01:32 +01:00
CONTRIBUTINGTESTS.MD fix Continous typo 2023-10-26 20:27:44 +08:00
README.md Overdue readme updates 2024-03-27 15:01:32 +01:00
codexnode-manifest.yml Use codexstorage/nim-codex Docker images 2023-05-30 22:45:41 +03:00
cs-codex-dist-testing.sln Sets up docker image for creating keys 2024-06-19 14:04:27 +02:00

README.md

Distributed System Tests

This project allows you to write tools and tests that control and interact with container-based applications to form a distributed system in a controlled, reproducible environment.

Dotnet: v7.0
Kubernetes: v1.25.4
Dotnet-kubernetes SDK: v10.1.4 https://github.com/kubernetes-client/csharp
Nethereum: v4.14.0

Currently, this project is mainly used for distributed testing of Nim-Codex. However, its plugin-structure allows for other projects to be on-boarded (relatively) easily. (See 'contribute a plugin`.)

Tests/DistTestCore

Library with generic distributed-testing functionality. Uses NUnit3. Reference this project to build unit-test style scenarios: setup, run test, teardown. The DistTestCore responds to the following env-vars:

  • LOGPATH = Path where log files will be written.
  • DATAFILEPATH = Path where (temporary) data files will be stored.
  • ALWAYS_LOGS = When set, DistTestCore will always download all container logs at the end of a test run. By default, logs are only downloaded on test failure.

Tests/CodexTests and Tests/CodexLongTests

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

Tests/ContinuousTests

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.