add backups to the universal site profile, and guard the list
Some checks failed
CI / backend (push) Failing after 7s
CI / naming (push) Successful in 2s
CI / frontend (push) Successful in 9s
CI / migrations-mysql (push) Failing after 7s

site-profile-universal.json is what the released Windows installer is built
from, so a bundled plugin missing from it is invisible to the install wizard.
Worse, `flask plugin prune-schema` drops the tables owned by plugins the site
did not install (ADR-014), so backuprevisions would have been dropped at
provisioning on every new site - a table that shipped in the build, removed
because the profile never named it.

The same omission explains why `flask plugin upgrade-all` skipped backups:
upgrade_all_plugins iterates the REGISTRY, not the plugins directory, on
purpose - a plugin folder merely sitting on disk unadopted must not have its
DDL run as a side effect of a deploy. instance/ is gitignored, so any machine
that never ran `flask plugin install backups` has it on disk but unadopted.

Nothing in the suite caught the stale profile, so this adds two guards: every
bundled plugin carrying a manifest must appear in the universal profile, and
the profile must not name a plugin that does not exist. Verified the first one
fails with the profile as it was.
This commit is contained in:
cproudlock
2026-08-07 14:44:33 -04:00
parent 34f08d5306
commit 565611e3d0
2 changed files with 50 additions and 0 deletions

View File

@@ -1,6 +1,7 @@
{
"site": "universal",
"plugins": [
"backups",
"computers",
"employees",
"geenforce",

View File

@@ -58,3 +58,52 @@ def test_no_unguarded_plugin_imports_in_core():
"Core imports a plugin without a try/except ImportError guard; a lean "
"build omitting that plugin would crash. Wrap in try/except:\n "
+ "\n ".join(unguarded))
# =============================================================================
# Universal site profile completeness
#
# deploy/site-profile-universal.json is what the released Windows installer is
# built from: one exe serving any site, with the wizard offering every bundled
# plugin for the operator to tick. A bundled plugin missing from that list is
# invisible to the installer AND, worse, `flask plugin prune-schema` drops the
# tables it owns at provisioning (ADR-014) because the site never "installed"
# it. That is silent data loss for a plugin that shipped in the build, and
# nothing else in the suite catches it - the backups plugin was added to
# PLUGIN_TABLE_OWNERS and the tree while the profile stayed stale.
# =============================================================================
import json
def _bundled_plugins_with_manifest():
"""Plugin dirs carrying a manifest.json - a manifest-less dir (e.g.
`applications`) is core and always ships, so it is deliberately excluded."""
root = os.path.join(os.path.dirname(os.path.dirname(os.path.abspath(__file__))),
'plugins')
return {name for name in os.listdir(root)
if os.path.isfile(os.path.join(root, name, 'manifest.json'))}
def _universal_profile_plugins():
path = os.path.join(os.path.dirname(os.path.dirname(os.path.abspath(__file__))),
'deploy', 'site-profile-universal.json')
with open(path) as handle:
return set(json.load(handle)['plugins'])
def test_universal_profile_lists_every_bundled_plugin():
missing = _bundled_plugins_with_manifest() - _universal_profile_plugins()
assert not missing, (
'bundled plugin(s) absent from deploy/site-profile-universal.json: '
+ ', '.join(sorted(missing))
+ '. The installer will not offer them and prune-schema will drop '
'their tables at provisioning.'
)
def test_universal_profile_names_only_real_plugins():
unknown = _universal_profile_plugins() - _bundled_plugins_with_manifest()
assert not unknown, (
'site-profile-universal.json names plugin(s) that do not exist: '
+ ', '.join(sorted(unknown)))