oscal-compass/compliance-trestle

Rules: isolate opinionated trestle Rules support into separate module(s) #1880

Open

#1,880 opened on May 21, 2025

View on GitHub
 (6 comments) (0 reactions) (1 assignee)Python (103 forks)auto 404
event/slamexempt-from-stalehelp wantedpythonrefactor

Repository metrics

Stars
 (264 stars)
PR merge metrics
 (PR metrics pending)

Description

Issue description / feature objectives

There is no formal support for rules and checks in OSCAL itself. However, to support automation such support is necessary and trestle has used existing OSCAL features (namely Properties) to embody Rules support. The initial implementation for Rules has been embedded in trestle tasks and core modules. Ideally, the code for Rules support should be gathered into one or a few modules comprising an API that the task and core modules can employ.

  • Identify the Rules code throughout the trestle code base
  • Create one or more modules to contain the Rules code
  • Relocate the Rules implementation code from the task and core modules into the Rule module(s)
  • Update the task and core modules to employ the Rules API

Caveats / Assumptions

  • Insure all existing test cases continue to pass

Completion Criteria

  • Add new test cases to assure 100% coverage for new Rules module(s)

Contributor guide

Research direction
Identify all code related to Rules support in the trestle codebase, design a module structure, and relocate the code while ensuring existing tests pass.
Tech stack
python
Domain
backendapi
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35