roblox-aether 0.3.8

Execute Luau tests on Roblox Cloud

Aether

Aether is a powerful CLI tool designed to execute Luau tests (TestEZ) directly on Roblox Cloud. It allows you to run unit tests from your local machine and see the results instantly, integrating seamlessly into your development workflow.

Features

• 🚀 Run Tests on Cloud: Execute tests in a live Roblox server environment.
• 📦 Rojo Integration: Automatically respects your default.project.json structure.
• ⚙️ Configurable: Use aether.toml to customize paths, timeouts, and more.
• 🔄 Watch Mode: Automatically re-run tests when files change (-w).
• 🤖 CI/CD Ready: Native support for GitHub Actions authentication.
• 🎯 Run Failed: Easily retry only failed tests with --failed.

Installation

Using pip

pip install roblox-aether

Using rokit

You can also install Aether using Rokit:

rokit add gado7h/aether

Quick Start

1. Initialize Configuration:

   aether init
   

   This creates a configuration file.

2. Set API Key (for local development):

   aether set-api <YOUR_API_KEY>
   

3. Run Tests:

   aether run
   

   or watch for changes:

   aether run --watch
   

Usage

Commands

• run [test_name]: Run tests. omit test_name to run all.
  • -v, --verbose: Show full logs.
  • -w, --watch: Watch mode.
  • -j, --json: JSON output.
  • --failed: Run only tests that failed in the previous run.
• init: Create default configuration.
• config: View current configuration.
• set-api <key>: Save API key.
• auth: CI/CD authentication helper.

Configuration (aether.toml)

[runner]
timeout = 60
tests_folder = "tests"

[project]
rojo_project = "default.project.json"

Environment & Debugging

Execution Environment

Tests run in a Roblox Cloud headless environment. This has some important limitations:

• No Physics Simulation: Gravity and physics stepping do not run automatically. The environment is "static". If your tests rely on physics, you may need to manually step the physics engine or mock it.
• Headless: No visual rendering.
• Script Context: Tests run inside a temporary script, often referred to as TaskScript.

Debugging

The runner automatically maps stack traces from the bundled TaskScript back to your original source files (supported for .luau files managed by Rojo).

• Tracebacks use relative paths for easier reading (e.g., src/my_script.server.luau:45).
• Use print() debugging freely; logs are streamed back to your terminal.

API Keys

API keys can be provided in three ways (checked in order):

1. CLI Argument: aether run --key <KEY> (mostly for CI)
2. Environment Variable: ROBLOX_API_KEY
3. User Configuration: Saved via aether set-api <KEY> (stored in your user home directory)

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.