oxidecomputer / oxidecomputer/omicron

cargo xtask openapi generate should warn users about tests that need updating

Open
#9,745 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

api nexus openapi
Dominant language
Rust
Stars
572
Forks
97
Avg merge
2d 12h
Merged PRs (30d)
96

Description

Specifically, after adding an endpoint to an external Nexus API, test_unauthorized_coverage will fail. It needs to be re-run with EXPECTORATE=overwrite. Warning will prevent users from finding out from CI and waiting for another round trip.

While we could automatically run this test from within cargo xtask openapi generate it would significantly slow down that operation as it would require building nexus and running the test even for changes that are not to nexus.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The entry point is cargo xtask openapi generate; start by locating its implementation and reviewing how it handles external Nexus API changes. Check test_unauthorized_coverage and its EXPECTORATE=overwrite workflow, then verify the command warns users to rerun the test without executing it automatically.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, rust
Domain
api, testing
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.