SmokeCrossFit 0.0.0__py3-none-any.whl → 1.0.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- crossfit/__init__.py +1 -1
- crossfit/commands/__init__.py +2 -1
- crossfit/commands/command.py +6 -6
- crossfit/commands/command_builder.py +9 -8
- crossfit/executors/executor_factory.py +8 -0
- crossfit/executors/local_executor.py +9 -2
- crossfit/models/command_models.py +0 -1
- crossfit/tools/dotnet_coverage.py +48 -36
- crossfit/tools/jacoco.py +31 -13
- crossfit/tools/tool.py +39 -22
- crossfit/tools/tool_factory.py +11 -8
- {smokecrossfit-0.0.0.dist-info → smokecrossfit-1.0.0.dist-info}/METADATA +12 -1
- smokecrossfit-1.0.0.dist-info/RECORD +23 -0
- smokecrossfit-0.0.0.dist-info/RECORD +0 -23
- {smokecrossfit-0.0.0.dist-info → smokecrossfit-1.0.0.dist-info}/WHEEL +0 -0
- {smokecrossfit-0.0.0.dist-info → smokecrossfit-1.0.0.dist-info}/top_level.txt +0 -0
crossfit/__init__.py
CHANGED
crossfit/commands/__init__.py
CHANGED
crossfit/commands/command.py
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import copy
|
|
2
2
|
import glob
|
|
3
3
|
from pathlib import Path
|
|
4
|
-
from typing import Optional,
|
|
4
|
+
from typing import Optional, Self
|
|
5
5
|
from typeguard import typechecked
|
|
6
6
|
|
|
7
7
|
COMMAND_DELIMITER = " "
|
|
@@ -11,9 +11,9 @@ class Command:
|
|
|
11
11
|
next_command: Optional[Self]
|
|
12
12
|
execution_call: Optional[str]
|
|
13
13
|
command_to_execute: Optional[str]
|
|
14
|
-
command_body:
|
|
15
|
-
options:
|
|
16
|
-
arguments:
|
|
14
|
+
command_body: list[str]
|
|
15
|
+
options: list[tuple[str, Optional[str]]]
|
|
16
|
+
arguments: list[str]
|
|
17
17
|
values_delimiter: Optional[str]
|
|
18
18
|
|
|
19
19
|
@typechecked()
|
|
@@ -30,14 +30,14 @@ class Command:
|
|
|
30
30
|
self.values_delimiter = None
|
|
31
31
|
|
|
32
32
|
@property
|
|
33
|
-
def command(self) ->
|
|
33
|
+
def command(self) -> list[str]:
|
|
34
34
|
"""
|
|
35
35
|
:returns: The command itself as a list of strings
|
|
36
36
|
"""
|
|
37
37
|
return list(filter(lambda s: s is not None, [self.execution_call, self.command_to_execute, *self.command_body]))
|
|
38
38
|
|
|
39
39
|
@command.setter
|
|
40
|
-
def command(self, value:
|
|
40
|
+
def command(self, value: list[str]):
|
|
41
41
|
"""
|
|
42
42
|
Sets the command body from a list of strings
|
|
43
43
|
:param value: The command body as list of strings
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import copy
|
|
2
2
|
import glob
|
|
3
3
|
import os.path
|
|
4
|
+
|
|
4
5
|
from pathlib import Path
|
|
5
|
-
from typing import
|
|
6
|
+
from typing import Optional, Self
|
|
6
7
|
from typeguard import typechecked
|
|
7
8
|
from crossfit.commands.command import Command
|
|
8
9
|
|
|
@@ -26,7 +27,7 @@ class CommandBuilder:
|
|
|
26
27
|
self._command.next_command = command
|
|
27
28
|
|
|
28
29
|
@typechecked()
|
|
29
|
-
def with_command(self, command:
|
|
30
|
+
def with_command(self, command: list[str]) -> Self:
|
|
30
31
|
"""
|
|
31
32
|
Initializes the command from a list of strings.
|
|
32
33
|
:param command: A list containing at least two strings - execution call and command to execute
|
|
@@ -49,7 +50,7 @@ class CommandBuilder:
|
|
|
49
50
|
:param path: Optional path to prepend to the execution call
|
|
50
51
|
:returns: Self for method chaining
|
|
51
52
|
"""
|
|
52
|
-
self._command.execution_call = execution_call if path is None else os.path.relpath(path / execution_call)
|
|
53
|
+
self._command.execution_call = execution_call if path is None else str(os.path.relpath(path / execution_call))
|
|
53
54
|
return self
|
|
54
55
|
|
|
55
56
|
@typechecked()
|
|
@@ -63,7 +64,7 @@ class CommandBuilder:
|
|
|
63
64
|
return self
|
|
64
65
|
|
|
65
66
|
@typechecked()
|
|
66
|
-
def set_command_body(self, command_body:
|
|
67
|
+
def set_command_body(self, command_body: list[str]) -> Self:
|
|
67
68
|
"""
|
|
68
69
|
Sets the command body containing arguments and options.
|
|
69
70
|
:param command_body: A list of strings representing the command body
|
|
@@ -83,7 +84,7 @@ class CommandBuilder:
|
|
|
83
84
|
if self._command.values_delimiter != delimiter:
|
|
84
85
|
self._command.values_delimiter = delimiter
|
|
85
86
|
if update_current_values:
|
|
86
|
-
self.
|
|
87
|
+
self._update_all_options()
|
|
87
88
|
return self
|
|
88
89
|
|
|
89
90
|
@typechecked()
|
|
@@ -99,7 +100,7 @@ class CommandBuilder:
|
|
|
99
100
|
return self
|
|
100
101
|
|
|
101
102
|
@typechecked()
|
|
102
|
-
def add_options(self, *args:
|
|
103
|
+
def add_options(self, *args: tuple[str, Optional[str]]) -> Self:
|
|
103
104
|
"""
|
|
104
105
|
Adds multiple options to the command.
|
|
105
106
|
:param args: Variable number of tuples, each containing (option, value) pairs
|
|
@@ -144,12 +145,12 @@ class CommandBuilder:
|
|
|
144
145
|
"""
|
|
145
146
|
return copy.copy(self._command)
|
|
146
147
|
|
|
147
|
-
def
|
|
148
|
+
def _update_all_options(self) -> Self:
|
|
148
149
|
"""
|
|
149
150
|
Updates all existing options with the current delimiter.
|
|
150
151
|
:returns: Self for method chaining
|
|
151
152
|
"""
|
|
152
|
-
self._command.command_body = self._command.
|
|
153
|
+
self._command.command_body = self._command.arguments
|
|
153
154
|
options = self._command.options.copy()
|
|
154
155
|
self._command.options = []
|
|
155
156
|
self.add_options(*options)
|
|
@@ -2,6 +2,14 @@ from crossfit.models.executor_models import ExecutorType
|
|
|
2
2
|
from crossfit.executors.local_executor import LocalExecutor
|
|
3
3
|
|
|
4
4
|
def create_executor(executor_type: ExecutorType, logger = None, catch: bool = True, **kwargs):
|
|
5
|
+
"""
|
|
6
|
+
Factory method to create an executor based on the specified type.
|
|
7
|
+
:param executor_type: The type of executor to create.
|
|
8
|
+
:param logger: Optional logger instance for logging execution details.
|
|
9
|
+
:param catch: Whether to catch exceptions during execution.
|
|
10
|
+
:param kwargs: Additional keyword arguments for executor initialization.
|
|
11
|
+
:return: An instance of the specified executor type.
|
|
12
|
+
"""
|
|
5
13
|
if executor_type == ExecutorType.Local:
|
|
6
14
|
return LocalExecutor(logger, catch, **kwargs)
|
|
7
15
|
else:
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import subprocess
|
|
2
2
|
from logging import Logger
|
|
3
3
|
import shlex
|
|
4
|
+
from pathlib import Path
|
|
5
|
+
|
|
4
6
|
from crossfit.commands.command import Command
|
|
5
7
|
from crossfit.executors.executor import Executor
|
|
6
8
|
from crossfit.models.command_models import CommandResult
|
|
@@ -9,20 +11,25 @@ from crossfit.models.command_models import CommandResult
|
|
|
9
11
|
class LocalExecutor(Executor):
|
|
10
12
|
"""Executor that runs commands locally via subprocess."""
|
|
11
13
|
|
|
12
|
-
def __init__(self, logger: Logger, catch: bool = True, **execution_kwargs):
|
|
14
|
+
def __init__(self, logger: Logger, catch: bool = True, workdir: Path = None, **execution_kwargs):
|
|
13
15
|
"""
|
|
14
16
|
:param logger: Logger instance for logging execution details (required)
|
|
15
17
|
:param catch: If True, catches exceptions and returns error in CommandResult.
|
|
16
18
|
If False, re-raises exceptions.
|
|
17
19
|
:param execution_kwargs: Additional arguments passed to subprocess.run
|
|
18
20
|
"""
|
|
21
|
+
self._workdir = workdir
|
|
22
|
+
if workdir is not None:
|
|
23
|
+
execution_kwargs["cwd"] = str(workdir)
|
|
24
|
+
|
|
19
25
|
super().__init__(logger, catch)
|
|
26
|
+
|
|
20
27
|
self._exec_kwargs = {
|
|
21
28
|
"capture_output": True,
|
|
22
29
|
"check": True,
|
|
23
30
|
"text": True,
|
|
31
|
+
**execution_kwargs,
|
|
24
32
|
}
|
|
25
|
-
self._exec_kwargs.update(execution_kwargs)
|
|
26
33
|
|
|
27
34
|
def _execute_single(self, command: Command) -> CommandResult:
|
|
28
35
|
"""
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
from pathlib import Path
|
|
2
|
-
from typing import
|
|
2
|
+
from typing import Optional
|
|
3
3
|
|
|
4
4
|
from crossfit import Command
|
|
5
5
|
from crossfit.models import ReportFormat, ToolType
|
|
@@ -9,16 +9,54 @@ from crossfit.tools.tool import Tool
|
|
|
9
9
|
class DotnetCoverage(Tool):
|
|
10
10
|
_tool_type = ToolType.DotnetCoverage
|
|
11
11
|
|
|
12
|
-
def
|
|
12
|
+
def save_report(self,
|
|
13
|
+
coverage_files,
|
|
14
|
+
target_dir,
|
|
15
|
+
sourcecode_dir=None,
|
|
16
|
+
report_format: ReportFormat = None,
|
|
17
|
+
report_formats: list[ReportFormat] = None,
|
|
18
|
+
*extras: tuple[str, Optional[str]]) -> Command:
|
|
19
|
+
"""
|
|
20
|
+
Creates a dotnet-coverage report from coverage files to the given path.
|
|
21
|
+
:param coverage_files: File paths (can handle wildcards) to create dotnet-coverage report from.
|
|
22
|
+
:param target_dir: Targeted directory to save the dotnet-coverage report to.
|
|
23
|
+
:param sourcecode_dir: Directory containing the covered source code files.
|
|
24
|
+
:param report_format: Primary format of the dotnet-coverage report.
|
|
25
|
+
:param report_formats: Additional formats of dotnet-coverage reports to create.
|
|
26
|
+
:param extras: Extra options to pass to the dotnet CLI's report command.
|
|
27
|
+
:return: A Command object configured to generate the coverage report.
|
|
28
|
+
"""
|
|
29
|
+
multiple_values_delimiter = ';'
|
|
30
|
+
if sourcecode_dir:
|
|
31
|
+
extras += ("-sourcedirs", str(sourcecode_dir)),
|
|
32
|
+
extras += ("-targetdir", str(target_dir)),
|
|
33
|
+
command_builder = (
|
|
34
|
+
self._create_command_builder("", ToolType.DotnetReportGenerator, None, *extras)
|
|
35
|
+
.set_values_delimiter(":", True)
|
|
36
|
+
.add_option("-reports", f"\"{multiple_values_delimiter.join(map(str, coverage_files))}\""))
|
|
37
|
+
combined_formats = set((report_formats or []) + [report_format])
|
|
38
|
+
command_builder = command_builder.add_option(
|
|
39
|
+
"-reporttypes",f"\"{multiple_values_delimiter.join([rf.value for rf in combined_formats if rf])}\"")
|
|
40
|
+
|
|
41
|
+
command = command_builder.build_command()
|
|
42
|
+
command.command = [kw.replace("--", "-") for kw in command.command[2:]]
|
|
43
|
+
|
|
44
|
+
return command
|
|
45
|
+
|
|
46
|
+
def snapshot_coverage(self,
|
|
47
|
+
session,
|
|
48
|
+
target_dir,
|
|
49
|
+
target_file,
|
|
50
|
+
*extras: tuple[str, Optional[str]]) -> Command:
|
|
13
51
|
"""
|
|
14
52
|
Triggers dotnet-coverage agent to save cobertura formatted coverage files to the given path.
|
|
15
|
-
:param session: Session id of the dotnet-coverage agent collected-coverage
|
|
53
|
+
:param session: Session id of the dotnet-coverage agent collected-coverage for snapshot.
|
|
16
54
|
:param target_dir: Targeted directory to save the dotnet-coverage collection to.
|
|
17
55
|
:param target_file: Specified snapshot file name - when not given, uses default with .xml suffix.
|
|
18
56
|
:param extras: Extra options to pass to the dotnet-coverage CLI's snapshot command.
|
|
19
57
|
:return: A Command object configured to snapshot coverage data.
|
|
20
58
|
"""
|
|
21
|
-
target_path =
|
|
59
|
+
target_path = target_dir / (
|
|
22
60
|
target_file if target_file is not None else self._get_default_target_filename())
|
|
23
61
|
if not target_path.suffix:
|
|
24
62
|
target_path = target_path.with_suffix(".xml")
|
|
@@ -28,7 +66,11 @@ class DotnetCoverage(Tool):
|
|
|
28
66
|
|
|
29
67
|
return command_builder.build_command()
|
|
30
68
|
|
|
31
|
-
def merge_coverage(self,
|
|
69
|
+
def merge_coverage(self,
|
|
70
|
+
coverage_files,
|
|
71
|
+
target_dir,
|
|
72
|
+
target_file,
|
|
73
|
+
*extras: tuple[str, Optional[str]]) -> Command:
|
|
32
74
|
"""
|
|
33
75
|
Merges multiple coverage files into a single unified coverage file.
|
|
34
76
|
:param coverage_files: File paths to coverage files to merge.
|
|
@@ -37,7 +79,7 @@ class DotnetCoverage(Tool):
|
|
|
37
79
|
:param extras: Extra options to pass to the dotnet-coverage CLI's merge command.
|
|
38
80
|
:return: A Command object configured to merge coverage files.
|
|
39
81
|
"""
|
|
40
|
-
extras += ("--output", str(
|
|
82
|
+
extras += ("--output", str(target_dir / (
|
|
41
83
|
target_file if target_file is not None else Path(self._get_default_target_filename()).with_suffix(
|
|
42
84
|
".xml")))),
|
|
43
85
|
command_builder = self._create_command_builder("merge", None, coverage_files, *extras)
|
|
@@ -45,33 +87,3 @@ class DotnetCoverage(Tool):
|
|
|
45
87
|
command_builder = command_builder.add_option("--output-format", ReportFormat.Cobertura.value.lower())
|
|
46
88
|
|
|
47
89
|
return command_builder.build_command()
|
|
48
|
-
|
|
49
|
-
def save_report(self, coverage_files, target_dir, sourcecode_dir,
|
|
50
|
-
report_format: ReportFormat = None, report_formats: List[ReportFormat] = None,
|
|
51
|
-
*extras: Tuple[str, Optional[str]]) -> Command:
|
|
52
|
-
"""
|
|
53
|
-
Creates a dotnet-coverage report from coverage files to the given path.
|
|
54
|
-
:param coverage_files: File paths (can handle wildcards) to create dotnet-coverage report from.
|
|
55
|
-
:param target_dir: Targeted directory to save the dotnet-coverage report to.
|
|
56
|
-
:param sourcecode_dir: Directory containing the covered source code files.
|
|
57
|
-
:param report_format: Primary format of the dotnet-coverage report.
|
|
58
|
-
:param report_formats: Additional formats of dotnet-coverage reports to create.
|
|
59
|
-
:param extras: Extra options to pass to the dotnet CLI's report command.
|
|
60
|
-
:return: A Command object configured to generate the coverage report.
|
|
61
|
-
"""
|
|
62
|
-
multiple_values_delimiter = ';'
|
|
63
|
-
if sourcecode_dir:
|
|
64
|
-
extras += ("-sourcedirs", str(sourcecode_dir)),
|
|
65
|
-
extras += ("-targetdir", str(target_dir)),
|
|
66
|
-
command_builder = (
|
|
67
|
-
self._create_command_builder("", ToolType.DotnetReportGenerator, None, *extras)
|
|
68
|
-
.set_values_delimiter(":", True)
|
|
69
|
-
.add_option("-reports", f"\"{multiple_values_delimiter.join(map(str, coverage_files))}\""))
|
|
70
|
-
combined_formats = set((report_formats or []) + [report_format])
|
|
71
|
-
command_builder = command_builder.add_option(
|
|
72
|
-
"-reporttypes",f"\"{multiple_values_delimiter.join([rf.value for rf in combined_formats if rf])}\"")
|
|
73
|
-
|
|
74
|
-
command = command_builder.build_command()
|
|
75
|
-
command.command = [kw.replace("--", "-") for kw in command.command[2:]]
|
|
76
|
-
|
|
77
|
-
return command
|
crossfit/tools/jacoco.py
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import os.path
|
|
2
|
-
|
|
3
|
-
from typing import Optional
|
|
2
|
+
|
|
3
|
+
from typing import Optional
|
|
4
4
|
from crossfit import Command
|
|
5
5
|
from crossfit.commands.command_builder import CommandBuilder
|
|
6
6
|
from crossfit.models.tool_models import ReportFormat, ToolType
|
|
@@ -11,8 +11,12 @@ class Jacoco(Tool):
|
|
|
11
11
|
"""JaCoCo coverage tool implementation for Java projects."""
|
|
12
12
|
_tool_type = ToolType.Jacoco
|
|
13
13
|
|
|
14
|
-
def _create_command_builder(self,
|
|
15
|
-
|
|
14
|
+
def _create_command_builder(self,
|
|
15
|
+
command,
|
|
16
|
+
tool_type = None,
|
|
17
|
+
path_arguments = None,
|
|
18
|
+
required_flags = None,
|
|
19
|
+
*extras: tuple[str, Optional[str]]) -> CommandBuilder:
|
|
16
20
|
"""
|
|
17
21
|
Creates a CommandBuilder for JaCoCo CLI commands.
|
|
18
22
|
:param command: The JaCoCo command to execute (e.g., 'report', 'dump', 'merge').
|
|
@@ -25,11 +29,11 @@ class Jacoco(Tool):
|
|
|
25
29
|
"""
|
|
26
30
|
tool_type = tool_type or self._tool_type
|
|
27
31
|
command_builder = (super()._create_command_builder(command, tool_type, path_arguments, *extras)
|
|
28
|
-
.set_execution_call(f"java -jar {os.path.relpath(
|
|
32
|
+
.set_execution_call(f"java -jar {os.path.relpath(self._path / str(tool_type.value))}"))
|
|
29
33
|
|
|
30
34
|
required_flags = required_flags or []
|
|
31
35
|
for required_flag in required_flags:
|
|
32
|
-
if required_flag not in [extra[0] for extra in
|
|
36
|
+
if required_flag not in [extra[0] for extra in extras]:
|
|
33
37
|
msg = (f"Encountered error while building {tool_type.name} command. "
|
|
34
38
|
f"JaCoCo flag option {required_flag} is required for command '{command}'.")
|
|
35
39
|
self._logger.error(msg)
|
|
@@ -39,8 +43,14 @@ class Jacoco(Tool):
|
|
|
39
43
|
|
|
40
44
|
return command_builder
|
|
41
45
|
|
|
42
|
-
def save_report(self,
|
|
43
|
-
|
|
46
|
+
def save_report(self,
|
|
47
|
+
coverage_files,
|
|
48
|
+
target_dir,
|
|
49
|
+
sourcecode_dir=None,
|
|
50
|
+
report_format = None,
|
|
51
|
+
report_formats = None,
|
|
52
|
+
build_dir = None,
|
|
53
|
+
*extras) -> Command:
|
|
44
54
|
"""
|
|
45
55
|
Creates a JaCoCo coverage report from coverage files to the given path.
|
|
46
56
|
:param coverage_files: File paths to JaCoCo .exec coverage files to create the report from.
|
|
@@ -64,11 +74,15 @@ class Jacoco(Tool):
|
|
|
64
74
|
command = command.add_option(f"--{rf.name.lower()}", str(target_dir))
|
|
65
75
|
elif rf is not None:
|
|
66
76
|
command = command.add_option(f"--{rf.name.lower()}",
|
|
67
|
-
str((
|
|
77
|
+
str((target_dir / self._get_default_target_filename())
|
|
68
78
|
.with_suffix(f".{rf.value.lower()}")))
|
|
69
79
|
return command.build_command()
|
|
70
80
|
|
|
71
|
-
def snapshot_coverage(self,
|
|
81
|
+
def snapshot_coverage(self,
|
|
82
|
+
session,
|
|
83
|
+
target_dir,
|
|
84
|
+
target_file,
|
|
85
|
+
*extras) -> Command:
|
|
72
86
|
"""
|
|
73
87
|
Triggers JaCoCo agent to dump coverage data to the given path.
|
|
74
88
|
:param session: Session identifier (not used by JaCoCo dump but kept for interface consistency).
|
|
@@ -77,7 +91,7 @@ class Jacoco(Tool):
|
|
|
77
91
|
:param extras: Extra options to pass to the JaCoCo CLI's dump command.
|
|
78
92
|
:return: A Command object configured to dump coverage data.
|
|
79
93
|
"""
|
|
80
|
-
target_path =
|
|
94
|
+
target_path = target_dir / (
|
|
81
95
|
target_file if target_file is not None else self._get_default_target_filename())
|
|
82
96
|
if not target_path.suffix:
|
|
83
97
|
target_path = target_path.with_suffix(".exec")
|
|
@@ -86,7 +100,11 @@ class Jacoco(Tool):
|
|
|
86
100
|
"dump", None, None, None, *extras)
|
|
87
101
|
return command.build_command()
|
|
88
102
|
|
|
89
|
-
def merge_coverage(self,
|
|
103
|
+
def merge_coverage(self,
|
|
104
|
+
coverage_files,
|
|
105
|
+
target_dir,
|
|
106
|
+
target_file,
|
|
107
|
+
*extras) -> Command:
|
|
90
108
|
"""
|
|
91
109
|
Merges multiple JaCoCo coverage files into a single unified coverage file.
|
|
92
110
|
:param coverage_files: File paths to JaCoCo .exec coverage files to merge.
|
|
@@ -95,7 +113,7 @@ class Jacoco(Tool):
|
|
|
95
113
|
:param extras: Extra options to pass to the JaCoCo CLI's merge command.
|
|
96
114
|
:return: A Command object configured to merge coverage files.
|
|
97
115
|
"""
|
|
98
|
-
target_path =
|
|
116
|
+
target_path = target_dir / (
|
|
99
117
|
target_file if target_file is not None else self._get_default_target_filename())
|
|
100
118
|
if not target_path.suffix:
|
|
101
119
|
target_path = target_path.with_suffix(".exec")
|
crossfit/tools/tool.py
CHANGED
|
@@ -1,27 +1,28 @@
|
|
|
1
1
|
import tempfile
|
|
2
|
-
|
|
2
|
+
|
|
3
3
|
from abc import ABC, abstractmethod
|
|
4
|
+
from logging import Logger
|
|
4
5
|
from pathlib import Path
|
|
5
|
-
from typing import
|
|
6
|
-
from crossfit
|
|
7
|
-
from crossfit.commands
|
|
8
|
-
from crossfit.models
|
|
6
|
+
from typing import Optional
|
|
7
|
+
from crossfit import Command
|
|
8
|
+
from crossfit.commands import CommandBuilder
|
|
9
|
+
from crossfit.models import ToolType, ReportFormat
|
|
9
10
|
|
|
10
11
|
|
|
11
12
|
class Tool(ABC):
|
|
12
13
|
"""Abstract base class for coverage tools. Tools build and return Commands."""
|
|
13
14
|
_tool_type: ToolType
|
|
14
15
|
_path: Optional[Path]
|
|
15
|
-
_logger:
|
|
16
|
+
_logger: Logger
|
|
16
17
|
_catch: bool
|
|
17
18
|
|
|
18
|
-
def __init__(self, logger:
|
|
19
|
+
def __init__(self, logger: Logger, path: Optional[Path] = None, catch: bool = True):
|
|
19
20
|
"""
|
|
20
21
|
:param logger: Logger instance for logging (required).
|
|
21
22
|
:param path: The path to the tool executable/jar.
|
|
22
23
|
:param catch: If True, catches exceptions and returns fallback. If False, re-raises.
|
|
23
24
|
"""
|
|
24
|
-
self._logger:
|
|
25
|
+
self._logger: Logger = logger
|
|
25
26
|
self._path: Optional[Path] = path
|
|
26
27
|
self._catch: bool = catch
|
|
27
28
|
|
|
@@ -29,9 +30,11 @@ class Tool(ABC):
|
|
|
29
30
|
"""Returns the default target filename for this tool."""
|
|
30
31
|
return f"cross-{self._tool_type.name}".lower()
|
|
31
32
|
|
|
32
|
-
def _create_command_builder(self,
|
|
33
|
-
|
|
34
|
-
|
|
33
|
+
def _create_command_builder(self,
|
|
34
|
+
command: str,
|
|
35
|
+
tool_type: Optional[ToolType] = None,
|
|
36
|
+
path_arguments: Optional[list[Path]] = None,
|
|
37
|
+
*extras: tuple[str, Optional[str]]) -> CommandBuilder:
|
|
35
38
|
"""
|
|
36
39
|
Creates a CommandBuilder for the tool's wanted functionality.
|
|
37
40
|
:param command: The command of the tool to build on.
|
|
@@ -45,8 +48,10 @@ class Tool(ABC):
|
|
|
45
48
|
|
|
46
49
|
command_builder = CommandBuilder().set_execution_call(str(tool_type.value), self._path)
|
|
47
50
|
try:
|
|
48
|
-
return command_builder
|
|
49
|
-
|
|
51
|
+
return (command_builder
|
|
52
|
+
.set_command_to_execute(command)
|
|
53
|
+
.add_path_arguments(*path_arguments)
|
|
54
|
+
.add_options(*extras))
|
|
50
55
|
except FileNotFoundError as e:
|
|
51
56
|
self._logger.error(f"Encountered exception while building {tool_type.name} command. Error - {e}")
|
|
52
57
|
if not self._catch:
|
|
@@ -54,25 +59,37 @@ class Tool(ABC):
|
|
|
54
59
|
return command_builder.set_command_body(["--help"])
|
|
55
60
|
|
|
56
61
|
@abstractmethod
|
|
57
|
-
def save_report(self,
|
|
58
|
-
|
|
59
|
-
|
|
62
|
+
def save_report(self,
|
|
63
|
+
coverage_files: list[Path],
|
|
64
|
+
target_dir: Path,
|
|
65
|
+
sourcecode_dir: Optional[Path] = None,
|
|
66
|
+
report_format: ReportFormat = None,
|
|
67
|
+
report_formats: list[ReportFormat] = None,
|
|
68
|
+
*extras: tuple[str, Optional[str]]) -> Command:
|
|
60
69
|
"""Builds a command to create a coverage report."""
|
|
61
70
|
raise NotImplementedError
|
|
62
71
|
|
|
63
72
|
@abstractmethod
|
|
64
|
-
def snapshot_coverage(self,
|
|
65
|
-
|
|
73
|
+
def snapshot_coverage(self,
|
|
74
|
+
session: str,
|
|
75
|
+
target_dir: Path,
|
|
76
|
+
target_file: Optional[Path],
|
|
77
|
+
*extras: tuple[str, Optional[str]]) -> Command:
|
|
66
78
|
"""Builds a command to snapshot coverage data."""
|
|
67
79
|
raise NotImplementedError
|
|
68
80
|
|
|
69
81
|
@abstractmethod
|
|
70
|
-
def merge_coverage(self,
|
|
71
|
-
|
|
82
|
+
def merge_coverage(self,
|
|
83
|
+
coverage_files: list[Path],
|
|
84
|
+
target_dir: Path,
|
|
85
|
+
target_file: Optional[Path],
|
|
86
|
+
*extras: tuple[str, Optional[str]]) -> Command:
|
|
72
87
|
"""Builds a command to merge coverage files."""
|
|
73
88
|
raise NotImplementedError
|
|
74
89
|
|
|
75
|
-
def reset_coverage(self,
|
|
90
|
+
def reset_coverage(self,
|
|
91
|
+
session: str,
|
|
92
|
+
*extras: tuple[str, Optional[str]]) -> Command:
|
|
76
93
|
"""
|
|
77
94
|
Builds a command to reset coverage data.
|
|
78
95
|
Uses next_command chaining to snapshot with --reset flag and then clean up temp file.
|
|
@@ -81,7 +98,7 @@ class Tool(ABC):
|
|
|
81
98
|
:returns: A Command with chained cleanup command via next_command.
|
|
82
99
|
"""
|
|
83
100
|
target_dir = Path(tempfile.gettempdir()) / r"crossfit"
|
|
84
|
-
extras
|
|
101
|
+
extras += ("--reset", None),
|
|
85
102
|
|
|
86
103
|
snapshot_command = self.snapshot_coverage(session, target_dir, None, *extras)
|
|
87
104
|
cleanup_command = CommandBuilder().with_command(["rm", "-f", str(target_dir)]).build_command()
|
crossfit/tools/tool_factory.py
CHANGED
|
@@ -1,20 +1,23 @@
|
|
|
1
|
-
import os
|
|
2
1
|
from logging import Logger
|
|
3
2
|
from pathlib import Path
|
|
4
|
-
from typing import Union
|
|
5
3
|
|
|
6
4
|
import crossfit.refs
|
|
7
5
|
from crossfit.tools import Jacoco, DotnetCoverage
|
|
8
6
|
from crossfit.models import ToolType
|
|
9
7
|
|
|
10
8
|
|
|
11
|
-
def create_tool(tool_type: ToolType, tool_path:
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
9
|
+
def create_tool(tool_type: ToolType, tool_path: Path = None, logger: Logger = None, catch: bool = True):
|
|
10
|
+
"""
|
|
11
|
+
Factory method to create a tool based on the specified type.
|
|
12
|
+
:param tool_type: The type of tool to create.
|
|
13
|
+
:param tool_path: Optional path to the tool executable.
|
|
14
|
+
:param logger: Optional logger instance for logging tool operations.
|
|
15
|
+
:param catch: Whether to catch exceptions during tool operations.
|
|
16
|
+
:return: An instance of the specified tool type.
|
|
17
|
+
"""
|
|
15
18
|
if tool_type == ToolType.Jacoco:
|
|
16
|
-
return Jacoco(logger,
|
|
19
|
+
return Jacoco(logger, tool_path or crossfit.refs.tools_dir, catch)
|
|
17
20
|
elif tool_type == ToolType.DotnetCoverage:
|
|
18
|
-
return DotnetCoverage(logger,
|
|
21
|
+
return DotnetCoverage(logger, tool_path or crossfit.refs.tools_dir, catch)
|
|
19
22
|
else:
|
|
20
23
|
raise ValueError(f"Unknown tool type: {tool_type}")
|
|
@@ -1,9 +1,20 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: SmokeCrossFit
|
|
3
|
-
Version:
|
|
3
|
+
Version: 1.0.0
|
|
4
4
|
Summary: A unified interface for various code coverage tools (JaCoCo, dotnet-coverage)
|
|
5
5
|
Requires-Python: >=3.12
|
|
6
6
|
Description-Content-Type: text/markdown
|
|
7
|
+
Requires-Dist: annotated-types~=0.7.0
|
|
8
|
+
Requires-Dist: colorama~=0.4.6
|
|
9
|
+
Requires-Dist: pydantic~=2.11.7
|
|
10
|
+
Requires-Dist: pydantic_core~=2.33.2
|
|
11
|
+
Requires-Dist: Pygments~=2.19.2
|
|
12
|
+
Requires-Dist: typeguard~=4.4.4
|
|
13
|
+
Requires-Dist: typing-inspection~=0.4.1
|
|
14
|
+
Requires-Dist: typing_extensions~=4.14.1
|
|
15
|
+
Requires-Dist: pytest>=8.4.3
|
|
16
|
+
Requires-Dist: build>=1.2.0
|
|
17
|
+
Requires-Dist: twine>=5.0.0
|
|
7
18
|
|
|
8
19
|
# CrossFit Coverage Tools
|
|
9
20
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
crossfit/__init__.py,sha256=yGycXJNRgaQySCTqhwaBsOaX8J6GWqXtEVpIcVVnAzI,374
|
|
2
|
+
crossfit/bin/tools/jacococli.jar,sha256=gRx_jGs1jF1oqJc8-oZ_aJK-emcbaXpLE8S0R-ba91w,607951
|
|
3
|
+
crossfit/commands/__init__.py,sha256=mRsGTLGRJ9f1lJ7J55AbG65z-sq33u9p_hPkFURyeqo,114
|
|
4
|
+
crossfit/commands/command.py,sha256=ZjAj5a14AMOkFm0bfIrXqUMdplSeEG0M18llmP8Ol8M,2739
|
|
5
|
+
crossfit/commands/command_builder.py,sha256=v8Nd8GAifGUew1eavTP1SMD11sPipsjvwvjydXovlM0,7060
|
|
6
|
+
crossfit/executors/__init__.py,sha256=7lUt1jO6RQwY_6xorlXaDBsOLlBradx9bKxzS-VSms0,179
|
|
7
|
+
crossfit/executors/executor.py,sha256=xPDTuP8wb9OQNC44Hy6yy9w9tDTT3NuH6oS_fXs_gp0,1665
|
|
8
|
+
crossfit/executors/executor_factory.py,sha256=Zps02ob42zM6EtuR_NOkpW2s6fxXUWUgYHOW_HlmzGk,806
|
|
9
|
+
crossfit/executors/local_executor.py,sha256=MSYo7QfF3puPBL7XaO7az-isPFXOLgla3hJduyv-RHM,3581
|
|
10
|
+
crossfit/models/__init__.py,sha256=awbAmN1HTp01PWgTB4JNwlg1EF_9w9ecSxqOaUVme4E,205
|
|
11
|
+
crossfit/models/command_models.py,sha256=FIkha9E_NKw2dP1Ax6WSUhP0EoG9z0-PwKWpEA-NUBE,817
|
|
12
|
+
crossfit/models/executor_models.py,sha256=9d4UYXKvzIMwf_COBHxg23bvBxJp21A97gJP9oAkvb0,92
|
|
13
|
+
crossfit/models/tool_models.py,sha256=CM-JKXzM563BGverMP4jQFWcqcplA5RXcNJwhoWjHHg,266
|
|
14
|
+
crossfit/refs/__init__.py,sha256=OEUVIOc-CDNp7KmmcDzKfwkz9LA7SlRtrD3Y5rjQIIU,270
|
|
15
|
+
crossfit/tools/__init__.py,sha256=YtIhLrhdEtDOOH_TMGr9_tgt59vxN-kM97I5ajeN9LY,196
|
|
16
|
+
crossfit/tools/dotnet_coverage.py,sha256=2oY1b4ON3WrjzleB5ZEfU4vaVrelMKsCqaZehzZE9tg,4616
|
|
17
|
+
crossfit/tools/jacoco.py,sha256=0ogqV_mSr3pbeCulaq6jZXgw9xk5Lqd-4_n8FKQ85hM,6408
|
|
18
|
+
crossfit/tools/tool.py,sha256=Ee_srBabhtRJ2VtwPfyrThHm8rVc-OpMbRfzJTIxLGQ,4601
|
|
19
|
+
crossfit/tools/tool_factory.py,sha256=jyXAQsIBjCp3qCvmH5AudlQxv5yHf3uik0EvWW9BAoM,967
|
|
20
|
+
smokecrossfit-1.0.0.dist-info/METADATA,sha256=lKdUlejuVlv5EjR1quNb7Ko3Jz5ye8aOjhmBY-yHFA0,6016
|
|
21
|
+
smokecrossfit-1.0.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
|
|
22
|
+
smokecrossfit-1.0.0.dist-info/top_level.txt,sha256=rDrcypRByvkrDsESoQmYOSkOKMO7eBPRToxHNQflYOI,9
|
|
23
|
+
smokecrossfit-1.0.0.dist-info/RECORD,,
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
crossfit/__init__.py,sha256=Bdtz57-tapFnCYiIa9V5k_edCRkXWKqbp13xODBEv4c,382
|
|
2
|
-
crossfit/bin/tools/jacococli.jar,sha256=gRx_jGs1jF1oqJc8-oZ_aJK-emcbaXpLE8S0R-ba91w,607951
|
|
3
|
-
crossfit/commands/__init__.py,sha256=Hiu6s_GoE0cxhtbgnc8rUXPUxRejnHOQAAfhpSHheLI,51
|
|
4
|
-
crossfit/commands/command.py,sha256=0ujP5wvzfA0P9WJfzJrucgGWBEuiZjbxs9oMtdTD8p0,2752
|
|
5
|
-
crossfit/commands/command_builder.py,sha256=GLfvt0zXDQYEirQd8VGOjAUQvnpeslk2KLQp4KMYCAw,7128
|
|
6
|
-
crossfit/executors/__init__.py,sha256=7lUt1jO6RQwY_6xorlXaDBsOLlBradx9bKxzS-VSms0,179
|
|
7
|
-
crossfit/executors/executor.py,sha256=xPDTuP8wb9OQNC44Hy6yy9w9tDTT3NuH6oS_fXs_gp0,1665
|
|
8
|
-
crossfit/executors/executor_factory.py,sha256=xSsTU3f8AgeMiFCwyGM4ZOm3p9Lp--KQRIqNY5ueaZI,389
|
|
9
|
-
crossfit/executors/local_executor.py,sha256=dNkHoY5bQxRQbniec1ZwGKt56QKbZP_qwXSW3avTfno,3435
|
|
10
|
-
crossfit/models/__init__.py,sha256=awbAmN1HTp01PWgTB4JNwlg1EF_9w9ecSxqOaUVme4E,205
|
|
11
|
-
crossfit/models/command_models.py,sha256=0bK7deXh16SRMPtHXTyYmqScAVoRzyycO3uNRgImBHo,818
|
|
12
|
-
crossfit/models/executor_models.py,sha256=9d4UYXKvzIMwf_COBHxg23bvBxJp21A97gJP9oAkvb0,92
|
|
13
|
-
crossfit/models/tool_models.py,sha256=CM-JKXzM563BGverMP4jQFWcqcplA5RXcNJwhoWjHHg,266
|
|
14
|
-
crossfit/refs/__init__.py,sha256=OEUVIOc-CDNp7KmmcDzKfwkz9LA7SlRtrD3Y5rjQIIU,270
|
|
15
|
-
crossfit/tools/__init__.py,sha256=YtIhLrhdEtDOOH_TMGr9_tgt59vxN-kM97I5ajeN9LY,196
|
|
16
|
-
crossfit/tools/dotnet_coverage.py,sha256=1NBkj6Inb-qf3LITciu1248oboMhQTShFqveu-tkW0U,4359
|
|
17
|
-
crossfit/tools/jacoco.py,sha256=oLw895WvaVk_2mSeI3vAh7vWswg-daMzTEnl26tx1cY,5992
|
|
18
|
-
crossfit/tools/tool.py,sha256=OL3xVMf56UdCnahwX1rz-U7qZcXWFo7ep5B0CCu6RFs,4296
|
|
19
|
-
crossfit/tools/tool_factory.py,sha256=Fstp2NlIOsfYY6UX8vefJ7_ClrojnsbOMA7J63dDl58,741
|
|
20
|
-
smokecrossfit-0.0.0.dist-info/METADATA,sha256=aCChRaK7lsbSmxFrrKw_6pREAgJLZlX7J7Chd8G-sEc,5648
|
|
21
|
-
smokecrossfit-0.0.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
|
|
22
|
-
smokecrossfit-0.0.0.dist-info/top_level.txt,sha256=rDrcypRByvkrDsESoQmYOSkOKMO7eBPRToxHNQflYOI,9
|
|
23
|
-
smokecrossfit-0.0.0.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|