# pytest-docker-apache-fixtures
[](https://pypi.org/project/pytest-docker-apache-fixtures)
[](https://github.com/crashvb/pytest-docker-apache-fixtures/actions)
[](https://coveralls.io/github/crashvb/pytest-docker-apache-fixtures)
[](https://pypi.org/project/pytest-docker-apache-fixtures)
[](https://github.com/PyCQA/pylint)
[](https://github.com/psf/black)
[](https://github.com/crashvb/pytest-docker-apache-fixtures/blob/master/LICENSE.md)
## Overview
Pytest fixtures to instantiate and utilize local apache (httpd) docker containers, using [lovely-pytest-docker](https://pypi.org/project/lovely-pytest-docker) and [docker-py](https://pypi.org/project/docker-py), for testing.
## Getting Started
Update <tt>setup.py</tt> to include:
```python
from distutils.core import setup
setup(
tests_require=["pytest-docker-apache-fixtures"]
)
```
All fixtures should be automatically included via the <tt>pytest11</tt> entry point.
```python
import requests
import pytest
from pytest_docker_apache_fixtures import ApacheInsecure, ApacheSecure # Optional, for typing
def test_apache_secure(apache_secure: ApacheSecure):
response = requests.head(f"https://{apache_secure.endpoint}/",
headers=apache_secure.auth_header,
verify=str(apache_secure.cacerts),
)
assert response.status_code == 200
def test_apache_insecure(apache_insecure: ApacheInsecure):
response = requests.head(f"http://{apache_insecure.endpoint}/")
assert response.status_code == 200
```
The `push_image` mark can optionally be added to stage images in the apache prior to testing. See [Markers](#markers) for details.
## Installation
### From [pypi.org](https://pypi.org/project/pytest-docker-apache-fixtures/)
```
$ pip install pytest_docker_apache_fixtures
```
### From source code
```bash
$ git clone https://github.com/crashvb/pytest-docker-apache-fixtures
$ cd pytest-docker-apache-fixtures
$ virtualenv env
$ source env/bin/activate
$ python -m pip install --editable .[dev]
```
## <a name="fixtures"></a>Fixtures
### <a name="apache_auth_header"></a> apache_auth_header
Retrieves an HTTP basic authentication header that is populated with credentials that can access the secure apache service. The credentials are retrieved from the [apache_password](#apache_password) and [apache_username](#apache_username) fixtures. This fixture is used to replicate docker images into the secure apache service.
### <a name="apache_cacerts"></a> apache_cacerts
Locates a user-defined CA trust store (<tt>tests/cacerts</tt>) to use to verify connections to the secure apache service. If one cannot be located, a temporary trust store is created containing certificates from <tt>certifi</tt> and the [apache_certs](#apache_certs) fixture. This fixture is used to instantiate the secure apache service.
### <a name="apache_certs"></a> apache_certs
Returns the paths of the self-signed certificate authority certificate, certificate, and private key that are used by the secure apache service. This fixture is used to instantiate the secure apache service.
#### NamedTuple Fields
The following fields are defined in the tuple provided by this fixture:
* **ca_certificate** - Path to the self-signed certificate authority certificate.
* **ca_private_key** - Path to the self-signed certificate authority private key.
* **certificate** - Path to the certificate.
* **private_key** - Path to the private key.
Typing is provided by `pytest_docker_apache_fixtures.ApacheCerts`.
### <a name="apache_hwpasswd"></a> apache_htpasswd
Provides the path to a htpasswd file that is used by the secure apache service. If a user-defined htpasswd file (<tt>tests/htpasswd</tt>) can be located, it is used. Otherwise, a temporary htpasswd file is created using credentials from the [apache_password](#apache_password) and [apache_username](#apache_username) fixtures. This fixture is used to instantiate the secure apache ervice.
### <a name="apache_apachecfg_insecure"></a> apache_apachecfg_insecure
Provides the path to an insecure apache.cfg file that is used by the insecure apache service. If a user-defined apache.cfg file (<tt>tests/apache.insecure.cfg</tt>) can be located, it is used. Otherwise, an embedded configuration is copied to a temporary location and returned. This fixture is used to instantiate the insecure apache service.
### <a name="apache_apachecfg_secure"></a> apache_apachecfg_secure
Provides the path to a secure apache.cfg file that is used by the secure apache service. If a user-defined apache.cfg file (<tt>tests/apache.secure.cfg</tt>) can be located, it is used. Otherwise, an embedded configuration is copied to a temporary location and returned. This fixture is used to instantiate the secure apache service.
### <a name="apache_insecure"></a> apache_insecure
Configures and instantiates a apache service without TLS or authentication.
```python
import requests
from pytest_docker_apache_fixtures import ApacheInsecure # Optional, for typing
def test_apache_insecure(apache_insecure: ApacheInsecure):
response = requests.head(f"http://{apache_insecure.endpoint}/")
assert response.status_code == 200
```
#### NamedTuple Fields
The following fields are defined in the tuple provided by this fixture:
* **docker_compose** - Path to the fully instantiated docker-compose configuration.
* **endpoint** - Endpoint of the insecure apache service.
* **endpoint_name** - Endpoint of the insecure apache service, by service name.
* **service_name** - Name of the service within the docker-compose configuration.
Typing is provided by `pytest_docker_apache_fixtures.ApacheInsecure`.
### <a name="apache_password"></a> apache_password
Provides a generated password to use for authentication to the secure apache service. This fixture is used to replicate docker images into the secure apache service.
### <a name="apache_secure"></a> apache_secure
Configures and instantiates a TLS enabled apache service with HTTP basic authorization.
```python
import requests
from pytest_docker_apache_fixtures import ApacheSecure # Optional, for typing
def test_apache_secure(apache_secure: ApacheSecure):
response = requests.head(
f"https://{apache_secure.endpoint}/",
headers=apache_secure.auth_header,
verify=str(apache_secure.cacerts),
)
assert response.status_code == 200
```
#### NamedTuple Fields
The following fields are defined in the tuple provided by this fixture:
* **auth_header** - from [apache_auth_header](#apache_auth_header).
* **cacerts** - from [apache_cacerts](#apache_cacerts).
* **certs** - from [apache_certs](#apache_certs).
* **docker_compose** - Path to the fully instantiated docker-compose configuration.
* **endpoint** - Endpoint of the secure apache service.
* **endpoint_name** - Endpoint of the secure apache service, by service name.
* **htpasswd** - from [apache_htpasswd](#apache_htpasswd)
* **password** - from [apache_password](#apache_password).
* **service_name** - Name of the service within the docker-compose configuration.
* **ssl_context** - from [apache_ssl_context](#apache_ssl_context).
* **username** - from [apache_username](#apache_username).
Typing is provided by `pytest_docker_apache_fixtures.ApacheSecure`.
### <a name="apache_ssl_context"></a> apache_ssl_context
Provides an SSL context containing the CA trust store from the [apache_cacerts](#apache_cacerts) fixture. This fixture is used to instantiate the secure apache service.
### <a name="apache_username"></a> apache_username
Provides a generated username to use for authentication to the secure apache service. This fixture is used to replicate docker images into the secure apache service.
### <a name="pdaf_docker_compose_insecure"></a> pdaf_docker_compose_insecure
This fixture uses the `docker_compose_files` fixture to locate a user-defined docker-compose configuration file (typically <tt>tests/docker-compose.yml</tt>) that contains the <tt>pytest-docker-apache-insecure</tt> service. If one cannot be located, an embedded configuration is copied to a temporary location and returned. This fixture is used to instantiate the insecure apache service. The configuration will be treated as a template; the <tt>$PATH_APACHECFG</tt> token will be populated with the absolute path provided by the [apache_apachecfg](#apache_apachecfg) fixture.
### <a name="pdaf_docker_compose_secure"></a> pdaf_docker_compose_secure
This fixture uses the `docker_compose_files` fixture to locate a user-defined docker-compose configuration file (typically <tt>tests/docker-compose.yml</tt>) that contains the <tt>pytest-docker-apache-secure</tt> service. If one cannot be located, an embedded configuration is copied to a temporary location and returned. This fixture is used to instantiate the secure apache service. The configuration will be treated as a template; the <tt>$PATH_CERTIFICATE</tt>, <tt>$PATH_HTPASSWD</tt>, <tt>$PATH_KEY</tt>, and <tt>$PATH_APACHECFG</tt> tokens will be populated with the absolute paths provided by the [apache_certs](#apache_certs), [apache_htpasswd](#apache_htpasswd), and [apache_apachecfg](#apache_apachecfg) fixtures, as appropriate.
## <a name="enumerated_fixtures"></a>Enumerated Fixtures
It is possible to instantiate multiple apache instances using the corresponding enumerated fixtures. All [fixtures](#fixtures) listed above have _*_list_ (e.g. `apache_secure` -> `apache_secure_list`) versions that will return enumerated lists of corresponding data type.
For example:
```python
import requests
from typing import List # Optional, for typing
from pytest_docker_apache_fixtures import ApacheSecure # Optional, for typing
def test_apache_secure_list(apache_secure_list: List[ApacheSecure]):
for apache_secure in apache_secure_list:
response = requests.head(
f"https://{apache_secure.endpoint}/",
headers=apache_secure.auth_header,
verify=str(apache_secure.cacerts),
)
assert response.status_code == 200
```
It is possible to use both singular and enumerated fixtures within the same test context; however, the same values will be returned for the singular fixture as the first enumerated list value (i.e. apache_secure == apache_secure_list[0]). To avoid complications with lower layers, mainly docker-compose, and to allow for this interchangeability, caching is used internally.
By default, the scale factor of the enumerated instances is set to one (n=1). This value can be changed by overriding the `pdaf_scale_factor` fixture, as follows:
```python
import pytest
@pytest.fixture(scope="session")
def pdaf_scale_factor() -> int:
return 4
```
This fixture will be used to scale both the insecure and secure docker registries.
## <a name="limitations"></a>Limitations
1. All the fixtures provided by this package are <tt>session</tt> scoped; and will only be executed once per test execution.
2. At most 10 insecure and 10 secure apache instances are supported using the embedded docker compose.
## Development
[Source Control](https://github.com/crashvb/pytest-docker-apache-fixtures)
Raw data
{
"_id": null,
"home_page": "https://github.com/crashvb/pytest-docker-apache-fixtures",
"name": "pytest-docker-apache-fixtures",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "apache apache2 docker fixtures httpd pytest",
"author": "Richard Davis",
"author_email": "crashvb@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2b/1e/52d668adfad8c27fd9fb7198855dedec791874b0312dfbcaf621dd246eaa/pytest_docker_apache_fixtures-1.0.0.tar.gz",
"platform": null,
"description": "# pytest-docker-apache-fixtures\n\n[](https://pypi.org/project/pytest-docker-apache-fixtures)\n[](https://github.com/crashvb/pytest-docker-apache-fixtures/actions)\n[](https://coveralls.io/github/crashvb/pytest-docker-apache-fixtures)\n[](https://pypi.org/project/pytest-docker-apache-fixtures)\n[](https://github.com/PyCQA/pylint)\n[](https://github.com/psf/black)\n[](https://github.com/crashvb/pytest-docker-apache-fixtures/blob/master/LICENSE.md)\n\n## Overview\n\nPytest fixtures to instantiate and utilize local apache (httpd) docker containers, using [lovely-pytest-docker](https://pypi.org/project/lovely-pytest-docker) and [docker-py](https://pypi.org/project/docker-py), for testing.\n\n## Getting Started\n\nUpdate <tt>setup.py</tt> to include:\n\n```python\nfrom distutils.core import setup\n\nsetup(\n\ttests_require=[\"pytest-docker-apache-fixtures\"]\n)\n```\n\nAll fixtures should be automatically included via the <tt>pytest11</tt> entry point.\n```python\nimport requests\nimport pytest\nfrom pytest_docker_apache_fixtures import ApacheInsecure, ApacheSecure # Optional, for typing\n\ndef test_apache_secure(apache_secure: ApacheSecure):\n response = requests.head(f\"https://{apache_secure.endpoint}/\",\n headers=apache_secure.auth_header,\n verify=str(apache_secure.cacerts),\n )\n assert response.status_code == 200\n\ndef test_apache_insecure(apache_insecure: ApacheInsecure):\n response = requests.head(f\"http://{apache_insecure.endpoint}/\")\n assert response.status_code == 200\n```\n\nThe `push_image` mark can optionally be added to stage images in the apache prior to testing. See [Markers](#markers) for details.\n\n## Installation\n### From [pypi.org](https://pypi.org/project/pytest-docker-apache-fixtures/)\n\n```\n$ pip install pytest_docker_apache_fixtures\n```\n\n### From source code\n\n```bash\n$ git clone https://github.com/crashvb/pytest-docker-apache-fixtures\n$ cd pytest-docker-apache-fixtures\n$ virtualenv env\n$ source env/bin/activate\n$ python -m pip install --editable .[dev]\n```\n\n## <a name=\"fixtures\"></a>Fixtures\n\n### <a name=\"apache_auth_header\"></a> apache_auth_header\n\nRetrieves an HTTP basic authentication header that is populated with credentials that can access the secure apache service. The credentials are retrieved from the [apache_password](#apache_password) and [apache_username](#apache_username) fixtures. This fixture is used to replicate docker images into the secure apache service.\n\n### <a name=\"apache_cacerts\"></a> apache_cacerts\n\nLocates a user-defined CA trust store (<tt>tests/cacerts</tt>) to use to verify connections to the secure apache service. If one cannot be located, a temporary trust store is created containing certificates from <tt>certifi</tt> and the [apache_certs](#apache_certs) fixture. This fixture is used to instantiate the secure apache service.\n\n### <a name=\"apache_certs\"></a> apache_certs\n\nReturns the paths of the self-signed certificate authority certificate, certificate, and private key that are used by the secure apache service. This fixture is used to instantiate the secure apache service.\n\n#### NamedTuple Fields\n\nThe following fields are defined in the tuple provided by this fixture:\n\n* **ca_certificate** - Path to the self-signed certificate authority certificate.\n* **ca_private_key** - Path to the self-signed certificate authority private key.\n* **certificate** - Path to the certificate.\n* **private_key** - Path to the private key.\n\nTyping is provided by `pytest_docker_apache_fixtures.ApacheCerts`.\n\n### <a name=\"apache_hwpasswd\"></a> apache_htpasswd\n\nProvides the path to a htpasswd file that is used by the secure apache service. If a user-defined htpasswd file (<tt>tests/htpasswd</tt>) can be located, it is used. Otherwise, a temporary htpasswd file is created using credentials from the [apache_password](#apache_password) and [apache_username](#apache_username) fixtures. This fixture is used to instantiate the secure apache ervice.\n\n### <a name=\"apache_apachecfg_insecure\"></a> apache_apachecfg_insecure\n\nProvides the path to an insecure apache.cfg file that is used by the insecure apache service. If a user-defined apache.cfg file (<tt>tests/apache.insecure.cfg</tt>) can be located, it is used. Otherwise, an embedded configuration is copied to a temporary location and returned. This fixture is used to instantiate the insecure apache service.\n\n### <a name=\"apache_apachecfg_secure\"></a> apache_apachecfg_secure\n\nProvides the path to a secure apache.cfg file that is used by the secure apache service. If a user-defined apache.cfg file (<tt>tests/apache.secure.cfg</tt>) can be located, it is used. Otherwise, an embedded configuration is copied to a temporary location and returned. This fixture is used to instantiate the secure apache service.\n\n### <a name=\"apache_insecure\"></a> apache_insecure\n\nConfigures and instantiates a apache service without TLS or authentication.\n\n```python\nimport requests\nfrom pytest_docker_apache_fixtures import ApacheInsecure # Optional, for typing\n\ndef test_apache_insecure(apache_insecure: ApacheInsecure):\n response = requests.head(f\"http://{apache_insecure.endpoint}/\")\n assert response.status_code == 200\n```\n\n#### NamedTuple Fields\n\nThe following fields are defined in the tuple provided by this fixture:\n\n* **docker_compose** - Path to the fully instantiated docker-compose configuration.\n* **endpoint** - Endpoint of the insecure apache service.\n* **endpoint_name** - Endpoint of the insecure apache service, by service name.\n* **service_name** - Name of the service within the docker-compose configuration.\n\nTyping is provided by `pytest_docker_apache_fixtures.ApacheInsecure`.\n\n### <a name=\"apache_password\"></a> apache_password\n\nProvides a generated password to use for authentication to the secure apache service. This fixture is used to replicate docker images into the secure apache service.\n\n### <a name=\"apache_secure\"></a> apache_secure\n\nConfigures and instantiates a TLS enabled apache service with HTTP basic authorization.\n\n```python\nimport requests\nfrom pytest_docker_apache_fixtures import ApacheSecure # Optional, for typing\n\ndef test_apache_secure(apache_secure: ApacheSecure):\n response = requests.head(\n f\"https://{apache_secure.endpoint}/\",\n headers=apache_secure.auth_header,\n verify=str(apache_secure.cacerts),\n )\n assert response.status_code == 200\n```\n\n#### NamedTuple Fields\n\nThe following fields are defined in the tuple provided by this fixture:\n\n* **auth_header** - from [apache_auth_header](#apache_auth_header).\n* **cacerts** - from [apache_cacerts](#apache_cacerts).\n* **certs** - from [apache_certs](#apache_certs).\n* **docker_compose** - Path to the fully instantiated docker-compose configuration.\n* **endpoint** - Endpoint of the secure apache service.\n* **endpoint_name** - Endpoint of the secure apache service, by service name.\n* **htpasswd** - from [apache_htpasswd](#apache_htpasswd)\n* **password** - from [apache_password](#apache_password).\n* **service_name** - Name of the service within the docker-compose configuration.\n* **ssl_context** - from [apache_ssl_context](#apache_ssl_context).\n* **username** - from [apache_username](#apache_username).\n\nTyping is provided by `pytest_docker_apache_fixtures.ApacheSecure`.\n\n### <a name=\"apache_ssl_context\"></a> apache_ssl_context\n\nProvides an SSL context containing the CA trust store from the [apache_cacerts](#apache_cacerts) fixture. This fixture is used to instantiate the secure apache service.\n\n### <a name=\"apache_username\"></a> apache_username\n\nProvides a generated username to use for authentication to the secure apache service. This fixture is used to replicate docker images into the secure apache service.\n\n### <a name=\"pdaf_docker_compose_insecure\"></a> pdaf_docker_compose_insecure\n\nThis fixture uses the `docker_compose_files` fixture to locate a user-defined docker-compose configuration file (typically <tt>tests/docker-compose.yml</tt>) that contains the <tt>pytest-docker-apache-insecure</tt> service. If one cannot be located, an embedded configuration is copied to a temporary location and returned. This fixture is used to instantiate the insecure apache service. The configuration will be treated as a template; the <tt>$PATH_APACHECFG</tt> token will be populated with the absolute path provided by the [apache_apachecfg](#apache_apachecfg) fixture.\n\n### <a name=\"pdaf_docker_compose_secure\"></a> pdaf_docker_compose_secure\n\nThis fixture uses the `docker_compose_files` fixture to locate a user-defined docker-compose configuration file (typically <tt>tests/docker-compose.yml</tt>) that contains the <tt>pytest-docker-apache-secure</tt> service. If one cannot be located, an embedded configuration is copied to a temporary location and returned. This fixture is used to instantiate the secure apache service. The configuration will be treated as a template; the <tt>$PATH_CERTIFICATE</tt>, <tt>$PATH_HTPASSWD</tt>, <tt>$PATH_KEY</tt>, and <tt>$PATH_APACHECFG</tt> tokens will be populated with the absolute paths provided by the [apache_certs](#apache_certs), [apache_htpasswd](#apache_htpasswd), and [apache_apachecfg](#apache_apachecfg) fixtures, as appropriate.\n\n## <a name=\"enumerated_fixtures\"></a>Enumerated Fixtures\n\nIt is possible to instantiate multiple apache instances using the corresponding enumerated fixtures. All [fixtures](#fixtures) listed above have _*_list_ (e.g. `apache_secure` -> `apache_secure_list`) versions that will return enumerated lists of corresponding data type.\n\nFor example:\n\n```python\nimport requests\nfrom typing import List # Optional, for typing\nfrom pytest_docker_apache_fixtures import ApacheSecure # Optional, for typing\n\ndef test_apache_secure_list(apache_secure_list: List[ApacheSecure]):\n for apache_secure in apache_secure_list:\n response = requests.head(\n f\"https://{apache_secure.endpoint}/\",\n headers=apache_secure.auth_header,\n verify=str(apache_secure.cacerts),\n )\n assert response.status_code == 200\n```\n\nIt is possible to use both singular and enumerated fixtures within the same test context; however, the same values will be returned for the singular fixture as the first enumerated list value (i.e. apache_secure == apache_secure_list[0]). To avoid complications with lower layers, mainly docker-compose, and to allow for this interchangeability, caching is used internally.\n\nBy default, the scale factor of the enumerated instances is set to one (n=1). This value can be changed by overriding the `pdaf_scale_factor` fixture, as follows:\n\n```python\nimport pytest\n\n@pytest.fixture(scope=\"session\")\ndef pdaf_scale_factor() -> int:\n return 4\n```\n\nThis fixture will be used to scale both the insecure and secure docker registries.\n\n## <a name=\"limitations\"></a>Limitations\n\n1. All the fixtures provided by this package are <tt>session</tt> scoped; and will only be executed once per test execution.\n2. At most 10 insecure and 10 secure apache instances are supported using the embedded docker compose.\n\n## Development\n\n[Source Control](https://github.com/crashvb/pytest-docker-apache-fixtures)\n\n\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Pytest fixtures for testing with apache2 (httpd).",
"version": "1.0.0",
"project_urls": {
"Bug Reports": "https://github.com/crashvb/pytest-docker-apache-fixtures/issues",
"Homepage": "https://github.com/crashvb/pytest-docker-apache-fixtures",
"Source": "https://github.com/crashvb/pytest-docker-apache-fixtures"
},
"split_keywords": [
"apache",
"apache2",
"docker",
"fixtures",
"httpd",
"pytest"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ef85826ba4743f28879b8fddd9fe4235a10d83be02946c5d7a915a9deb9ae60",
"md5": "99a4cda837700f0fa0499256ccdda7d4",
"sha256": "2d0c3efc244f6774e45b978221f02c57b6efcf004cf7c4263240797a64f38a57"
},
"downloads": -1,
"filename": "pytest_docker_apache_fixtures-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "99a4cda837700f0fa0499256ccdda7d4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 23752,
"upload_time": "2024-08-12T23:34:01",
"upload_time_iso_8601": "2024-08-12T23:34:01.373899Z",
"url": "https://files.pythonhosted.org/packages/4e/f8/5826ba4743f28879b8fddd9fe4235a10d83be02946c5d7a915a9deb9ae60/pytest_docker_apache_fixtures-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b1e52d668adfad8c27fd9fb7198855dedec791874b0312dfbcaf621dd246eaa",
"md5": "0806f0ae2987099e08bfa8d44ca51af7",
"sha256": "566f48851ccec36abcf2068d905ae1602ab570ea108a174f1925b9eb797db671"
},
"downloads": -1,
"filename": "pytest_docker_apache_fixtures-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "0806f0ae2987099e08bfa8d44ca51af7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 21189,
"upload_time": "2024-08-12T23:34:02",
"upload_time_iso_8601": "2024-08-12T23:34:02.782335Z",
"url": "https://files.pythonhosted.org/packages/2b/1e/52d668adfad8c27fd9fb7198855dedec791874b0312dfbcaf621dd246eaa/pytest_docker_apache_fixtures-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-12 23:34:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "crashvb",
"github_project": "pytest-docker-apache-fixtures",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pytest-docker-apache-fixtures"
}
JSON
