Skip to content

gettingstarted.md

Latest commit

 

History

History
140 lines (107 loc) · 4.62 KB

gettingstarted.md

File metadata and controls

140 lines (107 loc) · 4.62 KB
Raw

Getting started

Setting up an API credential

  1. On the NHS Developer site, create a new developer account, if you do not yet have one.

  2. Add a new application by going to environment access. Use the 'Integration test' and set yourself as the owner.

  3. Create a new API, linked to Personal Demographics Service - Application-Restricted (Integration Testing). You will need to give this a globally unique name.

  4. Generate a keypair, by running these commands (from the NHS documentation)

    1. KID=test-1

    2. openssl genrsa -out $KID.pem 4096

    3. openssl rsa -in $KID.pem -pubout -outform PEM -out $KID.pem.pub

    4. ```
MODULUS=$(
openssl rsa -pubin -in $KID.pem.pub -noout -modulus `# Print modulus of public key` \
| cut -d '=' -f2                                    `# Extract modulus value from output` \
| xxd -r -p                                         `# Convert from string to bytes` \
| openssl base64 -A                                 `# Base64 encode without wrapping lines` \
| sed 's|+|-|g; s|/|_|g; s|=||g'                    `# URL encode as JWK standard requires`
)
```
    5. ```
echo '{
  "keys": [
    {
      "kty": "RSA",
      "n": "'"$MODULUS"'",
      "e": "AQAB",
      "alg": "RS512",
      "kid": "'"$KID"'",
      "use": "sig"
    }
  ]
}' > $KID.json
```

  5. Upload the test-1.json file to your application's registration, on the 'Manage public key' page

  6. On the API portal, create a new API key, and copy the Key value. You do not need the secret. Then run the following command, using your Key value between the quotation marks.

    1. API_KEY="IlmDF45AbP8Ao11pRtkK7tCoApApdABC"

  7. Create the .env file to provide these secrets to the mocked Azure Secret Manager, by running the following commands:

    1. echo "export NhsAuthConfig__NHS_DIGITAL_PRIVATE_KEY=\"$(openssl rsa -in $KID.pem -traditional -out -)\"" > .env
    2. echo "export NhsAuthConfig__NHS_DIGITAL_KID=\"$KID\"" >> .env
    3. echo "export NhsAuthConfig__NHS_DIGITAL_CLIENT_ID=\"$API_KEY\"" >> .env

If you're using an IDE (such as Jetbrains Rider), you can add these environment variables to the AppHost run configuration, as follows:

Pre-requisites

You must install the .net CLI and SDK. For macOS, run:

curl -sSL https://dot.net/v1/dotnet-install.sh | bash -s -- --version 10.0.103 --install-dir "$HOME/.dotnet"
echo 'export PATH="$HOME/.dotnet:$PATH"' >> ~/.zshrc && source ~/.zshrc && echo $PATH

You should then be able to build the solution, using

dotnet build sui-matching.sln

Local commit hooks

The repository uses Husky.Net to run pre-commit checks, including a GitLeaks scan for staged secrets. Restore the local .NET tools and install the hooks before committing:

dotnet tool restore
dotnet husky install

The GitLeaks hook uses a pinned GitLeaks binary and downloads it into a user cache directory if it is not already available. You do not need to install GitLeaks globally.

To run the secret scan manually:

dotnet pwsh ./scripts/security/run-gitleaks.ps1

If GitLeaks blocks a commit and you are certain the finding is expected, update .gitleaks.toml or regenerate .gitleaks.baseline.json. For urgent one-off commits only, you can bypass the local scan with:

SUI_SKIP_GITLEAKS=1 git commit

Unit and integration testing

  • To run the whole test suite via the terminal:
source .env
dotnet test --settings tests.runsettings

or individually:

source .env
cd sui-tests
dotnet test <path>/<to>/<test-class>

Running locally

To build and run the project:

dotnet build sui-matching.sln
dotnet run --project src/app-host/AppHost.csproj

Run simple test:

curl -H 'Content-Type: application/json' \
      -d '{ "given":"octavia","family":"chislett", "birthdate": "2008-09-20"}' \
      -X POST \
      http://localhost:5000/matching/api/v1/matchperson

You should see a matchStatus of 0 if this has been successful. A matchStatus of 4 indicates that there has been an error connecting to the PDS API.

If you have errors connecting to the aspire host page you may need to run the below commands:

dotnet dev-certs https --clean
dotnet dev-certs https --trust