Skip to content

fix(vendor): drop the bracketed [UNSPECIFIED] from ESP Integrity comments (#2294) - #2371

Merged
JarryShaw merged 1 commit into
mainfrom
fix/2294-esp-integrity-unspecified
Oct 27, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
fix/2294-esp-integrity-unspecified

Conversation

@JarryShaw

@JarryShaw JarryShaw commented Oct 27, 2026 •

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • fix — bug fix

Description

Closes #2294.

  • Problem: Integrity.rfcs tested the whole registry cell against UNKNOWN, but IANA spells the "no document" cell [UNSPECIFIED], brackets included — so it passed through unrendered, giving pcapkit.const.esp.integrity entries like AUTH_DES_MAC [UNSPECIFIED] (DEPRECATED [:rfc:8247]). Cipher.rfcs shares the same check.
  • Fix: strip one pair of surrounding brackets before the UNKNOWN comparison, in both crawlers. The const file is regenerated by running the crawler against the live registry; cipher.py regenerates unchanged.
  • Test: test_esp_unspecified_reference_2294_unit checks both crawlers' rfcs handling on bracketed and bare placeholders and renders the recorded registry into the committed integrity.py.
  • Fail-without-fix: 11 failed on the pre-fix tree (10 placeholder subtests across both crawlers, plus the committed-file match). Passing on the head.

@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 27, 2026
@github-actions github-actions Bot added this to the PyPCAPKit v1.5 milestone Oct 27, 2026
@JarryShaw JarryShaw added bug Issues reporting a defect (set by the bug report template; a default, not an assessment) fix Pull requests that fix a defect (fix: subject prefix) const Regenerated IANA or vendor constant tables; members keep their numeric values labels Oct 27, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at 19136d4b5 (Sonnet). Confirmed against the live IANA registries: [UNSPECIFIED] exists exactly in Integrity rows 3/4, the fix strips exactly one bracket pair (28 edge cases checked, legitimately-bracketed cells like [RFC 4868] and [Matt_Ball] untouched), the regenerated const file matches a fresh crawl byte-for-byte, and Cipher's claimed no-op is real (same sha256 before/after). Mutation-verified: reverting either crawler's fix or the const file fails exactly its own assertion. Fail-without-fix: 11 failures on the pre-fix tree.
Added labels (bug/fix/const) and a fail-without-fix line to the body — the reviewer's only metadata gaps. One remaining nit (docstring past-tense wording, #1103 convention) has a fix dispatched.

…ents (#2294)

Integrity.rfcs tested the whole cell against UNKNOWN, but IANA spells
the "no document" cell "[UNSPECIFIED]", brackets included, so it passed
through and pcapkit.const.esp.integrity read
"#: AUTH_DES_MAC [UNSPECIFIED] (DEPRECATED [:rfc:`8247`])", and the
same for AUTH_KPDK_MD5.

Strip one pair of surrounding brackets before the UNKNOWN test, in
Integrity.rfcs and in Cipher.rfcs, which shares the check. The const
file is regenerated by running the crawler against the live registry;
cipher.py regenerates unchanged.

Test: test_esp_unspecified_reference_2294_unit checks both crawlers'
rfcs on bracketed and bare placeholders and renders the recorded
registry into the committed integrity.py.
@JarryShaw
JarryShaw force-pushed the fix/2294-esp-integrity-unspecified branch from 19136d4 to fe5dd8c Compare October 27, 2026 07:40
@JarryShaw

Copy link
Copy Markdown
Owner Author

Rebased and amended 19136d4b5 → fe5dd8c93 (6 commits onto current origin/main, clean): reworded the test module docstring off the past-tense "so the test missed it" narrative into the #1103 sweep's present-tense/"Guards against" convention. Prose-only, verified with an AST diff (docstrings stripped) showing no code change. 3/3 tests pass.

All review findings now addressed.

@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 91.64% (unit tier, Python 3.15, fe5dd8c93, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 4 20 2 95.16%
pcapkit/const 19601 881 2620 867 92.12%
pcapkit/corekit 2596 74 818 37 96.51%
pcapkit/dumpkit 282 3 102 3 98.44%
pcapkit/foundation 3029 23 1050 25 98.82%
pcapkit/interface 138 4 52 3 96.32%
pcapkit/protocols 17455 218 4598 185 98.15%
pcapkit/toolkit 914 36 334 10 95.51%
pcapkit/utilities 502 7 144 5 98.14%
pcapkit/vendor 4434 1961 1018 167 52.49%

Per-file detail: the coverage-html artifact of this run.

@JarryShaw

Copy link
Copy Markdown
Owner Author

Ready to merge.

Review: GOOD TO GO (Sonnet) at fe5dd8c93.
CI: Required checks passed, 0 failures (only the non-blocking experimental GraalPy leg still pending, if at all).
Mergeable, 0 unresolved threads.

@JarryShaw JarryShaw added the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 27, 2026
@JarryShaw
JarryShaw merged commit 8b50c1c into main Oct 27, 2026
62 checks passed
@JarryShaw
JarryShaw deleted the fix/2294-esp-integrity-unspecified branch October 27, 2026 15:14
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 27, 2026
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Issues reporting a defect (set by the bug report template; a default, not an assessment) const Regenerated IANA or vendor constant tables; members keep their numeric values fix Pull requests that fix a defect (fix: subject prefix)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

fix(vendor): ESP Integrity.rfcs keeps a bracketed [UNSPECIFIED] in the generated comments

1 participant