SCANPY-80 Read ".coveragerc" configuration to exclude files from coverage#234
Merged
maksim-grebeniuk-sonarsource merged 6 commits intomasterfrom Jun 17, 2025
Merged
SCANPY-80 Read ".coveragerc" configuration to exclude files from coverage#234maksim-grebeniuk-sonarsource merged 6 commits intomasterfrom
maksim-grebeniuk-sonarsource merged 6 commits intomasterfrom
Conversation
maksim-grebeniuk-sonarsource
force-pushed
the
SCANPY-80
branch
from
9d0b0bc to
4a8fec7
Compare
thomas-serre-sonarsource
requested changes
Jun 17, 2025
Contributor
thomas-serre-sonarsource
left a comment
thomas-serre-sonarsource
left a comment
There was a problem hiding this comment.
The logic looks good to me.
I suggested a few changes with some of them which are a matter of taste.
| class CoverageRCConfigurationLoader: | ||
|
|
||
| @staticmethod | ||
| def load(base_dir: pathlib.Path) -> dict[str, str]: |
Contributor
There was a problem hiding this comment.
minor let's rename this function as it's not loading the all coverage file but only the exclusions properties
Suggested change
| def load(base_dir: pathlib.Path) -> dict[str, str]: | |
| def load_exclusion_properties(base_dir: pathlib.Path) -> dict[str, str]: |
Comment on lines
+36
to
+40
| exclusion_properties = CoverageRCConfigurationLoader.__read_coverage_exclusions_properties( | ||
| config_file_path, coverage_properties | ||
| ) | ||
| result_dict.update(exclusion_properties) | ||
| return result_dict |
Contributor
There was a problem hiding this comment.
minor I would simplify
Suggested change
| exclusion_properties = CoverageRCConfigurationLoader.__read_coverage_exclusions_properties( | |
| config_file_path, coverage_properties | |
| ) | |
| result_dict.update(exclusion_properties) | |
| return result_dict | |
| exclusion_properties = CoverageRCConfigurationLoader.__read_coverage_exclusions_properties( | |
| config_file_path, coverage_properties | |
| ) | |
| return exclusion_properties |
| def __read_config(config_file_path: pathlib.Path) -> dict[str, Any]: | ||
| config_dict: dict[str, Any] = {} | ||
| if not config_file_path.exists(): | ||
| logging.debug(f"Configuration file not found: {config_file_path}") |
Contributor
There was a problem hiding this comment.
minor for coherence with other logs
Suggested change
| logging.debug(f"Configuration file not found: {config_file_path}") | |
| logging.debug(f"Coverage file not found: {config_file_path}") |
Comment on lines
+52
to
+53
|
|
||
| # Iterate over sections and options |
Contributor
There was a problem hiding this comment.
nit
Suggested change
| # Iterate over sections and options |
| return config_dict | ||
|
|
||
| @staticmethod | ||
| def __read_coverage_exclusions_properties( |
Contributor
There was a problem hiding this comment.
minor as this function is not reading from the file but only extracting patterns
Suggested change
| def __read_coverage_exclusions_properties( | |
| def __extract_coverage_exclusion_patterns( |
Comment on lines
+64
to
+75
| @staticmethod | ||
| def __read_coverage_exclusions_properties( | ||
| config_file_path: pathlib.Path, coverage_properties: dict[str, Any] | ||
| ) -> dict[str, Any]: | ||
| result_dict: dict[str, Any] = {} | ||
| if "run" not in coverage_properties: | ||
| logging.debug(f"The run key was not found in {config_file_path}") | ||
| return result_dict | ||
|
|
||
| if "omit" not in coverage_properties["run"]: | ||
| logging.debug(f"The run.omit key was not found in {config_file_path}") | ||
| return result_dict |
Contributor
There was a problem hiding this comment.
Suggested change
| @staticmethod | |
| def __read_coverage_exclusions_properties( | |
| config_file_path: pathlib.Path, coverage_properties: dict[str, Any] | |
| ) -> dict[str, Any]: | |
| result_dict: dict[str, Any] = {} | |
| if "run" not in coverage_properties: | |
| logging.debug(f"The run key was not found in {config_file_path}") | |
| return result_dict | |
| if "omit" not in coverage_properties["run"]: | |
| logging.debug(f"The run.omit key was not found in {config_file_path}") | |
| return result_dict | |
| @staticmethod | |
| def __extract_coverage_exclusion_patterns(coverage_properties: dict[str, Any]) -> dict[str, Any]: | |
| result_dict: dict[str, Any] = {} | |
| if "run" not in coverage_properties or "omit" not in coverage_properties["run"]: | |
| logging.debug(f"Coverage file has no exclusion properties") | |
| return result_dict |
Comment on lines
+81
to
+82
| result_dict["sonar.coverage.exclusions"] = translated_exclusions | ||
| return result_dict |
Contributor
There was a problem hiding this comment.
I don't find it relevant in a loader file to build the options that should be passed to the scanner. I think this function should only return the exclusion patterns, so only a string, and the dict should be built outside. Moreover, the dict will always have only one key which seems overkill :) I'd suggest to build the dictionnary in the load function
Suggested change
| result_dict["sonar.coverage.exclusions"] = translated_exclusions | |
| return result_dict | |
| return translated_exclusions |
|
thomas-serre-sonarsource
approved these changes
Jun 17, 2025
Contributor
thomas-serre-sonarsource
left a comment
thomas-serre-sonarsource
left a comment
There was a problem hiding this comment.
LGTM, thanks for the modifications !
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
SCANPY-80
Part of