Starting expecco via Command Line/en - Versionsgeschichte

Cg: /* Recommended Command Line Options */

2024-06-27T15:48:08Z

Recommended Command Line Options

← Nächstältere Version		Version vom 27. Juni 2024, 15:48 Uhr
Zeile 59:		Zeile 59:
	'''expecco --execute <testsuite filename>'''		'''expecco --execute <testsuite filename>'''

	You will notice, that expecco shows a banner initially; this can be disabled with a '''--noBanner''' option. ~~Also, under Windows, a small tray icon is shown in the lower right, which provides a controlling UI. This is disabled with '''--noTray'''.~~		You will notice, that expecco shows a banner initially; this can be disabled with a '''--noBanner''' option.<br>
			Also, under Windows, a small tray icon is shown in the lower right, which provides a [[Windows_Tray\|controlling UI]].
			This is disabled with '''--noTray'''.

	Finally, as mentioned before, the test's outcome is reported via the exit code. If you want a little more information on the status of individual test cases, use a '''--verdicts''' option.		Finally, as mentioned before, the test's outcome is reported via the exit code. If you want a little more information on the status of individual test cases, use a '''--verdicts''' option.

Sv: /* Services */

2022-03-14T16:20:39Z

Services

← Nächstältere Version		Version vom 14. März 2022, 16:20 Uhr
Zeile 260:		Zeile 260:
	*'''<code>--server</code>'''<br>Starts expecco in server mode. This combines the "''--service''", "''--infoService''" and "''--remoteControlService''" flags. All of those services as described below are started with that single command line argument.<p></p>		*'''<code>--server</code>'''<br>Starts expecco in server mode. This combines the "''--service''", "''--infoService''" and "''--remoteControlService''" flags. All of those services as described below are started with that single command line argument.<p></p>

	*'''<code>--service</code>'''<br>Starts expecco in test-server mode (actually a ''test slave'' mode). In this mode, HTTP-SOAP and HTTP-REST requests can be used to remote-control expecco's execution; especially, to execute and monitor tests, and upload results. The most obvious use for this is for expecco to act as an execution host (test slave) for an expecco ALM or Polarion server.<br>However, because standard protocols are used, this may also be used to interface the execution engine to many other QM management or automation systems (e.g. HP Quality Center). The interface is described below.<br>In this mode, ~~ALM~~ needs to know and needs to be able to contact the test slave.<p></p>		*'''<code>--service</code>'''<br>Starts expecco in test-server mode (actually a ''test slave'' mode). In this mode, HTTP-SOAP and HTTP-REST requests can be used to remote-control expecco's execution; especially, to execute and monitor tests, and upload results. The most obvious use for this is for expecco to act as an execution host (test slave) for an expecco ALM or Polarion server.<br>However, because standard protocols are used, this may also be used to interface the execution engine to many other QM management or automation systems (e.g. HP Quality Center). The interface is described below.<br>In this mode, expeccoALM needs to know and needs to be able to contact the expecco test slave.<p></p>

	*'''<code>--webSocketService</code>'''<br>Starts expecco in webSocket ''test slave'' mode. In this mode, expecco ~~contacts~~ the ~~ALM~~ system and communicates with it via a WebSocket. This is similar to the above, but ~~ALM~~ does not need to know and ~~contact~~ the ~~test~~ ~~slaves~~. Instead, the slave actively ~~contact~~ ~~ALM~~. Use this setup, if ~~ALM~~ is ~~installed~~ ~~inside~~ a cloud container and cannot ~~open~~ connections to the outside world ~~except~~ ~~for~~ 80/8080 HTTP ports.<br>The slave(s) need to be initially configured for this by following ~~the instruction in https://doc.expecco.de/wiki2.x/~~Anbindung_expecco_ALM#Ab_expecco_Version_20.1<p></p>		*'''<code>--webSocketService</code>'''<br>Starts expecco in webSocket ''test slave'' mode. In this mode, expecco initiates the connection to the expeccoALM system and communicates with it via a WebSocket. This is similar to the above, but expeccoALM does not need to know the test slaves and does not establish the connections to them. Instead, the expecco slave actively contacts expeccoALM. Use this setup, if your expecco slaves are running behind a firewall or in a cloud container or if expeccoALM is running in a cloud container and cannot initiate connections to the outside world but only listen to 80/8080 HTTP ports.<br>The expecco slave(s) need to be initially configured for this by following [[#Anbindung_expecco_ALM#Ab_expecco_Version_20.1\|this instruction]].<p></p>

	*'''<code>--infoService</code>'''<br>Provide an additional info service which allows for monitoring and control of an expecco server via a web browser (server mode only).<p></p>		*'''<code>--infoService</code>'''<br>Provide an additional info service which allows for monitoring and control of an expecco server via a web browser (server mode only).<p></p>

Sv: /* Utility Functions */ --eval

2022-03-14T16:00:24Z

Utility Functions: --eval

← Nächstältere Version		Version vom 14. März 2022, 16:00 Uhr
Zeile 278:		Zeile 278:
	*'''<code>--diff <file1> <file2></code>'''<br>Print differences between two test suites. This can be used e.g. to automatically generate log messages for a revision control system (please read the section on "Integration with Source Code Management System" below).		*'''<code>--diff <file1> <file2></code>'''<br>Print differences between two test suites. This can be used e.g. to automatically generate log messages for a revision control system (please read the section on "Integration with Source Code Management System" below).

	*'''<code>--vdiff <file1> <file2></code>'''<br>~~Opens~~ a version-diff viewer showing the differences between two test suites. This can be used e.g. to be automatically opened before checking a version into a revision control system (please read the section on "Integration with Source Code Management System" below).<p></p>		*'''<code>--vdiff <file1> <file2></code>'''<br>Open a version-diff viewer showing the differences between two test suites. This can be used e.g. to be automatically opened before checking a version into a revision control system (please read the section on "Integration with Source Code Management System" below).<p></p>

			*'''<code>--eval <Smalltalk expression> [<args>...]</code>'''<br>evaluate the Smalltalk expression inside expecco. examples:<br><code> expecco --noDisplay --eval "1 to:%1 do:[:i\| i factorial printCR]" 12</code><br><code> expecco --eval "Expecco::Browser open. Semaphore new wait"</code>

	=== Command Exit Status ===		=== Command Exit Status ===

Cg: /* Script File Example */

2021-11-19T08:18:05Z

Script File Example

← Nächstältere Version		Version vom 19. November 2021, 08:18 Uhr
Zeile 614:		Zeile 614:
	];		];

		⚫	var currentPrefs = Expecco::ExpeccoPreferences.current();

	~~Expecco::ExpeccoPreferences.current~~.automaticReimportOnLoad(true);		currentPrefs.automaticReimportOnLoad(true);
	~~Expecco::ExpeccoPreferences.current~~.checkForReimportableImportsOnLoad(true);		currentPrefs.checkForReimportableImportsOnLoad(true);
	~~Expecco::ExpeccoPreferences.current~~.checkForAnchestorOnAutomaticReimport(false);		currentPrefs.checkForAnchestorOnAutomaticReimport(false);
			// if required, tell expecco where to find import libs
⚫	// Expecco::ExpeccoPreferences.current~~.libraryPath~~(~~importPathes~~);
			// currentPrefs.libraryPath(importPathes);

	// --------------------		// --------------------

	function executeTestPlan ( aTestPlan ) {		function executeTestPlan ( aTestPlan ) {
	~~Stderr.nextPutLine("executing~~ ~~testplan~~ "+aTestPlan.name(~~)+"..."~~);		var tName = aTestPlan.name();

			Stderr.nextPutLine("executing testplan "+tName+"...");
	resultList = aTestPlan.execute();		resultList = aTestPlan.execute();
	Stderr.nextPutLine("done.");		Stderr.nextPutLine("done.");
Zeile 644:		Zeile 647:

	files.do(runSuite);		files.do(runSuite);
			// or, if you prefer:
			// for (var file in files) {
			// runSuite(file);
			// }
			}
	</PRE>		</PRE>

	And can be executed with:		And can be executed with:

	expecco --scriptFile run3Suites.js		expecco --scriptFile run3Suites.js

	for windowless operation, use the "<code>--noWindow</code>" command line argument.		for windowless operation, use the "<code>--noWindow</code>" command line argument.
	To speed up the startup, you can turn off the loading of plugins, with a "<code>--noPlugins</code>" argument (and possibly load any required plugins explicitly via additional plugin arguments).		To speed up the startup, you can turn off the loading of plugins, with a "<code>--noPlugins</code>" argument (and possibly load any required plugins explicitly via additional plugin arguments).
	Finally, enable debug messages with a "<code>--debug</code>" argument.		Finally, enable debug messages with a "<code>--debug</code>" argument.
	Thus, the recommended options for scripting are:		Thus, the recommended options for scripting are:

	expecco --debug --noPlugins --noWindow --scriptFile run3Suites.js		expecco --debug --noPlugins --noWindow --scriptFile run3Suites.js

	of course, this command line can be put into a shell (or batch) script file, and then executed with a single word command.		of course, this command line can be put into a shell (or batch) script file, and then executed with a single word command.

Cg: /* Scripting */

2021-11-19T08:10:36Z

Scripting

← Nächstältere Version		Version vom 19. November 2021, 08:10 Uhr
Zeile 593:		Zeile 593:
	* Controlling an application or web interface (via a GUI plugin) and saving a sequence of screen shots		* Controlling an application or web interface (via a GUI plugin) and saving a sequence of screen shots

	By default, the scripting interface expects expressions in JavaScript syntax (but with a Smalltalk object model), ~~similar to~~ the language used ~~for~~ elementary block ~~definition~~. However, the language can be changed to Smalltalk syntax via a "~" directive.		By default, the scripting interface expects expressions in JavaScript syntax (but with a Smalltalk object model) - the same language as used in elementary block definitions. However, the language can be changed to Smalltalk syntax via a "~" directive.

	=== Script File Example ===		=== Script File Example ===

Cg: /* Generating Diff Lists or other Version Information */

2021-11-19T08:09:11Z

Generating Diff Lists or other Version Information

← Nächstältere Version		Version vom 19. November 2021, 08:09 Uhr
Zeile 574:		Zeile 574:
	Many source code management systems allow for hook-scripts to be added to checkin/checkout actions, and/or to redefine the command to be used for diff-list generation.		Many source code management systems allow for hook-scripts to be added to checkin/checkout actions, and/or to redefine the command to be used for diff-list generation.

	For example, in the SVN system, an external diff tool can be defined. You could write a little shell or batch script, which calls expecco with the "<code>--diff</code>" option which is described above. Thus, you would get meaningful diff output even from checked in ets-bundle files.		For example, in the SVN system, an external diff tool can be defined. You could write a little shell or batch script, which calls expecco with the "<code>--diff</code>" option which is described above. Thus, you would get meaningful diff output even from checked in ets-bundle files. The output can then be used as a checkin "log" message.

	The "<code>expecco --diff</code>" option is also useful as a command line tool to get diff lists - even if your SCM system does not allow for such automatic hooks.		The "<code>expecco --diff</code>" option is also useful as a command line tool to get diff lists - even if your SCM system does not allow for such automatic hooks.

			=== Opening a Diff-Viewer when Checking in ===
			Your checkin script can also be written to first check if there are differences and then open a diff-viewer with the "<code>--vdiff</code>" command line option. The diff-viewer is the same as opened via the "Compare against Version in File" menu command found in expecco.

	== Scripting ==		== Scripting ==

Cg: /* Integration into a SOA Infrastructure */

2021-11-19T08:03:32Z

Integration into a SOA Infrastructure

← Nächstältere Version		Version vom 19. November 2021, 08:03 Uhr
Zeile 520:		Zeile 520:
	In this mode, expecco awaits for execution commands via SOAP or REST, executes tests in the background and returns status information (progress) and results (reports).		In this mode, expecco awaits for execution commands via SOAP or REST, executes tests in the background and returns status information (progress) and results (reports).

	Because tests may execute for a long time (hours or even days), the execution is performed asynchronously: first, the test ~~has~~ ~~to be~~ downloaded to the slave, then execution started. The start-command returns a ticket, which is a test-run-identifier, by which the execution progress can be queried (polled) while the test is running. Finally, a "finished" status is returned, upon which the result can be acquired via another service call.		Because tests may execute for a long time (hours or even days), the execution is performed asynchronously: first, the test is automatically downloaded to the slave, then the execution started. The start-command returns a ticket, which is a test-run-identifier, by which the execution progress can be queried (polled) while the test is running. Finally, a "finished" status is returned, upon which the result can be acquired via another service call.

	Multiple such test slaves can be started on multiple machines, and each test slave may (if required) execute multiple tests in parallel (although this is usually limited to one, to avoid conflicts when external resources are accessed).		Multiple such test slaves can be started on multiple machines, and each test slave may (if required) execute multiple tests in parallel (although this is usually limited to one, to avoid conflicts when external resources are accessed).

Cg: /* Integration with expecco ALM */

2021-11-19T08:01:42Z

Integration with expecco ALM

← Nächstältere Version		Version vom 19. November 2021, 08:01 Uhr
Zeile 509:		Zeile 509:
	# (optionally) define the devices available and attached to the execution slave machine in expecco ALM		# (optionally) define the devices available and attached to the execution slave machine in expecco ALM

	You can also install expecco slaves inside docker images an run them in the local network or in ~~the~~ cloud. However, if your suite needs access to special hardware, you will need a bridge (and communication tunnel) which provides access to it.		You can also install expecco slaves inside docker images and run them in the local network or in a cloud. However, if your suite needs access to special hardware, you will need a bridge (and communication tunnel) which provides access to it.

	Expecco ALM will ask the expecco slaves about their operating system environment. So jobs will be automatically executed on matching CPU/OS machines. However, if tests require special resources (devices) to be attached, these must be defined and listed in expecco ALM as well. If your test has corresponding resource-requirements defined (see resources/inventory), expecco ALM will both ensure that the test will execute on the correct machine, and also reserve the resource during the execution. ~~Also, test scheduling, if defined to be automatic, will be optimized to minimize resource usage, and to ensure that a higher number of tests can be executed in parallel.~~		Expecco ALM will ask the expecco slaves about their operating system environment. So jobs will be automatically executed on matching CPU/OS machines. However, if tests require special resources (devices) to be attached, these must be defined and listed in expecco ALM as well. If your test has corresponding resource-requirements defined (see resources/inventory), expecco ALM will both ensure that the test will execute on the correct machine, and also reserve the resource during the execution.

			Also, test scheduling, if defined to be automatic, will be optimized to minimize resource usage, and to ensure that a higher number of tests can be executed in parallel.

	=== Integration into a SOA Infrastructure ===		=== Integration into a SOA Infrastructure ===

Cg: /* Integration with Jenkins */

2021-11-19T07:59:03Z

Integration with Jenkins

← Nächstältere Version		Version vom 19. November 2021, 07:59 Uhr
Zeile 497:		Zeile 497:
	# Check the "Publish Test Attachments" flag, so the results will be presented in the Jenkins management console		# Check the "Publish Test Attachments" flag, so the results will be presented in the Jenkins management console

	That's it! Because expecco has been told to generate JUnit compatible report files, we can use Jenkins' existing JUnit support. However, the JUnit XML format does not support the full range of information which is present in the native expecco result files (especially the activity log and pin value information is not included). ~~Therefore, it is a good idea to also generate a regular "<code>.elf</code>" (expecco log file) and add it to the archived build artefacts.~~		That's it! Because expecco has been told to generate JUnit compatible report files, we can use Jenkins' existing JUnit support. However, the JUnit XML format does not support the full range of information which is present in the native expecco result files (especially the activity log and pin value information is not included).

			Therefore, it is a good idea to also generate a regular "<code>.elf</code>" (expecco log file) with an additional "<code>--elfReportFile</code>" argument and add the generated file it to the archived build artefacts.
⚫	Notes:<br>1) however, headless browsers, mobile devices and remote apps may still be tested in this mode.

		⚫	Notes:<br>1)<br>however, headless browsers, mobile devices and remote apps may still be tested in this mode.

	=== Integration with expecco ALM ===		=== Integration with expecco ALM ===

Cg: /* Integration with Jenkins */

2021-11-19T07:56:57Z

Integration with Jenkins

← Nächstältere Version		Version vom 19. November 2021, 07:56 Uhr
Zeile 445:		Zeile 445:
	As prerequirement please read: https://wiki.jenkins.io/display/JENKINS/Installing+Jenkins+as+a+Windows+service		As prerequirement please read: https://wiki.jenkins.io/display/JENKINS/Installing+Jenkins+as+a+Windows+service

	In any case expecco has to be started by the jenkins slave. To ensure expecco gets a license, start expecco manually with the same user account as you use for the jenkins slave. expecco will showup the license dialog and you can configure the license to be used. The license configuration will be stored for this user account. As long as the jenkins slave runs under the same user account, expecco gets the same license. If it is not possible to start expecco manually under the same user account as used for the jenkins slave, you can configure the license via command line ~~parameter~~:		In any case expecco has to be started by the jenkins slave. To ensure expecco gets a license, start expecco manually with the same user account as you use for the jenkins slave. expecco will showup the license dialog and you can configure the license to be used. The license configuration will be stored for this user account. As long as the jenkins slave runs under the same user account, expecco gets the same license. If it is not possible to start expecco manually under the same user account as used for the jenkins slave, you can configure the license via command line parameters:
	--licenseFile <fileName> ............... use this license file		--licenseFile <fileName> ............... use this license file
	--licenseServerHost <hostname> ......... use this license server ~~(for e.g. https://foo.bar.de:8081)~~		--licenseServerHost <hostname> ......... use this license server
			(for e.g. https://foo.bar.de:8081)
	--licenseServerPort <portNr> ........... use this license server port		--licenseServerPort <portNr> ........... use this license server port
	--licenseServerProxyHost <hostname> .... use this proxy host to contact license server ~~(for e.g. https://foo.bar.de:8081)~~		--licenseServerProxyHost <hostname> .... use this proxy host to contact license server
			(for e.g. https://foo.bar.de:8081)
	--licenseServerProxyPort <portNr> ...... use this proxy port to contact license server		--licenseServerProxyPort <portNr> ...... use this proxy port to contact license server
	--licenseServerTemplateFile <fileName> . use this template file to define the pro\|runtime and the plugin licences		--licenseServerTemplateFile <fileName> . use this template file to define the pro\|runtime and the plugin licences
	see https://doc.expecco.de/wiki2.x/Installation#expecco_Einstellungen_vordefinieren		see https://doc.expecco.de/wiki2.x/Installation#expecco_Einstellungen_vordefinieren
	use "expeccoLicenseServerLicense" file as template		use the "expeccoLicenseServerLicense" file as template

	Keep in mind: in case you use a local license "--licenseFile" you have to attach the corresponding dongle to the computer.		Keep in mind: in case you use a local license ("<code>--licenseFile</code>") you have to attach the corresponding dongle to the computer.

	There are (at least) 3 different ways to startup a jenkins slave:		There are (at least) 3 different ways to startup a jenkins slave:
Zeile 478:		Zeile 480:
	# Define the "Build Procedure" as "Execute Shell Script" (Unix/Linux) or "Execute Batch Job" (Windows)		# Define the "Build Procedure" as "Execute Shell Script" (Unix/Linux) or "Execute Batch Job" (Windows)
	# Enter a build procedure similar to the ours, which is:		# Enter a build procedure similar to the ours, which is:
	#::<code>~~cd exept\expecco\application~~		#::<code>
			#::cd exept\expecco\application
	#::del *.junit		#::del *.junit
	#::expecco.com --noBanner --exitOnInternalError --noTray \		#::expecco.com --noBanner --exitOnInternalError --noTray \
Zeile 485:		Zeile 488:
	#::expecco.com --noBanner --noTray \		#::expecco.com --noBanner --noTray \
	#::::--jUnitReportFile CommunicationWithExpeccoNETResult.junit \		#::::--jUnitReportFile CommunicationWithExpeccoNETResult.junit \
	#::::--execute ..\projects\expecco\CommunicationWithExpeccoNET.ets~~</code>~~		#::::--execute ..\projects\expecco\CommunicationWithExpeccoNET.ets
			#::</code>
	#:The details (especially paths and names) will of cause be different in your setup. The above uses the relative paths as it first changes the current directory to where the previous build has compiled the executable, which will of course not be the case in your setup.		#:The details (especially paths and names) will of cause be different in your setup. The above uses the relative paths as it first changes the current directory to where the previous build has compiled the executable, which will of course not be the case in your setup.
	#: You may add a "--silent" option to suppress warnings due to missing (or incompatible) plugins		#: You may add a "--silent" option to suppress warnings due to missing (or incompatible) plugins