MB-68871 Add --ipv6only and --ipv4only options to init-node

Change-Id: I5487e588b5f26ff7a83512bcc48c69447eb49df2
Reviewed-on: https://review.couchbase.org/c/couchbase-cli/+/239988
Reviewed-by: Matt Hall <matt.hall@couchbase.com>
Tested-by: Build Bot <build@couchbase.com>
Well-Formed: Restriction Checker

Author: lubomarinski

cbmgr.py

@@ -2262,28 +2262,42 @@ def __init__(self):
                            help="Configure the node to communicate via ipv6")
         group.add_argument("--ipv4", dest="ipv4", action="store_true", default=False,
                            help="Configure the node to communicate via ipv4")
+        group.add_argument("--ipv6only", dest="ipv6_only", action="store_true", default=False,
+                           help="Configure the node to only use ipv6")
+        group.add_argument("--ipv4only", dest="ipv4_only", action="store_true", default=False,
+                           help="Configure the node to only use ipv4")
 
     @rest_initialiser(credentials_required=False)
     def execute(self, opts):
         # Cluster does not need to be initialized for this command
 
         if (opts.data_path is None and opts.index_path is None and opts.analytics_path is None
                 and opts.eventing_path is None and opts.java_home is None and opts.hostname is None
-                and opts.ipv6 is None and opts.ipv4 is None):
+                and opts.ipv6 is None and opts.ipv4 is None and opts.ipv6_only is None and opts.ipv4_only is None):
             _exit_if_errors(["No node initialization parameters specified"])
 
-        if opts.ipv4 and opts.ipv6:
-            _exit_if_errors(["Use either --ipv4 or --ipv6"])
+        flags_used = sum([opts.ipv4, opts.ipv6, opts.ipv6_only, opts.ipv4_only])
+        if flags_used > 1:
+            _exit_if_errors(["--ipv4, --ipv6, --ipv4only, and --ipv6only are mutually exclusive"])
+
+        afamily_only = None
 
         if opts.ipv4:
             afamily = 'ipv4'
         elif opts.ipv6:
             afamily = 'ipv6'
+        elif opts.ipv4_only:
+            afamily = 'ipv4'
+            afamily_only = True
+        elif opts.ipv6_only:
+            afamily = 'ipv6'
+            afamily_only = True
         else:
             afamily = None
 
         _, errors = self.rest.node_init(hostname=opts.hostname,
                                         afamily=afamily,
+                                        afamily_only=afamily_only,
                                         data_path=opts.data_path,
                                         index_path=opts.index_path,
                                         cbas_path=opts.analytics_path,

cluster_manager.py

@@ -1396,7 +1396,7 @@ def get_bucket(self, name):
 
         return None, ["Bucket not found"]
 
-    def node_init(self, hostname=None, afamily=None, data_path=None,
+    def node_init(self, hostname=None, afamily=None, afamily_only=None, data_path=None,
                   index_path=None, cbas_path=None, eventing_path=None,
                   java_home=None):
         url = f'{self.hostname}/nodeInit'
@@ -1408,6 +1408,9 @@ def node_init(self, hostname=None, afamily=None, data_path=None,
         if afamily is not None:
             params["afamily"] = afamily
 
+        if afamily_only is not None:
+            params["afamilyOnly"] = "true" if afamily_only else "false"
+
         if data_path is not None:
             params["dataPath"] = data_path
 

docs/modules/cli/pages/cbcli/couchbase-cli-node-init.adoc

@@ -17,7 +17,7 @@ _couchbase-cli node-init_ [--cluster <url>] [--username <user>] [--password <pas
     [--client-key-password <password>] [--node-init-data-path <path>]
     [--node-init-index-path <path>] [--node-init-analytics-path <path>]
     [--node-init-eventing-path <path>] [--node-init-hostname <hostname>]
-    [--node-init-java-home <path>] [--ipv4] [--ipv6]
+    [--node-init-java-home <path>] [--ipv4] [--ipv6] [--ipv4only] [--ipv6only]
 
 == DESCRIPTION
 
@@ -66,6 +66,14 @@ include::{partialsdir}/cbcli/part-common-options.adoc[]
 --ipv6::
   Switch the node to use ipv6 for node to node communication
 
+--ipv4only::
+  Switch the node to use ipv4 only for node to node communication. The node
+  will only listen on that address.
+
+--ipv6only::
+  Switch the node to use ipv6 only for node to node communication. The node
+  will only listen on that address.
+
 include::{partialsdir}/cbcli/part-host-formats.adoc[]
 
 include::{partialsdir}/cbcli/part-certificate-authentication.adoc[]

jenkins/.aspell.en.pws

@@ -28,6 +28,8 @@ cbbackupwrapper
 cbcli
 cbcollect
 cbdatarecovery
+cbexport
+cbimport
 cblogredaction
 CBO
 cbrecovery

test/test_cli.py

@@ -1184,7 +1184,7 @@ def test_node_init(self):
 
     def test_node_init_ipv6_and_ipv4(self):
         self.system_exit_run(self.command + self.name_args + ['--ipv4', '--ipv6'], self.server_args)
-        self.assertIn('Use either --ipv4 or --ipv6', self.str_output)
+        self.assertIn('--ipv4, --ipv6, --ipv4only, and --ipv6only are mutually exclusive', self.str_output)
 
     def test_node_init_ipv6(self):
         self.no_error_run(self.command + self.name_args + ['--ipv6'], self.server_args)
@@ -1198,6 +1198,34 @@ def test_node_init_ipv4(self):
         expected_params = ['hostname=foo', 'afamily=ipv4']
         self.rest_parameter_match(expected_params)
 
+    def test_node_init_ipv6only(self):
+        self.no_error_run(self.command + self.name_args + ['--ipv6only'], self.server_args)
+        self.assertIn('POST:/nodeInit', self.server.trace)
+        expected_params = ['hostname=foo', 'afamily=ipv6', 'afamilyOnly=true']
+        self.rest_parameter_match(expected_params)
+
+    def test_node_init_ipv4only(self):
+        self.no_error_run(self.command + self.name_args + ['--ipv4only'], self.server_args)
+        self.assertIn('POST:/nodeInit', self.server.trace)
+        expected_params = ['hostname=foo', 'afamily=ipv4', 'afamilyOnly=true']
+        self.rest_parameter_match(expected_params)
+
+    def test_node_init_ipv6_and_ipv6only(self):
+        self.system_exit_run(self.command + self.name_args + ['--ipv6', '--ipv6only'], self.server_args)
+        self.assertIn('--ipv4, --ipv6, --ipv4only, and --ipv6only are mutually exclusive', self.str_output)
+
+    def test_node_init_ipv4_and_ipv6only(self):
+        self.system_exit_run(self.command + self.name_args + ['--ipv4', '--ipv6only'], self.server_args)
+        self.assertIn('--ipv4, --ipv6, --ipv4only, and --ipv6only are mutually exclusive', self.str_output)
+
+    def test_node_init_ipv4_and_ipv4only(self):
+        self.system_exit_run(self.command + self.name_args + ['--ipv4', '--ipv4only'], self.server_args)
+        self.assertIn('--ipv4, --ipv6, --ipv4only, and --ipv6only are mutually exclusive', self.str_output)
+
+    def test_node_init_ipv4only_and_ipv6only(self):
+        self.system_exit_run(self.command + self.name_args + ['--ipv4only', '--ipv6only'], self.server_args)
+        self.assertIn('--ipv4, --ipv6, --ipv4only, and --ipv6only are mutually exclusive', self.str_output)
+
 
 class TestNodeReset(CommandTest):
     def setUp(self):