Skip to content
Open
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
13 changes: 11 additions & 2 deletions mchub/models/magic_castle/magic_castle.py
Original file line number Diff line number Diff line change
Expand Up @@ -584,7 +584,16 @@ def plan_destruction(self):

def create_plan(self, github_sha=None, run_id=None):
logger.debug(f"Call <{self.__class__.__name__}:create_plan>")
self.tfcloud_run = TerraformCloudRunORM()
# A castle has exactly one Terraform Cloud run record. Reuse it when
# planning again instead of replacing it with another row carrying the
# same foreign key.
if self.tfcloud_run is None:
self.tfcloud_run = TerraformCloudRunORM()
else:
self.tfcloud_run.run_id = None
self.tfcloud_run.plan = None
self.tfcloud_run.apply_log_url = None
self.tfcloud_run.tf_state = None

try:
if github_sha is None and run_id is None:
Expand Down Expand Up @@ -636,4 +645,4 @@ def apply(self):
raise RunIDNotSet

tf = get_terraform_cloud()
tf.apply_run(self.tfcloud_run.run_id)
tf.apply_run(self.tfcloud_run.run_id)
6 changes: 5 additions & 1 deletion mchub/models/terraform_cloud.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,8 @@ class TerraformCloudRunORM(db.Model):
apply_log_url = db.Column(db.String)
tf_state = db.Column(db.PickleType())
magic_castle = db.relationship("MagicCastleORM", back_populates="tfcloud_run")
magic_castle_id = db.Column(db.Integer, db.ForeignKey("magiccastle.id"))
magic_castle_id = db.Column(
db.Integer,
db.ForeignKey("magiccastle.id"),
unique=True,
)
51 changes: 51 additions & 0 deletions migrations/versions/0005_enforce_one_tfcloud_run_per_cluster.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
"""Enforce one Terraform Cloud run per Magic Castle

Revision ID: 0005
Revises: 0004
Create Date: 2026-09-03 00:00:00.000000

"""
from alembic import op
import sqlalchemy as sa

# revision identifiers, used by Alembic.
revision = "0005"
down_revision = "0004"
branch_labels = None
depends_on = None


def upgrade():
bind = op.get_bind()

# The ORM relationship has always been scalar, but the database previously
# allowed several runs to reference the same castle. Keep the most recently
# inserted run before adding the missing database invariant.
bind.execute(
sa.text(
"""
DELETE FROM terraformcloudrun
WHERE magic_castle_id IS NOT NULL
AND id NOT IN (
SELECT MAX(id)
FROM terraformcloudrun
WHERE magic_castle_id IS NOT NULL
GROUP BY magic_castle_id
)
"""
)
)

with op.batch_alter_table("terraformcloudrun") as batch_op:
batch_op.create_unique_constraint(
"uq_terraformcloudrun_magic_castle_id",
["magic_castle_id"],
)


def downgrade():
with op.batch_alter_table("terraformcloudrun") as batch_op:
batch_op.drop_constraint(
"uq_terraformcloudrun_magic_castle_id",
type_="unique",
)
61 changes: 61 additions & 0 deletions tests/test_migrations.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
from pathlib import Path

import sqlalchemy as sa
from flask_migrate import upgrade

from .mocks.configuration.config_mock import config_auth_none_mock # noqa: F401


def test_tfcloud_run_migration_deduplicates_existing_rows(tmp_path):
from mchub import create_app
from mchub.database import db

database_path = tmp_path / "migration.db"
migrations_path = Path(__file__).parents[1] / "migrations"
app = create_app(db_path=f"sqlite:///{database_path}")

with app.app_context():
upgrade(directory=str(migrations_path), revision="0004")
db.session.execute(
sa.text(
"INSERT INTO magiccastle (hostname) VALUES ('duplicate.example.com')"
)
)
magic_castle_id = db.session.execute(
sa.text(
"SELECT id FROM magiccastle WHERE hostname = 'duplicate.example.com'"
)
).scalar_one()
db.session.execute(
sa.text(
"""
INSERT INTO terraformcloudrun (run_id, magic_castle_id)
VALUES ('OLD_RUN', :magic_castle_id),
('CURRENT_RUN', :magic_castle_id)
"""
),
{"magic_castle_id": magic_castle_id},
)
db.session.commit()

upgrade(directory=str(migrations_path), revision="head")

runs = db.session.execute(
sa.text(
"""
SELECT run_id
FROM terraformcloudrun
WHERE magic_castle_id = :magic_castle_id
"""
),
{"magic_castle_id": magic_castle_id},
).scalars().all()
assert runs == ["CURRENT_RUN"]

constraints = sa.inspect(db.engine).get_unique_constraints(
"terraformcloudrun"
)
assert any(
constraint["column_names"] == ["magic_castle_id"]
for constraint in constraints
)
28 changes: 27 additions & 1 deletion tests/unit/magic_castle/test_magic_castle.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,32 @@ def test_create_magic_castle_plan_valid(app):
cluster.plan_creation(deepcopy(VALID_CLUSTER_CONFIGURATION))


def test_create_plan_reuses_tfcloud_run(app):
from mchub.database import db
from mchub.models.magic_castle.magic_castle import MagicCastle, MagicCastleORM
from mchub.models.terraform_cloud import TerraformCloudRunORM

orm = db.session.scalar(
db.select(MagicCastleORM).filter_by(
hostname="valid1.magic-castle.cloud"
)
)
cluster = MagicCastle(orm)
original_run_id = cluster.tfcloud_run.id

cluster.create_plan(run_id="REPLACEMENT_RUN_ID")

runs = db.session.scalars(
db.select(TerraformCloudRunORM).filter_by(magic_castle_id=orm.id)
).all()
assert len(runs) == 1
assert runs[0].id == original_run_id
assert runs[0].run_id == "REPLACEMENT_RUN_ID"
assert runs[0].plan == {"MOCK": "PLAN_LOG"}
assert runs[0].apply_log_url is None
assert runs[0].tf_state is None


def test_create_magic_castle_twice(app):
from mchub.models.magic_castle.magic_castle import MagicCastle
from mchub.exceptions.invalid_usage_exception import (
Expand Down Expand Up @@ -223,4 +249,4 @@ def test_allocated_resources_not_found(app):
"pre_allocated_cores": 0,
"pre_allocated_volume_count": 0,
"pre_allocated_volume_size": 0,
}
}