Digital Prison Reporting - DPR

Github - Test Harness Jobs

Ministry of Justice Digital Prison Reporting Test Harness

CODEOWNER

• Team : hmpps-digital-prison-reporting
• Email : digitalprisonreporting@digital.justice.gov.uk

Overview

Provides a python framework code for E2E testing of Digital Prision Reporting Service.

Local Development

This project uses Python3 (Python 3.11.2 ).Key packages used are as below

• boto3 botocore - for AWS resource utils
• pytest - Test framework/tool
• allure-reporting - Flexible lightweight multi-language test report tool

Pre-requistes

• Python installed (ver 3.11.2)
• AWS profile exists (Update config in test_data.ini)
• Install all python packages

       python -m venv cicd
       source cicd/bin/activate
       pip install -r requirements.txt
  

Running the tests

       runner  sh runner.sh  (or)
       cd tests && pytest

Integration Tests

       TBD

Acceptance Tests

       TBD

Contributing

Please adhere to the following guidelines when making contributions to the project.

Documentation

• Keep all code commentary and documentation up to date

Branch Naming

• Use a JIRA ticket number where available
• Otherwise a short descriptive name is acceptable

Commit Messages

• Prefix any commit messages with the JIRA ticket number where available
• Otherwise use the prefix NOJIRA

Pull Requests

• Reference or link any relevant JIRA tickets in the pull request notes
• At least one approval is required before a PR can be merged

TODO

• Modify the Dependabot file to suit the dependency manager you plan to use and for automated pull requests for package updates. Dependabot is enabled in the settings by default.
• Ensure as many of the GitHub Standards rules are maintained as possibly can.