Add update command and status check to CLI; enhance Director for update messaging

Author: grongierisc

CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Add `iop --update` command to update a production from the command line
+- New info displayed in `iop --help` command showing current namespace
+- `iop --status` command now shows if production needs update, if so a message is displayed
+
 ### Fixed
 - Fix issue with boolean `response_required` parameter in `send_request_async` method of BusinessProcess
   - Now converts boolean to integer (1 or 0) to ensure compatibility with IRIS API

src/iop/_cli.py

@@ -28,6 +28,7 @@ class CommandType(Enum):
     LOG = auto()
     INIT = auto()
     HELP = auto()
+    UPDATE = auto()
 
 @dataclass
 class CommandArgs:
@@ -50,6 +51,7 @@ class CommandArgs:
     body: Optional[str] = None
     namespace: Optional[str] = None
     force_local: bool = False
+    update: bool = False
 
 class Command:
     def __init__(self, args: CommandArgs):
@@ -75,7 +77,8 @@ def execute(self) -> None:
             CommandType.MIGRATE: self._handle_migrate,
             CommandType.LOG: self._handle_log,
             CommandType.INIT: self._handle_init,
-            CommandType.HELP: self._handle_help
+            CommandType.HELP: self._handle_help,
+            CommandType.UPDATE: self._handle_update,
         }
         handler = command_handlers.get(command_type)
         if handler:
@@ -95,6 +98,7 @@ def _determine_command_type(self) -> CommandType:
         if self.args.migrate: return CommandType.MIGRATE
         if self.args.log: return CommandType.LOG
         if self.args.init: return CommandType.INIT
+        if self.args.update: return CommandType.UPDATE
         return CommandType.HELP
 
     def _handle_default(self) -> None:
@@ -128,6 +132,9 @@ def _handle_restart(self) -> None:
     def _handle_status(self) -> None:
         print(json.dumps(_Director.status_production(), indent=4))
 
+    def _handle_update(self) -> None:
+        _Director.update_production()
+
     def _handle_test(self) -> None:
         test_name = None if self.args.test == 'not_set' else self.args.test
         response = _Director.test_component(
@@ -164,6 +171,7 @@ def _handle_help(self) -> None:
         create_parser().print_help()
         try:
             print(f"\nDefault production: {_Director.get_default_production()}")
+            print(f"\nNamespace: {os.getenv('IRISNAMESPACE','not set')}")
         except Exception:
             logging.warning("Could not retrieve default production.")
 
@@ -186,6 +194,7 @@ def create_parser() -> argparse.ArgumentParser:
     parser.add_argument('-L', '--log', help='display log', nargs='?', const='not_set')
     parser.add_argument('-i', '--init', help='init the pex module in iris', nargs='?', const='not_set')
     parser.add_argument('-t', '--test', help='test the pex module in iris', nargs='?', const='not_set')
+    parser.add_argument('-u', '--update', help='update a production', action='store_true')
 
     # Command groups
     start = main_parser.add_argument_group('start arguments')

src/iop/cls/IOP/Director.cls

@@ -56,6 +56,14 @@ ClassMethod StatusProduction() As %String
 												$$$eProductionStateSuspended:"suspended",
 												$$$eProductionStateTroubled:"toubled",
 												:"unknown"))
+	// Get if production needs update
+	set tNeedsUpdate = ##class(Ens.Director).ProductionNeedsUpdate(.tMsgUpdate)
+	do tInfo."__setitem__"("NeedsUpdate",tNeedsUpdate)
+	// If needs update get message
+	if tNeedsUpdate {
+		do tInfo."__setitem__"("UpdateMessage",tMsgUpdate)
+	}
+	// Get last start time
 	Return tInfo
 }
 

src/tests/test_cli.py

@@ -17,9 +17,11 @@ def test_help_and_basic_commands(self):
         self.assertEqual(cm.exception.code, 0)
 
         # Test without arguments
-        with self.assertRaises(SystemExit) as cm:
-            main([])
-        self.assertEqual(cm.exception.code, 0)
+        with patch('sys.stdout', new=StringIO()) as fake_out:
+            with self.assertRaises(SystemExit) as cm:
+                main([])
+            self.assertEqual(cm.exception.code, 0)
+            self.assertIn('Namespace:', fake_out.getvalue())
 
     def test_default_settings(self):
         """Test default production settings."""
@@ -95,6 +97,25 @@ def test_migration(self):
             self.assertEqual(cm.exception.code, 0)
             mock_migrate.assert_called_once_with('/tmp/settings.json', force_local=True)
 
+    def test_status_and_update(self):
+        """Test status and update commands."""
+        # Test status
+        with patch('iop._director._Director.status_production') as mock_status:
+            mock_status.return_value = {"Production": "TestProd", "Status": "running"}
+            with patch('sys.stdout', new=StringIO()) as fake_out:
+                with self.assertRaises(SystemExit) as cm:
+                    main(['--status'])
+                self.assertEqual(cm.exception.code, 0)
+                mock_status.assert_called_once()
+                self.assertIn('"Production": "TestProd"', fake_out.getvalue())
+
+        # Test update
+        with patch('iop._director._Director.update_production') as mock_update:
+            with self.assertRaises(SystemExit) as cm:
+                main(['--update'])
+            self.assertEqual(cm.exception.code, 0)
+            mock_update.assert_called_once()
+
     def test_initialization(self):
         """Test initialization command."""
         with patch('iop._utils._Utils.setup') as mock_setup:

src/tests/test_director.py

@@ -123,6 +123,17 @@ def test_status_production(self):
         result = _Director.status_production()
         assert result == mock_status
 
+    def test_status_production_needs_update(self):
+        mock_status = {
+            'Production': 'test_prod', 
+            'Status': 'running',
+            'NeedsUpdate': True,
+            'UpdateMessage': 'Update available'
+        }
+        iris.cls('IOP.Director').StatusProduction = MagicMock(return_value=mock_status)
+        result = _Director.status_production()
+        assert result == mock_status
+
 class TestLogging:
     def test_format_log(self):
         test_row = [1, 'Config1', 'Job1', 'Msg1', 'Session1', 'Source1', 'Method1', 

src/tests/test_utils.py

@@ -140,3 +140,61 @@ def test_register_schema(self):
         with patch('iris.cls') as mock_cls:
             _Utils.register_schema("test.schema", "{}", "test")
             mock_cls.return_value.Import.assert_called_once()
+
+
+class TestRemoteMigration:
+    @patch('requests.put')
+    @patch('iop._utils._Utils._load_settings')
+    @patch('os.walk')
+    def test_migrate_remote_verify_ssl_true(self, mock_walk, mock_load_settings, mock_put):
+        # Setup mocks
+        mock_load_settings.return_value = (
+            MagicMock(
+                REMOTE_SETTINGS = {
+                    'url': 'http://test.com',
+                    'verify_ssl': True,
+                    'username': 'user',
+                    'password': 'password',
+                    'namespace': 'USER',
+                    'remote_folder': '/remote'
+                }
+            ), 
+            '/path/to/sys'
+        )
+        mock_walk.return_value = [] # No files
+        mock_put.return_value.status_code = 200
+        mock_put.return_value.text = '{"status": "OK"}'
+        
+        # Run
+        _Utils.migrate_remote('settings.py')
+        
+        # Assert verify=True
+        mock_put.assert_called_once()
+        assert mock_put.call_args[1]['verify'] == True
+
+    @patch('requests.put')
+    @patch('iop._utils._Utils._load_settings')
+    @patch('os.walk')
+    def test_migrate_remote_verify_ssl_false(self, mock_walk, mock_load_settings, mock_put):
+        # Setup mocks
+        mock_load_settings.return_value = (
+            MagicMock(
+                REMOTE_SETTINGS = {
+                    'url': 'http://test.com',
+                    'verify_ssl': False,
+                    'username': 'user',
+                    'password': 'password'
+                }
+            ), 
+            '/path/to/sys'
+        )
+        mock_walk.return_value = []
+        mock_put.return_value.status_code = 200
+        mock_put.return_value.text = '{"status": "OK"}'
+        
+        # Run
+        _Utils.migrate_remote('settings.py')
+        
+        # Assert verify=False
+        mock_put.assert_called_once()
+        assert mock_put.call_args[1]['verify'] == False