WIXLIB

ContinuousIntegration withTIA Portal:Test RunnerTIA Portal / Continuous /ww/en/view/109801203SiemensIndustryOnlineSupport

Legal informationLegal informationUse of application examplesApplication examples illustrate the solution of automation tasks through an interaction of severalcomponents in the form of text, graphics and/or software modules. The application examples area free service by Siemens AG and/or a subsidiary of Siemens AG ("Siemens"). They arenon-binding and make no claim to completeness or functionality regarding configuration andequipment. The application examples merely offer help with typical tasks; they do not constitutecustomer-specific solutions. You yourself are responsible for the proper and safe operation of theproducts in accordance with applicable regulations and must also check the function of therespective application example and customize it for your system.Siemens grants you the non-exclusive, non-sublicensable and non-transferable right to have theapplication examples used by technically trained personnel. Any change to the applicationexamples is your responsibility. Sharing the application examples with third parties or copying theapplication examples or excerpts thereof is permitted only in combination with your own products.The application examples are not required to undergo the customary tests and quality inspectionsof a chargeable product; they may have functional and performance defects as well as errors. It isyour responsibility to use them in such a manner that any malfunctions that may occur do notresult in property damage or injury to persons. Siemens AG 2021 All rights reservedDisclaimer of liabilitySiemens shall not assume any liability, for any legal reason whatsoever, including, withoutlimitation, liability for the usability, availability, completeness and freedom from defects of theapplication examples as well as for related information, configuration and performance data andany damage caused thereby. This shall not apply in cases of mandatory liability, for exampleunder the German Product Liability Act, or in cases of intent, gross negligence, or culpable loss oflife, bodily injury or damage to health, non-compliance with a guarantee, fraudulentnon-disclosure of a defect, or culpable breach of material contractual obligations. Claims fordamages arising from a breach of material contractual obligations shall however be limited to theforeseeable damage typical of the type of agreement, unless liability arises from intent or grossnegligence or is based on loss of life, bodily injury or damage to health. The foregoing provisionsdo not imply any change in the burden of proof to your detriment. You shall indemnify Siemensagainst existing or future claims of third parties in this connection except where Siemens ismandatorily liable.By using the application examples you acknowledge that Siemens cannot be held liable for anydamage beyond the liability provisions described.Other informationSiemens reserves the right to make changes to the application examples at any time withoutnotice. In case of discrepancies between the suggestions in the application examples and otherSiemens publications such as catalogs, the content of the other documentation shall haveprecedence.The Siemens terms of use (https://support.industry.siemens.com) shall also apply.Security informationSiemens provides products and solutions with Industrial Security functions that support the secureoperation of plants, systems, machines and networks.In order to protect plants, systems, machines and networks against cyber threats, it is necessaryto implement – and continuously maintain – a holistic, state-of-the-art industrial security concept.Siemens’ products and solutions constitute one element of such a concept.Customers are responsible for preventing unauthorized access to their plants, systems, machinesand networks. Such systems, machines and components should only be connected to anenterprise network or the Internet if and to the extent such a connection is necessary and onlywhen appropriate security measures (e.g. firewalls and/or network segmentation) are in place.For additional information on industrial security measures that may be implemented, please emens’ products and solutions undergo continuous development to make them more secure.Siemens strongly recommends that product updates are applied as soon as they are availableand that the latest product versions are used. Use of product versions that are no longersupported, and failure to apply the latest updates may increase customer’s exposure to cyberthreats.To stay informed about product updates, subscribe to the Siemens Industrial Security RSS Feedat: ous Integration - Test RunnerArticle ID: 109801203, V1.0, 11/20212

Table of contentsTable of contentsLegal information . 212 Siemens AG 2021 All rights reserved3Introduction . 41.1Overview. 41.2Components used . 41.3Restrictions . 5Description . 62.1Areas of application . 62.22.2.12.2.22.2.3Principle of operation. 6Parameter overview . 6Parameter explanation . 7Example calls . 102.3Report . 11Appendix . 123.1Service and support . 123.2Industry Mall . 133.3Links and literature . 133.4Change documentation . 13Continuous Integration - Test RunnerArticle ID: 109801203, V1.0, 11/20213

1 Introduction1Introduction1.1OverviewLaunching Test Runner allows you to test program code with the TIA Portal TestSuite option. In the process, previously defined style guide rules and applicationtests are run automatically and a report of the results is written to a file.Test Runner uses the TIA Portal Test Suite option in conjunction with TIA Portalversion 17 or higher.1.2Components usedThe following hardware and software components were used to create thisapplication example:Table 1-1ComponentQuantity Siemens AG 2021 All rights reservedTIA Portal V17Step 7TIA Portal TestSuite optionItem numberNote16ES7822-1A.07-.Requires license16ES7823-1TE07-0AA5Requires licenseArticle ID for download:109793099This application example consists of the following components:Table 1-2ComponentFile nameNoteTest Runnerdocumentation109801203 Cont Int TestRunner DOC V10 en.pdfThisdocumentTest RunnerV1.3.1109801203 Cont Int TestRunner PROJ V10.zipDLLs,applicationBAT files forintegration109801203 Cont Int Setup PROJ V11.zipOptional: BATfiles forintegratingTest Runnerinto JenkinsSetupdocumentation109801203 Cont Int Setup DOC V11 en.pdfOptional: CIsystem setupJenkinsdocumentation109801203 Cont Int Jenkins DOC V11 en.pdfOptional:JenkinsReadme OSSReadMe OSS.htmlThird-partysoftwareinformationContinuous Integration - Test RunnerArticle ID: 109801203, V1.0, 11/20214

1 Introduction1.3RestrictionsTest Runner uses the TIA Portal Test Suite option and is mandatory if you wish touse the component. TIA Portal V17 or higher is a prerequisite for the component. Siemens AG 2021 All rights reservedUsing Test Runner, it is currently not possible to run application tests for which thescope is a PLC with activated F operation. This also means that Test Runnercannot test safety program code. Testing controllers with active F operation is onlypossible with the TIA Portal user interface.Continuous Integration - Test RunnerArticle ID: 109801203, V1.0, 11/20215

2 Description2Description2.1Areas of applicationTest Runner is used to verify and/or test program code with the style guide rulesand application tests previously defined in the project. The style guide rules andapplication tests are defined with the Test Suite option and run with Test Runnervia a command-line interface (CLI). This implementation can be accomplished inthe continuous integration context, or as a standalone application.2.2Principle of operationTest Runner is launched with the appropriate parameter and does not need to beconfigured separately.Test Runner is controlled with the Windows Command Prompt or as a batch script.You can launch it by right-clicking the application folder with the SHIFT key helddown, then selecting "Open Command Prompt here".2.2.1Parameter overviewTable 2-1: Parameter overview Siemens AG 2021 All rights reservedLong formShort --final-behavior CLOSE KEEP INSTANCE KEEP PROJECT -x CLOSE KEEP INSTANCE KEEP PROJECT ---project TiaProjectFilePath -p TiaProjectFilePath X--report FilePath -r FilePath X--format XML JUNIT JUNIT HUDSON -f XML JUNIT JUNIT HUDSON X--logfile FilePath -l FilePath ---test-application ListOfTestCasesSpacesSeparated all -a ListOfTestCasesSpacesSeparated all X--test-application-plc-scope PlcName -b PlcName --test-style ListOfRuleSetSpaceSeparated all -s ListOfRuleSetSpaceSeparated all X--test-style-plc-scope PlcName -t PlcName --In general, two spellings or formats are allowed for passing the arguments.For example, the following versions are possible for "report":--report FilePath oder --report FilePath Continuous Integration - Test RunnerArticle ID: 109801203, V1.0, 11/20216

2 Description2.2.2Parameter explanationParameter --helpThis outputs the console application's help text, which contains a short descriptionof the parameters from Table 2-1.Parameter --versionThis outputs the current version number of the console application.Parameter –-quiet or -qThis will suppress the log output in the console window. In this case, the log entrieswill only be written to the log file, to the extent this has been specified.Parameter --debug or -dThis will launch TIA Portal with user interface when the application is launched, inorder to facilitate debugging when running the tests.Parameter --final-behavior or -x Siemens AG 2021 All rights reservedThis defines what is to happen to the TIA Portal and project after testing. Thisserves to speed up the execution of the tests, since TIA Portal and the project mayno longer have to be opened separately and test execution is also faster. Thefollowing options are available: The project and the TIA Portal instance are closed (CLOSE). The project is closed, the TIA Portal instance is kept (KEEP INSTANCE). The project and the TIA Portal instance are kept (KEEP PROJECT).When the application is started, a search is made for an open TIA Portal instance.If an instance is found where the project to be tested is already open, this instanceis used. If an instance is found where no project is open yet, this instance is used,and the project is opened. Otherwise, a TIA Portal instance is created and theproject to be tested is opened in it.NOTESince Jenkins automatically closes the instances created by its processes at theend of a build, the TIA Portal instance must be manually opened in advance forreuse.Parameter --project or -pThis is used to specify the project that will be tested. The project must be a singleuser project.This parameter is mandatory.Example call:--project "D:\Projects\Library Master\Library Master.ap17"Continuous Integration - Test RunnerArticle ID: 109801203, V1.0, 11/20217