Skip to content

Commit 3a4948e

Browse files
committed
Move the runner scripts into the OpenSpace folder. Move the backend folder into the root
1 parent 1626788 commit 3a4948e

46 files changed

Lines changed: 6 additions & 978 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
backend/node_modules
2-
runner/node_modules
3-
runner/out
4-
backend/data
5-
backend/config.json
6-
runner/config.json
7-
runner/testsuite/__pycache__
8-
runner/tests
9-
backend/frontend/node_modules
10-
backend/dist
1+
node_modules
2+
data
3+
config.json
4+
frontend/node_modules
5+
dist
6+
out
File renamed without changes.
File renamed without changes.

README.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,6 @@ Important terms to understand the testing results:
1313
| Difference image | An image that shows the pixel differences between the reference image and a candidate image. |
1414

1515

16-
## Runner
17-
The _Runner_ is a Python script that will execute and possibly submit test results to a regression server. To execute the _Runner_, the `requests` and `openspace-api` PIP packages need to be installed, for example using `pip install requests && pip install openspace-api`. The `main.py` inside the `runner` folder can then be called to run individual tests. Executing `main.py --help` will return all commandline parameters that can be used to customize the program execution. The available commandline arguments are as follows:
18-
19-
| Parameter | Description |
20-
| --------- | ----------- |
21-
| `--dir` | Points to the base folder of the OpenSpace version that is used to execute the tests. There needs to be a compiled version of OpenSpace available in that folder such that `bin/RelWithDebInfo/OpenSpace.exe` (on Windows) or `bin/OpenSpace` (on Linux) exists and is executable. The base test folder will also be taken from this parameter as `tests/visual`. |
22-
| `--test` | A comma-separated list of the group/name combination of the tests that should be run. The group of a test is all of the folders relative to the `tests/visual` server concatenated with the name of the test being the filename. For example a test in `tests/visual/mars/insight/landing.ostest` would have the group "mars/insight" and the name "landing". |
23-
| `--overwrite` | This path can be provided to store commonly used files that can be useful to keep between test runs. Right now, this is only used for the Sync folder and the MRF cache used by OpenSpace.|
24-
25-
Example: `python main.py --dir C:/Development/OpenSpace --test default/earth,rosetta/model default --overwrite C:/Development/TestCache`
26-
27-
Additionally, a `config.json` must be provided if tests are to be submitted to the regression server. The `config.sample.json` provides a stub that can be used as the starting point for configuring the JSON file.
28-
29-
If no `config.json` is found, all tests are run locally and are not submitted to the regression server. Instead all resulting images are stored in a `tests` folder whose subfolders mimick the folder structure found in the `visualtests` folder, resulting in images that can be manually inspected.
30-
31-
If a `config.json` is provided, it requires the specification of the URL at which the regression server is located, the hardware string under which the test images are submitted, and a runner id that has to be provided by the administrator of the regression test server. If all these values are correct, test images are directly submitted to the regression server and be can used to compare against a reference image.
32-
3316
### Helper scripts
3417
The runner folder also contains useful helper scripts that can be used to communicate with the image testing server.
3518

backend/.gitignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

backend/README.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)