Wrap original get_restic_config instead of replacing it; add hook status file

sitecustomize.py: _patch_restic no longer reimplements get_restic_config.
It now wraps the original: calls _orig(cloud_backup) to get a ResticConfig,
then post-processes only the -r argument to fix "b2:/bucket" → "b2:bucket"
when the URL contains a stray leading slash (the stock bug for empty-hostname
providers). Uses dataclasses.replace() to build the corrected result so new
ResticConfig fields added in future TrueNAS versions pass through unchanged.
This eliminates the transfer_setting gap, env dict mutation, and frozen-copy
drift that would occur over time.

Also adds a status file mechanism: sitecustomize.py writes
/data/truecloud-patch/hook_status.json atomically after both patches have
reported success or failure. This gives a machine-readable signal that the
hook fired correctly — without requiring log scraping.

create_task.py: new "verify" subcommand reads the status file and prints a
human-readable summary. Does not require --host or --api-key. --host and
--api-key are now optional at the parser level and validated only for
subcommands that actually need an API connection.

README: update troubleshooting to use "create_task.py verify" instead of
the manual Python introspection one-liner.
This commit is contained in:
2026-06-15 02:47:59 +00:00
parent 78f943a71b
commit 06de1e15c0
3 changed files with 106 additions and 34 deletions
+48 -5
View File
@@ -42,11 +42,14 @@ List existing TrueCloud Backup tasks:
import argparse
import json
import os
import ssl
import sys
import urllib.error
import urllib.request
_STATUS_FILE = "/data/truecloud-patch/hook_status.json"
def make_client(host, api_key, insecure=False):
"""Return a callable that makes authenticated REST API calls."""
@@ -80,6 +83,37 @@ def make_client(host, api_key, insecure=False):
# ── Sub-commands ──────────────────────────────────────────────────────────────
def cmd_verify(_client, _args):
"""Print the hook status written by sitecustomize.py at middlewared startup."""
if not os.path.exists(_STATUS_FILE):
print("No hook status file found.")
print("Either the patch has never loaded (middlewared not yet restarted")
print("after install) or the status file was deleted.")
print(f" Expected: {_STATUS_FILE}")
sys.exit(1)
with open(_STATUS_FILE, encoding="utf-8") as fh:
status = json.load(fh)
print(f"Hook status (recorded at {status.get('patched_at', 'unknown')})")
print()
all_ok = True
for module, info in status.get("patches", {}).items():
ok = info.get("ok", False)
label = "OK " if ok else "FAIL"
detail = f" — {info['detail']}" if info.get("detail") else ""
print(f" [{label}] {module}{detail}")
if not ok:
all_ok = False
print()
if all_ok:
print("All patches active. B2 and S3 backups should work.")
else:
print("One or more patches failed to apply.")
print("Check /data/truecloud-patch/apply.log and journalctl -u middlewared")
sys.exit(1)
def cmd_list_credentials(client, _args):
creds = client("GET", "/cloudsync/credentials")
if not creds:
@@ -149,15 +183,16 @@ def main():
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog=__doc__.split("Examples")[1] if "Examples" in __doc__ else "",
)
p.add_argument("--host", required=True, metavar="HOST",
help="TrueNAS hostname or IP address")
p.add_argument("--api-key", required=True, metavar="KEY",
help="TrueNAS API key (System → API Keys)")
p.add_argument("--host", default=None, metavar="HOST",
help="TrueNAS hostname or IP address (required except for verify)")
p.add_argument("--api-key", default=None, metavar="KEY",
help="TrueNAS API key — System → API Keys (required except for verify)")
p.add_argument("--insecure", action="store_true",
help="Skip TLS certificate verification (self-signed certs)")
sub = p.add_subparsers(dest="cmd", required=True)
sub.add_parser("verify", help="Check that the backend hook loaded correctly")
sub.add_parser("list-credentials", help="List configured cloud credentials")
sub.add_parser("list-tasks", help="List TrueCloud Backup tasks")
@@ -193,11 +228,19 @@ def main():
client = make_client(args.host, args.api_key, args.insecure)
dispatch = {
"verify": cmd_verify,
"list-credentials": cmd_list_credentials,
"list-tasks": cmd_list_tasks,
"create": cmd_create,
}
dispatch[args.cmd](client, args)
if args.cmd == "verify":
cmd_verify(None, args)
else:
if not args.host or not args.api_key:
p.error("--host and --api-key are required for this command")
client = make_client(args.host, args.api_key, args.insecure)
dispatch[args.cmd](client, args)
if __name__ == "__main__":