Use test_ prefix only for actual unit test files to allow the usage of Pytest (#81)

* Use test_ prefix only for actual unit test files

New developers and some test frameworks (e.g. pytest) search for files
named 'test_*.py' or '*_test.py' to discover test cases. However
currently the naming may be confusing as the files named 'test_*.py' contain
code to be executed by the unittests not the actual unittest itself.
This also leads to errors in e.g. the Python VSCode extension which
autodiscovers tests using the above naming scheme,

This renames all test_ files removing the prefix or adding bm_ as the
prefix for benchmark helpers together with a more descriptive name.
The main test entrypoint is now test_scorep.py.
No code changes (except where files were referenced) are done.

* Introduce cases folder for files run by the unit tests

Author: Flamefire

.github/workflows/unit_tests.yml

@@ -53,4 +53,4 @@ jobs:
       run: pip install .
     - name: Run tests
       working-directory: test
-      run: ./test.py
+      run: ./test_scorep.py

.travis.yml

@@ -20,4 +20,4 @@ install:
   - pip install mpi4py numpy
 
 script:
-  - pip install ./ && cd test && python test.py
+  - pip install ./ && cd test && python test_scorep.py

CMakeLists.txt

@@ -26,7 +26,7 @@ add_custom_target(ScorepModule ALL
 
 enable_testing()
 add_test(NAME ScorepPythonTests
-         COMMAND Python::Interpreter test.py
+         COMMAND Python::Interpreter test_scorep.py
          WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/test
 )
 set(pythonPath ${CMAKE_CURRENT_BINARY_DIR}/site-packages)

DEVELOPING.md

@@ -22,7 +22,7 @@ Although, we do not actively maintain the CMake build system, and will not help
 
 You might find this build system helpful for development, especially if you are doing C/C++ things:
 * Include paths for C++ are correctly searched for and set up for use by IDEs or other tools. For example Visual Studio Code works out of the box, given the appropriate extensions (C++, Python, CMake) are installed.
-* A folder `site-packages` is created in the build folder where the C/C++ extension module and the scorep module are copied to on each build (e.g. `make`-call). Hence it is possible to add that folder to the PYTHONPATH environment variable, build the project and start debugging or execute the tests in test/test.py.
+* A folder `site-packages` is created in the build folder where the C/C++ extension module and the scorep module are copied to on each build (e.g. `make`-call). Hence it is possible to add that folder to the PYTHONPATH environment variable, build the project and start debugging or execute the tests in test/test_scorep.py.
 * A `test` target exists which can be run to execute all tests.
 
 Please note, that changes to the Python source files are not reflected in the build folder unless a build is executed.

benchmark/benchmark.py

@@ -7,12 +7,12 @@
 import pickle
 
 bench = benchmark_helper.BenchmarkEnv(repetitions=51)
-tests = ["test_1.py", "test_2.py"]
+tests = ["bm_baseline.py", "bm_simplefunc.py"]
 results = {}
 
 reps_x = {}
-reps_x["test_1.py"] = ["1000000", "2000000", "3000000", "4000000", "5000000"]
-reps_x["test_2.py"] = ["100000", "200000", "300000", "400000", "500000"]
+reps_x["bm_baseline.py"] = ["1000000", "2000000", "3000000", "4000000", "5000000"]
+reps_x["bm_simplefunc.py"] = ["100000", "200000", "300000", "400000", "500000"]
 
 for test in tests:
     results[test] = {"profile": {}, "trace": {}, "dummy": {}, "None": {}}