reqstool-demo

Description

This project act as a demo on how to integrate the Reqstool into you project. In this simple project, you are able to see how Reqstool can be used and how the different files relate to each other.

In this demo, we are showcasing how we define requirements and tests for a microservice, and also imports and implements requirements from an external system (ext-001)

Installation

Tools needed to run the demo:

  • Java 21

  • Maven

  • Python 3.10

  • Reqstool >= 0.4.0

Usage

Before you can analyze the codebase with Reqstool, the project has to be built in order to generate the required annotation classes which will reside under the target folder of this project.

From the root of you project, run:

mvn clean install

when the project is built and the tests are run (one of them are expected to fail), you can check the status of the project by running:

reqstool status local -p {root_of_project}/docs/reqstool

If you would like to generate your requirement data as a asciidoc report file, you could run

reqstool report-asciidoc local -p {root_of_project}/docs/reqstool -o {path-to-file}filename.adoc

If you would like to generate your requirement data as a json file, you could run

reqstool generate-json local -p {root_of_project}/docs/reqstool -o {path-to-file}filename.adoc

License

MIT License

Copyright (c) 2024 Luftfartsverket

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.