Improved version check.

Author: MOBergeron

ctf/__init__.py

@@ -1,21 +1,67 @@
 #!/usr/bin/env python3
 import importlib.metadata
+import json
 import logging
 import os
+import sys
+import urllib.request
 
 import coloredlogs
 
+VERSION = importlib.metadata.version("ctf-script")
+
+if len(sys.argv) > 1 and sys.argv[1] == "version":
+    print(VERSION)
+    exit(code=0)
+
 ENV = {}
 for k, v in os.environ.items():
     ENV[k] = v
 
-VERSION = importlib.metadata.version("ctf-script")
-
 LOG = logging.getLogger()
 LOG.setLevel(level=logging.DEBUG)
 coloredlogs.install(level="DEBUG", logger=LOG)
 
 
+def check_tool_version():
+    with urllib.request.urlopen(
+        url="https://api.github.com/repos/nsec/ctf-script/releases/latest"
+    ) as r:
+        if r.getcode() != 200:
+            LOG.debug(r.read().decode())
+            LOG.error("Could not verify the latest release.")
+        else:
+            try:
+                latest_version = json.loads(s=r.read().decode())["tag_name"]
+            except Exception as e:
+                LOG.debug(e)
+                LOG.error("Could not verify the latest release.")
+
+        compare = 0
+        for current_part, latest_part in zip(
+            [int(part) for part in VERSION.split(".")],
+            [int(part) for part in latest_version.split(".")],
+        ):
+            if current_part < latest_part:
+                compare = -1
+                break
+            elif current_part > latest_part:
+                compare = 1
+                break
+
+        match compare:
+            case 0 | 1:
+                LOG.debug("Script is up to date.")
+            case -1:
+                LOG.critical(
+                    "Script is outdated. Please update to the latest release before continuing."
+                )
+                exit(code=1)
+
+
+check_tool_version()
+
+
 def find_ctf_root_directory() -> str:
     path = os.path.join(os.getcwd(), ".")
 

ctf/__main__.py

@@ -17,7 +17,7 @@
 import yaml
 from tabulate import tabulate
 
-from ctf import CTF_ROOT_DIRECTORY, ENV, LOG, VERSION
+from ctf import CTF_ROOT_DIRECTORY, ENV, LOG
 from ctf.utils import (
     add_tracks_to_terraform_modules,
     available_incus_remotes,
@@ -1136,11 +1136,6 @@ def write_badge(name: str, svg: str) -> None:
         f.write(svg)
 
 
-def version(args: argparse.Namespace) -> None:
-    print(VERSION)
-    exit(code=0)
-
-
 def main():
     # Command line parsing.
     parser = argparse.ArgumentParser(
@@ -1150,11 +1145,11 @@ def main():
 
     subparsers = parser.add_subparsers(required=True)
 
-    parser_version = subparsers.add_parser(
+    # Create a fake subparser as the version is printed before anything else in the __init__.py file.
+    subparsers.add_parser(
         "version",
         help="Script version.",
     )
-    parser_version.set_defaults(func=version)
 
     parser_flags = subparsers.add_parser(
         "flags",
@@ -1367,9 +1362,6 @@ def main():
 
     args = parser.parse_args()
 
-    if args.func.__name__ == "version":
-        args.func(args=args)
-
     if "remote" in args and args.remote:
         ENV["INCUS_REMOTE"] = args.remote
 

ctf/utils.py

@@ -5,7 +5,6 @@
 from typing import Any, Generator
 
 import jinja2
-import tomllib
 import yaml
 
 from ctf import CTF_ROOT_DIRECTORY

pyproject.toml

@@ -18,7 +18,7 @@ dependencies = [
     "black",
     "tabulate==0.9.0",
 ]
-version = "2025.5.0"
+version = "1.0.1"
 classifiers = [
     "Programming Language :: Python :: 3",
     "Operating System :: OS Independent",