Merge pull request #1567 from oscal-compass/develop

chore: Trestle release
oscal-compass · Jun 3, 2024 · c8be4ab · c8be4ab
2 parents 31aefbc + 7f93f86
commit c8be4ab
Show file tree

Hide file tree

Showing 73 changed files with 23,647 additions and 3,115 deletions.
diff --git a/.github/workflows/python-push.yml b/.github/workflows/python-push.yml
@@ -20,19 +20,7 @@ jobs:
           path: ~/Library/Caches/pip
         - os: windows-latest
           path: ~\AppData\Local\pip\Cache
-        # optional 3.7 test
-        - os: ubuntu-latest
-          path: ~/.cache/pip
-          python-version: 3.7
-        # optional 3.7 test
-        - os: macos-latest
-          path: ~/Library/Caches/pip
-          python-version: 3.7.16
-        # optional 3.7 test
-        - os: windows-latest
-          path: ~\AppData\Local\pip\Cache
-          python-version: 3.7
-        python-version: [3.8, 3.9]
+        python-version: ['3.9', '3.10', '3.11']
 
     steps:
     - name: Don't mess with  line endings
@@ -56,39 +44,39 @@ jobs:
       run: |
         make develop
     - name: Setup pre-commit
-      if: ${{ (matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8') }}
+      if: ${{ (matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10') }}
       run: |
         make pre-commit
     - name: Install dependencies
       run: |
         make install
     - name: Run md document formatting (mdformat)
-      if: ${{ (matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8') }}
+      if: ${{ (matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10') }}
       run: |
         make mdformat
     - name: Run code formatting (yapf)
-      if: ${{ (matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8') }}
+      if: ${{ (matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10') }}
       run: |
         make code-format
     - name: Run code linting (flake8)
-      if: ${{ (matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8') }}
+      if: ${{ (matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10') }}
       run: |
         make code-lint
     - name: Run code typing check (mypy)
-      if: ${{ (matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8') }}
+      if: ${{ (matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10') }}
       continue-on-error: true 
       run: |
         make code-typing
     - name: Validate website content (mkdocs)
-      if: ${{ (matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8') }}
+      if: ${{ (matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10') }}
       run: |
         make docs-validate
     - name: Pytest Fast
-      if: ${{ !(matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8') }}
+      if: ${{ !(matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10') }}
       run: |
         make test
     - name: Pytest Cov
-      if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8' }}
+      if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10' }}
       run: |
         make test-cov
   deploy:
@@ -102,10 +90,10 @@ jobs:
         submodules: true
         fetch-depth: 0
         token: ${{ secrets.ADMIN_PAT }} 
-    - name: Set up Python 3.8
+    - name: Set up Python 3.10
       uses: actions/setup-python@v2
       with:
-        python-version: 3.8
+        python-version: '3.10'
     - name: Install build tools
       run: |
         make develop
@@ -131,11 +119,11 @@ jobs:
         submodules: true
         fetch-depth: 0
         token: ${{ secrets.ADMIN_PAT }} 
-    - name: Set up Python 3.8
+    - name: Set up Python 3.10
       uses: actions/setup-python@v2
       # This is deliberately not using a custom credential as it relies on native github actions token to have push rights.
       with:
-        python-version: 3.8
+        python-version: '3.10'
     - name: Install build tools
       run: |
         make develop

diff --git a/.github/workflows/python-test.yml b/.github/workflows/python-test.yml
@@ -19,13 +19,13 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
-        python-version: 3.9
+        python-version: '3.10'
     - uses: actions/cache@v2
       with:
         path: ~/.cache/pip
-        key: ubuntu-latest-3.9-pip-${{ hashFiles('setup.cfg') }}
+        key: ubuntu-latest-3.10-pip-${{ hashFiles('setup.cfg') }}
         restore-keys: |
-          ubuntu-latest-3.9-pip-
+          ubuntu-latest-3.10-pip-
     - name: Install build tools
       run: |
         make develop
@@ -72,13 +72,13 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
-        python-version: 3.9
+        python-version: '3.10'
     - uses: actions/cache@v2
       with:
         path: ~/.cache/pip
-        key: ubuntu-latest-3.9-pip-${{ hashFiles('setup.cfg') }}
+        key: ubuntu-latest-3.10-pip-${{ hashFiles('setup.cfg') }}
         restore-keys: |
-          ubuntu-latest-3.9-pip-
+          ubuntu-latest-3.10-pip-
     - name: Install build tools
       run: |
         make develop
@@ -92,27 +92,14 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.8, 3.9]
+        python-version: ['3.9', '3.10', '3.11']
         include:
         - os: ubuntu-latest
           path: ~/.cache/pip
         - os: macos-latest
           path: ~/Library/Caches/pip
         - os: windows-latest
           path: ~\AppData\Local\pip\Cache
-        # optional 3.7 test
-        - os: ubuntu-latest
-          path: ~/.cache/pip
-          python-version: 3.7
-        # optional 3.7 test
-        - os: macos-latest
-          path: ~/Library/Caches/pip
-          python-version: 3.7.16
-        # optional 3.7 test
-        - os: windows-latest
-          path: ~\AppData\Local\pip\Cache
-          python-version: 3.7
-
     steps:
     - name: Don't mess with line endings
       run: |
@@ -135,16 +122,16 @@ jobs:
       run: |
         make develop
     - name: Pytest Fast
-      if: ${{ !(matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8') }}
+      if: ${{ !(matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10') }}
       run: |
         make test
     - name: Pytest Cov
-      if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8' }}
+      if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10' }}
       run: |
         make test-cov
 
     - name: Upload artifact
-      if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8' }}
+      if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10' }}
       uses: actions/upload-artifact@v2
       with:
         name: coverage
@@ -167,13 +154,13 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
-        python-version: 3.8
+        python-version: '3.10'
     - uses: actions/cache@v2
       with:
         path: ~/.cache/pip
-        key: ubuntu-latest-3.9-pip-${{ hashFiles('setup.cfg') }}
+        key: ubuntu-latest-3.10-pip-${{ hashFiles('setup.cfg') }}
         restore-keys: |
-          ubuntu-latest-3.9-pip-
+          ubuntu-latest-3.10-pip-
     - name: Install build tools
       run: |
         make develop
@@ -191,10 +178,11 @@ jobs:
           -Dsonar.python.coverage.reportPaths=coverage.xml
           -Dsonar.tests=tests/
           -Dsonar.sources=trestle/ 
-          -Dsonar.python.version=3.8
+          -Dsonar.python.version='3.10'
           -Dsonar.projectKey=compliance-trestle
           -Dsonar.organization=compliance-trestle
           -Dsonar.cpd.exclusions=trestle/oscal/*.py
+          -Dsonar.exclusions=trestle/oscal/*.py
     - name: SonarQube Quality Gate check
       uses: sonarsource/sonarqube-quality-gate-action@master
       # Force to fail step after specific time

diff --git a/Makefile b/Makefile
@@ -49,6 +49,9 @@ code-lint:
 code-typing:
 	mypy --pretty trestle
 
+test-all::
+	python -m pytest -n auto
+
 test::
 	python -m pytest --exitfirst -n auto
 

diff --git a/README.md b/README.md
@@ -8,19 +8,9 @@
 ![[Pypi](https://pypi.org/project/compliance-trestle/)](https://img.shields.io/pypi/dm/compliance-trestle)
 ![GitHub Actions status](https://img.shields.io/github/workflow/status/oscal-compass/compliance-trestle/Trestle%20PR%20pipeline?event=push)
 
-______________________________________________________________________
+Trestle is an ensemble of tools that enable the creation, validation, and governance of documentation artifacts for compliance needs. It leverages NIST's [OSCAL](https://pages.nist.gov/OSCAL/) as a standard data format for interchange between tools and people, and provides an opinionated approach to OSCAL adoption.
 
-<table>
-<tr>
-<td><img src="images/Apollo_11_liftoff.png">
-<td> We've moved. Please note our new organizational location.
-</table>
-
-______________________________________________________________________
-
-Trestle is an ensemble of tools that enable the creation, validation, and governance of documentation artifacts for compliance needs. It leverages NIST's [OSCAL](https://pages.nist.gov/OSCAL/documentation/) as a standard data format for interchange between tools and people, and provides an opinionated approach to OSCAL adoption.
-
-Trestle is designed to operate as a CICD pipeline running on top of compliance artifacts in `git`, to provide transparency for the state of compliance across multiple stakeholders in an environment friendly to developers. Trestle passes the generated artifacts on to tools that orchestrate the enforcement, measurement, and reporting of compliance.
+Trestle is designed to operate as a CICD pipeline running on top of compliance artifacts in `git`, to provide transparency for the state of compliance across multiple stakeholders in an environment friendly to developers. Trestle passes the generated artifacts onto tools that orchestrate the enforcement, measurement, and reporting of compliance.
 
 It also provides tooling to manage OSCAL documents in a more human-friendly manner. By splitting large OSCAL data structures into smaller and easier to edit sub-structures, creation and maintenance of these artifacts can follow normal `git` workflows including peer review via pull request, versioning, releases/tagging.
 
@@ -35,17 +25,15 @@ Trestle provides tooling to help orchestrate the compliance process across a num
 - Help manage OSCAL documents in a more human-friendly manner by expanding the large OSCAL data structures into smaller and easier to edit sub-structures while making sure the schemas are enforced.
 - Transform documents from other formats to OSCAL
 - Provide governance for markdown documents and enforce consistency of format and content based on specified templates
-- Tooling manage authoring and governance of markdown and drawio files withn a repository.
+- Tooling manage authoring and governance of markdown and drawio files within a repository.
 - Support within trestle to streamline management within a managed git environment.
-- An underlying object model that supports developers interacting with OSCAL artefacts.
+- An underlying object model that supports developers interacting with OSCAL artifacts.
 
 ## Important Note:
 
-The current version of trestle supports NIST OSCAL 1.0.0-4.  There was a breaking change in OSCAL moving from
-version 1.0.0 to 1.0.2 mainly due to `prop` becoming `props` in AssessmentResults.  As a result, the current development path of trestle requires OSCAL 1.0.4, but for those who require OSCAL 1.0.0 please use trestle version 0.37.x.  That version is stable but will not have any features added, and we encourage users to move to OSCAL 1.0.4.
+The current version of trestle supports NIST OSCAL 1.1.2 as well as previous versions 1.1.x and 1.0.x. All files created by trestle will be output as OSCAL version 1.1.2.
 
-OSCAL version 1.0.0 files are still handled on import but any AssessmentResults must conform to the OSCAL 1.0.4 schema, with
-props instead of prop.  And all files created by trestle will be output as OSCAL version 1.0.4.
+There was a breaking change in OSCAL moving from version 1.0.0 to 1.0.2 mainly due to `prop` becoming `props` in AssessmentResults.  Those who require strict OSCAL 1.0.0 please use trestle version 0.37.x.  That version is stable but will not have any features added, and we encourage all users to move to OSCAL 1.1.2. OSCAL version 1.0.0 files are still handled on import but any AssessmentResults must conform to the `props` in AssessmentResults OSCAL specification.
 
 ## Why Trestle
 
@@ -75,7 +63,7 @@ natively supports only `json` and `yaml` formats at this time.
 Future roadmap anticipates that support for xml [import](https://github.com/oscal-compass/compliance-trestle/issues/177) and [upstream references](https://github.com/oscal-compass/compliance-trestle/issues/178) will be enabled. However, it is expected
 that full support will remain only for `json` and  `yaml`.
 
-Users needing to import XML OSCAL artifacts are recommended to look at NIST's XML to json conversion page [here](https://github.com/usnistgov/OSCAL/tree/master/json#oscal-xml-to-json-converters).
+Users needing to import XML OSCAL artifacts are recommended to look at NIST's XML to json conversion page [here](https://github.com/usnistgov/OSCAL/blob/main/build/README.md#converters).
 
 ## Python codebase, easy installation via pip
 
@@ -104,35 +92,30 @@ A collection of demos utilizing trestle can be found in the related project [com
 
 ## Development status
 
-Compliance trestle is currently stable and is based on NIST OSCAL version 1.0.4, with active development continuing.
+Compliance trestle is currently stable and is based on NIST OSCAL version 1.1.2, with active development continuing.
 
 ## Community meetings and communications
 
 ##### Scheduled meetings
 
 Please attend! All are invited.
 
-**When**: Every other Tuesday at 10:00 ET [convert to your local time](https://dateful.com/convert/est-edt-eastern-time)
-
-To discover the actual meeting dates:
-
-- Go to [Google Calendar](https://calendar.google.com/calendar/u/0/[email protected]&ctz=America/Los_Angeles)
-- Look at entries in `Tue` day of week for *Compliance Trestle Community Call*
-- To add to your calendar, `click` on `Compliance Trestle Community Call` and choose `copy to my calendar`
-
-**Where**: [https://zoom.us/j/92729235315](https://zoom.us/j/92729235315)
+**When**:
 
-- Meeting Id: 927 2923 5315
+Every other Tuesday starting on April 23, 2024 · 11:00 – 11:30am ET
+[convert to your local time](https://mytime.io/11am/ET)
 
-- Passcode: 233140
+**Where**: [Google Meet Link](https://meet.google.com/mwp-affd-tvu)
 
-- **Note**: Use the passcode above to login to Zoom (or you can login to Zoom using another account like Google, Facebook)
+Dial in:
+(US) +1 402-627-0247 PIN: 535 362 764#\
+[More phone numbers](https://tel.meet/mwp-affd-tvu?pin=9717189704231)
 
-**What**: Meeting agenda and notes [Google Docs](https://docs.google.com/document/d/1z9xvt-Z97j4CtEH1-nR9sMWul7jQkUi_fNY7BdMPgxM/edit#heading=h.nohkp1kbeduj)
+**What**: Meeting agenda and notes [Google Docs](https://docs.google.com/document/d/1XTYM7xnWlIqd-8Nn5-qtgvgk8kH3NSmYle5yZvaS7qs/edit?usp=sharing)
 
 ##### Chat anytime
 
-Slack: [# compliance-grc](https://cloud-native.slack.com/archives/C066TMUBEL8)
+Slack: [#oscal-compliance-trestle-agileauthoring-c2p](https://cloud-native.slack.com/archives/C06F3PEPNBW)
 
 - **Note**: You can login to Slack using another account like Google, Apple
 

diff --git a/docs/api_reference/trestle.core.commands.author.prof.md b/docs/api_reference/trestle.core.commands.author.prof.md
@@ -0,0 +1,2 @@
+::: trestle.core.commands.author.prof
+handler: python
diff --git a/docs/api_reference/trestle.core.commands.author.profile.md b/docs/api_reference/trestle.core.commands.author.profile.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -88,7 +88,7 @@ nav:
           - folders: api_reference/trestle.core.commands.author.folders.md
           - headers: api_reference/trestle.core.commands.author.headers.md
           - jinja: api_reference/trestle.core.commands.author.jinja.md
-          - profile: api_reference/trestle.core.commands.author.profile.md
+          - prof: api_reference/trestle.core.commands.author.prof.md
           - ssp: api_reference/trestle.core.commands.author.ssp.md
           - versioning:
             - template_versioning: api_reference/trestle.core.commands.author.versioning.template_versioning.md

diff --git a/nist-content b/nist-content
diff --git a/nist-source b/nist-source
diff --git a/pyproject.toml b/pyproject.toml
@@ -14,3 +14,9 @@ minversion = "6.2"
 testpaths = [
     "tests",
 ]
+
+[tool.black]
+line-length = 500
+
+[tool.isort]
+line_length = 500
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		::: trestle.core.commands.author.prof
		handler: python