mas-cli 9.5.0__py3-none-any.whl → 10.0.0__py3-none-any.whl

mas/cli/__init__.py

@@ -8,4 +8,4 @@
 #
 # *****************************************************************************
 
-__version__ = "9.5.0"
+__version__ = "10.0.0"

mas/cli/cli.py

@@ -7,9 +7,11 @@
 # http://www.eclipse.org/legal/epl-v10.html
 #
 # *****************************************************************************
+
 from argparse import RawTextHelpFormatter
 from shutil import which
 from os import path
+from sys import exit
 
 # Use of the openshift client rather than the kubernetes client allows us access to "apply"
 from openshift import dynamic
@@ -17,62 +19,17 @@ from kubernetes import config
 from kubernetes.client import api_client
 
 from prompt_toolkit import prompt, print_formatted_text, HTML
-from prompt_toolkit.validation import Validator, ValidationError
-
-# Available named colours in prompt_toolkit
-# -----------------------------------------------------------------------------
-# AliceBlue  AntiqueWhite  Aqua  Aquamarine  Azure  Beige  Bisque  Black  BlanchedAlmond  Blue  BlueViolet
-# Brown  BurlyWood  CadetBlue  Chartreuse  Chocolate  Coral  CornflowerBlue  Cornsilk  Crimson  Cyan
-# DarkBlue  DarkCyan  DarkGoldenRod  DarkGray  DarkGreen  DarkGrey  DarkKhaki  DarkMagenta  DarkOliveGreen
-# DarkOrange  DarkOrchid  DarkRed  DarkSalmon  DarkSeaGreen  DarkSlateBlue  DarkSlateGray  DarkSlateGrey
-# DarkTurquoise  DarkViolet  DeepPink  DeepSkyBlue  DimGray  DimGrey  DodgerBlue  FireBrick  FloralWhite
-# ForestGreen  Fuchsia  Gainsboro  GhostWhite  Gold  GoldenRod  Gray  Green  GreenYellow  Grey  HoneyDew
-# HotPink  IndianRed  Indigo  Ivory  Khaki  Lavender  LavenderBlush  LawnGreen  LemonChiffon  LightBlue
-# LightCoral  LightCyan  LightGoldenRodYellow  LightGray  LightGreen  LightGrey  LightPink  LightSalmon
-# LightSeaGreen  LightSkyBlue  LightSlateGray  LightSlateGrey  LightSteelBlue  LightYellow  Lime
-# LimeGreen  Linen  Magenta  Maroon  MediumAquaMarine  MediumBlue  MediumOrchid  MediumPurple  MediumSeaGreen
-# MediumSlateBlue  MediumSpringGreen  MediumTurquoise  MediumVioletRed  MidnightBlue  MintCream  MistyRose
-# Moccasin  NavajoWhite  Navy  OldLace  Olive  OliveDrab  Orange  OrangeRed  Orchid  PaleGoldenRod  PaleGreen
-# PaleTurquoise  PaleVioletRed  PapayaWhip  PeachPuff  Peru  Pink  Plum  PowderBlue  Purple  RebeccaPurple
-# Red  RosyBrown  RoyalBlue  SaddleBrown  Salmon  SandyBrown  SeaGreen  SeaShell  Sienna  Silver  SkyBlue
-# SlateBlue  SlateGray  SlateGrey  Snow  SpringGreen  SteelBlue  Tan  Teal  Thistle  Tomato  Turquoise
-# Violet  Wheat  White  WhiteSmoke  Yellow  YellowGreen
-
-from mas.cli import __version__ as packageVersion
-from mas.devops.ocp import connect
-from mas.devops.mas import verifyMasInstance
 
-from sys import exit
+from .validators import YesNoValidator
 
-import logging
+from . import __version__ as packageVersion
+from .displayMixins import PrintMixin, PromptMixin
+from mas.devops.ocp import connect, isSNO
 
+import logging
 logger = logging.getLogger(__name__)
 
 
-class InstanceIDValidator(Validator):
-    def validate(self, document):
-        """
-        Validate that a MAS instance ID exists on the target cluster
-        """
-        instanceId = document.text
-
-        dynClient = dynamic.DynamicClient(
-            api_client.ApiClient(configuration=config.load_kube_config())
-        )
-        if not verifyMasInstance(dynClient, instanceId):
-            raise ValidationError(message='Not a valid MAS instance ID on this cluster', cursor_position=len(instanceId))
-
-
-class YesNoValidator(Validator):
-    def validate(self, document):
-        """
-        Validate that a response is understandable as a yes/no response
-        """
-        response = document.text
-        if response.lower() not in ["y", "n", "yes", "no"]:
-            raise ValidationError(message='Enter a valid response: y(es), n(o)', cursor_position=len(response))
-
-
 def getHelpFormatter(formatter=RawTextHelpFormatter, w=160, h=50):
     """
     Return a wider HelpFormatter, if possible.
@@ -88,7 +45,7 @@ def getHelpFormatter(formatter=RawTextHelpFormatter, w=160, h=50):
         return formatter
 
 
-class BaseApp(object):
+class BaseApp(PrintMixin, PromptMixin):
     def __init__(self):
         # Set up a log formatter
         chFormatter = logging.Formatter('%(asctime)-25s' + ' %(levelname)-8s %(message)s')
@@ -107,9 +64,48 @@ class BaseApp(object):
 
         self.version = packageVersion
         self.h1count = 0
-
-        self.tektonDefsPath = path.join(path.abspath(path.dirname(__file__)), "templates", "ibm-mas-tekton.yaml")
-        print(self.tektonDefsPath)
+        self.h2count = 0
+
+        self.localConfigDir = None
+        self.templatesDir = path.join(path.abspath(path.dirname(__file__)), "templates")
+        self.tektonDefsPath = path.join(self.templatesDir, "ibm-mas-tekton.yaml")
+
+        # These dicts will hold the additional-configs and pod-templates secrets
+        self.additionalConfigsSecret = None
+        self.podTemplatesSecret = None
+
+        self._isSNO = None
+
+        self.compatibilityMatrix = {
+            "9.0.x": {
+                "assist": ["9.0.x", "8.8.x"],
+                "iot": ["9.0.x", "8.8.x"],
+                "manage": ["9.0.x", "8.7.x"],
+                "monitor": ["9.0.x", "8.11.x"],
+                "optimizer": ["9.0.x", "8.5.x"],
+                "predict": ["9.0.x", "8.9.x"],
+                "visualinspection": ["9.0.x", "8.9.x"]
+            },
+            "8.11.x": {
+                "assist": ["8.8.x", "8.7.x"],
+                "iot": ["8.8.x", "8.7.x"],
+                "manage": ["8.7.x", "8.6.x"],
+                "monitor": ["8.11.x", "8.10.x"],
+                "optimizer": ["8.5.x", "8.4.x"],
+                "predict": ["8.9.x", "8.8.x"],
+                "visualinspection": ["8.9.x", "8.8.x"]
+            },
+            "8.10.x": {
+                "assist": ["8.7.x", "8.6.x"],
+                "hputilities": ["8.6.x", "8.5.x"],
+                "iot": ["8.7.x", "8.6.x"],
+                "manage": ["8.6.x", "8.5.x"],
+                "monitor": ["8.10.x", "8.9.x"],
+                "optimizer": ["8.4.x", "8.3.x"],
+                "predict": ["8.8.x", "8.7.x"],
+                "visualinspection": ["8.8.x", "8.7.x"]
+            }
+        }
 
         self.spinner = {
             "interval": 80,
@@ -120,21 +116,42 @@ class BaseApp(object):
 
         self._dynClient = None
 
-        self.printTitle(f"IBM Maximo Application Suite Admin CLI v{self.version}")
-        print_formatted_text(HTML("Powered by <DarkGoldenRod><u>https://github.com/ibm-mas/ansible-devops/</u></DarkGoldenRod> and <DarkGoldenRod><u>https://tekton.dev/</u></DarkGoldenRod>"))
-
+        self.printTitle(f"\nIBM Maximo Application Suite Admin CLI v{self.version}")
+        print_formatted_text(HTML("Powered by <DarkGoldenRod><u>https://github.com/ibm-mas/ansible-devops/</u></DarkGoldenRod> and <DarkGoldenRod><u>https://tekton.dev/</u></DarkGoldenRod>\n"))
         if which("kubectl") is None:
             logger.error("Could not find kubectl on the path")
             print_formatted_text(HTML("\n<Red>Error: Could not find kubectl on the path, see <u>https://kubernetes.io/docs/tasks/tools/#kubectl</u> for installation instructions</Red>\n"))
             exit(1)
 
-    def printTitle(self, message):
-        print_formatted_text(HTML(f"<b><u>{message}</u></b>"))
+    def getCompatibleVersions(self, coreChannel: str, appId: str) -> list:
+        if coreChannel in self.compatibilityMatrix:
+            return self.compatibilityMatrix[coreChannel][appId]
+        else:
+            return []
 
-    def printH1(self, message):
-        self.h1count += 1
-        print()
-        print_formatted_text(HTML(f"<u><SteelBlue>{self.h1count}. {message}</SteelBlue></u>"))
+    def fatalError(self, message: str, exception: Exception=None) -> None:
+        if exception is not None:
+            print_formatted_text(HTML(f"<Red>Fatal Exception: {message.replace(' & ', ' &amp; ')}: {exception}</Red>"))
+        else:
+            print_formatted_text(HTML(f"<Red>Fatal Error: {message.replace(' & ', ' &amp; ')}</Red>"))
+        exit(1)
+
+    def isSNO(self):
+        if self._isSNO is None:
+            self._isSNO = isSNO(self.dynamicClient)
+        return self._isSNO
+
+    def setParam(self, param: str, value: str):
+        self.params[param] = value
+
+    def getParam(self, param: str):
+        """
+        Returns the value of a parameter, or an empty string is the parameter has not set at all or is set to None
+        """
+        if param in self.params and self.params[param] is not None:
+            return self.params[param]
+        else:
+            return ""
 
     @property
     def dynamicClient(self):
@@ -158,7 +175,7 @@ class BaseApp(object):
             logger.warning(f"Error: Unable to connect to OpenShift Container Platform: {e}")
             return None
 
-    def connect(self, noConfirm):
+    def connect(self):
         promptForNewServer = False
         self.reloadDynamicClient()
         if self._dynClient is not None:
@@ -167,7 +184,7 @@ class BaseApp(object):
                 consoleRoute = routesAPI.get(name="console", namespace="openshift-console")
                 print_formatted_text(HTML(f"Already connected to OCP Cluster:\n <u><Orange>https://{consoleRoute.spec.host}</Orange></u>"))
                 print()
-                if not noConfirm:
+                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"]

mas/cli/displayMixins.py

@@ -0,0 +1,110 @@
+# *****************************************************************************
+# Copyright (c) 2024 IBM Corporation and other Contributors.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+#
+# *****************************************************************************
+
+from os import path, getenv
+from prompt_toolkit import prompt, print_formatted_text, HTML
+from prompt_toolkit.validation import Validator
+
+from .validators import YesNoValidator, FileExistsValidator, DirectoryExistsValidator
+
+import logging
+logger = logging.getLogger(__name__)
+
+H1COLOR="SkyBlue"
+H2COLOR="SkyBlue"
+DESCRIPTIONCOLOR="LightSlateGrey"
+SUMMARYCOLOR="SkyBlue"
+UNDEFINEDPARAMCOLOR="LightSlateGrey"
+PROMPTCOLOR="Yellow"
+
+class PrintMixin():
+    def printTitle(self, message):
+        print_formatted_text(HTML(f"<b><u>{message.replace(' & ', ' &amp; ')}</u></b>"))
+
+    def printH1(self, message):
+        self.h1count += 1
+        self.h2count = 0
+        print()
+        print_formatted_text(HTML(f"<u><{H1COLOR}>{self.h1count}) {message.replace(' & ', ' &amp; ')}</{H1COLOR}></u>"))
+
+    def printH2(self, message):
+        self.h2count += 1
+        print()
+        print_formatted_text(HTML(f"<u><{H2COLOR}>{self.h1count}.{self.h2count}) {message.replace(' & ', ' &amp; ')}</{H2COLOR}></u>"))
+
+    def printDescription(self, content: list) -> None:
+        content[0] = f"<{DESCRIPTIONCOLOR}>{content[0]}"
+        content[len(content) - 1] = f"{content[len(content) - 1]}</{DESCRIPTIONCOLOR}>"
+        print_formatted_text(HTML("\n".join(content)))
+
+    def printSummary(self, title: str, value: str) -> None:
+        titleLength = len(title)
+        message = f"{title} {'.' * (40 - titleLength)} {value}"
+        print_formatted_text(HTML(f"  <{SUMMARYCOLOR}>{message.replace(' & ', ' &amp; ')}</{SUMMARYCOLOR}>"))
+
+    def printParamSummary(self, message: str, param: str) -> None:
+        if self.getParam(param) is None:
+            self.printSummary(message, f"<{UNDEFINEDPARAMCOLOR}>Undefined</{UNDEFINEDPARAMCOLOR}>")
+        elif self.getParam(param) == "":
+            self.printSummary(message, f"<{UNDEFINEDPARAMCOLOR}>Default</{UNDEFINEDPARAMCOLOR}>")
+        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:
+        response = prompt(masPromptYesOrNo(message), validator=YesNoValidator(), validate_while_typing=False)
+        responseAsBool = response.lower() in ["y", "yes"]
+        if param is not None:
+            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) -> str:
+        if param is not None and default == "":
+            default = getenv(param.upper(), default="")
+
+        response = prompt(masPromptValue(message), is_password=isPassword, default=default, validator=validator, validate_while_typing=False)
+        if param is not None:
+            self.params[param] = response
+        return response
+
+    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)
+
+        if default is None:
+            response = int(prompt(masPromptValue(message)))
+        else:
+            response = int(prompt(masPromptValue(message), default=str(default)))
+        if param is not None:
+            self.params[param] = str(response)
+        return response
+
+    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])
+
+    def promptForFile(self, message: str, mustExist: bool=True, default: str="") -> None:
+        if mustExist:
+            return prompt(masPromptValue(message), validator=FileExistsValidator(), validate_while_typing=False, default=default)
+        else:
+            return prompt(masPromptValue(message), default=default)
+
+    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:
+            return prompt(masPromptValue(message), default=default)

mas/cli/gencfg.py

@@ -0,0 +1,65 @@
+# *****************************************************************************
+# Copyright (c) 2024 IBM Corporation and other Contributors.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+#
+# *****************************************************************************
+
+from os import path
+from jinja2 import Template
+
+class ConfigGeneratorMixin():
+    def generateJDBCCfg(
+            self,
+            instanceId: str,
+            scope: str,
+            destination: str,
+            appId: str="",
+            workspaceId: str="") -> None:
+
+        templateFile = path.join(self.templatesDir, "jdbccfg.yml.j2")
+        with open(templateFile) as tFile:
+            template = Template(tFile.read())
+
+        if scope == "workspace-application":
+            assert appId != ""
+            assert workspaceId != ""
+
+        name = self.promptForString("Configuration Display Name")
+        url = self.promptForString("JDBC Connection String")
+
+        username = self.promptForString("JDBC Username")
+        password = self.promptForString("JDBC Password", isPassword=True)
+
+        sslEnabled = self.yesOrNo("Enable SSL Connection")
+
+        if sslEnabled:
+            sslCertFile = self.promptForFile("Path to certificate file")
+            with open(sslCertFile) as cFile:
+                certLocalFileContent = cFile.read()
+        else:
+            certLocalFileContent = ""
+
+        cfg = template.render(
+            scope=scope,
+
+            mas_instance_id=instanceId,
+            mas_workspace_id=workspaceId,
+            mas_application_id=appId,
+
+            cfg_display_name=name,
+
+            jdbc_url=url,
+            jdbc_username=username,
+            jdbc_password=password,
+
+            jdbc_ssl_enabled=sslEnabled,
+            jdbc_cert_local_file_content=certLocalFileContent
+        )
+
+        with open(destination, 'w') as f:
+            f.write(cfg)
+            f.write('\n')

mas/cli/install/__init__.py

@@ -0,0 +1,9 @@
+# *****************************************************************************
+# Copyright (c) 2024 IBM Corporation and other Contributors.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+#
+# *****************************************************************************