Rename the --downgrade flag to --force (#18)

The old name was reflective of our expected use for the flag, but it also is used to re-download a version. This new name better reflects its broader semantics.

Author: velovix

brainframe/cli/commands/update.py

@@ -15,25 +15,39 @@ def update():
 
     docker_compose.assert_installed(install_path)
 
-    _, _, upgrade_version = docker_compose.check_download_version()
-    existing_version = docker_compose.check_existing_version(install_path)
-    if version.parse(existing_version) >= version.parse(upgrade_version):
-        if not args.downgrade:
+    if args.version == "latest":
+        _, _, requested_version_str = docker_compose.check_download_version()
+    else:
+        requested_version_str = args.version
+
+    existing_version_str = docker_compose.check_existing_version(install_path)
+
+    existing_version = version.parse(existing_version_str)
+    requested_version = version.parse(requested_version_str)
+
+    if not args.force:
+        if existing_version == requested_version:
             print_utils.fail_translate(
-                "update.version-failing",
-                existing_version=existing_version,
-                upgrade_version=upgrade_version,
+                "update.version-already-installed",
+                existing_version=existing_version_str,
+                requested_version=requested_version_str,
+            )
+        elif existing_version > requested_version:
+            print_utils.fail_translate(
+                "update.downgrade-not-allowed",
+                existing_version=existing_version_str,
+                requested_version=requested_version_str,
             )
 
     print_utils.translate(
         "update.upgrade-version",
-        existing_version=existing_version,
-        upgrade_version=upgrade_version,
+        existing_version=existing_version_str,
+        requested_version=requested_version_str,
     )
 
     print_utils.translate("general.downloading-docker-compose")
     docker_compose_path = install_path / "docker-compose.yml"
-    docker_compose.download(docker_compose_path, version=args.version)
+    docker_compose.download(docker_compose_path, version=requested_version_str)
 
     docker_compose.run(install_path, ["pull"])
 
@@ -72,9 +86,7 @@ def _parse_args():
     )
 
     parser.add_argument(
-        "--downgrade",
-        action="store_true",
-        help=i18n.t("update.downgrade-help"),
+        "--force", action="store_true", help=i18n.t("update.force-help"),
     )
 
     return subcommand_parse_args(parser)

brainframe/cli/translations/update.en.yml

@@ -6,14 +6,17 @@ en:
   supported, and may result in instability or data loss."
   restart-help: "If provided, the server will restart after the update is
   complete"
-  downgrade-help: "If provided, BrainFrame server will be forced to downgrade."
+  force-help: "If provided, the BrainFrame server will download the
+  specified version, even if it is not newer than the current version."
   ask-restart: "Would you like to restart the BrainFrame server to apply the
   update?"
   complete: "BrainFrame has been updated!"
   upgrade-version: "BrainFrame:%{existing_version} detected under your installation
-  location, we will replace it with BrainFrame:%{upgrade_version}"
-  version-failing: "You have BrainFrame:%{existing_version} installed already.
-  The latest version we found on updating server is
-  BrainFrame:%{upgrade_version}. We don't recommend downgrading BrainFrame
-  for data integrity reasons. This request will be ignored. But you can force to
-  downgrade by appending --downgrade flag."
+  location, we will replace it with BrainFrame:%{requested_version}"
+  version-already-installed: "BrainFrame:%{existing_version} is already
+  installed. This request will be ignored. You can force this release to be
+  re-downloaded using the --force flag."
+  downgrade-not-allowed: "BrainFrame:%{requested_version} is an earlier release
+  than the currently installed version, BrainFrame:%{existing_version}. We
+  don't recommend downgrading BrainFrame for data integrity reasons. This
+  request will be ignored. You can force a downgrade using the --force flag."