Skip to content

Latest commit

 

History

History
43 lines (24 loc) · 3.47 KB

TESTING_AND_CI.md

File metadata and controls

43 lines (24 loc) · 3.47 KB
Raw

Roblogic Codespace Template Automated Testing and Continuous Integration

This document provides information about the automated test suite and continuous integration process used in the Roblogic Codespace Template project.

Table of Contents

  1. Introduction
  2. Automated Test Suite
  3. Continuous Integration Process
  4. Test Reports
  5. Contact

Introduction

The Roblogic Codespace Template project aims to provide a solid foundation for developers to quickly set up and work with a Roblogic project in a GitHub Codespace environment. Ensuring the quality and reliability of the code is crucial, and automated testing and continuous integration play a key role in achieving this goal. This document outlines the automated test suite, continuous integration process, and test reports generated for the project.

Automated Test Suite

The Roblogic Codespace Template project uses an automated test suite to verify the functionality and reliability of the code. The test suite includes unit tests, integration tests, and other types of tests as needed to ensure comprehensive coverage of the project's features and components.

The test suite uses the following testing frameworks for each primary language:

  1. React (JavaScript): Jest is used as the testing framework for React and JavaScript code. Jest is a popular and feature-rich testing framework that provides a wide range of utilities for testing JavaScript applications, including React components.

  2. Python: pytest is used as the testing framework for Python code. pytest is a powerful and flexible testing framework that simplifies the process of writing and running Python tests, offering advanced features and plugins for various testing scenarios.

Continuous Integration Process

The Roblogic Codespace Template project uses a continuous integration (CI) process to automatically run the test suite on each check-in to a shared repository for at least one branch. The CI process ensures that all submitted code is tested and verified before it is merged into the main branch.

The project uses GitHub Actions as the CI platform. GitHub Actions enables the creation of custom workflows that automate software development processes, such as building, testing, and deploying applications.

A GitHub Actions workflow is configured to run the test suite on every push to a shared repository and on every pull request targeting the main branch. This workflow ensures that all code is tested before it is merged into the main branch.

Test Reports

The automated test suite produces a report on test success or failure for each run. The report provides detailed information about the test results, including the number of tests executed, the number of tests passed, the number of tests failed, and any error messages or stack traces related to failed tests.

The test report is available in the GitHub Actions workflow run summary, which can be accessed through the GitHub repository's "Actions" tab. The test report helps developers identify and fix issues in their code, ensuring that the project maintains a high level of quality and reliability.

Contact

If you have any questions, issues, or suggestions related to automated testing or continuous integration, please open an issue on the GitHub repository.