Server

You can find the API definition. The server serves according to the API. It verifies the input and output for correctness.

To start the server, run

python -m schul_cloud_ressources_server_tests.app

The server should appear at http://localhost:8080/v1.

Tests

You always test against the running server. Tests may delete everyting you can reach. If you test the running server, make sure to authenticate in a way that does not destroy the data you want to keep.

python -m schul_cloud_ressources_server_tests.tests --url=http://localhost:8080/v1/

http://localhost:8080/v1/ is the default url.

Steps for Implementation

If you want to implement your server you can follow the TDD steps to implement one test after the other.

python -m schul_cloud_ressources_server_tests.tests -m step1
python -m schul_cloud_ressources_server_tests.tests -m step2
python -m schul_cloud_ressources_server_tests.tests -m step3
...

• step1 runs the first test

• step2 runs the first and the second test

• step3 runs the first, second and third test

• …

You can run a single test with

python -m schul_cloud_ressources_server_tests.tests -m step3only

Test Authentication

The test server supports api key authentication and basic authentication. If you test authentication over the internet. Use https to protect the secrets. Thus, an example test call to your api could look like this:

python -m schul_cloud_ressources_server_tests.tests  \
       --url=https://url.to/your/server               \
       --noauth=false --basic=username:password

If you have an api key, you can test that the server works.

python -m schul_cloud_ressources_server_tests.tests   \
       --url=http://url.to/your/server                \
       --noauth=false --apikey=apikey

By default the test server accepts authentication with several credentials

• no authentication

• basic:

  • user valid1@schul-cloud.org password 123abc

  • user valid2@schul-cloud.org password supersecure

• api key: abcdefghijklmn for the user valid1@schul-cloud.org. The client does not send the user name to the server.

To test these, you can add the --basic and --apikey parameters several times to the tests. The --noauth=true parameter is default. If the api only accepts authenticated requests, set --noauth=false.

python -m schul_cloud_ressources_server_tests.tests    \
       --basic=valid1@schul-cloud.org:123abc           \
       --basic=valid2@schul-cloud.org:supersecure      \
       --apikey=valid1@schul-cloud.org:abcdefghijklmn  \
       --noauth=true

All tests are run with the different authentication options. If we have several ways to authenticate, the tests test if the user sees the other users’ data.

It is assumed, that adding invalid to the password, user name and api key will make it invalid. Tests use the invalid credentials to test the server behavior in rejected cases.