[GPCAPIM-260]-[Steel Thread integration testing]-[RP] #86
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # This file is for you! Please, updated to the versions agreed by your team. | ||
|
|
||
| terraform 1.14.5 | ||
| pre-commit 3.6.0 | ||
| gitleaks 8.18.4 | ||
|
|
||
|
|
@@ -15,7 +15,7 @@ gitleaks 8.18.4 | |
| # docker/ghcr.io/make-ops-tools/gocloc latest@sha256:6888e62e9ae693c4ebcfed9f1d86c70fd083868acb8815fe44b561b9a73b5032 # SEE: https://github.com/make-ops-tools/gocloc/pkgs/container/gocloc | ||
| # docker/ghcr.io/nhs-england-tools/github-runner-image 20230909-321fd1e-rt@sha256:ce4fd6035dc450a50d3cbafb4986d60e77cb49a71ab60a053bb1b9518139a646 # SEE: https://github.com/nhs-england-tools/github-runner-image/pkgs/container/github-runner-image | ||
| # docker/hadolint/hadolint 2.12.0-alpine@sha256:7dba9a9f1a0350f6d021fb2f6f88900998a4fb0aaf8e4330aa8c38544f04db42 # SEE: https://hub.docker.com/r/hadolint/hadolint/tags | ||
| docker/hashicorp/terraform 1.14.5@sha256:96d2bc440714bf2b2f2998ac730fd4612f30746df43fca6f0892b2e2035b11bc # SEE: https://hub.docker.com/r/hashicorp/terraform/tags | ||
| # docker/koalaman/shellcheck latest@sha256:e40388688bae0fcffdddb7e4dea49b900c18933b452add0930654b2dea3e7d5c # SEE: https://hub.docker.com/r/koalaman/shellcheck/tags | ||
| # docker/mstruebing/editorconfig-checker 2.7.1@sha256:dd3ca9ea50ef4518efe9be018d669ef9cf937f6bb5cfe2ef84ff2a620b5ddc24 # SEE: https://hub.docker.com/r/mstruebing/editorconfig-checker/tags | ||
| # docker/sonarsource/sonar-scanner-cli 10.0@sha256:0bc49076468d2955948867620b2d98d67f0d59c0fd4a5ef1f0afc55cf86f2079 # SEE: https://hub.docker.com/r/sonarsource/sonar-scanner-cli/tags | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -40,6 +40,7 @@ def send_to_nonexistent_endpoint( | |
| url=nonexistent_endpoint, | ||
| data=json.dumps(simple_request_payload), | ||
| timeout=timedelta(seconds=1).total_seconds(), | ||
| cert=client.cert, | ||
| ) | ||
|
|
||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,6 +21,13 @@ def __init__(self, base_url: str, timeout: timedelta = timedelta(seconds=1)): | |
| self.base_url = base_url | ||
| self._timeout = timeout.total_seconds() | ||
|
|
||
| cert = None | ||
| cert_path = os.getenv("MTLS_CERT") | ||
| key_path = os.getenv("MTLS_KEY") | ||
| if cert_path and key_path: | ||
| cert = (cert_path, key_path) | ||
| self.cert = cert | ||
|
|
||
| def send_to_get_structured_record_endpoint( | ||
| self, payload: str, headers: dict[str, str] | None = None | ||
| ) -> requests.Response: | ||
|
|
@@ -40,6 +47,7 @@ def send_to_get_structured_record_endpoint( | |
| data=payload, | ||
| headers=default_headers, | ||
| timeout=self._timeout, | ||
| cert=self.cert, | ||
| ) | ||
|
|
||
| def send_health_check(self) -> requests.Response: | ||
|
|
@@ -49,7 +57,7 @@ def send_health_check(self) -> requests.Response: | |
| Response object from the request | ||
| """ | ||
| url = f"{self.base_url}/health" | ||
| return requests.get(url=url, timeout=self._timeout, cert=self.cert) | ||
|
|
||
|
|
||
| @pytest.fixture | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| import os | ||
| import threading | ||
| from collections.abc import Generator | ||
| from functools import partial | ||
| from http.server import BaseHTTPRequestHandler, HTTPServer | ||
| from typing import Any | ||
|
|
||
| import pytest | ||
| import requests | ||
|
|
||
|
|
||
| def get_mtls_cert() -> tuple[str, str] | None: | ||
| cert_path = os.getenv("MTLS_CERT") | ||
| key_path = os.getenv("MTLS_KEY") | ||
| if not cert_path or not key_path: | ||
| return None | ||
| return (cert_path, key_path) | ||
|
|
||
|
|
||
| class MtlsProxyHandler(BaseHTTPRequestHandler): | ||
| """ | ||
| A simple proxy that forwards requests to the target HTTPS URL | ||
| attaching the mTLS client certificates. | ||
| """ | ||
|
|
||
| def __init__( | ||
| self, | ||
| target_base: str, | ||
| cert: tuple[str, str] | None, | ||
| *args: Any, | ||
| **kwargs: Any, | ||
| ) -> None: | ||
| self.target_base = target_base | ||
| self.cert = cert | ||
| super().__init__(*args, **kwargs) | ||
|
|
||
| def do_proxy(self, method: str) -> None: | ||
| if not self.target_base: | ||
| self.send_error(500, "Target base URL not set") | ||
| return | ||
|
|
||
| url = f"{self.target_base}{self.path}" | ||
| content_length_header = self.headers.get("Content-Length") | ||
| content_length = int(content_length_header) if content_length_header else 0 | ||
| body = self.rfile.read(content_length) if content_length > 0 else None | ||
| headers = {k: v for k, v in self.headers.items() if k.lower() != "host"} | ||
|
|
||
| try: | ||
| response = requests.request( | ||
| method=method, | ||
| url=url, | ||
| headers=headers, | ||
| data=body, | ||
| cert=self.cert, | ||
| verify=False, | ||
|
Collaborator
There was a problem hiding this comment. Given we have the certificate file and key, I think we should be able to verify the certificate provided by the server here? |
||
| timeout=30, | ||
| ) | ||
|
|
||
| self.send_response(response.status_code) | ||
| for k, v in response.headers.items(): | ||
| self.send_header(k, v) | ||
| self.end_headers() | ||
| self.wfile.write(response.content) | ||
|
|
||
| except Exception as e: | ||
| self.send_error(500, f"Proxy Error: {str(e)}") | ||
|
|
||
| def do_GET(self) -> None: | ||
| self.do_proxy("GET") | ||
|
|
||
| def do_POST(self) -> None: | ||
| self.do_proxy("POST") | ||
|
|
||
| def do_PUT(self) -> None: | ||
| self.do_proxy("PUT") | ||
|
|
||
|
|
||
| @pytest.fixture(scope="module") | ||
| def mtls_proxy(base_url: str) -> Generator[str, None, None]: | ||
| """ | ||
| Spins up a local HTTP server in a separate thread. | ||
| Returns the URL of this local proxy. | ||
| """ | ||
|
|
||
| cert = get_mtls_cert() | ||
| handler_factory = partial(MtlsProxyHandler, base_url, cert) | ||
| server = HTTPServer(("localhost", 0), handler_factory) | ||
| thread = threading.Thread(target=server.serve_forever) | ||
| thread.daemon = True | ||
| thread.start() | ||
|
|
||
| yield f"http://localhost:{server.server_port}" | ||
|
|
||
| server.shutdown() | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would we ever expect this
unit-tests.xmlfile to not exist? Maybe it would be nicer to just let this step fail if the file doesn't exist, as I think this would point to something else going wrong anyway?