Merge pull request #5904 from cylc/8.2.x-sync

🤖 Merge 8.2.x-sync into master

Author: markgrahamdawson

cylc/flow/option_parsers.py

@@ -182,6 +182,99 @@ def format_help_headings(string):
     )
 
 
+def verbosity_to_log_level(verb: int) -> int:
+    """Convert Cylc verbosity to log severity level."""
+    if verb < 0:
+        return logging.WARNING
+    if verb > 0:
+        return logging.DEBUG
+    return logging.INFO
+
+
+def log_level_to_verbosity(lvl: int) -> int:
+    """Convert log severity level to Cylc verbosity.
+
+    Examples:
+        >>> log_level_to_verbosity(logging.NOTSET)
+        2
+        >>> log_level_to_verbosity(logging.DEBUG)
+        2
+        >>> log_level_to_verbosity(logging.INFO)
+        0
+        >>> log_level_to_verbosity(logging.WARNING)
+        -1
+        >>> log_level_to_verbosity(logging.ERROR)
+        -1
+    """
+    if lvl <= logging.DEBUG:
+        return 2
+    if lvl < logging.INFO:
+        return 1
+    if lvl == logging.INFO:
+        return 0
+    return -1
+
+
+def verbosity_to_opts(verb: int) -> List[str]:
+    """Convert Cylc verbosity to the CLI opts required to replicate it.
+
+    Examples:
+        >>> verbosity_to_opts(0)
+        []
+        >>> verbosity_to_opts(-2)
+        ['-q', '-q']
+        >>> verbosity_to_opts(2)
+        ['-v', '-v']
+
+    """
+    return [
+        '-q'
+        for _ in range(verb, 0)
+    ] + [
+        '-v'
+        for _ in range(0, verb)
+    ]
+
+
+def verbosity_to_env(verb: int) -> Dict[str, str]:
+    """Convert Cylc verbosity to the env vars required to replicate it.
+
+    Examples:
+        >>> verbosity_to_env(0)
+        {'CYLC_VERBOSE': 'false', 'CYLC_DEBUG': 'false'}
+        >>> verbosity_to_env(1)
+        {'CYLC_VERBOSE': 'true', 'CYLC_DEBUG': 'false'}
+        >>> verbosity_to_env(2)
+        {'CYLC_VERBOSE': 'true', 'CYLC_DEBUG': 'true'}
+
+    """
+    return {
+        'CYLC_VERBOSE': str((verb > 0)).lower(),
+        'CYLC_DEBUG': str((verb > 1)).lower(),
+    }
+
+
+def env_to_verbosity(env: Union[Dict, os._Environ]) -> int:
+    """Extract verbosity from environment variables.
+
+    Examples:
+        >>> env_to_verbosity({})
+        0
+        >>> env_to_verbosity({'CYLC_VERBOSE': 'true'})
+        1
+        >>> env_to_verbosity({'CYLC_DEBUG': 'true'})
+        2
+        >>> env_to_verbosity({'CYLC_DEBUG': 'TRUE'})
+        2
+
+    """
+    return (
+        2 if env.get('CYLC_DEBUG', '').lower() == 'true'
+        else 1 if env.get('CYLC_VERBOSE', '').lower() == 'true'
+        else 0
+    )
+
+
 class CylcOption(Option):
     """Optparse option which adds a decrement action."""
 

tests/functional/cli/03-set-verbosity.t

@@ -17,7 +17,7 @@
 #-------------------------------------------------------------------------------
 # Test "cylc set-verbosity"
 . "$(dirname "$0")/test_header"
-set_test_number 6
+set_test_number 4
 
 # Test illegal log level
 TEST_NAME="${TEST_NAME_BASE}-bad"
@@ -28,18 +28,32 @@ grep_ok 'InputError: Illegal logging level, duck' "${TEST_NAME}.stderr"
 TEST_NAME="${TEST_NAME_BASE}-good"
 init_workflow "${TEST_NAME_BASE}" << '__FLOW__'
 [scheduler]
-    allow implicit tasks = True
+    [[events]]
+        abort on stall timeout = True
+        stall timeout = PT0S
 [scheduling]
     [[graph]]
-        R1 = andor
+        R1 = setter => getter
+[runtime]
+    [[setter]]
+        script = """
+            echo "CYLC_VERBOSE: $CYLC_VERBOSE"
+            [[ "$CYLC_VERBOSE" != 'true' ]]
+            echo "CYLC_DEBUG: $CYLC_DEBUG"
+            [[ "$CYLC_DEBUG" != 'true' ]]
+
+            cylc set-verbosity DEBUG "$CYLC_WORKFLOW_ID"
+            cylc__job__poll_grep_workflow_log 'Command actioned: set_verbosity'
+        """
+    [[getter]]
+        script = """
+            echo "CYLC_VERBOSE: $CYLC_VERBOSE"
+            [[ "$CYLC_VERBOSE" == 'true' ]]
+            echo "CYLC_DEBUG: $CYLC_DEBUG"
+            [[ "$CYLC_DEBUG" == 'true' ]]
+        """
 __FLOW__
 
 run_ok "${TEST_NAME}-validate" cylc validate "$WORKFLOW_NAME"
-workflow_run_ok "${TEST_NAME}-run" cylc play --pause "$WORKFLOW_NAME"
-
-run_ok "$TEST_NAME" cylc set-verbosity DEBUG "$WORKFLOW_NAME"
-log_scan "${TEST_NAME}-grep" "${WORKFLOW_RUN_DIR}/log/scheduler/log" 5 1 \
-    'Command actioned: set_verbosity'
-
-cylc stop "$WORKFLOW_NAME"
+workflow_run_ok "${TEST_NAME}-run" cylc play --no-detach "$WORKFLOW_NAME"
 purge