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.

Sign up for GitHub

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

Jump to bottom

parametrize peer relation name for vault backend storage #97

Merged
merged 1 commit into from
Jun 14, 2024
Merged

parametrize peer relation name for vault backend storage #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 8 additions & 3 deletions lib/charms/observability_libs/v1/cert_handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,7 @@ def __init__(
*,
key: str,
certificates_relation_name: str = "certificates",
peer_relation_name: str = "peers",
cert_subject: Optional[str] = None,
sans: Optional[List[str]] = None,
):
Expand All @@ -285,7 +286,11 @@ def __init__(
charm: The owning charm.
key: A manually-crafted, static, unique identifier used by ops to identify events.
It shouldn't change between one event to another.
certificates_relation_name: Must match metadata.yaml.
certificates_relation_name: Name of the certificates relation over which we obtain TLS certificates.
Must match metadata.yaml.
peer_relation_name: Name of a peer relation used to store our secrets.
Only used on older Juju versions where secrets are not supported.
Must match metadata.yaml.
cert_subject: Custom subject. Name collisions are under the caller's responsibility.
sans: DNS names. If none are given, use FQDN.
"""
Expand All @@ -309,7 +314,7 @@ def __init__(
# self.framework.observe(self.charm.on.secret_remove, self._rotate_csr)

else:
vault_backend = _RelationVaultBackend(charm, relation_name="peers")
vault_backend = _RelationVaultBackend(charm, relation_name=peer_relation_name)
self.vault = Vault(vault_backend)

self.certificates_relation_name = certificates_relation_name
Expand Down Expand Up @@ -514,7 +519,7 @@ def _csr(self) -> Optional[str]:
# ignoring all but the last one.
if len(csrs) > 1:
logger.warning(
"Multiple CSRs found in `certificates` relation. "
f"Multiple CSRs found in {self.certificates_relation_name!r} relation. "
"cert_handler is not ready to expect it."
)

Expand Down
31 changes: 30 additions & 1 deletion tests/scenario/test_cert_handler/test_cert_handler_v1.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

import pytest
from ops import CharmBase
from scenario import Context, Relation, State
from scenario import Context, PeerRelation, Relation, State

from lib.charms.observability_libs.v1.cert_handler import (
CertHandler,
Expand Down Expand Up @@ -43,3 +43,32 @@ def test_cert_joins(ctx, certificates, leader):
) as mgr:
mgr.run()
assert mgr.charm.ch.private_key


class MyJuju2Charm(CharmBase):
META = {
"name": "fabio",
"requires": {"certificates": {"interface": "certificates"}},
"peers": {"myfunkypeers": {"interface": "peerymcpeer"}},
}

def __init__(self, fw):
super().__init__(fw)
self.ch = CertHandler(
self, key="ch", sans=[socket.getfqdn()], peer_relation_name="myfunkypeers"
)


@pytest.fixture
def ctx_juju2():
return Context(MyJuju2Charm, MyJuju2Charm.META, juju_version="2.0")


@pytest.mark.parametrize("leader", (True, False))
def test_cert_joins_peer_vault_backend(ctx_juju2, certificates, leader):
with ctx_juju2.manager(
certificates.joined_event,
State(leader=leader, relations=[certificates, PeerRelation("myfunkypeers")], secrets=[]),
) as mgr:
mgr.run()
assert mgr.charm.ch.private_key
Loading