README.md

---

💡 About

The Test Auto Runner (AutoTDD) is an automated testing tool which helps you continuously monitor the status of your project by enabling you to automatically run tests on changes to your project. When a test fails, you will get instant feedback on what went wrong. AutoTDD also supports integration with CI tools such as GitHub Actions and Travis CI.

💾 Installation

Via Metacello (recommended)

1. Make sure you have Metacello-Work installed.
2. In a new workspace load the project into your image by running:

Metacello new
  baseline: 'AutoTDD';
  repository: 'github://hpi-swa-teaching/AutoTDD:master/packages';
  onConflict: [:ex | ex allow];
  load

You should now be able to open AutoTDD by clicking on Test Auto Runner via the Apps menu.

Via direct SAR-Installation

1. Download the latest AutoTDD.sar file from the project's Releases.
2. Drag and drop AutoTDD.sar into your image and select install SAR.

You should now be able to open AutoTDD by clicking on Test Auto Runner via the Apps menu.

📦 Upgrading from v2 / v3

If you are upgrading from AutoTDD v2 or v3 please make sure to stop all currently running tests and close all AutoTDD-related windows before proceeding with the installation.

☝️ FAQ

What permissions are needed for GitHub Actions Tokens?

GitHub Actions tokens require repo and workflow permissions.

What kind of tests is AutoTDD suited for?

AutoTDD runs user-specified tests as soon as any relevant classes / methods undergo changes. As such, your tests will run quite frequently. Due to this, it is not advised to use AutoTDD for obtrusive or long-winded tests. This especially includes GUI tests where windows are opened / closed frequently.

How can I customize the test-runner?

AutoTDD supports customization for sounds as well as themes. To change what sounds AutoTDD uses, swap out the respective files in the Resources/AutoTDD/sounds directory and reload the sound player with:

ATDDSoundPlayer new generateSoundMethods

AutoTDD also supports various color schemes depending on the currently selected theme in your image. To change the look and feel of the GUI, select a new theme from Extras → Themes & Colors

Documentation

A more detailed and technical documentation can either be found in the class comments under the AutoTDD Wiki.