Updated cli.py and yaml

Author: noctarius

simplyblock_cli/cli-reference-schema.yaml

@@ -295,11 +295,28 @@ properties:
                       x-intellij-html-description: |
                         The action value parameter. <b>Positional arguments cannot have actions.</b>
                     choices:
-                        type: array
-                        description: The valid choices of the positional argument or parameter.
-                        x-intellij-html-description: The valid choices of the positional argument or parameter.
-                        items:
-                          minItems: 2
-                          oneOf:
-                            - type: string
-                            - type: integer
+                      type: array
+                      description: The valid choices of the positional argument or parameter.
+                      x-intellij-html-description: The valid choices of the positional argument or parameter.
+                      items:
+                        minItems: 2
+                        oneOf:
+                          - type: string
+                          - type: integer
+                    deprecated:
+                      type: object
+                      required:
+                        - since
+                      properties:
+                        replaced-by:
+                          type: string
+                          description: The replacement of the parameter.
+                          x-intellij-html-description: The replacement of the parameter.
+                        since:
+                          type: string
+                          description: The version of the parameter which deprecates the replacement.
+                          x-intellij-html-description: The version of the parameter which deprecates the replacement.
+                        migration:
+                          type: string
+                          description: The migration function which migrates the old value to the new value..
+                          x-intellij-html-description: The migration function which migrates the old value to the new value.

simplyblock_cli/cli-reference.yaml

@@ -159,10 +159,12 @@ commands:
             dest: ifname
             type: str
           - name: "--journal-partition"
+            deprecated:
+              since: "26.1"
+              replaced-by: "--enable-journal-device"
+              migration: "migrate_journal_partition"
             help: |
-              **Deprecated:** use `--enable-journal-device` instead.
-              
-              1: Auto-create small partitions for journal on nvme devices. 0: use a separate (the smallest) nvme device of the node for journal. The journal needs a maximum of 3 percent of total available raw disk space. Default: `1`.
+              1: auto-create small partitions for journal on nvme devices. 0: use a separate (the smallest) nvme device of the node for journal. The journal needs a maximum of 3% of total available raw disk space."
             dest: partitions
             type: int
             choices:

simplyblock_cli/cli.py

@@ -122,7 +122,7 @@ def init_storage_node__add_node(self, subparser):
         subcommand.add_argument('cluster_id', help='The cluster id.', type=str)
         subcommand.add_argument('node_addr', help='Address of storage node api to add, like <node-ip>:5000.', type=str)
         subcommand.add_argument('ifname', help='The management interface name.', type=str)
-        argument = subcommand.add_argument('--journal-partition', help='**Deprecated:** use `--enable-journal-device` instead.1: Auto-create small partitions for journal on nvme devices. 0: use a separate (the smallest) nvme device of the node for journal. The journal needs a maximum of 3 percent of total available raw disk space. Default: `1`.', type=int, dest='partitions', choices=[0,1,])
+        argument = subcommand.add_argument('--journal-partition', help='**Deprecated since: 26.1** Replaced by: --enable-journal-device\n\n1: auto-create small partitions for journal on nvme devices. 0: use a separate (the smallest) nvme device of the node for journal. The journal needs a maximum of 3%% of total available raw disk space."', type=int, dest='partitions', choices=[0,1,])
         argument = subcommand.add_argument('--enable-journal-device', help='Enables the use of a separate (the smallest) NVMe device of the node for the journal. Otherwise, the journal uses a maximum of 3%% of total available raw disk space across all NVMe devices.', default=False, dest='enable_journal_device', action='store_true')
         argument = subcommand.add_argument('--format-4k', help='Force format nvme devices with 4K.', dest='format_4k', action='store_true')
         if self.developer_mode:
@@ -1094,6 +1094,7 @@ def run(self):
                         args.id_device_by_nqn = False
                         args.max_snap = 5000
                         args.spdk_proxy_image = None
+                    args = self.migrate_journal_partition(args)
                     ret = self.storage_node__add_node(sub_command, args)
                 elif sub_command in ['delete']:
                     ret = self.storage_node__delete(sub_command, args)

simplyblock_cli/clibase.py

@@ -161,18 +161,7 @@ def storage_node__add_node(self, sub_command, args):
         namespace = args.namespace
         ha_jm_count = args.ha_jm_count
         format_4k = args.format_4k
-
-        if args.enable_journal_device:
-            num_partitions_per_dev = 0
-        else:
-            # Deprecated but still supported for backward compatibility.
-            if args.partitions is None:
-                num_partitions_per_dev = 1
-            elif args.partitions < 0 or args.partitions > 1:
-                self.parser.error("partitions must be either 0 or 1")
-            else:
-                print("WARNING: --journal-partition is deprecated, use --enable-journal-device instead")
-                num_partitions_per_dev = args.partitions
+        num_partitions_per_dev = 0 if args.enable_journal_device else 1
 
         try:
             out = storage_ops.add_node(
@@ -1118,3 +1107,11 @@ def _completer_get_cluster_list(self, prefix, parsed_args, **kwargs):
     def _completer_get_sn_list(self, prefix, parsed_args, **kwargs):
         db = db_controller.DBController()
         return (cluster.get_id() for cluster in db.get_storage_nodes() if cluster.get_id().startswith(prefix))
+
+    def migrate_journal_partition(self, args):
+        if args.partitions < 0 or args.partitions > 1:
+            self.parser.error("partitions must be either 0 or 1")
+        else:
+            args.enable_journal_device = True
+            del args.partitions
+        return args

simplyblock_cli/scripts/cli-wrapper-gen.py

@@ -65,6 +65,20 @@ def escape_strings(text):
     return text
 
 
+def apply_deprecated_warning(item):
+    deprecated = item.get("deprecated")
+    if not deprecated:
+        return ""
+
+    since = deprecated.get("since")
+    replaced_by = deprecated.get("replaced-by")
+
+    if not since:
+        raise ValueError("deprecated item must have a since")
+
+    return f"**Deprecated since: {since}**{ '' if not replaced_by else f' Replaced by: {replaced_by}'}" + "\\n\\n"
+
+
 def make_identifier(name):
     if name.startswith("--"):
         name = name[2:]
@@ -154,6 +168,7 @@ def nargs(item):
         environment.filters["get_description"] = get_description
         environment.filters["escape_strings"] = escape_strings
         environment.filters["make_identifier"] = make_identifier
+        environment.filters["apply_deprecated_warning"] = apply_deprecated_warning
         environment.filters["bool_value"] = bool_value
         environment.filters["escape_python_string"] = escape_python_string
         environment.filters["nargs"] = nargs

simplyblock_cli/scripts/cli-wrapper.jinja2

@@ -78,7 +78,7 @@ class CLIWrapper(CLIWrapperBase):
 , '{{ alias }}'
 {%- endfor -%}
 {%- endif -%}
-, help='{{ parameter.help | escape_strings | escape_python_string }}'
+, help='{{ parameter | apply_deprecated_warning }}{{ parameter.help | escape_strings | escape_python_string }}'
 {%- if parameter.type is defined and parameter.action is undefined %}, type={{ parameter.type | argument_type }}{% endif %}
 {%- if parameter.default is defined %}, default={{ parameter | default_value }}{% endif %}
 {%- if parameter.dest is defined %}, dest='{{ parameter.dest }}'{% endif %}
@@ -137,6 +137,11 @@ class CLIWrapper(CLIWrapperBase):
                         args.{{ parameter.dest }} = {{ parameter | default_value }}
 {%- endif -%}
 {%- endfor -%}
+{%- for parameter in subcommand.parameters -%}
+{%- if parameter.deprecated is defined and parameter.deprecated.migration is defined %}
+                    args = self.{{ parameter.deprecated.migration }}(args)
+{%- endif %}
+{%- endfor -%}
 {%- if subcommand.private %}
                     if not self.developer_mode:
                         print("This command is private.")