https://github.com/madskjeldgaard/supercolliderplugin-catch2
An example plugin for SuperCollider with the Catch2 testing framework setup for automatic testing
https://github.com/madskjeldgaard/supercolliderplugin-catch2
catch2 cmake supercollider supercollider-ugens
Last synced: 4 months ago
JSON representation
An example plugin for SuperCollider with the Catch2 testing framework setup for automatic testing
- Host: GitHub
- URL: https://github.com/madskjeldgaard/supercolliderplugin-catch2
- Owner: madskjeldgaard
- License: gpl-3.0
- Created: 2020-12-19T00:05:58.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-12-19T17:04:38.000Z (over 5 years ago)
- Last Synced: 2025-03-12T06:42:10.517Z (over 1 year ago)
- Topics: catch2, cmake, supercollider, supercollider-ugens
- Language: CMake
- Homepage:
- Size: 22.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PluginWithTests
Author: Mads Kjeldgaard
A simple plugin example with the [Catch2](https://github.com/catchorg/Catch2) testing framework added as a submodule and setup properly in CMake.
It is setup so that the `plugins` folder is included in the header search path of the `test` folder so that including `plugins/CrazyPluginHeader.hpp` in your tests may be done using `#include "CrazyPluginHeader.hpp"`
### Testing
Testing is enabled by default (this can be disabled by setting the option `BUILD_WITH_TEST` to `OFF`).
This creates an executable in your builds directory called `plugintest` that may be run after compilation.
From the root of the repository, run
```bash
./build/plugintest
```
This will run the tests defined in `test/main.cpp`
### Requirements
- CMake >= 3.5
- SuperCollider source code
### Building
Clone the project:
git clone --recurse-submodules https://github.com/madskjeldgaard/supercolliderplugin-catch2
cd pluginwithtests
mkdir build
cd build
Then, use CMake to configure and build it:
cmake .. -DCMAKE_BUILD_TYPE=Release
cmake --build . --config Release
cmake --build . --config Release --target install
You may want to manually specify the install location in the first step to point it at your
SuperCollider extensions directory: add the option `-DCMAKE_INSTALL_PREFIX=/path/to/extensions`.
It's expected that the SuperCollider repo is cloned at `../supercollider` relative to this repo. If
it's not: add the option `-DSC_PATH=/path/to/sc/source`.
### Developing
Use the command in `regenerate` to update CMakeLists.txt when you add or remove files from the
project. You don't need to run it if you only change the contents of existing files. You may need to
edit the command if you add, remove, or rename plugins, to match the new plugin paths. Run the
script with `--help` to see all available options.