Refactor exit codes to use an enum (#3300)

Author: ssbarnea

src/ansiblelint/__main__.py

@@ -49,7 +49,7 @@
     render_yaml,
 )
 from ansiblelint.config import get_version_warning, log_entries, options
-from ansiblelint.constants import EXIT_CONTROL_C_RC, GIT_CMD, LOCK_TIMEOUT_RC
+from ansiblelint.constants import GIT_CMD, RC
 from ansiblelint.file_utils import abspath, cwd, normpath
 from ansiblelint.loaders import load_ignore_txt
 from ansiblelint.skip_utils import normalize_tag
@@ -136,7 +136,7 @@ def initialize_options(arguments: list[str] | None = None) -> None:
             _logger.error(
                 "Timeout waiting for another instance of ansible-lint to release the lock.",
             )
-            sys.exit(LOCK_TIMEOUT_RC)
+            sys.exit(RC.LOCK_TIMEOUT)
 
     # Avoid extra output noise from Ansible about using devel versions
     if "ANSIBLE_DEVEL_WARNING" not in os.environ:  # pragma: no branch
@@ -373,7 +373,7 @@ def _run_cli_entrypoint() -> None:
         if exc.errno != errno.EPIPE:  # pragma: no cover
             raise
     except KeyboardInterrupt:  # pragma: no cover
-        sys.exit(EXIT_CONTROL_C_RC)
+        sys.exit(RC.EXIT_CONTROL_C)
     except RuntimeError as exc:  # pragma: no cover
         raise SystemExit(exc) from exc
 

src/ansiblelint/_mockings.py

@@ -7,7 +7,7 @@
 import sys
 
 from ansiblelint.config import options
-from ansiblelint.constants import ANSIBLE_MOCKED_MODULE, INVALID_CONFIG_RC
+from ansiblelint.constants import ANSIBLE_MOCKED_MODULE, RC
 
 _logger = logging.getLogger(__name__)
 
@@ -35,7 +35,7 @@ def _make_module_stub(module_name: str) -> None:
         )
     else:
         _logger.error("Config error: %s is not a valid module name.", module_name)
-        sys.exit(INVALID_CONFIG_RC)
+        sys.exit(RC.INVALID_CONFIG)
 
 
 def _write_module_stub(

src/ansiblelint/app.py

@@ -16,7 +16,7 @@
 from ansiblelint.color import console, console_stderr, render_yaml
 from ansiblelint.config import PROFILES, get_version_warning
 from ansiblelint.config import options as default_options
-from ansiblelint.constants import RULE_DOC_URL, SUCCESS_RC, VIOLATIONS_FOUND_RC
+from ansiblelint.constants import RC, RULE_DOC_URL
 from ansiblelint.errors import MatchError
 from ansiblelint.loaders import IGNORE_FILE
 from ansiblelint.stats import SummarizedResults, TagStats
@@ -224,7 +224,7 @@ def report_outcome(self, result: LintResult, mark_as_success: bool = False) -> i
                 is_success=mark_as_success,
             )
 
-        return SUCCESS_RC if mark_as_success else VIOLATIONS_FOUND_RC
+        return RC.SUCCESS if mark_as_success else RC.VIOLATIONS_FOUND
 
     def report_summary(  # pylint: disable=too-many-branches,too-many-locals
         self,

src/ansiblelint/cli.py

@@ -14,7 +14,7 @@
 from ansiblelint.constants import (
     CUSTOM_RULESDIR_ENVVAR,
     DEFAULT_RULESDIR,
-    INVALID_CONFIG_RC,
+    RC,
 )
 from ansiblelint.file_utils import (
     Lintable,
@@ -68,7 +68,7 @@ def load_config(config_file: str) -> dict[Any, Any]:
         config_path = os.path.abspath(config_file)
         if not os.path.exists(config_path):
             _logger.error("Config file not found '%s'", config_path)
-            sys.exit(INVALID_CONFIG_RC)
+            sys.exit(RC.INVALID_CONFIG)
     config_path = config_path or get_config_path()
     if not config_path or not os.path.exists(config_path):
         # a missing default config file should not trigger an error
@@ -82,7 +82,7 @@ def load_config(config_file: str) -> dict[Any, Any]:
 
     for error in validate_file_schema(config_lintable):
         _logger.error("Invalid configuration file %s. %s", config_path, error)
-        sys.exit(INVALID_CONFIG_RC)
+        sys.exit(RC.INVALID_CONFIG)
 
     config = clean_json(config_lintable.data)
     if not isinstance(config, dict):

src/ansiblelint/constants.py

@@ -7,11 +7,18 @@
 CUSTOM_RULESDIR_ENVVAR = "ANSIBLE_LINT_CUSTOM_RULESDIR"
 RULE_DOC_URL = "https://ansible-lint.readthedocs.io/rules/"
 
-SUCCESS_RC = 0
-VIOLATIONS_FOUND_RC = 2
-INVALID_CONFIG_RC = 3
-LOCK_TIMEOUT_RC = 4
-EXIT_CONTROL_C_RC = 130
+
+# Not using an IntEnum because only starting with py3.11 it will evaluate it
+# as int.
+class RC:  # pylint: disable=too-few-public-methods
+    """All exist codes used by ansible-lint."""
+
+    SUCCESS = 0
+    VIOLATIONS_FOUND = 2
+    INVALID_CONFIG = 3
+    LOCK_TIMEOUT = 4
+    EXIT_CONTROL_C = 130
+
 
 # Minimal version of Ansible we support for runtime
 ANSIBLE_MIN_VERSION = "2.12"

src/ansiblelint/rules/only_builtins.py

@@ -45,7 +45,7 @@ def matchtask(
     # pylint: disable=ungrouped-imports
     import pytest
 
-    from ansiblelint.constants import SUCCESS_RC, VIOLATIONS_FOUND_RC
+    from ansiblelint.constants import RC
     from ansiblelint.testing import RunFromText, run_ansible_lint
 
     SUCCESS_PLAY = """
@@ -68,7 +68,7 @@ def test_only_builtins_fail() -> None:
             "only-builtins",
             "examples/playbooks/rule-only-builtins.yml",
         )
-        assert result.returncode == VIOLATIONS_FOUND_RC
+        assert result.returncode == RC.VIOLATIONS_FOUND
         assert "Failed" in result.stderr
         assert "warning(s)" in result.stderr
         assert "only-builtins: Use only builtin actions" in result.stdout
@@ -85,7 +85,7 @@ def test_only_builtins_allow() -> None:
             "examples/playbooks/rule-only-builtins.yml",
         )
         assert "only-builtins" not in result.stdout
-        assert result.returncode == SUCCESS_RC
+        assert result.returncode == RC.SUCCESS
 
     @pytest.mark.parametrize(
         "rule_runner",

src/ansiblelint/rules/var_naming.py

@@ -9,7 +9,7 @@
 from ansible.parsing.yaml.objects import AnsibleUnicode
 
 from ansiblelint.config import options
-from ansiblelint.constants import LINE_NUMBER_KEY, SUCCESS_RC
+from ansiblelint.constants import LINE_NUMBER_KEY, RC
 from ansiblelint.file_utils import Lintable
 from ansiblelint.rules import AnsibleLintRule, RulesCollection
 from ansiblelint.runner import Runner
@@ -235,7 +235,7 @@ def test_var_naming_with_pattern() -> None:
             f"--config-file={conf_path}",
             role_path,
         )
-        assert result.returncode == SUCCESS_RC
+        assert result.returncode == RC.SUCCESS
         assert "var-naming" not in result.stdout
 
     def test_is_invalid_variable_name() -> None:

test/test_mockings.py

@@ -2,12 +2,12 @@
 import pytest
 
 from ansiblelint._mockings import _make_module_stub
-from ansiblelint.constants import INVALID_CONFIG_RC
+from ansiblelint.constants import RC
 
 
 def test_make_module_stub() -> None:
     """Test make module stub."""
     with pytest.raises(SystemExit) as exc:
         _make_module_stub("")
     assert exc.type == SystemExit
-    assert exc.value.code == INVALID_CONFIG_RC
+    assert exc.value.code == RC.INVALID_CONFIG

test/test_utils.py

@@ -38,7 +38,7 @@
 from ansiblelint import cli, constants, utils
 from ansiblelint.__main__ import initialize_logger
 from ansiblelint.cli import get_rules_dirs
-from ansiblelint.constants import VIOLATIONS_FOUND_RC
+from ansiblelint.constants import RC
 from ansiblelint.file_utils import Lintable
 from ansiblelint.rules import RulesCollection
 from ansiblelint.runner import Runner
@@ -292,7 +292,7 @@ def test_cli_auto_detect(capfd: CaptureFixture[str]) -> None:
     result = subprocess.run(cmd, check=False).returncode
 
     # We de expect to fail on our own repo due to test examples we have
-    assert result == VIOLATIONS_FOUND_RC
+    assert result == RC.VIOLATIONS_FOUND
 
     out, err = capfd.readouterr()