Skip to content

fix(protocols)!: rename OSPF_CrytographicAuthentication and group OSPF under the application layer - #1116

Merged
JarryShaw merged 1 commit into
mainfrom
fix/1090-ospf-cryptographic-authentication
Oct 6, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
fix/1090-ospf-cryptographic-authentication

Conversation

@JarryShaw

@JarryShaw JarryShaw commented Oct 6, 2026 •

Copy link
Copy Markdown
Owner
  • Searched for similar pull requests
  • Followed the coding style (make pylint, make mypy, make isort) — run on the touched pcapkit/ files with the Makefile flags; no new findings (3 mypy errors in application/ospf.py predate this PR)
  • make test passes, and a test case covers the change — the modules listed below, not the full suite
  • Added a changelog entry under docs/source/changelog/ and regenerated CHANGELOG.md, if the change is user-visible — N/A, added centrally after the wave

What is the purpose of your pull request?

  • fix — corrects a defect

Description of your pull request and other information

Closes #1090. Breaking: OSPF_CrytographicAuthentication (and CrytographicAuthentication in both ospf modules) becomes OSPF_CryptographicAuthentication / CryptographicAuthentication. No alias keeps the old name. Both OSPF names move to the application group of schema.__all__ and data.__all__.

Probe (schema / data): before, new name False, old True, OSPF listed between L2TP/Ethernet and VLAN. After, new True, old False, OSPF listed after NGAP.

New tests/protocols/application/test_ospf_cryptographic_authentication_unit.py: without the fix, 11 failed, 3 passed (all 4 tests fail). With it, 4 passed, 10 subtests passed. Also passing: test_ospf_unit (3), link/test_link_unit (24), test_layer_placement_unit (17), project/test_public_api (10), and tests/project (379 passed, 1 skipped).

…F under the application layer

- Rename the misspelled OSPF schema and data classes to
  CryptographicAuthentication, exported as OSPF_CryptographicAuthentication.
  No alias keeps the old name: this is a breaking rename.
- Move both OSPF names into the application-layer group of the
  pcapkit.protocols.schema and pcapkit.protocols.data __all__ lists, and
  drop the inline "# application layer" comment.
- Move the OSPF auth-data selector assertions out of the link tests into
  tests/protocols/application/.

Closes #1090
@JarryShaw JarryShaw added breaking Breaks public-facing behaviour or API (apply alongside the type label) fix Pull requests that fix a defect (fix: subject prefix) review: running A cross-review is in flight against the current head - no verdict yet labels Oct 6, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Cross-review verdict on e4affd90b: GOOD TO GO (ran on Sonnet; author Opus)

  • No old spelling left: grep -rIn Crytographic across the repo finds only the new test's negative assertions.
  • Exports: from pcapkit.protocols.data import * and from pcapkit.protocols.schema import * both export OSPF_CryptographicAuthentication, with no duplicates and every name resolving. The top level never exported the class.
  • Placement: OSPF now sits in the application run of both __all__ lists, after NGAP and before HTTPv1.
  • Moved test: the selector assertions moved unchanged from test_link_unit.py.
  • Tests: with the library reverted, the new module fails 11 tests. test_public_api (450 subtests), test_layer_placement_unit, test_ospf_unit and test_link_unit all pass.

Pre-existing, outside this PR: pcapkit/all.py:113-114 still lists OSPF on its Link Layer line. That is being filed separately.

@JarryShaw JarryShaw added review: good-to-go Cross-review at the current head says ready; CI state is separate and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 6, 2026
@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

Coverage: 88.74% (unit tier, Python 3.14, e4affd90b, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 4 20 4 93.55%
pcapkit/const 18757 1035 2342 846 90.23%
pcapkit/corekit 1874 91 578 22 94.33%
pcapkit/dumpkit 136 0 40 0 100.00%
pcapkit/foundation 2422 143 842 34 92.62%
pcapkit/interface 112 7 40 5 92.11%
pcapkit/protocols 15653 187 3942 162 98.19%
pcapkit/toolkit 487 71 144 3 84.15%
pcapkit/utilities 429 4 122 4 98.55%
pcapkit/vendor 4409 2359 1006 158 42.84%

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

@JarryShaw
JarryShaw merged commit 0c9cc4d into main Oct 6, 2026
42 checks passed
@JarryShaw
JarryShaw deleted the fix/1090-ospf-cryptographic-authentication branch October 6, 2026 20:36
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 6, 2026
JarryShaw added a commit that referenced this pull request Oct 6, 2026
- 22 new 1.5.0 entries for the 30 PRs merged since b10e795
  (#1106-#1158), with related fixes grouped per the #918 ruling;
  three marked breaking to match their labels (#1116, #1138, #1145)
- regenerate CHANGELOG.md with util/changelog_md.py
- process.rst: entry-count pin re-measured, 167 -> 189
- pep.rst: note the plist round-trip test skipped on the upstream
  dictdumper fractional-second <date> defect (DictDumper#122)

tests/project: conventions_doc_claims, changelog_md and
documentation_claims pass; changelog_md.py --check is in step.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking Breaks public-facing behaviour or API (apply alongside the type label) fix Pull requests that fix a defect (fix: subject prefix)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

fix(protocols)!: rename OSPF_CrytographicAuthentication and group OSPF under the application layer

1 participant