Skip to content

Commit

Permalink
doc: adding more readmes per each root directory
Browse files Browse the repository at this point in the history
  • Loading branch information
Bidon15 committed Sep 2, 2022
1 parent d908e59 commit c5c9675
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 0 deletions.
16 changes: 16 additions & 0 deletions compositions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Compositions

Please navigate to the `manifest.toml` if you want to know more about which test cases/params are defined for the compositions
to set during test runs

## local-docker

This directory contains sanity compositions that can be easily run on a local PC or any small VM(e.g. DO droplet)
The motivation is to do quick regression check-ups if any PR arises from the stack(core/app/node etc.)

## cluster-k8s

This directory contains compositions that are described in `docs/test-plans`. The sorting of inner directories
are following the same pattern as the test-plan to test-case placement. Namings of directories and files follow this style:

`test-case-id` -> `participants-amount` -> `bandwidth-latency-per-participant`
11 changes: 11 additions & 0 deletions testkit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Testing Kit

This directory contains all necessary implementations that are utilized in `tests` directory

Mainly:

- Sync Topics
- App Creation and CLI handling
- Node Creation

Please follow up to dedicated inner `doc.go` for more details
8 changes: 8 additions & 0 deletions tests/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Tests

Each `*.go` follows the naming of the test-case in `docs/test-plan/test-plan-id/*`.

In order to not clutter the test-file with different participants' steps, each dedicated directory is created to
maintain steps of each types of participants.

The `common` directory is maintaining steps for a participant that plays the same role in every of the test-case(e.g. creating a validators set)

0 comments on commit c5c9675

Please sign in to comment.