Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish traefik_route v0 library #403

Merged
merged 3 commits into from
Sep 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

```shell
cd some-charm
charmcraft fetch-lib charms.traefik_route_k8s.v0.traefik_route
charmcraft fetch-lib charms.traefik_k8s.v0.traefik_route
```

To use the library from the provider side (Traefik):
Expand All @@ -28,7 +28,7 @@
```

```python
from charms.traefik_route_k8s.v0.traefik_route import TraefikRouteProvider
from charms.traefik_k8s.v0.traefik_route import TraefikRouteProvider

class TraefikCharm(CharmBase):
def __init__(self, *args):
Expand Down Expand Up @@ -56,7 +56,7 @@ def _handle_traefik_route_ready(self, event):

```python
# ...
from charms.traefik_route_k8s.v0.traefik_route import TraefikRouteRequirer
from charms.traefik_k8s.v0.traefik_route import TraefikRouteRequirer

class TraefikRouteCharm(CharmBase):
def __init__(self, *args):
Expand Down Expand Up @@ -88,7 +88,7 @@ def __init__(self, *args):

# Increment this PATCH version before using `charmcraft publish-lib` or reset
# to 0 if you are raising the major API version
LIBPATCH = 10
LIBPATCH = 1

log = logging.getLogger(__name__)

Expand Down Expand Up @@ -254,8 +254,10 @@ def is_ready(self, relation: Relation) -> bool:

def get_config(self, relation: Relation) -> Optional[str]:
"""Renamed to ``get_dynamic_config``."""
log.warning("``TraefikRouteProvider.get_config`` is deprecated. "
"Use ``TraefikRouteProvider.get_dynamic_config`` instead")
log.warning(
"``TraefikRouteProvider.get_config`` is deprecated. "
"Use ``TraefikRouteProvider.get_dynamic_config`` instead"
)
return self.get_dynamic_config(relation)

def get_dynamic_config(self, relation: Relation) -> Optional[str]:
Expand Down Expand Up @@ -356,7 +358,7 @@ def is_ready(self) -> bool:
"""Is the TraefikRouteRequirer ready to submit data to Traefik?"""
return self._relation is not None

def submit_to_traefik(self, config: dict, static: dict=None):
def submit_to_traefik(self, config: dict, static: Optional[dict] = None):
"""Relay an ingress configuration data structure to traefik.

This will publish to the traefik-route relation databag
Expand Down
8 changes: 4 additions & 4 deletions src/charm.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,16 @@
from charms.prometheus_k8s.v0.prometheus_scrape import MetricsEndpointProvider
from charms.tempo_k8s.v1.charm_tracing import trace_charm
from charms.tempo_k8s.v2.tracing import TracingEndpointRequirer
from charms.traefik_k8s.v0.traefik_route import (
TraefikRouteProvider,
TraefikRouteRequirerReadyEvent,
)
from charms.traefik_k8s.v1.ingress import IngressPerAppProvider as IPAv1
from charms.traefik_k8s.v1.ingress_per_unit import (
DataValidationError,
IngressPerUnitProvider,
)
from charms.traefik_k8s.v2.ingress import IngressPerAppProvider as IPAv2
from charms.traefik_route_k8s.v0.traefik_route import (
TraefikRouteProvider,
TraefikRouteRequirerReadyEvent,
)
from deepmerge import always_merger
from lightkube.core.client import Client
from lightkube.core.exceptions import ApiError
Expand Down
67 changes: 56 additions & 11 deletions tests/integration/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ def copy_traefik_library_into_tester_charms(ops_test):
"traefik_k8s/v2/ingress.py",
"traefik_k8s/v1/ingress_per_unit.py",
"observability_libs/v1/kubernetes_service_patch.py",
"traefik_route_k8s/v0/traefik_route.py",
"traefik_k8s/v0/traefik_route.py",
]
for tester in ["forward-auth", "ipa", "ipu", "tcp", "route"]:
for lib in libraries:
Expand Down Expand Up @@ -101,40 +101,85 @@ async def traefik_charm(ops_test):
@timed_memoizer
async def forward_auth_tester_charm(ops_test):
charm_path = (Path(__file__).parent / "testers" / "forward-auth").absolute()
charm = await ops_test.build_charm(charm_path, verbosity="debug")
return charm
count = 0
while True:
try:
charm = await ops_test.build_charm(charm_path, verbosity="debug")
return charm
except RuntimeError:
logger.warning("Failed to build forward auth tester. Trying again!")
count += 1

if count == 3:
raise


@pytest.fixture(scope="module")
@timed_memoizer
async def ipa_tester_charm(ops_test):
charm_path = (Path(__file__).parent / "testers" / "ipa").absolute()
charm = await ops_test.build_charm(charm_path, verbosity="debug")
return charm
count = 0
while True:
try:
charm = await ops_test.build_charm(charm_path, verbosity="debug")
return charm
except RuntimeError:
logger.warning("Failed to build ipa tester. Trying again!")
count += 1

if count == 3:
raise


@pytest.fixture(scope="module")
@timed_memoizer
async def ipu_tester_charm(ops_test):
charm_path = (Path(__file__).parent / "testers" / "ipu").absolute()
charm = await ops_test.build_charm(charm_path, verbosity="debug")
return charm
count = 0
while True:
try:
charm = await ops_test.build_charm(charm_path, verbosity="debug")
return charm
except RuntimeError:
logger.warning("Failed to build ipu tester. Trying again!")
count += 1

if count == 3:
raise


@pytest.fixture(scope="module")
@timed_memoizer
async def tcp_tester_charm(ops_test):
charm_path = (Path(__file__).parent / "testers" / "tcp").absolute()
charm = await ops_test.build_charm(charm_path, verbosity="debug")
return charm
count = 0
while True:
try:
charm = await ops_test.build_charm(charm_path, verbosity="debug")
return charm
except RuntimeError:
logger.warning("Failed to build tcp tester. Trying again!")
count += 1

if count == 3:
raise


@pytest.fixture(scope="module")
@timed_memoizer
async def route_tester_charm(ops_test):
charm_path = (Path(__file__).parent / "testers" / "route").absolute()
charm = await ops_test.build_charm(charm_path, verbosity="debug")
return charm
count = 0
while True:
try:
charm = await ops_test.build_charm(charm_path, verbosity="debug")
return charm
except RuntimeError:
logger.warning("Failed to build route tester. Trying again!")
count += 1

if count == 3:
raise


@pytest.fixture(scope="module")
Expand Down
4 changes: 1 addition & 3 deletions tests/integration/spellbook/build_all_caches.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,7 @@ def main():
spellbook_fetch(
charm_name="route-tester",
charm_root=testers_root / "route",
pull_libs=[
traefik_root / "lib" / "charms" / "traefik_route_k8s" / "v0" / "traefik_route.py"
],
pull_libs=[traefik_root / "lib" / "charms" / "traefik_k8s" / "v0" / "traefik_route.py"],
)
spellbook_fetch(
charm_name="ipa-tester",
Expand Down
1 change: 1 addition & 0 deletions tests/integration/testers/forward-auth/charmcraft.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ parts:
charm-binary-python-packages:
- jsonschema
- ops
- pydantic-core
build-packages:
- git
1 change: 1 addition & 0 deletions tests/integration/testers/ipa/charmcraft.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ parts:
charm:
charm-binary-python-packages:
- ops
- pydantic-core
build-packages:
- git
1 change: 1 addition & 0 deletions tests/integration/testers/ipu/charmcraft.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ parts:
charm:
charm-binary-python-packages:
- ops
- pydantic-core
build-packages:
- git
1 change: 1 addition & 0 deletions tests/integration/testers/route/charmcraft.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ parts:
charm:
charm-binary-python-packages:
- ops
- pydantic-core
build-packages:
- git
2 changes: 1 addition & 1 deletion tests/integration/testers/route/src/charm.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python3
# Copyright 2022 Canonical Ltd.
# See LICENSE file for licensing details.
from charms.traefik_route_k8s.v0.traefik_route import TraefikRouteRequirer
from charms.traefik_k8s.v0.traefik_route import TraefikRouteRequirer
from ops.charm import CharmBase
from ops.model import ActiveStatus

Expand Down
1 change: 1 addition & 0 deletions tests/integration/testers/tcp/charmcraft.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ parts:
charm-binary-python-packages:
- ops
- lightkube
- pydantic-core
build-packages:
- git
Loading