e2e

Local Redmine E2E

This directory contains a local end-to-end harness for redmine-cli.

It uses:

• Docker Official Image redmine:7.0 by default
• postgres:16-alpine
• The default Redmine admin account to derive an API key for CLI tests

The harness is version-aware. The supported matrix in this repo is:

• 4.2
• 5.1
• 6.1
• 7.0

If you want to test a custom image, set E2E_IMAGE when you start the stack.

Start Redmine

make e2e-up

That starts Docker Compose from compose.yaml, waits until Redmine is reachable, and bootstraps the instance for CLI testing by enabling the Redmine REST API.

To choose a supported Redmine line explicitly:

make e2e-up E2E_VERSION=4.2
make e2e-up E2E_VERSION=5.1
make e2e-up E2E_VERSION=6.1
make e2e-up E2E_VERSION=7.0

To override the Redmine image:

make e2e-up E2E_IMAGE=your-registry/redmine:7.0-custom

It has to be a make variable, not an environment variable: the recipe passes REDMINE_IMAGE=$(E2E_IMAGE) to Docker Compose itself, and that assignment wins over anything inherited from the environment.

Write a local CLI config

make e2e-config

By default this writes ./.redmine-cli.e2e.yaml in the repo root using the admin user's Redmine API key against http://127.0.0.1:3000.

Run the Go e2e suite

make e2e-test

The tests build the CLI once, then each test provisions its own project/issue fixtures (cleaned up via t.Cleanup) and drives the CLI against the local Redmine instance. The suite is split into topical files:

Shared infrastructure lives in e2e_test.go (TestMain + requireE2E), runner_test.go (CLI runner + profile constructors), helpers_test.go (envelope types + env accessors) and fixtures_test.go (project / issue fixtures, tracker / activity lookups).

bootstrap-redmine.sh seeds the fixtures that have no REST endpoint: a public saved query, an issue custom field (E2E Severity, applied to all projects) and a role-restricted time entry custom field (E2E Billing Code, seeded visible: false so the role restriction has meaning). The seeding uses save! throughout: a fixture that cannot be created should stop the bootstrap, not degrade quietly into a confusing test failure later.

Version-gated assertions

Some behaviour only exists from a given Redmine line onwards. Gate those assertions with the helpers in helpers_test.go rather than parsing REDMINE_E2E_VERSION inline:

• skipBelowRedmine(t, 7, 0, "…") skips the test on older servers.
• redmineAtLeast(5, 0) branches on the version, e.g. to pick Textile over Markdown.

An unset REDMINE_E2E_VERSION counts as "new enough", so ad-hoc runs against an unknown server still exercise the newest assertions.

Adding a new test

1. Create <feature>_test.go with //go:build e2e at the top.
2. Call requireE2E(t) first.
3. Build a runner with newCLIRunner (API key) or newCLIRunnerBasicAuth.
4. Use createTestProject / createTestIssue for any write fixtures so cleanup is handled automatically.
5. Decode CLI JSON output with runner.runJSON(t, &dest, ...) and assert on the decoded struct rather than the raw bytes.
6. For commands that must fail, use runner.runExpectError(t, ...) and decode into errorEnvelope.

To run the full supported-version matrix sequentially:

make e2e-matrix

The matrix uses separate ports per Redmine line to avoid collisions:

• 4.2 -> http://127.0.0.1:3402
• 5.1 -> http://127.0.0.1:3501
• 6.1 -> http://127.0.0.1:3601
• 7.0 -> http://127.0.0.1:3700

Tear it down

make e2e-down

Environment overrides

• REDMINE_E2E_BASE_URL
• REDMINE_E2E_USERNAME
• REDMINE_E2E_API_KEY
• REDMINE_E2E_PASSWORD - admin password forced by bootstrap-redmine.sh and used by basic-auth tests. make e2e-up / make e2e-test default this to admintest123. Tests that need basic auth are skipped when this is empty.
• REDMINE_E2E_TIMEOUT_SECONDS
• REDMINE_E2E_CONFIG_PATH
• REDMINE_E2E_PROFILE_NAME
• E2E_IMAGE - Makefile-level override for the Redmine image. REDMINE_IMAGE is set by the recipe and cannot be overridden from the environment.
• E2E_VERSION
• E2E_PORT
• E2E_PASSWORD - Makefile-level override for the forced admin password (propagates into REDMINE_E2E_PASSWORD).