https://github.com/FocusriteGroup/juce-end-to-end

Library to assist with end-to-end testing of JUCE desktop applications
https://github.com/FocusriteGroup/juce-end-to-end

Last synced: 3 months ago
JSON representation

Library to assist with end-to-end testing of JUCE desktop applications

• Host: GitHub
• URL: https://github.com/FocusriteGroup/juce-end-to-end
• Owner: FocusriteGroup
• License: apache-2.0
• Created: 2021-10-11T15:55:51.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-01T00:51:38.000Z (9 months ago)
• Last Synced: 2024-03-26T23:02:05.095Z (8 months ago)
• Language: C++
• Homepage:
• Size: 1.22 MB
• Stars: 83
• Watchers: 7
• Forks: 10
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-juce - juce-end-to-end - 2.0|88|4 months_{^󠀠󠀠🟢}| (Testing)

README

        
# JUCE End to End test framework

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/FocusriteGroup/juce-end-to-end/tree/main.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/FocusriteGroup/juce-end-to-end/tree/main)

[![Platform](https://img.shields.io/static/v1?label=Platform&message=macOS%20%7C%20windows&color=pink&style=flat)](./documentation/building.md)

[![Language](https://img.shields.io/static/v1?label=Language&message=C%2B%2B&color=orange&style=flat)](./documentation/building.md)

[![Code Style](https://img.shields.io/static/v1?label=Code%20Style&message=Clang%20Format&color=pink&style=flat)](https://clang.llvm.org/docs/ClangFormat.html)

[![Language](https://img.shields.io/static/v1?label=Language&message=TypeScript&color=orange&style=flat)](./documentation/building.md)

[![Code Style](https://img.shields.io/static/v1?label=Code%20Style&message=Prettier&color=pink&style=flat)](https://prettier.io)

[![Language](https://img.shields.io/static/v1?label=Language&message=CMake&color=orange&style=flat)](https://www.cmake.org)

[![Code Style](https://img.shields.io/static/v1?label=Code%20Style&message=CMake%20Format&color=pink&style=flat)](https://github.com/cheshirekow/cmake_format)

## What is it?

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

## Prerequisites

- [CMake](https://www.cmake.org). 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](https://nodejs.org/en/). 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](https://juce.com). 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](./documentation/integration-guide.md)

## Continuous Integration

Our Continuous Integration is [CircleCI](https://www.circleci.com). The config for circle is [here](./.circleci/config.yml)

## 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.

- [C++](./documentation/cplusplus.md)

- [JavaScript](./documentation/javascript.md)

- [CMake](./documentation/cmake.md)

## Scripts

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