Skip to content

test(geolibre): mark the langpack test wait; run test-hygiene on every PR - #2323

Merged
giswqs merged 2 commits into
mainfrom
fix/langpack-test-wait
Nov 17, 2026
Merged

giswqs merged 2 commits into
mainfrom
fix/langpack-test-wait

Conversation

@giswqs

@giswqs giswqs commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

Fixes CI on main (run 44008397027): xtask test_hygiene::tests::repository_tests_follow_the_guardrails failed on every platform with

crates/geolibre/src/langpack.rs:735: timer wait in test: wait on the job's completion or progress signal, not on time; if time is essential, add // test-wait: <reason> on this line

Cause: #2289 added a test that sleeps 200 ms to show remove() stays blocked while a check holds LIFECYCLE. Its merge-queue run (44005866127, same commit) passed because the test job runs only the packages a change touches (test-selection.sh picked rustgis-geolibre and its dependents, not xtask), and test-hygiene runs nowhere else on a pull request. The push to main runs every package, so it failed there.

Fix:

  • The sleep is essential (it proves a call is not finished; nothing signals a blocked call), so it gets the // test-wait: reason the check asks for.
  • The Project schema job, which already builds xtask and runs whole on every pull request, now also runs cargo xtask test-hygiene, so a new wait in any package is caught before it merges.

Evidence: cargo xtask test-hygiene and cargo test -p xtask repository_tests_follow pass locally; the new CI step runs on this PR.

Reaches: tests and CI only, no surface changes.

Summary by CodeRabbit

  • Tests
    • Added a workspace-wide hygiene check to the schema validation workflow, covering timer waits and ignored tests.
    • Clarified that a lifecycle test’s wait verifies removal remains blocked while the lifecycle lock is held; test behavior and duration are unchanged.

The removal test added in #2289 sleeps to show remove() stays blocked while a
check holds LIFECYCLE. test-hygiene requires a // test-wait: reason on timer
waits, so CI failed on main on every platform.
@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The schema job now runs the workspace-wide test-hygiene check. A lifecycle test comment clarifies the purpose of its existing 200 ms wait.

Changes: Test hygiene

Layer / File(s) Summary
Run and clarify test hygiene checks
.github/workflows/ci.yml, crates/geolibre/src/langpack.rs
The schema job runs xtask test-hygiene across the workspace. The lifecycle test comment identifies the existing 200 ms wait and the blocked-removal condition it checks.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: elpidioassinaturas, mavrick-f

Merge Risk: Minimal · up to eec18

This change only adds a test-hygiene check to CI and a clarifying comment in a test. It has no production impact, and the risk of merging is minimal.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names two changes: marking the langpack test wait with a test-wait reason, and running test-hygiene on every PR. Both appear in the raw summary and objectives. It is conventional and specifi…
Description check Passed The description follows the template's intent. It explains the cause and fix for the CI failure, and it gives local test evidence. The template has a Summary, Testing, UI evidence, and Related issue s…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names two changes: marking the langpack test wait with a test-wait reason, and running test-hygiene on every PR. Both appear in the raw summary and objectives. It is conventional and specific, but it lists two aspects in one line, so it does not name a single primary change. This is a partial match on scope, not a mismatch.

Full details: Description check

Explanation

The description follows the template's intent. It explains the cause and fix for the CI failure, and it gives local test evidence. The template has a Summary, Testing, UI evidence, and Related issue section. The Summary and Testing content is present. The UI evidence section is missing, but the template says to keep the 'No visible UI change.' line when there is no visible change, and the description reports 'Reaches: tests and CI only, no surface changes.' The description does not include that line, and it has no Related issue entry, although the description references #2289 and the failing CI run.

Resolution

Optional improvements: add the exact line 'No visible UI change.' under a UI evidence heading, and add a Related issue line (for example, 'Part of #2289' or the linked issue, if one exists).

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

A rabbit checks the tests at night,
The timer waits; the notes read right.
Across the workspace, checks now run,
While held locks keep removal done.
I nibble clover, pleased with care,
And leave neat footprints everywhere.

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 09fc2483-dc3e-41e7-a021-0f133eb4ff4b
Commits

Reviewing files that changed from the base of the PR and between 55e1ede and eec18bb.

Files selected for processing: 2

  • .github/workflows/ci.yml
  • crates/geolibre/src/langpack.rs

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.

The test job runs only the packages a pull request changes, so xtask's
hygiene test missed the new sleep in #2289 and main failed.
@giswqs giswqs changed the title test(geolibre): mark the langpack removal-blocking sleep as a test wait test(geolibre): mark the langpack test wait; run test-hygiene on every PR Nov 17, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Code review

I found no defects in this PR and left no inline comments. There were no earlier review threads, so no concerns were left alone as already raised.

What I checked:

  • Test-wait marker (crates/geolibre/src/langpack.rs:735): the // test-wait: reason sits on the same line as the std::thread::sleep call. xtask/src/test_hygiene.rs accepts a marker only on the call's line with a non-empty reason, so the marker satisfies the check. The sleep is a negative assertion that remove() is still blocked. It can only produce a false pass, not a flake, and it predates this PR, so I did not raise it.
  • New CI step (.github/workflows/ci.yml:196-200): cargo run --locked -q -p xtask -- test-hygiene matches the subcommand in xtask/src/main.rs. It runs in the schema job, which already builds xtask and runs unnarrowed on every pull request. The step scans the whole workspace, so it does not depend on the changed-package selection. The step matches what docs/contributing.md says about the schema check running whole.
  • Docs and AGENTS.md: the AGENTS.md line "cargo xtask test-hygiene (also in CI)" was not fully true on pull requests before this change. This PR makes it true, so no AGENTS.md update is needed. docs/contributing.md does not say where test-hygiene runs in CI, but nothing in it is now wrong.

Confidence: high that the change is correct and that there is nothing to raise.

Bugs: none.
Security: none.
Performance: none. The added step is a source scan and adds little time to the existing schema job.
Quality: none worth raising.
AGENTS.md: none. The rule that a PR adding a check updates its AGENTS.md line does not apply, because the check already exists and the line already says "also in CI".

Change size

Compared: the whole PR against main (merge base 55e1ede to PR head eec18bb).

Measure Value
Files changed 2 (added 0, modified 2, removed 0, renamed 0)
Size before 47.0 KB
Size after 47.5 KB
Total size change +466 B
Path Size before Size after Size change
.github/workflows/ci.yml 15.1 KB 15.5 KB +360 B
crates/geolibre/src/langpack.rs 31.9 KB 32.0 KB +106 B

@github-actions

Copy link
Copy Markdown
Contributor

📖 Docs preview

Item Value
Preview https://preview.rustgis.app/pr-2323/
Web app https://preview.rustgis.app/pr-2323/app/
Commit eec18bb

GitHub Pages takes a minute or two to publish a new commit.

@giswqs
giswqs added this pull request to the merge queue Nov 17, 2026
Merged via the queue into main with commit cca86cb Nov 17, 2026
26 checks passed
@giswqs
giswqs deleted the fix/langpack-test-wait branch November 17, 2026 05:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant