Merge remote-tracking branch 'origin/master' into rust

Author: Tom-Willemsen

installation_and_upgrade/ibex_install_utils/admin_runner.py

@@ -7,6 +7,8 @@
 from time import sleep
 from typing import Any, Generator
 
+from ibex_install_utils.logger import temporarily_disable_logging
+
 # Plink is an SSH binary bundled with putty.
 # Use Plink as it allows passwords on the command-line, as opposed to
 # windows-bundled SSH which does not.
@@ -30,8 +32,9 @@ class AdminRunner:
     def _auth_ssh(cls) -> None:
         if not cls._ssh_authenticated:
             while True:
-                cls._ssh_user = input("Enter admin username (without domain): ")
-                cls._ssh_password = getpass.getpass("Enter admin password: ")
+                with temporarily_disable_logging():
+                    cls._ssh_user = input("Enter admin username (without domain): ")
+                    cls._ssh_password = getpass.getpass("Enter admin password: ")
 
                 assert cls._ssh_user is not None
                 assert cls._ssh_password is not None

installation_and_upgrade/ibex_install_utils/logger.py

@@ -1,40 +1,61 @@
 import os
 import sys
 import time
+from contextlib import contextmanager
+from typing import Generator
+
+ENABLE_LOGGING = True
+
+
+@contextmanager
+def temporarily_disable_logging() -> Generator[None, None, None]:
+    global ENABLE_LOGGING
+    previous_logging_enabled = ENABLE_LOGGING
+    ENABLE_LOGGING = False
+    try:
+        yield
+    finally:
+        ENABLE_LOGGING = previous_logging_enabled
 
 
 class Logger:
     """
     Logger class used to capture output and input to a log file.
     """
 
-    def __init__(self):
-        CURRENT_DATE = time.strftime("%Y%m%d")
-        LOG_FILE = f"DEPLOY-{CURRENT_DATE}.log"
-        LOG_DIRECTORY = os.path.join("C:\\", "Instrument", "var", "logs", "deploy")
-        os.makedirs(LOG_DIRECTORY, exist_ok=True)
-        LOG_PATH = os.path.join(LOG_DIRECTORY, LOG_FILE)
+    def __init__(self) -> None:
+        current_date = time.strftime("%Y%m%d")
+        log_file = f"DEPLOY-{current_date}.log"
+        log_directory = os.path.join("C:\\", "Instrument", "var", "logs", "deploy")
+        os.makedirs(log_directory, exist_ok=True)
+        log_path = os.path.join(log_directory, log_file)
 
         self.console = sys.stdout
         self.input = sys.stdin
-        self.log = open(LOG_PATH, "a")
-        print(f"Log file is {LOG_PATH}")
-
-    def write(self, message):
-        self.log.write(message)
+        self.log = open(log_path, "a")
+        print(f"Log file is {log_path}")
+
+    def write(self, message: str) -> int:
+        if ENABLE_LOGGING:
+            self.log.write(message)
+        else:
+            self.log.write("[concealed]\n")
         return self.console.write(message)
 
-    def flush(self):
+    def flush(self) -> None:
         self.console.flush()
         self.log.flush()
 
-    def readline(self):
+    def readline(self) -> str:
         text = self.input.readline()
-        self.log.write(text)
+        if ENABLE_LOGGING:
+            self.log.write(text)
+        else:
+            self.log.write("[concealed]\n")
         return text
 
     @staticmethod
-    def set_up():
+    def set_up() -> None:
         logger = Logger()
         sys.stdout = logger
         sys.stderr = logger

installation_and_upgrade/ibex_install_utils/tasks/mysql_tasks.py

@@ -8,6 +8,7 @@
 
 from ibex_install_utils.admin_runner import AdminCommandBuilder
 from ibex_install_utils.exceptions import ErrorInRun
+from ibex_install_utils.logger import temporarily_disable_logging
 from ibex_install_utils.run_process import RunProcess
 from ibex_install_utils.software_dependency.mysql import MySQL
 from ibex_install_utils.task import task
@@ -217,12 +218,13 @@ def _setup_database_users_and_tables(self, vhd_install: bool = True) -> None:
         sql_password = ""
         retry_count = 5
         while --retry_count > 0:
-            sql_password = self.prompt.prompt(
-                "Enter the MySQL root password:",
-                UserPrompt.ANY,
-                os.getenv("MYSQL_PASSWORD", "environment variable not set"),
-                show_automatic_answer=False,
-            ).strip()
+            with temporarily_disable_logging():
+                sql_password = self.prompt.prompt(
+                    "Enter the MySQL root password:",
+                    UserPrompt.ANY,
+                    os.getenv("MYSQL_PASSWORD", "environment variable not set"),
+                    show_automatic_answer=False,
+                ).strip()
             if len(sql_password) > 0:
                 break
             print("Please enter a non blank password")

installation_and_upgrade/ibex_install_utils/tasks/server_tasks.py

@@ -369,9 +369,7 @@ def update_calibrations_repository(self) -> None:
     @task("Server release tests")
     def perform_server_tests(self) -> None:
         """Test that the server works"""
-        server_release_tests_url = (
-            "https://github.com/ISISComputingGroup/ibex_developers_manual/wiki/Server-Release-Tests"
-        )
+        server_release_tests_url = "https://isiscomputinggroup.github.io/ibex_developers_manual/deployment/deploy/Server-Release-Tests.html"
 
         print(f"For further details, see {server_release_tests_url}")
         self.prompt.prompt_and_raise_if_not_yes("Check that blocks are logging as expected")

installation_and_upgrade/ibex_install_utils/tasks/system_tasks.py

@@ -247,7 +247,9 @@ def inform_instrument_scientists(self) -> None:
         email_template = f"""Please send the following email to your instrument scientists:
                     Hello,
                     We have finished the upgrade of {BaseTasks._get_machine_name()} to IBEX {ibex_version}.
-                    The release notes for this are at the following link: https://github.com/ISISComputingGroup/IBEX/wiki/Release-Notes-v{ibex_version}
+                    The relevant release notes can be found at the following links:
+                       * https://github.com/ISISComputingGroup/IBEX/blob/master/release_notes/Release-Notes-v{ibex_version}.md
+                       * https://github.com/ISISComputingGroup/IBEX/blob/master/release_notes/Release-Notes-v<INSERT PREVIOUS IBEX VERSION HERE>.md
 
                     Please let us know if you have any queries or find any problems with the upgrade.
                     Thank you,