fix: unblock stale La Suite Docs canonical #50
@@ -126,6 +126,25 @@ def recipe_checkout(recipe: str, version: str) -> None:
|
|||||||
subprocess.run(["git", "-C", path, "checkout", "-f", "--quiet", version], check=True)
|
subprocess.run(["git", "-C", path, "checkout", "-f", "--quiet", version], check=True)
|
||||||
|
|
||||||
|
|
||||||
|
def ensure_secret_versions_from_recipe(recipe: str, domain: str) -> None:
|
||||||
|
"""Fill missing secret versions after a pinned checkout.
|
||||||
|
|
||||||
|
`app new <recipe> <version>` creates its .env from whichever recipe tree was
|
||||||
|
checked out *before* it pins the version. A removed secret in the current
|
||||||
|
recipe can therefore be missing from the older base's .env. Keep existing
|
||||||
|
assignments, including versions intentionally changed by install hooks.
|
||||||
|
"""
|
||||||
|
sample = os.path.join(recipe_dir(recipe), ".env.sample")
|
||||||
|
if not os.path.isfile(sample):
|
||||||
|
return
|
||||||
|
pattern = re.compile(r"^\s*(SECRET_[A-Z0-9_]+_VERSION)=(v[A-Za-z0-9._-]+)")
|
||||||
|
with open(sample) as fh:
|
||||||
|
for line in fh:
|
||||||
|
match = pattern.match(line)
|
||||||
|
if match and env_get(domain, match.group(1)) is None:
|
||||||
|
env_set(domain, match.group(1), match.group(2))
|
||||||
|
|
||||||
|
|
||||||
def has_lightweight_version_tags(recipe: str) -> bool:
|
def has_lightweight_version_tags(recipe: str) -> bool:
|
||||||
"""True if the recipe's local checkout has any LIGHTWEIGHT (non-annotated) version tag.
|
"""True if the recipe's local checkout has any LIGHTWEIGHT (non-annotated) version tag.
|
||||||
|
|
||||||
|
|||||||
@@ -444,6 +444,7 @@ def deploy_app(
|
|||||||
)
|
)
|
||||||
elif version:
|
elif version:
|
||||||
abra.recipe_checkout(recipe, version)
|
abra.recipe_checkout(recipe, version)
|
||||||
|
abra.ensure_secret_versions_from_recipe(recipe, domain)
|
||||||
# A pinned (non-chaos) deploy runs `abra recipe lint`, which FATAs R014 ('only annotated
|
# A pinned (non-chaos) deploy runs `abra recipe lint`, which FATAs R014 ('only annotated
|
||||||
# tags') if the upstream recipe ships a stray lightweight version tag (e.g. lasuite-meet's
|
# tags') if the upstream recipe ships a stray lightweight version tag (e.g. lasuite-meet's
|
||||||
# 0.3.0+v1.16.0). In that case deploy the EXPLICITLY-checked-out pinned version with chaos:
|
# 0.3.0+v1.16.0). In that case deploy the EXPLICITLY-checked-out pinned version with chaos:
|
||||||
|
|||||||
@@ -20,6 +20,24 @@ set -euo pipefail
|
|||||||
: "${CCCI_APP_DOMAIN:?missing}"
|
: "${CCCI_APP_DOMAIN:?missing}"
|
||||||
ENV_PATH="${CCCI_APP_ENV:?missing}"
|
ENV_PATH="${CCCI_APP_ENV:?missing}"
|
||||||
|
|
||||||
|
# The v6 release requires two RSA PEM secrets with generate=false. CI must
|
||||||
|
# supply those operator-managed keys before deploy, including when the base
|
||||||
|
# is v5 and the upgrade head is v6. A PR head with its own key sidecar ignores
|
||||||
|
# these secrets after upgrade.
|
||||||
|
STACK_NAME="${CCCI_APP_DOMAIN//./_}"
|
||||||
|
for SECRET_NAME in jwt_pk yhub_jwt_pk; do
|
||||||
|
ENV_NAME="SECRET_${SECRET_NAME^^}_VERSION"
|
||||||
|
VERSION=$(sed -n "s/^${ENV_NAME}=\([^ #]*\).*/\1/p" "$ENV_PATH" | tail -1)
|
||||||
|
if [ -n "$VERSION" ]; then
|
||||||
|
DOCKER_SECRET="${STACK_NAME}_${SECRET_NAME}_${VERSION}"
|
||||||
|
if ! docker secret inspect "$DOCKER_SECRET" >/dev/null 2>&1; then
|
||||||
|
openssl genpkey -algorithm RSA -pkeyopt rsa_keygen_bits:2048 2>/dev/null \
|
||||||
|
| docker secret create "$DOCKER_SECRET" - >/dev/null
|
||||||
|
echo " install_steps: supplied ${SECRET_NAME} for the published base recipe"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
# No deps file / no keycloak entry → install-time provisioning failed or was skipped. NO-OP so the
|
# No deps file / no keycloak entry → install-time provisioning failed or was skipped. NO-OP so the
|
||||||
# recipe still boots; the @requires_deps OIDC custom test then SKIPs and F2-11 flips the run RED.
|
# recipe still boots; the @requires_deps OIDC custom test then SKIPs and F2-11 flips the run RED.
|
||||||
if [ -z "${CCCI_DEPS_FILE:-}" ] || [ ! -s "${CCCI_DEPS_FILE}" ]; then
|
if [ -z "${CCCI_DEPS_FILE:-}" ] || [ ! -s "${CCCI_DEPS_FILE}" ]; then
|
||||||
@@ -42,6 +60,13 @@ echo " lasuite-docs install_steps: wiring OIDC at install against keycloak ${KC
|
|||||||
# can be created independently — so the single deploy below picks up v2.
|
# can be created independently — so the single deploy below picks up v2.
|
||||||
CUR_VER=$(grep -E '^\s*SECRET_OIDC_RPCS_VERSION=' "$ENV_PATH" | tail -1 | cut -d= -f2 | tr -d '"\r' || echo "v1")
|
CUR_VER=$(grep -E '^\s*SECRET_OIDC_RPCS_VERSION=' "$ENV_PATH" | tail -1 | cut -d= -f2 | tr -d '"\r' || echo "v1")
|
||||||
NEW_NUM=$((${CUR_VER#v} + 1))
|
NEW_NUM=$((${CUR_VER#v} + 1))
|
||||||
|
# A previous warm canonical may have left the next version behind. Its value
|
||||||
|
# belongs to an old Keycloak realm, so select a fresh version instead of
|
||||||
|
# reusing it or failing promotion with Swarm's AlreadyExists error.
|
||||||
|
STACK_NAME="${CCCI_APP_DOMAIN//./_}"
|
||||||
|
while docker secret inspect "${STACK_NAME}_oidc_rpcs_v${NEW_NUM}" >/dev/null 2>&1; do
|
||||||
|
NEW_NUM=$((NEW_NUM + 1))
|
||||||
|
done
|
||||||
NEW_VER="v${NEW_NUM}"
|
NEW_VER="v${NEW_NUM}"
|
||||||
INSERT_LOG=$(abra app secret insert "$CCCI_APP_DOMAIN" oidc_rpcs "$NEW_VER" "$KC_SECRET" --no-input -C -o 2>&1) ||
|
INSERT_LOG=$(abra app secret insert "$CCCI_APP_DOMAIN" oidc_rpcs "$NEW_VER" "$KC_SECRET" --no-input -C -o 2>&1) ||
|
||||||
INSERT_LOG=$(script -qec "abra app secret insert $CCCI_APP_DOMAIN oidc_rpcs $NEW_VER $KC_SECRET --no-input -C -o" /dev/null 2>&1) ||
|
INSERT_LOG=$(script -qec "abra app secret insert $CCCI_APP_DOMAIN oidc_rpcs $NEW_VER $KC_SECRET --no-input -C -o" /dev/null 2>&1) ||
|
||||||
|
|||||||
@@ -0,0 +1,30 @@
|
|||||||
|
"""Pinned base recipes need the secret versions declared by their own tag."""
|
||||||
|
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
|
sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", "..", "runner"))
|
||||||
|
from harness import abra # noqa: E402
|
||||||
|
|
||||||
|
|
||||||
|
def test_pinned_base_adds_removed_secret_without_overwriting_existing_version(
|
||||||
|
monkeypatch, tmp_path
|
||||||
|
):
|
||||||
|
monkeypatch.setenv("HOME", str(tmp_path))
|
||||||
|
monkeypatch.setenv("ABRA_DIR", str(tmp_path / ".abra"))
|
||||||
|
recipe = tmp_path / ".abra" / "recipes" / "lasuite-docs"
|
||||||
|
recipe.mkdir(parents=True)
|
||||||
|
(recipe / ".env.sample").write_text(
|
||||||
|
"SECRET_COLLAB_SS_VERSION=v1\n"
|
||||||
|
"SECRET_JWT_PK_VERSION=v1 # generate=false\n"
|
||||||
|
"# SECRET_UNUSED_VERSION=v1\n"
|
||||||
|
)
|
||||||
|
env = tmp_path / ".abra" / "servers" / "default" / "test.example.env"
|
||||||
|
env.parent.mkdir(parents=True)
|
||||||
|
env.write_text("SECRET_JWT_PK_VERSION=v2\n")
|
||||||
|
|
||||||
|
abra.ensure_secret_versions_from_recipe("lasuite-docs", "test.example")
|
||||||
|
|
||||||
|
assert abra.env_get("test.example", "SECRET_COLLAB_SS_VERSION") == "v1"
|
||||||
|
assert abra.env_get("test.example", "SECRET_JWT_PK_VERSION") == "v2"
|
||||||
|
assert abra.env_get("test.example", "SECRET_UNUSED_VERSION") is None
|
||||||
@@ -127,7 +127,13 @@ def test_previous_overlay_deploys_checked_out_base_without_clean_tree_gate(monke
|
|||||||
"prepull_images",
|
"prepull_images",
|
||||||
):
|
):
|
||||||
monkeypatch.setattr(lifecycle, name, lambda *a, **kw: None)
|
monkeypatch.setattr(lifecycle, name, lambda *a, **kw: None)
|
||||||
for name in ("app_config_remove", "app_new", "env_set", "secret_generate"):
|
for name in (
|
||||||
|
"app_config_remove",
|
||||||
|
"app_new",
|
||||||
|
"env_set",
|
||||||
|
"secret_generate",
|
||||||
|
"ensure_secret_versions_from_recipe",
|
||||||
|
):
|
||||||
monkeypatch.setattr(lifecycle.abra, name, lambda *a, **kw: None)
|
monkeypatch.setattr(lifecycle.abra, name, lambda *a, **kw: None)
|
||||||
monkeypatch.setattr(lifecycle.meta_mod, "extra_env", lambda *a: {})
|
monkeypatch.setattr(lifecycle.meta_mod, "extra_env", lambda *a: {})
|
||||||
monkeypatch.setattr(lifecycle.meta_mod, "hook_ctx", lambda *a: None)
|
monkeypatch.setattr(lifecycle.meta_mod, "hook_ctx", lambda *a: None)
|
||||||
|
|||||||
Reference in New Issue
Block a user