Skip to content

Commit

Permalink
Prefix fixtures to prevent conflicts until pytest-dev/pytest#3966 is …
Browse files Browse the repository at this point in the history 
…resolved.
  • Loading branch information
@crashvb
crashvb committed Feb 9, 2022
1 parent a6c3fca commit e3a96ae
Show file tree
Hide file tree
Showing 4 changed files with 600 additions and 621 deletions.
153 changes: 76 additions & 77 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

Pytest fixtures to instantiate and populated local docker GIT SCMs, using [lovely-pytest-docker](https://pypi.org/project/lovely-pytest-docker), for testing.
Pytest fixtures to instantiate and populated local GIT SCMs, using [lovely-pytest-docker](https://pypi.org/project/lovely-pytest-docker), for testing.

## Getting Started

Expand All @@ -21,12 +21,12 @@ All fixtures should be automatically included via the <tt>pytest11</tt> entry po
import pytest
import subprocess
from pathlib import Path
from pytest_docker_git_fixtures import DockerGITInsecure, DockerGITSecure # Optional, for typing
from pytest_git_fixtures import GITInsecure, GITSecure # Optional, for typing

@pytest.mark.create_repo("test_docker_git_secure")
@pytest.mark.create_repo("test_git_secure")
@pytest.mark.mirror_repo("https://github.com/crashvb/shim-bind.git")
def test_docker_git_secure(docker_git_secure: DockerGITSecure, tmp_path: Path):
uri = f"https://{docker_git_secure.endpoint}/secure/shim-bind.git"
def test_git_secure(git_secure: GITSecure, tmp_path: Path):
uri = f"https://{git_secure.endpoint}/secure/shim-bind.git"
path = tmp_path.join("local-clone")
subprocess.run(
["git", "clone", uri, str(path)],
Expand All @@ -36,9 +36,9 @@ def test_docker_git_secure(docker_git_secure: DockerGITSecure, tmp_path: Path):
)
assert path.joinpath("README.md").exists()

@pytest.mark.create_repo("test_docker_git_insecure")
def test_docker_git_insecure(docker_git_insecure: DockerGITInsecure, tmp_path: Path):
uri = f"https://{docker_git_insecure.endpoint}/insecure/test_docker_git_insecure.git"
@pytest.mark.create_repo("test_git_insecure")
def test_git_insecure(git_insecure: GITInsecure, tmp_path: Path):
uri = f"https://{git_insecure.endpoint}/insecure/test_git_insecure.git"
path = tmp_path.join("local-clone")
subprocess.run(
["git", "clone", uri, str(path)],
Expand All @@ -58,7 +58,7 @@ The `create_repo` and `mirror_repo` marks can optionally be added to stage repos
### From [pypi.org](https://pypi.org/project/pytest-docker-git-fixtures/)

```
$ pip install pytest_docker_git_fixtures
$ pip install pytest_git_fixtures
```

### From source code
Expand All @@ -73,25 +73,17 @@ $ python -m pip install --editable .[dev]

## <a name="fixtures"></a>Fixtures

### <a name="docker_compose_insecure"></a> docker_compose_insecure
### <a name="git_auth_header"></a> git_auth_header

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-git-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 docker GIT service.
Retrieves an HTTP basic authentication header that is populated with credentials that can access the secure GIT service. The credentials are retrieved from the [git_password](#git_password) and [git_username](#git_username) fixtures.

### <a name="docker_compose_secure"></a> docker_compose_secure
### <a name="git_cacerts"></a> git_cacerts

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-git-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 docker GIT service; however, unlike the configuration returned by the [docker_compose_insecure](#docker_compose_insecure) fixture, this configuration will be treated as a template; the <tt>$PATH_CERTIFICATE</tt>, <tt>$PATH_HTPASSWD</tt>, and <tt>$PATH_KEY</tt> tokens will be populated with the absolute paths provided by the [docker_git_certs](#docker_git_certs) and [docker_git_htpasswd](#docker_git_htpasswd) fixtures, as appropriate.
Locates a user-defined CA trust store (<tt>tests/cacerts</tt>) to use to verify connections to the secure GIT service. If one cannot be located, a temporary trust store is created containing certificates from <tt>certifi</tt> and the [git_certs](#git_certs) fixture. This fixture is used to instantiate the secure GIT service.

### <a name="docker_git_auth_header"></a> docker_git_auth_header
### <a name="git_certs"></a> git_certs

Retrieves an HTTP basic authentication header that is populated with credentials that can access the secure docker GIT service. The credentials are retrieved from the [docker_git_password](#docker_git_password) and [docker_git_username](#docker_git_username) fixtures.

### <a name="docker_git_cacerts"></a> docker_git_cacerts

Locates a user-defined CA trust store (<tt>tests/cacerts</tt>) to use to verify connections to the secure docker GIT service. If one cannot be located, a temporary trust store is created containing certificates from <tt>certifi</tt> and the [docker_git_certs](#docker_git_certs) fixture. This fixture is used to instantiate the secure docker GIT service.

### <a name="docker_git_certs"></a> docker_git_certs

Returns the paths of the self-signed certificate authority certificate, certificate, and private key that are used by the secure docker GIT service. This fixture is used to instantiate the secure docker GIT service.
Returns the paths of the self-signed certificate authority certificate, certificate, and private key that are used by the secure GIT service. This fixture is used to instantiate the secure GIT service.

#### NamedTuple Fields

Expand All @@ -102,25 +94,25 @@ The following fields are defined in the tuple provided by this fixture:
* **certificate** - Path to the certificate.
* **private_key** - Path to the private key.

Typing is provided by `pytest_docker_git_fixtures.DockerGITCerts`.
Typing is provided by `pytest_git_fixtures.GITCerts`.

### <a name="docker_git_hwpasswd"></a> docker_git_htpasswd
### <a name="git_hwpasswd"></a> git_htpasswd

Provides the path to a htpasswd file that is used by the secure docker GIT 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 [docker_git_password](#docker_git_password) and [docker_git_username](#docker_git_username) fixtures. This fixture is used to instantiate the secure docker GIT service.
Provides the path to a htpasswd file that is used by the secure GIT 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 [git_password](#git_password) and [git_username](#git_username) fixtures. This fixture is used to instantiate the secure GIT service.

### <a name="docker_git_insecure"></a> docker_git_insecure
### <a name="git_insecure"></a> git_insecure

Configures and instantiates a docker GIT without TLS or authentication.
Configures and instantiates a GIT without TLS or authentication.

```python
import pytest
import subprocess
from pathlib import Path
from pytest_docker_git_fixtures import DockerGITInsecure # Optional, for typing
from pytest_git_fixtures import GITInsecure # Optional, for typing

@pytest.mark.create_repo("test_docker_git_insecure")
def test_docker_git_insecure(docker_git_insecure: DockerGITInsecure, tmp_path: Path):
uri = f"https://{docker_git_insecure.endpoint}/insecure/test_docker_git_insecure.git"
@pytest.mark.create_repo("test_git_insecure")
def test_git_insecure(git_insecure: GITInsecure, tmp_path: Path):
uri = f"https://{git_insecure.endpoint}/insecure/test_git_insecure.git"
path = tmp_path.join("local-clone")
subprocess.run(
["git", "clone", uri, str(path)],
Expand All @@ -137,29 +129,29 @@ The following fields are defined in the tuple provided by this fixture:

* **created_repos** - The list of created repositories.
* **docker_compose** - Path to the fully instantiated docker-compose configuration.
* **endpoint** - Endpoint of the insecure docker GIT service.
* **endpoint** - Endpoint of the insecure GIT service.
* **mirrored_repos** - The list of mirrored repositories.
* **service_name** - Name of the service within the docker-compose configuration.

Typing is provided by `pytest_docker_git_fixtures.DockerGITInsecure`.
Typing is provided by `pytest_git_fixtures.GITInsecure`.

### <a name="docker_git_password"></a> docker_git_password
### <a name="git_password"></a> git_password

Provides a generated password to use for authentication to the secure docker GIT service.
Provides a generated password to use for authentication to the secure GIT service.

### <a name="docker_git_secure"></a> docker_git_secure
### <a name="git_secure"></a> git_secure

Configures and instantiates a TLS enabled docker GIT with HTTP basic authorization.
Configures and instantiates a TLS enabled GIT with HTTP basic authorization.

```python
import pytest
import subprocess
from pathlib import Path
from pytest_docker_git_fixtures import DockerGITSecure # Optional, for typing
from pytest_git_fixtures import GITSecure # Optional, for typing

@pytest.mark.mirror_repo("https://github.com/crashvb/shim-bind.git")
def test_docker_git_secure(docker_git_secure: DockerGITSecure, tmp_path: Path):
uri = f"https://{docker_git_secure.endpoint}/secure/shim-bind.git"
def test_git_secure(git_secure: GITSecure, tmp_path: Path):
uri = f"https://{git_secure.endpoint}/secure/shim-bind.git"
path = tmp_path.join("local-clone")
subprocess.run(
["git", "clone", uri, str(path)],
Expand All @@ -174,43 +166,50 @@ def test_docker_git_secure(docker_git_secure: DockerGITSecure, tmp_path: Path):

The following fields are defined in the tuple provided by this fixture:

* **auth_header** - from [docker_git_auth_header](#docker_git_auth_header).
* **cacerts** - from [docker_git_cacerts](#docker_git_cacerts).
* **certs** - from [docker_git_certs](#docker_git_certs).
* **auth_header** - from [git_auth_header](#git_auth_header).
* **cacerts** - from [git_cacerts](#git_cacerts).
* **certs** - from [git_certs](#git_certs).
* **created_repos** - The list of created repositories.
* **docker_compose** - Path to the fully instantiated docker-compose configuration.
* **endpoint** - Endpoint of the secure docker GIT service.
* **htpasswd** - from [docker_git_htpasswd](#docker_git_htpasswd)
* **endpoint** - Endpoint of the secure GIT service.
* **htpasswd** - from [git_htpasswd](#git_htpasswd)
* **mirrored_repos** - The list of mirrored repositories.
* **password** - from [docker_git_password](#docker_git_password).
* **password** - from [git_password](#git_password).
* **service_name** - Name of the service within the docker-compose configuration.
* **ssl_context** - from [docker_git_ssl_context](#docker_git_ssl_context).
* **username** - from [docker_git_username](#docker_git_username).
* **ssl_context** - from [git_ssl_context](#git_ssl_context).
* **username** - from [git_username](#git_username).

Typing is provided by `pytest_git_fixtures.GITSecure`.

### <a name="git_ssl_context"></a> git_ssl_context

Provides an SSL context containing the CA trust store from the [git_cacerts](#git_cacerts) fixture.

Typing is provided by `pytest_docker_git_fixtures.DockerGITSecure`.
### <a name="git_username"></a> git_username

### <a name="docker_git_ssl_context"></a> docker_git_ssl_context
Provides a generated username to use for authentication to the secure GIT service.

Provides an SSL context containing the CA trust store from the [docker_git_cacerts](#docker_git_cacerts) fixture.
### <a name="pdgf_docker_compose_insecure"></a> pdgf_docker_compose_insecure

### <a name="docker_git_username"></a> docker_git_username
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-git-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 GIT service.

Provides a generated username to use for authentication to the secure docker GIT service.
### <a name="pdgf_docker_compose_secure"></a> 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-git-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 GIT service; however, unlike the configuration returned by the [pdgf_docker_compose_insecure](#pdgf_docker_compose_insecure) fixture, this configuration will be treated as a template; the <tt>$PATH_CERTIFICATE</tt>, <tt>$PATH_HTPASSWD</tt>, and <tt>$PATH_KEY</tt> tokens will be populated with the absolute paths provided by the [git_certs](#git_certs) and [git_htpasswd](#git_htpasswd) fixtures, as appropriate.
## <a name="markers"></a>Markers

### pytest.mark.create_repo

This marker specifies the GIT repository(ies) that should be initialized within the docker GIT service(s) prior to testing. It can ...
This marker specifies the GIT repository(ies) that should be initialized within the GIT service(s) prior to testing. It can ...

... decorate individual tests:

```python
import pytest
from pytest_docker_git_fixtures import DockerGITSecure # Optional, for typing
from pytest_git_fixtures import GITSecure # Optional, for typing

@pytest.mark.create_repo("test_docker_git_secure")
def test_docker_git_secure(docker_git_secure: DockerGITSecure):
@pytest.mark.create_repo("test_git_secure")
def test_git_secure(git_secure: GITSecure):
...
```

Expand Down Expand Up @@ -238,64 +237,64 @@ A helper function, `get_created_repos`, is included for test scenarios that wis

```python
import pytest
from pytest_docker_git_fixtures import DockerGITSecure, get_created_repos
from pytest_git_fixtures import GITSecure, get_created_repos

@pytest.mark.create_repo("test_docker_git_secure")
def test_docker_git_secure(docker_git_secure: DockerGITSecure, request):
@pytest.mark.create_repo("test_git_secure")
def test_git_secure(git_secure: GITSecure, request):
name = get_created_repos(request)[0]
```

### pytest.mark.mirror_repo

Similarly to create_repo, this marker specifies the GIT repository(ies) that should be replicated to the docker GIT service(s) prior to testing.
Similarly to create_repo, this marker specifies the GIT repository(ies) that should be replicated to the GIT service(s) prior to testing.

Likewise, there is a `get_mirrored_repos` helper function.

## <a name="enumerated_fixtures"></a>Enumerated Fixtures

It is possible to instantiate multiple GIT instances using the corresponding enumerated fixtures. All [fixtures](#fixtures) listed above have _*_list_ (e.g. `docker_git_secure` -> `docker_git_secure_list`) versions that will return enumerated lists of corresponding data type.
It is possible to instantiate multiple GIT instances using the corresponding enumerated fixtures. All [fixtures](#fixtures) listed above have _*_list_ (e.g. `git_secure` -> `git_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_git_fixtures import DockerGITSecure # Optional, for typing
from pytest_git_fixtures import GITSecure # Optional, for typing

def test_docker_git_secure_list(docker_git_secure_list: List[DockerGITSecure]):
for docker_git_secure in docker_git_secure_list:
def test_git_secure_list(git_secure_list: List[GITSecure]):
for git_secure in git_secure_list:
# Default listener ...
response = requests.get(
f"https://{docker_git_secure.endpoint}/",
headers=docker_git_secure.auth_header,
verify=str(docker_git_secure.cacerts),
f"https://{git_secure.endpoint}/",
headers=git_secure.auth_header,
verify=str(git_secure.cacerts),
)
assert response.status_code == 200
assert response.content == b"pytest-docker-git-fixtures-docker\n"
```

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. docker_git_secure == docker_git_secure_list[0]). To avoid complications with lower layers, mainly docker-compose, and to allow for this interchangeability, caching is used internally.
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. git_secure == git_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 `pdrf_scale_factor` fixture, as follows:
By default, the scale factor of the enumerated instances is set to one (n=1). This value can be changed by overriding the `pdgf_scale_factor` fixture, as follows:

```python
import pytest

@pytest.fixture(scope="session")
def pdrf_scale_factor() -> int:
def pdgf_scale_factor() -> int:
return 4
```

This fixture will be used to scale both the insecure and secure docker GIT SCMs.
This fixture will be used to scale both the insecure and secure GIT SCMs.

## <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. The `create_repo`, and `mirror_repo` markers are processed as part of the `docker_git_insecure` and `docker_git_secure` fixtures. As such:
2. The `create_repo`, and `mirror_repo` markers are processed as part of the `git_insecure` and `git_secure` fixtures. As such:
* _all_ markers will be aggregated during initialization of the session, and processed prior test execution.
* Initialized and mirror repositories will be applied to both the insecure and secure docker GIT SCMs, if both are instantiated.
3. At most 10 insecure and 10 secure docker GIT SCMs are supported using the embedded docker compose.
4. It is not currently possible to specify into which enumerated SCM instances repositories should be applied. As such, and for backwards compatibility, they will only be applied into the first instance of each of the insecure and secure docker GIT SCMs.
* Initialized and mirror repositories will be applied to both the insecure and secure GIT SCMs, if both are instantiated.
3. At most 10 insecure and 10 secure GIT SCMs are supported using the embedded docker compose.
4. It is not currently possible to specify into which enumerated SCM instances repositories should be applied. As such, and for backwards compatibility, they will only be applied into the first instance of each of the insecure and secure GIT SCMs.

## Development

Expand Down
Loading

0 comments on commit e3a96ae

Please sign in to comment.