refactor: Auto-generate version file at packing (#13)

This commit removes the version file generation
job step from the release workflow, removes
the version file generation utilities from the
integration tests, and modifies charmcraft.yaml
so that the version file will be automatically
generated when the slurmrestd charm is packed.

Signed-off-by: Jason C. Nucciarone <[email protected]>

.github/workflows/release.yaml

@@ -31,8 +31,6 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Create version file
-        run: git describe --tags --always --dirty > version
       - name: Select charmhub channel
         uses: canonical/charming-actions/[email protected]
         id: channel

charmcraft.yaml

@@ -1,3 +1,6 @@
+# Copyright 2020 Omnivector Solutions, LLC.
+# See LICENSE file for licensing details.
+
 type: charm
 bases:
   - build-on:
@@ -13,7 +16,22 @@ bases:
       - name: centos
         channel: "7"
         architectures: [amd64]
+
 parts:
   charm:
     build-packages: [git]
     charm-python-packages: [setuptools]
+
+  # Create a version file and pack it into the charm. This is dynamically generated
+  # as part of the build process for a charm to ensure that the git revision of the
+  # charm is always recorded in this version file.
+  version-file:
+    plugin: nil
+    build-packages:
+      - git
+    override-build: |
+      VERSION=$(git -C $CRAFT_PART_SRC/../../charm/src describe --dirty --always)
+      echo "Setting version to $VERSION"
+      echo $VERSION > $CRAFT_PART_INSTALL/version
+    stage:
+      - version

tests/integration/conftest.py

@@ -19,7 +19,7 @@
 
 import pytest
 from _pytest.config.argparsing import Parser
-from helpers import ETCD, NHC, VERSION
+from helpers import ETCD, NHC
 from pytest_operator.plugin import OpsTest
 
 
@@ -46,4 +46,3 @@ def pytest_sessionfinish(session, exitstatus) -> None:
     """Clean up repository after test session has completed."""
     pathlib.Path(ETCD).unlink(missing_ok=True)
     pathlib.Path(NHC).unlink(missing_ok=True)
-    pathlib.Path(VERSION).unlink(missing_ok=True)

tests/integration/helpers.py

@@ -16,8 +16,6 @@
 
 import logging
 import pathlib
-import shlex
-import subprocess
 from typing import Dict
 from urllib import request
 
@@ -27,17 +25,10 @@
 ETCD_URL = f"https://github.com/etcd-io/etcd/releases/download/v3.5.0/{ETCD}"
 NHC = "lbnl-nhc-1.4.3.tar.gz"
 NHC_URL = f"https://github.com/mej/nhc/releases/download/1.4.3/{NHC}"
-VERSION = "version"
-VERSION_NUM = subprocess.run(
-    shlex.split("git describe --always"), stdout=subprocess.PIPE, text=True
-).stdout.strip("\n")
 
 
 def get_slurmctld_res() -> Dict[str, pathlib.Path]:
     """Get slurmctld resources needed for charm deployment."""
-    if not (version := pathlib.Path(VERSION)).exists():
-        logger.info(f"Setting resource {VERSION} to value {VERSION_NUM}")
-        version.write_text(VERSION_NUM)
     if not (etcd := pathlib.Path(ETCD)).exists():
         logger.info(f"Getting resource {ETCD} from {ETCD_URL}")
         request.urlretrieve(ETCD_URL, etcd)