Browse Source

Update doc

content-update
Xavier Petit 4 years ago committed by xpetit
parent
commit
476d6f5f76
  1. 31
      tests/README.md
  2. 10
      tests/service.sh

31
tests/README.md

@ -4,20 +4,27 @@
The tests must be in a Docker image that will be executed with (among others) the following options : The tests must be in a Docker image that will be executed with (among others) the following options :
- `--read-only` Mount the container's root filesystem as read only - `--read-only` Mount the container's root filesystem as read only
- `--user 1000:1000` Avoid to give root rights - `--user 1000:1000` Avoid to give root rights
- `--tmpfs /jail:size=200M,noatime,exec,nodev,nosuid,uid=1000,gid=1000,nr_inodes=5k,mode=1700` Mount a 200MB tmpfs directory to create files and run tests - `--tmpfs /jail:size=200M,noatime,exec,nodev,nosuid,uid=1000,gid=1000,nr_inodes=5k,mode=1700` Mount a 200MB tmpfs directory to create files and run tests
- `--memory 500M` Memory limit of 500 MB - `--memory 500M` Memory limit of 500 MB
- `--cpus 2.0` Number of CPUs (2 threads) - `--cpus 2.0` Number of CPUs (2 threads)
- `--mount readonly,type=volume,source=student/username,destination=/app/student` The student's code is available in /app/student - `--mount readonly,type=volume,source=student/username,destination=/app/student` The student's code is available in /app/student
- `--env HOME=/jail` Set the only writable folder as home directory - `--env HOME=/jail` Set the only writable folder as home directory
- `--env TMPDIR=/jail` Set the only writable folder as temporary directory - `--env TMPDIR=/jail` Set the only writable folder as temporary directory
- `--env USERNAME=` Username - `--env USERNAME=` Username
- `--env EXERCISE=` Exercise name - `--env EXERCISE=` Exercise name
- `--env DOMAIN=` Domain name (e.g. gp.ynov-bordeaux.com) - `--env DOMAIN=` Domain name (e.g. gp.ynov-bordeaux.com)
- `--env EXPECTED_FILES=` A space-separated list of required files - `--env EXPECTED_FILES=` A space-separated list of required files
The username is the Gitea login. The username is the Gitea login.
No command or arguments are used, the entrypoint has to run the tests. No command or arguments are used, the entrypoint has to run the tests.
The exit status of the container will determine whether or not the test has passed. The exit status of the container will determine whether or not the test has passed.
Any output will be printed in the platform but not interpreted. Any output will be printed in the platform but not interpreted.
### Building
```console
docker build go -t tests-go
docker build sh -t tests-sh
```

10
tests/service.sh

@ -1,10 +0,0 @@
#!/usr/bin/env bash
. "$WRAPPER"
check_command docker "https://docs.docker.com/install"
if test "$1" = "build"; then
docker build go -t tests-go
docker build sh -t tests-sh
fi
Loading…
Cancel
Save