Add active, write_to_console, pause, and resume actions for mp.logger.manager.

And clean up handling of default arguments for mp.logger constructor.

Author: rdzman

CHANGES.md

@@ -5,7 +5,7 @@ Change history for MP-Test
 since 8.1
 ---------
 
-#### 7/23/26
+#### 7/30/26
   - Use recently added `mp_printf()` in place of `fprintf()` everywhere to
     allow redirecting of console output.
   - Add `mp.logger` class, and `mp_printf()` and `mp_disp()` functions

lib/+mp/logger.m

@@ -104,16 +104,16 @@
 
             %% set default inputs
             default_log_file_name = 'mp.logger_log.txt';
-            if nargin < 4
+            if nargin < 4 || isempty(write_to_console)
                 write_to_console = false;
-                if nargin < 3
-                    permission = 'a';
-                end
             end
-            if nargin < 2 || isempty(log_file_path)
-                log_file_path = '.';
+            if nargin < 3 || isempty(permission)
+                permission = 'a';
+            end
+            if nargin < 2
+                log_file_path = '';
             end
-            if exist(log_file_path, 'dir')
+            if isempty(log_file_path) || exist(log_file_path, 'dir')
                 log_file_path = fullfile(log_file_path, default_log_file_name);
             end
 
@@ -231,15 +231,24 @@
             %   mp.logger.manager('init', log_file_path, permission, write_to_console);
             %   logger = mp.logger.manager('get');
             %   log_file_path = mp.logger.manager('path');
+            %   TorF = mp.logger.manager('write_to_console');
+            %   TorF = mp.logger.manager('active');
+            %   mp.logger.manager('pause');
+            %   mp.logger.manager('resume');
             %   mp.logger.manager('clear');
             %
             % Inputs:
             %   action (char array) : one of:
             %
             %       - ``'init'`` - initialize logger object, after clearing any
             %         existing one
+            %       - ``'active'`` - return true if a logger is active
             %       - ``'get'`` - retreive logger object
             %       - ``'clear'`` - clear logger object
+            %       - ``'write_to_console'`` - return true if logger writes
+            %         to console in addition to logging to file
+            %       - ``'pause'`` - pause (temporarily disable) logger
+            %       - ``'resume'`` - resume (re-enable) paused logger
             %       - ``<other>`` - any other action, along with subsequent
             %         input arguments is passed to the manage() method of the
             %         logger object
@@ -260,9 +269,12 @@
             %       manage() method determines the number and content of output
             %       arguments
 
-            persistent logger;      %% logger object (or empty)
+            persistent logger;          %% logger object (or empty)
+            persistent logger_paused;   %% inactive (paused) logger object (or empty)
 
             switch lower(action)
+            case 'active'
+                [varargout{1:nargout}] = ~isempty(logger);
             case 'get'
                 [varargout{1:nargout}] = logger;
             case 'init'
@@ -281,6 +293,32 @@
                     logger.finalize();
                     logger = [];
                 end
+                if ~isempty(logger_paused)
+                    logger_paused.finalize();
+                    logger_paused = [];
+                end
+            case 'write_to_console'
+                if ~isempty(logger)
+                    if length(varargin) > 0
+                        logger.write_to_console = varargin{1} ~= 0;
+                    else
+                        [varargout{1:nargout}] = logger.write_to_console;
+                    end
+                else
+                    if length(varargin) == 0
+                        [varargout{1:nargout}] = true;
+                    end
+                end
+            case 'pause'
+                if ~isempty(logger) && isempty(logger_paused)
+                    logger_paused = logger;
+                    logger = [];
+                end
+            case 'resume'
+                if ~isempty(logger_paused) && isempty(logger)
+                    logger = logger_paused;
+                    logger_paused = [];
+                end
             otherwise
                 if isempty(logger)
                     [varargout{1:nargout}] = [];

lib/mptestver.m

@@ -22,9 +22,9 @@
 %   See https://github.com/MATPOWER/mptest for more info.
 
 v = struct( 'Name',     'MP-Test', ... 
-            'Version',  '8.1+', ...
+            'Version',  '8.2-dev', ...
             'Release',  '', ...
-            'Date',     '23-Jul-2026' );
+            'Date',     '30-Jul-2026' );
 if nargout > 0
     if nargin > 0
         rv = v;

lib/t/t_mp_logger.m

@@ -17,7 +17,7 @@ function t_mp_logger(quiet)
     quiet = 0;
 end
 
-n_tests = 20;
+n_tests = 44;
 
 t_begin(n_tests, quiet);
 
@@ -37,6 +37,8 @@ function t_mp_logger(quiet)
 
     %% no redirection
     t = 'no redirection : ';
+    t_ok(~mp.logger.manager('active'), [t 'not active']);
+    t_ok(mp.logger.manager('write_to_console'), [t 'write_to_console']);
     fname_got = mp.logger.manager('path');
     t_ok(isempty(fname_got), [t 'log file path (empty)']);
     c = evalc('mp_disp(sprintf(''This is %d\nlines of\ntext (%s).\n'', 3, ''I think'')); mp_disp(exp(1));');
@@ -62,21 +64,29 @@ function t_mp_logger(quiet)
     t = 'redirect to file : ';
     fname = sprintf('redir-disp-%d.txt', fix(rand*1e8));
     mp.logger.manager('init', fname);
+    active = mp.logger.manager('active');
+    write_to_console = mp.logger.manager('write_to_console');
     mp_disp(exp(1));
     c = evalc('mp_disp(sprintf(''This is %d\nlines of\ntext (%s).\n'', 3, ''I think''));');
     fname_got = mp.logger.manager('path');
     mp.logger.manager('clear', fname);
+    t_ok(active, [t 'active']);
+    t_ok(~write_to_console, [t 'not write_to_console']);
     t_str_match(fname_got, fname, [t 'log file path']);
     t_file_match(fname, redir_disp_fname, [t 'mp_disp - file w/expected content'], {}, true);
     t_ok(isempty(c), [t 'mp_disp - no console output']);
     t_ok(isempty(mp.logger.manager('get')), [t 'mp.logger.manage(''clear'')']);
 
     fname = sprintf('redir-printf-%d.txt', fix(rand*1e8));
     mp.logger.manager('init', fname);
+    active = mp.logger.manager('active');
+    write_to_console = mp.logger.manager('write_to_console');
     mp_printf('This is %d\nlines of\ntext (%s).\n', 3, 'I think');
     c = evalc('mp_printf(''Hello %s!\n\n'', ''mp_printf'');');
     fname_got = mp.logger.manager('path');
     mp.logger.manager('clear', fname);
+    t_ok(active, [t 'active']);
+    t_ok(~write_to_console, [t 'not write_to_console']);
     t_str_match(fname_got, fname, [t 'log file path']);
     t_file_match(fname, redir_printf_fname, [t 'mp_printf - file w/expected content'], {}, true);
     t_ok(isempty(c), [t 'mp_printf - no console output']);
@@ -86,6 +96,8 @@ function t_mp_logger(quiet)
     t = 'both : ';
     fname = sprintf('redir-disp-%d.txt', fix(rand*1e8));
     mp.logger.manager('init', fname, 'a', 1);
+    active = mp.logger.manager('active');
+    write_to_console = mp.logger.manager('write_to_console');
     c = evalc('mp_disp(exp(1)); mp_disp(sprintf(''This is %d\nlines of\ntext (%s).\n'', 3, ''I think''));');
     if have_feature('octave')
         if have_feature('octave', 'vnum') < 6
@@ -98,6 +110,8 @@ function t_mp_logger(quiet)
     end
     fname_got = mp.logger.manager('path');
     mp.logger.manager('clear', fname);
+    t_ok(active, [t 'active']);
+    t_ok(write_to_console, [t 'write_to_console']);
     t_str_match(fname_got, fname, [t 'log file path']);
     t_file_match(fname, redir_disp_fname, [t 'mp_disp - file w/expected content'], {}, true);
     if ~t_str_match(c, expected, [t 'mp_disp - outputs to console']);
@@ -108,17 +122,56 @@ function t_mp_logger(quiet)
 
     fname = sprintf('redir-printf-%d.txt', fix(rand*1e8));
     mp.logger.manager('init', fname, 'w', 1);
+    active = mp.logger.manager('active');
+    write_to_console = mp.logger.manager('write_to_console');
     c = evalc(' mp_printf(''This is %d\nlines of\ntext (%s).\n'', 3, ''I think''); mp_printf(''Hello %s!\n\n'', ''mp_printf'');');
     expected = sprintf('This is 3\nlines of\ntext (I think).\nHello mp_printf!\n\n');
     fname_got = mp.logger.manager('path');
     mp.logger.manager('clear', fname);
+    t_ok(active, [t 'active']);
+    t_ok(write_to_console, [t 'write_to_console']);
     t_str_match(fname_got, fname, [t 'log file path']);
     t_file_match(fname, redir_printf_fname, [t 'mp_printf - file w/expected content'], {}, true);
     t_str_match(c, expected, [t 'mp_printf - outputs to console']);
     t_ok(isempty(mp.logger.manager('get')), [t 'mp.logger.manage(''clear'')']);
+    t_ok(~mp.logger.manager('active'), [t 'not active']);
+    t_ok(mp.logger.manager('write_to_console'), [t 'write_to_console']);
 
     fname_got = mp.logger.manager('path');
     t_ok(isempty(fname_got), [t 'log file path (empty)']);
+
+    %% pause
+    t = 'pause : ';
+    fname = sprintf('redir-printf-%d.txt', fix(rand*1e8));
+    mp.logger.manager('init', fname);
+    active = mp.logger.manager('active');
+    write_to_console = mp.logger.manager('write_to_console');
+    mp.logger.manager('pause');
+    t_ok(active, [t 'active (before pause)']);
+    t_ok(~write_to_console, [t 'not write_to_console (before pause)']);
+    t_ok(~mp.logger.manager('active'), [t 'not active']);
+    t_ok(mp.logger.manager('write_to_console'), [t 'write_to_console']);
+    fname_got = mp.logger.manager('path');
+    t_ok(isempty(fname_got), [t 'log file path (empty)']);
+    c = evalc('mp_printf(''Hello %s!\n\n'', ''mp_printf''); mp_printf(''This is %d\nlines of\ntext (%s).\n'', 3, ''I think'');');
+    expected = sprintf('Hello mp_printf!\n\nThis is 3\nlines of\ntext (I think).\n');
+    t_str_match(c, expected, [t 'mp_printf - outputs to console']);
+
+    %% resume
+    t = 'resume : ';
+    mp.logger.manager('resume');
+    active = mp.logger.manager('active');
+    write_to_console = mp.logger.manager('write_to_console');
+    mp_printf('This is %d\nlines of\ntext (%s).\n', 3, 'I think');
+    c = evalc('mp_printf(''Hello %s!\n\n'', ''mp_printf'');');
+    fname_got = mp.logger.manager('path');
+    mp.logger.manager('clear', fname);
+    t_ok(active, [t 'active']);
+    t_ok(~write_to_console, [t 'not write_to_console']);
+    t_str_match(fname_got, fname, [t 'log file path']);
+    t_file_match(fname, redir_printf_fname, [t 'mp_printf - file w/expected content'], {}, true);
+    t_ok(isempty(c), [t 'mp_printf - no console output']);
+    t_ok(isempty(mp.logger.manager('get')), [t 'mp.logger.manage(''clear'')']);
 else
     t_skip(n_tests, 'mp.logger object in use, tests will not work');
 end