TDR Reporting

This will generate a csv report of all consignments for the given environment.

Setting up the environment

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

Running the test locally

python -m pytest

Running different report types.

There are two different reports available.

• Standard - this is the service owner report which gives a detailed report of all consignments.
• CaseLaw - this is a summary report with fewer fields than the standard report and is only for judgment consignments.

Running the report locally

This report needs AWS credentials with SSM access to work. These can be set with environment variables, in ~/.aws/credentials or using sso profiles.

You need to also setup following environment variables if you are running from IntelliJ IDEA or you need to pass with python command:

1. AUTH_URL - For authentication. ie. https://auth.tdr-{environment}.nationalarchives.gov.uk
2. AWS_LAMBDA_FUNCTION_NAME - Use reporting lambda function name. ie. tdr-reporting-{environment}
3. CLIENT_ID - It should be tdr-reporting
4. CLIENT_SECRET_PATH - Parameter store path of the client secret eg. /{environment}/path/to/value
5. CONSIGNMENT_API_URL - Consignment API base url (https://api.tdr-{environment}.nationalarchives.gov.uk). If you are running locally then it should be http://localhost:8080.
6. AWS_DEFAULT_REGION - AWS region eu-west-2
7. SLACK_BOT_TOKEN - Should be encrypted value from {environment} SSM Parameter store
8. TDR_REPORTING_SLACK_CHANNEL_ID - Should be encrypted value from {environment} SSM Parameter store

You will need to provide a report type as the first argument, either standard or caselaw.

Once these are set you can run report_runner.py from IntelliJ IDEA or run with following command:

python report_runner.py <environment_variables> <report_type> username

It will create a file called report.csv in the /tmp directory and will send a slack message to the da-tdr-reporting Slack channel. The username must be provided and enclosed in double quotes.

Cleaning up

deactivate
rm -r venv