pytest-nhsd-apim 5.0.15__tar.gz

pytest_nhsd_apim-5.0.15/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: pytest-nhsd-apim
+Version: 5.0.15
+Summary: Pytest plugin accessing NHSDigital's APIM proxies
+Home-page: https://github.com/NHSDigital/pytest-nhsd-apim
+Author: Adrian Ciobanita
+Author-email: adrian.ciobanita1@nhs.net
+Maintainer: Alex Carrie
+Maintainer-email: alexander.carrie1@nhs.net
+License: MIT
+Classifier: Framework :: Pytest
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: Authlib==1.6.1
+Requires-Dist: cryptography==44.0.1
+Requires-Dist: lxml==5.3.1
+Requires-Dist: pycryptodome==3.20.0
+Requires-Dist: PyJWT==2.8.0
+Requires-Dist: pyotp==2.9.0
+Requires-Dist: pytest==8.2.0
+Requires-Dist: requests==2.32.0
+Requires-Dist: toml==0.10.2
+Requires-Dist: typing-extensions==4.12.2
+Requires-Dist: pydantic==2.9.2
+Requires-Dist: wheel<0.45.0,===0.37.1
+Requires-Dist: pydantic-settings==2.2.1
+Requires-Dist: setuptools==80.0.1
+Requires-Dist: urllib3==2.6.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# pytest-nhsd-apim
+
+A pytest extension for NHSDigital's API Mangement suite.
+
+## Installation
+In your project's virtual environment
+```code()
+poetry add pytest-nhsd-apim
+```
+or if using pip directly
+```code()
+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:
+```code()
+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.
+```python
+    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](/tests/test_examples.py#L308).
+### 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
+```bash
+# 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.
+```
+```python
+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](/src/pytest_nhsd_apim/apigee_apis.py#L292)  |[Overview](https://apidocs.apigee.com/docs/developer-apps/1/overview)|
+| ApiProductsAPI  | [here](/src/pytest_nhsd_apim/apigee_apis.py#L575)  |[Overview](https://apidocs.apigee.com/docs/api-products/1/overview)|
+| DebugSessionsAPI  | [here](/src/pytest_nhsd_apim/apigee_apis.py#L844)  |[Overview](https://apidocs.apigee.com/docs/debug-sessions/1/overview)|
+| AccessTokensAPI  | [here](/src/pytest_nhsd_apim/apigee_apis.py#L983)  |[Overview](https://apidocs.apigee.com/docs/oauth-20-access-tokens/1/overview)|
+| AppKeysAPI  | [here](/src/pytest_nhsd_apim/apigee_apis.py#L1243)  |[Overview](https://apidocs.apigee.com/docs/developer-app-keys/1/overview)|
+
+For a more detailed implementation of the available APIs please refer to the tests [here](/tests/test_apigee_apis.py).
+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.
+
+

pytest_nhsd_apim-5.0.15/README.md

@@ -0,0 +1,81 @@
+# pytest-nhsd-apim
+
+A pytest extension for NHSDigital's API Mangement suite.
+
+## Installation
+In your project's virtual environment
+```code()
+poetry add pytest-nhsd-apim
+```
+or if using pip directly
+```code()
+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:
+```code()
+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.
+```python
+    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](/tests/test_examples.py#L308).
+### 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
+```bash
+# 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.
+```
+```python
+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](/src/pytest_nhsd_apim/apigee_apis.py#L292)  |[Overview](https://apidocs.apigee.com/docs/developer-apps/1/overview)|
+| ApiProductsAPI  | [here](/src/pytest_nhsd_apim/apigee_apis.py#L575)  |[Overview](https://apidocs.apigee.com/docs/api-products/1/overview)|
+| DebugSessionsAPI  | [here](/src/pytest_nhsd_apim/apigee_apis.py#L844)  |[Overview](https://apidocs.apigee.com/docs/debug-sessions/1/overview)|
+| AccessTokensAPI  | [here](/src/pytest_nhsd_apim/apigee_apis.py#L983)  |[Overview](https://apidocs.apigee.com/docs/oauth-20-access-tokens/1/overview)|
+| AppKeysAPI  | [here](/src/pytest_nhsd_apim/apigee_apis.py#L1243)  |[Overview](https://apidocs.apigee.com/docs/developer-app-keys/1/overview)|
+
+For a more detailed implementation of the available APIs please refer to the tests [here](/tests/test_apigee_apis.py).
+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.
+
+

pytest_nhsd_apim-5.0.15/pyproject.toml

@@ -0,0 +1,42 @@
+[tool.poetry]
+name = "pytest-nhsd-apim"
+version = "5.0.15"
+description = "Pytest plugin accessing NHSDigital's APIM proxies"
+authors = ["Adrian Ciobanita <adrian.ciobanita1@nhs.net>", "Alex Carrie <alexander.carrie1@nhs.net>", "Lucas Fantini <lucas.fantini@nhs.net>"]
+maintainers = ["Alex Carrie <alexander.carrie1@nhs.net>", "Alex Hawdon <alex.hawdon1@nhs.net"]
+readme = "README.md"
+repository = "https://github.com/NHSDigital/pytest-nhsd-apim"
+classifiers = ["Framework :: Pytest"]
+license = "MIT"
+
+[tool.poetry.dependencies]
+Authlib = "^1.6.1"
+cryptography = ">44.0.1"
+lxml = "^5.3.1"
+python = "^3.13"
+pycryptodome = "^3.20.0"
+PyJWT = "^2.8.0"
+pyotp = "^2.9.0"
+pytest = "^8.2.0"
+requests = "^2.32.0"
+toml = "^0.10.2"
+typing-extensions = "^4.12.2"
+pydantic = "^2.9.2"
+wheel = ">=0.37.1,<0.45.0"
+pydantic-settings = "^2.2.1"
+setuptools = "^80.0.1" 
+urllib3 = "^2.6.1"
+
+# [tool.poetry.group.dev.dependencies]
+
+[tool.pytest.ini_options]
+log_cli = true
+log_cli_level = "INFO"
+log_cli_format = "%(asctime)s - %(name)s.%(module)s.%(funcName)s - %(levelname)s - %(message)s"
+log_file_level = "DEBUG"
+log_file_format = "%(asctime)s - %(name)s.%(module)s.%(funcName)s - %(levelname)s - %(message)s"
+log_file_date_format = "%Y-%m-%d %H:%M:%S"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

pytest_nhsd_apim-5.0.15/setup.cfg

@@ -0,0 +1,7 @@
+[flake8]
+max-line-length = 120
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

pytest_nhsd_apim-5.0.15/setup.py

@@ -0,0 +1,90 @@
+"""
+pytest-nhsd-apim setup install.
+"""
+
+import os
+
+import toml
+from setuptools import setup, find_packages
+
+
+def _read_file(file_name):
+    """
+    Read a file from disk, given it's `file_name`
+    :param file_name: file name, including extension
+    :type file_name: str
+    :return: file stream
+    :rtype: IO stream
+    """
+    path_to_file = os.path.join(os.path.dirname(__file__), file_name)
+    with open(path_to_file) as f_stream:
+        return f_stream.read()
+
+
+def readme():
+    """
+    Open this project's `README.md`.
+    :return: `README.md` file stream
+    :rtype: IO stream
+    """
+    return _read_file("README.md")
+
+
+def get_pyproject_toml_metadata():
+    """
+    Read `pyproject.toml`.
+    :return: `pyproject.toml` values
+    :rtype: dict
+    """
+    return toml.loads(_read_file("pyproject.toml"))
+
+
+def get_name_and_email(name_and_email_pair):
+    """
+    Get name and email from a string of form `FirstName LastName <email_address>`
+    :param name_and_email_pair: `FirstName LastName <email_address>`
+    :type name_and_email_pair: str
+    :return: tuple with name and email address
+    :rtype: tuple
+    """
+    return name_and_email_pair[0].split(' <')[:1][0], name_and_email_pair[0].split(" <")[1:][0][:-1]
+
+
+def get_package_dependencies(toml_dependencies):
+    """
+    Read package dependencies from `pyproject.toml`
+    :param toml_dependencies: `pyproject.toml` dict containing project dependencies
+    :type toml_dependencies: dict
+    :return: data needed by setuptools to pass into `install_requires`
+    :rtype: list
+    """
+    install_requires = ["{}=={}".format(pkg_name, pkg_version[1:])
+                        for pkg_name, pkg_version in toml_dependencies.items() if pkg_name != 'python']
+
+    return install_requires
+
+
+PYPROJECT_METADATA = get_pyproject_toml_metadata()
+AUTHOR, AUTHOR_EMAIL = get_name_and_email(PYPROJECT_METADATA['tool']['poetry']['authors'])
+MAINTAINER, MAINTAINER_EMAIL = get_name_and_email(PYPROJECT_METADATA['tool']['poetry']['maintainers'])
+
+setup(
+    name=PYPROJECT_METADATA['tool']['poetry']['name'],
+    version=PYPROJECT_METADATA['tool']['poetry']['version'],
+    author=AUTHOR,
+    author_email=AUTHOR_EMAIL,
+    maintainer=MAINTAINER,
+    maintainer_email=MAINTAINER_EMAIL,
+    license=PYPROJECT_METADATA['tool']['poetry']['license'],
+    url=PYPROJECT_METADATA['tool']['poetry']['repository'],
+    description=PYPROJECT_METADATA['tool']['poetry']['description'],
+    long_description=readme(),
+    long_description_content_type='text/markdown',
+    packages=find_packages(where="src"),
+    package_dir={"": "src"},
+    package_data={"": ["data/*"]},
+    python_requires=">=3.8",
+    entry_points={"pytest11": ["nhsd_apim = pytest_nhsd_apim.pytest_nhsd_apim"]},
+    classifiers=PYPROJECT_METADATA['tool']['poetry']['classifiers'],
+    install_requires=get_package_dependencies(PYPROJECT_METADATA['tool']['poetry']['dependencies']),
+)

pytest_nhsd_apim-5.0.15/src/pytest_nhsd_apim/__init__.py

@@ -0,0 +1,3 @@
+import logging
+
+logging.getLogger("urllib3").setLevel(logging.CRITICAL)