♻ reordering code in compartimented units for clarity

README.md

 # Federation Tests
 
-You'll find the documentation here: [feneas.git.feneas.org/federation/testsuite](https://feneas.git.feneas.org/federation/testsuite/)
+This test suite spins up pairs of instances for them to test simple federation
+scenarios, testing for various protocols. At the moment it doesn't test conformance
+to any protocol, but just ensures messages sent get received by the other end
+of the instance pair at test.
+
+## Documentation
+
+You will find the full documentation at: [feneas.git.feneas.org/federation/testsuite](https://feneas.git.feneas.org/federation/testsuite/)
+
+### Adding your software
+
+You can add your software to the list of supported projects by copying the
+`projects/testproject` directory and making your own helper and Dockerfile.
+The helper is used in the tests, which are defined in the `tests` directory.
+The Dockerfile is an adaptation of your software's Dockerfile, with the 
+addition of a custom entrypoint, required by the test suite.
+

scripts/build_docker_image.sh

@@ -3,7 +3,7 @@
 project=$(echo $CI_COMMIT_TAG |cut -d- -f2)
 
 # change into docker project
-cd $CI_PROJECT_DIR/$project || exit 1
+cd $CI_PROJECT_DIR/projects/$project || exit 1
 
 # authenticate with docker registry first
 docker login -u $DOCKER_USER -p $DOCKER_PASSWORD || exit 1

scripts/test.sh

@@ -4,7 +4,7 @@
 truncate --size 0 report.tap && tail -f report.tap &
 
 # run tests and save it as tap format
-bats --tap $(find . -name $PROJECT'*.bats') >> report.tap
+bats --tap $(find tests -name $PROJECT'*.bats') >> report.tap
 # remember exit code for later
 exitCode=$?
 

diaspora-ganggo.tx-rx.bats → tests/diaspora-ganggo.tx-rx.bats

 # vim:ft=sh
 
-load test_helper
-load ganggo_helper
+load '../test_helper'
+load '../projects/ganggo/ganggo_helper'
 
 @test "$btf create database" {
   create_database "g1"

ganggo-diaspora.tx-rx.bats → tests/ganggo-diaspora.tx-rx.bats

@@ -3,8 +3,8 @@
 # All API calls are documented here: https://ganggo.github.io/api/
 #
 
-load test_helper
-load ganggo_helper
+load '../test_helper'
+load '../projects/ganggo/ganggo_helper'
 
 @test "$btf create database" {
   create_database "g1"

ganggo-ganggo.tx-rx.bats → tests/ganggo-ganggo.tx-rx.bats

@@ -3,8 +3,8 @@
 # All API calls are documented here: https://ganggo.github.io/api/
 #
 
-load test_helper
-load ganggo_helper
+load '../test_helper'
+load '../projects/ganggo/ganggo_helper'
 
 @test "$btf create databases" {
   create_database "g1"

mastodon-mastodon.tx-rx.bats → tests/mastodon-mastodon.tx-rx.bats

 # vim:ft=sh
 
-load test_helper
+load '../test_helper'
 
 @test "$btf start mastodon#1 server" {
   start_app "m1" "3000" "mastodon"$(latest_tag "mastodon")

socialhome-ganggo.tx-rx.bats → tests/socialhome-ganggo.tx-rx.bats

@@ -3,9 +3,9 @@
 # All API calls are documented here: https://ganggo.github.io/api/
 #
 
-load test_helper
-load ganggo_helper
-load socialhome_helper
+load '../test_helper'
+load '../projects/ganggo/ganggo_helper'
+load '../projects/socialhome/socialhome_helper'
 
 @test "$btf create databases" {
   create_database "g1"

testproject.bats → tests/testproject.bats

@@ -2,7 +2,7 @@
 #
 # this test file is related to https://feneas.git.feneas.org/federation/testsuite
 
-load test_helper
+load '../test_helper'
 
 @test "$btf create databases" {
   for tp in tp1 tp2; do