reqstool 0.3.0__tar.gz

reqstool-0.3.0/.github/dependabot.yml

@@ -0,0 +1,19 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "maven" # See documentation for possible values
+    directory: "/data/local/test_basic/layout_maven/ms-101" # Location of package manifests
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

reqstool-0.3.0/.github/workflows/build.yml

@@ -0,0 +1,40 @@
+name: Build PyPI
+on:
+  workflow_call: 
+  workflow_dispatch:
+  push:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+
+jobs:
+  linting:
+    name: Reuse linting job
+    uses: ./.github/workflows/lint.yml
+
+  build:
+    needs: linting
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out source repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 #full history
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: pip install hatch
+      - name: Run unit and integrations tests
+        run: hatch run test:pytest --cov=reqstool-python-decorators --cov-report=xml --cov-report=html 
+      - name: Build project
+        run: hatch build
+      # Upload artifacts for later use
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/

reqstool-0.3.0/.github/workflows/check_release.yml

@@ -0,0 +1,11 @@
+name: Lint (black and flake8)
+on:
+  workflow_call:
+
+jobs:
+  check-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check branch and tag
+        if: github.event_name == 'push' && !(github.ref == 'refs/heads/main' && startsWith(github.ref, 'refs/tags/v'))
+        run: exit 1

reqstool-0.3.0/.github/workflows/lint.yml

@@ -0,0 +1,21 @@
+name: Lint (black and flake8)
+on:
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out source repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install pip package(s)
+        run: pip install hatch
+      - name: Run black formatter check
+        run: hatch run lint:black --check --verbose src tests
+      - name: Run flake8 linter
+        run: hatch run lint:flake8

reqstool-0.3.0/.github/workflows/publish_gh_pages.yml

@@ -0,0 +1,47 @@
+name: Publish to GitHub Pages
+on:
+  workflow_dispatch:  
+  release:
+    types: [created]
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: github-pages
+  cancel-in-progress: false
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Configure Pages
+        uses: actions/configure-pages@v4
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+      - name: Install Antora
+        run: npm i antora
+      - name: Install Asciidoctor Kroki extension
+        run: npm i asciidoctor asciidoctor-kroki
+      - name: Generate Site
+        run: npx antora docs/antora-playbook.yml
+      - name: Create site folders
+        run: mkdir -p docs/build/site
+      - name: Upload Artifacts
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build/site
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

reqstool-0.3.0/.github/workflows/publish_pypi_prod.yml

@@ -0,0 +1,37 @@
+name: Build and publish to PyPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  check-release:
+    name: Reuse check release
+    uses: ./.github/workflows/check_release.yml
+  build:
+    name: Reuse build
+    uses: ./.github/workflows/build.yml
+  
+
+  publish-to-pypi:
+    needs: 
+      - check-release
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: prod
+      url: https://pypi.org/p/reqstool-client
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+      # Download artifacts from the build job
+      - name: Download Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+      - name: Publish distribution 📦 to PyPI
+        # if: startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          sign-artifacts: true

reqstool-0.3.0/.github/workflows/publish_pypi_test.yml

@@ -0,0 +1,32 @@
+name: Build and publish to Test PyPI
+
+on:
+  workflow_dispatch: 
+
+jobs:
+  build:
+    name: Reuse build
+    uses: ./.github/workflows/build.yml
+
+  publish-to-test-pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    # Specifying a GitHub environment is optional, but strongly encouraged
+    environment:
+      name: test
+      url: https://test.pypi.org/p/reqstool-client
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+      # Download artifacts from the build job
+      - name: Download Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+      - name: Publish distribution 📦 to Test PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          sign-artifacts: true
+          skip-existing: true

reqstool-0.3.0/.gitignore

@@ -0,0 +1,219 @@
+# Created by https://www.toptal.com/developers/gitignore/api/java,maven,python
+# Edit at https://www.toptal.com/developers/gitignore?templates=java,maven,python
+
+### Java ###
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+replay_pid*
+
+### Maven ###
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
+# https://github.com/takari/maven-wrapper#usage-without-binary-jar
+.mvn/wrapper/maven-wrapper.jar
+
+# Eclipse m2e generated files
+# Eclipse Core
+.project
+# JDT-specific (Eclipse Java Development Tools)
+.classpath
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/java,maven,python

reqstool-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 LFV
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

reqstool-0.3.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.1
+Name: reqstool
+Version: 0.3.0
+Summary: A tool for managing requirements with related tests and test results.
+Project-URL: Source, https://github.com/Luftfartsverket/reqstool-client
+Author-email: LFV <info@lfv.se>
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: colorama==0.4.6
+Requires-Dist: jinja2==3.1.3
+Requires-Dist: jsonpickle==3.0.2
+Requires-Dist: jsonschema[format-nongpl]==4.21.1
+Requires-Dist: lark==1.1.9
+Requires-Dist: maven-artifact==0.3.4
+Requires-Dist: pygit2==1.14.0
+Requires-Dist: referencing==0.33.0
+Requires-Dist: requests-file==2.0.0
+Requires-Dist: ruamel-yaml==0.18.6
+Requires-Dist: tabulate==0.9.0
+Requires-Dist: xmldict==0.4.1
+Description-Content-Type: text/markdown
+
+# Reqstool Client
+
+## Overview
+
+Reqstool is a tool for managing requirements with related software verification cases (aka tests) and verification results (test results).
+
+- Requirements are defined in YAML files and can reference each other (depending on the variant different data will be parsed).
+- Annotations are then used in code to specify where a requirement is implemented as well as tested.
+
+With this information and the actual test results (e.g., JUnit), use Reqstool to:
+
+- Generate a report (AsciiDoc, which can be transformed into e.g. PDF) listing all requirements, where that requirement is implemented and tested, and whether the tests passed/failed. This report can be used e.g. with auditors ("Yes, we track this requirement, it's implemented (here) and it has been tested with a pass (here).")
+- Status the software, i.e. get a list of all requirements, their status on implementation and tests. Reqstool will exit with a status code equal to the number of requirements that have not been implemented and tested with a pass. Hence, it can be used in a pipeline as a gate for deployment to production.
+
+## Installation
+
+You need to have the following installed in order to use the tool:
+
+- Python, 3.10 or later
+- pip
+
+To use the tool, you need to install the PyPI package *reqstool*.
+
+```bash
+pip install -U reqstool
+reqstool -h # to confirm installation
+```
+
+## Usage
+
+```bash
+reqstool [-h] {command: report-asciidoc,generate-json,status} {location: local,git,maven} ...
+```
+
+Use `-h/--help` for more information about each command and location.
+
+## Documentation
+
+For full documentation see [xxx](https://somelink).
+
+## Contributing
+
+- We adhere to the latest version of [Contributor Covenant](https://www.contributor-covenant.org/).
+- Fork repo
+- Before submitting a PR
+  - Perform formatting (black):  `hatch run lint:black src tests`
+  - Run linter (flake8): `hatch run lint:flake8`
+  - Run tests:
+    - all: `hatch run test:pytest --cov=reqstool`
+    - unit only: `hatch run test:pytest --cov=reqstool  tests/unit`
+    - integration only: `hatch run test:pytest --cov=reqstool  tests/integration`

reqstool-0.3.0/README.md

@@ -0,0 +1,51 @@
+# Reqstool Client
+
+## Overview
+
+Reqstool is a tool for managing requirements with related software verification cases (aka tests) and verification results (test results).
+
+- Requirements are defined in YAML files and can reference each other (depending on the variant different data will be parsed).
+- Annotations are then used in code to specify where a requirement is implemented as well as tested.
+
+With this information and the actual test results (e.g., JUnit), use Reqstool to:
+
+- Generate a report (AsciiDoc, which can be transformed into e.g. PDF) listing all requirements, where that requirement is implemented and tested, and whether the tests passed/failed. This report can be used e.g. with auditors ("Yes, we track this requirement, it's implemented (here) and it has been tested with a pass (here).")
+- Status the software, i.e. get a list of all requirements, their status on implementation and tests. Reqstool will exit with a status code equal to the number of requirements that have not been implemented and tested with a pass. Hence, it can be used in a pipeline as a gate for deployment to production.
+
+## Installation
+
+You need to have the following installed in order to use the tool:
+
+- Python, 3.10 or later
+- pip
+
+To use the tool, you need to install the PyPI package *reqstool*.
+
+```bash
+pip install -U reqstool
+reqstool -h # to confirm installation
+```
+
+## Usage
+
+```bash
+reqstool [-h] {command: report-asciidoc,generate-json,status} {location: local,git,maven} ...
+```
+
+Use `-h/--help` for more information about each command and location.
+
+## Documentation
+
+For full documentation see [xxx](https://somelink).
+
+## Contributing
+
+- We adhere to the latest version of [Contributor Covenant](https://www.contributor-covenant.org/).
+- Fork repo
+- Before submitting a PR
+  - Perform formatting (black):  `hatch run lint:black src tests`
+  - Run linter (flake8): `hatch run lint:flake8`
+  - Run tests:
+    - all: `hatch run test:pytest --cov=reqstool`
+    - unit only: `hatch run test:pytest --cov=reqstool  tests/unit`
+    - integration only: `hatch run test:pytest --cov=reqstool  tests/integration`

reqstool-0.3.0/docs/antora-playbook.yml

@@ -0,0 +1,22 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/asciidoctor/asciidoctor-intellij-plugin/main/src/main/resources/jsonSchemas/antoraPlaybookSchema.json
+
+site:
+  title: Reqstool Documentation
+  url: https://github.com/luftfartsverket/reqstool-client
+  start_page: reqstool-client::index.adoc
+
+content:
+  sources:
+    - url: ~+
+      branches: HEAD
+      start_path: docs
+ui:
+  bundle:
+    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
+    snapshot: true
+asciidoc:
+  attributes:
+    kroki-server-url: https://kroki.io
+    kroki-fetch-diagram: true
+  extensions:
+    - asciidoctor-kroki

reqstool-0.3.0/docs/antora.yml

@@ -0,0 +1,7 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/asciidoctor/asciidoctor-intellij-plugin/main/src/main/resources/jsonSchemas/antoraComponentSchema.json
+
+name: reqstool-client
+title: Reqstool Client
+version: 0.0.1
+nav:
+  - modules/ROOT/nav.adoc

reqstool-0.3.0/docs/examples/requirements/manual_verification_results.yml

@@ -0,0 +1,7 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/Luftfartsverket/reqstool-client/main/src/reqstool/resources/schemas/v1/manual_verification_results.schema.json
+
+results:
+  - id: # alphanumerical
+    svc_ids: # array of alphanumerical
+    comment: #
+    pass: # true, false

reqstool-0.3.0/docs/examples/requirements/requirements_external.yml

@@ -0,0 +1,21 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/Luftfartsverket/reqstool-client/main/src/reqstool/resources/schemas/v1/requirements.schema.json
+
+metadata:
+  urn: sys-ext # unique resource name
+  variant: external # enum of system, microservice or external
+  title: title
+  url: optional
+
+requirements:
+  - id: id # alphanumerical
+    title: title # text
+    significance: shall # was level # shall, should, may # https://www.rfc-editor.org/rfc/rfc2119
+    description: description # text
+    rationale: test # text
+    category: [business] # [Business, User Interface, System Interface, Performance, IT Security, Information Security, Reliability, Operational]
+    references: # links, source
+      - requirement_ids: [REQ123] # links to another requirement in this document
+      - sources: [FSB] # FSB, SAF, SWAL
+      - requirement_ids: [REQ123] # links to another requirement in this document
+        sources: [FSB] # FSB, SAF, SWAL
+    revision: 0.0.0 # requirement added from revision number, e.g. 1.0.2