adding of cli parameters for user and password (#335)

* added cli parameter for user (-u) and password (-p) to be used in an eased way for fully automated execution of 'aci-preupgrade-validation-script.py'

* test: Add pytest

---------

Co-authored-by: Detlef Sass <detlef.sass@de.bosch.com>

Author: Thatleft

aci-preupgrade-validation-script.py

@@ -1812,9 +1812,11 @@ def get_vpc_nodes():
     return vpc_nodes
 
 
-def query_common_data(api_only=False, arg_cversion=None, arg_tversion=None):
-    username = password = None
-    if not api_only:
+def query_common_data(api_only=False, arg_cversion=None, arg_tversion=None, username=None, password=None):
+    if api_only:
+        username = None
+        password = None
+    elif not username or not password:
         username, password = get_credentials()
 
     try:
@@ -6296,6 +6298,8 @@ def multipod_modular_spine_bootscript_check(tversion, fabric_nodes, username, pa
 
 def parse_args(args):
     parser = ArgumentParser(description="ACI Pre-Upgrade Validation Script - %s" % SCRIPT_VERSION)
+    parser.add_argument("-u", "--username", action="store", type=str, help="Username used for SSH. If not provied it will prompt for")
+    parser.add_argument("-p", "--password", action="store", type=str, help="Password used for SSH. If not provied it will prompt for")
     parser.add_argument("-t", "--tversion", action="store", type=str, help="Upgrade Target Version. Ex. 6.2(1a)")
     parser.add_argument("-c", "--cversion", action="store", type=str, help="Override Current Version. Ex. 6.1(1a)")
     parser.add_argument("-d", "--debug-function", action="store", type=str, help="Name of a single function to debug. Ex. 'apic_version_md5_check'")
@@ -6589,7 +6593,7 @@ def main(_args=None):
     prints('    ==== %s%s, Script Version %s  ====\n' % (ts, tz, SCRIPT_VERSION))
     prints('!!!! Check https://github.com/datacenter/ACI-Pre-Upgrade-Validation-Script for Latest Release !!!!\n')
 
-    common_data = query_common_data(args.api_only, args.cversion, args.tversion)
+    common_data = query_common_data(args.api_only, args.cversion, args.tversion, args.username, args.password)
     write_script_metadata(args.api_only, args.timeout, cm.total_checks, common_data)
 
     cm.run_checks(common_data)

tests/test_common_data.py

@@ -324,7 +324,7 @@ def _mock_get_target_version(arg_tversion):
                 "attributes": {
                     "dn": "topology/pod-1/node-1/sys/ctrlrfwstatuscont/ctrlrrunning",
                     "type": "controller",
-                    "version": "3.2(7f)"
+                    "version": "3.2(7f)",
                 }
             }
         }
@@ -336,7 +336,7 @@ def _mock_get_target_version(arg_tversion):
                     "dn": "topology/pod-1/node-101/sys/fwstatuscont/running",
                     "peVer": "3.1(2u)",
                     "type": "switch",
-                    "version": "n9000-13.1(2u)"
+                    "version": "n9000-13.1(2u)",
                 }
             }
         },
@@ -346,7 +346,7 @@ def _mock_get_target_version(arg_tversion):
                     "dn": "topology/pod-1/node-102/sys/fwstatuscont/running",
                     "peVer": "3.2(7f)",
                     "type": "switch",
-                    "version": "n9000-13.2(7f)"
+                    "version": "n9000-13.2(7f)",
                 }
             }
         },
@@ -356,7 +356,7 @@ def _mock_get_target_version(arg_tversion):
                     "dn": "topology/pod-1/node-1001/sys/fwstatuscont/running",
                     "peVer": "3.2(7f)",
                     "type": "switch",
-                    "version": "n9000-13.2(7f)"
+                    "version": "n9000-13.2(7f)",
                 }
             }
         },
@@ -366,7 +366,7 @@ def _mock_get_target_version(arg_tversion):
                     "dn": "topology/pod-2/node-201/sys/fwstatuscont/running",
                     "peVer": "3.2(7f)",
                     "type": "switch",
-                    "version": "n9000-13.2(7f)"
+                    "version": "n9000-13.2(7f)",
                 }
             }
         },
@@ -376,11 +376,10 @@ def _mock_get_target_version(arg_tversion):
                     "dn": "topology/pod-2/node-2001/sys/fwstatuscont/running",
                     "peVer": "3.2(7f)",
                     "type": "switch",
-                    "version": "n9000-13.2(7f)"
+                    "version": "n9000-13.2(7f)",
                 }
             }
         },
-
     ],
 }
 
@@ -391,6 +390,8 @@ def fake_args(request):
         "api_only": False,
         "cversion": None,
         "tversion": None,
+        "username": None,
+        "password": None,
     }
     # update data contents when parametrize provides non-falsy values
     for key in data:
@@ -412,6 +413,8 @@ def fake_args(request):
             _icurl_outputs,
             {},
             {
+                "username": "admin",
+                "password": "mypassword",
                 "cversion": AciVersion("6.1(1a)"),
                 "sw_cversion": AciVersion("6.0(9d)"),
                 "tversion": AciVersion("6.2(1a)"),
@@ -425,6 +428,8 @@ def fake_args(request):
             _icurl_outputs_old,
             {},
             {
+                "username": "admin",
+                "password": "mypassword",
                 "cversion": AciVersion("3.2(7f)"),
                 "sw_cversion": AciVersion("3.1(2u)"),
                 "tversion": AciVersion("6.2(1a)"),
@@ -451,6 +456,34 @@ def fake_args(request):
             },
             id="api_only",
         ),
+        # `api_only` is True.
+        # username and password are provide but ignored.
+        pytest.param(
+            _icurl_outputs,
+            {
+                "api_only": True,
+                "username": "arg_admin",
+                "password": "arg_password",
+            },
+            {
+                "username": None,
+                "password": None,
+            },
+            id="api_only_with_username_password",
+        ),
+        # username and password are provided
+        pytest.param(
+            _icurl_outputs,
+            {
+                "username": "arg_admin",
+                "password": "arg_password",
+            },
+            {
+                "username": "arg_admin",
+                "password": "arg_password",
+            },
+            id="username_password",
+        ),
         # `arg_tversion` is provided (i.e. -t 6.1(4a))
         pytest.param(
             _icurl_outputs,
@@ -537,7 +570,11 @@ def test_common_data(mock_icurl, fake_args, expected_common_data):
     """test query_common_data and write_script_metadata"""
     # --- test for `query_common_data()`
     common_data = script.query_common_data(
-        api_only=fake_args["api_only"], arg_cversion=fake_args["cversion"], arg_tversion=fake_args["tversion"]
+        api_only=fake_args["api_only"],
+        arg_cversion=fake_args["cversion"],
+        arg_tversion=fake_args["tversion"],
+        username=fake_args["username"],
+        password=fake_args["password"],
     )
     for key in common_data:
         if isinstance(common_data[key], AciVersion):
@@ -603,7 +640,13 @@ def test_cversion_invald(capsys, mock_icurl):
         # `get_fabric_nodes()` failure
         (
             {
-                "fabricNode.json": [{"error": {"attributes": {"code": "400", "text": "Request failed, unresolved class for dummyClass"}}}],
+                "fabricNode.json": [
+                    {
+                        "error": {
+                            "attributes": {"code": "400", "text": "Request failed, unresolved class for dummyClass"}
+                        }
+                    }
+                ],
                 "fabricNodePEp.json": _icurl_outputs["fabricNodePEp.json"],
             },
             "Gathering Node Information...\n\n",
@@ -612,7 +655,13 @@ def test_cversion_invald(capsys, mock_icurl):
         (
             {
                 "fabricNode.json": _icurl_outputs["fabricNode.json"],
-                "fabricNodePEp.json": [{"error": {"attributes": {"code": "400", "text": "Request failed, unresolved class for dummyClass"}}}],
+                "fabricNodePEp.json": [
+                    {
+                        "error": {
+                            "attributes": {"code": "400", "text": "Request failed, unresolved class for dummyClass"}
+                        }
+                    }
+                ],
             },
             "Collecting VPC Node IDs...",
         ),

tests/test_main.py

@@ -13,7 +13,7 @@
 # ----------------------------
 @pytest.fixture
 def mock_query_common_data(monkeypatch, expected_common_data):
-    def _mock_query_common_data(api_only, args_cversion, args_tversion):
+    def _mock_query_common_data(api_only, args_cversion, args_tversion, username, password):
         return expected_common_data
 
     monkeypatch.setattr(script, "query_common_data", _mock_query_common_data)

tests/test_parse_args.py

@@ -18,6 +18,8 @@ def test_no_args():
     assert args.api_only is False
     assert args.tversion is None
     assert args.cversion is None
+    assert args.username is None
+    assert args.password is None
     assert args.debug_function is None
     assert args.no_cleanup is False
     assert args.version is False
@@ -76,6 +78,32 @@ def test_cversion(args, expected_result):
     assert str(args.cversion) == str(expected_result)
 
 
+@pytest.mark.parametrize(
+    "args, expected_result",
+    [
+        ([], None),
+        (["-u", "myusername"], "myusername"),
+        (["--username", "myusername"], "myusername"),
+    ],
+)
+def test_username(args, expected_result):
+    args = script.parse_args(args)
+    assert args.username == expected_result
+
+
+@pytest.mark.parametrize(
+    "args, expected_result",
+    [
+        ([], None),
+        (["-p", "mypassword"], "mypassword"),
+        (["--password", "mypassword"], "mypassword"),
+    ],
+)
+def test_password(args, expected_result):
+    args = script.parse_args(args)
+    assert args.password == expected_result
+
+
 @pytest.mark.parametrize(
     "args, expected_result",
     [