/juce-end-to-end

End to end test framework designed for Juce applications

Primary LanguageC++Apache License 2.0Apache-2.0

JUCE End to End test framework

License

Contributor Covenant

Focusrite-Novation

Platform

Language Code Style

Language Code Style

Language Code Style

What is it?

This package provides a mechanism to end-to-end test a JUCE application

Prerequisites

  • CMake. Must be 3.18 or higher. Normally just get the latest version
    • CMake is used as the build system, as we as a pseudo package manager. It is the simplest way to use JE2E
  • Node. Should be 14.x, with npm 6.14.x
    • Node is used to manage the build and test process. You can manually execute any of the normal commands in Cmake and your compiler if you don't wish to use Node
  • JUCE. Should be >= 6.x
    • This project is designed to integrate with JUCE. We use large parts of the JUCE mainline. To make this project work, JUCE should be available on your compile path

Integration guide

To integrate into your project, please read the Integration Guide

Building

You can build on the command line, or using an IDE (We support XCode, CLion and VS2019 currently). See here for how to build.

CI

Our ci is CircleCI. The config for circle is here

Code formatting

We use a variety of code formatting tools. Please make sure you have these installed on your system to keep the codebase styling consistent.

Scripts

We have a variety of scripts available in our package.json. Learn more