← Back to issue list

test: add version test module

View original Github issue

Metadata

Project
starbase
Number
#560
Type
pull request
State
open
Author
medubelko
Labels
—
Created
Updated
Closed
—

Current evaluation

Adds a standalone docs version test and mocked conf.py helper, but the #532 fix landed later in #588/#590; it remains open despite green CI.

Suggested action: close superseded

Reason: The intended #532 fix was merged in #588 via commit 23328cd, with #590 removing the html_title override. The author also noted that the test might belong in the existing version integration test, making this disconnected test-and-mock approach obsolete despite passing CI.

Evaluated by: mr-cal-bot

Impact: 20 Quick Win: 3 Complexity: 32 Confidence: 97 Actionability: 20

Issue body

The version attribute inside a craft (`craft.__version__`) is generated by Setuptools, so it's outside of the scope of the modules. The docs, however, rely on it for the version in the toolbar. This PR adds a standalone test module for the version string, and checks against common values. It mocks a function that I plan to add to `conf.py`, but isn't implemented yet. This is a first step toward fixing #532. ## Concerns There's nothing to guarantee `conf.py` will have this function. We're creating a value in the docs, then mocking the logic in an unrelated test, so there's no coupling. I think it would be more ideal if each craft could provide something like `craft.__version_major_minor__`, so the logic would reside in the app itself, not the docs. Is there a simple place to put that? --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/starbase/blob/main/CONTRIBUTING.md). - [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [x] I've successfully run `make lint && make test`. - [ ] I've added or updated any relevant documentation. - [ ] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing. - [ ] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 20
Quick Win: 3
Complexity: 32
Confidence: 97
Actionability: 20
close superseded Adds a standalone docs version test and mocked conf.py helper, but the #532 fix landed later in #588/#590; it remains open despite green CI.
stealth/space-bunny-alpha
Impact: 22
Quick Win: 8
Complexity: 24
Confidence: 91
Actionability: 48
needs review Adds a standalone version-string test that mocks an unimplemented docs/conf.py helper, as a first step toward #532; all CI passes, but the author says it belongs in the existing version test.
qwen3.6-35b-a3b-mtp-q6
Impact: 30
Quick Win: 24
Staleness: 70
Complexity: 20
Confidence: 60
close stale Add version test module for starbase docs, mocking a planned conf.py function. Inactive for 52 days with 10 unresolved review comments.
qwen/qwen3.6-35b-a3b
Staleness: 15
Complexity: 12
Confidence: 85
needs review Adds a standalone test module for craft.__version__ and mocks a conf.py function. Currently pending review with 10 unresolved comments. Author recently noted the test might belong in an existing integration test.
qwen3.6-35b-a3b-mtp-q6
Staleness: 15
Complexity: 20
Confidence: 80
keep open Adds a standalone test module for the craft version string and mocks a future conf.py function. The author is reconsidering whether to merge this into an existing integration test.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/starbase#532 (confidence 100%)

    The PR explicitly describes itself as a first step toward this issue, which is now fixed by the later merged work.

  • Superseded By: canonical/starbase#588 (confidence 99%)

    Merged commit 23328cd implemented versioned documentation titles for #532.

  • Related To: canonical/starbase#590 (confidence 98%)

    Merged follow-up removed the html_title override as part of the same documentation-title fix.

Related issues

No related issues found above the similarity threshold.