Skip to content

Refactor SsvcDecisionPoint base class mixins #743

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 7 commits into from
Mar 20, 2025
Merged

Refactor SsvcDecisionPoint base class mixins #743

merged 7 commits into from
Mar 20, 2025

Conversation

ahouseholder
Copy link
Contributor

@ahouseholder ahouseholder commented Mar 13, 2025 •
edited
Loading

In the process of working on #707, it came to my attention that the order of the mixin dataclasses matters to the production of the .json examples. This PR:

  • extracts just that portion of the refactoring necessary to ensure that the name and description fields of a decision point appear at the top of each decision point's .json representation.
  • Updates the .json examples to reflect this new ordering
  • It also refactors out a _Valued class in src/ssvc/_mixins.py that will support future datatypes.

CoPilot Summary

This pull request includes several updates to JSON files related to decision points in the CVSS and SSVC namespaces. The primary change across all files is the reordering of the "name" and "description" fields to improve consistency and readability.

@ahouseholder ahouseholder added the enhancement New feature or request label Mar 13, 2025
@ahouseholder ahouseholder added this to the 2025-03 milestone Mar 13, 2025
@ahouseholder ahouseholder self-assigned this Mar 13, 2025
@ahouseholder ahouseholder mentioned this pull request Mar 20, 2025
Draft
sei-vsarvepalli
sei-vsarvepalli approved these changes Mar 20, 2025
View reviewed changes
Copy link
Contributor

@sei-vsarvepalli sei-vsarvepalli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to go. I haven't caught anything new after these changes.

@ahouseholder ahouseholder merged commit 8887a13 into main Mar 20, 2025
3 checks passed
@ahouseholder ahouseholder deleted the feature/reorder-base-class-mixins branch March 20, 2025 20:16
ahouseholder added a commit that referenced this pull request Mar 26, 2025
@sei-vsarvepalli @ahouseholder
@sei-renae @dependabot
Update Publish branch with the latest updates to ensure SSVC newer ve…
2f8a367 
…rsion of schema is available. (#760)

* Convert cwes list to markdown with fewer rows and columns (#737)

* Update verbiage because we have a list of CWE-IDs per issue 529.

* Clean CWE-IDs list to only exploit_possible=yes, eliminate need for side scrolling, add hyperlinks, and create a markdown version of the csv per issues 530 and 713.

* markdown lint

* Fix broken link to cwe examples and remove cwe csvs file to enforce a single source of truth.

* Make the linkchecker happy

* Really fix links this time

* Replace `Track*`/`Track *` with `Monitor` in CISA-based decision model (#738)

* change type hints on OutcomeGroup class

* black reformat

* replace `Track *` with `Monitor`

* carve a new version of CISA OutcomeGroup to reflect `Track *` -> `Monitor`

* replace `Track*` with `Monitor` in json

* replace CISA.json with Monitor outcome value

* more substitutions

* Revert "Replace `Track*`/`Track *` with `Monitor` in CISA-based decision mode…" (#741)

This reverts commit a54f999.

* Bump markdown-exec from 1.10.0 to 1.10.1 (#746)

Bumps [markdown-exec](https://github.com/pawamoy/markdown-exec) from 1.10.0 to 1.10.1.
- [Release notes](https://github.com/pawamoy/markdown-exec/releases)
- [Changelog](https://github.com/pawamoy/markdown-exec/blob/main/CHANGELOG.md)
- [Commits](pawamoy/markdown-exec@1.10.0...1.10.1)

---
updated-dependencies:
- dependency-name: markdown-exec
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump the mkdocs group with 6 updates (#747)

Bumps the mkdocs group with 6 updates:

| Package | From | To |
| --- | --- | --- |
| [mkdocs-bibtex](https://github.com/shyamd/mkdocs-bibtex) | `4.2.2` | `4.2.3` |
| [mkdocs-include-markdown-plugin](https://github.com/mondeja/mkdocs-include-markdown-plugin) | `7.1.4` | `7.1.5` |
| [mkdocs-material](https://github.com/squidfunk/mkdocs-material) | `9.6.7` | `9.6.9` |
| [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings) | `0.28.2` | `0.29.0` |
| [mkdocstrings-python](https://github.com/mkdocstrings/python) | `1.16.2` | `1.16.5` |
| [mkdocs-print-site-plugin](https://github.com/timvink/mkdocs-print-site-plugin) | `2.6.0` | `2.7.1` |


Updates `mkdocs-bibtex` from 4.2.2 to 4.2.3
- [Release notes](https://github.com/shyamd/mkdocs-bibtex/releases)
- [Commits](shyamd/mkdocs-bibtex@v4.2.2...v4.2.3)

Updates `mkdocs-include-markdown-plugin` from 7.1.4 to 7.1.5
- [Release notes](https://github.com/mondeja/mkdocs-include-markdown-plugin/releases)
- [Commits](mondeja/mkdocs-include-markdown-plugin@v7.1.4...v7.1.5)

Updates `mkdocs-material` from 9.6.7 to 9.6.9
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.6.7...9.6.9)

Updates `mkdocstrings` from 0.28.2 to 0.29.0
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.28.2...0.29.0)

Updates `mkdocstrings-python` from 1.16.2 to 1.16.5
- [Release notes](https://github.com/mkdocstrings/python/releases)
- [Changelog](https://github.com/mkdocstrings/python/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/python@1.16.2...1.16.5)

Updates `mkdocs-print-site-plugin` from 2.6.0 to 2.7.1
- [Release notes](https://github.com/timvink/mkdocs-print-site-plugin/releases)
- [Commits](timvink/mkdocs-print-site-plugin@v2.6.0...v2.7.1)

---
updated-dependencies:
- dependency-name: mkdocs-bibtex
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
- dependency-name: mkdocs-include-markdown-plugin
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
- dependency-name: mkdocstrings
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: mkdocs
- dependency-name: mkdocstrings-python
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
- dependency-name: mkdocs-print-site-plugin
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: mkdocs
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* add `mdlint_fix` target to Makefile (#744)

* pin changed-files action to specific sha1 (#750)

* Add NameSpace Enum (#749)

* add a namespace Enum along with a pydantic dataclass validator to enforce it

Valid = str in enum OR str.startswith("x_")

* add validator to _Namespaced mixin class

* refactor base classes to use NameSpace enum values

* add optional "x_" prefix as valid namespace pattern

* update unit tests

* add docstrings

* bump python test version to 3.12

* update the regex pattern for namespaces, add validation to pydantic field

* refactor namespace validation methods

* add unit tests

* simplify regex to avoid inefficiencies

* add length requirements to namespace patterns and fields

* refactor regex again

* add docstrings

* add docs, update docstrings

* Update Decision_Point-1-0-1.schema.json

Modify Namespace information and examples as wel..

* Update Decision_Point-1-0-1.schema.json

Matching x_custom/extension as examples for schema docs.

* we shouldn't mention nciss yet as it's still a draft PR

* missed an nciss

---------

Co-authored-by: Vijay Sarvepalli <[email protected]>

* Refactor SsvcDecisionPoint base class mixins (#743)

* create a `_Valued` mixin

* add `_Valued` mixin to base decision point class. Also reorder mixins to adjust default json output key order

* update json examples to reflect new base class mixin ordering

* add len() to _Valued mixin

* add tests

* Bump tj-actions/changed-files from 46.0.1 to 46.0.3 (#757)

Bumps [tj-actions/changed-files](https://github.com/tj-actions/changed-files) from 46.0.1 to 46.0.3.
- [Release notes](https://github.com/tj-actions/changed-files/releases)
- [Changelog](https://github.com/tj-actions/changed-files/blob/main/HISTORY.md)
- [Commits](tj-actions/changed-files@2f7c5bf...823fceb)

---
updated-dependencies:
- dependency-name: tj-actions/changed-files
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump markdown-exec from 1.10.1 to 1.10.2 (#756)

Bumps [markdown-exec](https://github.com/pawamoy/markdown-exec) from 1.10.1 to 1.10.2.
- [Release notes](https://github.com/pawamoy/markdown-exec/releases)
- [Changelog](https://github.com/pawamoy/markdown-exec/blob/main/CHANGELOG.md)
- [Commits](pawamoy/markdown-exec@1.10.1...1.10.2)

---
updated-dependencies:
- dependency-name: markdown-exec
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump mkdocstrings-python from 1.16.5 to 1.16.8 in the mkdocs group (#755)

Bumps the mkdocs group with 1 update: [mkdocstrings-python](https://github.com/mkdocstrings/python).


Updates `mkdocstrings-python` from 1.16.5 to 1.16.8
- [Release notes](https://github.com/mkdocstrings/python/releases)
- [Changelog](https://github.com/mkdocstrings/python/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/python@1.16.5...1.16.8)

---
updated-dependencies:
- dependency-name: mkdocstrings-python
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: mkdocs
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Allen D. Householder <[email protected]>
Co-authored-by: sei-renae <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sei-vsarvepalli sei-vsarvepalli sei-vsarvepalli approved these changes

Assignees

@ahouseholder ahouseholder

Labels
enhancement New feature or request
Projects
None yet
Milestone
2025-03
Development

Successfully merging this pull request may close these issues.
2 participants
@ahouseholder @sei-vsarvepalli