Support for coverage groups (#7)

Author: gregorybchris

covcheck/_cli/config.py

@@ -3,6 +3,8 @@
 from pathlib import Path
 from typing import Any, Optional, Union
 
+from covcheck._cli.utilities import fail_with_error
+
 try:
     import toml
     TOML_INSTALLED = True
@@ -37,34 +39,53 @@ def __init__(
     @classmethod
     def create(
         cls,
-        coverage_file: Union[str, Path],
-        config_file: Optional[Union[str, Path]] = None,
+        coverage_filepath: Union[str, Path],
+        config_filepath: Optional[Union[str, Path]] = None,
+        group: Optional[str] = None,
         **kwargs: Optional[Any],
     ) -> 'Config':
         """Get a config based on both CLI arguments and config file settings.
 
         If the same argument is specified in both CLI arguments and config file,
         then the CLI argument will take precedence.
 
-        :param coverage_file: XML coverage file from Coverage.py.
-        :param config_file: Path to pyproject.toml config file.
+        :param coverage_filepath: Path to XML coverage file from Coverage.py.
+        :param config_filepath: Path to pyproject.toml config file.
+        :param group: Name of coverage group to check.
         :param kwargs: Kwargs containing additional config settings.
         """
-        config = cls(coverage_file)
+        config = cls(coverage_filepath)
 
-        if config_file is not None:
+        if config_filepath is not None:
             if not TOML_INSTALLED:
                 raise ImportError("--config was passed, but the toml package was not installed. "
                                   "Please 'pip install toml' before running with --config.")
 
-            with open(config_file, 'r', encoding='utf-8') as f:
+            with open(config_filepath, 'r', encoding='utf-8') as f:
                 toml_config = toml.load(f)
 
-                toml_tools = toml_config['tool']
-                if 'covcheck' in toml_tools:
-                    toml_covcheck = toml_tools['covcheck']
-                    for key, value in toml_covcheck.items():
-                        setattr(config, key, value)
+                if 'tool' in toml_config:
+                    toml_tools = toml_config['tool']
+                    if 'covcheck' in toml_tools:
+                        toml_covcheck = toml_tools['covcheck']
+
+                        # Check for missing group configuration
+                        if group is not None:
+                            # Group name selected but no matching group in config file
+                            if 'group' in toml_covcheck and group not in toml_covcheck['group']:
+                                fail_with_error(f"Group {group} not found in config")
+                            # Group name selected but no groups at all in config file
+                            if 'group' not in toml_covcheck:
+                                fail_with_error(f"Group {group} not found in config")
+
+                        if 'group' in toml_covcheck and group is not None:
+                            group_dict = toml_covcheck['group'][group]
+                            if 'coverage' in group_dict:
+                                for key, value in group_dict['coverage'].items():
+                                    setattr(config, key, value)
+                        else:
+                            for key, value in toml_covcheck.items():
+                                setattr(config, key, value)
 
         for key, value in kwargs.items():
             if value is not None:

covcheck/_cli/main.py

@@ -20,6 +20,7 @@ def parse_args() -> argparse.Namespace:
     parser.add_argument('--silent', default=False, action='store_true', help="Do not print coverage results.")
 
     parser.add_argument('--config', default=None, type=str, help="Path to pyproject.toml config file.")
+    parser.add_argument('--group', default=None, type=str, help="Name of coverage group to check.")
 
     return parser.parse_args()
 
@@ -30,11 +31,12 @@ def run() -> None:
 
     config = Config.create(
         args.coverage_file,
-        config_file=args.config,
+        config_filepath=args.config,
         line=args.line,
         branch=args.branch,
         output=args.output,
         silent=args.silent,
+        group=args.group,
     )
 
     validate_coverage(config)

pyproject.toml

@@ -35,8 +35,8 @@ types-toml = "^0.10.1"
 covcheck = "covcheck._cli.main:run"
 
 [tool.covcheck]
-line = 97.0
-branch = 97.0
+line = 98.0
+branch = 96.0
 
 [tool.flake8]
 ignore = ""           # Required to disable default ignores
@@ -52,6 +52,7 @@ ignore_missing_imports = true
 good-names = ["e", "f", "h", "i", "j", "k", "m", "n", "w", "x", "y"]
 max-locals = 25
 max-args = 8
+max-branches = 14
 notes = ["FIXME"]
 
 [tool.pylint.format]

tests/pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+log_cli = 1
+log_cli_level = INFO

tests/test_cli/test_config.py

@@ -22,6 +22,22 @@ def fixture_example_config_filepath(tmp_path_factory: TempPathFactory) -> Path:
     return config_filepath
 
 
+@pytest.fixture(name='example_group_config_filepath', scope='module')
+def fixture_example_group_config_filepath(tmp_path_factory: TempPathFactory) -> Path:
+    temp_dirpath = tmp_path_factory.mktemp('configs')
+    config_filepath = temp_dirpath / 'pyproject.toml'
+    lines = [
+        '[tool.covcheck.group.unit]\n',
+        '\n',
+        '[tool.covcheck.group.unit.coverage]\n',
+        'line = 6.0\n',
+        'branch = 7.0\n',
+    ]
+    with open(config_filepath, 'w', encoding='utf-8') as f:
+        f.writelines(lines)
+    return config_filepath
+
+
 @pytest.fixture(name='example_config_kwargs', scope='module')
 def fixture_example_config_kwargs() -> Dict[str, Any]:
     return {
@@ -39,7 +55,7 @@ def test_create_cli(
     ) -> None:
         config = config_module.Config.create(
             coverage_filepath,
-            config_file=None,
+            config_filepath=None,
             **example_config_kwargs,
         )
         assert config.line == 4.0
@@ -53,7 +69,7 @@ def test_create_file(
     ) -> None:
         config = config_module.Config.create(
             coverage_filepath,
-            config_file=example_config_filepath,
+            config_filepath=example_config_filepath,
         )
         assert config.line == 2.0
         assert config.branch == 3.0
@@ -67,7 +83,7 @@ def test_create_both(
     ) -> None:
         config = config_module.Config.create(
             coverage_filepath,
-            config_file=example_config_filepath,
+            config_filepath=example_config_filepath,
             **example_config_kwargs,
         )
         assert config.line == 4.0
@@ -87,5 +103,52 @@ def test_create_no_toml(
         with pytest.raises(ImportError, match=message):
             config_module.Config.create(
                 coverage_filepath,
-                config_file=example_config_filepath,
+                config_filepath=example_config_filepath,
             )
+
+    def test_create_group(
+        self,
+        example_group_config_filepath: Path,
+        coverage_filepath: Path,
+    ) -> None:
+        config = config_module.Config.create(
+            coverage_filepath,
+            config_filepath=example_group_config_filepath,
+            group='unit',
+        )
+        assert config.line == 6.0
+        assert config.branch == 7.0
+
+    def test_create_missing_all_groups(
+        self,
+        example_config_filepath: Path,
+        coverage_filepath: Path,
+        capsys: pytest.CaptureFixture,
+    ) -> None:
+        with pytest.raises(SystemExit):
+            config_module.Config.create(
+                coverage_filepath,
+                config_filepath=example_config_filepath,
+                group='fake-group',
+            )
+
+        captured = capsys.readouterr()
+        expected = "Group fake-group not found in config"
+        assert expected in captured.err
+
+    def test_create_missing_one_group(
+        self,
+        example_group_config_filepath: Path,
+        coverage_filepath: Path,
+        capsys: pytest.CaptureFixture,
+    ) -> None:
+        with pytest.raises(SystemExit):
+            config_module.Config.create(
+                coverage_filepath,
+                config_filepath=example_group_config_filepath,
+                group='fake-group',
+            )
+
+        captured = capsys.readouterr()
+        expected = "Group fake-group not found in config"
+        assert expected in captured.err