Manual constraint generation tool/Comparison callbacks

[nikitawootten-nist]

User Story:

As an OSCAL-deep-diff user, I need to be able to easily generate constraint sets for reproducible comparisons.

Goals:

{A clear and concise description of what you want to happen. This should be outcome focused. Include concise description of any alternative solutions or features you've considered. Feel free to include screenshots or examples about the feature request here.}

Dependencies:

• The comparison library must allow callbacks that can modify comparison behavior including:
  • A callback when the tool does not find a constraint for an array
    • This can be used to extend matching behavior
    • This can also be used within web-apps
    • Allow for users to return/inject new constraints?
  • A callback when the tool finds out-of-tree matches
  • A callback when the tool cannot match or compare elements with the given constraint
    • Possibly add the ability to restart the comparison with new changes?
• Leveraging the new callbacks, the existing CLI can be made interactive in order to assist the user in generating constraint sets for a comparison that can be re-used.

Acceptance Criteria

• readme documentation affected by the changes in this issue have been updated.
• A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
• The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.

[nikitawootten-nist]

Closing this until it is relevant again