ScriptCollection 4.3.64__py3-none-any.whl → 4.4.1__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.
- ScriptCollection/AnionBuildPlatform.py +205 -205
- ScriptCollection/CertificateUpdater.py +157 -157
- ScriptCollection/Executables.py +4 -2
- ScriptCollection/GeneralUtilities.py +1696 -1696
- ScriptCollection/OCIImages/OCIImageManager.py +278 -278
- ScriptCollection/ProcessesRunner.py +43 -43
- ScriptCollection/ProgramRunnerSudo.py +110 -110
- ScriptCollection/SCLog.py +115 -115
- ScriptCollection/ScriptCollectionCore.py +4372 -4351
- ScriptCollection/TFCPS/DotNet/TFCPS_CodeUnitSpecific_DotNet.py +716 -709
- ScriptCollection/TFCPS/NodeJS/TFCPS_CodeUnitSpecific_NodeJS.py +235 -235
- ScriptCollection/TFCPS/Python/TFCPS_CodeUnitSpecific_Python.py +258 -258
- ScriptCollection/TFCPS/TFCPS_CodeUnitSpecific_Base.py +537 -524
- ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnit.py +157 -155
- ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnits.py +691 -681
- ScriptCollection/TFCPS/TFCPS_CreateRelease.py +98 -98
- ScriptCollection/TFCPS/TFCPS_Generic.py +44 -44
- ScriptCollection/TFCPS/TFCPS_MergeToMain.py +132 -132
- ScriptCollection/TFCPS/TFCPS_MergeToStable.py +358 -358
- ScriptCollection/TFCPS/TFCPS_PreBuildCodeunitsScript.py +48 -48
- ScriptCollection/TFCPS/TFCPS_Tools_General.py +30 -4
- {scriptcollection-4.3.64.dist-info → scriptcollection-4.4.1.dist-info}/METADATA +168 -168
- {scriptcollection-4.3.64.dist-info → scriptcollection-4.4.1.dist-info}/RECORD +26 -26
- {scriptcollection-4.3.64.dist-info → scriptcollection-4.4.1.dist-info}/WHEEL +1 -1
- {scriptcollection-4.3.64.dist-info → scriptcollection-4.4.1.dist-info}/entry_points.txt +0 -0
- {scriptcollection-4.3.64.dist-info → scriptcollection-4.4.1.dist-info}/top_level.txt +0 -0
|
@@ -1,235 +1,235 @@
|
|
|
1
|
-
import os
|
|
2
|
-
import re
|
|
3
|
-
import json
|
|
4
|
-
from pathlib import Path
|
|
5
|
-
import xml.etree.ElementTree as ET
|
|
6
|
-
from lxml import etree
|
|
7
|
-
from ...GeneralUtilities import GeneralUtilities
|
|
8
|
-
from ...SCLog import LogLevel
|
|
9
|
-
from ..TFCPS_CodeUnitSpecific_Base import TFCPS_CodeUnitSpecific_Base,TFCPS_CodeUnitSpecific_Base_CLI
|
|
10
|
-
from ...HTTPMaintenanceOverheadHelper import HTTPMaintenanceOverheadHelper
|
|
11
|
-
|
|
12
|
-
class TFCPS_CodeUnitSpecific_NodeJS_Functions(TFCPS_CodeUnitSpecific_Base):
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
def __init__(self,current_file:str,verbosity:LogLevel,targetenvironmenttype:str,use_cache:bool,is_pre_merge:bool):
|
|
16
|
-
super().__init__(current_file, verbosity,targetenvironmenttype,use_cache,is_pre_merge)
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
@GeneralUtilities.check_arguments
|
|
20
|
-
def build(self) -> None:
|
|
21
|
-
self._protected_sc.run_with_epew("npm", "run build", self.get_codeunit_folder(),print_live_output=self.get_verbosity()==LogLevel.Debug,encode_argument_in_base64=True)
|
|
22
|
-
self.standardized_tasks_build_bom_for_node_project()
|
|
23
|
-
self.copy_source_files_to_output_directory()
|
|
24
|
-
|
|
25
|
-
@GeneralUtilities.check_arguments
|
|
26
|
-
def linting(self) -> None:
|
|
27
|
-
codeunit_folder = self.get_codeunit_folder()
|
|
28
|
-
self._protected_sc.normalize_line_endings_of_files_in_folder(codeunit_folder, ["ts", "js", "css", "scss", "sass"])
|
|
29
|
-
# The OpenAPI-generator writes its '.openapi-generator/FILES' metadata-file with the host's native
|
|
30
|
-
# line-endings (CRLF on Windows, LF on Linux). Normalize it to LF like the other generated text-files
|
|
31
|
-
# so the committed file does not drift between build-hosts.
|
|
32
|
-
for openapi_generator_files_file in self._protected_sc.get_not_git_ignored_files_of_folder(codeunit_folder):
|
|
33
|
-
if os.path.basename(openapi_generator_files_file) == "FILES" and os.path.basename(os.path.dirname(openapi_generator_files_file)) == ".openapi-generator":
|
|
34
|
-
self._protected_sc.normalize_line_endings(openapi_generator_files_file)
|
|
35
|
-
for html_file in self._protected_sc.get_not_git_ignored_files_of_folder(codeunit_folder, ".html"):
|
|
36
|
-
self._protected_sc.format_html_file(html_file, os.path.basename(html_file) == "index.html")
|
|
37
|
-
self._protected_sc.run_with_epew("npm", "run lint", codeunit_folder,print_live_output=self.get_verbosity()==LogLevel.Debug,encode_argument_in_base64=True)
|
|
38
|
-
|
|
39
|
-
@GeneralUtilities.check_arguments
|
|
40
|
-
def do_common_tasks(self,current_codeunit_version:str)-> None:
|
|
41
|
-
codeunit_version = current_codeunit_version
|
|
42
|
-
codeunit_folder = self.get_codeunit_folder()
|
|
43
|
-
self.do_common_tasks_base(current_codeunit_version)
|
|
44
|
-
self.tfcps_Tools_General.replace_version_in_packagejson_file(GeneralUtilities.resolve_relative_path("./package.json", codeunit_folder), codeunit_version)
|
|
45
|
-
self.tfcps_Tools_General.do_npm_install(codeunit_folder, True,self.use_cache())
|
|
46
|
-
|
|
47
|
-
@GeneralUtilities.check_arguments
|
|
48
|
-
def generate_reference(self) -> None:
|
|
49
|
-
self.generate_reference_using_docfx()
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
@GeneralUtilities.check_arguments
|
|
53
|
-
def run_testcases(self) -> None:
|
|
54
|
-
# prepare
|
|
55
|
-
codeunit_name: str =self.get_codeunit_name()
|
|
56
|
-
|
|
57
|
-
codeunit_folder =self.get_codeunit_folder()
|
|
58
|
-
repository_folder = os.path.dirname(codeunit_folder)
|
|
59
|
-
|
|
60
|
-
# run testcases
|
|
61
|
-
self._protected_sc.run_with_epew("npm", f"run test-{self.get_target_environment_type()}", self.get_codeunit_folder(),print_live_output=self.get_verbosity()==LogLevel.Debug,encode_argument_in_base64=True)
|
|
62
|
-
|
|
63
|
-
# rename file
|
|
64
|
-
coverage_folder = os.path.join(codeunit_folder, "Other", "Artifacts", "TestCoverage")
|
|
65
|
-
target_file = os.path.join(coverage_folder, "TestCoverage.xml")
|
|
66
|
-
GeneralUtilities.ensure_file_does_not_exist(target_file)
|
|
67
|
-
os.rename(os.path.join(coverage_folder, "cobertura-coverage.xml"), target_file)
|
|
68
|
-
self.__rename_packagename_in_coverage_file(target_file, codeunit_name)
|
|
69
|
-
|
|
70
|
-
# adapt backslashs to slashs
|
|
71
|
-
content = GeneralUtilities.read_text_from_file(target_file)
|
|
72
|
-
content = re.sub('\\\\', '/', content)
|
|
73
|
-
GeneralUtilities.write_text_to_file(target_file, content)
|
|
74
|
-
|
|
75
|
-
# aggregate packages in testcoverage-file
|
|
76
|
-
roottree: etree._ElementTree = etree.parse(target_file)
|
|
77
|
-
existing_classes = list(roottree.xpath('//coverage/packages/package/classes/class'))
|
|
78
|
-
|
|
79
|
-
old_packages_list = roottree.xpath('//coverage/packages/package')
|
|
80
|
-
for package in old_packages_list:
|
|
81
|
-
package.getparent().remove(package)
|
|
82
|
-
|
|
83
|
-
root = roottree.getroot()
|
|
84
|
-
packages_element = root.find("packages")
|
|
85
|
-
package_element = etree.SubElement(packages_element, "package")
|
|
86
|
-
package_element.attrib['name'] = codeunit_name
|
|
87
|
-
package_element.attrib['lines-valid'] = root.attrib["lines-valid"]
|
|
88
|
-
package_element.attrib['lines-covered'] = root.attrib["lines-covered"]
|
|
89
|
-
package_element.attrib['line-rate'] = root.attrib["line-rate"]
|
|
90
|
-
package_element.attrib['branches-valid'] = root.attrib["branches-valid"]
|
|
91
|
-
package_element.attrib['branches-covered'] = root.attrib["branches-covered"]
|
|
92
|
-
package_element.attrib['branch-rate'] = root.attrib["branch-rate"]
|
|
93
|
-
package_element.attrib['timestamp'] = root.attrib["timestamp"]
|
|
94
|
-
package_element.attrib['complexity'] = root.attrib["complexity"]
|
|
95
|
-
|
|
96
|
-
classes_element = etree.SubElement(package_element, "classes")
|
|
97
|
-
|
|
98
|
-
for existing_class in existing_classes:
|
|
99
|
-
classes_element.append(existing_class)
|
|
100
|
-
|
|
101
|
-
result = etree.tostring(roottree, pretty_print=True).decode("utf-8")
|
|
102
|
-
GeneralUtilities.write_text_to_file(target_file, result)
|
|
103
|
-
|
|
104
|
-
# post tasks
|
|
105
|
-
self.run_testcases_common_post_task(repository_folder, codeunit_name, True, self.get_target_environment_type())
|
|
106
|
-
|
|
107
|
-
@GeneralUtilities.check_arguments
|
|
108
|
-
def __rename_packagename_in_coverage_file(self, file: str, codeunit_name: str) -> None:
|
|
109
|
-
root: etree._ElementTree = etree.parse(file)
|
|
110
|
-
packages = root.xpath('//coverage/packages/package')
|
|
111
|
-
for package in packages:
|
|
112
|
-
package.attrib['name'] = codeunit_name
|
|
113
|
-
result = etree.tostring(root).decode("utf-8")
|
|
114
|
-
GeneralUtilities.write_text_to_file(file, result)
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
@GeneralUtilities.check_arguments
|
|
118
|
-
def standardized_tasks_build_bom_for_node_project(self) -> None:
|
|
119
|
-
relative_path_to_bom_file = f"Other/Artifacts/BOM/{os.path.basename(self.get_codeunit_folder())}.{self.tfcps_Tools_General.get_version_of_codeunit(self.get_codeunit_file())}.sbom.xml"
|
|
120
|
-
self._protected_sc.run_with_epew("cyclonedx-npm", f"--output-format xml --output-file {relative_path_to_bom_file}", self.get_codeunit_folder(),print_live_output=self._protected_sc.log.loglevel==LogLevel.Diagnostic,encode_argument_in_base64=True)
|
|
121
|
-
self._protected_sc.format_xml_file(self.get_codeunit_folder()+"/"+relative_path_to_bom_file)
|
|
122
|
-
|
|
123
|
-
def get_dependencies(self)->dict[str,set[str]]:
|
|
124
|
-
return dict[str,set[str]]()#TODO
|
|
125
|
-
|
|
126
|
-
@GeneralUtilities.check_arguments
|
|
127
|
-
def get_available_versions(self,dependencyname:str)->list[str]:
|
|
128
|
-
return []#TODO
|
|
129
|
-
|
|
130
|
-
@GeneralUtilities.check_arguments
|
|
131
|
-
def set_dependency_version(self,name:str,new_version:str)->None:
|
|
132
|
-
raise ValueError(f"Operation is not implemented.")
|
|
133
|
-
|
|
134
|
-
@GeneralUtilities.check_arguments
|
|
135
|
-
def add_culture_chooser(self,site_title:str,supported_cultures:list[str])->None:
|
|
136
|
-
output_folder=self.get_codeunit_folder()+"/Other/Artifacts/BuildResult_WebApplication/browser"
|
|
137
|
-
GeneralUtilities.assert_folder_exists(output_folder)
|
|
138
|
-
cc:HTTPMaintenanceOverheadHelper=HTTPMaintenanceOverheadHelper()
|
|
139
|
-
|
|
140
|
-
index_html_file=output_folder+"/index.html"
|
|
141
|
-
GeneralUtilities.ensure_file_exists(index_html_file)
|
|
142
|
-
index_html_content=cc.get_index_html(site_title)
|
|
143
|
-
GeneralUtilities.write_text_to_file(index_html_file, index_html_content)
|
|
144
|
-
|
|
145
|
-
cc_script_file=output_folder+"/CultureChooser.js"
|
|
146
|
-
GeneralUtilities.ensure_file_exists(cc_script_file)
|
|
147
|
-
cc_script_content=cc.get_culture_chooser_script(supported_cultures)
|
|
148
|
-
GeneralUtilities.write_text_to_file(cc_script_file, cc_script_content)
|
|
149
|
-
|
|
150
|
-
@GeneralUtilities.check_arguments
|
|
151
|
-
def add_maintenance_site(self,site_title:str)->None:
|
|
152
|
-
output_folder_base=self.get_codeunit_folder()+"/Other/Artifacts/BuildResult_WebApplication"
|
|
153
|
-
GeneralUtilities.assert_folder_exists(output_folder_base)
|
|
154
|
-
output_folder=os.path.join(output_folder_base,"maintenance")
|
|
155
|
-
GeneralUtilities.ensure_directory_exists(output_folder)
|
|
156
|
-
cc:HTTPMaintenanceOverheadHelper=HTTPMaintenanceOverheadHelper()
|
|
157
|
-
|
|
158
|
-
maintenance_file=output_folder+"/MaintenanceSite.html"
|
|
159
|
-
GeneralUtilities.ensure_file_exists(maintenance_file)
|
|
160
|
-
maintenance_content=cc.get_maintenance_file(site_title)
|
|
161
|
-
GeneralUtilities.write_text_to_file(maintenance_file, maintenance_content)
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
@GeneralUtilities.check_arguments
|
|
165
|
-
def get_available_cultures_for_angular_app(self)->None:
|
|
166
|
-
return self._protected_sc.get_available_cultures_for_angular_app(self.get_codeunit_folder()+"/angular.json")
|
|
167
|
-
|
|
168
|
-
@GeneralUtilities.check_arguments
|
|
169
|
-
def __ensure_translations_exist(self,languages:list[str])->None:
|
|
170
|
-
base_file=os.path.join(self.get_codeunit_folder(),"Other","Resources","Translations",f"messages.xlf")
|
|
171
|
-
for language in languages:
|
|
172
|
-
target_file=os.path.join(self.get_codeunit_folder(),"Other","Resources","Translations",f"messages.{language}.xlf")
|
|
173
|
-
if not os.path.isfile(target_file):
|
|
174
|
-
GeneralUtilities.ensure_file_exists(target_file)
|
|
175
|
-
GeneralUtilities.write_text_to_file(target_file, GeneralUtilities.read_text_from_file(base_file))
|
|
176
|
-
#set new attribute
|
|
177
|
-
tree = ET.parse(target_file)
|
|
178
|
-
root = tree.getroot()
|
|
179
|
-
ns_prefix = "{urn:oasis:names:tc:xliff:document:2.0}"
|
|
180
|
-
for unit in root.findall(f".//{ns_prefix}unit"):
|
|
181
|
-
for segment in unit.findall(f"{ns_prefix}segment"):
|
|
182
|
-
segment.set("state", "initial")
|
|
183
|
-
tree.write(target_file, encoding="utf-8", xml_declaration=True)
|
|
184
|
-
|
|
185
|
-
angular_json_file=self.get_codeunit_folder()+"/angular.json"
|
|
186
|
-
if os.path.isfile(angular_json_file):
|
|
187
|
-
angular_json_path = Path(angular_json_file)
|
|
188
|
-
with angular_json_path.open(encoding="utf-8") as f:
|
|
189
|
-
angular_config = json.load(f)
|
|
190
|
-
i18n_config = angular_config["projects"][self.get_codeunit_name()]["i18n"]
|
|
191
|
-
new_locales = {
|
|
192
|
-
lang: f"Other/Resources/Translations/messages.{lang}.xlf"
|
|
193
|
-
for lang in languages
|
|
194
|
-
}
|
|
195
|
-
i18n_config.setdefault("locales", {}).update(new_locales)
|
|
196
|
-
with angular_json_path.open("w", encoding="utf-8") as f:
|
|
197
|
-
json.dump(angular_config, f, ensure_ascii=False, indent=2)
|
|
198
|
-
|
|
199
|
-
@GeneralUtilities.check_arguments
|
|
200
|
-
def organize_translations(self,languages:list[str])->None:
|
|
201
|
-
self._protected_sc.run_with_epew("npm","run extract-translations",self.get_codeunit_folder())
|
|
202
|
-
self.__ensure_translations_exist(languages)
|
|
203
|
-
self._protected_sc.sync_xlf2_files("messages",languages,os.path.join(self.get_codeunit_folder(),"Other","Resources","Translations"))
|
|
204
|
-
|
|
205
|
-
@GeneralUtilities.check_arguments
|
|
206
|
-
def translate_safe(self,base_language:str="en", throw_if_no_credentials:bool=False)->None:
|
|
207
|
-
"""Translates XLF files if a translation service is configured. The translation service can be configured by creating a file at ~/.ScriptCollection/TranslationServiceProperties.txt with the content 'LibreTranslateAPI=your_api_server_url'."""
|
|
208
|
-
translationservice_file:str=self._protected_sc.get_global_cache_folder()+"/TranslationServiceProperties.txt"
|
|
209
|
-
api_server:str=None
|
|
210
|
-
if os.path.isfile(translationservice_file):
|
|
211
|
-
lines=GeneralUtilities.read_nonempty_lines_from_file(translationservice_file)
|
|
212
|
-
for line in lines:
|
|
213
|
-
if line.startswith("LibreTranslateAPI="):
|
|
214
|
-
api_server=line.replace("LibreTranslateAPI=","").strip()
|
|
215
|
-
if api_server is None:
|
|
216
|
-
if throw_if_no_credentials:
|
|
217
|
-
raise ValueError("No translation service configured. Please create a file at ~/.ScriptCollection/TranslationServiceProperties.txt with the content 'LibreTranslateAPI=your_api_server_url' to enable automatic translation of XLF files.")
|
|
218
|
-
else:
|
|
219
|
-
self.translate(api_server,base_language)
|
|
220
|
-
|
|
221
|
-
@GeneralUtilities.check_arguments
|
|
222
|
-
def translate(self,api_server:str,base_language:str="en")->None:
|
|
223
|
-
folder:str=os.path.join(self.get_codeunit_folder(),"Other","Resources","Translations")
|
|
224
|
-
self._protected_sc.translate_xlf_files_in_folder(folder, base_language, api_server)
|
|
225
|
-
|
|
226
|
-
class TFCPS_CodeUnitSpecific_NodeJS_CLI:
|
|
227
|
-
|
|
228
|
-
@staticmethod
|
|
229
|
-
@GeneralUtilities.check_arguments
|
|
230
|
-
def parse(file:str)->TFCPS_CodeUnitSpecific_NodeJS_Functions:
|
|
231
|
-
parser=TFCPS_CodeUnitSpecific_Base_CLI.get_base_parser()
|
|
232
|
-
#add custom parameter if desired
|
|
233
|
-
args=parser.parse_args()
|
|
234
|
-
result:TFCPS_CodeUnitSpecific_NodeJS_Functions=TFCPS_CodeUnitSpecific_NodeJS_Functions(file,LogLevel(int(args.verbosity)),args.targetenvironmenttype,not args.nocache,args.ispremerge)
|
|
235
|
-
return result
|
|
1
|
+
import os
|
|
2
|
+
import re
|
|
3
|
+
import json
|
|
4
|
+
from pathlib import Path
|
|
5
|
+
import xml.etree.ElementTree as ET
|
|
6
|
+
from lxml import etree
|
|
7
|
+
from ...GeneralUtilities import GeneralUtilities
|
|
8
|
+
from ...SCLog import LogLevel
|
|
9
|
+
from ..TFCPS_CodeUnitSpecific_Base import TFCPS_CodeUnitSpecific_Base,TFCPS_CodeUnitSpecific_Base_CLI
|
|
10
|
+
from ...HTTPMaintenanceOverheadHelper import HTTPMaintenanceOverheadHelper
|
|
11
|
+
|
|
12
|
+
class TFCPS_CodeUnitSpecific_NodeJS_Functions(TFCPS_CodeUnitSpecific_Base):
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
def __init__(self,current_file:str,verbosity:LogLevel,targetenvironmenttype:str,use_cache:bool,is_pre_merge:bool):
|
|
16
|
+
super().__init__(current_file, verbosity,targetenvironmenttype,use_cache,is_pre_merge)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
@GeneralUtilities.check_arguments
|
|
20
|
+
def build(self) -> None:
|
|
21
|
+
self._protected_sc.run_with_epew("npm", "run build", self.get_codeunit_folder(),print_live_output=self.get_verbosity()==LogLevel.Debug,encode_argument_in_base64=True)
|
|
22
|
+
self.standardized_tasks_build_bom_for_node_project()
|
|
23
|
+
self.copy_source_files_to_output_directory()
|
|
24
|
+
|
|
25
|
+
@GeneralUtilities.check_arguments
|
|
26
|
+
def linting(self) -> None:
|
|
27
|
+
codeunit_folder = self.get_codeunit_folder()
|
|
28
|
+
self._protected_sc.normalize_line_endings_of_files_in_folder(codeunit_folder, ["ts", "js", "css", "scss", "sass"])
|
|
29
|
+
# The OpenAPI-generator writes its '.openapi-generator/FILES' metadata-file with the host's native
|
|
30
|
+
# line-endings (CRLF on Windows, LF on Linux). Normalize it to LF like the other generated text-files
|
|
31
|
+
# so the committed file does not drift between build-hosts.
|
|
32
|
+
for openapi_generator_files_file in self._protected_sc.get_not_git_ignored_files_of_folder(codeunit_folder):
|
|
33
|
+
if os.path.basename(openapi_generator_files_file) == "FILES" and os.path.basename(os.path.dirname(openapi_generator_files_file)) == ".openapi-generator":
|
|
34
|
+
self._protected_sc.normalize_line_endings(openapi_generator_files_file)
|
|
35
|
+
for html_file in self._protected_sc.get_not_git_ignored_files_of_folder(codeunit_folder, ".html"):
|
|
36
|
+
self._protected_sc.format_html_file(html_file, os.path.basename(html_file) == "index.html")
|
|
37
|
+
self._protected_sc.run_with_epew("npm", "run lint", codeunit_folder,print_live_output=self.get_verbosity()==LogLevel.Debug,encode_argument_in_base64=True)
|
|
38
|
+
|
|
39
|
+
@GeneralUtilities.check_arguments
|
|
40
|
+
def do_common_tasks(self,current_codeunit_version:str)-> None:
|
|
41
|
+
codeunit_version = current_codeunit_version
|
|
42
|
+
codeunit_folder = self.get_codeunit_folder()
|
|
43
|
+
self.do_common_tasks_base(current_codeunit_version)
|
|
44
|
+
self.tfcps_Tools_General.replace_version_in_packagejson_file(GeneralUtilities.resolve_relative_path("./package.json", codeunit_folder), codeunit_version)
|
|
45
|
+
self.tfcps_Tools_General.do_npm_install(codeunit_folder, True,self.use_cache())
|
|
46
|
+
|
|
47
|
+
@GeneralUtilities.check_arguments
|
|
48
|
+
def generate_reference(self) -> None:
|
|
49
|
+
self.generate_reference_using_docfx()
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
@GeneralUtilities.check_arguments
|
|
53
|
+
def run_testcases(self) -> None:
|
|
54
|
+
# prepare
|
|
55
|
+
codeunit_name: str =self.get_codeunit_name()
|
|
56
|
+
|
|
57
|
+
codeunit_folder =self.get_codeunit_folder()
|
|
58
|
+
repository_folder = os.path.dirname(codeunit_folder)
|
|
59
|
+
|
|
60
|
+
# run testcases
|
|
61
|
+
self._protected_sc.run_with_epew("npm", f"run test-{self.get_target_environment_type()}", self.get_codeunit_folder(),print_live_output=self.get_verbosity()==LogLevel.Debug,encode_argument_in_base64=True)
|
|
62
|
+
|
|
63
|
+
# rename file
|
|
64
|
+
coverage_folder = os.path.join(codeunit_folder, "Other", "Artifacts", "TestCoverage")
|
|
65
|
+
target_file = os.path.join(coverage_folder, "TestCoverage.xml")
|
|
66
|
+
GeneralUtilities.ensure_file_does_not_exist(target_file)
|
|
67
|
+
os.rename(os.path.join(coverage_folder, "cobertura-coverage.xml"), target_file)
|
|
68
|
+
self.__rename_packagename_in_coverage_file(target_file, codeunit_name)
|
|
69
|
+
|
|
70
|
+
# adapt backslashs to slashs
|
|
71
|
+
content = GeneralUtilities.read_text_from_file(target_file)
|
|
72
|
+
content = re.sub('\\\\', '/', content)
|
|
73
|
+
GeneralUtilities.write_text_to_file(target_file, content)
|
|
74
|
+
|
|
75
|
+
# aggregate packages in testcoverage-file
|
|
76
|
+
roottree: etree._ElementTree = etree.parse(target_file)
|
|
77
|
+
existing_classes = list(roottree.xpath('//coverage/packages/package/classes/class'))
|
|
78
|
+
|
|
79
|
+
old_packages_list = roottree.xpath('//coverage/packages/package')
|
|
80
|
+
for package in old_packages_list:
|
|
81
|
+
package.getparent().remove(package)
|
|
82
|
+
|
|
83
|
+
root = roottree.getroot()
|
|
84
|
+
packages_element = root.find("packages")
|
|
85
|
+
package_element = etree.SubElement(packages_element, "package")
|
|
86
|
+
package_element.attrib['name'] = codeunit_name
|
|
87
|
+
package_element.attrib['lines-valid'] = root.attrib["lines-valid"]
|
|
88
|
+
package_element.attrib['lines-covered'] = root.attrib["lines-covered"]
|
|
89
|
+
package_element.attrib['line-rate'] = root.attrib["line-rate"]
|
|
90
|
+
package_element.attrib['branches-valid'] = root.attrib["branches-valid"]
|
|
91
|
+
package_element.attrib['branches-covered'] = root.attrib["branches-covered"]
|
|
92
|
+
package_element.attrib['branch-rate'] = root.attrib["branch-rate"]
|
|
93
|
+
package_element.attrib['timestamp'] = root.attrib["timestamp"]
|
|
94
|
+
package_element.attrib['complexity'] = root.attrib["complexity"]
|
|
95
|
+
|
|
96
|
+
classes_element = etree.SubElement(package_element, "classes")
|
|
97
|
+
|
|
98
|
+
for existing_class in existing_classes:
|
|
99
|
+
classes_element.append(existing_class)
|
|
100
|
+
|
|
101
|
+
result = etree.tostring(roottree, pretty_print=True).decode("utf-8")
|
|
102
|
+
GeneralUtilities.write_text_to_file(target_file, result)
|
|
103
|
+
|
|
104
|
+
# post tasks
|
|
105
|
+
self.run_testcases_common_post_task(repository_folder, codeunit_name, True, self.get_target_environment_type())
|
|
106
|
+
|
|
107
|
+
@GeneralUtilities.check_arguments
|
|
108
|
+
def __rename_packagename_in_coverage_file(self, file: str, codeunit_name: str) -> None:
|
|
109
|
+
root: etree._ElementTree = etree.parse(file)
|
|
110
|
+
packages = root.xpath('//coverage/packages/package')
|
|
111
|
+
for package in packages:
|
|
112
|
+
package.attrib['name'] = codeunit_name
|
|
113
|
+
result = etree.tostring(root).decode("utf-8")
|
|
114
|
+
GeneralUtilities.write_text_to_file(file, result)
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
@GeneralUtilities.check_arguments
|
|
118
|
+
def standardized_tasks_build_bom_for_node_project(self) -> None:
|
|
119
|
+
relative_path_to_bom_file = f"Other/Artifacts/BOM/{os.path.basename(self.get_codeunit_folder())}.{self.tfcps_Tools_General.get_version_of_codeunit(self.get_codeunit_file())}.sbom.xml"
|
|
120
|
+
self._protected_sc.run_with_epew("cyclonedx-npm", f"--output-format xml --output-file {relative_path_to_bom_file}", self.get_codeunit_folder(),print_live_output=self._protected_sc.log.loglevel==LogLevel.Diagnostic,encode_argument_in_base64=True)
|
|
121
|
+
self._protected_sc.format_xml_file(self.get_codeunit_folder()+"/"+relative_path_to_bom_file)
|
|
122
|
+
|
|
123
|
+
def get_dependencies(self)->dict[str,set[str]]:
|
|
124
|
+
return dict[str,set[str]]()#TODO
|
|
125
|
+
|
|
126
|
+
@GeneralUtilities.check_arguments
|
|
127
|
+
def get_available_versions(self,dependencyname:str)->list[str]:
|
|
128
|
+
return []#TODO
|
|
129
|
+
|
|
130
|
+
@GeneralUtilities.check_arguments
|
|
131
|
+
def set_dependency_version(self,name:str,new_version:str)->None:
|
|
132
|
+
raise ValueError(f"Operation is not implemented.")
|
|
133
|
+
|
|
134
|
+
@GeneralUtilities.check_arguments
|
|
135
|
+
def add_culture_chooser(self,site_title:str,supported_cultures:list[str])->None:
|
|
136
|
+
output_folder=self.get_codeunit_folder()+"/Other/Artifacts/BuildResult_WebApplication/browser"
|
|
137
|
+
GeneralUtilities.assert_folder_exists(output_folder)
|
|
138
|
+
cc:HTTPMaintenanceOverheadHelper=HTTPMaintenanceOverheadHelper()
|
|
139
|
+
|
|
140
|
+
index_html_file=output_folder+"/index.html"
|
|
141
|
+
GeneralUtilities.ensure_file_exists(index_html_file)
|
|
142
|
+
index_html_content=cc.get_index_html(site_title)
|
|
143
|
+
GeneralUtilities.write_text_to_file(index_html_file, index_html_content)
|
|
144
|
+
|
|
145
|
+
cc_script_file=output_folder+"/CultureChooser.js"
|
|
146
|
+
GeneralUtilities.ensure_file_exists(cc_script_file)
|
|
147
|
+
cc_script_content=cc.get_culture_chooser_script(supported_cultures)
|
|
148
|
+
GeneralUtilities.write_text_to_file(cc_script_file, cc_script_content)
|
|
149
|
+
|
|
150
|
+
@GeneralUtilities.check_arguments
|
|
151
|
+
def add_maintenance_site(self,site_title:str)->None:
|
|
152
|
+
output_folder_base=self.get_codeunit_folder()+"/Other/Artifacts/BuildResult_WebApplication"
|
|
153
|
+
GeneralUtilities.assert_folder_exists(output_folder_base)
|
|
154
|
+
output_folder=os.path.join(output_folder_base,"maintenance")
|
|
155
|
+
GeneralUtilities.ensure_directory_exists(output_folder)
|
|
156
|
+
cc:HTTPMaintenanceOverheadHelper=HTTPMaintenanceOverheadHelper()
|
|
157
|
+
|
|
158
|
+
maintenance_file=output_folder+"/MaintenanceSite.html"
|
|
159
|
+
GeneralUtilities.ensure_file_exists(maintenance_file)
|
|
160
|
+
maintenance_content=cc.get_maintenance_file(site_title)
|
|
161
|
+
GeneralUtilities.write_text_to_file(maintenance_file, maintenance_content)
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
@GeneralUtilities.check_arguments
|
|
165
|
+
def get_available_cultures_for_angular_app(self)->None:
|
|
166
|
+
return self._protected_sc.get_available_cultures_for_angular_app(self.get_codeunit_folder()+"/angular.json")
|
|
167
|
+
|
|
168
|
+
@GeneralUtilities.check_arguments
|
|
169
|
+
def __ensure_translations_exist(self,languages:list[str])->None:
|
|
170
|
+
base_file=os.path.join(self.get_codeunit_folder(),"Other","Resources","Translations",f"messages.xlf")
|
|
171
|
+
for language in languages:
|
|
172
|
+
target_file=os.path.join(self.get_codeunit_folder(),"Other","Resources","Translations",f"messages.{language}.xlf")
|
|
173
|
+
if not os.path.isfile(target_file):
|
|
174
|
+
GeneralUtilities.ensure_file_exists(target_file)
|
|
175
|
+
GeneralUtilities.write_text_to_file(target_file, GeneralUtilities.read_text_from_file(base_file))
|
|
176
|
+
#set new attribute
|
|
177
|
+
tree = ET.parse(target_file)
|
|
178
|
+
root = tree.getroot()
|
|
179
|
+
ns_prefix = "{urn:oasis:names:tc:xliff:document:2.0}"
|
|
180
|
+
for unit in root.findall(f".//{ns_prefix}unit"):
|
|
181
|
+
for segment in unit.findall(f"{ns_prefix}segment"):
|
|
182
|
+
segment.set("state", "initial")
|
|
183
|
+
tree.write(target_file, encoding="utf-8", xml_declaration=True)
|
|
184
|
+
|
|
185
|
+
angular_json_file=self.get_codeunit_folder()+"/angular.json"
|
|
186
|
+
if os.path.isfile(angular_json_file):
|
|
187
|
+
angular_json_path = Path(angular_json_file)
|
|
188
|
+
with angular_json_path.open(encoding="utf-8") as f:
|
|
189
|
+
angular_config = json.load(f)
|
|
190
|
+
i18n_config = angular_config["projects"][self.get_codeunit_name()]["i18n"]
|
|
191
|
+
new_locales = {
|
|
192
|
+
lang: f"Other/Resources/Translations/messages.{lang}.xlf"
|
|
193
|
+
for lang in languages
|
|
194
|
+
}
|
|
195
|
+
i18n_config.setdefault("locales", {}).update(new_locales)
|
|
196
|
+
with angular_json_path.open("w", encoding="utf-8") as f:
|
|
197
|
+
json.dump(angular_config, f, ensure_ascii=False, indent=2)
|
|
198
|
+
|
|
199
|
+
@GeneralUtilities.check_arguments
|
|
200
|
+
def organize_translations(self,languages:list[str])->None:
|
|
201
|
+
self._protected_sc.run_with_epew("npm","run extract-translations",self.get_codeunit_folder())
|
|
202
|
+
self.__ensure_translations_exist(languages)
|
|
203
|
+
self._protected_sc.sync_xlf2_files("messages",languages,os.path.join(self.get_codeunit_folder(),"Other","Resources","Translations"))
|
|
204
|
+
|
|
205
|
+
@GeneralUtilities.check_arguments
|
|
206
|
+
def translate_safe(self,base_language:str="en", throw_if_no_credentials:bool=False)->None:
|
|
207
|
+
"""Translates XLF files if a translation service is configured. The translation service can be configured by creating a file at ~/.ScriptCollection/TranslationServiceProperties.txt with the content 'LibreTranslateAPI=your_api_server_url'."""
|
|
208
|
+
translationservice_file:str=self._protected_sc.get_global_cache_folder()+"/TranslationServiceProperties.txt"
|
|
209
|
+
api_server:str=None
|
|
210
|
+
if os.path.isfile(translationservice_file):
|
|
211
|
+
lines=GeneralUtilities.read_nonempty_lines_from_file(translationservice_file)
|
|
212
|
+
for line in lines:
|
|
213
|
+
if line.startswith("LibreTranslateAPI="):
|
|
214
|
+
api_server=line.replace("LibreTranslateAPI=","").strip()
|
|
215
|
+
if api_server is None:
|
|
216
|
+
if throw_if_no_credentials:
|
|
217
|
+
raise ValueError("No translation service configured. Please create a file at ~/.ScriptCollection/TranslationServiceProperties.txt with the content 'LibreTranslateAPI=your_api_server_url' to enable automatic translation of XLF files.")
|
|
218
|
+
else:
|
|
219
|
+
self.translate(api_server,base_language)
|
|
220
|
+
|
|
221
|
+
@GeneralUtilities.check_arguments
|
|
222
|
+
def translate(self,api_server:str,base_language:str="en")->None:
|
|
223
|
+
folder:str=os.path.join(self.get_codeunit_folder(),"Other","Resources","Translations")
|
|
224
|
+
self._protected_sc.translate_xlf_files_in_folder(folder, base_language, api_server)
|
|
225
|
+
|
|
226
|
+
class TFCPS_CodeUnitSpecific_NodeJS_CLI:
|
|
227
|
+
|
|
228
|
+
@staticmethod
|
|
229
|
+
@GeneralUtilities.check_arguments
|
|
230
|
+
def parse(file:str)->TFCPS_CodeUnitSpecific_NodeJS_Functions:
|
|
231
|
+
parser=TFCPS_CodeUnitSpecific_Base_CLI.get_base_parser()
|
|
232
|
+
#add custom parameter if desired
|
|
233
|
+
args=parser.parse_args()
|
|
234
|
+
result:TFCPS_CodeUnitSpecific_NodeJS_Functions=TFCPS_CodeUnitSpecific_NodeJS_Functions(file,LogLevel(int(args.verbosity)),args.targetenvironmenttype,not args.nocache,args.ispremerge)
|
|
235
|
+
return result
|