ScriptCollection 4.2.130__py3-none-any.whl → 4.2.131__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.
@@ -1,355 +1,355 @@
1
- import argparse
2
- import os
3
- import shutil
4
- from functools import cmp_to_key
5
- from ..GeneralUtilities import GeneralUtilities
6
- from ..ScriptCollectionCore import ScriptCollectionCore
7
- from ..SCLog import LogLevel
8
- from .TFCPS_Tools_General import TFCPS_Tools_General
9
- from .TFCPS_MergeToMain import TFCPS_MergeToMain
10
- from .TFCPS_CodeUnit_BuildCodeUnits import TFCPS_CodeUnit_BuildCodeUnits
11
-
12
-
13
- class MergeToStableConfiguration:
14
- log_level:LogLevel
15
- source_branch:str#main
16
- target_branch:str#stable
17
- repository:str
18
- build_repo:str
19
- common_remote_name:str
20
- build_repo_main_branch_name:str
21
- reference_repo_main_branch_name:str
22
- reference_remote_name:str
23
- build_repo_remote_name:str
24
- artifacts_target_folder:str
25
- common_remote_url:str
26
- additional_arguments_file:str
27
-
28
- def __init__(self,loglevel:LogLevel,source_branch:str,target_branch:str,repository:str,build_repo:str,common_remote_name:str,build_repo_main_branch_name:str,reference_repo_main_branch_name:str,reference_remote_name:str,build_repo_remote_name:str,artifacts_target_folder:str,common_remote_url:str,additional_arguments_file:str):
29
- self.log_level=loglevel
30
- self.source_branch=source_branch
31
- self.target_branch=target_branch
32
- self.repository=repository
33
- self.build_repo=build_repo
34
- self.common_remote_name=common_remote_name
35
- self.build_repo_main_branch_name=build_repo_main_branch_name
36
- self.reference_repo_main_branch_name=reference_repo_main_branch_name
37
- self.reference_remote_name=reference_remote_name
38
- self.build_repo_remote_name=build_repo_remote_name
39
- self.artifacts_target_folder=artifacts_target_folder
40
- self.common_remote_url=common_remote_url
41
- self.additional_arguments_file=additional_arguments_file
42
-
43
- class TFCPS_MergeToStable:
44
-
45
- sc:ScriptCollectionCore
46
- tFCPS_Tools_General:TFCPS_Tools_General
47
- createRelease_configuration: MergeToStableConfiguration
48
-
49
- def __init__(self, createRelease_configuration: MergeToStableConfiguration):
50
- self.sc=ScriptCollectionCore()
51
- self.tFCPS_Tools_General=TFCPS_Tools_General(self.sc)
52
- self.createRelease_configuration=createRelease_configuration
53
-
54
- @GeneralUtilities.check_arguments
55
- def merge_to_stable_branch(self):
56
- self.sc.log.loglevel=self.createRelease_configuration.log_level
57
- self.sc.log.log("Merge to stable-branch...")
58
- product_name:str=self.tFCPS_Tools_General.get_product_name(self.createRelease_configuration.repository)
59
- if self.sc.git_get_commit_id(self.createRelease_configuration.repository,self.createRelease_configuration.source_branch)==self.sc.git_get_commit_id(self.createRelease_configuration.repository,self.createRelease_configuration.target_branch):
60
- self.sc.log.log("Source- and target-branch are on the same commit.")
61
- return
62
-
63
- self.sc.assert_is_git_repository(self.createRelease_configuration.repository)
64
- self.sc.assert_no_uncommitted_changes(self.createRelease_configuration.repository)
65
- self.sc.git_checkout(self.createRelease_configuration.repository, self.createRelease_configuration.source_branch)
66
- self.sc.assert_no_uncommitted_changes(self.createRelease_configuration.repository)
67
-
68
- reference_repo=self.createRelease_configuration.repository+"Reference"
69
- self.sc.assert_is_git_repository(reference_repo)
70
- self.sc.assert_no_uncommitted_changes(reference_repo)
71
-
72
- self.sc.assert_is_git_repository(self.createRelease_configuration.build_repo)
73
- self.sc.assert_no_uncommitted_changes(self.createRelease_configuration.build_repo)
74
-
75
- product_version:str=self.tFCPS_Tools_General.get_version_of_project(self.createRelease_configuration.repository)
76
-
77
- #TODO do premerge-build instead
78
- tfcps_CodeUnit_BuildCodeUnits:TFCPS_CodeUnit_BuildCodeUnits=TFCPS_CodeUnit_BuildCodeUnits(self.createRelease_configuration.repository,self.sc.log.loglevel,"Productive",self.createRelease_configuration.additional_arguments_file,False,False,False)
79
- try:
80
- tfcps_CodeUnit_BuildCodeUnits.build_codeunits()
81
- except Exception:
82
- self.sc.log.log(f"Branch {self.createRelease_configuration.source_branch} is not buildable.",LogLevel.Error)
83
- self.sc.git_undo_all_changes(self.createRelease_configuration.repository)
84
- raise
85
-
86
- self.sc.log.log("Release artifacts...")
87
- repository:str=self.createRelease_configuration.repository
88
- project_version:str=self.tFCPS_Tools_General.get_version_of_project(repository)
89
- for codeunit in self.tFCPS_Tools_General.get_codeunits(self.createRelease_configuration.repository):
90
- self.sc.git_checkout(self.createRelease_configuration.repository, self.createRelease_configuration.source_branch, True,True)
91
- if self.createRelease_configuration.artifacts_target_folder is not None:
92
- #export artifacts to local target folder
93
- self.sc.log.log(f"Export artifacts of codeunit {codeunit} to target-folder...")
94
- source_folder:str=GeneralUtilities.resolve_relative_path(f"./{codeunit}/Other/Artifacts",self.createRelease_configuration.repository)
95
- target_folder:str=GeneralUtilities.resolve_relative_path(f"./{product_name}/{product_version}/{codeunit}",self.createRelease_configuration.artifacts_target_folder)
96
- GeneralUtilities.ensure_directory_exists(target_folder)
97
- codeunit_version:str=self.tFCPS_Tools_General.get_version_of_codeunit(os.path.join(self.createRelease_configuration.repository,codeunit,f"{codeunit}.codeunit.xml"))
98
- target_file:str=os.path.join(target_folder,f"{codeunit}.v{codeunit_version}.Artifacts.zip")
99
- self.sc.create_zip_archive(source_folder,target_file)
100
-
101
- #push artifacts
102
- push_script:str=os.path.join( self.createRelease_configuration.build_repo,"Scripts","CreateRelease",f"PushArtifacts.{codeunit}.py")
103
- if os.path.isfile(push_script):
104
- self.sc.log.log(f"Push artifacts of codeunit {codeunit}...")
105
- self.sc.run_program(GeneralUtilities.get_python_executable(),os.path.basename(push_script),os.path.dirname(push_script))
106
- else:
107
- self.sc.log.log(f"Codeunit {codeunit} does not have artifacts to push. (Scriptfile \"{push_script}\" does not exist.)",LogLevel.Debug)
108
-
109
- # update codeunit-reference
110
- self.sc.log.log(f"Release artifacts of codeunit {codeunit}...")
111
- reference_folder:str=os.path.join(reference_repo,"ReferenceContent")
112
- projectname:str=os.path.basename(repository)
113
- public_repository_url:str=self.createRelease_configuration.common_remote_url
114
- main_branch_name:str=self.createRelease_configuration.source_branch
115
- codeunit_version=self.tFCPS_Tools_General.get_version_of_codeunit(os.path.join(repository,codeunit,f"{codeunit}.codeunit.xml"))
116
- self.__export_codeunit_reference_content_to_reference_repository(f"v{project_version}", False, reference_folder, repository, codeunit, projectname, codeunit_version, public_repository_url, f"v{project_version}")
117
- self.__export_codeunit_reference_content_to_reference_repository("Latest", True, reference_folder, repository, codeunit, projectname, codeunit_version, public_repository_url, main_branch_name)
118
-
119
- #TODO set (update/overwrite) project-specific reference in reference_repo
120
-
121
- #TODO set (update/overwrite) project-issues in reference_repo
122
-
123
- # Generate reference
124
- self.__generate_entire_reference(projectname, project_version, reference_folder,reference_repo)
125
-
126
- self.sc.git_commit(reference_repo,f"Added reference for v{project_version}")
127
-
128
- #TODO do this not as fast-forward-merge anymore, because the changes from the premerge-build should be included
129
- self.sc.git_merge(self.createRelease_configuration.repository, self.createRelease_configuration.source_branch,self.createRelease_configuration.target_branch, True,True,None,True,True)
130
-
131
- self.sc.assert_no_uncommitted_changes(self.createRelease_configuration.repository)
132
- self.sc.assert_no_uncommitted_changes(reference_repo)
133
- self.sc.git_commit(self.createRelease_configuration.build_repo,"Updated submodules")
134
-
135
- self.sc.git_push_with_retry(self.createRelease_configuration.repository,self.createRelease_configuration.common_remote_name,self.createRelease_configuration.source_branch,self.createRelease_configuration.source_branch)
136
- self.sc.git_push_with_retry(self.createRelease_configuration.repository,self.createRelease_configuration.common_remote_name,self.createRelease_configuration.target_branch,self.createRelease_configuration.target_branch)
137
- self.sc.git_push_with_retry(self.createRelease_configuration.build_repo,self.createRelease_configuration.build_repo_remote_name,self.createRelease_configuration.build_repo_main_branch_name,self.createRelease_configuration.build_repo_main_branch_name)
138
- self.sc.git_push_with_retry(reference_repo,self.createRelease_configuration.reference_remote_name,self.createRelease_configuration.reference_repo_main_branch_name,self.createRelease_configuration.reference_repo_main_branch_name)
139
-
140
- self.sc.log.log(f"Finishing merging {projectname} v{project_version} to stable...")
141
-
142
- @GeneralUtilities.check_arguments
143
- def __remove_outdated_version(self,reference_repo:str):
144
- now = GeneralUtilities.get_now()
145
- for unsupported_version in self.tFCPS_Tools_General.get_unsupported_versions(self.createRelease_configuration.repository, now):
146
- unsupported_reference_folder = f"{reference_repo}/ReferenceContent/v{unsupported_version[0]}"
147
- GeneralUtilities.ensure_directory_does_not_exist(unsupported_reference_folder)
148
-
149
-
150
- @GeneralUtilities.check_arguments
151
- def __generate_entire_reference(self, projectname: str, project_version: str, reference_folder: str,reference_repo:str) -> None:
152
- self.sc.log.log("Remove outdated versions...")
153
- self.__remove_outdated_version(reference_repo)
154
- self.sc.log.log("Generate reference...")
155
- all_available_version_identifier_folders_of_reference: list[str] = list(folder for folder in GeneralUtilities.get_direct_folders_of_folder(reference_folder))
156
- all_available_version_identifier_folders_of_reference = sorted(all_available_version_identifier_folders_of_reference, key=cmp_to_key(TFCPS_Tools_General.sort_reference_folder))
157
- reference_versions_html_lines = []
158
- reference_versions_html_lines.append(' <hr/>')
159
- for all_available_version_identifier_folder_of_reference in all_available_version_identifier_folders_of_reference:
160
- version_identifier_of_project = os.path.basename(all_available_version_identifier_folder_of_reference)
161
- if version_identifier_of_project == "Latest":
162
- latest_version_hint = f" (v{project_version})"
163
- else:
164
- latest_version_hint = GeneralUtilities.empty_string
165
- reference_versions_html_lines.append(f' <h2>{version_identifier_of_project}{latest_version_hint}</h2>')
166
- reference_versions_html_lines.append(" Contained codeunits:<br/>")
167
- reference_versions_html_lines.append(" <ul>")
168
- for codeunit_reference_folder in list(folder for folder in GeneralUtilities.get_direct_folders_of_folder(all_available_version_identifier_folder_of_reference)):
169
- reference_versions_html_lines.append(f' <li><a href="./{version_identifier_of_project}/{os.path.basename(codeunit_reference_folder)}/index.html">' +
170
- f'{os.path.basename(codeunit_reference_folder)} {version_identifier_of_project}</a></li>')
171
- reference_versions_html_lines.append(" </ul>")
172
- reference_versions_html_lines.append(' <hr/>')
173
- if version_identifier_of_project == "Latest":
174
- latest_version_hint = " <h2>History</h2>"
175
-
176
- design_file = None
177
- design = "ModestDark"
178
- if design == "ModestDark":
179
- design_file = GeneralUtilities.get_modest_dark_url()
180
- # TODO make designs from customizable sources be available by a customizable name and outsource this to a class-property because this is duplicated code.
181
- if design_file is None:
182
- design_html = GeneralUtilities.empty_string
183
- else:
184
- design_html = f'<link type="text/css" rel="stylesheet" href="{design_file}" />'
185
-
186
- reference_versions_links_file_content = " \n".join(reference_versions_html_lines)
187
- title = f"{projectname}-reference"
188
- reference_index_file = os.path.join(reference_folder, "index.html")
189
- reference_index_file_content = f"""<!DOCTYPE html>
190
- <html lang="en">
191
-
192
- <head>
193
- <meta charset="UTF-8">
194
- <title>{title}</title>
195
- {design_html}
196
- </head>
197
-
198
- <body>
199
- <h1>{title}</h1>
200
- {reference_versions_links_file_content}
201
- </body>
202
-
203
- </html>
204
- """ # see https://getbootstrap.com/docs/5.1/getting-started/introduction/
205
- GeneralUtilities.write_text_to_file(reference_index_file, reference_index_file_content)
206
-
207
- @GeneralUtilities.check_arguments
208
- def __export_codeunit_reference_content_to_reference_repository(self, project_version_identifier: str, replace_existing_content: bool, target_folder_for_reference_repository: str, repository: str, codeunitname: str, projectname: str, codeunit_version: str, public_repository_url: str, branch: str) -> None:
209
- codeunit_folder = os.path.join(repository, codeunitname)
210
- codeunit_file = os.path.join(codeunit_folder, f"{codeunitname}.codeunit.xml")
211
- codeunit_has_testcases = self.tFCPS_Tools_General.codeunit_has_testable_sourcecode(codeunit_file)
212
- target_folder = os.path.join(target_folder_for_reference_repository, project_version_identifier, codeunitname)
213
- if os.path.isdir(target_folder) and not replace_existing_content:
214
- raise ValueError(f"Folder '{target_folder}' already exists.")
215
- GeneralUtilities.ensure_directory_does_not_exist(target_folder)
216
- GeneralUtilities.ensure_directory_exists(target_folder)
217
- codeunit_version_identifier = "Latest" if project_version_identifier == "Latest" else "v"+codeunit_version
218
- page_title = f"{codeunitname} {codeunit_version_identifier} codeunit-reference"
219
- diff_report = f"{repository}/{codeunitname}/Other/Artifacts/DiffReport/DiffReport.html"
220
- diff_target_folder = os.path.join(target_folder, "DiffReport")
221
- GeneralUtilities.ensure_directory_exists(diff_target_folder)
222
- diff_target_file = os.path.join(diff_target_folder, "DiffReport.html")
223
- title = (f'Reference of codeunit {codeunitname} {codeunit_version_identifier} (contained in project <a href="{public_repository_url}">{projectname}</a> {project_version_identifier})')
224
- if public_repository_url is None:
225
- repo_url_html = GeneralUtilities.empty_string
226
- else:
227
- repo_url_html = f'<a href="{public_repository_url}/tree/{branch}/{codeunitname}">Source-code</a>'
228
- if codeunit_has_testcases:
229
- coverage_report_link = '<a href="./TestCoverageReport/index.html">Test-coverage-report</a><br>'
230
- else:
231
- coverage_report_link = GeneralUtilities.empty_string
232
- index_file_for_reference = os.path.join(target_folder, "index.html")
233
-
234
- design_file = None
235
- design = "ModestDark"
236
- if design == "ModestDark":
237
- design_file = GeneralUtilities.get_modest_dark_url()
238
- # TODO make designs from customizable sources be available by a customizable name and outsource this to a class-property because this is duplicated code.
239
- if design_file is None:
240
- design_html = GeneralUtilities.empty_string
241
- else:
242
- design_html = f'<link type="text/css" rel="stylesheet" href="{design_file}" />'
243
-
244
- index_file_content = f"""<!DOCTYPE html>
245
- <html lang="en">
246
-
247
- <head>
248
- <meta charset="UTF-8">
249
- <title>{page_title}</title>
250
- {design_html}
251
- </head>
252
-
253
- <body>
254
- <h1>{title}</h1>
255
- <hr/>
256
- Available reference-content for {codeunitname}:<br>
257
- {repo_url_html}<br>
258
- <!--TODO add artefacts-link: <a href="./x">Artefacts</a><br>-->
259
- <a href="./Reference/index.html">Reference</a><br>
260
- <a href="./DiffReport/DiffReport.html">Diff-report</a><br>
261
- {coverage_report_link}
262
- </body>
263
-
264
- </html>
265
- """
266
-
267
- GeneralUtilities.ensure_file_exists(index_file_for_reference)
268
- GeneralUtilities.write_text_to_file(index_file_for_reference, index_file_content)
269
- other_folder_in_repository = os.path.join(repository, codeunitname, "Other")
270
- source_generatedreference = os.path.join(other_folder_in_repository, "Artifacts", "Reference")
271
- target_generatedreference = os.path.join(target_folder, "Reference")
272
- shutil.copytree(source_generatedreference, target_generatedreference)
273
-
274
- shutil.copyfile(diff_report, diff_target_file)
275
-
276
- if codeunit_has_testcases:
277
- source_testcoveragereport = os.path.join(other_folder_in_repository, "Artifacts", "TestCoverageReport")
278
- if os.path.isdir(source_testcoveragereport): # check, because it is not a mandatory artifact. if the artifact is not available, the user gets already a warning.
279
- target_testcoveragereport = os.path.join(target_folder, "TestCoverageReport")
280
- shutil.copytree(source_testcoveragereport, target_testcoveragereport)
281
-
282
- class TFCPS_MergeToStable_CLI:
283
-
284
- @staticmethod
285
- @GeneralUtilities.check_arguments
286
- def get_with_overwritable_defaults(file:str,default_loglevel:LogLevel=None,default_source_branch:str=None,default_additionalargumentsfile:str=None,default_target_branch:str=None,common_remote_name:str=None,build_repo_main_branch_name:str=None,reference_repo_main_branch_name:str=None,reference_remote_name:str=None,build_repo_remote_name:str=None,artifacts_target_folder:str=None,common_remote_url:str=None)->TFCPS_MergeToMain:
287
- parser = argparse.ArgumentParser()
288
- verbosity_values = ", ".join(f"{lvl.value}={lvl.name}" for lvl in LogLevel)
289
- parser.add_argument('-a', '--additionalargumentsfile', required=False, default=None)
290
- parser.add_argument('-s', '--sourcebranch', required=False)#default="main"
291
- parser.add_argument('-t', '--targetbranch', required=False)#default="stable"
292
- parser.add_argument( '--referencerepo', required=False, default=None)
293
- parser.add_argument( '--commonremotename', required=False, default=None)
294
- parser.add_argument( '--buildrepomainbranchname', required=False)#default="main"
295
- parser.add_argument( '--referencerepomainbranchname', required=False)#default="main"
296
- parser.add_argument( '--referenceremotename', required=False, default=None)
297
- parser.add_argument( '--buildreporemotename', required=False, default=None)
298
- parser.add_argument( '--artifactstargetfolder', required=False, default=None)
299
- parser.add_argument( '--commonremoteurl', required=False, default=None)
300
- parser.add_argument('-v', '--verbosity', required=False, help=f"Sets the loglevel. Possible values: {verbosity_values}")
301
- args=parser.parse_args()
302
-
303
- sc:ScriptCollectionCore=ScriptCollectionCore()
304
-
305
- build_repo=GeneralUtilities.resolve_relative_path("../../..",file)
306
- sc.assert_is_git_repository(build_repo)
307
-
308
- default_product_name=os.path.basename(build_repo)[:-len("Build")]
309
-
310
- if args.verbosity is not None:
311
- default_loglevel=LogLevel(int( args.verbosity))
312
- GeneralUtilities.assert_not_null(default_loglevel,"verbosity is not set")
313
-
314
- if args.additionalargumentsfile is not None:
315
- default_additionalargumentsfile=args.additionalargumentsfile
316
-
317
- if args.sourcebranch is not None:
318
- default_source_branch=args.sourcebranch
319
- GeneralUtilities.assert_not_null(default_source_branch,"sourcebranch is not set")
320
-
321
- if args.targetbranch is not None:
322
- default_target_branch=args.targetbranch
323
- GeneralUtilities.assert_not_null(default_target_branch,"targetbranch is not set")
324
-
325
- if args.commonremotename is not None:
326
- common_remote_name=args.commonremotename
327
- GeneralUtilities.assert_not_null(common_remote_name,"commonremotename is not set")
328
-
329
- if args.buildrepomainbranchname is not None:
330
- build_repo_main_branch_name=args.buildrepomainbranchname
331
- GeneralUtilities.assert_not_null(build_repo_main_branch_name,"buildrepomainbranchname is not set")
332
-
333
- if args.referencerepomainbranchname is not None:
334
- reference_repo_main_branch_name=args.referencerepomainbranchname
335
- GeneralUtilities.assert_not_null(reference_repo_main_branch_name,"referencerepomainbranchname is not set")
336
-
337
- if args.referenceremotename is not None:
338
- reference_remote_name=args.referenceremotename
339
- GeneralUtilities.assert_not_null(reference_remote_name,"referenceremotename is not set")
340
-
341
- if args.buildreporemotename is not None:
342
- build_repo_remote_name=args.buildreporemotename
343
- GeneralUtilities.assert_not_null(build_repo_remote_name,"buildreporemotename is not set")
344
-
345
- if args.artifactstargetfolder is not None:
346
- artifacts_target_folder=args.artifactstargetfolder
347
-
348
- if args.commonremoteurl is not None:
349
- common_remote_url=args.commonremoteurl
350
- GeneralUtilities.assert_not_null(common_remote_url,"commonremoteurl is not set")
351
-
352
- repository=os.path.join(build_repo,"Submodules",default_product_name)
353
- config:MergeToStableConfiguration=MergeToStableConfiguration(default_loglevel,default_source_branch,default_target_branch,repository,build_repo,common_remote_name,build_repo_main_branch_name,reference_repo_main_branch_name,reference_remote_name,build_repo_remote_name,artifacts_target_folder,common_remote_url,default_additionalargumentsfile)
354
- tFCPS_MergeToMain:TFCPS_MergeToStable=TFCPS_MergeToStable(config)
355
- return tFCPS_MergeToMain
1
+ import argparse
2
+ import os
3
+ import shutil
4
+ from functools import cmp_to_key
5
+ from ..GeneralUtilities import GeneralUtilities
6
+ from ..ScriptCollectionCore import ScriptCollectionCore
7
+ from ..SCLog import LogLevel
8
+ from .TFCPS_Tools_General import TFCPS_Tools_General
9
+ from .TFCPS_MergeToMain import TFCPS_MergeToMain
10
+ from .TFCPS_CodeUnit_BuildCodeUnits import TFCPS_CodeUnit_BuildCodeUnits
11
+
12
+
13
+ class MergeToStableConfiguration:
14
+ log_level:LogLevel = None
15
+ source_branch:str = None #main
16
+ target_branch:str = None #stable
17
+ repository:str = None
18
+ build_repo:str = None
19
+ common_remote_name:str = None
20
+ build_repo_main_branch_name:str = None
21
+ reference_repo_main_branch_name:str = None
22
+ reference_remote_name:str = None
23
+ build_repo_remote_name:str = None
24
+ artifacts_target_folder:str = None
25
+ common_remote_url:str = None
26
+ additional_arguments_file:str = None
27
+
28
+ def __init__(self,loglevel:LogLevel,source_branch:str,target_branch:str,repository:str,build_repo:str,common_remote_name:str,build_repo_main_branch_name:str,reference_repo_main_branch_name:str,reference_remote_name:str,build_repo_remote_name:str,artifacts_target_folder:str,common_remote_url:str,additional_arguments_file:str):
29
+ self.log_level=loglevel
30
+ self.source_branch=source_branch
31
+ self.target_branch=target_branch
32
+ self.repository=repository
33
+ self.build_repo=build_repo
34
+ self.common_remote_name=common_remote_name
35
+ self.build_repo_main_branch_name=build_repo_main_branch_name
36
+ self.reference_repo_main_branch_name=reference_repo_main_branch_name
37
+ self.reference_remote_name=reference_remote_name
38
+ self.build_repo_remote_name=build_repo_remote_name
39
+ self.artifacts_target_folder=artifacts_target_folder
40
+ self.common_remote_url=common_remote_url
41
+ self.additional_arguments_file=additional_arguments_file
42
+
43
+ class TFCPS_MergeToStable:
44
+
45
+ sc:ScriptCollectionCore = None
46
+ tFCPS_Tools_General:TFCPS_Tools_General = None
47
+ createRelease_configuration: MergeToStableConfiguration = None
48
+
49
+ def __init__(self, createRelease_configuration: MergeToStableConfiguration):
50
+ self.sc=ScriptCollectionCore()
51
+ self.tFCPS_Tools_General=TFCPS_Tools_General(self.sc)
52
+ self.createRelease_configuration=createRelease_configuration
53
+
54
+ @GeneralUtilities.check_arguments
55
+ def merge_to_stable_branch(self):
56
+ self.sc.log.loglevel=self.createRelease_configuration.log_level
57
+ self.sc.log.log("Merge to stable-branch...")
58
+ product_name:str=self.tFCPS_Tools_General.get_product_name(self.createRelease_configuration.repository)
59
+ if self.sc.git_get_commit_id(self.createRelease_configuration.repository,self.createRelease_configuration.source_branch)==self.sc.git_get_commit_id(self.createRelease_configuration.repository,self.createRelease_configuration.target_branch):
60
+ self.sc.log.log("Source- and target-branch are on the same commit.")
61
+ return
62
+
63
+ self.sc.assert_is_git_repository(self.createRelease_configuration.repository)
64
+ self.sc.assert_no_uncommitted_changes(self.createRelease_configuration.repository)
65
+ self.sc.git_checkout(self.createRelease_configuration.repository, self.createRelease_configuration.source_branch)
66
+ self.sc.assert_no_uncommitted_changes(self.createRelease_configuration.repository)
67
+
68
+ reference_repo=self.createRelease_configuration.repository+"Reference"
69
+ self.sc.assert_is_git_repository(reference_repo)
70
+ self.sc.assert_no_uncommitted_changes(reference_repo)
71
+
72
+ self.sc.assert_is_git_repository(self.createRelease_configuration.build_repo)
73
+ self.sc.assert_no_uncommitted_changes(self.createRelease_configuration.build_repo)
74
+
75
+ product_version:str=self.tFCPS_Tools_General.get_version_of_project(self.createRelease_configuration.repository)
76
+
77
+ #TODO do premerge-build instead
78
+ tfcps_CodeUnit_BuildCodeUnits:TFCPS_CodeUnit_BuildCodeUnits=TFCPS_CodeUnit_BuildCodeUnits(self.createRelease_configuration.repository,self.sc.log.loglevel,"Productive",self.createRelease_configuration.additional_arguments_file,False,False,False)
79
+ try:
80
+ tfcps_CodeUnit_BuildCodeUnits.build_codeunits()
81
+ except Exception:
82
+ self.sc.log.log(f"Branch {self.createRelease_configuration.source_branch} is not buildable.",LogLevel.Error)
83
+ self.sc.git_undo_all_changes(self.createRelease_configuration.repository)
84
+ raise
85
+
86
+ self.sc.log.log("Release artifacts...")
87
+ repository:str=self.createRelease_configuration.repository
88
+ project_version:str=self.tFCPS_Tools_General.get_version_of_project(repository)
89
+ for codeunit in self.tFCPS_Tools_General.get_codeunits(self.createRelease_configuration.repository):
90
+ self.sc.git_checkout(self.createRelease_configuration.repository, self.createRelease_configuration.source_branch, True,True)
91
+ if self.createRelease_configuration.artifacts_target_folder is not None:
92
+ #export artifacts to local target folder
93
+ self.sc.log.log(f"Export artifacts of codeunit {codeunit} to target-folder...")
94
+ source_folder:str=GeneralUtilities.resolve_relative_path(f"./{codeunit}/Other/Artifacts",self.createRelease_configuration.repository)
95
+ target_folder:str=GeneralUtilities.resolve_relative_path(f"./{product_name}/{product_version}/{codeunit}",self.createRelease_configuration.artifacts_target_folder)
96
+ GeneralUtilities.ensure_directory_exists(target_folder)
97
+ codeunit_version:str=self.tFCPS_Tools_General.get_version_of_codeunit(os.path.join(self.createRelease_configuration.repository,codeunit,f"{codeunit}.codeunit.xml"))
98
+ target_file:str=os.path.join(target_folder,f"{codeunit}.v{codeunit_version}.Artifacts.zip")
99
+ self.sc.create_zip_archive(source_folder,target_file)
100
+
101
+ #push artifacts
102
+ push_script:str=os.path.join( self.createRelease_configuration.build_repo,"Scripts","CreateRelease",f"PushArtifacts.{codeunit}.py")
103
+ if os.path.isfile(push_script):
104
+ self.sc.log.log(f"Push artifacts of codeunit {codeunit}...")
105
+ self.sc.run_program(GeneralUtilities.get_python_executable(),os.path.basename(push_script),os.path.dirname(push_script))
106
+ else:
107
+ self.sc.log.log(f"Codeunit {codeunit} does not have artifacts to push. (Scriptfile \"{push_script}\" does not exist.)",LogLevel.Debug)
108
+
109
+ # update codeunit-reference
110
+ self.sc.log.log(f"Release artifacts of codeunit {codeunit}...")
111
+ reference_folder:str=os.path.join(reference_repo,"ReferenceContent")
112
+ projectname:str=os.path.basename(repository)
113
+ public_repository_url:str=self.createRelease_configuration.common_remote_url
114
+ main_branch_name:str=self.createRelease_configuration.source_branch
115
+ codeunit_version=self.tFCPS_Tools_General.get_version_of_codeunit(os.path.join(repository,codeunit,f"{codeunit}.codeunit.xml"))
116
+ self.__export_codeunit_reference_content_to_reference_repository(f"v{project_version}", False, reference_folder, repository, codeunit, projectname, codeunit_version, public_repository_url, f"v{project_version}")
117
+ self.__export_codeunit_reference_content_to_reference_repository("Latest", True, reference_folder, repository, codeunit, projectname, codeunit_version, public_repository_url, main_branch_name)
118
+
119
+ #TODO set (update/overwrite) project-specific reference in reference_repo
120
+
121
+ #TODO set (update/overwrite) project-issues in reference_repo
122
+
123
+ # Generate reference
124
+ self.__generate_entire_reference(projectname, project_version, reference_folder,reference_repo)
125
+
126
+ self.sc.git_commit(reference_repo,f"Added reference for v{project_version}")
127
+
128
+ #TODO do this not as fast-forward-merge anymore, because the changes from the premerge-build should be included
129
+ self.sc.git_merge(self.createRelease_configuration.repository, self.createRelease_configuration.source_branch,self.createRelease_configuration.target_branch, True,True,None,True,True)
130
+
131
+ self.sc.assert_no_uncommitted_changes(self.createRelease_configuration.repository)
132
+ self.sc.assert_no_uncommitted_changes(reference_repo)
133
+ self.sc.git_commit(self.createRelease_configuration.build_repo,"Updated submodules")
134
+
135
+ self.sc.git_push_with_retry(self.createRelease_configuration.repository,self.createRelease_configuration.common_remote_name,self.createRelease_configuration.source_branch,self.createRelease_configuration.source_branch)
136
+ self.sc.git_push_with_retry(self.createRelease_configuration.repository,self.createRelease_configuration.common_remote_name,self.createRelease_configuration.target_branch,self.createRelease_configuration.target_branch)
137
+ self.sc.git_push_with_retry(self.createRelease_configuration.build_repo,self.createRelease_configuration.build_repo_remote_name,self.createRelease_configuration.build_repo_main_branch_name,self.createRelease_configuration.build_repo_main_branch_name)
138
+ self.sc.git_push_with_retry(reference_repo,self.createRelease_configuration.reference_remote_name,self.createRelease_configuration.reference_repo_main_branch_name,self.createRelease_configuration.reference_repo_main_branch_name)
139
+
140
+ self.sc.log.log(f"Finishing merging {projectname} v{project_version} to stable...")
141
+
142
+ @GeneralUtilities.check_arguments
143
+ def __remove_outdated_version(self,reference_repo:str):
144
+ now = GeneralUtilities.get_now()
145
+ for unsupported_version in self.tFCPS_Tools_General.get_unsupported_versions(self.createRelease_configuration.repository, now):
146
+ unsupported_reference_folder = f"{reference_repo}/ReferenceContent/v{unsupported_version[0]}"
147
+ GeneralUtilities.ensure_directory_does_not_exist(unsupported_reference_folder)
148
+
149
+
150
+ @GeneralUtilities.check_arguments
151
+ def __generate_entire_reference(self, projectname: str, project_version: str, reference_folder: str,reference_repo:str) -> None:
152
+ self.sc.log.log("Remove outdated versions...")
153
+ self.__remove_outdated_version(reference_repo)
154
+ self.sc.log.log("Generate reference...")
155
+ all_available_version_identifier_folders_of_reference: list[str] = list(folder for folder in GeneralUtilities.get_direct_folders_of_folder(reference_folder))
156
+ all_available_version_identifier_folders_of_reference = sorted(all_available_version_identifier_folders_of_reference, key=cmp_to_key(TFCPS_Tools_General.sort_reference_folder))
157
+ reference_versions_html_lines = []
158
+ reference_versions_html_lines.append(' <hr/>')
159
+ for all_available_version_identifier_folder_of_reference in all_available_version_identifier_folders_of_reference:
160
+ version_identifier_of_project = os.path.basename(all_available_version_identifier_folder_of_reference)
161
+ if version_identifier_of_project == "Latest":
162
+ latest_version_hint = f" (v{project_version})"
163
+ else:
164
+ latest_version_hint = GeneralUtilities.empty_string
165
+ reference_versions_html_lines.append(f' <h2>{version_identifier_of_project}{latest_version_hint}</h2>')
166
+ reference_versions_html_lines.append(" Contained codeunits:<br/>")
167
+ reference_versions_html_lines.append(" <ul>")
168
+ for codeunit_reference_folder in list(folder for folder in GeneralUtilities.get_direct_folders_of_folder(all_available_version_identifier_folder_of_reference)):
169
+ reference_versions_html_lines.append(f' <li><a href="./{version_identifier_of_project}/{os.path.basename(codeunit_reference_folder)}/index.html">' +
170
+ f'{os.path.basename(codeunit_reference_folder)} {version_identifier_of_project}</a></li>')
171
+ reference_versions_html_lines.append(" </ul>")
172
+ reference_versions_html_lines.append(' <hr/>')
173
+ if version_identifier_of_project == "Latest":
174
+ latest_version_hint = " <h2>History</h2>"
175
+
176
+ design_file = None
177
+ design = "ModestDark"
178
+ if design == "ModestDark":
179
+ design_file = GeneralUtilities.get_modest_dark_url()
180
+ # TODO make designs from customizable sources be available by a customizable name and outsource this to a class-property because this is duplicated code.
181
+ if design_file is None:
182
+ design_html = GeneralUtilities.empty_string
183
+ else:
184
+ design_html = f'<link type="text/css" rel="stylesheet" href="{design_file}" />'
185
+
186
+ reference_versions_links_file_content = " \n".join(reference_versions_html_lines)
187
+ title = f"{projectname}-reference"
188
+ reference_index_file = os.path.join(reference_folder, "index.html")
189
+ reference_index_file_content = f"""<!DOCTYPE html>
190
+ <html lang="en">
191
+
192
+ <head>
193
+ <meta charset="UTF-8">
194
+ <title>{title}</title>
195
+ {design_html}
196
+ </head>
197
+
198
+ <body>
199
+ <h1>{title}</h1>
200
+ {reference_versions_links_file_content}
201
+ </body>
202
+
203
+ </html>
204
+ """ # see https://getbootstrap.com/docs/5.1/getting-started/introduction/
205
+ GeneralUtilities.write_text_to_file(reference_index_file, reference_index_file_content)
206
+
207
+ @GeneralUtilities.check_arguments
208
+ def __export_codeunit_reference_content_to_reference_repository(self, project_version_identifier: str, replace_existing_content: bool, target_folder_for_reference_repository: str, repository: str, codeunitname: str, projectname: str, codeunit_version: str, public_repository_url: str, branch: str) -> None:
209
+ codeunit_folder = os.path.join(repository, codeunitname)
210
+ codeunit_file = os.path.join(codeunit_folder, f"{codeunitname}.codeunit.xml")
211
+ codeunit_has_testcases = self.tFCPS_Tools_General.codeunit_has_testable_sourcecode(codeunit_file)
212
+ target_folder = os.path.join(target_folder_for_reference_repository, project_version_identifier, codeunitname)
213
+ if os.path.isdir(target_folder) and not replace_existing_content:
214
+ raise ValueError(f"Folder '{target_folder}' already exists.")
215
+ GeneralUtilities.ensure_directory_does_not_exist(target_folder)
216
+ GeneralUtilities.ensure_directory_exists(target_folder)
217
+ codeunit_version_identifier = "Latest" if project_version_identifier == "Latest" else "v"+codeunit_version
218
+ page_title = f"{codeunitname} {codeunit_version_identifier} codeunit-reference"
219
+ diff_report = f"{repository}/{codeunitname}/Other/Artifacts/DiffReport/DiffReport.html"
220
+ diff_target_folder = os.path.join(target_folder, "DiffReport")
221
+ GeneralUtilities.ensure_directory_exists(diff_target_folder)
222
+ diff_target_file = os.path.join(diff_target_folder, "DiffReport.html")
223
+ title = (f'Reference of codeunit {codeunitname} {codeunit_version_identifier} (contained in project <a href="{public_repository_url}">{projectname}</a> {project_version_identifier})')
224
+ if public_repository_url is None:
225
+ repo_url_html = GeneralUtilities.empty_string
226
+ else:
227
+ repo_url_html = f'<a href="{public_repository_url}/tree/{branch}/{codeunitname}">Source-code</a>'
228
+ if codeunit_has_testcases:
229
+ coverage_report_link = '<a href="./TestCoverageReport/index.html">Test-coverage-report</a><br>'
230
+ else:
231
+ coverage_report_link = GeneralUtilities.empty_string
232
+ index_file_for_reference = os.path.join(target_folder, "index.html")
233
+
234
+ design_file = None
235
+ design = "ModestDark"
236
+ if design == "ModestDark":
237
+ design_file = GeneralUtilities.get_modest_dark_url()
238
+ # TODO make designs from customizable sources be available by a customizable name and outsource this to a class-property because this is duplicated code.
239
+ if design_file is None:
240
+ design_html = GeneralUtilities.empty_string
241
+ else:
242
+ design_html = f'<link type="text/css" rel="stylesheet" href="{design_file}" />'
243
+
244
+ index_file_content = f"""<!DOCTYPE html>
245
+ <html lang="en">
246
+
247
+ <head>
248
+ <meta charset="UTF-8">
249
+ <title>{page_title}</title>
250
+ {design_html}
251
+ </head>
252
+
253
+ <body>
254
+ <h1>{title}</h1>
255
+ <hr/>
256
+ Available reference-content for {codeunitname}:<br>
257
+ {repo_url_html}<br>
258
+ <!--TODO add artefacts-link: <a href="./x">Artefacts</a><br>-->
259
+ <a href="./Reference/index.html">Reference</a><br>
260
+ <a href="./DiffReport/DiffReport.html">Diff-report</a><br>
261
+ {coverage_report_link}
262
+ </body>
263
+
264
+ </html>
265
+ """
266
+
267
+ GeneralUtilities.ensure_file_exists(index_file_for_reference)
268
+ GeneralUtilities.write_text_to_file(index_file_for_reference, index_file_content)
269
+ other_folder_in_repository = os.path.join(repository, codeunitname, "Other")
270
+ source_generatedreference = os.path.join(other_folder_in_repository, "Artifacts", "Reference")
271
+ target_generatedreference = os.path.join(target_folder, "Reference")
272
+ shutil.copytree(source_generatedreference, target_generatedreference)
273
+
274
+ shutil.copyfile(diff_report, diff_target_file)
275
+
276
+ if codeunit_has_testcases:
277
+ source_testcoveragereport = os.path.join(other_folder_in_repository, "Artifacts", "TestCoverageReport")
278
+ if os.path.isdir(source_testcoveragereport): # check, because it is not a mandatory artifact. if the artifact is not available, the user gets already a warning.
279
+ target_testcoveragereport = os.path.join(target_folder, "TestCoverageReport")
280
+ shutil.copytree(source_testcoveragereport, target_testcoveragereport)
281
+
282
+ class TFCPS_MergeToStable_CLI:
283
+
284
+ @staticmethod
285
+ @GeneralUtilities.check_arguments
286
+ def get_with_overwritable_defaults(file:str,default_loglevel:LogLevel=None,default_source_branch:str=None,default_additionalargumentsfile:str=None,default_target_branch:str=None,common_remote_name:str=None,build_repo_main_branch_name:str=None,reference_repo_main_branch_name:str=None,reference_remote_name:str=None,build_repo_remote_name:str=None,artifacts_target_folder:str=None,common_remote_url:str=None)->TFCPS_MergeToMain:
287
+ parser = argparse.ArgumentParser()
288
+ verbosity_values = ", ".join(f"{lvl.value}={lvl.name}" for lvl in LogLevel)
289
+ parser.add_argument('-a', '--additionalargumentsfile', required=False, default=None)
290
+ parser.add_argument('-s', '--sourcebranch', required=False)#default="main"
291
+ parser.add_argument('-t', '--targetbranch', required=False)#default="stable"
292
+ parser.add_argument( '--referencerepo', required=False, default=None)
293
+ parser.add_argument( '--commonremotename', required=False, default=None)
294
+ parser.add_argument( '--buildrepomainbranchname', required=False)#default="main"
295
+ parser.add_argument( '--referencerepomainbranchname', required=False)#default="main"
296
+ parser.add_argument( '--referenceremotename', required=False, default=None)
297
+ parser.add_argument( '--buildreporemotename', required=False, default=None)
298
+ parser.add_argument( '--artifactstargetfolder', required=False, default=None)
299
+ parser.add_argument( '--commonremoteurl', required=False, default=None)
300
+ parser.add_argument('-v', '--verbosity', required=False, help=f"Sets the loglevel. Possible values: {verbosity_values}")
301
+ args=parser.parse_args()
302
+
303
+ sc:ScriptCollectionCore=ScriptCollectionCore()
304
+
305
+ build_repo=GeneralUtilities.resolve_relative_path("../../..",file)
306
+ sc.assert_is_git_repository(build_repo)
307
+
308
+ default_product_name=os.path.basename(build_repo)[:-len("Build")]
309
+
310
+ if args.verbosity is not None:
311
+ default_loglevel=LogLevel(int( args.verbosity))
312
+ GeneralUtilities.assert_not_null(default_loglevel,"verbosity is not set")
313
+
314
+ if args.additionalargumentsfile is not None:
315
+ default_additionalargumentsfile=args.additionalargumentsfile
316
+
317
+ if args.sourcebranch is not None:
318
+ default_source_branch=args.sourcebranch
319
+ GeneralUtilities.assert_not_null(default_source_branch,"sourcebranch is not set")
320
+
321
+ if args.targetbranch is not None:
322
+ default_target_branch=args.targetbranch
323
+ GeneralUtilities.assert_not_null(default_target_branch,"targetbranch is not set")
324
+
325
+ if args.commonremotename is not None:
326
+ common_remote_name=args.commonremotename
327
+ GeneralUtilities.assert_not_null(common_remote_name,"commonremotename is not set")
328
+
329
+ if args.buildrepomainbranchname is not None:
330
+ build_repo_main_branch_name=args.buildrepomainbranchname
331
+ GeneralUtilities.assert_not_null(build_repo_main_branch_name,"buildrepomainbranchname is not set")
332
+
333
+ if args.referencerepomainbranchname is not None:
334
+ reference_repo_main_branch_name=args.referencerepomainbranchname
335
+ GeneralUtilities.assert_not_null(reference_repo_main_branch_name,"referencerepomainbranchname is not set")
336
+
337
+ if args.referenceremotename is not None:
338
+ reference_remote_name=args.referenceremotename
339
+ GeneralUtilities.assert_not_null(reference_remote_name,"referenceremotename is not set")
340
+
341
+ if args.buildreporemotename is not None:
342
+ build_repo_remote_name=args.buildreporemotename
343
+ GeneralUtilities.assert_not_null(build_repo_remote_name,"buildreporemotename is not set")
344
+
345
+ if args.artifactstargetfolder is not None:
346
+ artifacts_target_folder=args.artifactstargetfolder
347
+
348
+ if args.commonremoteurl is not None:
349
+ common_remote_url=args.commonremoteurl
350
+ GeneralUtilities.assert_not_null(common_remote_url,"commonremoteurl is not set")
351
+
352
+ repository=os.path.join(build_repo,"Submodules",default_product_name)
353
+ config:MergeToStableConfiguration=MergeToStableConfiguration(default_loglevel,default_source_branch,default_target_branch,repository,build_repo,common_remote_name,build_repo_main_branch_name,reference_repo_main_branch_name,reference_remote_name,build_repo_remote_name,artifacts_target_folder,common_remote_url,default_additionalargumentsfile)
354
+ tFCPS_MergeToMain:TFCPS_MergeToStable=TFCPS_MergeToStable(config)
355
+ return tFCPS_MergeToMain