ScriptCollection 4.4.54__py3-none-any.whl → 4.4.55__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/ScriptCollectionCore.py +1 -1
- ScriptCollection/TFCPS/TFCPS_VisualRegressionTests.py +47 -17
- {scriptcollection-4.4.54.dist-info → scriptcollection-4.4.55.dist-info}/METADATA +1 -1
- {scriptcollection-4.4.54.dist-info → scriptcollection-4.4.55.dist-info}/RECORD +7 -7
- {scriptcollection-4.4.54.dist-info → scriptcollection-4.4.55.dist-info}/WHEEL +0 -0
- {scriptcollection-4.4.54.dist-info → scriptcollection-4.4.55.dist-info}/entry_points.txt +0 -0
- {scriptcollection-4.4.54.dist-info → scriptcollection-4.4.55.dist-info}/top_level.txt +0 -0
|
@@ -2,6 +2,7 @@ import json
|
|
|
2
2
|
import os
|
|
3
3
|
import re
|
|
4
4
|
import socket
|
|
5
|
+
from typing import Callable
|
|
5
6
|
from PIL import Image, ImageChops
|
|
6
7
|
from ..GeneralUtilities import GeneralUtilities
|
|
7
8
|
from ..ScriptCollectionCore import ScriptCollectionCore
|
|
@@ -76,7 +77,7 @@ class TFCPS_VisualRegressionTests:
|
|
|
76
77
|
self.__sc.log.loglevel = tfcps_codeunit.get_verbosity()
|
|
77
78
|
|
|
78
79
|
@GeneralUtilities.check_arguments
|
|
79
|
-
def run(self, update_baselines: bool, playwright_project_folder_relative_path: str = ".", domain_of_externally_started_application: str = None, environment_variables: dict[str, str] = None, playwright_project: str = None) -> None:
|
|
80
|
+
def run(self, update_baselines: bool, playwright_project_folder_relative_path: str = ".", domain_of_externally_started_application: str = None, environment_variables: dict[str, str] = None, playwright_project: str = None, restart_application_under_test: Callable = None) -> None:
|
|
80
81
|
"""Executes the visual-regression-tests of the codeunit.
|
|
81
82
|
If 'update_baselines' is false the screenshots are compared with the baselines and a difference fails the
|
|
82
83
|
run. If 'update_baselines' is true the baseline-screenshots are regenerated instead: missing ones are
|
|
@@ -96,7 +97,17 @@ class TFCPS_VisualRegressionTests:
|
|
|
96
97
|
'playwright_project' restricts the run to one project of the playwright-configuration (which is one
|
|
97
98
|
browser). It is required by codeunits whose testcases change the state of the application under test:
|
|
98
99
|
those have to start the application newly for every browser, because otherwise the second browser would
|
|
99
|
-
find the state which the first one left behind and would therefore see other pages than the first one.
|
|
100
|
+
find the state which the first one left behind and would therefore see other pages than the first one.
|
|
101
|
+
'restart_application_under_test' is only relevant in the update-mode and only for an application which the
|
|
102
|
+
caller started itself (see the documentation of this class). That mode runs the testcases twice (see the
|
|
103
|
+
construction of the command below): once to write the baselines and once to verify that every screenshot
|
|
104
|
+
could really be produced. An application which the playwright-configuration starts itself is restarted by
|
|
105
|
+
every "npx playwright test" and therefore begins the verify-pass with a fresh state, but an application
|
|
106
|
+
which the caller started keeps its state for the lifetime of its process, so a testcase which changes that
|
|
107
|
+
state (by registering a user or by creating an entity for example) would find in the verify-pass the state
|
|
108
|
+
which it created in the update-pass and would fail although its screenshot could be produced. The caller
|
|
109
|
+
therefore passes this callback, which restarts the application between the two passes; when it is not given
|
|
110
|
+
the two passes share one application, which is correct for an application that restarts itself."""
|
|
100
111
|
codeunit_folder: str = self.__tfcps_codeunit.get_codeunit_folder()
|
|
101
112
|
repository_folder: str = self.__tfcps_codeunit.get_repository_folder()
|
|
102
113
|
playwright_project_folder: str = self.__get_folder_in_codeunit(codeunit_folder, playwright_project_folder_relative_path)
|
|
@@ -119,6 +130,21 @@ class TFCPS_VisualRegressionTests:
|
|
|
119
130
|
# contain packages for another operating-system. "--no-save" is required so that the installation does not
|
|
120
131
|
# modify "package.json" or "package-lock.json".
|
|
121
132
|
install_command: str = "npm install --no-audit --no-fund --no-save"
|
|
133
|
+
base_arguments: list[str] = ["run", "--rm"]
|
|
134
|
+
# Playwright recommends this because the default-size of the shared memory of a container is too small for
|
|
135
|
+
# chromium, which makes chromium crash on pages which are not trivial.
|
|
136
|
+
base_arguments = base_arguments+["--ipc=host"]
|
|
137
|
+
base_arguments = base_arguments+self.__get_mount_arguments(codeunit_folder, codeunit_folder_in_container, playwright_project_folder_relative_path)
|
|
138
|
+
if domain_of_externally_started_application is not None:
|
|
139
|
+
base_arguments = base_arguments+self.__get_network_arguments(domain_of_externally_started_application)
|
|
140
|
+
if environment_variables is not None:
|
|
141
|
+
for name, value in environment_variables.items():
|
|
142
|
+
base_arguments = base_arguments+["-e", f"{name}={value}"]
|
|
143
|
+
base_arguments = base_arguments+["-w", working_folder, image]
|
|
144
|
+
|
|
145
|
+
def run_in_container(command_to_run: str) -> tuple:
|
|
146
|
+
return self.__sc.run_program_argsasarray("docker", base_arguments+["/bin/sh", "-c", command_to_run], throw_exception_if_exitcode_is_not_zero=False, print_live_output=True, print_errors_as_information=True)
|
|
147
|
+
|
|
122
148
|
if update_baselines:
|
|
123
149
|
# The update-run writes the baseline-screenshots (it creates the missing ones and overwrites the
|
|
124
150
|
# changed ones). Since playwright 1.50 that run reports every testcase whose screenshot it created or
|
|
@@ -129,22 +155,26 @@ class TFCPS_VisualRegressionTests:
|
|
|
129
155
|
# captured stabilizes and therefore matches its own new baseline, while a testcase which can not
|
|
130
156
|
# produce a screenshot keeps failing (a missing baseline is regenerated by the second run and still
|
|
131
157
|
# fails it). The exit-code of the second run therefore decides about success, so the one of the
|
|
132
|
-
# update-run is discarded
|
|
133
|
-
|
|
158
|
+
# update-run is discarded.
|
|
159
|
+
update_command: str = f"{install_command} && {test_command} --update-snapshots"
|
|
160
|
+
verify_command: str = f"{install_command} && {test_command}"
|
|
161
|
+
if restart_application_under_test is None:
|
|
162
|
+
# The application restarts itself between the two passes (for example because the
|
|
163
|
+
# playwright-configuration starts it through its "webServer"-setting), so both passes can share one
|
|
164
|
+
# invocation. They are separated by ";" and not by "&&" so that the discarded exit-code of the
|
|
165
|
+
# update-run does not skip the verify-run.
|
|
166
|
+
result = run_in_container(f"{install_command} && ( {test_command} --update-snapshots ; {test_command} )")
|
|
167
|
+
else:
|
|
168
|
+
# The application was started by the caller and keeps its state for the lifetime of its process, so
|
|
169
|
+
# the two passes must not share one application: the verify-pass would otherwise find the state
|
|
170
|
+
# which a testcase created in the update-pass (a registered user or a created entity for example)
|
|
171
|
+
# and would fail although its screenshot could be produced. The passes are therefore two separate
|
|
172
|
+
# invocations and the caller restarts the application in between through the callback.
|
|
173
|
+
run_in_container(update_command)
|
|
174
|
+
restart_application_under_test()
|
|
175
|
+
result = run_in_container(verify_command)
|
|
134
176
|
else:
|
|
135
|
-
|
|
136
|
-
arguments: list[str] = ["run", "--rm"]
|
|
137
|
-
# Playwright recommends this because the default-size of the shared memory of a container is too small for
|
|
138
|
-
# chromium, which makes chromium crash on pages which are not trivial.
|
|
139
|
-
arguments = arguments+["--ipc=host"]
|
|
140
|
-
arguments = arguments+self.__get_mount_arguments(codeunit_folder, codeunit_folder_in_container, playwright_project_folder_relative_path)
|
|
141
|
-
if domain_of_externally_started_application is not None:
|
|
142
|
-
arguments = arguments+self.__get_network_arguments(domain_of_externally_started_application)
|
|
143
|
-
if environment_variables is not None:
|
|
144
|
-
for name, value in environment_variables.items():
|
|
145
|
-
arguments = arguments+["-e", f"{name}={value}"]
|
|
146
|
-
arguments = arguments+["-w", working_folder, image, "/bin/sh", "-c", command]
|
|
147
|
-
result = self.__sc.run_program_argsasarray("docker", arguments, throw_exception_if_exitcode_is_not_zero=False, print_live_output=True, print_errors_as_information=True)
|
|
177
|
+
result = run_in_container(f"{install_command} && {test_command}")
|
|
148
178
|
if result[0] != 0:
|
|
149
179
|
if update_baselines:
|
|
150
180
|
# A non-zero exit-code of the second run means a screenshot could not be produced even against its
|
|
@@ -11,7 +11,7 @@ ScriptCollection/ProgramRunnerSudo.py,sha256=vwKq-MOcqsgiKhSf-MBUDBC_UyaU8evP3Ro
|
|
|
11
11
|
ScriptCollection/RepositoryDiagramGenerator.py,sha256=K_u2NW_p4ozdWD50irJEkkcDVa70TcUJpZN63TeXSLw,7092
|
|
12
12
|
ScriptCollection/RepositoryHistoryAnalyzer.py,sha256=u9141B9D-Kef-9uo3yR7BXKUMzIKLVsesnYk7H-cWm4,6157
|
|
13
13
|
ScriptCollection/SCLog.py,sha256=Fjf8Pdi63cXHGMxL_aI6A0dwGm7QIfrv3czjvpSUlaM,4705
|
|
14
|
-
ScriptCollection/ScriptCollectionCore.py,sha256=
|
|
14
|
+
ScriptCollection/ScriptCollectionCore.py,sha256=PuIiMubN5jksKWshA9gbrmZP_foKXaa0Zt0FqrVF0Yw,310633
|
|
15
15
|
ScriptCollection/TestKind.py,sha256=jqLJwNvQeyea7SZf-UFzMC9pM0znv4do7FIC1xq8u9M,1672
|
|
16
16
|
ScriptCollection/UnassignedVariablesCheck.py,sha256=8xNcp1D5HeOLO1a1NEerq2TsnpFhw7yzYPkaay-oisY,3804
|
|
17
17
|
ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
@@ -48,7 +48,7 @@ ScriptCollection/TFCPS/TFCPS_OCIImageSecretScan.py,sha256=Jb7AaMcJDW-gYEYBUVZAG3
|
|
|
48
48
|
ScriptCollection/TFCPS/TFCPS_PreBuildCodeunitsScript.py,sha256=XLVsFTA1jvfDbZ7wYJgIdEByZhF_bYVbA5jkisuvK4k,2322
|
|
49
49
|
ScriptCollection/TFCPS/TFCPS_RemoteBuild.py,sha256=2Tx5HLk1ZftBWDCTiGZdP2QiiGNyWsEuTCSt33dNQjc,23891
|
|
50
50
|
ScriptCollection/TFCPS/TFCPS_Tools_General.py,sha256=eGmKZSoS2EQin-qrHTewJrvm-2VzdZhw6d0LceIonF0,158891
|
|
51
|
-
ScriptCollection/TFCPS/TFCPS_VisualRegressionTests.py,sha256=
|
|
51
|
+
ScriptCollection/TFCPS/TFCPS_VisualRegressionTests.py,sha256=F90CF5kLCgV_M3yN696xWzF1cglWLXecau9My2ZyGxw,42230
|
|
52
52
|
ScriptCollection/TFCPS/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
53
53
|
ScriptCollection/TFCPS/CPP/TFCPS_CodeUnitSpecific_CPP.py,sha256=BNZPMjGiWLMBH7QDtP06WEVLMnI38NLX4Dpd13bSbi4,16614
|
|
54
54
|
ScriptCollection/TFCPS/CPP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
@@ -73,8 +73,8 @@ ScriptCollection/TFCPS/Rust/TFCPS_CodeUnitSpecific_Rust.py,sha256=yyjWPMHQjPLkML
|
|
|
73
73
|
ScriptCollection/TFCPS/Rust/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
74
74
|
ScriptCollection/TFCPS/TypeScript/TFCPS_CodeUnitSpecific_TypeScript.py,sha256=ILVhJHvwG5TvPBBqSvyACYb7W9QnWrJpxKgHu8IQu4g,9249
|
|
75
75
|
ScriptCollection/TFCPS/TypeScript/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
76
|
-
scriptcollection-4.4.
|
|
77
|
-
scriptcollection-4.4.
|
|
78
|
-
scriptcollection-4.4.
|
|
79
|
-
scriptcollection-4.4.
|
|
80
|
-
scriptcollection-4.4.
|
|
76
|
+
scriptcollection-4.4.55.dist-info/METADATA,sha256=UgU-qihSFZ52MbEHY-5kMH-5WQN_mLK0NYiXszxgh7k,8032
|
|
77
|
+
scriptcollection-4.4.55.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
|
|
78
|
+
scriptcollection-4.4.55.dist-info/entry_points.txt,sha256=--Xk3EcTa14uk1YnUD8CQ2naQjNKJFohScd1ONy4CeY,6135
|
|
79
|
+
scriptcollection-4.4.55.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
|
|
80
|
+
scriptcollection-4.4.55.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|
|
File without changes
|