From c2e05facdb446202d1b1ca8cf0cf32ece9727eb1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ren=C3=A9=20Radoi?= <rene.radoi@canonical.com>
Date: Fri, 29 Nov 2024 16:27:11 +0100
Subject: [PATCH] Switch to charmed-etcd snap and publish to Charmhub (#7)

With this PR, we use revision 1 of the `charmed-etcd` snap instead of
legacy `etcd` snap. Furthermore the PR enables the release-workflow for
publishing to Charmhub `3.5/edge` on pushes to main.
---
 .github/workflows/release.yaml    | 26 +++++++++++++-------------
 src/common/client.py              |  4 +++-
 src/literals.py                   |  6 +++---
 src/managers/config/etcd.conf.yml |  1 +
 tests/integration/helpers.py      |  8 ++++----
 5 files changed, 24 insertions(+), 21 deletions(-)

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
index 6960956..73ce7ab 100644
--- a/.github/workflows/release.yaml
+++ b/.github/workflows/release.yaml
@@ -39,16 +39,16 @@ jobs:
     name: Build charm
     uses: canonical/data-platform-workflows/.github/workflows/build_charm.yaml@v23.0.4
 
-#  release:
-#    name: Release charm
-#    needs:
-#      - ci-tests
-#      - build
-#    uses: canonical/data-platform-workflows/.github/workflows/release_charm.yaml@v23.0.4
-#    with:
-#      channel: 3.5/edge
-#      artifact-prefix: ${{ needs.build.outputs.artifact-prefix }}
-#    secrets:
-#      charmhub-token: ${{ secrets.CHARMHUB_TOKEN }}
-#    permissions:
-#      contents: write  # Needed to create GitHub release
\ No newline at end of file
+  release:
+    name: Release charm
+    needs:
+      - ci-tests
+      - build
+    uses: canonical/data-platform-workflows/.github/workflows/release_charm.yaml@v23.0.4
+    with:
+      channel: 3.5/edge
+      artifact-prefix: ${{ needs.build.outputs.artifact-prefix }}
+    secrets:
+      charmhub-token: ${{ secrets.CHARMHUB_TOKEN }}
+    permissions:
+      contents: write  # Needed to create GitHub release
\ No newline at end of file
diff --git a/src/common/client.py b/src/common/client.py
index 0e460a3..48ea3d6 100644
--- a/src/common/client.py
+++ b/src/common/client.py
@@ -8,6 +8,8 @@
 import logging
 import subprocess
 
+from literals import SNAP_NAME
+
 logger = logging.getLogger(__name__)
 
 
@@ -62,7 +64,7 @@ def _run_etcdctl(
         try:
             result = subprocess.run(
                 args=[
-                    "etcdctl",
+                    f"{SNAP_NAME}.etcdctl",
                     command,
                     subcommand,
                     f"--endpoints={endpoints}",
diff --git a/src/literals.py b/src/literals.py
index eb18142..69cf8d3 100644
--- a/src/literals.py
+++ b/src/literals.py
@@ -10,12 +10,12 @@
 
 from ops.model import ActiveStatus, BlockedStatus, MaintenanceStatus, StatusBase
 
-SNAP_NAME = "etcd"
-SNAP_REVISION = 233
+SNAP_NAME = "charmed-etcd"
+SNAP_REVISION = 1
 SNAP_SERVICE = "etcd"
 # this path will be updated when we switch to charmed-etcd snap
 # it's the current config path for the legacy-etcd snap
-CONFIG_FILE = "/var/snap/etcd/common/etcd.conf.yml"
+CONFIG_FILE = "/var/snap/charmed-etcd/current/etcd.conf.yml"
 
 PEER_RELATION = "etcd-peers"
 CLIENT_PORT = 2379
diff --git a/src/managers/config/etcd.conf.yml b/src/managers/config/etcd.conf.yml
index c31fa93..fdafbc5 100644
--- a/src/managers/config/etcd.conf.yml
+++ b/src/managers/config/etcd.conf.yml
@@ -1,3 +1,4 @@
+data-dir: "/var/snap/charmed-etcd/common/var/lib/etcd"
 initial-cluster-token: 'etcd-cluster'
 snapshot-count: 10000
 heartbeat-interval: 100
diff --git a/tests/integration/helpers.py b/tests/integration/helpers.py
index aacea47..80a5184 100644
--- a/tests/integration/helpers.py
+++ b/tests/integration/helpers.py
@@ -10,7 +10,7 @@
 import yaml
 from pytest_operator.plugin import OpsTest
 
-from literals import CLIENT_PORT
+from literals import CLIENT_PORT, SNAP_NAME
 
 logger = logging.getLogger(__name__)
 
@@ -20,7 +20,7 @@
 
 def put_key(model: str, unit: str, endpoints: str, key: str, value: str) -> str:
     """Write data to etcd using `etcdctl` via `juju ssh`."""
-    etcd_command = f"etcdctl put {key} {value} --endpoints={endpoints}"
+    etcd_command = f"{SNAP_NAME}.etcdctl put {key} {value} --endpoints={endpoints}"
     juju_command = f"juju ssh --model={model} {unit} {etcd_command}"
 
     return subprocess.getoutput(juju_command).split("\n")[0]
@@ -28,7 +28,7 @@ def put_key(model: str, unit: str, endpoints: str, key: str, value: str) -> str:
 
 def get_key(model: str, unit: str, endpoints: str, key: str) -> str:
     """Read data from etcd using `etcdctl` via `juju ssh`."""
-    etcd_command = f"etcdctl get {key} --endpoints={endpoints}"
+    etcd_command = f"{SNAP_NAME}.etcdctl get {key} --endpoints={endpoints}"
     juju_command = f"juju ssh --model={model} {unit} {etcd_command}"
 
     return subprocess.getoutput(juju_command).split("\n")[1]
@@ -36,7 +36,7 @@ def get_key(model: str, unit: str, endpoints: str, key: str) -> str:
 
 def get_cluster_members(model: str, unit: str, endpoints: str) -> list[dict]:
     """Query all cluster members from etcd using `etcdctl` via `juju ssh`."""
-    etcd_command = f"etcdctl member list --endpoints={endpoints} -w=json"
+    etcd_command = f"{SNAP_NAME}.etcdctl member list --endpoints={endpoints} -w=json"
     juju_command = f"juju ssh --model={model} {unit} {etcd_command}"
 
     result = subprocess.getoutput(juju_command).split("\n")[0]