← Back to issue list

Spread should run the doc tests with a nonroot user

View original Github issue

Metadata

Project
rockcraft
Number
#651
Type
issue
State
open
Author
cjdcordeiro
Labels
Type: Documentation
Created
Updated
Closed

Current evaluation

Request to run Spread doc tests as a nonroot user to catch permission-related documentation issues (e.g. #649). Open 768 days, last activity 263 days ago, 0 comments, labeled Type: Documentation, authored by a maintainer. No evidence of implementation yet.

Suggested action: keep open

Reason: Maintainer-authored issue with a clear, actionable scope (add nonroot user execution to the docs spread suite) and a concrete motivating example (#649). No maintainer has closed or deprioritized it, and the referenced problem (docker socket permissions in tutorials) is still relevant. Last activity was ~8.5 months ago with no resolution, so it is moderately stale but not obsolete.

Impact: 40 Quick Win: 26.0 Staleness: 55 Complexity: 35 Confidence: 72 Support Request: 5

Issue body

### What needs to get done By default, Spread will run the test suites with `sudo`. To be more comprehensive, and specifically for the doc tests (which are public-facing code blocks that must be reproducible), Spread should also run the tests as a nonroot user. ### Why it needs to get done If we only run the tests with `sudo`, then we'll fail to identify documentation bits that ignore how permissions might be set in the user's working environment. For example - #649 . In this case, testing that code block with a nonroot user would've helped identify the documentation issue in advance.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 40
Quick Win: 26.0
Staleness: 55
Complexity: 35
Confidence: 72
Support Request: 5
keep open Request to run Spread doc tests as a nonroot user to catch permission-related documentation issues (e.g. #649). Open 768 days, last activity 263 days ago, 0 comments, labeled Type: Documentation, authored by a maintainer. No evidence of implementation yet.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 40
Confidence: 70
Support Request: 10
needs triage Request to configure Spread to run documentation tests as a non-root user to catch permission-related documentation errors. Currently unaddressed with no maintainer comments or activity for over 7 months.
qwen3.6-35b-a3b-mtp-q6
Staleness: 80
Complexity: 25
Confidence: 70
Support Request: 0
needs triage Request to configure Spread to run documentation tests as a non-root user to catch permission-related issues. Currently open with no maintainer comments or activity in 208 days.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 25
Confidence: 60
Support Request: 0
needs triage Request to configure Spread to run documentation tests as a non-root user to catch permission issues. Open for over two years with no maintainer comments, assignee, or triage status.
qwen3.6-35b-a3b-mtp-q6
Staleness: 80
Complexity: 25
Confidence: 70
Support Request: 0
close stale Configure Spread to run documentation tests as a nonroot user to catch permission-related issues in public code examples. Open, zero comments, last active 186 days ago. Awaiting triage and assignment.

Update history

No update history recorded yet.

Related work

  • Related To: rockcraft#649 (confidence 85%)

    The issue explicitly cites #649 (docker run in tutorial fails due to Docker socket permissions) as the motivating example that a nonroot doc-test run would have caught.

Related issues

Issue Project State Summary Similarity
#839 Spread tests for documentation examples craft-parts open Feature request to add spread tests for documentation examples (like Rockcraft has). Open 721 days, no labels/assignee/comments, last activity 538 days ago. Pytest ignores tests/spread but no spread tests exist yet.
71%
#1962 Spread test the documentation examples charmcraft open Feature request to add spread tests for documentation examples (like Rockcraft) to prevent them from becoming outdated. Open since 2023, no labels/assignees, only a Jira-sync bot comment; no evidence of implementation.
71%