Skip to main content

Pytest plugin accessing NHSDigital's APIM proxies

Project description

pytest-nhsd-apim

A pytest extension for NHSDigital's API Mangement suite.

Installation

In your project's virtual environment

poetry add pytest-nhsd-apim

or if using pip directly

python -m pip install pytest-nhsd-apim

Usage

  • create a python test file
  • write a test using our custom authentication markers!
  • enjoy!?

Testing

  • run make test to run test examples, located in this repo
  • after creating your file you can use the plugin as:
python -m pytest -p pytest_nhsd_apim test_nhsd_apim.py -s --apigee-proxy-name=<your-proxy-name>

Available tools

When installing this library in your project you can access some very handy tools, including our platform authenticators and our apigee api wrapper library.

Autheticators

We present a variety of authenticators including AuthorizationCodeAuthenticator, ClientCredentialsAuthenticator and TokenExchangeAuthenticator. The way of using them is simple. First you create the configuration object which will validate that your coniguration is correct on creation using pydantic, then pass the config to the authenticator and call get_token() on it.

    from pytest_nhsd_apim.identity_service import ClientCredentialsConfig, ClientCredentialsAuthenticator

    config = ClientCredentialsConfig(
        environment={APIGEE_ENVIRONMENT},
        identity_service_base_url={BASE_URL},
        client_id={CLIENT_ID},
        jwt_private_key={PRIVATE_KEY_PEM},
        jwt_kid={KEY_ID},
    )

    authenticator=ClientCredentialsAuthenticator(config=config)
    token=authenticator.get_token()

For a more detailed implementation on the rest of the authenticators please refer to the examples here.

Apigee APIs

We also present a variety off Apigee APIs with the benefit of a fully authenticated Apigee client ready to use. Just remember to export the following variables

# If you want the client to authenticate you...
export APIGEE_NHSD_NONPROD_USERNAME={my_username}
export APIGEE_NHSD_NONPROD_PASSWORD={my_password}
export APIGEE_NHSD_NONPROD_OTP_KEY={my_otp}
# Or alternatively, if you already have a token you can pass it and the client will use it.
export APIGEE_ACCESS_TOKEN={access_token}

#NOTE: in case both sets of credentials are defined, the username and password take presedence, this is so the Apigee client can keep itself authenticated all the time.
from pytest_nhsd_apim.apigee_apis import ApigeeNonProdCredentials, DeveloperAppsAPI

config = ApigeeNonProdCredentials()
client =  ApigeeClient(config=config)
apps = DeveloperAppsAPI(client=client)

print(apps.list_aps('lucas.fantini@nhs.net'))

The APIs we offer at the moment are:

API Methods Documentation
DeveloperAppsAPI here Overview
ApiProductsAPI here Overview
DebugSessionsAPI here Overview
AccessTokensAPI here Overview
AppKeysAPI here Overview

For a more detailed implementation of the available APIs please refer to the tests here. We will keep adding APIs with time, if you are looking for a particular APIs not listed above please feel free to open a pull request and send it to us.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest_nhsd_apim-5.0.0.tar.gz (40.3 kB view details)

Uploaded Source

Built Distribution

pytest_nhsd_apim-5.0.0-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

Details for the file pytest_nhsd_apim-5.0.0.tar.gz.

File metadata

  • Download URL: pytest_nhsd_apim-5.0.0.tar.gz
  • Upload date:
  • Size: 40.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.8.18 Linux/6.8.0-1021-azure

File hashes

Hashes for pytest_nhsd_apim-5.0.0.tar.gz
Algorithm Hash digest
SHA256 7107b78ac0162727dccb8f51ca19ee339d86cdbcb97ae1948ff19e840d2ad932
MD5 60c956b69e97260bc1b611ff54af81f4
BLAKE2b-256 b11051c00401af8dfd04066d4a4c63b736d64cbe945602d525b538b85aa7069d

See more details on using hashes here.

File details

Details for the file pytest_nhsd_apim-5.0.0-py3-none-any.whl.

File metadata

  • Download URL: pytest_nhsd_apim-5.0.0-py3-none-any.whl
  • Upload date:
  • Size: 36.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.8.18 Linux/6.8.0-1021-azure

File hashes

Hashes for pytest_nhsd_apim-5.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ef79d99221e403e2198c3f206655f85ff59a9111549b03367f39b1cfe444828d
MD5 443dddb453402750cac92ad964a61c64
BLAKE2b-256 76ae3893ff646eccd1633cb55a4a495483cd80e4e9c4a52bfbacf24c05bd661c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page