ScriptCollection 4.3.63__py3-none-any.whl → 4.4.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.
Files changed (38) hide show
  1. ScriptCollection/AnionBuildPlatform.py +205 -205
  2. ScriptCollection/CertificateUpdater.py +157 -155
  3. ScriptCollection/Executables.py +4 -2
  4. ScriptCollection/GeneralUtilities.py +1696 -1696
  5. ScriptCollection/OCIImages/OCIImageManager.py +278 -278
  6. ScriptCollection/ProcessesRunner.py +43 -43
  7. ScriptCollection/ProgramRunnerSudo.py +110 -110
  8. ScriptCollection/Resources/CultureChooser/CultureChooser.js +0 -0
  9. ScriptCollection/Resources/CultureChooser/index.html +0 -0
  10. ScriptCollection/Resources/Dependencies/JRE/Version.txt +0 -0
  11. ScriptCollection/Resources/Dependencies/OpenAPIGenerator/Version.txt +0 -0
  12. ScriptCollection/Resources/Dependencies/PlantUML/Version.txt +0 -0
  13. ScriptCollection/Resources/Fonts/DejaVuSans-Bold.ttf +0 -0
  14. ScriptCollection/Resources/Fonts/DejaVuSans-BoldOblique.ttf +0 -0
  15. ScriptCollection/Resources/Fonts/DejaVuSans-Oblique.ttf +0 -0
  16. ScriptCollection/Resources/Fonts/DejaVuSans.ttf +0 -0
  17. ScriptCollection/Resources/Fonts/LICENSE.txt +0 -0
  18. ScriptCollection/Resources/MaintenanceSite/MaintenanceSite.html +0 -0
  19. ScriptCollection/SCLog.py +115 -115
  20. ScriptCollection/ScriptCollectionCore.py +4372 -4292
  21. ScriptCollection/TFCPS/Docker/TFCPS_CodeUnitSpecific_Docker.py +8 -2
  22. ScriptCollection/TFCPS/DotNet/TFCPS_CodeUnitSpecific_DotNet.py +716 -709
  23. ScriptCollection/TFCPS/NodeJS/TFCPS_CodeUnitSpecific_NodeJS.py +235 -235
  24. ScriptCollection/TFCPS/Python/TFCPS_CodeUnitSpecific_Python.py +258 -258
  25. ScriptCollection/TFCPS/TFCPS_CodeUnitSpecific_Base.py +524 -524
  26. ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnit.py +157 -155
  27. ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnits.py +691 -672
  28. ScriptCollection/TFCPS/TFCPS_CreateRelease.py +98 -98
  29. ScriptCollection/TFCPS/TFCPS_Generic.py +44 -44
  30. ScriptCollection/TFCPS/TFCPS_MergeToMain.py +132 -131
  31. ScriptCollection/TFCPS/TFCPS_MergeToStable.py +358 -358
  32. ScriptCollection/TFCPS/TFCPS_PreBuildCodeunitsScript.py +48 -48
  33. ScriptCollection/TFCPS/TFCPS_Tools_General.py +38 -8
  34. {scriptcollection-4.3.63.dist-info → scriptcollection-4.4.0.dist-info}/METADATA +1 -1
  35. {scriptcollection-4.3.63.dist-info → scriptcollection-4.4.0.dist-info}/RECORD +27 -27
  36. {scriptcollection-4.3.63.dist-info → scriptcollection-4.4.0.dist-info}/WHEEL +0 -0
  37. {scriptcollection-4.3.63.dist-info → scriptcollection-4.4.0.dist-info}/entry_points.txt +0 -0
  38. {scriptcollection-4.3.63.dist-info → scriptcollection-4.4.0.dist-info}/top_level.txt +0 -0
@@ -1,258 +1,258 @@
1
- import os
2
- import re
3
- import tempfile
4
- from ...GeneralUtilities import GeneralUtilities,Dependency
5
- from ...SCLog import LogLevel
6
- from ..TFCPS_CodeUnitSpecific_Base import TFCPS_CodeUnitSpecific_Base,TFCPS_CodeUnitSpecific_Base_CLI
7
-
8
- class TFCPS_CodeUnitSpecific_Python_Functions(TFCPS_CodeUnitSpecific_Base):
9
-
10
- def __init__(self,current_file:str,verbosity:LogLevel,targetenvironmenttype:str,use_cache:bool,is_pre_merge:bool):
11
- super().__init__(current_file, verbosity,targetenvironmenttype,use_cache,is_pre_merge)
12
-
13
-
14
- @GeneralUtilities.check_arguments
15
- def build(self) -> None:
16
- codeunit_folder = self.get_codeunit_folder()
17
- target_directory = GeneralUtilities.resolve_relative_path("../Artifacts/BuildResult_Wheel", os.path.join(self.get_artifacts_folder()))
18
- GeneralUtilities.ensure_directory_does_not_exist(os.path.join(self.get_codeunit_folder(),".pytest_cache"))
19
- GeneralUtilities.ensure_directory_does_not_exist(os.path.join(self.get_codeunit_folder(),"__pycache__"))
20
- GeneralUtilities.ensure_directory_does_not_exist(os.path.join(self.get_codeunit_folder(),"build"))
21
- GeneralUtilities.ensure_directory_does_not_exist(os.path.join(self.get_codeunit_folder(),f"{self.get_codeunit_name()}.egg-info"))
22
- GeneralUtilities.ensure_directory_exists(target_directory)
23
- self._protected_sc.run_program(GeneralUtilities.get_python_executable(), f"-m build --wheel --outdir {target_directory}", codeunit_folder,print_live_output=self.get_verbosity()==LogLevel.Debug)
24
- self.generate_bom_for_python_project()
25
- self.copy_source_files_to_output_directory()
26
-
27
- @GeneralUtilities.check_arguments
28
- def generate_bom_for_python_project(self) -> None:
29
- codeunit_folder: str=self.get_codeunit_folder()
30
- codeunitname: str=self.get_codeunit_name()
31
- repository_folder = os.path.dirname(codeunit_folder)
32
- codeunitversion = self.tfcps_Tools_General.get_version_of_codeunit(self.get_codeunit_file())
33
- bom_folder = "Other/Artifacts/BOM"
34
- bom_folder_full = os.path.join(codeunit_folder, bom_folder)
35
- GeneralUtilities.ensure_directory_exists(bom_folder_full)
36
- if not os.path.isfile(os.path.join(codeunit_folder, "requirements.txt")):
37
- raise ValueError(f"Codeunit {codeunitname} does not have a 'requirements.txt'-file.")
38
- # TODO check that all values from pyproject.cfg are contained in requirements.txt
39
- result = self._protected_sc.run_program("cyclonedx-py", "requirements", codeunit_folder)
40
- bom_file_relative_json = f"{bom_folder}/{codeunitname}.{codeunitversion}.bom.json"
41
- bom_file_relative_xml = f"{bom_folder}/{codeunitname}.{codeunitversion}.bom.xml"
42
- bom_file_json = os.path.join(codeunit_folder, bom_file_relative_json)
43
- bom_file_xml = os.path.join(codeunit_folder, bom_file_relative_xml)
44
-
45
- enabled:bool=False
46
- if enabled:#TODO cyclonedx must be available for all platforms in the global sc-cache-folder
47
- GeneralUtilities.ensure_file_exists(bom_file_json)
48
- GeneralUtilities.write_text_to_file(bom_file_json, result[1])
49
- cyclonedx_exe=self.tfcps_Tools_General.ensure_cyclonedxcli_is_available(not self.use_cache())
50
- self._protected_sc.run_program(cyclonedx_exe, f"convert --input-file ./{codeunitname}/{bom_file_relative_json} --input-format json --output-file ./{codeunitname}/{bom_file_relative_xml} --output-format xml", repository_folder)
51
- self._protected_sc.format_xml_file(bom_file_xml)
52
- GeneralUtilities.ensure_file_does_not_exist(bom_file_json)
53
-
54
- @GeneralUtilities.check_arguments
55
- def linting(self) -> None:
56
- codeunitname: str = self.get_codeunit_name()
57
-
58
- repository_folder: str = self.get_repository_folder()
59
- codeunit_folder = os.path.join(repository_folder, codeunitname)
60
- errors_found = False
61
- self._protected_sc.log.log(f"Check for linting-issues in codeunit {codeunitname}.")
62
- src_folder = os.path.join(codeunit_folder, codeunitname)
63
- tests_folder = src_folder+"Tests"
64
- # The codeunit gets linted in an isolated folder which only contains this codeunit. This is required because otherwise sibling-codeunit-source-folders of the repository would shadow the installed dependency-packages of the same name during pylint's import-resolution (pylint adds the repository-folder to sys.path due to the package-nesting), which would result in false-positive import-errors. In the isolated folder the declared (and installed) dependency-codeunits are resolved instead.
65
- ignored_subfolders = ["Other", "__pycache__", "*.egg-info", "build", "dist", "venv", ".venv", ".pytest_cache", ".git"]
66
- with tempfile.TemporaryDirectory(dir=GeneralUtilities.get_temp_folder()) as isolation_folder:
67
- isolated_codeunit_folder = os.path.join(isolation_folder, codeunitname)
68
- GeneralUtilities.copy_content_of_folder(codeunit_folder, isolated_codeunit_folder, ignored_glob_patterms=ignored_subfolders)
69
- pylint_configuration_file = os.path.join(repository_folder, ".pylintrc")
70
- if os.path.isfile(pylint_configuration_file):
71
- GeneralUtilities.safe_copy(pylint_configuration_file, os.path.join(isolation_folder, ".pylintrc"))
72
- # TODO check if there are errors in sarif-file
73
- for file in GeneralUtilities.get_all_files_of_folder(src_folder)+GeneralUtilities.get_all_files_of_folder(tests_folder):
74
- relative_file_path_in_repository = os.path.relpath(file, repository_folder)
75
- if file.endswith(".py") and os.path.getsize(file) > 0 and not self._protected_sc.file_is_git_ignored(relative_file_path_in_repository, repository_folder):
76
- relative_file_path_in_codeunit = os.path.relpath(file, codeunit_folder)
77
- self._protected_sc.log.log(f"Check for linting-issues in {relative_file_path_in_codeunit}.")
78
- isolated_file = os.path.join(isolated_codeunit_folder, relative_file_path_in_codeunit)
79
- linting_result = self._protected_sc.python_file_has_errors(isolated_file, isolation_folder, display_file=file)
80
- if (linting_result[0]):
81
- errors_found = True
82
- for error in linting_result[1]:
83
- self._protected_sc.log.log(error, LogLevel.Warning)
84
- if errors_found:
85
- raise ValueError("Linting-issues occurred.")
86
- else:
87
- self._protected_sc.log.log("No linting-issues found.")
88
-
89
- @GeneralUtilities.check_arguments
90
- def do_common_tasks(self,current_codeunit_version:str )-> None:
91
- self.do_common_tasks_base(current_codeunit_version)
92
- codeunitname =self.get_codeunit_name()
93
- codeunit_version = self.tfcps_Tools_General.get_version_of_project(self.get_repository_folder())
94
- self._protected_sc.replace_version_in_ini_file(GeneralUtilities.resolve_relative_path("./pyproject.toml", self.get_codeunit_folder()), codeunit_version)
95
- self._protected_sc.replace_version_in_python_file(GeneralUtilities.resolve_relative_path(f"./{codeunitname}/{codeunitname}Core.py", self.get_codeunit_folder()), codeunit_version)
96
-
97
- @GeneralUtilities.check_arguments
98
- def generate_reference(self) -> None:
99
- self.generate_reference_using_docfx()
100
-
101
- @GeneralUtilities.check_arguments
102
- def run_testcases(self) -> None:
103
- codeunitname: str =self.get_codeunit_name()
104
- repository_folder: str = self.get_repository_folder()
105
- codeunit_folder = os.path.join(repository_folder, codeunitname)
106
- self._protected_sc.run_program("coverage", f"run -m pytest -s ./{codeunitname}Tests", codeunit_folder)
107
- self._protected_sc.run_program("coverage", "xml", codeunit_folder)
108
- coveragefolder = os.path.join(repository_folder, codeunitname, "Other/Artifacts/TestCoverage")
109
- GeneralUtilities.ensure_directory_exists(coveragefolder)
110
- coveragefile = os.path.join(coveragefolder, "TestCoverage.xml")
111
- GeneralUtilities.ensure_file_does_not_exist(coveragefile)
112
- os.rename(os.path.join(repository_folder, codeunitname, "coverage.xml"), coveragefile)
113
- self.tfcps_Tools_General.merge_packages(coveragefile,codeunitname)
114
- self.run_testcases_common_post_task(repository_folder, codeunitname, True, self.get_type_environment_type())
115
-
116
- @GeneralUtilities.check_arguments
117
- def get_dependencies(self)->dict[str,set[str]]:
118
- return GeneralUtilities.merge_dependency_lists([
119
- self.get_dependencies_from_pyprojecttoml(),
120
- self.get_dependencies_from_requirementstxt(),
121
- self.get_dependencies_from_otherrequirementstxt()
122
- ])
123
-
124
- @GeneralUtilities.check_arguments
125
- def get_dependencies_from_pyprojecttoml(self)->list[Dependency]:
126
- setupcfg_file=os.path.join(self.get_codeunit_folder(),"pyproject.toml")
127
- lines = GeneralUtilities.read_lines_from_file(setupcfg_file)
128
- result:list[Dependency]=[]
129
- is_in_dependency_section=False
130
- for line in lines:
131
- if line=="dependencies = [":
132
- is_in_dependency_section=True
133
- elif line.startswith(" "):
134
- if is_in_dependency_section:
135
- stripped = line.strip()
136
- if not stripped or stripped.startswith("#"):
137
- continue
138
- if stripped.endswith(","):
139
- stripped = stripped[:-1].rstrip()
140
- if len(stripped) >= 2 and stripped[0] in ('"', "'") and stripped[-1] == stripped[0]:
141
- stripped = stripped[1:-1]
142
- match = re.match(r"^([A-Za-z0-9_\-\.]+)\s*([<>=!~]+)?\s*(.*)?$", stripped)
143
- if match:
144
- dep_name = match.group(1)
145
- dep_operator = match.group(2) or None#pylint:disable=unused-variable
146
- dep_version = match.group(3) or None
147
- dep=Dependency(dep_name,dep_version)
148
- result.append(dep)
149
- else:
150
- raise ValueError(f"Unparsable dependency-definition-line: \"{line}\"")
151
- else:
152
- is_in_dependency_section=False
153
- return result
154
-
155
- @GeneralUtilities.check_arguments
156
- def get_dependencies_from_requirementstxt(self)->list[Dependency]:
157
- return self.get_dependencies_from_requirementsfile(os.path.join(self.get_codeunit_folder(),"requirements.txt"))
158
-
159
- @GeneralUtilities.check_arguments
160
- def get_dependencies_from_otherrequirementstxt(self)->list[Dependency]:
161
- rfile=os.path.join(self.get_codeunit_folder(),"Other","requirements.txt")
162
- if os.path.isfile(rfile):
163
- return self.get_dependencies_from_requirementsfile(rfile)
164
- else:
165
- return []
166
-
167
- @GeneralUtilities.check_arguments
168
- def get_dependencies_from_requirementsfile(self,file:str)->list[Dependency]:
169
- lines = GeneralUtilities.read_lines_from_file(file)
170
- result:list[Dependency]=[]
171
- for line in lines:
172
- match = re.match(r"^([A-Za-z0-9_\-]+)\s*([<>=!~]+)?\s*(.*)?$", line)
173
- if match:
174
- dep_name = match.group(1)
175
- dep_operator = match.group(2) or None#pylint:disable=unused-variable
176
- dep_version = match.group(3) or None
177
- dep=Dependency(dep_name,dep_version)
178
- result.append(dep)
179
-
180
- return result
181
-
182
- @GeneralUtilities.check_arguments
183
- def get_available_versions(self,dependencyname:str)->list[str]:
184
- result=self._protected_sc.run_program("pip3",f"index versions {dependencyname}")
185
- available_versions_line:str=[line for line in GeneralUtilities.string_to_lines(result[1]) if line.startswith("Available versions: ")][0]
186
- available_versions=[version_str.strip() for version_str in available_versions_line[len("Available versions: "):].split(",")]
187
- result=[]
188
- for v in available_versions:
189
- if re.match(r"^(\d+)\.(\d+)\.(\d+)$", v) is not None:
190
- result.append(v)
191
- elif re.match(r"^(\d+)\.(\d+)$", v) is not None:
192
- result.append(v+".0")
193
- elif re.match(r"^(\d+)$", v) is not None:
194
- result.append(v+".0.0")
195
- return result
196
-
197
- @GeneralUtilities.check_arguments
198
- def set_dependency_version(self,name:str,new_version:str)->None:
199
- self.__set_dependency_version_in_pyprojecttoml(name,new_version)
200
- self.__set_dependency_version_in_requirementstxt(name,new_version)
201
- self.__set_dependency_version_in_otherrequirementstxt(name,new_version)
202
-
203
- @GeneralUtilities.check_arguments
204
- def __set_dependency_version_in_pyprojecttoml(self,name:str,new_version:str)->None:
205
- setupcfg_file=os.path.join(self.get_codeunit_folder(),"pyproject.toml")
206
- lines=GeneralUtilities.read_lines_from_file(setupcfg_file)
207
- new_lines:list[str]=[]
208
- for line in lines:
209
- match = re.match(r'^(\s*)"(' + re.escape(name) + r')\s*([<>=!~]+)?\s*([^"]*?)"(,?)\s*$', line)
210
- if match:
211
- whitespace = match.group(1)
212
- dep_operator = match.group(3) or ">="
213
- comma = match.group(5)
214
- new_line = f'{whitespace}"{name}{dep_operator}{new_version}"{comma}'
215
- new_lines.append(new_line)
216
- else:
217
- new_lines.append(line)
218
- GeneralUtilities.write_lines_to_file(setupcfg_file,new_lines)
219
-
220
- @GeneralUtilities.check_arguments
221
- def __set_dependency_version_in_requirementstxt(self,name:str,new_version:str)->None:
222
- self.__set_dependency_version_in_requirements(name,new_version,os.path.join(self.get_codeunit_folder(),"requirements.txt"))
223
-
224
- @GeneralUtilities.check_arguments
225
- def __set_dependency_version_in_otherrequirementstxt(self,name:str,new_version:str)->None:
226
- rfile=os.path.join(self.get_codeunit_folder(),"Other","requirements.txt")
227
- if os.path.isfile(rfile):
228
- self.__set_dependency_version_in_requirements(name,new_version,rfile)
229
-
230
- @GeneralUtilities.check_arguments
231
- def __set_dependency_version_in_requirements(self,name:str,new_version:str,requirementsfile:str)->None:
232
- lines=GeneralUtilities.read_lines_from_file(requirementsfile)
233
- new_lines:list[str]=[]
234
- for line in lines:
235
- match = re.match("^("+re.escape(name)+")\\s*([<>=!~]+)?\\s*(.*)?$", line)
236
- if match:
237
- dep_name = match.group(1)#pylint:disable=unused-variable
238
- dep_operator = match.group(2) or None
239
- dep_version = match.group(3) or None#pylint:disable=unused-variable
240
- new_line=name
241
- if dep_operator is None:
242
- dep_operator=">="
243
- new_line=new_line+dep_operator+new_version
244
- new_lines.append(new_line)
245
- else:
246
- new_lines.append(line)
247
- GeneralUtilities.write_lines_to_file(requirementsfile,new_lines)
248
-
249
- class TFCPS_CodeUnitSpecific_Python_CLI:
250
-
251
- @staticmethod
252
- @GeneralUtilities.check_arguments
253
- def parse(file:str)->TFCPS_CodeUnitSpecific_Python_Functions:
254
- parser=TFCPS_CodeUnitSpecific_Base_CLI.get_base_parser()
255
- #add custom parameter if desired
256
- args=parser.parse_args()
257
- result:TFCPS_CodeUnitSpecific_Python_Functions=TFCPS_CodeUnitSpecific_Python_Functions(file,LogLevel(int(args.verbosity)),args.targetenvironmenttype,not args.nocache,args.ispremerge)
258
- return result
1
+ import os
2
+ import re
3
+ import tempfile
4
+ from ...GeneralUtilities import GeneralUtilities,Dependency
5
+ from ...SCLog import LogLevel
6
+ from ..TFCPS_CodeUnitSpecific_Base import TFCPS_CodeUnitSpecific_Base,TFCPS_CodeUnitSpecific_Base_CLI
7
+
8
+ class TFCPS_CodeUnitSpecific_Python_Functions(TFCPS_CodeUnitSpecific_Base):
9
+
10
+ def __init__(self,current_file:str,verbosity:LogLevel,targetenvironmenttype:str,use_cache:bool,is_pre_merge:bool):
11
+ super().__init__(current_file, verbosity,targetenvironmenttype,use_cache,is_pre_merge)
12
+
13
+
14
+ @GeneralUtilities.check_arguments
15
+ def build(self) -> None:
16
+ codeunit_folder = self.get_codeunit_folder()
17
+ target_directory = GeneralUtilities.resolve_relative_path("../Artifacts/BuildResult_Wheel", os.path.join(self.get_artifacts_folder()))
18
+ GeneralUtilities.ensure_directory_does_not_exist(os.path.join(self.get_codeunit_folder(),".pytest_cache"))
19
+ GeneralUtilities.ensure_directory_does_not_exist(os.path.join(self.get_codeunit_folder(),"__pycache__"))
20
+ GeneralUtilities.ensure_directory_does_not_exist(os.path.join(self.get_codeunit_folder(),"build"))
21
+ GeneralUtilities.ensure_directory_does_not_exist(os.path.join(self.get_codeunit_folder(),f"{self.get_codeunit_name()}.egg-info"))
22
+ GeneralUtilities.ensure_directory_exists(target_directory)
23
+ self._protected_sc.run_program(GeneralUtilities.get_python_executable(), f"-m build --wheel --outdir {target_directory}", codeunit_folder,print_live_output=self.get_verbosity()==LogLevel.Debug)
24
+ self.generate_bom_for_python_project()
25
+ self.copy_source_files_to_output_directory()
26
+
27
+ @GeneralUtilities.check_arguments
28
+ def generate_bom_for_python_project(self) -> None:
29
+ codeunit_folder: str=self.get_codeunit_folder()
30
+ codeunitname: str=self.get_codeunit_name()
31
+ repository_folder = os.path.dirname(codeunit_folder)
32
+ codeunitversion = self.tfcps_Tools_General.get_version_of_codeunit(self.get_codeunit_file())
33
+ bom_folder = "Other/Artifacts/BOM"
34
+ bom_folder_full = os.path.join(codeunit_folder, bom_folder)
35
+ GeneralUtilities.ensure_directory_exists(bom_folder_full)
36
+ if not os.path.isfile(os.path.join(codeunit_folder, "requirements.txt")):
37
+ raise ValueError(f"Codeunit {codeunitname} does not have a 'requirements.txt'-file.")
38
+ # TODO check that all values from pyproject.cfg are contained in requirements.txt
39
+ result = self._protected_sc.run_program("cyclonedx-py", "requirements", codeunit_folder)
40
+ bom_file_relative_json = f"{bom_folder}/{codeunitname}.{codeunitversion}.bom.json"
41
+ bom_file_relative_xml = f"{bom_folder}/{codeunitname}.{codeunitversion}.bom.xml"
42
+ bom_file_json = os.path.join(codeunit_folder, bom_file_relative_json)
43
+ bom_file_xml = os.path.join(codeunit_folder, bom_file_relative_xml)
44
+
45
+ enabled:bool=False
46
+ if enabled:#TODO cyclonedx must be available for all platforms in the global sc-cache-folder
47
+ GeneralUtilities.ensure_file_exists(bom_file_json)
48
+ GeneralUtilities.write_text_to_file(bom_file_json, result[1])
49
+ cyclonedx_exe=self.tfcps_Tools_General.ensure_cyclonedxcli_is_available(not self.use_cache())
50
+ self._protected_sc.run_program(cyclonedx_exe, f"convert --input-file ./{codeunitname}/{bom_file_relative_json} --input-format json --output-file ./{codeunitname}/{bom_file_relative_xml} --output-format xml", repository_folder)
51
+ self._protected_sc.format_xml_file(bom_file_xml)
52
+ GeneralUtilities.ensure_file_does_not_exist(bom_file_json)
53
+
54
+ @GeneralUtilities.check_arguments
55
+ def linting(self) -> None:
56
+ codeunitname: str = self.get_codeunit_name()
57
+
58
+ repository_folder: str = self.get_repository_folder()
59
+ codeunit_folder = os.path.join(repository_folder, codeunitname)
60
+ errors_found = False
61
+ self._protected_sc.log.log(f"Check for linting-issues in codeunit {codeunitname}.")
62
+ src_folder = os.path.join(codeunit_folder, codeunitname)
63
+ tests_folder = src_folder+"Tests"
64
+ # The codeunit gets linted in an isolated folder which only contains this codeunit. This is required because otherwise sibling-codeunit-source-folders of the repository would shadow the installed dependency-packages of the same name during pylint's import-resolution (pylint adds the repository-folder to sys.path due to the package-nesting), which would result in false-positive import-errors. In the isolated folder the declared (and installed) dependency-codeunits are resolved instead.
65
+ ignored_subfolders = ["Other", "__pycache__", "*.egg-info", "build", "dist", "venv", ".venv", ".pytest_cache", ".git"]
66
+ with tempfile.TemporaryDirectory(dir=GeneralUtilities.get_temp_folder()) as isolation_folder:
67
+ isolated_codeunit_folder = os.path.join(isolation_folder, codeunitname)
68
+ GeneralUtilities.copy_content_of_folder(codeunit_folder, isolated_codeunit_folder, ignored_glob_patterms=ignored_subfolders)
69
+ pylint_configuration_file = os.path.join(repository_folder, ".pylintrc")
70
+ if os.path.isfile(pylint_configuration_file):
71
+ GeneralUtilities.safe_copy(pylint_configuration_file, os.path.join(isolation_folder, ".pylintrc"))
72
+ # TODO check if there are errors in sarif-file
73
+ for file in GeneralUtilities.get_all_files_of_folder(src_folder)+GeneralUtilities.get_all_files_of_folder(tests_folder):
74
+ relative_file_path_in_repository = os.path.relpath(file, repository_folder)
75
+ if file.endswith(".py") and os.path.getsize(file) > 0 and not self._protected_sc.file_is_git_ignored(relative_file_path_in_repository, repository_folder):
76
+ relative_file_path_in_codeunit = os.path.relpath(file, codeunit_folder)
77
+ self._protected_sc.log.log(f"Check for linting-issues in {relative_file_path_in_codeunit}.")
78
+ isolated_file = os.path.join(isolated_codeunit_folder, relative_file_path_in_codeunit)
79
+ linting_result = self._protected_sc.python_file_has_errors(isolated_file, isolation_folder, display_file=file)
80
+ if (linting_result[0]):
81
+ errors_found = True
82
+ for error in linting_result[1]:
83
+ self._protected_sc.log.log(error, LogLevel.Warning)
84
+ if errors_found:
85
+ raise ValueError("Linting-issues occurred.")
86
+ else:
87
+ self._protected_sc.log.log("No linting-issues found.")
88
+
89
+ @GeneralUtilities.check_arguments
90
+ def do_common_tasks(self,current_codeunit_version:str )-> None:
91
+ self.do_common_tasks_base(current_codeunit_version)
92
+ codeunitname =self.get_codeunit_name()
93
+ codeunit_version = self.tfcps_Tools_General.get_version_of_project(self.get_repository_folder())
94
+ self._protected_sc.replace_version_in_ini_file(GeneralUtilities.resolve_relative_path("./pyproject.toml", self.get_codeunit_folder()), codeunit_version)
95
+ self._protected_sc.replace_version_in_python_file(GeneralUtilities.resolve_relative_path(f"./{codeunitname}/{codeunitname}Core.py", self.get_codeunit_folder()), codeunit_version)
96
+
97
+ @GeneralUtilities.check_arguments
98
+ def generate_reference(self) -> None:
99
+ self.generate_reference_using_docfx()
100
+
101
+ @GeneralUtilities.check_arguments
102
+ def run_testcases(self) -> None:
103
+ codeunitname: str =self.get_codeunit_name()
104
+ repository_folder: str = self.get_repository_folder()
105
+ codeunit_folder = os.path.join(repository_folder, codeunitname)
106
+ self._protected_sc.run_program("coverage", f"run -m pytest -s ./{codeunitname}Tests", codeunit_folder)
107
+ self._protected_sc.run_program("coverage", "xml", codeunit_folder)
108
+ coveragefolder = os.path.join(repository_folder, codeunitname, "Other/Artifacts/TestCoverage")
109
+ GeneralUtilities.ensure_directory_exists(coveragefolder)
110
+ coveragefile = os.path.join(coveragefolder, "TestCoverage.xml")
111
+ GeneralUtilities.ensure_file_does_not_exist(coveragefile)
112
+ os.rename(os.path.join(repository_folder, codeunitname, "coverage.xml"), coveragefile)
113
+ self.tfcps_Tools_General.merge_packages(coveragefile,codeunitname)
114
+ self.run_testcases_common_post_task(repository_folder, codeunitname, True, self.get_type_environment_type())
115
+
116
+ @GeneralUtilities.check_arguments
117
+ def get_dependencies(self)->dict[str,set[str]]:
118
+ return GeneralUtilities.merge_dependency_lists([
119
+ self.get_dependencies_from_pyprojecttoml(),
120
+ self.get_dependencies_from_requirementstxt(),
121
+ self.get_dependencies_from_otherrequirementstxt()
122
+ ])
123
+
124
+ @GeneralUtilities.check_arguments
125
+ def get_dependencies_from_pyprojecttoml(self)->list[Dependency]:
126
+ setupcfg_file=os.path.join(self.get_codeunit_folder(),"pyproject.toml")
127
+ lines = GeneralUtilities.read_lines_from_file(setupcfg_file)
128
+ result:list[Dependency]=[]
129
+ is_in_dependency_section=False
130
+ for line in lines:
131
+ if line=="dependencies = [":
132
+ is_in_dependency_section=True
133
+ elif line.startswith(" "):
134
+ if is_in_dependency_section:
135
+ stripped = line.strip()
136
+ if not stripped or stripped.startswith("#"):
137
+ continue
138
+ if stripped.endswith(","):
139
+ stripped = stripped[:-1].rstrip()
140
+ if len(stripped) >= 2 and stripped[0] in ('"', "'") and stripped[-1] == stripped[0]:
141
+ stripped = stripped[1:-1]
142
+ match = re.match(r"^([A-Za-z0-9_\-\.]+)\s*([<>=!~]+)?\s*(.*)?$", stripped)
143
+ if match:
144
+ dep_name = match.group(1)
145
+ dep_operator = match.group(2) or None#pylint:disable=unused-variable
146
+ dep_version = match.group(3) or None
147
+ dep=Dependency(dep_name,dep_version)
148
+ result.append(dep)
149
+ else:
150
+ raise ValueError(f"Unparsable dependency-definition-line: \"{line}\"")
151
+ else:
152
+ is_in_dependency_section=False
153
+ return result
154
+
155
+ @GeneralUtilities.check_arguments
156
+ def get_dependencies_from_requirementstxt(self)->list[Dependency]:
157
+ return self.get_dependencies_from_requirementsfile(os.path.join(self.get_codeunit_folder(),"requirements.txt"))
158
+
159
+ @GeneralUtilities.check_arguments
160
+ def get_dependencies_from_otherrequirementstxt(self)->list[Dependency]:
161
+ rfile=os.path.join(self.get_codeunit_folder(),"Other","requirements.txt")
162
+ if os.path.isfile(rfile):
163
+ return self.get_dependencies_from_requirementsfile(rfile)
164
+ else:
165
+ return []
166
+
167
+ @GeneralUtilities.check_arguments
168
+ def get_dependencies_from_requirementsfile(self,file:str)->list[Dependency]:
169
+ lines = GeneralUtilities.read_lines_from_file(file)
170
+ result:list[Dependency]=[]
171
+ for line in lines:
172
+ match = re.match(r"^([A-Za-z0-9_\-]+)\s*([<>=!~]+)?\s*(.*)?$", line)
173
+ if match:
174
+ dep_name = match.group(1)
175
+ dep_operator = match.group(2) or None#pylint:disable=unused-variable
176
+ dep_version = match.group(3) or None
177
+ dep=Dependency(dep_name,dep_version)
178
+ result.append(dep)
179
+
180
+ return result
181
+
182
+ @GeneralUtilities.check_arguments
183
+ def get_available_versions(self,dependencyname:str)->list[str]:
184
+ result=self._protected_sc.run_program("pip3",f"index versions {dependencyname}")
185
+ available_versions_line:str=[line for line in GeneralUtilities.string_to_lines(result[1]) if line.startswith("Available versions: ")][0]
186
+ available_versions=[version_str.strip() for version_str in available_versions_line[len("Available versions: "):].split(",")]
187
+ result=[]
188
+ for v in available_versions:
189
+ if re.match(r"^(\d+)\.(\d+)\.(\d+)$", v) is not None:
190
+ result.append(v)
191
+ elif re.match(r"^(\d+)\.(\d+)$", v) is not None:
192
+ result.append(v+".0")
193
+ elif re.match(r"^(\d+)$", v) is not None:
194
+ result.append(v+".0.0")
195
+ return result
196
+
197
+ @GeneralUtilities.check_arguments
198
+ def set_dependency_version(self,name:str,new_version:str)->None:
199
+ self.__set_dependency_version_in_pyprojecttoml(name,new_version)
200
+ self.__set_dependency_version_in_requirementstxt(name,new_version)
201
+ self.__set_dependency_version_in_otherrequirementstxt(name,new_version)
202
+
203
+ @GeneralUtilities.check_arguments
204
+ def __set_dependency_version_in_pyprojecttoml(self,name:str,new_version:str)->None:
205
+ setupcfg_file=os.path.join(self.get_codeunit_folder(),"pyproject.toml")
206
+ lines=GeneralUtilities.read_lines_from_file(setupcfg_file)
207
+ new_lines:list[str]=[]
208
+ for line in lines:
209
+ match = re.match(r'^(\s*)"(' + re.escape(name) + r')\s*([<>=!~]+)?\s*([^"]*?)"(,?)\s*$', line)
210
+ if match:
211
+ whitespace = match.group(1)
212
+ dep_operator = match.group(3) or ">="
213
+ comma = match.group(5)
214
+ new_line = f'{whitespace}"{name}{dep_operator}{new_version}"{comma}'
215
+ new_lines.append(new_line)
216
+ else:
217
+ new_lines.append(line)
218
+ GeneralUtilities.write_lines_to_file(setupcfg_file,new_lines)
219
+
220
+ @GeneralUtilities.check_arguments
221
+ def __set_dependency_version_in_requirementstxt(self,name:str,new_version:str)->None:
222
+ self.__set_dependency_version_in_requirements(name,new_version,os.path.join(self.get_codeunit_folder(),"requirements.txt"))
223
+
224
+ @GeneralUtilities.check_arguments
225
+ def __set_dependency_version_in_otherrequirementstxt(self,name:str,new_version:str)->None:
226
+ rfile=os.path.join(self.get_codeunit_folder(),"Other","requirements.txt")
227
+ if os.path.isfile(rfile):
228
+ self.__set_dependency_version_in_requirements(name,new_version,rfile)
229
+
230
+ @GeneralUtilities.check_arguments
231
+ def __set_dependency_version_in_requirements(self,name:str,new_version:str,requirementsfile:str)->None:
232
+ lines=GeneralUtilities.read_lines_from_file(requirementsfile)
233
+ new_lines:list[str]=[]
234
+ for line in lines:
235
+ match = re.match("^("+re.escape(name)+")\\s*([<>=!~]+)?\\s*(.*)?$", line)
236
+ if match:
237
+ dep_name = match.group(1)#pylint:disable=unused-variable
238
+ dep_operator = match.group(2) or None
239
+ dep_version = match.group(3) or None#pylint:disable=unused-variable
240
+ new_line=name
241
+ if dep_operator is None:
242
+ dep_operator=">="
243
+ new_line=new_line+dep_operator+new_version
244
+ new_lines.append(new_line)
245
+ else:
246
+ new_lines.append(line)
247
+ GeneralUtilities.write_lines_to_file(requirementsfile,new_lines)
248
+
249
+ class TFCPS_CodeUnitSpecific_Python_CLI:
250
+
251
+ @staticmethod
252
+ @GeneralUtilities.check_arguments
253
+ def parse(file:str)->TFCPS_CodeUnitSpecific_Python_Functions:
254
+ parser=TFCPS_CodeUnitSpecific_Base_CLI.get_base_parser()
255
+ #add custom parameter if desired
256
+ args=parser.parse_args()
257
+ result:TFCPS_CodeUnitSpecific_Python_Functions=TFCPS_CodeUnitSpecific_Python_Functions(file,LogLevel(int(args.verbosity)),args.targetenvironmenttype,not args.nocache,args.ispremerge)
258
+ return result