Enhance CMake build system and add developer readme (#75)

* Create module directory in CMake build dir
* Add 'make test' support to cmake
* Add developers readme
Co-authored-by: Andreas Gocht <andreas.gocht@tu-dresden.de>

Author: Flamefire

CMakeLists.txt

@@ -13,6 +13,24 @@ find_package(Python REQUIRED COMPONENTS Interpreter Development)
 Python_add_library(scorep_bindings src/scorep.cpp)
 target_link_libraries(scorep_bindings PRIVATE Scorep::Scorep)
 target_compile_features(scorep_bindings PRIVATE cxx_std_11)
+set_target_properties(scorep_bindings PROPERTIES
+  LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/site-packages/scorep
+)
+add_custom_target(ScorepModule ALL
+  ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_LIST_DIR}/scorep $<TARGET_FILE_DIR:scorep_bindings>
+  COMMENT "Copying module files to build tree"
+)
+
+enable_testing()
+add_test(NAME ScorepPythonTests
+         COMMAND Python::Interpreter test.py
+         WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/test
+)
+set(pythonPath ${CMAKE_CURRENT_BINARY_DIR}/site-packages)
+if(ENV{PYTHONPATH})
+  string(PREPEND pythonPath "$ENV{PYTHONPATH}:")
+endif()
+set_tests_properties(ScorepPythonTests PROPERTIES ENVIRONMENT "PYTHONPATH=${pythonPath}")
 
 set(INSTALL_DIR "lib/python${Python_VERSION_MAJOR}.${Python_VERSION_MINOR}/site-packages")
 

DEVELOPING.md

@@ -0,0 +1,29 @@
+# Developing
+We appreciate any contributions to the Score-P Python Bindings.
+However, there are a few policies we agreed on and which are relevant for contributions.
+These are detailed below. 
+
+## Formatting / Codestyle
+
+Readable and consistent code makes it easy to understand your changes.
+Therefore the CI system has checks using `clang-format-9` and `flake8` in place.
+Please make sure that these test pass, when making a Pull Request.
+These tests will tell you the issues and often also how to fix them.
+Prior to opening a Pull Request you can use the provided `.flake8` and `.clang-format` files, to check your code locally and run `clang-format-9` or `autopep8` to fix most of them automatically.
+
+## Build system
+
+The official way to build and install this module is using `pip`.
+Please make sure that all changes, you introduce, work with `pip install .`.
+
+However, you might have noticed that there is a CMake-based build system in place as well.
+We do not support this build system, and it might be outdated or buggy.
+Although, we do not actively maintain the CMake build system, and will not help you fix issues related to it, Pull Requests against it might be accepted.
+
+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 `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.
+Also, if you delete Python files, we recommended to clear and recreate the build folder.