Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
integration
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Package registry
Model registry
Operate
Terraform modules
Analyze
Contributor analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
elixxir
integration
Commits
855f2e3e
Commit
855f2e3e
authored
3 years ago
by
Josh Brooks
Browse files
Options
Downloads
Patches
Plain Diff
WIP: Update README
parent
afbbae65
No related branches found
No related tags found
3 merge requests
!68
Master merge
,
!24
Josh/local env migration
,
!11
Release
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+29
-5
29 additions, 5 deletions
README.md
with
29 additions
and
5 deletions
README.md
+
29
−
5
View file @
855f2e3e
...
@@ -2,11 +2,35 @@
...
@@ -2,11 +2,35 @@
## Purpose
## Purpose
This is to automatically test all the system's components and make sure they
This is to automatically test all the system's components and make sure they
work together correctly. If the integration test passes, it should guarantee
work together correctly. There are 2 testing suite packages
that clients can send messages all the way through the system, including
(smokeinfra and basice2e) and a general long-running network package (localNetwork).
mixing with multiple nodes and an anonymity set greater than 1. If the
integration test fails, look at the logs and narrow down the cause by adding
### Testing Suites
more logging statements if necessary.
These testing suites are used by the xx network team to ensure basic functionality
of the network and its clients. It is a part of their CI/CD workflow. If the
integration tedigga#1
st fails with an unknown or unhandled error, they look at the logs
to narrow down and resolve the issue.
[
//
]:
#
(link to the readme?)
[
SmokeInfra
](
./smokeinfra/
)
is a simple test of the xx network, ensuring that rounds are running.
Generally speaking, this is for the xx network team and developers that wish to
contribute to how the network operates.
[
BasicE2E
](
./basice2e
)
determines whether clients can send messages all the way through the system, including
mixing with multiple nodes and an anonymity set greater than 1. There are several
tests of the client in this package, including features such as group messaging,
file transfer, etc. Whenever a new feature is introduced to the client by the
xx network development team, a new test for this feature
is added to this testing suite via the run script (
`run.sh`
)
## Local Network
The
[
localNetwork package
](
./localNetwork
)
is a more general use network tool.
This package will run a local version of the xx network on a single machine.
This can be done either via the
`run.sh`
script, which will run the network entirely
locally with internal IP addresses, or the
`runpublish.sh`
, which runs the network
with remotely accessible IP addresses.
## How to manually run locally
## How to manually run locally
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment