mas-cli 11.4.0__py3-none-any.whl → 11.5.0__py3-none-any.whl

mas/cli/__init__.py

@@ -8,4 +8,4 @@
 #
 # *****************************************************************************
 
-__version__ = "11.4.0"  # Python module compatible semver
+__version__ = "11.5.0"  # Python module compatible semver

mas/cli/cli.py

@@ -30,7 +30,6 @@ from prompt_toolkit import prompt, print_formatted_text, HTML
 from mas.devops.mas import isAirgapInstall
 from mas.devops.ocp import connect, isSNO
 
-from .validators import YesNoValidator
 from .displayMixins import PrintMixin, PromptMixin
 
 # Configure the logger
@@ -97,7 +96,7 @@ class BaseApp(PrintMixin, PromptMixin):
 
         # Set up a log handler (5mb rotating log file)
         ch = logging.handlers.RotatingFileHandler(
-            "mas.log", maxBytes=(1048576*5), backupCount=2
+            "mas.log", maxBytes=(1048576 * 5), backupCount=2
         )
         ch.setLevel(logging.DEBUG)
         ch.setFormatter(chFormatter)
@@ -108,7 +107,7 @@ class BaseApp(PrintMixin, PromptMixin):
         rootLogger.setLevel(logging.DEBUG)
 
         # Supports extended semver, unlike mas.cli.__version__
-        self.version = "11.4.0"
+        self.version = "11.5.0"
         self.h1count = 0
         self.h2count = 0
 
@@ -223,7 +222,7 @@ class BaseApp(PrintMixin, PromptMixin):
         else:
             return []
 
-    def fatalError(self, message: str, exception: Exception=None) -> None:
+    def fatalError(self, message: str, exception: Exception = None) -> None:
         if exception is not None:
             logger.error(message)
             logger.exception(exception, stack_info=True)
@@ -289,8 +288,7 @@ class BaseApp(PrintMixin, PromptMixin):
                 print()
                 if not self.noConfirm:
                     # We are already connected to a cluster, but prompt the user if they want to use this connection
-                    continueWithExistingCluster = prompt(HTML('<Yellow>Proceed with this cluster?</Yellow> '), validator=YesNoValidator(), validate_while_typing=False)
-                    promptForNewServer = continueWithExistingCluster in ["n", "no"]
+                    promptForNewServer = not self.yesOrNo("Proceed with this cluster?")
             except Exception as e:
                 # We are already connected to a cluster, but the connection is not valid so prompt for connection details
                 logger.debug("Failed looking up OpenShift Console route to verify connection")
@@ -311,7 +309,7 @@ class BaseApp(PrintMixin, PromptMixin):
                 print_formatted_text(HTML("<Red>Unable to connect to cluster.  See log file for details</Red>"))
                 exit(1)
 
-    def initializeApprovalConfigMap(self, namespace: str, id: str, key: str=None, maxRetries: int=100, delay: int=300, ignoreFailure: bool=True) -> None:
+    def initializeApprovalConfigMap(self, namespace: str, id: str, key: str = None, maxRetries: int = 100, delay: int = 300, ignoreFailure: bool = True) -> None:
         """
         Set key = None if you don't want approval workflow enabled
         """

mas/cli/displayMixins.py

@@ -8,7 +8,7 @@
 #
 # *****************************************************************************
 
-from os import path, getenv
+from os import getenv
 from prompt_toolkit import prompt, print_formatted_text, HTML
 from prompt_toolkit.completion import WordCompleter
 from prompt_toolkit.validation import Validator
@@ -18,12 +18,13 @@ from .validators import YesNoValidator, FileExistsValidator, DirectoryExistsVali
 import logging
 logger = logging.getLogger(__name__)
 
-H1COLOR="SkyBlue"
-H2COLOR="SkyBlue"
-DESCRIPTIONCOLOR="LightSlateGrey"
-SUMMARYCOLOR="SkyBlue"
-UNDEFINEDPARAMCOLOR="LightSlateGrey"
-PROMPTCOLOR="Yellow"
+H1COLOR = "SkyBlue"
+H2COLOR = "SkyBlue"
+DESCRIPTIONCOLOR = "LightSlateGrey"
+SUMMARYCOLOR = "SkyBlue"
+UNDEFINEDPARAMCOLOR = "LightSlateGrey"
+PROMPTCOLOR = "Yellow"
+
 
 class PrintMixin():
     def printTitle(self, message):
@@ -67,14 +68,17 @@ class PrintMixin():
         else:
             self.printSummary(message, self.getParam(param))
 
+
 def masPromptYesOrNo(message):
     return HTML(f"<{PROMPTCOLOR}>{message.replace(' & ', ' &amp; ')}? [y/n]</{PROMPTCOLOR}> ")
 
+
 def masPromptValue(message):
     return HTML(f"<{PROMPTCOLOR}>{message.replace(' & ', ' &amp; ')}</{PROMPTCOLOR}> ")
 
+
 class PromptMixin():
-    def yesOrNo(self, message: str, param: str=None) -> bool:
+    def yesOrNo(self, message: str, param: str = None) -> bool:
         response = prompt(masPromptYesOrNo(message), validator=YesNoValidator(), validate_while_typing=False)
         responseAsBool = response.lower() in ["y", "yes"]
 
@@ -82,7 +86,7 @@ class PromptMixin():
             self.params[param] = "true" if responseAsBool else "false"
         return responseAsBool
 
-    def promptForString(self, message: str, param: str=None, default: str="", isPassword: bool=False, validator: Validator=None, completer: WordCompleter=None) -> str:
+    def promptForString(self, message: str, param: str = None, default: str = "", isPassword: bool = False, validator: Validator = None, completer: WordCompleter = None) -> str:
         if param is not None and default == "":
             default = getenv(param.upper(), default="")
 
@@ -91,7 +95,7 @@ class PromptMixin():
             self.params[param] = response
         return response
 
-    def promptForInt(self, message: str, param: str=None, default: int=None) -> int:
+    def promptForInt(self, message: str, param: str = None, default: int = None) -> int:
         if param is not None and default is None:
             default = getenv(param.upper(), default=None)
 
@@ -103,12 +107,12 @@ class PromptMixin():
             self.params[param] = str(response)
         return response
 
-    def promptForListSelect(self, message: str, options: list, param: str=None, default: int=None) -> str:
+    def promptForListSelect(self, message: str, options: list, param: str = None, default: int = None) -> str:
         selection = self.promptForInt(message=message, default=default)
         # List indices are 0 origin, so we need to subtract 1 from the selection made to arrive at the correct value
-        self.setParam(param, options[selection-1])
+        self.setParam(param, options[selection - 1])
 
-    def promptForFile(self, message: str, mustExist: bool=True, default: str="", envVar: str="") -> None:
+    def promptForFile(self, message: str, mustExist: bool = True, default: str = "", envVar: str = "") -> None:
         if default == "" and envVar != "":
             default = getenv(envVar, "")
         if mustExist:
@@ -116,7 +120,7 @@ class PromptMixin():
         else:
             return prompt(masPromptValue(message), default=default)
 
-    def promptForDir(self, message: str, mustExist: bool=True, default: str="") -> None:
+    def promptForDir(self, message: str, mustExist: bool = True, default: str = "") -> None:
         if mustExist:
             return prompt(masPromptValue(message), validator=DirectoryExistsValidator(), validate_while_typing=False, default=default)
         else:

mas/cli/gencfg.py

@@ -11,14 +11,15 @@
 from os import path
 from jinja2 import Template
 
+
 class ConfigGeneratorMixin():
     def generateJDBCCfg(
             self,
             instanceId: str,
             scope: str,
             destination: str,
-            appId: str="",
-            workspaceId: str="") -> None:
+            appId: str = "",
+            workspaceId: str = "") -> None:
 
         templateFile = path.join(self.templatesDir, "jdbccfg.yml.j2")
         with open(templateFile) as tFile:

mas/cli/install/__init__.py

@@ -8,4 +8,4 @@
 #
 # *****************************************************************************
 
-from ..cli import BaseApp
+from ..cli import BaseApp  # noqa: F401

mas/cli/install/app.py

@@ -12,7 +12,7 @@
 import logging
 import logging.handlers
 from sys import exit
-from os import path
+from os import path, getenv
 import re
 
 from openshift.dynamic.exceptions import NotFoundError
@@ -31,12 +31,12 @@ from .settings import InstallSettingsMixin
 from .summarizer import InstallSummarizerMixin
 
 from mas.cli.validators import (
-  InstanceIDFormatValidator,
-  WorkspaceIDFormatValidator,
-  WorkspaceNameFormatValidator,
-  TimeoutFormatValidator,
-  StorageClassValidator,
-  OptimizerInstallPlanValidator
+    InstanceIDFormatValidator,
+    WorkspaceIDFormatValidator,
+    WorkspaceNameFormatValidator,
+    TimeoutFormatValidator,
+    StorageClassValidator,
+    OptimizerInstallPlanValidator
 )
 
 from mas.devops.ocp import createNamespace, getStorageClass, getStorageClasses
@@ -116,19 +116,19 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
 
     def configICR(self):
         if self.devMode:
-            self.setParam("mas_icr_cp", "docker-na-public.artifactory.swg-devops.com/wiotp-docker-local")
-            self.setParam("mas_icr_cpopen", "docker-na-public.artifactory.swg-devops.com/wiotp-docker-local/cpopen")
-            self.setParam("sls_icr_cpopen", "docker-na-public.artifactory.swg-devops.com/wiotp-docker-local/cpopen")
+            self.setParam("mas_icr_cp", getenv("MAS_ICR_CP", "docker-na-public.artifactory.swg-devops.com/wiotp-docker-local"))
+            self.setParam("mas_icr_cpopen", getenv("MAS_ICR_CPOPEN", "docker-na-public.artifactory.swg-devops.com/wiotp-docker-local/cpopen"))
+            self.setParam("sls_icr_cpopen", getenv("SLS_ICR_CPOPEN", "docker-na-public.artifactory.swg-devops.com/wiotp-docker-local/cpopen"))
         else:
-            self.setParam("mas_icr_cp", "cp.icr.io/cp")
-            self.setParam("mas_icr_cpopen", "icr.io/cpopen")
-            self.setParam("sls_icr_cpopen", "icr.io/cpopen")
+            self.setParam("mas_icr_cp", getenv("MAS_ICR_CP", "cp.icr.io/cp"))
+            self.setParam("mas_icr_cpopen", getenv("MAS_ICR_CPOPEN", "icr.io/cpopen"))
+            self.setParam("sls_icr_cpopen", getenv("SLS_ICR_CPOPEN", "icr.io/cpopen"))
 
     def configICRCredentials(self):
         self.printH1("Configure IBM Container Registry")
         self.promptForString("IBM entitlement key", "ibm_entitlement_key", isPassword=True)
         if self.devMode:
-            self.promptForString("Artifactory username", "artifactory_username", isPassword=True)
+            self.promptForString("Artifactory username", "artifactory_username")
             self.promptForString("Artifactory token", "artifactory_token", isPassword=True)
 
     def configCertManager(self):
@@ -145,8 +145,8 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
             print(tabulate(self.installOptions, headers="keys", tablefmt="simple_grid"))
             catalogSelection = self.promptForInt("Select catalog and release", default=1)
 
-            self.setParam("mas_catalog_version", self.installOptions[catalogSelection-1]["catalog"])
-            self.setParam("mas_channel", self.installOptions[catalogSelection-1]["release"])
+            self.setParam("mas_catalog_version", self.installOptions[catalogSelection - 1]["catalog"])
+            self.setParam("mas_channel", self.installOptions[catalogSelection - 1]["release"])
 
     def configSLS(self) -> None:
         self.printH1("Configure Product License")
@@ -234,7 +234,7 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
             "By default, Maximo Application Suite is configured with guided tour, you can disable this if it not required"
         ])
         if not self.yesOrNo("Enable Guided Tour"):
-            self.setParam("mas_enable_walkme","false")
+            self.setParam("mas_enable_walkme", "false")
 
     def configMAS(self):
         self.printH1("Configure MAS Instance")
@@ -363,7 +363,7 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
             f"{self.getParam('mas_instance_id')}-cloudflare-le-stg",
             ""
         ]
-        self.setParam("mas_cluster_issuer", certIssuerOptions[certIssuer-1])
+        self.setParam("mas_cluster_issuer", certIssuerOptions[certIssuer - 1])
 
     def configDNSAndCertsCIS(self):
         self.setParam("dns_provider", "cis")
@@ -384,7 +384,7 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
             f"{self.getParam('mas_instance_id')}-cis-le-stg",
             ""
         ]
-        self.setParam("mas_cluster_issuer", certIssuerOptions[certIssuer-1])
+        self.setParam("mas_cluster_issuer", certIssuerOptions[certIssuer - 1])
 
     def configDNSAndCertsRoute53(self):
         self.setParam("dns_provider", "route53")
@@ -537,8 +537,8 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
 
     def setIoTStorageClasses(self) -> None:
         if self.installIoT:
-            self.setParam("mas_app_settings_iot_fpl_pvc_storage_class",  self.getParam("storage_class_rwo"))
-            self.setParam("mas_app_settings_iot_mqttbroker_pvc_storage_class",  self.getParam("storage_class_rwo"))
+            self.setParam("mas_app_settings_iot_fpl_pvc_storage_class", self.getParam("storage_class_rwo"))
+            self.setParam("mas_app_settings_iot_mqttbroker_pvc_storage_class", self.getParam("storage_class_rwo"))
 
     def optimizerSettings(self) -> None:
         if self.installOptimizer:
@@ -617,7 +617,7 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
         self.interactiveMode = False
 
         # Set defaults
-        self.storageClassProvider="custom"
+        self.storageClassProvider = "custom"
         self.installAssist = False
         self.installIoT = False
         self.installMonitor = False
@@ -858,9 +858,9 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
                     self.fatalError(f"{key} must be set")
                 self.pipelineStorageClass = value
             elif key == "license_file":
-                    if value is None:
-                        self.fatalError(f"{key} must be set")
-                    self.slsLicenseFileLocal = value
+                if value is None:
+                    self.fatalError(f"{key} must be set")
+                self.slsLicenseFileLocal = value
 
             elif key.startswith("approval_"):
                 if key not in self.approvals:
@@ -876,7 +876,7 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
                             self.approvals[key]["maxRetries"] = int(valueParts[1])
                             self.approvals[key]["retryDelay"] = int(valueParts[2])
                             self.approvals[key]["ignoreFailure"] = bool(valueParts[3])
-                        except:
+                        except ValueError:
                             self.fatalError(f"Unsupported format for {key} ({value}).  Expected string:int:int:boolean")
 
             # Arguments that we don't need to do anything with
@@ -965,7 +965,7 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
                 "optimizer": "8.4.10",
                 "predict": "8.8.3",
                 "inspection": "8.8.4"
-            },            
+            },
             {
                 "#": 4,
                 "catalog": "v9-240827-amd64",
@@ -1120,7 +1120,7 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
 
             with Halo(text='Validating OpenShift Pipelines installation', spinner=self.spinner) as h:
                 installOpenShiftPipelines(self.dynamicClient)
-                h.stop_and_persist(symbol=self.successIcon, text=f"OpenShift Pipelines Operator is installed and ready to use")
+                h.stop_and_persist(symbol=self.successIcon, text="OpenShift Pipelines Operator is installed and ready to use")
 
             with Halo(text=f'Preparing namespace ({pipelinesNamespace})', spinner=self.spinner) as h:
                 createNamespace(self.dynamicClient, pipelinesNamespace)
@@ -1144,9 +1144,9 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
 
                 h.stop_and_persist(symbol=self.successIcon, text=f"Namespace is ready ({pipelinesNamespace})")
 
-            with Halo(text=f'Testing availability of MAS CLI image in cluster', spinner=self.spinner) as h:
+            with Halo(text='Testing availability of MAS CLI image in cluster', spinner=self.spinner) as h:
                 testCLI()
-                h.stop_and_persist(symbol=self.successIcon, text=f"MAS CLI image deployment test completed")
+                h.stop_and_persist(symbol=self.successIcon, text="MAS CLI image deployment test completed")
 
             with Halo(text=f'Installing latest Tekton definitions (v{self.version})', spinner=self.spinner) as h:
                 updateTektonDefinitions(pipelinesNamespace, self.tektonDefsPath)