README.md

Important

This repository has been archived and the code moved to a new combined pre-award-stores.

funding-service-design-fund-store

This is the fund store for funding service design Access Funding. This service provides an API and associated model implementation for fund and round configuration data.

Developer setup guide

This service depends on:

• A postgres database
• No other microservices

Data

Local DB Setup

General instructions for local db development are available here: Local database development

DB Helper Scripts

This repository uses invoke to provide scripts for dropping and recreating the local database in tasks.py

Running Locally

To run locally, make sure psql client is installed on your machine(https://www.postgresql.org/download/) and set the environment variable DATABASE_URL,

# pragma: allowlist nextline secret
export DATABASE_URL=postgresql://postgres:password@127.0.0.1:5432/fund_store

Running in-container

To run the tasks inside the docker container used by docker compose, first bash into the container:

docker exec -it $(docker ps -qf "name=fund-store") bash

Then execute the required tasks using inv as below.

Or to combine the two into one command:

    docker exec -it $(docker ps -qf "name=fund-store") inv truncate-data

Available scripts

The following commands are the same locally or in container

Recreate DB instance

    inv recreate-local-db

this drops (if it exists) and recreates the DB

Truncate data

    inv truncate-data

)

Seeding Fund Data

To seed fund & round data to db for all funds and rounds, use the fund/round loaders scripts.

If running against a local postgresql instance:

    python -m scripts.load_all_fund_rounds

If running with the docker compose setup:

    docker exec -ti $(docker ps -qf "name=fund-store") python -m scripts.load_all_fund_rounds

Further details on the fund/round loader scripts, and how to load data for a specific fund or round can be found here

Amending round dates

This script allows you to open/close rounds using their dates to test different functionality as needed. You can also use the keywords 'PAST', 'FUTURE' and 'UNCHANGED' to save typing dates.

docker exec -ti $(docker ps -qf "name=fund-store") python -m scripts.amend_round_dates -q update-round-dates --round_id c603d114-5364-4474-a0c4-c41cbf4d3bbd --application_deadline "2023-03-30 12:00:00"

docker exec -ti $(docker ps -qf "name=fund-store") python -m scripts.amend_round_dates -q update-round-dates -r COF_R3W3 -o "2022-10-04 12:00:00" -d "2022-12-14 11:59:00" -ad "2023-03-30 12:00:00" -as NONE

docker exec -ti $(docker ps -qf "name=fund-store") python -m scripts.amend_round_dates -q update-round-dates -r COF_R3W3 -o PAST -d FUTURE

For an interactive prompt where you can supply (or leave unchanged) all dates:

docker exec -ti $(docker ps -qf "name=fund-store") python -m scripts.amend_round_dates update-round-dates

To reset the dates for a round to those in the fund loader config:

docker exec -ti $(docker ps -qf "name=fund-store") python -m scripts.amend_round_dates -q reset-round-dates -r COF_R4W1

And with an interactive prompt:

docker exec -ti $(docker ps -qf "name=fund-store") python -m scripts.amend_round_dates reset-round-dates

Testing

Testing in Python repos

IDE Setup

Python IDE Setup

Builds and Deploys

Details on how our pipelines work and the release process is available here

Paketo

Paketo is used to build the docker image which gets deployed to our test and production environments. Details available here

Copilot

Copilot is used for infrastructure deployment. Instructions are available here, with the following values for the fund store:

• service-name: fsd-fund-store
• image-name: funding-service-design-fund-store