Skip to content

README.md

Latest commit

 

History

History
98 lines (58 loc) · 3.55 KB

README.md

File metadata and controls

98 lines (58 loc) · 3.55 KB

Manual Tests

This directory contains interactive manual tests and scripts to verify the functionality of mstl and mstl-gh.

These tests are designed to be run in an isolated environment (like Docker) to avoid modifying your local configuration or creating persistent repositories on your GitHub account (although the tests do create and delete temporary repositories).

Prerequisites

  • Docker: Recommended for running tests in a clean environment.
  • GitHub Personal Access Token (PAT): Required for mstl-gh tests to authenticate with GitHub. The token needs repo and delete_repo scopes.

Running Tests with Docker (Recommended)

The easiest way to run these tests is using the provided Dockerfile. This ensures all dependencies (Go, Python, git, gh CLI) are installed and configured correctly.

1. Build the Docker Image

You can build the image in two ways:

Option A: Build with Pre-Authentication (Recommended)

Pass your GitHub token as a secret. This creates an image where gh is already logged in, so you don't need to authenticate every time you run the container.

Setting the Secret:

To pass the secret, you generally use the --secret flag with docker build. You can source the secret from an environment variable or a file.

Method 1: Using an Environment Variable (Simplest)

Ensure you have your token in an environment variable (e.g., GITHUB_TOKEN).

export GITHUB_TOKEN="ghp_your_token_here"
# The 'env=GITHUB_TOKEN' part tells Docker to read the value from your shell's environment variable
docker build --secret id=mistletoe_manual_test_github_token,env=GITHUB_TOKEN -t mstl-gh-test -f manual_tests/Dockerfile.manual_test .

Method 2: Using a File

If you have your token in a file (e.g., my_token.txt):

docker build --secret id=mistletoe_manual_test_github_token,src=my_token.txt -t mstl-gh-test -f manual_tests/Dockerfile.manual_test .

Note: The id must be exactly mistletoe_manual_test_github_token as expected by the Dockerfile.

Option B: Standard Build

Build the image without a token. You will need to log in manually inside the container.

docker build -t mstl-gh-test -f manual_tests/Dockerfile.manual_test .

2. Run the Container

Start the container interactively, mounting the current directory so you can edit scripts if needed.

docker run -it --rm -v $(pwd):/app mstl-gh-test /bin/bash

3. Run Test Scripts

Inside the container, navigate to the manual_tests directory (if not already there) and run the desired test script using Python 3.

If you didn't use Option A (Pre-Authentication), run gh auth login first.

Example: Test Pull Request Creation (mstl-gh)

python3 manual_tests/manual_test_gh_pr_create.py

Example: Test Core Functionality (mstl)

python3 manual_tests/manual_test_mstl.py

Follow the on-screen prompts. These scripts act as interactive guides, performing setup steps automatically and pausing to let you verify the results (e.g., checking URLs in your browser).

Available Tests

For a complete list of available manual tests, their descriptions, and corresponding design documentation, please refer to:

docs/manual_tests/index.md

Cleanup

The test scripts attempt to clean up the temporary repositories they create (prefixed with mistletoe-test- or similar) upon completion or failure.

If a test is interrupted and artifacts remain, you can run the cleanup script (requires gh authentication):

python3 manual_tests/temp_repos_cleanup.py