o Hardware Requirements o Software Requirements o Required Permissions Overview Tutorials Actions Asserts Assets Wizards Frequently Asked Questions

Transcription

1 LegiTest View LegiTest Live Dcumentatin LegiTest is a Visual Studi extensin that prvides a set f functinality tailred arund testing data. Using a simple graphical designer, unit tests that run n standard testing framewrks can be created thrugh cde generatin. LegiTest aims t take the pain ut f data testing by putting yu in tuch with the elements that matter mst t yu - databases, queries, SSIS packages, SSRS reprts etc. By generating the cde required t interact with these types f target, LegiTest reduces the investment required t bring yur data int yur testing lifecycle. Table f Cntents Setup Instructin Hardware Requirements Sftware Requirements Required Permissins Overview Tutrials Actins Asserts Assets Wizards Frequently Asked Questins Created with the Standard Editin f HelpNDc: News and infrmatin abut help authring tls and sftware

2 Setup Instructins Table f Cntents Hardware Requirements Sftware Requirements Required Permissins 1. After the installatin envirnment meets all Hardware and Sftware Requirements, pen the installer. 1. Users can install LegiTest in ne f tw ways: If yu are installing thrugh the Pragmatic Wrkbench installer, g t step 2 If yu are installing thrugh the Visual Studi Gallery, g t step 9 2. If yu d nt wish t send feature usage statistics, uncheck the bx "Send feature usage statistics t Pragmatic Wrks." 3. Make sure t read the License terms and cnditins befre checking "I agree t the License terms and cnditins". Once yu have agreed, click "Next". 4. Select the type f installatin yu wish t perfrm. 1. If yu select "Custm", g t Step If yu select "Typical", g t Step 6.

3 5. On the "Custm" installatin page, yu may select which features t install r leave ut. After making yur selectins, click "Install". Imprtant Nte: By expanding BI xpress yu may chse which versin(s) f Visual Studi ur add-in will be cmpatible with n yur machine. Yu may als chse t include DBA xpress, DOC xpress, LegiTest and the ptinal prerequisites fr DOC xpress and BI xpress' BI Cmpare.

4 6. The installatin prgress view will appear.

5 7. If yu chse "Typical" install in step 4 r pted t install the ptinal prerequisites*, yu will see the fllwing cmpnents request t be installed frm the Micrsft site: Micrsft System CLR Types fr Micrsft SQL Server 2012 x86 Micrsft SQL Server 2012 Shared Management Objects x86 Micrsft SQL Server 2012 Analysis Management Objects x86 Micrsft SQL Server 2012 Transact-SQL ScriptDm x86 Micrsft System CLR Types fr Micrsft SQL Server 2012 x64 Micrsft SQL Server 2012 Shared Management Objects x64 Micrsft SQL Server 2012 Analysis Management Objects x64 Micrsft SQL Server 2012 Transact-SQL ScriptDm x64 Imprtant Nte: These cmpnents are "Optinal Prerequisites" because Pragmatic Wrkbench will wrk withut them. Hwever, DOC xpress and BI Cmpare (a feature within BI xpress) d require them t be installed in rder t dcument and cmpare SSAS and SQL Server database bjects 8. After each cmpnent, the Wrkbench installer will cntinue. If any errr messages appear during the installatin f these cmpnents, please reference their errr message against Micrsft's supprt site fr reslutin.

6 9. If yu chse "Typical" install in step 4, pted t install LegiTest, r are installing LegiTest thrugh the Visual Studi Gallery, the Visual Studi Extensin installer will appear. This allws users t chse which versins f Visual Studi will cntain LegiTest. Once the installatin has cmpleted, the selected Visual Studi editins will be ready t create a new LegiTest prject. Created with the Standard Editin f HelpNDc: Easy EBk and dcumentatin generatr

7 Hardware Requirements The fllwing memry and prcessr requirements apply t all editins f LegiTest: Requirements Cmpnent Minimum Recmmended Memry 4 GB At least 8 GB Prcessr Speed 1.4 GHz 2.0 GHz r faster Prcessr Type Nt Applicable AMD Optern AMD Athln 64 Intel Xen with Intel EM64T supprt Intel Pentium IV with EM64T supprt Imprtant Nte Hardware requirements can vary based n wrklads and ther prcesses. Running LegiTest n a virtual machine will be slwer than running natively because f the verhead f virtualizatin Created with the Standard Editin f HelpNDc: Full-featured Help generatr

8 Sftware Requirements Befre installing Wrkbench, make sure yu meet the fllwing system requirements: SQL Server Integratin Services 2005, 2008, 2008 R2, 2012, 2014, 2016 BIDS 2005, 2008, 2008 R2 (Business Intelligence Develpment Studi) r SSDT 2010, 2012, 2014, 2016, 2017 (SQL Server Data Tls) Micrsft.NET 3.5 with Service Pack 1 Micrsft.NET 4.0 Micrsft.NET 4.5 (2017 Prviders nly) Micrsft SQL Server 2012 Transact-SQL ScriptDm x86 The fllwing perating systems are supprted by Wrkbench: 64-bit (x64) Operating Systems: Windws Server 2003 (at least Service Pack 2) * Windws Vista (at least Service Pack 2) Windws Server 2008 R2 Windws Server 2012 Windws Server 2016 Windws 7 Windws 8 Windws bit (x86) Operating Systems: Windws XP (at least Service Pack 3) * Windws Server 2003 (at least Service Pack 3) * Windws Vista (at least Service Pack 2) Windws Server 2008 R2 Windws Server 2012 Windws 7 Windws 8 Windws 10 Imprtant Nte Windws XP and Server 2003 have been deprecated frm full supprt. Any issues encuntered n either Windws XP r Server 2003 must be reprducible n newer versins f Windws t be eligible fr supprt. LegiTest extensin requires: An installatin f ne f the fllwing editins f Visual Studi: Visual Studi 2012 Pr r better Visual Studi 2013 Visual Studi 2013 Cmmunity Editin Visual Studi 2015 Visual Studi 2015 Cmmunity Editin Visual Studi 2017 NUnit Requirements NUnit is required t execute LegiTest NUnit tests utside f Visual Studi NUnit Test Adapter 2.0 is required fr LegiTest NUnit tests t be displayed within the Visual Studi Test Explrer The fllwing prerequisites are required t enable features within LegiTest:

9 SQL Server Assets Supprted Versins SQL Server 2008 R2 SQL Server 2012 SQL Server 2014 SQL Server 2016 SQL Server 2017 SSIS Actins and Assets Supprted Versins SSIS 2008 R2 SSIS 2012 SSIS 2014 SSIS 2016 SSIS 2017 Each versin f SQL Server Integratin Services (2008 R2 r abve) that the user wishes t test SQL Server Data Tls r Business Intelligence Develpment Studi Micrsft.NET 4.5 (Required by SSIS 2017 Only) Nte: The versin f SQL Server Data Tls that prvides the Integratin Services designed within Visual Studi must be installed. This is a separate dwnlad t the versin f SQL Server Data Tls that prvides.sqlprj supprt that ships with Visual Studi. SSAS Actins Supprted Versins Multidimensinal SSAS 2008 R2 SSAS 2012 SSAS 2014 SSAS 2016 SSAS 2017 Tabular SSAS 2012 SSAS 2014 SSAS 2016 SSAS 2017 Micrsft.NET 4.5 (Required by SSAS 2017 Only) SSRS Actins Supprted Versins SSRS 2008 R2 SSRS 2012 SSRS 2014 SSRS 2016 SSRS 2017 System Requirements fr ther Wrkbench prducts: The fllwing prerequisites are required t enable features within BI xpress and DOC xpress: 64-bit Operating Systems: Micrsft System CLR Types fr Micrsft SQL Server 2012 x64 Micrsft SQL Server 2012 Shared Management Objects x64 Micrsft SQL Server 2012 Analysis Management Objects x64 Micrsft SQL Server 2012 Transact-SQL ScriptDm x64 Micrsft System CLR Types fr Micrsft SQL Server 2012 x86 Micrsft SQL Server 2012 Shared Management Objects x86

10 Micrsft SQL Server 2012 Analysis Management Objects x86 Micrsft SQL Server 2012 Transact-SQL ScriptDm x86 32-bit Operating Systems: Micrsft System CLR Types fr Micrsft SQL Server 2012 x86 Micrsft SQL Server 2012 Shared Management Objects x86 Micrsft SQL Server 2012 Analysis Management Objects x86 Micrsft SQL Server 2012 Transact-SQL ScriptDm x86 Prviders: Hive: 64-bit Operating Systems: 64-bit HrtnWrks Hive ODBC Driver 32-bit HrtnWrks Hive ODBC Driver 32-bit Operating Systems: 32-bit HrtnWrks Hive ODBC Driver Oracle: 64-bit Operating Systems: 64-bit Oracle Data Access Cmpnents (ODAC) 12c 64-bit Oracle 12c Managed Data Access Client installed int the GAC 32-bit Oracle Data Access Cmpnents (ODAC) with Oracle Develper Tls fr Visual Studi 12c 32-bit Oracle 12c Managed Data Access Client installed int the GAC 32-bit Operating Systems: 32-bit Oracle Data Access Cmpnents (ODAC) with Oracle Develper Tls fr Visual Studi 12c 32-bit Oracle 12c Managed Data Access Client installed int the GAC SQL: 64-bit Operating Systems: Micrsft SQL Server 2012 Shared Management Objects x64 Micrsft SQL Server 2012 Shared Management Objects x86 32-bit Operating Systems: Micrsft SQL Server 2012 Shared Management Objects x86 SSAS: Micrsft.NET 4.5 (Required by SSAS 2017 Only) 64-bit Operating Systems: Micrsft SQL Server 2012 Analysis Management Objects x64 Micrsft SQL Server 2012 Analysis Management Objects x86 32-bit Operating Systems: Micrsft SQL Server 2012 Analysis Management Objects x86 SSAS Azure Analysis Services: Micrsft Azure Analysis Services Client Libraries SSIS: Micrsft.NET 4.5 (Required by SSIS 2017 Only) Each versin f SQL Server Integratin Services (2005 r abve) that the user wishes t dcument. SQL Server Data Tls r Business Intelligence Develpment Studi. Any Third-Party Prducts (Cnnectin Managers, Tasks, Cmpnents, et cetera) that are used within the SSIS Package(s) SSRS: Each versin f SQL Server Reprting Services (2005 r abve) that the user wishes

11 t dcument. SQL Server Data Tls r Business Intelligence Develpment Studi. Supprt prvided fr the fllwing reprt lcatins: File System: SQL Server 2005 and abve Native Web Services: SQL Server 2008 R2 and abve SharePint Web Service: SQL Server 2008 R2 and abve Infrmatica PwerCenter: If cnnecting t a SQL Repsitry: 64-bit Operating Systems: Micrsft SQL Server 2012 Shared Management Objects x64 Micrsft SQL Server 2012 Shared Management Objects x86 32-bit Operating Systems: Micrsft SQL Server 2012 Shared Management Objects x86 If cnnecting t an Oracle Repsitry: 64-bit Operating Systems: 64-bit Oracle Data Access Cmpnents (ODAC) 12c 64-bit Oracle 12c Managed Data Access Client installed int the GAC 32-bit Oracle Data Access Cmpnents (ODAC) with Oracle Develper Tls fr Visual Studi 12c 32-bit Oracle 12c Managed Data Access Client installed int the GAC 32-bit Operating Systems: 32-bit Oracle Data Access Cmpnents (ODAC) with Oracle Develper Tls fr Visual Studi 12c 32-bit Oracle 12c Managed Data Access Client installed int the GAC The fllwing prerequisites are required t enable sme features within BI xpress: BI xpress extensin fr Visual Studi 2015 requires: An installatin f ne f the fllwing editins f Visual Studi: Visual Studi 2015 Cmmunity Editin Visual Studi 2015 Prfessinal Visual Studi 2015 Enterprise The fllwing extensin installed within their Visual Studi 2015 envirnment: SQL Server Data Tls fr SQL Server 2016 (nw includes BI Prjects) Plug-ins: Auditing Framewrk, BI Cmpare, Package Builder Wizard, and/r SSIS Unit Test: Any Third-Party Prducts (Cnnectin Managers, Tasks, Cmpnents, et cetera) that are used within the SSIS Package(s) Reprt Mver Reprting Deplyment is cmpatible with SQL 2008 R2 r later Reprt Mnitring Cnsle: Reprting Perfrmance Mnitr is cmpatible with SQL Server 2008 r later The fllwing prerequisites are required t enable sme features within DOC xpress: SQL 2008 r higher is required t create a DOC xpress metabase. Hwever, if cnnected t a valid DOC xpress metabase, SQL 2005 and up may be dcumented, thugh there are sme limitatins t SSRS 2005 and 2008 dcumentatin. Dcumentatin CHM HTML Help Wrkshp and Dcumentatin

12 Created with the Standard Editin f HelpNDc: Easily create HTML Help dcuments

13 Required Permissins Many f the features within Wrkbench nly need db_wner when issuing database updates. This ccurs when upgrading frm an lder versin f Wrkbench t a newer versin. Outside f database updates, thse users nly need db_datareader and db_datawriter permissins. Belw is a cmprehensive list f each feature and their required permissins. BI xpress Required Permissins Best Practice Analyzer: BI xpress database: Regular Usage: db_datareader db_datawriter Database updates: db_wner Technlgy specific permissins: Hive Read permissins fr the HDFS files that yu wish t dcument Infrmatica View definitin permissins n the Infrmatica repsitry Read permissins within the Infrmatica repsitry n any flder and bject yu wish t dcument SQL Server Definitin permissins fr any bject yu wish t dcument SQL Server Integratin Services SSIS Catalg: Read and Mdify permissin fr each prject within the SSISDB the user wishes t analyze SQL Server 2008 R2 (r higher) Reprting Services Flder Security Settings: Minimum Predefined User Rles required: My Reprts Cntent Manager Minimum Tasks required fr a custm User Rle: View Reprts View Flders View Data Surces View Mdels Cnsume Reprts Web Service Security Settings: Minimum Predefined System Rle required: System User Minimum Tasks required fr a custm System Rle: Execute Reprt Definitins Oracle Permissins Cnnect permissins n any schema that yu wish t dcument Tableau Permissins User must be a part f the Server Administratr rle Data Generatin: Each table yu wish t generate data within db_datareader db_datawriter

14 Deplyment Wizard (2005 and 2008): Permissin t deply t the SQL Server SSIS Unit Test: Permissin t execute the packages yu are testing (at their lcatin, ex. file system, SQL server etc...) SSRS Mnitring Cnsle: SSRS ReprtServer database(s): db_datareader Mnitring Cnsle: BI xpress database: Regular Usage: db_datareader db_datawriter Database updates: db_wner Other Features: Fr ther features yu will need permissin t access and btain the packages at their lcatin. Required Permissins fr ther Wrkbench prducts: DBA xpress Required Permissins Data Inspectr, Data Space Analyzer, Data Surf, Object Brwser, Schema Surf Each bject being manipulated: db_datareader db_datawriter Schema Inspectr, Schema Inspectr Snapsht Tl Each bject being manipulated: db_wner DOC xpress Required Permissins DOC xpress database: Regular Usage: db_datareader db_datawriter Database updates: db_wner Technlgy specific permissins: Hive Read permissins fr the HDFS files that yu wish t dcument Infrmatica View definitin permissins n the Infrmatica repsitry Read permissins within the Infrmatica repsitry n any flder and bject yu wish t dcument SQL Server Definitin permissins fr any bject yu wish t dcument SQL Server Analysis Services

15 Multidimensinal: Read definitin permissin n each database bject yu wish t dcument Tabular: Administratr permissin n each database bject yu wish t dcument SQL Server Integratin Services SSIS Catalg: Read and Mdify permissin fr each prject within the SSISDB the user wishes t analyze SQL Server 2008 R2 (r higher) Reprting Services Flder Security Settings: Minimum Predefined User Rles required: My Reprts Cntent Manager Minimum Tasks required fr a custm User Rle: View Reprts View Flders View Data Surces View Mdels Cnsume Reprts Web Service Security Settings: Minimum Predefined System Rle required: System User Minimum Tasks required fr a custm System Rle: Execute Reprt Definitins Oracle Permissins Cnnect permissins n any schema that yu wish t dcument Tableau Permissins User must be a part f the Server Administratr rle Created with the Standard Editin f HelpNDc: Generate Kindle ebks with ease

16 Overview Overview Table f Cntents Chsing a Test Framewrk Creating a New Test Prject Prject Organizatin Understanding Generated Output Design Area Test Flw Assets, Actins, Asserts and Resurces Data Driven Testing Filtering Integrating with LegiTest Server r LegiTest Online Created with the Standard Editin f HelpNDc: Create iphne web-based dcumentatin

17 Chsing a Test Framewrk Chsing a Test Framewrk LegiTest is, at its cre, a cde generatin tl. The tests, grups and assets that yu cnfigure becme cde in the frm f unit tests. There are multiple test framewrks available, each with their wn benefits and drawbacks. LegiTest currently supprts NUnit 2, NUnit 3 and MSTest. Pragmatic Wrks recmmends NUnit as a better chice in mst scenaris. Sme f the specific benefits include: Mre pwerful mdel fr supprting Data Driven Testing While Data Driven Testing is supprted bth in NUnit and MSTest - the way it wrks in MSTest means that yur data driven query can be executed at unexpected times because f limitatin in the framewrk. Mre pwerful assert mdel Assertins are a key aspect f testing. They are the part f the test where the cde verifies that the result f the test (the actual result) matches the desired result (the expected result). NUnit has a lt mre flexibility in this area - meaning the generated cde is simpler and it is easier t write yur wn assertins shuld yu wish t d s. Brader cmpatibility NUnit tests perate in a way that means that there are less prblems with executin f tests. Testing SSIS packages is ne key area where NUnit is superir - packages laded at the grup level have issues under MSTest - while n similar prblems ccur using NUnit. Nte that bth versins f NUnit carry these benefits, and the chice between NUnit 2 and NUnit 3 is available t fit in with yur rganizatin's existing usage. If n prir usage exists, Pragmatic Wrks recmmends using NUnit 3. Created with the Standard Editin f HelpNDc: Benefits f a Help Authring Tl

18 Creating a New Test Prject Creating a New Test Prject Within Visual Studi, click File > New > Prject... t launch the New Prject windw In the New Prject Windw, expand the Installed Templates tree and select Visual C# Scrll dwn and select the either the LegiTest Prject MSTest, NUnit r NUnit3 Test template. Fr help understanding the differences, see the 'Chsing a Test Framewrk' tpic. Imprtant Nte NUnit tests are shwn in the Visual Studi Text Explrer windw because the NUnit prject type includes a reference t the 'NUnitTestAdapter' MuGet package. This allws the Visual Studi test framewrk t discver and run NUnit tests. When switching a prject frm MSTest t NUnit, be sure t add a reference t the NUnitTestAdapter NuGet package. Further instructins n ding that can be fund here. 4. Prvide a meaningful name fr the LegiTest Prject and then click OK. Helpful Tip It is advisable t end the prject name in 'Tests', as a lt f cntinuus integratin systems will, by default, run tests in assemblies with the wrd Tests in them. Created with the Standard Editin f HelpNDc: Free help authring envirnment

19 Prject Organizatin Prject Organizatin LegiTest prjects are basically C# prjects and are rganized very similarly. There are a few different types f file that can be added and are handled specially within LegiTest prjects: LegiTest grup (.legitestgrup) These files define a single LegiTest grup. LegiTest, in previus releases, used suite files (.legitest) which cntained many grups. T allw a better rganizatin f prjects the grup files were added. This has particular benefits fr any teams using surce cntrl. With grups in individual files it becmes much less likely that a cmplicated merge is required when mre than ne persn is wrking n a prject. A grup file will emit a single C# class that cntains the tests that are defined. LegiTest settings file (.legitestsettings) Settings files cme in tw types - settings and prject settings. Settings files cntain parameters and their values - and there can be mre than ne if desired. Fr mre infrmatin n settings files see the help tpic here. A prject can nly cntain ne prject settings file - and the prject settings file defines bth the server that the prject is assciated with and the test framewrk type. Asset file (.asset) Asset files are used t define assets that are generally useful acrss multiple grups / suites. They are the same as assets defined within suites / grups / tests but defined at the prject level. This gives the benefit that they are easier t change in islatin (i.e. changing ne asset desn't mean that the suite / grup file has t be check in t surce cntrl) and they give us a better way t rganize the data within ur prjects. Mre infrmatin n assets can be fund here and here. Helpful Tip Flders in the slutin can be used t grup all types f item tgether. A large testing prject with many grups, assets and settings can becme hard t manage unless it is well rganized. Created with the Standard Editin f HelpNDc: Create crss-platfrm Qt Help files

20 Understanding Generated Output Understanding Generated Output The generated utput frm LegiTest is C# cde, alng with sme additinal files. These files are used as the input t the C# cmpiler which generates an assembly which cntains unit tests. This assembly can then be executed within Visual Studi, LegiTest Server r a third party prduct that supprts standard.net unit tests. This tpic aims t clarify the prcess f mving frm a design time test grup t a run time assembly. The prcess fllws the diagram belw. When a test suite r grup is saved then cde is generated. This cde is then cmpiled by the C# cmpiler int a test assembly. When this assembly is run the tests execute and results fr the tests are available. When running within Visual Studi, the test results appear within the Test Explrer windw. Yu can als publish results t LegiTest Server r LegiTest Online - fr mre infrmatin abut that integratin, please refer t the tpic here. Generated utput Lking at the utput generated by a test grup called 'TestGrup' - we might see the fllwing in slutin explrer: There are tw main flders, the *_Assets and *_Output flder.

21 Imprtant Nte The *_Assets and *_Output flders are used t stre test infrastructure files and are nt intended t cntain additinal files. Any nn-legitest generated files will be remved upn regeneratin f the LegiTest suite(s) r grup(s). *_Assets Flder The _Assets flder cntains the cntent fr yur assets at design time. S, fr example, if we have a Delimited Cntent asset, then the cntent file cntains the data makes up the delimited cntent. Mst assets are made up f tw types f data - there is the metadata (such as a list f utput clumns and settings) and the data itself. The metadata is usually small, while the data itself can be large. The metadata is stred within the grup file - s that when yu first pen a LegiTest grup the asset type can be displayed. The data itself is stred in a separate file s that large amunts f data dn't need t be laded as sn as yu pen the file. Fr mre infrmatin n the assets available, refer t the 'Assets' sectin. *_Output Flder The _Output flder cntains the cde that is generated frm yur grup file, alng with sme ther files. Lking at each ne: Resurces.resx This file cntains the same cntent as the _Assets flder - but encded in a way that the C# cmpiler can understand. This way, the asset cntent becmes part f the cmpiled assembly and is available t the tests when they are run. TestGrup.cs This file is the 'user' file. It is usually blank - but cde can be added here that integrated with the generated cde. Yu can create methds that are called by the generated test cde t perfrm any actin that yu want. Fr mre infrmatin n adding cde t the user tpic, see the tpic in the FAQ sectin. TestGrup.Generated.cs This is the main utput file. It is where the cde that frms the bulk f the tests is stred. Each test, actin and assertin will have a methd defined within this file. Imprtant Nte The generated files are re-created every time yu save a LegiTest suite r grup. Any changes made directly t the.generated.cs file will be lst. TestGrup.legiTestSettings This file cntains the details f any parameters defined. This file is fund by the tests at runtime and used in rder t cntrl any parameterized elements. Fr mre infrmatin n using parameters within tests, refer t the 'Using Parameters' sectin. Created with the Standard Editin f HelpNDc: Free Qt Help dcumentatin generatr

22 Design Area Design Area The design area is where the user will add their test elements. The area is divided int the different test flw steps and will change depending if there is a single test r a test grup selected. As mentined in the test flw, elements are executed frm left t right, then tp t bttm. These elements can be rearranged nce placed by dragging and drpping. The elements can be placed n the design area by dragging and drpping frm the tlbx, duble clicking an item in the tlbx, r right clicking the design area and use the quick add menu. T pen the tlbx, n the visual Studi tlbar, click View > Other Windws > LegiTest Tlbx. Once an item is placed, an icn may appear n the tp right f the element's bx. Hvering ver this will give the user infrmatin n any errrs this element has. Once the tests have been set up, saving the prject will autmatically generate the test cde. Once the prject has been built, the test will be discverable in the test explrer windw f Visual Studi. Fr mre infrmatin n the flw frm design t executin, see the sectin n understanding the utput. A simple cmparisn test might lk like the fllwing: Lking at the tree ndes n the left - these are cvered in mre detail in the fllwing sectins: Parameters Server Integratin

23 System Cverage Reprts Anntatin Types Under that we have the nde fr the test grup, anntatins fr the grup, the test itself, anntatins fr the test and the data driven cnfiguratin fr the test. Nte that the test and grup ndes have a warning icn next t them - this is because sme elements require attentin. Yu can see a brief descriptin f the errrs by hvering ver the warning icn, r yu can view the errrs in mre detail by duble-clicking n the icn. This brings up the errr inspectr: Duble clicking n the icn f an element will bring up it's editr and duble-clicking n the text will start editing the name f the element. The element editr is a dckable windw within Visual Studi, s yu may find it cnvenient t dck it int a psitin where it is permanently visible.

24 Sme elements have custm editrs which present a mre cnvenient user interface fr cnfiguring the element in questin. Created with the Standard Editin f HelpNDc: Qt Help dcumentatin made easy

25 Test Flw Test Flw A LegiTest Prject rganizes all test elements int fur scpes: Prject - a test prject can cntain assets and test grups Suites - nw deprecated, suites can cntain assets and multiple grups Grups - grups can cntain assets, multiple tests and manage the Grup and Test Level Initializatin as well as the the Grup and Test Level Teardwn steps. Tests - can cntain assets and manage the Test Initializatin Steps, Executin Tracks, Assertins and Test Teardwn Steps. Imprtant Nte LegiTest nw supprts grup files being added directly within slutin explrer. While existing suites are still supprted, individual LegiTest grups ffer greater flexibility in use and are the preferred methd f building tests. Grup Executin Flw Grup Initializatin Steps The Grup Initializatin executes nly nce at the beginning the entire test grup. This step is the first t run befre any tests are actually executed. This step is the first t run befre any tests within the grup are actually executed. Each grup has its wn Grup Initializatin Step. This step cnfigures everything needed t prepare the test envirnment fr the grup executin. Grup Level Test Initializatin Steps

26 This steps executes nce at the beginning f every test in the grup. It will run right befre the actual test begins executing. Each grup has its wn Grup Level Test Initializatin step. This step cnfigures everything needed t prepare the test envirnment befre each test executin. Test Initializatin Steps This step executes nce at the beginning f single test. Each test cntains its wn Test Initializatin step. This step cnfigures unique elements needed t prepare this test fr executin. Executins Tracks Executin Tracks cntain the actual elements that cmpse the test. Each test can hld any number f tracks. By default, the test will execute as many tracks as the test envirnment can handle. If they wish, users can mdified this behavir t nly run a set number f tracks at the same time. Assertins Assertins cntain test validatin that cnfirms whether a test has passed r failed. Assertins are run immediately after all executin track fr the current test has cmpleted. Assertins cmpares expected data t actual data generated during the executin tracks. The results f these data cmparisns will dictate whether the test passes r fails. Test Teardwn Steps This step executes nce at the end f single test. Each test cntains its wn Test Teardwn step. This step cnfigures unique elements needed t clean the test envirnment after test executin. Grup Level Test Teardwn Steps This steps executes nce at the end f every test in the grup. It will run right after the actual test finishes executing. Each grup has its wn Grup Level Test Teardwn step. This step cnfigures everything needed t clean the test envirnment after each test cmpletes. Grup Teardwn Steps The Grup Teardwn executes nly nce at the end f the entire test grup. This step is the last t run after all tests in the test grup have executed. Each grup has its wn Grup Teardwn. This step cnfigures everything needed t clean the test envirnment nce grup executin cmpletes. Created with the Standard Editin f HelpNDc: Write EPub bks fr the ipad

27 Assets, Actins, Asserts and Resurces Assets, Actins, Asserts and Resurces Fur key cncepts in LegiTest are Assets, Actins, Asserts and Resurces. Assets Assets are items that are created at design time and used at runtime. S, fr example, yu might have a query r a reference t an SSIS package. These items are cnfigured when yu are creating tests and used when the tests run. There are many different types f asset available in LegiTest and yu can read abut thse in the Assets sectin. Assets can als use parameters - s yu may want t cnfigure a cnnectin string using the parameter system. Nte that parameters are evaluated at the pint that the asset is used. Assets can either be part f a test suite / grup r part f the test prject itself. T add an asset t the prject, right click n the prject nde in slutin explrer and click Add -> LegiTest Asset... Prject-level assets can be placed in subflders f the prject t aid in rganizatin, but this desn't affect their use. Assets at the prject level are available t all test suites / grups, irrespective f what flder they are placed in. Assets that are defined within a test suite / grup can nly be used within that suite / grup. Additinally, assets defined at the test level may nly be used by that test. Actins Actins prduce sme kind f utcme. Fr example they may execute a query t return a rw cunt, prcess a cube, r execute a package. When an actin returns infrmatin, such as a rw cunt r data set (aka a grid), it is stred in a resurce. Actins will ften use assets r resurces as part f their input (fr example, an actin t lad a grid will use a cnnectin asset and a query asset - an actin t filter a previusly laded grid will use the resurce). Actins can be placed in any f the executin areas except fr the assert sectin - s they can be used fr set-up and teardwn at bth the grup and test level. Fr the list f available actins, please see the Actins tpic. Asserts Asserts are used t test the results f actins. Fr example, we might use an integer assert t cmpare the result f a query actin which returns a rw cunt with sme predetermined value. Asserts will cmpare the values in resurce keys t each ther, r t a static value entered int the Assert. A test which desn't cntain any asserts will always yield an 'Incnclusive' result - s it is imprtant t make sure that all yur tests actually include an assert t determine whether the test passed r failed. Asserts can nly be placed in the assert sectin f a test. Fr the list f available assertins, please see the Asserts tpic. Resurces Resurces are items that are available nly at runtime. S, fr example, when yu execute a query yu may get a result back which yu wish t cmpare. Resurces are referred t by their 'resurce key' which is a string that uniquely identifies that resurce. Resurces are usually laded by actins (the exceptin being data driven testing) and can be referenced by ther actins r assertins. Yu can view dependent elements fr any element - which shws the elements that fllw and use the resurce(s) generated. When data driven testing is being used - additinal resurces are available - ne fr each clumn f data used as the data surce. Fr mre infrmatin n this, please see the data driven testing sectin.

28 Resurces can als be used in place f parameters by elements that fllw them. S, fr example, an execute scalar query might get back a resurce called 'CutOffDate' - a query might then fllw where the query is defined similarly t: SELECT OrderId FROM Orders WHERE OrderDate > '{{CutOffDate}}' Because parameters are evaluated when an asset is used, the resurce 'CutOffDate' wuld be included in the query and used as a filter. Created with the Standard Editin f HelpNDc: Easily create EPub bks

29 Data Driven Testing Data Driven Testing Data driven testing allws us t repeat the same test many times, based n dynamic surce data. Fr example, cnsider the scenari where we want t ensure that the each f a series f 2000 prducts passes a set f tests. We bviusly wuldn't want t create 2000 f the same test. Similarly it might nt be pssible t write a single query that cvers all the test cases - we may want t validate that the results f a REST call fr each f the prducts passes a set f criteria. This is where data driven testing cmes in t play. Cnfiguring data-driven testing In the test tree n the left, under each test nde is a nde titled 'Data Driven Surce'. Clicking n this and clicking the check bx t enable data driven testing fr the test gives us the fllwing view: Here, much like in the interactive cmparisn wizard we are selecting a cnnectin and either entering a query r cnfiguring the surce (if using a REST cnnectin, fr example). Once we have selected ur cnnectin we click Execute t retrieve the results. Nte: It is imprtant t understand that the results are nly shwn in the UI t enable easier cnfiguratin. The data returned is NOT stred, and the surce is run every time the test runs. The nly infrmatin that is retained is the metadata abut the clumns, s that they can be used as resurces.

30 One we have cnfigured the surce and executed it, we can see that the data is shwn: This test is nw cnfigured fr data driven testing! In this example, we are using a list f slutin items frm the DOC xpress metabase. Nw, when selecting resurces fr ur actins / assertins - we can see that the clumns returned frm ur data driven surce are reflected in the list f available resurces:

31 We can als use these values wherever we wuld use parameters nrmally - s, fr example, we culd write a query in the frm: SELECT COUNT(*) FROM LineageService.ItemSets WHERE SlutinItemId = '{{SlutinItemId}}' Differences between data driven testing in MS Test and NUnit There are differences in hw data driven testing wrks under the cvers between the test framewrks available. Fr a cmplete descriptin f the differences, see the framewrk cnsideratins tpic. Created with the Standard Editin f HelpNDc: Write ebks fr the Kindle

32 Framewrk Cnsideratins Framewrk Cnsideratins Data driven testing is implemented slightly differently under MS Test and NUnit. Bth will evaluate the data driven surce during the 'discvery' phase f the test and use the utput f that t generate the list f iteratins. Hwever - there are sme differences in the utput that yu will see frm each because the test framewrks are designed differently. MSTest When using MSTest - each iteratin f the test is reprted under a single test in the test explrer. When lking at the utput fr this test, yu will see several different runs. Each ne has a link that says 'utput' - this link can be clicked t get a summary f the rws f data used fr that test. When examining the utput f an individual test, the display will lk similar t this: As a technical nte, MS Test data driven tests generate an XML file cntaining the test cases during the discvery phase. This is then used as the surce f the test data using the DataSurce attribute. NUnit When using NUnit - each iteratin f the test is reprted as an individual test. This can make it a lt easier t identify the tests. Here is a similar display, where we are lking at the utput f an indifividual test iteratin and viewing the utput.

33 The tecnhical implementatin f the NUnit back end is slightly cleaner than MSTest - in that NUnit supprts the TestCaseSurce attribute. This means that the test data des nt have t be written t disk first. Created with the Standard Editin f HelpNDc: Easily create CHM Help dcuments

34 Filtering Filtering The filtering windw is available thrugh the 'Edit Filter' buttn f sme actins (such as the Lad Flat File Data and Lad Directry Cntent actins). At the tp f the filter windw are drp dwns which relate t the clumn, the peratr and an area where the value can be entered. Clicking the '+' icn will add this clause t the end f the filter. Filter Expressins Filter expressins are very similar t SQL WHERE clauses. Yu can enter text that refers t clumn names and uses peratrs t cmpare with ther clumns r static values. Filter expressins als supprt cmbinatinal lgic using AND/OR. Samples [Size] > [DateMdified] BETWEEN '2017/01/01' AND '2017/02/01' [CustmerName] LIKE 'Fred%' AND [OrderCmplete]!= 1 Available Operatrs =: Equals

35 !=: Nt Equal <>: Nt Equal >: Greater Than >=: Greater Than Or Equal T <: Less Than <=: Less Than Or Equal T!>: Nt Greater Than!<: Nt Less Than LIKE: Value matches SQL-style string pattern NOT LIKE: Value des nt match SQL-style string pattern BETWEEN: Value falls between [x] and [y] NOT BETWEEN: Value des nt fall between [x] and [y] IS NULL: Value is null IS NOT NULL: Value is nt null Cmbinatinal Operatrs AND/OR can be used t cmbine expressin clauses, and parenthesis can be used t grup clauses. [a] = 5 AND [b] = 2 AND [c] = 9 [a] > 1 AND ([b] > 10 OR [c] > 20) Static value frmatting Values are frmatted as they wuld be in SQL. Strings, GUIDs and Date/Time values are enclsed in qutes, blean values are 0 r 1 and numeric values are represented naturally. String: 'a string' GUID: '6264E1FD-D1DA-49B2-977E-5BAD05BCAC9D' Date/Time: '2017/03/01' Blean: 1 Integer: Flat:

36 Created with the Standard Editin f HelpNDc: Easily create Web Help sites

37 Integrating with LegiTest Server r LegiTest Online Integrating with LegiTest Server r LegiTest Online LegiTest generated cde includes the ability t publish detailed test results t a server system. This ges abve and beynd what yu might see frm a standard test framewrk - each f the individual elements within a test becme visible n the server every time they are run. Detailed results can als be fund rather than just a message saying 'yur grid cmparisn failed' yu get t see what that grid actually lked like. Other benefits available with server integratin are the ability t publish tests and run them autmatically n a schedule, the ability t anntate yur tests t give meaningful business descriptins t them and the ability t specify what parts f yur system are cvered by the tests that yu have implemented. Mre infrmatin is available in the subtpics: Publishing Results System Cverage Anntatins Publishing Test Assemblies Created with the Standard Editin f HelpNDc: Free help authring envirnment

38 Cnnecting t a Server Cnnecting t a Server In rder t cnnect t a server, yu need t pen the prject settings file. By default, this is called PrjectSettings.legitestSettings. When pening the prject settings file, a view similar t the fllwing is presented: Here we can type the URL f the server that we wish t cnnect t and click 'Validate'. If the server requires credentials (e.g. LegiTest Online) then a ppup may be shwn requiring yu t lg in t yur accunt. After the server has been validated, this is shwn n the display. Imprtant Nte Ensure that the scheme (http / https) is set crrectly fr the server that yu are cnnecting t. The address required fr LegiTest Online is the public API address. Created with the Standard Editin f HelpNDc: Easy EPub and dcumentatin editr

39 Publishing Results Publishing Results Publishing results can be cntrlled fr each LegiTest Grup. When clicking n the 'Server Integratin' nde, the fllwing display is visible: Here we can click n 'Publish test results t LegiTest Server' - which means that when the test runs, infrmatin will be sent t the server cnfigured in the prject settings. Imprtant Nte Server integratin is cntrlled by parameters. Whether a test grup publishes results r nt is cntrlled by the 'PublishResultsTLegiTestServer' parameter, and the server t which results are published is cntrlled by the 'LegiTestServerUrl' parameter. Created with the Standard Editin f HelpNDc: Qt Help dcumentatin made easy

40 System Cverage System Cverage System Cverage allws a view f which bjects have been tested within a system. There are tw mdes f peratin - DOC xpress integrated and standalne. DOC xpress Integrated In this mde, infrmatin abut which bjects are available fr test cmes frm DOC xpress Server. Because there is a slutin snapsht present, the system can tell what items there are t test. LegiTest Client shws the DOC xpress Metadata Search tl, and yu can pick items frm yur DOC xpress Server t mark as tested. This means that there are fur available categries f utput: Passed - An item is cvered by a passing test Failed - An item is cvered by a failing test Incnclusive - An item is cvered by a failing test Nt cvered - An item is knwn in the DOC xpress Server database, but n tests that cver it have been run Standalne In standalne mde, there isn't any infrmatin abut what bjects there are t test. Because f that, System Cverage is nly able t shw the first three categries f utput abve. Individual items are assigned identifiers by the user, and thse identifiers are hw the system cllates data. Setting up Cverage Infrmatin When setting up system cverage there are tw parts that must be cnfigured - the binding f items t tests and the cnfiguratin f viewable reprts n the server. Infrmatin n setting up system cverage n LegiTest Server can be fund here. In the client, selecting the 'System Cverage' nde in a test grup shws the fllwing display:

41 On the right is the DOC xpress Metadata Search, allwing us t find items t mark as cvered. On the left is a tree which represents the cntent f the current grup / suite. Entering a search term returns us the results frm the server: By clicking n an item in the left hand tree and then duble clicking the fund item in the right hand pane,

42 the item is the bund t the test. Nw when the test runs, that item will be cnsidered 'cvered' and will have a status f 'Passed', 'Failed' r 'Incnclusive' depending n the test utcme. Created with the Standard Editin f HelpNDc: Free Qt Help dcumentatin generatr

43 Viewing Reprts Viewing Reprts T view system cverage reprts frm the server in LegiTest Client, we can simply click n the 'Reprts' nde under System Cverage. This prduces a list f the cverage reprts that are available n the server: T view a reprt, we simply click n the 'View this reprt' buttn, and we are shwn the graph view which cntains a summary graph, and a graph fr each cverage reprt item we have cnfigured: We can click n 'View as tree' t change the view t a detailed tree view shwing all the bjects available, and their status:

44 Created with the Standard Editin f HelpNDc: Easy EBk and dcumentatin generatr

45 Anntatins Anntatins Anntatins allw meaningful descriptins t be assigned t tests. These can be useful when business users are trying t make sense f test results n LegiTest Server, and appear n the test management page fr a test. Cnfiguring the anntatins in the LegiTest Client is simple. Clicking n the 'Anntatins' nde under a test brings us t the fllwing display: Here we can click n 'Add', chse the anntatin type and enter sme text that relates t the test in questin. The built in anntatin types are 'User Errr Message', 'Descriptin' and 'Reslutin Steps'. Custm anntatin types can be added by clicking n the 'Anntatin Types' nde, which will then display a list f the anntatin types:

46 We can add new nes r delete ur custm added nes (the built in anntatins cannt be deleted). Yu can click n 'Sync' t synchrnize the list f anntatin types with the cnfigured LegiTest Server. Created with the Standard Editin f HelpNDc: Free EPub and dcumentatin generatr

47 Publishing Test Assemblies Publishing Test Assemblies When we are finished develping ur tests, we can publish the resulting test assemblies t LegiTest Server s that they can be run n a schedule r manually thrugh the web interface. T d this, right click n the prject yu want t publish and click 'Publish t LegiTest Server...' The ptins available t us are: Target Here we can specify the server that we are publishing the assemblies t, r specify a file path t which t cpy the built assemblies. A new server can be added by clicking n the '+' buttn. Results Mde We can specify frme the fllwing ptins: 'Set all suites t publish results' - All suites / grups in the prject are set t send their results t a server when they run 'Set all suites nt t publish results' - All suites / grups in the prject are set s that results are nt sent at runtime 'D nt change suite settings' - N settings are changed - s each suite / grup will publish results accrding t the setting set n the 'Server Integratin' nde. 'Remve suite settings t inherit glbal cnfiguratin' - The setting is remved frm each suite - and the setting will be picked up frm a glbal parameter file. Results Server This is the server t which results will be sent when the assemblies are run after being published. Cnfiguratin We can specify the 'Debug' r 'Release' cnfiguratin fr the C# cmpiler t use. Fr mst situatins, 'Release' is the crrect cnfiguratin t use fr deplyed tests. Run tests immediately after publish When this ptin is checked, tests will be run by the server as sn as publishing is cmplete. Created with the Standard Editin f HelpNDc: Easy EPub and dcumentatin editr

48 Tutrials Tutrials Table f Cntents Getting Started My First SSIS LegiTest Designing a LegiTest Test Using Parameters Created with the Standard Editin f HelpNDc: Free EPub and dcumentatin generatr

49 My First SSIS LegiTest My First SSIS LegiTest In the previus pst, Designing a LegiTest Test, we walked thrugh the steps t design a test arund an SSIS package. In this pst weʼll build ur first LegiTest test, allwing us t test the executin f an SSIS Package. If yu havenʼt read the previus pst Designing a LegiTest Test yu shuld, as it establishes the design we will implement here. After creating a slutin / prject fr the package described in the previus pst, weʼll add a secnd prject. Add the secnd prject by ging t the menu and ding File, Add, New Prject. In the Add New Prject dialg, click n Visual C#, scrll dwn and click LegiTest Prject MSTest. Give it a gd name and click OK. As a reminder, in the previus pst, the basic steps fr design were: Understand the bject being tested. Identify the assertins which will legitimize the bject being tested. Define the actins that need t be taken in rder t d the tests. List the assets needed in rder fr the actins t wrk. Implementing the design ges in reverse rder. 1. Create the assets. 2. Define the actins. 3. Create the asserts. Assets As the first step t building ur test, weʼll start creating assets. Cnnectins Click inside the Assets area. The LegiTest Tlbx will update with the items apprpriate t the assets area. In the tlbx, click n the Cnnectin tl, drag and drp it int the assets area. Click n the Cnnectin blck, and the LegiTest Element Editr shuld appear. In the prvider drp dwn, pick the SqlClient Data Prvider. Take a secnd thugh t nte the vast array f data cnnectins available, including Oracle, OLEDB and ODBC.

50 Next click n the Cnfigure buttn. This will bring up a dialg yuʼve likely seen a millin times in yur career as a data centric develper. Use it t select the server and the LegiTestSurce database. Als be sure t set the user ID crrectly, fr a simple test t lcalhst the Windws Authenticatin ptin will likely wrk fine. Finally rename the asset t LegiTest Surce, either by single clicking twice r right clicking and picking rename n the ppup menu. When dne it will lk smething like the image belw. Dnʼt be alarmed abut the big exclamatin mark in the upper right crner. Thatʼs just an indicatr that it is an asset that isnʼt being used. In this case, the asset isnʼt being used yet. Nw repeat the abve steps, creating a cnnectin t the LegiTestDestinatin database. Yu can name it LegitTest Destinatin (spaces OK, it just makes the name easier t read). As an alternative t drag and drp frm the tlbx, try right clicking in the asset area, and in the ppup menu pick Query, Cnnectin. Queries T meet ur requirements fur queries will be needed. Frm the tlbx, drp a Query tl int the assets area. The element area fr a query is pretty simple, just a big text bx. In it paste the fllwing query: SELECT COUNT(*) AS MySitesCunt FROM [db].[mysites] Name the query asset MySites Cunt. Nw repeat the prcess, creating anther query asset named DimMySites Cunt and using the fllwing query: SELECT COUNT(*) AS DimMySitesCunt FROM [db].[dimmysites] Next, in rder t d the data cmpare we need queries t bring back the rws and clumns frm the surce and target. Add a query MySites Data, with this query: SELECT [PrimaryKey], [Name], [URL] FROM [db].[mysites] ORDER BY [PrimaryKey] And then anther query, DimMySites Data, with this query:

51 SELECT [PrimaryKey], [Name], [URL] FROM [db].[dimmysites] ORDER BY [PrimaryKey] Nte the Order By clause, it is needed t make sure the rws are in the crrect rder fr the cmpare. Als nte the LastUpdate is mitted frm the DimMySites Data query. The surce system lacks this field, thus weʼd have nthing t cmpare t if it was included. But wait, yu say, wasnʼt there a requirement t check the LastUpdate t ensure the rw hadnʼt changed? Gd catch. Hwever, instead f handling it as part f the data cmpare we will instead use a scalar cmparisn t get the value prir t and after the package executes and use thse t cmpare. Fr that we need t add anther query asset DimMySites LastUpdate. Fr the query use: SELECT [LastUpdate] FROM [db].[dimmysites] WHERE [Name] = 'Pragmatic Wrks' Nte yu culd als have used the primary key, hwever in mst data warehusing situatins the primary key is usually the surrgate key, which may nt be predictable. In this example we went with the Name clumn, which acts as the surce system native key fr this dem. Weʼre almst dne. Even thugh it wasnʼt mentined as a requirement, ne thing every test needs is a way t reset the target befre each run. This can be accmplished in a variety f ways. Fr example, LegiTest has a backup / restre asset which wuld allw yu t restre the destinatin database frm a baseline database previusly backed up. Yu culd als use the Execute Prcess task t deply a dacpac t the target. In this case thugh we can d smething much simpler. Weʼll add a query t truncate the target table, then insert the needed rws. Create a query DimMySites Reset. Insert the fllwing cde: TRUNCATE TABLE [db].[dimmysites]; INSERT INTO [db].[dimmysites] ([PrimaryKey], [Name], [URL]) VALUES (1, 'Pragmatic Wrks', ' (3, 'arcanecde', ' ; Imprtant pint t nte abut the abve query. If yu ran this in SQL Server Management Studi, it wuld want a GO after the TRUNCATE TABLE statement. GO is a mechanism fr SSMS, it is nt needed when executing a query frm a.net applicatin such as LegiTest generates. Be sure t mit any GOs r else yu will get an incrrect syntax errr when yu execute yur test. That is the last f the query assets we need t create. Hwever, there are tw mre asset we need t add befre we can begin creating ur actins. Cmparisn Manifest In rder fr LegiTest t be able t cmpare data sets, r as the tlbx calls them grids, it needs t knw hw each clumn frm the first data set (referred t as the Left Side) cmpares t the clumns n the Right Side. Insert a Cmparisn Manifest tl int the assets area. Name it Cmpare MySites t DimMySites. In the LegiTest Element Editr, yu will see the first step f the Cmparisn Manifest wizard appear, titled Gather Left Clumn(s). T this yu will first need t prvide a cnnectin. Click the Cpy Frm Asset buttn, in the dialg that appears click n the LegiTest Surce (Cnnectin) then click OK.

52 Nte that if yu had nt yet created the cnnectin yu culd als d it thrugh this dialg. Hwever, because yu are a talented and brilliant individual (yu must be if yuʼre using LegiTest) and planned things ahead, the cnnectins already exist and can just be picked. Next the Cmparisn Manifest needs t knw the query that will get the data fr the left side. Simply click the Cpy Frm Asset buttn next t the Query, and select the MySites Data (Query) in the dialg that appears. When dne yur editr shuld lk apprximately like the image belw. Click the Gather buttn t prceed t the next step. Nw we repeat the steps fr the right side. Fr the Cnnectin, cpy frm the asset LegitTest Destinatin, and fr the query cpy frm DimMySites Data. When dne click Gather. In the final page f the wizard we need t match up the clumns. LegiTest autmatically matches when the names are the same, which is a great reasn t use aliasing in the queries if yu can. In this simple dem it wasnʼt needed as the clumn names all matched up. If it was, yu culd click n a clumn name, slick the edit buttn t the right, and change the mapping. Yu can als add mappings if LegiTest didnʼt detect it, r delete nes yu dnʼt want t cmpare. There is ne thing we can d t help speed things alng. Nte the Key Clumns area at the tp is empty. We shuld mve the PrimaryKey clumn up t this area t speed up the cmpare. First, click the Add buttn at the tp, next t the Key Clumns. In the page that appears, pick the PrimaryKey fr bth the left and right clumn name and click OK. Next, in the Cmparisn Clumns area, click n the PrimaryKey and then the Delete buttn. Since weʼve indicated it is the primary key, it isnʼt ging t change and hence desnʼt need t be cmpared. Yur cmpare shuld nw lk like:

53 Package Reference (SSIS 2012) The final item t add is a reference t the package we are testing. Click in the Assets area, then int it drag and drp a Package Reference (SSIS 2012) asset frm the tlbx. In the LegiTest Element Editr, there are three lcatins t lad the package frm: File, SQL, and Catalg. Fr this example the File ptin will be selected, hwever many pt t run frm the catalg t make testing frm multiple machines easier. Make sure File is selected (it will be a darker clr than the thers) the click the Brwse buttn. Navigate t the flder with yur package and select it. Finally give the asset a gd name, in this case just name it after the package, MyFirstSSISLegiTest Nw that weʼve finished creating the assets, take a secnd t save yur wrk, then itʼs time t start the actin rlling! Actins Nw that all the assets are setup, itʼs time t create the actins. Actins are arranged at multiple levels. T

54 fully understand hw LegiTest rganizes tests, please refer t the first pst in the series, Intrductin t the LegiTest Designer. Grup Level Actins With the assets setup, mve t the arrangement area in the designer, and click n Test Grup 1. Rename it t DimMySites Package. Nw in the Grup Initializatin Steps area, we need t perfrm actins that are needed prir t testing. Referring back t ur requirements, there were three actins that needed t be perfrmed prir t ding any testing. The first actin was reset the target table t a knwn state. T d s we will execute the DimMySites Reset query. In the LegiTest Tlbx, drag an Execute Query (Cmmand) actin int the Grup Initializatin Steps area. Click n it t pen the LegiTest Element Editr. Click in the Cnnectin Asset area, then click n the icn. In the dialg that appears select the LegiTest Destinatin cnnectin asset yu setup. Next, repeat the prcess fr the Query Asset, selecting the DimMySites Reset (Query) asset. (Nte yu may need t click utside the line with Query Asset t make it finalize yur chice). Finally, rename the actin t Exec DimMySites Reset. Nw that the target table has been reset, we need t get a key piece f infrmatin frm the table. Fr the rw that is nt suppsed t change (the rw with Pragmatic Wrks in the Name clumn), we will get the LastUpdate clumn befre the package executes. Later, weʼll cmpare this t the LastUpdate clumn after the package runs t ensure there was n change. Int the Grup Initializatin Steps, place an Execute Query (Scalar) actin. Fr the Cnnectin select the LegiTestDestinatin, fr the Query select DimMySites LastUpdate. The nly ther ptin is Resurce Key. Mst (but nt all) actins in LegiTest have a Resurce Key. Think f the Resurce Key much like a variable. When an actin has sme utput, the utput is stred in the Resurce Key, where it can be later accessed by ther actins. Thus yu shuld be sure t give all Resurce Keyʼs gd, clear names. In this case, the LastUpdate value retrieved by the query will be stred in the Resurce key we prvide. As yu can see frm the image abve, weʼll name this DimMySitesLastUpdatePreRun. As the last step rename the actin t Exec DimMySites LastUpdate Pre Run. The third actin in ur list f things t d is Lad the package int memry. This is straightfrward. Frm the tlbx, simply drag the Lad Package actin t the Grup Initializatin Steps. In the LegiTest Element Editr, in the Package Reference Asset pick the MyFirstSSISLegiTest asset frm the dialg.

55 At last we are at the final actin needed fr ur tests, and that is t run the package. Frm the tlbx drp an Execute Package actin int the Grup Initializatin Steps area. In the LegiTest Element Editr, select the MyFirstSSISLegiTestPackage (Package) frm the dialg. This came frm the Lad Package assets Resurce Key name in the previus step. Speaking f resurce keys, we shuld give this ne a gd name, hw abut ExecMyFirstSSISLegiTest. Finally rename the asset itself Exec MyFirstSSISLegiTest. The Grup Initializatin Steps track shuld nw lk like: Actins and Asserts The Tests Nw that the grup level actins are dne, it is time t build each test. In each test we first build the actins t get back any further data needed t d ur asserts, then we build the asserts themselves. Fr this example we have five tests t perfrm. Test One Rw Cunts At lng last it is time t setup the first test. If yu recall frm the initial requirements, test ne is t Test t ensure that the surce and target tables have the same number f rws after the package executes. Click n the Test 1 in the arrangement pane. By using the same single click twice methd used n assets and actins, tests can als be renamed. In this example we can use the name f the grup fllwed by the test. DimMySites_RwCunts will make a gd name. Why? Well when tests are executed, all tests acrss all prjects in the slutin are lumped tgether and nly the test name, nt the test grup, will be visible. Depending n the number f tests in yur prject, a simple name like Rw Cunts wnʼt be sufficient enugh t quickly identify and find the test shuld it fail. Fr an especially large prject yu may wish t extend yur naming scheme even further, fr example Prject_Grup_TestName. Als nte that when the tests are cmpiled, any spaces are remved thus an

56 underscre may make yur test names mre readable. T fulfill this requirement, we need t match the rws in the surce t the rws in the target. Thus weʼll need t execute the tw rw cunt queries stred in the assets area, then cmpare the results. Begin by drpping an Execute Query (Scalar) actin int the Executin Tracks area. These actins are used t run queries that return a single value, such as a SELECT COUNT r executing a stred prcedure which returns a single value. In the LegiTest Element Editr, fr the Cnnectin Asset select the LegiTest Surce. Fr the Query Asset, select the MySites Cunt. Next, give this actin a gd Resurce Key, such as MySitesCunt. As a last step give this a gd name, such as Exec MySites Cunt. (A typical pattern fr naming Execute Query actins is t use the wrd Exec fllwed by the name f the query t be run.) The last rw, Timeut, represents the number f secnds the query will run befre LegiTest times it ut. Fr mst queries 30 secnds is sufficient, but if yu have a lng running query yu may need t increase the time. If yu nte the Executin Tracks header, yuʼll see (1/1) after the track name. (Pinted at by the red arrw in the image belw). Unlike ther areas, the main executin track f a test supprts parallel prcessing. LegiTest understands that yu may need t run lng running queries as part f a test. Hence, it has the ability t run these in parallel. Even thugh the sample queries in this prject will run extremely fast, and hence dnʼt really need t be parallelized, weʼll setup this ne test just as an example. Click the + Add buttn t tward the right. The cunter will nw shw (1/2), and the Previus / Next buttns will becme active. Click Next t advance t the secnd executin track. In it, place anther Execute Query (Scalar) actin. As a reminder, if yu are tired f dragging and drpping yu can als right click in any f the tracks and add items frm the tlbx in a ppup menu. In the LegiTest Element Editr, fr the Cnnectin Asset select the LegiTest Destinatin. Fr the Query Asset, select the DimMySites Cunt. Next, give this actin a gd Resurce Key, such as DimMySitesCunt. Finally, fllwing ur naming pattern, name this actin Exec DimMySites Cunt. Finally it is time t see if ur test passes r nt. T d s, click n the Assertins track. Fr this we are cmparing rw cunts, which are integers, s we can use the Integer Cmparisn assertin. In the LegiTest Element Editr, nte first the Cmparable Value Surce. By default, this will cmpare the key in the Resurce Key field t a static value in the Cmparisn Value field. In this case we want t

57 cmpare ne resurce key t anther, s fr the Cmparable Value Surce click in it, and change it t Resurce. In the Cmparable Resurce Key field, select the MySitesCunt (Scalar Value) resurce. Then in the Resurce Key area, pick the DimMySitesCunt (Scalar Value). This will nw cmpare the values held in the resurce keys. The Cmparisn Mde indicates they type f cmparisn, by default it is set t Equal, which is what is needed fr this test. Hwever it supprts the standard cmparisns like greater than, less than, etc. The Cmparisn Value desnʼt apply when ding a Cmparable Value Surce f Resurce. If this was still set t Static Value, what is in here wuld be cmpared t the key Resurce Key (and by inference in Static Value mde the Cmparable Resurce Key field is ignred). Finally, Tlerance is used t set a +/- value, this allws fr either a set value r percentage. Essentially hw clse can the numbers be and still pass the test. In this case weʼll leave it alne. As a last step rename the assertin t Cmpare Rw Cunts. Nw that the first test is created, we can test ur test. First thugh, we need t generate the C# cde that will actually becme ur test. Ding s is simple, just click the Save buttn. Yes, itʼs just that easy. (And Save All wrks t!) After saving take a lk at the slutin explrer. Expanding the varius branches yu will see quite a few files have been added t the prject.

58 Dnʼt wrry, it isnʼt necessary fr yu t understand any f these, just knw that LegiTest generated this cntent. If yu did want t lk, the DimMySitesPackage.Generated.cs wuld be the prime file t review, hwever delving int the generated cde is utside the scpe f this pst, and will be saved fr the future. Nw we can actually run the test. T d s, simply click the Run All Tests buttn abve the grup rganizatin area. Visual Studi will build the cde, then execute the test. In a mment it will pen up a new tab Test Explrer. If the windw is already pen, yu will likely need t switch t it manually. In the belw screen sht yu will hpefully see a successful run.

59 Test Tw Data Cmpare It is nw time t add the secnd test, cmparing data between the surce and target. In the test rganizer, click the Add Test buttn. Rename this new test DimMySites_DataCmpare. After it is created, click n it t be sure it is the currently selected test. In the Executin Tracks fr this test, place an Execute Query (Grid) actin. This actin will get a dataset frm a query and place the entire dataset int memry. Select the LegiTest Surce as the Cnnectin Asset, and the MySites Data fr the Query Asset. Finally, give this a gd Resurce Key, in this example MySItesData. Finally give the actin itself a gd name, Exec MySites Data. In the preceding paragraph yu may have nticed the statement and place the entire dataset int memry. If yu have a query that returns an especially large dataset, LegiTest has an ptin, Disk Based. Instead f placing the dataset in memry, it instead spls the data t disk. As yu might surmise, the query and later cmparisn will run a tad slwer, but will be scalable fr larger datasets. Weʼll nw repeat the abve steps, nly this time fr the destinatin data. Rather than creating a secnd executin track as we did in the previus example, weʼll just add this query t the existing executin track. Fr the Cnnectin Asset use LegiTest Destinatin. In the Query Asset select DimMySites Data, and finally use DimMySitesData fr the Resurce Key. Name the new actin Exec DimMySitesData. Nw fr the Assert. In the Assert track, place a Grid Cmparisn assert. Next, click in the Left Grid rw inside the LegiTest Element Editr. Click the buttn and select the MySitesData (Grid) ptin. Next, click in the Cmparisn Manifest Actin rw, and select the Cmpare MySites t DimMySites (Cmparisn Manifest) ptin. Finally, in the Right Grid, select the DimMySitesData (Grid). Nte that yuʼll want t click utside the rw area fr LegiTest t cmmit the change t the prperty. Save yur wrk, and Run All Tests again. Nw it will execute bth tests, and if all went well bth shuld be green. Test Three Ensure the Rw Did Nt Change In ur next test, we want t validate the lgic f ur package such that if a rw des nt need t be updated, it isnʼt. Our methd fr testing this is t get the LastUpdate date-time fr that rw prir t the package executin, then again after it executes. This shuld be the same value bth befre and after.

60 In the Grup Initializatin sectin, we already btained the value befre the package executed. Nw weʼll grab it afterward. Start by adding a new test, and naming it DimMySites_UnchangedRws_LastUpdate. (Weʼre ging t have a secnd test fr unchanged rws mmentarily, hence the _LastUpdate at the end t differentiate.) In the Executin Track, place an Execute Query (Scalar) actin. Use LegiTest Destinatin fr the cnnectin, and DimMySites LastUpdate fr the query. Name the Resurce Key DimMySitesLastUpdatePstRun. Finally rename it t Exec DimMySites LastUpdate Pst Run. Nw fr the Assert. Place a Scalar Cmparisn Assert int the Assertins track. Use the Exec DimMySites LastUpdate Pre Run and Exec DimMySites LastUpdate Pst Run resurce keys fr the cmpariable and resurce key values, respectively. Be sure t change the Cmparable Value Surce t Resurce. Finally, we want t change the Cmparisn Type t the apprpriate data type. In this case they are bth date time values, s update this t DateTime. Rename the assert t Cmpare DimMySites Last Update, save and again run all tests. The Test Explrer shuld nw reprt this ne as passed as well. Test Fur Validate the Unchanged Rws Variable Fr this test weʼll validate ur rw did nt change by getting the value f the UnchangedRws variable we setup in the package. Add a new test and name it DimMySites_UnchangedRws_Variable. Instead f a query, we will instead want t get the value f a variable after the package has executed. T d s, place a Get Prperties actin int the executin track f the test. Inside the LegiTest Element Editr, in the Target Package drpdwn select the MyFirstSSISLegiTestPackage. Under the Prperties T Get, click the Add buttn. The editr will update, with the package name at the tp. Drill dwn int the Variables area, and click n When yu d, the area at the bttm will update t shw all f the variables prperties. Click n the Value. Finally,we will need t uniquely identify this value by giving it a Resurce Key. At the very tp f the editr, enter a resurce key f UnchangedRwsValue. Click OK t save and return t the

61 The new value shuld be listed in the Get Prperties editr inside the LegiTest Element Editr. Nte that yu can actually get multiple prperties all with the same Get Prperties actin, just click Add again and repeat the prcess. Hwever fr this test this single item is all that is needed. Just wrap this actin up by renaming it t Get UnchangedRws. Nw fr the Assert. Place an Integer Cmparisn int the Assertins track. This time instead f cmparing tw resurces, we will cmpare a resurce t a static value, s the Cmparable Resurce Value can be left at its default f StaticValue. Change the Cmparisn Value t 1, which is the number f rws that shuld nt be changed. Then select the UnchangedRwsValue fr the resurce key.

62 As befre, we can test the test by using the Run All Tests buttn abve the arrangement area. Test Five Package Executin Time This final test will be a repeat f the test abve, nly instead f a variable we will get the package executin time. Add a new test, DimMySites_ExecutinTime. Add a Get Prperties actin t the Executin Track. After selecting the package in the element editr, click Add, then click n the package itself. In the prperties that appear fr the package, select ExecutinDuratin, and finally give a resurce key f MyFirstSSISLegiTest_ExecutinTime. Wrap it up by naming the actin Get Executin Time. Next cmes the assertin, again we can use the integer cmparisn. This will be anther static cmpare, using the just added MyFirstSSISLegiTest_ExecutinTime resurce key. In the value, we need t enter the time in millisecnds, thus 5000 fr 5 secnds. One final but imprtant step. In the assertin we want the time t be less than the cmparisn value. As lng as the run time is less than 5000 ms we are gd. Thus be sure t change the Cmparisn Mde t Less Than. After saving, weʼll run it a bit differently than the previus examples. First g t the Slutin Explrer. Right click n the prject hlding yur LegiTest test (in this example we named it My First SSIS LegiTest Tests) and pick Build. Nw g t the Test Explrer. After the build, the new test shuld appear under the Nt Run Tests branch (yu may have t expand it). Simply right click n it, and pick Run Selected Tests. Yur test shuld nw execute and give yu a green result. As yu can see, ging t Test Explrer gives a bit mre fine-tune cntrl ver which tests are executed. If

63 yu g t the Test Explrer and dnʼt see yur test, be sure t build yur prject. The ther reasn why a test may nt appear is due t build errrs, s be sure t als check the utput windw fr issues there. Cnclusin Whew! Weʼve finally reached the finish line. Admittedly all written ut like this makes it lk like a lt f wrk. But in fact the wrking methds will quickly becme secnd nature. In fact even a relatively new user t LegiTest shuld be able t create this test in well under an hur. With that small investment f time there will be a test that can be run ver and ver. Nt nly can this test be used t validate this particular package, but it can als buffer against changes made elsewhere in yur system. Fr example, letʼs say yu had ver 500 packages in yur prject, plus databases. Thereʼs n way t easily test all 500 every time. With LegiTest, it is a simple matter f launching yur autmated LegiTests. This will help ensure a change elsewhere didnʼt impact the package being tested. Created with the Standard Editin f HelpNDc: Free EPub prducer

64 Designing a LegiTest Test Designing a LegiTest Test As yu begin t wrk with LegiTest, a natural first questin is Hw d yu design a test? In this article weʼll lk at just that, using the testing f an SSIS package as an example. The steps thugh are similar regardless f what yu are testing Understand the bject being tested. Identify the assertins which will legitimize the bject being tested. Define the actins that need t be taken in rder t d the tests. List the assets needed in rder fr the actins t wrk. With LegiTest, the bject being tested can be a multitude f things. SSIS Packages, data, database bjects such as stred prcedures and functins, SSRS reprts, SSAS cubes and dimensins, and mre. The assertins can be thught f as the way in which we prve the bject wrks as designed. In human readable terms, a test might assert If the rw cunt frm a query matches an entered number, the test passes. Actins are the things a test will need t d in rder t perfrm an assertin. Fr example, running queries, lading packages, running reprts, etc. Finally, assets are the things actins need in rder t run. Cnnectin strings, queries, and package references are all examples f assets. Fr a mre in depth discussin n these, please see Assets, Actins, Asserts and Resurces. The Package Being Tested The first step is t understand the bject being tested. The package being used in this pst is very simple, but perfrms a cmmn jb in the SSIS wrld. Take data frm a surce table, and see if that data is already in the target database based n the Primary Key clumn. If the data is nt present, insert it int the target table. If that data is present, but is different frm what is already in the target update the target. Otherwise, if the surce and target are the same, increment the unchanged rws variable but therwise take n actin. Here is a screen sht f the data flw task inside the package we are wrking with.

65 As mentined, this package uses tw databases, ne a surce and ne a target, each with ne table. In the first database, LegiTestSurce, weʼll create ne table. CREATE TABLE [db].[mysites]( [PrimaryKey] [int] NOT NULL, [Name] [nvarchar](250) NOT NULL, [URL] [nvarchar](250) NULL ) ON [PRIMARY] Here is an example f the kind f data that might g in it. INSERT INTO [db].[mysites] ([PrimaryKey], [Name], [URL]) VALUES (1, 'Pragmatic Wrks', ' (2, 'LegiTest', ' (3, 'Arcane Cde', ' ; Fr ur target database, LegiTestTarget, we will create a fake dimensin table. CREATE TABLE [db].[dimmysites]( [PrimaryKey] [int] NOT NULL, [Name] [nvarchar](250) NOT NULL, [URL] [nvarchar](250) NULL, [LastUpdate] [datetime] NOT NULL DEFAULT (getdate()) ) ON [PRIMARY] Of curse, this isnʼt a real dimensin table in any sense f the wrd, in this example weʼll just use the Dim

66 name fr illustratin purpses. The package needs tw cnnectin managers, ne fr each database. Fr this sample they were just made lcal t the package. Nte they were renamed t remve the lcal.ʼ SSIS autmatically places n the frnt. The package als has ne variable, which will be used t track the number f unchanged rws. In the package we create, it will d a lkup. If the rw desnʼt exist, it will then insert the rw int DimMySites. If it des exist, flw ges t the cnditinal split. In the cnditinal split the name and URL are cmpared t see if anything changed. (Name!= DimName) (URL!= DimURL) The purpse f the derived clumn transfrm is t calculate the LastUpdate date fr the target table. The variable is LastUpdate, and the expressin is simply (DT_DATE)GETDATE(). The cntents f the OLEDB CMD destinatin shuld be relatively bvius. The cmmand is a simple update statement. UPDATE [db].[dimmysites] SET [Name] =?, [URL] =?, [LastUpdate] =? WHERE [PrimaryKey] =? A final nte, this is nt the ptimal way t design a gd data warehuse package. Nrmally the OLEDB Cmmand wuld nt be used, due t its slwness. Hwever this wrks well fr this fray int LegiTest. Nw that we understand the bject being tested, in this example the package, hw wuld we g abut testing it? What are the types f assertins we culd run against this package t ensure it wrks as designed? Assertins A first, and bvius ne is t make sure that after the package executes the number f rws in bth tables is the same. Anther bvius assertin wuld be t make sure the data in bth tables is the same after the package executes (excluding the LastUpdate clumn which nly exists in the target). S what else shuld we test? Lking at the package, there is lgic arund existing rws. We wuld f curse want t ensure data is updated prperly, but that wuld be cvered in the previus test n matching the surce t the target. Anther part f the lgic thugh, rutes unchanged rws t a cunter. A test arund this culd actually cnsist f tw assertins. The first shuld validate that the rw did nt change between the time the package started, and the time it ended. The secnd shuld check the rw cunter. T make this testable, we will need sme special data laded int the target table. INSERT INTO [db].[dimmysites] ([PrimaryKey], [Name], [URL]) VALUES (1, 'Pragmatic Wrks', ' (3, 'arcanecde', ' ; Referring back t the data laded int the surce, the rw with Primary Key 1 is the same data. Thus this rw shuld nt change during the update prcess. The rw with Primary Key 3 will be updated, but again that will be tested and validated when the target table is cmpared t the surce table. As a final test, we want ur package t execute in under a set amunt f time. Thus we want t get the execute time t ensure it meets the defined parameters.

67 T sum up the assertins we want t execute within ur tests, they are: 1. Assert that the surce and target tables have the same number f rws after the package executes. (Fr the test database we have setup, this will be 3 rws.) 2. Assert that the data, excluding the LastUpdate clumn (which desnʼt exist in the surce), matches between the surce and target. 3. Assert that the rw that shuld nt be changed (Primary Key 1) was nt altered, based n the LastUpdate clumn. 4. Assert that the UnchangedRws variable cntaining the unchanged rws rw cunt has a value f 1 after the package executes. 5. Assert that the package executed in under a set amunt f time. At this pint we have nw identified the assertins that are needed within each test. Nw in rder t d these tests, what actins d we need t take befre we can actually run assertins within ur tests? Actins Prir t running individual tests, there are actins that need t be dne. These wuld likely be dne at the Grup Initializatin area f LegiTest. First, weʼll need t set the surce and target databases t a knwn state. Often the surce database will already be in a knwn state, which is the case here, s we wnʼt have t d anything within the test. Hwever we will want t ensure the target database is reset crrectly prir t the tests being dne. After the target database is setup, we need t determine hw t knw whether the rw that will be used in ur unchanged rw has been changed r nt. Thus we will need t execute a query t get the LastUpdate date-time fr that rw befre the test executes. Packages can exist in many different places. As a next step weʼll need t get a reference t the package itself. Once we have that package laded in memry, weʼll need t run it. Summarizing, these are the actins that need t be executed prir t running individual tests Reset the target table t a knwn state. Execute a query t get the Last Update data fr the rw that shuldnʼt change. Lad the package int memry. Execute the package. Nw that the grup actins are identified, we knw that each test itself will need t run its wn series f actins befre the assertin in that test can take place. Individual tests within LegiTest fllws a typical pattern. 1. Execute ne r mre actins t determine the state f data after the bject (in this example a package) executes. 2. Run ne r mre assertins which use the utput f the actins t determine if the assertin is true r false. Specific t this test, the actins we take fr the first fur tests will execute a query actin against the database. The final test will perfrm a get prperties actin t get the executin time. Assets With the bulk f the wrk cmpleted, the final task is t identify the assets needed fr the actins t wrk. The LegiTest being designed here wrks with tw databases, s a cnnectin string fr each database will be manifested as cnnectin assets. In the actins area it was mentined there will be actins which determine the state f the data. These are queries, and thus a series f query assets need t be generated.

68 One f the assertins we listed was t cmpare data between the surce and target. T d this, LegiTest needs t knw hw t map the clumns between the tw systems. T d that weʼll use an asset called a cmparisn manifest. Finally, in rder t lad a package weʼll need t tell LegiTest where it is. That is dne thrugh a package reference asset. Our asset list can thus be summarized as: Cnnectins t the surce and target database. Queries t get rw cunts fr bth the surce and target tables. Queries t get data fr bth the surce and target tables. Query t get the LastUpdate clumn. A cmparisn manifest that will be used t cmpare the rw and surce data. A reference t the DimMySites package. Summary As yu can see, this is a lgical prgressin yu can use t design any LegiTest test. First, befre the design f any test begins yu must understand what is being tested. Secnd, identify the ways in which we will be able t validate the bject being tested wrks as designed. After this step it shuld start t becme clear which actins are needed in rder t perfrm the validatin. As the furth and final step, identify the assets which are needed in rder t perfrm the actins and asserts. T repeat the list we started with: Understand the bject being tested. Identify the assertins which will legitimize the bject being tested. Define the actins that need t be taken in rder t d the tests. List the assets needed in rder fr the actins t wrk. Sidebar: The Real Wrld In an ptimal wrld, it wuld be nice t be able t have everything identified befre we did any cding, and laid ut s neatly, as we were able t d in this article. We all knw thugh the real wrld isnʼt s neat. The steps listed thugh can be perfrmed n an iterative basis. Instead f identifying everything up frnt, this culd be dne n a test by test basis Understand the bject being tested. Identify the assertin(s) fr an individual test. Define the actins needed fr that test t perfrm its assertin. Create the assets fr that particular test, r identify and reuse any assets that may already exist. Return t step 1 fr creatin f the next test. Whatʼs Next? In this tutrial we walked thrugh the design f a LegiTest test, using a SSIS package as illustratin. In the next tutrial weʼll implement this design by building a cmplete LegiTest test arund it. Created with the Standard Editin f HelpNDc: What is a Help Authring tl?

69 Using Parameters Using Parameters LegiTest includes the ability t parameterize tests. Element prperties within the tests can use the parameters t allw easy prting between envirnments. This tutrial uses the Pragmatic Wrks HigherEd demnstratin prject. The tutrial creates tests fr an SSIS package ensuring it extracts and then lads data int a data warehuse. By the end f this tutrial the tests will use parameters t allw fr easier deplyment. Users unfamiliar with LegiTest's layut shuld first familiarize themselves with the tutrial verview. Users already familiar with the LegiTest layut can cntinue t the parameter tutrial. Created with the Standard Editin f HelpNDc: Free PDF dcumentatin generatr

70 Overview Parameters Overview Within the test suite / grup, select the "Parameters" nde t view parameter settings. This area allws user t create and manage parameters. We'll be revisiting this area shrtly, fr nw let's lk at the remaining pieces f the test. If yu select the "HigherEdETL" nde, the view will change test suite level elements. Test suite level assets are available fr use acrss all grups and tests. This test suite cntains three assets: HigherEd: A Cnnectin asset referencing the HigherEd database HigherEdDW: A Cnnectin asset referencing the HigherEdDW database SSIS Catalg: A Cnnectin asset referencing the SSIS Catalg that stres the package

71 As f nw, the HigherEdDW cnnectin references ur lcal data surce. This will later be verridden with a parameter fr easier deplyment. If yu select the "HigherEdETL_Dim_Dner" nde, the view will display grup elements. Click here mre infrmatin n a test grup's test flw. Grup level elements are nly available fr the specific grup and its tests. This grup cntains a single asset: Dim_Dnr: An SSIS Package Reference that references the SSIS package

72 Selecting the "HigherEdETL_Dim_Dnr_DataCmpare" nde displays test elements. Imprtant Nte: Usually, test suites cntain mre than ne test. This test suite has minimal cmplexity t better illustrate the use f parameters. The "HigherEdETL_Dim_Dnr_DataCmpare" cntains five main areas, thugh this test uses nly fur.

73 Test Assets: Assets used by all elements within this test. DimDnr Manifest: A Cmparisn Manifest that describes hw t cmpare the Dnr and Dim_Dnr table HigherEdDW Dim_Dnr Grid: The Query Asset cntaining a T-SQL query that extracts the Dim_Dnr table HigherEd Dnr Grid: The Query Asset cntaining a T-SQL query that extracts the Dnr table Test Initializatin Steps: These elements run befre all executin tracks. Lad Dim_Dnr: A Lad Package actin that lads the Dim_Dnr package. LegiTest needs t lad an SSIS Package befre it can run within the executin track Executin Tracks: Each executin track runs asynchrnusly. Within a single executin track the actins run frm left t right. This particular test cntains nly a single executin track. Execute Dim_Dnr: An Execute Package actin that executes the Dim_Dnr package Lad HigherEdDW Dim_Dnr (Grid): The Execute Query (Grid) lads the Dim_Dnr table fr cmparisn Lad HigherEd Dnr (Grid): The Execute Query (Grid) lads the Dnr table fr cmparisn Test Teardwn Steps: Elements within this area execute after all executin tracks. This sample test cntains n elements within this area. Asserts: These elements determine whether the test passes r fails. Grid Cmparisn: A Grid Cmparisn assert that cmpares whether Dim_Dnr and Dnr

74 are identical Created with the Standard Editin f HelpNDc: Easy t use tl t create HTML Help files and Help web sites

75 Parameter Tutrial Parameter Tutrial As created, the test cntains hard-cded package and cnnectin references. Rather than using hardcded references, parameters allw fr flexible deplyment acrss envirnments. This tutrial walks thrugh the prcess f cnfiguring the cnnectins t reference parameters. Imprtant Nte Parameters can be defined bth in LegiTest suites as well as individual parameter files within the prject. T add a parameter file t the prject yu can right click n the prject nde in slutin explrer and click Add -> LegiTest Parameters File Frm the parameter area, click the "Add" buttn 2. Create the fllwing parameters: Parameter Name DataSurce Type System.String HigherEdDW_CnnectinString System.String InitialCatalg Direct Prperty Replacement System.String Value lcalhst Data Surce=lcalhst;Initial Catalg=HigherEdDWTesting;Integr ated Security=True HigherEdDWTesting

76 Users can map parameters t prperties within the LegiTest's Parameter area. This is the mst basic frm f parameter mapping. Direct prperty replacement cmpletely replaces the entire prperty value with the value specified. 1. Frm the test suite's parameter area, click the Parameter Mappings' "Add" buttn 2. The next windw displays an rganized list f all available element prperties. Navigate t the HigherEdDW cnnectin asset and select its CnnectinString prperty. 3. Within the parameter drp dwn list, select the HigherEdDW_CnnectinString parameter 4. Click "Ok" Parameter Tken Replacement

77 Using parameter tken replacement, users can replace prtins f a prperty. This allws users t replace pieces f a prperty instead f the entire prperty. When using this methd, LegiTest interprets these as a parameter. {{ParameterName}} All actins that rely n the HigherEdDW asset nw use the HigherEdDW_CnnectinString parameter. The Dim_Dnr package still cntains cnnectin managers pinting t the riginal database. The package's cnnectin managers need parameter mappings as well Within SSDT r BIDS, select each f the cnnectin managers and view its prperties. Cpy ut the cnnectin's cnnectin string prperty. This cnnectin string prperty will frm the baseline fr the parameter tken replacement. D this fr bth cnnectin strings. Belw are the riginal values fr the cnnectin strings. Cnnectin String HigherEdDW_ADO HigherEdDW_OLEDB Value Data Surce=lcalhst,1433;Initial Catalg=HigherEdDW;Integrated Security=True;Applicatin Name=SSIS-InvalidPackage-{C15B09F B38A44F-69C9A98C8612}lcalhst,1433.HigherEdDW; Data Surce=lcalhst,1433;Initial Catalg=HigherEd;Prvider=SQLNCLI11.1;Integrated Security=SSPI;Aut Translate=False; 3. Back within LegiTest, select the HigherEdETL_Dim_Dnr_DataCmpare nde. 4. Add a Set Prperty actin within the Grup Initializatin steps.

78 5. Replace the Data Surce and Initial Catalg within the cnnectin strings. Belw, with emphasis, are the replaced values fr the cnnectin strings. Cnnectin String HigherEdDW_ADO HigherEdDW_OLEDB Value Data Surce={{DataSurce}},1433;Initial Catalg={{InitialCatalg}};Integrated Security=True;Applicatin Name=SSIS-InvalidPackage-{C15B09F B38A44F-69C9A98C8612}lcalhst,1433.HigherEdDW; Data Surce={{DataSurce}};Initial Catalg={{InitialCatalg}};Prvider=SQLNCLI11.1;Integrated Security=SSPI;Aut Translate=False; 6. Select bth Cnnectins and replace the CnnectinString with their mdified value 7. There shuld be tw CnnectinString prperty values that were changed. Once fr HigherEdDW_ADO and again fr HigherEdDW_OLEDB.

79 Envirnment Tken Replacement Using envirnment tken replacement, users can use system envirnment variables t replace prtins f a prperty. This allws users t replace pieces f a prperty instead f the entire prperty. When using this methd, LegiTest interprets these as a parameter. %EnvirnmentVariableName% The steps t using envirnment tken replacement are identical t parameter tken replacement. Created with the Standard Editin f HelpNDc: What is a Help Authring tl?

80 Settings Files and Glbal Parameters Settings Files and Glbal Parameters Settings files The previus tutrial explained hw t use parameters within Visual Studi. Within the MSTest and nunit cmmand line LegiTest can use setting files. These setting files cntrl parameters during runtime. LegiTest even generates the file fr yu when building the prject. This parameters file is lcated within the utput flder. 1. When a test runs, LegiTest lks in the fllwing lcatins fr setting files (in this rder): The directry where the test assembly is lcated %PROGRAMDATA%\PragmaticWrks\LegiTest (e.g. C: \PrgramData\PragmaticWrks\LegiTest) %USERPROFILE%\Dcuments\PragmaticWrks\LegiTest (e.g. C: \Users\jsmith\Dcuments\PragmaticWrks\LegiTest) After this search is dne, the same set f directries is searched again, fr legitestsettings files that have the crrect 'applicabletestsuiteid' attribute. Helpful Tip In rder t find the crrect 'applicabletestsuiteid' fr a test grup / suite, pen up the file in ntepad and lk fr the 'uniqueid' attribute n the TestSuite nde in the xml. Any settings that are fund in a lcatin later in the list will ver-ride any that are fund previusly. S - fr example, a setting called 'TargetServer' in the directry where the assembly is lcated will be ver-ridden by a setting called 'TargetServer' in the user prfile directry. Hwever, a setting called 'TargetServer' in a file that has the applicabletestsuiteid attribute crrectly set and exists in the assembly directry wuld ver-ride the same setting frm a file in the user prfile where the applicabletestsuiteid was nt present. T clarify, the fllwing is a list f lcatins, in increasing rder f imprtance: Assembly directry withut applicabletestsuiteid attribute %PROGRAMDATA% withut applicabletestsuiteid attribute %USERPROFILE% withut applicabletestsuiteid attribute Assembly directry with applicabletestsuiteid attribute %PROGRAMDATA% with applicabletestsuiteid attribute %USERPROFILE% with applicabletestsuiteid attribute Imprtant Nte Pragmatic Wrks recmmends using the Prgram Data lcatin t stre legitestsettings files. These

81 Imprtant Nte directries can hld many *.legitestsettings files, the file names are nt imprtant. LegiTest nly searches fr files with the *.legitestsettings extensin. We recmmend renaming setting files after the tests they belng t. 2. Belw is sample cntent f a settings file: <?xml versin="1.0" encding="utf-8"?> <ParameterSet applicabletestsuiteid="a3856bd9-e9fe-460e-bf eff9458a"> <Parameters> <Parameter name="highereddw_cnnectinstring" type="system.string" value="data Surce=lcalhst;Initial Catalg=HigherEdDWTesting;Integrated Security=True" /> <Parameter name="datasurce" type="system.string" value="lcalhst" /> <Parameter name="initialcatalg" type="system.string" value="highereddwtesting" /> </Parameters> <Mappings> <Mapping parametername="highereddw_cnnectinstring" targetelementid="bea91e70-8d45-480f-8c63-f568388cf8dd" targetprpertyname="cnnectinstring" /> </Mappings> </ParameterSet> 1. applicabletestsuiteid: Assciates the cllectin f parameters and mappings with the test suite that has that specific identifier. Only test suites with the crrespnding id will use this setting file. Imprtant Nte Glbal Parameters are parameters within a settings file that dn't include an applicabletestsuiteid. In such a scenari, all test suites executed n that machine wuld use thse glbal parameters. Mre details regarding the usage f glbal LegiTest Setting files and parameters can be fund belw. 2. targetelementid: Assciates a parameter value t a specific element within the test suite using the element's unique identifier. The targetprpertyname attribute reference's the specific prperty that the parameter value will replace. Glbal parameters In the previus tutrial, we parameterized nly the cnnectin strings f a test suite. LegiTest can use parameters thrughut all its actins, asserts, and assets. The Query asset is anther gd example where parameters wuld be useful. Thrugh the use f parameters, users can transitin between many envirnments. Parameters help keep the testing prcess flwing thrugh the varius stages f develpment. Glbal Parameters are parameters applied t all test suite executins n a machine. When mdifying a settings file, remving the applicabletestsuiteid creates a glbal settings file. The mst cmmn use wuld be between publishing LegiTest assemblies t LegiTest Server. <?xml versin="1.0" encding="utf-8"?> <ParameterSet> <Parameters> <Parameter name="highereddw_cnnectinstring" type="system.string" value="data Surce=lcalhst;Initial Catalg=HigherEdDWTesting;Integrated Security=True" /> <Parameter name="datasurce" type="system.string" value="lcalhst" />

82 <Parameter name="initialcatalg" type="system.string" value="highereddwtesting" /> </Parameters> </ParameterSet> Glbal parameters allw the establishment f cmmnly named parameters acrss all envirnments. After publishing t a new envirnment, future executins use that envirnment's settings file. The mst cmmn use wuld be redirecting cnnectin strings between database deplyments. Imprtant Nte Pragmatic Wrks recmmends using the Prgram Data lcatin fr glbal legitestsettings files. Thugh users can have mre, we recmmend nly ne glbal file per machine. Created with the Standard Editin f HelpNDc: Full-featured Dcumentatin generatr

83 Parameter Replacement Methds Parameter Replacement Methds Elements, Assets and Assertins within LegiTest can use parameters in ne f three replacement methds Direct Prperty Replacement: Users can map a parameter t a prperty within the test suite / grup Parameter Tken Replacement: Users can insert tkens within a prperty value. When using this methd, LegiTest interprets these as a parameter. {{ParameterName}} Envirnment Variable Replacement: Users can insert system envirnment variables within a prperty value. When using this methd, LegiTest interprets these as envirnment variables. %EnvirnmentVariableName% At test executin, LegiTest replaces all parameters with the supplied value. This parameter replacement ccurs regardless f the methd used. Fr examples f the parameter replacement methds in use, please see the Parameter Tutrial. Imprtant Nte Direct Prperty Replacement is the nly methd f mapping a parameter t a value that is nt a string. Frmatting Parameters Smetimes it is necessary t frmat ur parameters. Fr example, cnsider the SQL Query: SELECT * FROM [MyTable] WHERE [LastMdifiedDate] >= '{{PrcessingDate}}' In this example, we wuld like the parameter t be frmatted as fur digits fr the year, tw fr the mnth and tw fr the day. We can use filters that are defined by the DtLiquid markup t frmat the parameters as we wuld like: SELECT * FROM [MyTable] WHERE [LastMdifiedDate] >= '{{PrcessingDate date:"yyyymmdd"}}' A reference f the available filters can be fund n the DtLiquid fr Designers page. Created with the Standard Editin f HelpNDc: Full-featured multi-frmat Help generatr

84 Actins Actins The varius actin elements are used t perfrm actins such as mve, create, delete, r cpy directries r files. These actins are als used t gather data using SQL cmmands t be cmpared in the assertin steps. Table f Cntents Clud Execute REST Query (Grid) Execute REST Query (Scalar) Execute SalesFrce Query Grid Data Management Data Generatin Execute Query Cmmand Execute Query Grid Execute Query Scalar Extract Grid Checksum Filter Grid Get Grid Rw Cunt Lad Delimited File Lad Grid Frm Asset Directry Directry Cpy Directry Create Directry Delete Directry Mve File File Cpy File Create File Delete File Line / Match Cunt File Mve Miscellaneus Execute Prcess Lad Asset Read Histrical Results Timing End Timing Start XPath Extract SSAS Prcess Cube Prcess Database Prcess Dimensin SSIS Execute Package Execute Task Get Prperties Lad Package Set Prperties SSRS Execute Reprt

85 Created with the Standard Editin f HelpNDc: Easy EBk and dcumentatin generatr

86 Clud Clud Actins Clud actins are respnsible fr gathering data by cnnecting t Salesfrce r ther sites that prvide a REST API. Each actin can be used t fulfill a unique rll within a test: They can prepare tests by ensuring the expected results are up t date. Clean-up an envirnment befre r after a test executin. Table f Cntents Execute REST Query (Grid) Execute REST Query (Scalar) Execute Salesfrce Query Grid Created with the Standard Editin f HelpNDc: Full-featured Dcumentatin generatr

87 Execute REST Query (Grid) Execute REST Query (Grid) The Execute Rest Grid perfrms HTTP Request. It parses and stres the respnse (table) values int a resurce grid. Rest Cnnectin - The clud cnnectin created in the test grup level r test level asset. Endpint URL - The web address that accepts the web request. Endpints can use the fllwing actins: Get - Retrieves infrmatin frm the endpint. Pst - A request that the endpint perfrm "smething" with the prvided infrmatin. Settings Tab Results Frmat - Users select whether results will be returned in Jsn r Xml frmat.

88 Cntent Type - The infrmatin needed t send in the header (ie. applicatin\jsn, applicatin\javascript, applicatin\xml, etc.) Rt Jsn Path - Jsn can return results that have several rt bjects. Each bject cntains crrespnding data. Identifying the rt will nly return the results fr that rt. Example: { "data": { "id" : "1", "data1clumn": "test1" } "data2": { "data2key": "1", "data2clumn:" "test2" } } Setting the rt Jsn path t "data" will nly return the results "id" and "data1clumn." Setting the rt Jsn path t "data2" will nly return "data2key" and "data2clumn" results. Timeut (s) - Sets the amunt f time (in secnds) the request shuld fail if there is n respnse frm the web service. Number f retires - Sets the number f attempts t cnnect befre the executin fails and reprts an errr. Resurce key - Identifies the tile's name. This name helps users if it needs t be used in the Executin Track, Assert, r Teardwn steps f the test. Grid Clumn(s) - The user defined clumn names, tken paths, and data types fr each clumn. Using the Jsn example abve, users can add 2 clumns with the data rt Jsn path. Example: Clumn Name ID NameOfTest Tken Path id data1clumn Data Type System.Int64 System.String Clumn Name are user-defined. The tken path must be exactly the same as the path it is pinting t in the returned Jsn data. (Ntice "id" and "data1clumn" paths identified in the Jsn example abve.) Headers Tab - Headers are simply infrmatin abut the type f data returned. Users can add and remve headers by clicking the crrespnding buttns. Once a header is added, click in its crrespnding name and value fields t cnfigure them.

89 Cursr / Paging Settings Tken Path - Identifies the child tken being used. Is Return Value URL - Select ptin if the Tken Path is a URL. Query String Parameter - Identifies the (ptinal) parameters needed t cmplete the Jsn request. Cursr Finished Value - The value needed t identify the utput data is cmplete.

90 Test Results Tab Click the Test buttn t see the results returned based n the cnfiguratin in the previus tabs. Created with the Standard Editin f HelpNDc: Easily create HTML Help dcuments

91 Execute REST Query (Scalar) Execute REST Query (Scalar) The Execute Rest Query (Scalar) perfrms HTTP Requests that parses and stres the respnse value int a resurce grid. Rest Cnnectin - The clud cnnectin created in the test grup level r test level asset. Endpint URL - The web address that accepts the web request. Endpints can use the fllwing actins: Get - Retrieves infrmatin frm the endpint. Pst - A request that the endpint perfrm "smething" with the prvided infrmatin. Settings Tab Results Frmat - Users select whether results are returned in Jsn r Xml frmat.

92 Cntent Type - The infrmatin needed t be sent in the header (ie. applicatin\jsn, applicatin\javascript, applicatin\xml, etc.) Rt Jsn Path - Jsn can return results that have numerus rt bjects with crrespnding data fr each rt. Identifying the rt will nly return the results fr that rt. Example: { "data": { "id" : "1", "data1clumn": "test1" } "data2": { "data2key": "1", "data2clumn:" "test2" } } Setting the rt Jsn path t "data" will nly return the results "id" and "data1clumn." Timeut (s) - Sets the time (in secnds) the request actin shuld take place befre it is determined t be a failure. Number f retires - Sets the number f attempts t cnnect befre the executin fails and reprts an errr. Resurce key - Identifies the tile's name t be easily identified shuld it need t be called in the Executin Track, Assert, r Teardwn steps f the test. Grid Clumn(s) - The user defined clumn names, tken paths, and data types fr each clumn. Using the Jsn example abve, users can add 2 clumns with the data rt Jsn path. Example: Clumn Name ID NameOfTest Tken Path id data1clumn Data Type System.Int64 System.String Clumn Name can be user-defined, hwever, the tken path must be exactly the same as the path it is pinting t in the returned Jsn data (ntice "id" and "data1clumn" paths identified in the Jsn example abve.) Headers Tab - Headers are simply infrmatin abut the type f data returned. Users can add and remve headers by clicking the crrespnding buttns. Once a header is added, click in its crrespnding name and value fields t cnfigure them.

93 Test Results Tab Scalar Value - Users can add their wn data t ppulate the clumn nly when testing their cnfiguratin. Click the Test buttn t see the results returned based n the user's cnfiguratin in the previus tabs.

94 Created with the Standard Editin f HelpNDc: Free help authring envirnment

95 Execute Salesfrce Query Grid Execute Salesfrce Query Grid The Execute Salesfrce Query Grid actin allws the user t execute a query t gather a data grid frm Salesfrce. Execute Salesfrce Query Grid Editr Batch Size - This ptin allws the user t set the amunt f recrds retrieved frm Salesfrce per trip. The max recrds in a batch is Cnnectin asset - The cnnectin asset will cntain the cnnectin string t the Salesfrce surce. Disk based - The user can select this ptin will then stre the results n disk instead f n memry. This ptin is recmmended fr large result sets. Include deleted - Checking this ptin will include deleted recrds in the result set. Query asset - The asset which cntains the query t be executed. Resurce key - The name given t the results that is then stred in the Test Resurces. Created with the Standard Editin f HelpNDc: Generate Kindle ebks with ease

96 Execute Salesfrce Query Scalar Execute Salesfrce Query Scalar The Execute Salesfrce Query Scalar actin allws the user t execute a query that gathers a single value frm Salesfrce. Execute Salesfrce Query Grid Editr Cnnectin asset - The cnnectin asset will cntain the cnnectin string t the Salesfrce surce. Expected type - Defines the expected datatype that is returned. Query asset - The asset which cntains the query t be executed. Resurce key - The name given t the results that is then stred in the Test Resurces. Created with the Standard Editin f HelpNDc: Create help files fr the Qt Help Framewrk

97 Data Management Data Management Actins Data Management actins are respnsible fr gathering and / r manipulating data. Each actin can be used t fulfil a unique rle within a test: They can prepare tests by ensuring the expected results are up t date. Clean-up an envirnment befre r after a test executin. Summarize data in preparatin fr asserts Generate test data fr usage within a test Table f Cntents Data Generatin Execute Query Cmmand Execute Query Grid Execute Query Scalar Extract Grid Checksum Filter Grid Get Grid Rw Cunt Lad Delimited File Lad Grid Frm Asset Created with the Standard Editin f HelpNDc: Free help authring tl

98 Data Generatin Data Generatin The Data Generatin actin creates data using a BI xpress' Data Generatin slutin. Required Assets Cnnectin Data Generatin Slutin Once the editr has laded, the user will need t input the fllwing prperties: 1. Cnnectin Asset: The cnnectin string used during data generatin. 2. Data Generatin Slutin Asset: The prperty stres the lcatin t the BI xpress Data Generatin slutin. Created with the Standard Editin f HelpNDc: Easily create iphne dcumentatin

99 Execute Query Cmmand Execute Query Cmmand The Execute Query Cmmand actin will take a query cmmand specified by the user and run it against the lcatin specified by the user. This element uses varius assets t accmplish quickly filling in the required infrmatin. Execute Query Cmmand Editr Cnnectin Asset - The cnnectin asset t be used, this determines which database the cmmand is run against. Query Asset - The query cmmand t be executed. Timeut - Cntrls hw lng the cmmand will run befre failing with a timeut. Created with the Standard Editin f HelpNDc: Easy CHM and dcumentatin editr

100 Execute Query Grid Execute Query Grid The Execute Query Grid actin will run a query against a cnnectin, then stre the infrmatin gathered int the resurce key defined in the element's editr. This element is used fr retrieving a grid f infrmatin t be cmpared in the assertin step. If the query pulls multiple grids, yu can specify which grid t use using the Result set index. The default is 0, which is the first result set pulled. Execute Query Grid Editr Cnnectin Asset - The cnnectin t be used fr cnnecting t the data surce. Disk Based - Tggles whether the grid shuld be stred n disk r in memry. Tggle n fr larger grids. Query Asset - The query t be run against the cnnectin. Result Set Index - Selects which result set t use if multiple sets are returned frm the query. Timeut - Cntrls hw lng the query will run befre failing with a timeut. Created with the Standard Editin f HelpNDc: Create HTML Help, DOC, PDF and print manuals frm 1 single surce

101 Execute Query Scalar Execute Query Scalar This actin is used t retrieve a single piece f data t be cmpared. The data retrieved is then stred in the resurce key defined in the element's editr. Execute Query Scalar Editr Cnnectin Asset - The cnnectin t be used fr the query. Query Asset - The query t be run against the cnnectin. Resurce Key - The resurce key where the data is stred frm this element. Timeut - Cntrls hw lng the query will run befre failing with a timeut. Created with the Standard Editin f HelpNDc: Free CHM Help dcumentatin generatr

102 Extract Grid Checksum Extract Grid Checksum The Extract Grid Checksum actin gives a user a simple and quick way t check fr changes in a grid set. This actin wuld be used in cnjuctin with an integer cmpare assert. The grid checksum takes in a grid, and then returns ut an integer that represents it's current state. This integer state can then be cmpared t anther integer t see if there has been any changes t the structure r cntent f the grid. Extract Grid Checksum Editr Grid Resurce - The grid in which t extract the checksum. Target Resurce Key - The name given t the result in the Test Resurces. This key is used when ppulating an assert. Created with the Standard Editin f HelpNDc: Generate Kindle ebks with ease

103 Filter Grid Filter Grid The Filter Grid actin prvides a way t filter an already laded grid. If pssible, avid using this actin. Fr example - if the grid being laded cmes frm an Execute Query Grid actin, then mdifying the query t perfrm the filtering at surce will perfrm better. It is nt always pssible t run sufficient filtering at surce - and this is why the filter grid actin is present. Filter Grid Editr Grid t filter - The grid which shuld be filtered. Filter expressin - The filter expressin t use. Fr mre infrmatin abut filter expressins, please see the filtering tpic. Created with the Standard Editin f HelpNDc: Full-featured Help generatr

104 Get Grid Rw Cunt Get Grid Rw Cunt The Get Grid Rw Cunt actin is a simple that actin that takes in a grid and returns the amunt f rws in the grid. Get Grid Rw Cunt Editr Grid - The grid t get the rw cunt frm. Resurce key - The name given t the result stred in the Test Resurces. Created with the Standard Editin f HelpNDc: Free EPub and dcumentatin generatr

105 Lad Flat File Data Lad Flat File Data The lad flat file data actin will lad flat file data int a resurce key fr cmparisn / validatin. The lad flat file data actin lads data frm the fllwing types f asset: Delimited File Reference Delimited Cntent Fixed Width File Reference Lad Flat File Data Editr Flat data - The Delimited File Reference Asset, Delimited Cntent Asset r Fixed Width File Reference Asset that cntains the infrmatin abut the file t lad. Resurce Key - Name f the resurce key t stre the results in. Lw memry mde - If true, then the grid is laded in lw memry mde - meaning that the data is stred in a temprary file. Edit Filter - Pressing this buttn will bring up the filtering windw that allws a SQL-like filter expressin t be applied t select data.

106 Selected clumns - This area allws the user t select which clumns will be laded frm the flat file data. Created with the Standard Editin f HelpNDc: Create iphne web-based dcumentatin

107 Lad Grid Frm Asset Lad Grid Frm Asset The lad grid frm asset actin will lad the grid defined by a grid cllectin asset int a resurce key fr cmparisn. Lad Grid Editr Asset - The Grid Cllectin asset t be used. Grid Index - The index f the grid t be laded int the resurce key. Default is 0. Resurce Key - Name f the resurce key t stre the results in. Created with the Standard Editin f HelpNDc: Easily create PDF Help dcuments

108 Directry Directry Actins The Directry actins give the user cntrl ver creating, mving, cpying, and deleting directries fr use in develping tests. Table f Cntents Directry Cpy Directry Create Directry Delete Directry Mve Created with the Standard Editin f HelpNDc: Free EBk and dcumentatin generatr

109 Directry Cpy Directry Cpy Directry cpy is used t cpy ne directry t anther lcatin. If the directry trying t be cpied des nt exist, then it will fail the test. Directry Cpy Editr Overwrite - Enable verwriting f directry cntents at the target. If disabled, and the user tries t cpy ver existing cntent, the test will fail. Surce - The lcatin f the directry t be cpied. Target - The lcatin t cpy the directry t. Created with the Standard Editin f HelpNDc: Create HTML Help, DOC, PDF and print manuals frm 1 single surce

110 Directry Create Directry Create This actin is used t create a directry at a user defined lcatin. Directry Create Editr Target - Lcatin t create the directry at. Created with the Standard Editin f HelpNDc: Free EBk and dcumentatin generatr

111 Directry Delete Directry Delete Used t delete the target directry. This actin has recursive and strict ptins that can be used t cntrl the behavir f the test. Directry Delete Editr Recursive - If enabled, the element will delete all sub-directries and files. If disabled and the target directry has cntent, then the test will fail. Strict - If enabled, and the target des nt exist, then the test will fail. If disabled and the target des nt exist, then the test will cntinue n as nrmal. Target - Lcatin f directry t be deleted. Created with the Standard Editin f HelpNDc: Free Qt Help dcumentatin generatr

112 Directry Mve Directry Mve This actin will mve a directry frm ne lcatin t anther. The user may als specify t verwrite a directry's cntents if the target lcatin already exists. Directry Mve Editr Overwrite - Overwrites the cntent f the target directry if it already exists. Surce - Lcatin f the flder t be mved. Target - Lcatin t mve the surce flder. Created with the Standard Editin f HelpNDc: Free help authring envirnment

113 Lad Directry Cntent Lad Directry Cntent The lad directry cntent actin lads the cntent f a directry int a grid. This can be useful fr verifying that a list f files matches an expected set, r fr use within data driven testing t allw a test t be run fr each file in a directry. Directry reference - This is the directry reference asset that stres the path t the directry t lad. Click n the arrw t select the asset t use. Resurce key - This is the resurce key f the grid that will be laded. Include files in sub-directries - Tick this t lad files in sub-directries as well as the selected path. Wild card - This is the wild card used t select files - it culd be f the frm '*.txt' r 'Reprt*.*'. Fr mre cmplicated restrictins, use the filter. Edit filter - Use this buttn t edit the filter f files t lad. Fr mre infrmatin abut filtering, please see the filtering tpic.

114 Created with the Standard Editin f HelpNDc: Easily create Help dcuments

115 File File Actins The varius file actins give the user cntrl ver creating, deleting, mving, and cpying files t be used in the testing prcess. Table f Cntents File Cpy File Create File Delete File Line / Match Cunt File Mve Created with the Standard Editin f HelpNDc: Free HTML Help dcumentatin generatr

116 File Cpy File Cpy The file cpy actin is used t cpy a file frm ne lcatin int anther. If the file t be cpied des nt exist then the test will fail. File Cpy Editr Overwrite - Determines if the element shuld verwrite an existing file at the target lcatin. If this is nt checked, and the file already exists at the target lcatin, then the test will fail. Surce - Lcatin f the file t be cpied. Target - Lcatin t cpy the file t. Created with the Standard Editin f HelpNDc: Free Kindle prducer

117 File Create File Create The file create actin is used t create a file based n a text file asset. This will create the file with the infrmatin cntained in the text file asset. File Create Editr File Cntent Asset - The text t be put int the file upn creatin. Overwrite - Determines if the element shuld verwrite an existing file at the target lcatin. If this is nt checked, and the file already exists at the target lcatin, then the test will fail. Target - Lcatin t create the file. Created with the Standard Editin f HelpNDc: Create help files fr the Qt Help Framewrk

118 File Delete File Delete This actin is used t delete a file frm the target lcatin. If the file des nt exist, the user can cntrl if the test shuld fail r cntinue using the strict ptin. File Delete Editr Strict - Determines whether the test shuld fail r cntinue if the target file des nt exist. If checked, and the file des nt exist, the test will fail. Target - The lcatin f the file t be deleted. Created with the Standard Editin f HelpNDc: Easy CHM and dcumentatin editr

119 File Line / Match Cunt File Line / Match Cunt This actin will either cunt lines in a file, r matches accrding t a specified pattern. The result f the cunt is then stred in a resurce key t be used fr cmparisns in the assert step. File Line / Match Cunt Editr Line By Line - Tggle n and ff t determine if matches shuld be evaluated a line at a time. Operatin Type - Specifies if the element is t cunt lines r matches. Pattern - This is the regular expressin that will be used t cunt matches. Target - The file t be cunted. Resurce Key - The result f the cunt is stred in the resurce key. Created with the Standard Editin f HelpNDc: Write ebks fr the Kindle

120 File Mve File Mve The file mve actin will mve the file frm ne lcatin t anther. The user can specify if the element shuld verwrite an existing file r nt. File Mve Editr Overwrite - Tggle n and ff t specify if th element can verwrite a file that already exists. If turned ff, and the file exists at the target lcatin, then the test will fail. Surce - The lcatin f the file t be mved. Target - Where the file will be mved t. Created with the Standard Editin f HelpNDc: News and infrmatin abut help authring tls and sftware

121 Miscellaneus Miscellaneus Actins Table f Cntents Execute Prcess Lad Asset Read Histrical Results Timing End Timing Start XPath Extract Created with the Standard Editin f HelpNDc: Easily create EPub bks

122 Execute Prcess Execute Prcess This actin will launch an exe specified by the user, the exit cde f the exe launched will be stred in the resurce key defined n this element. This can then be used fr cmparisn later in the assert step. Execute Prcess Editr Arguments - The user can enter in cmmand line arguments t launch this prgram with. Executable - The lcatin f the.exe file t be executed. Resurce Key - User defined key that the exit cde f the.exe is stred in. Created with the Standard Editin f HelpNDc: Full-featured Dcumentatin generatr

123 Lad Asset Lad Asset The Lad Asset actin allws a user t lad a text file int the resurce bag s that it can be used in asserts. This helps t bypass the need f writing the cntent f the asset t a file befre cmparing it. Lad Asset Editr Text file asset - The text file asset t be laded. Resurce Key - The name f the resurce key t be assigned. Created with the Standard Editin f HelpNDc: Qt Help dcumentatin made easy

124 Read Histrical Results Read Histrical Results The Read Histrical Results actins allws a user t specify a past run f an assert, grab that results, and cmpare it t a mre recent r previus result. This will allw a user t cmpare results ver time t and keep track f test quality ver time. Imprtant Nte The Read Histrical Results actin nly wrks with test suites / grups that publish their results t LegiTest Server r LegiTest Online. Fr mre infrmatin abut server integratin, please see the tpic here. Read Histrical Results Editr Surce Element - Clicking the Select Surce Element will bring up a selectin diague t allw the user t select an assert frm the suite / grup. Target Resurce Key - The name assigned t the result that is stred in the Test Resurces. Retrieval Mde - There are three retrieval mdes available t chse frm: Retrieve result frm the mst recent test run - This ptin will get the result frm

125 the very last time this assert was run. Retrieve result frm a previus test run - This ptin will bring up anther ptin t be filled in: Number f Runs. This field determines which run t get, 1 wuld be the previus run, 2 wuld be tw runs ag and s n. Retrieve the result frm a test run between tw dates/times - This ptin will bring up tw new fields, Start Date and End Date. Here a user will select a start and end time fr searching fr a result, then the first assert in that time frame will be used. Default Result Surce - The default result surce is used when the actin is nt able t retrieve an existing assert in the ptins prvided Created with the Standard Editin f HelpNDc: Qt Help dcumentatin made easy

126 Timing End Timing End The Timing End actin is used alng side the Timing Start actin. This actins serves as the endpint fr measuring the number f secnds that have elapsed between the start and end. Timing End Editr Timing start pint - The starting pint t begin timing. This will bring up a list f available Timing Start actins t chse frm. Resurce Key - The name given t the number f secnds measured that are stred in the Test Resurces. Created with the Standard Editin f HelpNDc: iphne web sites made easy

127 Timing Start Timing Start The Timing Start actin is used alng side f a Timing End actin. When the test hits the Timing Start actin, it starts cunting the number f secnds elapsed, and nce the test hits a Timing End actin, the number f secnds are then stred in the Test Resurces using the Resurce Key specified by the Timing End actin. Timing Start Editr There is nthing t edit fr a Timing Start actin. The cnnectin f a start t an end is handled in the Timing End actin. Created with the Standard Editin f HelpNDc: Full-featured Help generatr

128 XPath Extract XPath Extract The XPath Extract actin is used with an Execute Reprt actin t extract infrmatin frm the reprt. The user will select the resurce key f the reprt that was previusly executed, and then supply the xpath f the infrmatin they want t retrieve. The infrmatin extracted is then stred in anther resurce key that can then be used with ne f the assert actins t verify the validity f the data. If multiple ndes are matched, then nly the value f the first will be returned. If n infrmatin is fund at the nde that the path is directed t, then the user can specify if the test shuld fail r cntinue. XPath Extract Editr Fail if nde nt fund - This allws the user t specify whether r nt t fail the test if a nde can nt be fund. Path - The XPath t apply t the XML t retrieve the value. Resurce Key - The resurce key f the XML. Target Resurce Key - The resurce key t stre the extracted value. Created with the Standard Editin f HelpNDc: Easy EBk and dcumentatin generatr

129 SSAS SSAS Actins The SSAS actins bring cubes, dimensins, databases r tables t a full prcessed state. Users can chse which prcessing mde t use depending n their preferences. These actins prepare a test by ensuring they are nly testing against updated bjects. Table f Cntents Prcess Cube Prcess Database Prcess Dimensin Prcess Table Created with the Standard Editin f HelpNDc: Free EPub and dcumentatin generatr

130 Prcess Cube Prcess Cube The Prcess cube actin helps bring a cube t a fully prcessed state. This actin helps prepare a test by ensuring it is nly testing against an updated cube. Imprtant Nte The Prcess Cube actin supprts the fllwing mdel types using the listed cmpatibilty levels: Multidimensinal Mdel with cmpatibility level 1050 and higher Tabular Mdel with cmpatibility levels belw 1200 Use the Prcess Table actin t prcess Tabular tables set t cmpatibility levels 1200 r higher. Once the editr has laded, the user will need t input the fllwing prperties: 1. Server: The server lcatin fr the cube the user is planning t prcess. Click "Cnnect" t lad all cubes stred n the server. 2. Prcess Mde: Users can chse which prcessing mde t use depending n their preferences: Default: Des the smallest amunt f wrk required t bring the selected cube t a fully prcessed state Full: Discards the data frm the selected cube and cmpletely rebuilds it Data: Discards the data frm the selected cube and rebuilds the data withut building indexes Clear: Discards the data frm the selected cube Index: Rebuilds the indexes fr the selected cube. This requires the cube t already have its data built Defrag: Optimizes the selected cube

131 Fail n Prcess Fail: Determins if the test shuld als fail if the prcess cube actin fails Selected: Displays the currently selected cube. Server Tree: After cnnecting, the server tree displays all available cubes. Created with the Standard Editin f HelpNDc: Free PDF dcumentatin generatr

132 Prcess Database Prcess Database The Prcess Database actin helps bring a cube t a fully prcessed state. This actin helps prepare a test by ensuring it is nly testing against an updated database. Once the editr has laded, the user will need t input the fllwing prperties: 1. Server: The server lcatin fr the database the user is planning t prcess. Click "Cnnect" t lad all databases stred n the server. 2. Prcess Mde: Users can chse which prcessing mde t use depending n their preferences: Default: Des the smallest amunt f wrk required t bring the selected database t a fully prcessed state Full: Discards the data frm the selected database and cmpletely rebuilds it Clear: Discards the data frm the selected database Fail n Prcess Fail: Determins if the test shuld als fail if the prcess database actin fails Selected: Displays the currently selected database. Server Tree: After cnnecting, the server tree displays all available databases. Created with the Standard Editin f HelpNDc: Create iphne web-based dcumentatin

133 Prcess Dimensin Prcess Dimensin The Prcess Dimensin actin helps bring a cube t a fully prcessed state. This actin helps prepare a test by ensuring it is nly testing against an updated dimensin. Once the editr has laded, the user will need t input the fllwing prperties: 1. Server: The server lcatin fr the dimensin the user is planning t prcess. Click "Cnnect" t lad all dimensins stred n the server. 2. Prcess Mde: Users can chse which prcessing mde t use depending n their preferences: Default: Des the smallest amunt f wrk required t bring the selected dimensin t a fully prcessed state Full: Discards the data frm the selected dimensin and cmpletely rebuilds it Data: Discards the data frm the selected dimensin and rebuilds the data withut building indexes Clear: Discards the data frm the selected dimensin Index: Rebuilds the indexes fr the selected dimensin. This requires the dimensin t already have its data built Update: Incrementally brings the selected dimensin t a fully prcessed state Fail n Prcess Fail: Determins if the test shuld als fail if the prcess dimensin actin fails Selected: Displays the currently selected dimensin. Server Tree: After cnnecting, the server tree displays all available dimensins. Created with the Standard Editin f HelpNDc: Easily create CHM Help dcuments

134 Prcess Table Prcess Table The Prcess Table actin helps bring a cube t a fully prcessed state. This actin helps prepare a test by ensuring it is nly testing against an updated table. Imprtant Nte The Prcess Table actin supprts the fllwing mdel types using the listed cmpatibilty levels: Tabular Mdel with cmpatibility levels abve 1200 Use the Prcess Cube actin t prcess Tabular tables set t cmpatibility levels belw Once the editr has laded, the user will need t input the fllwing prperties: 1. Server: The server lcatin fr the table the user is planning t prcess. Click "Cnnect" t lad all tables stred n the server. 2. Prcess Mde: Users can chse which prcessing mde t use depending n their preferences: Default: Des the smallest amunt f wrk required t bring the selected table t a fully prcessed state Full: Discards the data frm the selected table and cmpletely rebuilds it Data: Discards the data frm the selected table and rebuilds the data withut building indexes Clear: Discards the data frm the selected table Defrag: Optimizes the selected table Fail n Prcess Fail: Determins if the test shuld als fail if the prcess table actin fails Selected: Displays the currently selected table. Server Tree: After cnnecting, the server tree displays all available tables.

135 Created with the Standard Editin f HelpNDc: Easily create Web Help sites

136 SSIS SSIS Actins The SSIS actins allw testing f packages, their prperties, and their tasks. A package and be laded frm a package reference asset and then used t get it's prperties, set it's prperties, r select individual tasks t execute. Table f Cntents Execute Package Execute Task Get Prperties Lad Package Set Prperties Created with the Standard Editin f HelpNDc: Free Kindle prducer

137 Execute Package Execute Package The execute package actin allws the user t launch a package frm the test. The user can then decide if the test shuld fail n package failure r cntinue. Fail On Package Failure - Tggle n and ff t determine behavir f test n package failure. Package - The resurce key f the package t be executed. Resurce Key - The result f the package is placed in the resurce key. Created with the Standard Editin f HelpNDc: Free CHM Help dcumentatin generatr

138 Execute Task Execute Task The execute task actin is used tgether with a package reference and lad package element. The user will select the task they wish t execute and nce the test runs, nly the selected task will be perfrmed. Target Package - The resurce key f the package t be used frm a previus lad package actin. Resurce Key - The resurce key in which t stre the result f the package. Fail n task failure - Specify whether r nt t fail the test if the task being executed fails. Package Selectin Windw - A list f available task frm the chsen package will be listed here fr selectin. Created with the Standard Editin f HelpNDc: Easily create HTML Help dcuments

139 Get Prperties Get Prperties The get prperties actin is used t get the prperties f varius items f a package. One such use wuld be t get the value f a variable, r the type f a parameter r variable. Target Package - The package reference key frm the previus lad package actin. Prperties t get - A list f prperties t retrieve when this actin is run. Add - When the user clicks the add buttn, they are taken t the add prperty windw. Frm here the user will select the package, and then the bject, and then the prperty. The value f the prperty can be set t a resurce key defined at the tp f the editr. Edit - When the user clicks the edit buttn, they are brught back t the add screen with the selected prperty in fcus. Delete - Deletes the selected prperty frm the get list. Example: In this image, the data type f the cunt variable is being retrieved and stred in the resurce bag with the key CuntValue.

140 Created with the Standard Editin f HelpNDc: Free PDF dcumentatin generatr

141 Lad Package Lad Package The lad package prepares a package frm a package reference asset and gives it a resurce key t be used in anther element. Package Reference Asset - The package asset previusly defined. Resurce Key - Where the package is stred, the name is used t select the package in the execute package element. Created with the Standard Editin f HelpNDc: Full-featured Help generatr

142 Set Prperties Set Prperties The set prperties actins allws a user t set the prperties f a package during the test run. A user can set multiple prperties using just the ne element. Target Package - The reference key f the package t be used. Prperties t set - The list f prperties added t the element t be set. Add - Takes the user t the add prperty windw where they will select the prperty t be changed. Edit - Takes the use user t the add prperty windw with the fcus n the selected prperty. Delete - Deletes the selected prperty frm the set editr.

143 In this image the is having its value set t

144 Created with the Standard Editin f HelpNDc: Free help authring tl

145 SSRS SSRS Actins The available SSRS actin item allws the user t execute a reprt and stre the result fr cmparisn. Table f Cntents Execute Reprt Created with the Standard Editin f HelpNDc: Create iphne web-based dcumentatin

146 Execute Reprt Execute Reprt The execute reprt actin will run a reprt and stre the XML f the reprt int the resurce bag using the resurce key. This XML can then be used with an XPath extract actin t get a value frm a selected nde. Execute Reprt Editr Service Address - This is the server name fr the lcatin f reprts. Initial Path - The path t the reprt t be executed. Is SharePint - Tggle n and ff t specify if the reprt is SharePint r nt. Use Windws Authenticatin - Tggle n and ff t specify whether t use Windws Authenticatin r nt.

147 Resurce Key - The resurce key name t stre the data returned by running the reprt. Parameters - If the reprt has any parameters, then the UI will extend t allw input f these parameters. Created with the Standard Editin f HelpNDc: Single surce CHM, PDF, DOC and HTML Help creatin

148 Asserts Asserts The asserts are generally what determines if a test passes r fails. The data gathered thrugh the test and stred in resurce keys, can be used here t test fr actual vs expected results. Table f Cntents Data Management Grid Cmparisn Grid Validatin Directry Directry Existence File File Cntent Cmparisn File Existence Miscellaneus Integer Cmparisn Range Check Scalar Cmparisn Created with the Standard Editin f HelpNDc: Generate EPub ebks with ease

149 Data Management Data Management Asserts The data management asserts allw fr a quick and easy way t cmpare and validate data. These asserts can cmpare large amunts f data with ne simple assert. Table f Cntents Grid Cmparisn Grid Validatin Created with the Standard Editin f HelpNDc: Free HTML Help dcumentatin generatr

150 Grid Cmparisn Grid Cmparisn The grid cmparisn assert will cmpare tw grids, it expects bth sides t be equal. The user can specify different criteria fr the cmparisn t be made. Grid Cmparisn Editr Difference lg maximum size - This is the maximum number f rws t send t LegiTest server if the test suite / grup is cnfigured t send results t the server. Ignre aggregates - Tggle n and ff t specify if aggregate cmparisns shuld be ignred. Ignre different rws - Tggle n and ff t specify if rws that differ shuld be ignred. Ignre expected-nly rws - Tggle n and ff t specify if rws nly appearing in the expected grid shuld be ignred. Ignre actual-nly rws - Tggle n and ff t specify if rws nly appearing in the actual grid shuld be ignred. Include equal rws - Tggle n and ff t specify if rws that match are sent t LegiTest server. By

151 default, nly rws that differ r exist n nly ne side f the cmparisn are sent. Expected results grid - This is the grid f 'expected' results - i.e. the result set that we want ur test t match. A previus actin shuld lad the grid t a specific resurce key. Cmparisn manifest asset - This is the cmparisn manifest asset that determines what items are cmpared. Actual results grid - This is the grid f 'actual' results - i.e. the result set that ur test prduced. A previus actin shuld lad the grid t a specific resurce key. Test utput message rw limit - When the cmparisn fails an errr message is prduced and visible in the test runner. This specifies hw many detail rws may be included in that message. Created with the Standard Editin f HelpNDc: Prduce nline help fr Qt applicatins

152 Grid Validatin Grid Validatin Assertin The Grid Validatin Assertin is usedwith a Validatin Manifest. The assertin will use the rules utlined in the Validatin Manifest and run the asserts t validate the grid. Grid Validatin Assertin Editr Grid - The grid in which t run validatin against. Grid Validatin Manifest - The validatin manifest cntaining the validatin rules used in the assert. Created with the Standard Editin f HelpNDc: Easily create Web Help sites

153 Directry Directry Asserts Asserts fr testing against directries. Table f Cntents Directry Existence Created with the Standard Editin f HelpNDc: Easily create Web Help sites

154 Directry Existence Directry Existence The Directry Existence assert will check if a specified directry exists. Directry Existence Editr Exists - If checked, then the assert will check that the directry exists, if unchecked, it will check that the directry des nt exist. Target Directry Path - The path t the directry being checked. Created with the Standard Editin f HelpNDc: Create help files fr the Qt Help Framewrk

155 File File Asserts Asserts fr checking if a file exists, r t cmpare the cntents f files. Table f Cntents File Cntent Cmparisn File Existence Created with the Standard Editin f HelpNDc: Easy EBk and dcumentatin generatr

156 File Cntent Cmparisn File Cntent Cmparisn This assert is used t cmpare the cntents f tw files r the cntents f ne file against a File Cntent asset. The user can specify several parameters t meet their cmparisn needs. File Cntent Cmparisn Editr Cmparable File Surce - Select whether t cmpare a file t a File Cntent Asset r t anther file. Cmparisn File - If the user selected t cmpare a file t a file, this will be the cmparisn file's lcatin. Otherwise, if using a File Cntent Asset, this can be left blank. File Cntent Asset - If the user selected t use an asset t cmpare their file t, then the user wuld select the File Cntent Asset here. Ignre Case - Tggle n and ff t specify if the cmparisn shuld ignre letter case. Ignre Line Endings - Tggle n and ff t specify if the cmparisn shuld ignre line endings. Target - The lcatin f the file being cmpared. Trim Spaces - Tggle n and ff t specify if spaces n the end f the file shuld be ignred. Created with the Standard Editin f HelpNDc: Generate EPub ebks with ease

157 File Existence File Existence The File Existence assert will check if a specified file exists. File Existence Editr Exists - If checked, then the assert will check that the file exists, if unchecked, it will check that the file des nt exist. Target File Path - The lcatin f the file t be checked. Created with the Standard Editin f HelpNDc: Generate Kindle ebks with ease

158 Miscellaneus Miscellaneus Asserts A cllectin f asserts that can cmpare a variety f bject types. Table f Cntents Expressin Integer Cmparisn Range Check Scalar Cmparisn Value Cmparisn Xml Cmparisn Created with the Standard Editin f HelpNDc: Create help files fr the Qt Help Framewrk

159 Expressin Expressin The expressin assertin is an assertin that lets yu enter a free-frm expessin in rder t be able t use mre pwerful cmbinatinal lgic in rder t validate that ne r mre resurce values are crrect. Expressin Editr Language allws yu t select the expressin language - currently nly the 'SimpleFilter' language is available. Belw that is the filter expressin, alng with sme helper cntrls that allw yu t easily add items t the expressin. T add a clause t the expressin, simply select the resurce in the left hand cmb bx, chse the peratr in the middle cmb bx and type the value yu require in the right hand text bx. Clicking the '+' buttn will then add the specified clause t the expressin. Fr mre infrmatin abut filter expressins, please see the filtering tpic. Help n the filtering language is als available in the editr directly by clicking n the '?' icn in the bttm right.

160 Helpful Tip Often when filtering, whether in SQL r using LegiTest filters, the identifiers relate t field names. In this instance, the identifiers relate t resurce keys. Fr example, if there was an Execute Query Scalar actin which generated a resurce called 'MyScalarValue' then the expressin culd include a clause such as '[MyScalarValue] > 10' Created with the Standard Editin f HelpNDc: Prduce electrnic bks easily

161 Integer Cmparisn Integer Cmparisn Imprtant Nte The Integer Cmparisn assertin is nw deprecated. While existing prjects can still cntinue t use it, new prducts shuld migrate t using the Value Cmparisn assertin. The integer cmparisn assert will test tw integers fr different levels f equality. The user can specify t test fr greater than, less than, r even user defined tlerances. The integer t cmpare yur actual value t can either be a static value defined in the element's editr, r frm anther resurce key. Integer Cmparisn Editr Cmparable Resurce Key - If the user pts nt t use a static value t cmpare t, they wuld select a resurce key here t cmpare against. Cmparable Value Surce - Specifies if the element shuld use a static value r a resurce key t make the cmparisn with. Cmparisn Mde: Equal - Asserts that the tw integers are equal. NtEqual - Asserts that the tw integers are nt equal. LessThan - Asserts that the integer is less than the static value r resurce. GreaterThan - Asserts that the integer is greater than the static value r resurce.

162 Within Percentage Tlerance - Asserts that the integer is within a specified percent f the static value r resurce. Within Fixed Tlerance - Asserts that the integer is within the specified tlerance range f the static value r resurce. Cmparisn Value - The static value t be used if the user pts fr static value ver resurce. Resurce Key - The resurce key f the integer t be cmpared. Tlerance - Specifies the fixed r percent tlerance. Created with the Standard Editin f HelpNDc: Easily create Web Help sites

163 Range Check Range Check the Range Check assert will check a resurce key's value, and check t see if is between the user set maximum and minimum value. Range Check Editr Maximum Value - The maximum allwable value fr the Value Resurce Key Minimum Value - The minimum allwable value fr the Value Resurce Key. Value Resurce Key - The user will select a resurce key in which t cmpare a value. Created with the Standard Editin f HelpNDc: Free EPub prducer

164 Scalar Cmparisn Scalar Cmparisn Imprtant Nte The Scalar Cmparisn assertin is nw deprecated. While existing prjects can still cntinue t use it, new prducts shuld migrate t using the Value Cmparisn assertin. The scalar cmparisn takes the result f an execute scalar actin and cmpares with either a static value r anther scalar result. The scalar values can be f several different types, each with their wn specificatins f equality. Scalar Cmparisn Editr Cmparable Resurce Key - If the user des nt pt t use a static value t cmpare against, this is where the resurce key fr the dynamic value will be entered. Cmparable Value Surce - Specify whether t use a static value r a dynamic value frm anther resurce key. Cmparisn Type - Specify the type f the value t be cmpared: Blean DateTime Decimal Flating Pint Guid Integer

165 Text Equality Type - Specify the equality type f Equal, Nt Equal, Within Percent Tlerance, r Within Fixed Tlerance. Resurce Key - The value t be cmpared. Tlerance - Used t specify fixed r percent tlerance fr certain value types. Created with the Standard Editin f HelpNDc: Full-featured Kindle ebks generatr

166 Value Cmparisn Value Cmparisn Value Cmparisn is a general purpse cmparisn fr cmparing tw single values. It supersedes bth the Integer Cmparisn and the Scalar Cmparisn assertins, presenting a simpler cnfiguratin while als significantly extending the available ptins. Value Cmparisn Editr There are fur main sectins t the editr: 'Actual value', 'Expected value', 'Cmparisn' and 'Summary'. Actual Value This is the value that we want t validate. It always cmes frm a resurce that is available in the test. T select the resurce t test, click n the arrw t the right f the resurce name bx. Expected Value This is the value that we expect the actual value t match. This can either cme frm a static value that we cnfigure in the user interface r frm a resurce. If we're using a static value we simply type the value

167 that we want int the static value bx. If we're using a resurce then we select that ptin and pick the resurce in the same way we did fr the actual value. Cmparisn This sectin specifies the ptins that we use fr cmparisn: Data type: This will be detected autmatically when the actual and expected values are entered, but can be changed manually t use a different type fr the cmparisn if necessary. Cmparisn type: This is the type f cmparisn that we want t use, and different types are available fr different cmparisn types. S, fr example, 'GreaterThan' is nt available fr blean cmparisns and 'StringMatch' is nt available fr integers. Sme cmparisn types have additinal cnfiguratin ptins, which are detailed belw. Fr cmparisn types 'WithinFixedTlerance' and 'WithinPercentageTlerance' the tlerance ptins are visible. There is the chice f entering a symmetric tlerance (i.e. same amunt f tlerance up and dwn) r the values fr the upper and lwer tlerance can be entered specifically. By way f example, in the image abve where we are validating within a fixed tlerance f 11 with 5 dwn and 10 up, values between 6 (11-5) and 21 (11+10) wuld pass the check. Fr cmparisn types 'StringMatch' and 'RegexMatch', additinal string cmparisn ptins are available including whether t ignre case, ignre line endings and trim spaces frm the start / end f the values t cmpare. An example f this is shwn in the image belw. Summary This sectin simply prvides a plain text descriptin f what has been cnfigured in the assertin editr.

168 Created with the Standard Editin f HelpNDc: Free EBk and dcumentatin generatr

169 Xml Cmparisn Xml Cmparisn The Xml Cmparisn Assert allws a user t cmpare tw Xml resurces. These resurces can be laded many different ways, such as a frm a Lad Asset that is lading a File Cnent Asset, result f a query, r even frm a Get Prperties Actin. The Xml in the resurce is passed in as a string, checked if it is valid Xml then cmpared t the ther resurce. Xml Cmparisn Editr Actual Xml Resurce Key - This is the resurce key fr the key hlding the Xml t be used t cmpare. Cmpare Attribute Order - When in enabled, the cmparisn will first cmpare the rder f attributes in an element, befre cmparing the cntent. If left disabled, attribute rder will nt be cmpared, nly attribute value. Expected Xml Resurce Key - This is the resurce key fr the key hlding the Xml t be cmpares against. Ignre White Space - When enabled, this will ignre any extra spaces r white spaces in r arund

170 elements. Actual XPath Exclusin - This field takes an XPath string, the XPath will be executed against the Actual Xml nce laded, and elements fund by the XPath will be excluded frm the cmparisn n the Actual side nly. This field can be a "pipe" delimited string, allwing fr multiple XPath items t be executed. Expected XPath Exclusin -This field takes an XPath string, the XPath will be executed against the Expected Xml nce laded, and elements fund by the XPath will be excluded frm the cmparisn n the Expected side nly. This field can be a "pipe" delimited string, allwing fr multiple XPath items t be executed. Actual XPath Cmparisn - This field takes an XPath string, the XPath will be executed against the Actual Xml nce laded. Only the elements fund by the XPath will be used in the cmparisn fr the Actual side nly. Expected XPath Cmparisn - This field takes an XPath string, the XPath will be executed against the Expected Xml nce laded. Only the elements fund by the XPath will be used in the cmparisn fr the Expected side nly. Created with the Standard Editin f HelpNDc: Create HTML Help, DOC, PDF and print manuals frm 1 single surce

171 Assets Assets The asset elements are designed t be reusable pieces thrughut test develpment. Many different items may require the same cnnectin r query, but thse elements achieve different gals. Instead f needing t retype a cnnectin string every time, a user wuld stre that cnnectin string in a cnnectin asset. Nw every time that cnnectin is needed, the user simply selects it frm a list f available assets. Assets can be defined at the prject, suite, grup r test level. Assets within each f thse lcatins may nly be used by elements within that lcatin. S, fr example, an asset defined at the test level can nly be used by that test, whereas an asset defined at the prject level can be used anywhere within that prject. Table f Cntents Clud SalesFrce Cnnectin Data Managment Cmparisn Manifest Cnnectin Data Generatin Slutin Delimited Cntent Delimited File Reference Fixed Width File Reference Grid Cllectin Query Validatin Manifest Directry Directry Reference File Text File SQL Server T-SQL Backup / Restre T-SQL Bulk Insert SSIS Package Reference Created with the Standard Editin f HelpNDc: Full-featured Dcumentatin generatr

172 Clud Clud Actins The Clud assets include the items needed t gather data fr actins and asserts. Table f Cntents SalesFrce Cnnectin Created with the Standard Editin f HelpNDc: Easily create CHM Help dcuments

173 Rest Cnnectin (Basic) Rest Cnnectin (Basic) The Rest Cnnectin (Basic) cnnects t a web API. It is used in the Execute Rest Query (Grid) and Execute Rest Query (Scalar) actins. Settings. User Name - The username needed t authenticate t the endpint Url. Passwrd - The passwrd that allws the user t authenticate t the endpint Url. Use Base 64 Header - Check this ptin when yur endpint requires yu t use a basic authenticatin header using Base 64 Encding. (Fr example, this is hw the header is added t the request: webrequest.headers.add("authrizatin", string.frmat("basic {0}", Cnvert.TBase64String(Encding.ASCII.GetBytes(string.Frmat("{0}:{1}", UserName, Passwrd))))); Security Prtcl - Identifies the transprt layer security r secure sckets layer used by the endpint. Optins include: Default, SSL3, TLS1.0, TLS1.1, TLS1.2 Headers

174 Can be used t add headers t every request being used by the cnnectin. Prxy Hst - When cnnecting t an endpint using a prxy, users shuld enter the address f the prxy server.. Dmain - (Optinal) The dmain f the user lgging in. User Name - The username t authenticate t the prxy.

175 Passwrd - The passwrd t authenticate t the prxy. Prt - The prt number needed t cnnect t the prxy. Created with the Standard Editin f HelpNDc: Full-featured EPub generatr

176 Rest Cnnectin (OAuth1) Rest Cnnectin (OAuth1) The Rest Cnnectin (OAuth1) cnnects t a web API that uses OAuth1 security. It is used in the Execute Rest Query (Grid) and Execute Rest Query (Scalar) actins. Tken Settings API Key - Authenticatin key prvided at the applicatin's develper site. API Secret - Authenticatin secret prvided at the applicatin's develper site. Tken - The tken required by the web API. This infrmatin is prvided at the applicatin's develper site. Tken Secret - The tken's secret "passwrd" prvided at the applicatin's develper site. Security Prtcl - Identifies the transprt layer security r secure sckets layer used by the endpint. Optins include: Default, SSL3, TLS1.0, TLS1.1, TLS1.2 Headers Can be used t add headers t every request being used by the cnnectin.

177 Prxy Hst - When cnnecting t an endpint using a prxy, users shuld enter the address f the prxy server.. Dmain - (Optinal) The dmain f the user lgging in. User Name - The username t authenticate t the prxy. Passwrd - The passwrd t authenticate t the prxy.

178 Prt - The prt number needed t cnnect t the prxy. Created with the Standard Editin f HelpNDc: Free HTML Help dcumentatin generatr

179 Rest Cnnectin (OAuth2) Rest Cnnectin (OAuth2) The Rest Cnnectin (OAuth2) cnnects t a web API that uses OAuth2 security. It is used in the Execute Rest Query (Grid) and Execute Rest Query (Scalar) actins. Access Tken Access Tken - Carries the necessary infrmatin the API uses t determine whether the client is authrized r nt. The access tken prvided at the applicatin's develper site. Is Bearer Tken - An authrizatin header that is required by sme API's. If the API issues a bearer tken, click this ptin. API Key - Authenticatin key prvided at the applicatin's develper site. API Secret - Authenticatin secret prvided at the applicatin's develper site. Security Prtcl - Identifies the transprt layer security r secure sckets layer used by the endpint. Optins include: Default, SSL3, TLS1.0, TLS1.1, TLS1.2 Refresh Tken

180 Refresh Tken - The tken given t the user by the applicatin/service. This call allws users t request new access tkens. Refresh Tken Endpint - The refresh tken URL. Example: Refresh Tken Endpint Parameters - The query parameters used during the refresh tken request Example: scpe= state=security_tken%3d138r5719ru3e1%26url%3dhttps://a2cb.example.cm/myhme& redirect_uri=https%3a%2f%2fmyapp.example.cm%2fcallback& respnse_type=cde& client_id= apps.ggleusercntent.cm& apprval_prmpt=frce& include_granted_scpes=true Access Tken Jsn Path - When making the request t get a new access tken, the service will return that access tken in Jsn. This prperty is the path t that tken. Fr example the path t the access tken belw is access_tken. { "access_tken": "ERLKJDSLKDJLK! ", "expires_in" : 3180 } Headers Can be used t add headers t every request being used by the cnnectin.

181 Prxy Hst - When cnnecting t an endpint using a prxy, users shuld enter the address f the prxy server.. Dmain - (Optinal) The dmain f the user lgging in. User Name - The username t authenticate t the prxy. Passwrd - The passwrd t authenticate t the prxy.

182 Prt - The prt number needed t cnnect t the prxy. Created with the Standard Editin f HelpNDc: Easy CHM and dcumentatin editr

183 Salesfrce Cnnectin Salesfrce Cnnectin The Salesfrce Cnnectin asset prvides the user with an easy way t create a cnnectin t their Salesfrce surce. The editr als allws the user t set up a cnnectin thrugh a prxy. Salesfrce Cnnectin Editr

184 User Name - The Salesfrce user name. Passwrd + Security Tken - This field requires bth the passwrd and the security tken prvided by salesfrce t be enetered tgether. Server Url - An ptinal field t specify the server that hsts the cnnectin. Timeut - The amunt f time t wait befre the cnnectin times ut. Use Prxy - Check t enable the use f the prxy settings belw. Prxy Hst - The address f the prxy t be used. Prxy Dmain - Dmain address f the prxy. Prxy User Name - User name used t lg int the prxy. Prxy Passwrd - Passwrd t lg int the prxy. Prxy Prt - Prt specified t be used by the prxy cnnectin. Test Cnnectin - Clicking test cnnectin, will test the current settings and ensure they can cnnect. Created with the Standard Editin f HelpNDc: Easily create Web Help sites

185 Data Management Data Management Assets The Data Management assets include the items needed t gather data fr actins and asserts. Table f Cntents Cmparisn Manifest Cnnectin Data Generatin Slutin Delimited Cntent Delimited File Reference Fixed Width File Reference Grid Cllectin Query Salesfrce Cnnectin Validatin Manifest Created with the Standard Editin f HelpNDc: Easily create EPub bks

186 Cmparisn Manifest Cmparisn Manifest The cmparisn manifest asset is used in the grid cmparisn assert. This asset defines hw the tw grids in the assert are cmpared t each ther. First the user will need t gather the left side f the cmparisn, then the right. Once bth sides f the cmparisn have been gathered, then the user may set which clumns are cmpared and hw. Gather Left Clumns / Gather Right Clumns Cnnectin - The cnnectin t the lcatin f the data t be cmpared. The cnnectin can be set frm an existing cnnectin asset r typed int the cnnectin string bx. Query - The query used t gather the data t be cmpared. This can be typed in the editr bx, r pulled frm an existing query asset. Cmparisns

187 Key Clumns - Add, edit, r delete the key clumns frm each side f the cmparisn. The user will select the left and right clumn that match as the key clumn, and can als specify if the key is descending. Cmparisn Clumns - Set the clumns t be cmpared. Clumns with the same name and data type are autmatically ppulated t be cmpared. In the key clumns, the user can als chse a cmparisn

188 type based n the type f the clumn. Integers will have fixed tlerance ptins, and strings will have an exact value ptin r a string match ptin with additinal parameters. Aggregate Cmparisns - Set aggregate cmparisn f clumns. There are several aggregatin types t chse frm depending n the types being cmpared, as well as standard chices fr cmparisn types. Created with the Standard Editin f HelpNDc: Easily create Help dcuments

189 Cnnectin Cnnectin The cnnectin asset is designed t help a user create and stre a cnnectin string t a data surce. If the users knws the cnnectin string, they can simply type it int the Cnnectin string field, therwise they can make use f the cnnectin string builder. Using the cnfigure buttn,and selecting ther as the prvider, a user can even set up a cnnectin t analysis services. Cnnectin Editr Prvider - The prvider type fr the cnnectin string. Available Prviders: Odbc OleDb OracleClient SqlClient Micrsft SQL Server Cmpact 4.0 MySQL Cnnectin String - The cnnectin string fr the data surce. Cnfigure - The cnfigure buttn will launch the cnnectin string builder, and walk the user thrugh creating the cnnectin string that will be stred in the asset. Cnnectin Prperties Windw

190 Data Surce - This is the prvider type specified in the element's editr. Server Name - The name f the server that the data surce is lcated. Lg n t the server - The user can decide whether t use windw's authenticatin r prvide a specific user name and passwrd. Cnnect t a database - The user will either select a database lcated n the server specified, r pt t attach a database file. Once all items are ppulated the user can click Test Cnnectin t ensure that everything cnnects as expected, nce they click OK, the cnnectin string based n the prperties prvided will ppulate the cnnectin string field in the element's editr. Created with the Standard Editin f HelpNDc: Prduce electrnic bks easily

191 Data Generatin Slutin Data Generatin Slutin The Data Generatin Slutin asset picks an existing data generatin slutin that was created in Pragmatic Wrkbench, and is later executed with the Data Generatin actin. Data Generatin Slutin Editr Lad Slutin - Clicking the Lad slutin buttn will bring up a file picker windw. The user can brws fr an existing.dgsln file and lad it int the asset. Once laded, the editr will let the user knw hw many tables will be affected. Created with the Standard Editin f HelpNDc: Easily create Web Help sites

192 Delimited Cntent Delimited Cntent The Delimited Cntent asset allws the user t stre sme delimited data that becmes part f the test assembly. This enables, fr example, an easy set up fr static data as a data driven testing surce. Initial view File cntent - Here yu can type the data that yu wuld like t stre in the test assembly. This data will be stred in asset files and can be in any delimited frmat. Delimiter / Qute - These are the delimiter and qute that the file has. The asset's frmat detectin rutine will always check tab, pipe and cmma fr delimiters and bth single and duble qutes fr the qute. If yur file uses a different delimiter r qute, yu can enter them here. Detect frmat - Clicking this buttn will begin the prcess f detecting the frmat f the file and clumns. After scan view

193 Frmat - This lists the frmats that have been evaluated, alng with their scres. A higher scre indicates better cmpliance (cnsistent number f clumns acrss rws and a higher number f clumns in ttal). The frmat with the highest scre will be pre-selected - unless a custm delimiter r qute was specified, in which case the custm frmat will be pre-selected. Nte that the frmat selectin is nly available immediately after running the frmat detectin prcess. When cming back t edit the asset later, this ptin will disappear. Delimiter / Qute - Shws the currently selected delimiter and qute. Lines t skip - The number f lines f pre-amble t skip. Has header rw - Check this is the file has a header rw cntaining clumn names. The header rw cmes after any pre-amble. Treat empty as NULL - Check this if empty values shuld be rendered as <NULL> values. Encding - This is the encding that will be used t read the file. If yur file cntains special characters that are represented incrrectly n preview, it is likely that the encding needs changing. Culture - This is the culture that is used t interpret the surce data as typed values. Decimal pints and date frmats are thse where the culture requires particular attentin. Preview Data - This buttn will shw the preview f the data using the selected ptin in a grid view. Change cntent - This buttn allws yu t change the cntent stred in the test assembly and run the frmat detectin again. Clumn list - Each clumn is presented alng with a list f types. This list is derived by attempting frmat cnversin n a variety f frmats. Yu can change the resulting type t any f the allwable frmats.

194 Created with the Standard Editin f HelpNDc: Easily create HTML Help dcuments

195 Delimited File Reference Delimited File Reference The Delimited File Reference asset allws the user t select a delimited file and gather infrmatin abut bth it's frmat and the data it cntains. Initial view File name - Yu can paste the file name here r use the ellipsis buttn t select a file. A parameterized value may be used in the frm %parametername% r {{parametername}}. Delimiter / Qute - These are the delimiter and qute that the file has. The asset's frmat detectin rutine will always check tab, pipe and cmma fr delimiters and bth single and duble qutes fr the qute. If yur file uses a different delimiter r qute, yu can enter them here. Lines t skip - This is the number f rws f pre-amble t skip. Yu can leave Aut ticked t autmatically find ut hw much pre-amble there is. Nte that header rws will be autmatically detected. Lines t scan - This is the number f lines f data t scan while detecting clumn frmats. Detect frmat - Clicking this buttn will begin the prcess f detecting the frmat f the file and clumns. After scan view

196 File name - Yu can paste the file name here r use the ellipsis buttn t select a file. A parameterized value may be used in the frm %parametername% r {{parametername}}. Frmat - This lists the frmats that have been evaluated, alng with their scres. A higher scre indicates better cmpliance (cnsistent number f clumns acrss rws and a higher number f clumns in ttal). The frmat with the highest scre will be pre-selected - unless a custm delimiter r qute was specified, in which case the custm frmat will be pre-selected. Nte that the frmat selectin is nly available immediately after running the frmat detectin prcess. When cming back t edit the asset later, this ptin will disappear. Delimiter / Qute - Shws the currently selected delimiter and qute. Lines t skip - The number f lines f pre-amble t skip. Has header rw - Check this is the file has a header rw cntaining clumn names. The header rw cmes after any pre-amble. Treat empty as NULL - Check this if empty values shuld be rendered as <NULL> values. Encding - This is the encding that will be used t read the file. If yur file cntains special characters that are represented incrrectly n preview, it is likely that the encding needs changing. Culture - This is the culture that is used t interpret the surce data as typed values. Decimal pints and date frmats are thse where the culture requires particular attentin. Preview Data - This buttn will shw the preview f the data using the selected ptin in a grid view.

197 Change delimiters - This buttn allws yu t change the custm delimiters and run the frmat detectin again. Clumn list - Each clumn is presented alng with a list f types. This list is derived by attempting frmat cnversin n a variety f frmats. Yu can change the resulting type t any f the allwable frmats. Created with the Standard Editin f HelpNDc: Easy EPub and dcumentatin editr

198 Fixed Width File Reference Fixed Width File Reference The Fixed Width File Reference asset allws the user t reference a fixed width file and, after specifying the clumn widths, determine what frmat data each clumn represents. Initial view File name - Yu can paste the file name here r use the ellipsis buttn t select a file. A parameterized value may be used in the frm %parametername% r {{parametername}}. Lines t scan - This is the number f lines f data t scan while detecting clumn frmats. File type - This is the type f flat file that is being referenced. Three file types are available: Ragged right - This is a file where the last clumn is nt fixed width, with each line terminated by a carriage return and/r line feed. A line will be parsed if it is at least as lng as the sum f the widths f all but the last clumn. Fixed width with line breaks - This is a file where lines terminated by a carriage return and/r line feed. A line will be parsed if it is at least as lng as the sum f the widths f all clumns. Fixed width withut line breaks - This is a file where there are n line breaks, and the data cmes in a cntinuus stream. Every x characters are parsed where x is the sum f the widths f all

199 clumns. Clumns - This is the list f clumn widths that will be parsed frm the file. Yu can use the '+' and '-' buttns in rder t add r remve clumns t/frm the end f the list. Alternatively, yu can place the caret in the first clumn width bx, type the width and then press enter. This will add a new clumn where yu can repeat the same prcess. Nte that pressing enter in a width bx will nly add a new clumn if yu are currently in the last bx. Pressing enter n any ther bxes will mve fcus t the next bx. Detect frmat - Clicking this buttn will begin the prcess f detecting the frmat f the clumns. After scan view File name - Yu can paste the file name here r use the ellipsis buttn t select a file. A parameterized value may be used in the frm %parametername% r {{parametername}}. Has header rw - Check this is the file has a header rw cntaining clumn names. The header rw cmes after any pre-amble. Treat empty as NULL - Check this if empty values shuld be rendered as <NULL> values. Encding - This is the encding that will be used t read the file. If yur file cntains special characters that are represented incrrectly n preview, it is likely that the encding needs changing. Culture - This is the culture that is used t interpret the surce data as typed values. Decimal pints and date frmats are thse where the culture requires particular attentin. Preview Data - This buttn will shw the preview f the data using the selected ptin in a grid view. Change delimiters - This buttn allws yu t change the custm delimiters and run the frmat detectin again.

200 Clumn list - Each clumn is presented alng with a list f types. This list is derived by attempting frmat cnversin n a variety f frmats. Yu can change the resulting type t any f the allwable frmats. Created with the Standard Editin f HelpNDc: Create crss-platfrm Qt Help files

201 Grid Cllectin Grid Cllectin The grid cllectin is used t stre the details f a grid that can be used ver and ver using the Lad Grid frm Asset actin. The user will supply a cnnectin string and a query that pulls the infrmatin fr the grid. Bth the cnnectin and the query can be typed r pulled frm anther asset. Grid Cllectin Editr Cnnectin - Cnnectin string t the data surce, can either be typed manually r pulled frm an existing cnnectin asset. Is Disk Based - Stre the query restuls within a temprary file instead f in memry. This ptin is best used fr larger data sets. Query - The query respnsible fr gathering the data fr the grid. Created with the Standard Editin f HelpNDc: Create help files fr the Qt Help Framewrk

202 Query Query The query asset is used t stre queries. When cnnecting t a SQL Server r Azure SQL instance, the query editr includes an advanced editing experience. Yu can select the cnnectin frm the drp-dwn at the tp f the editr, which will lad infrmatin abut the schema f the database against which the query will run. The selectin is remembered fr the duratin f the sessin. When cnnecting t a SQL Server r Azure SQL instance, the query editr prvides the fllwing features: Cde cmpletin (suggestin lists after. r when Ctrl+Space is pressed) Quick inf (hver an bject name fr infrmatin abut that bject) Refactring (tracked renaming f variables and temprary bjects, query frmatting, bject qualificatin) Parameter infrmatin (shws the parameters expected fr prcedure and functin calls) Clumn chsers (chse which table t reslve an ambiguus clumn t) Synnym reslutin (wrk with synnyms with the full IntelliSense experience)

203 Shrtcuts (e.g. 'ssf' -> 'SELECT * FROM', st100 -> 'SELECT TOP 100 * FROM') Tab expansin (press tab when the caret is t the right f a * in rder t specify all clumns) A summary f the available functins can be fund by clicking the '?' icn in the bttm right hand crner f the editr. Created with the Standard Editin f HelpNDc: Free help authring tl

204 Validatin Manifest Validatin Manifest The Validatin Manifest allws the user t select a grid, and then add rules t validate the cntent f the grid. There are different available rules fr any given type available in the grid. Validatin Manifest Editr Select Grid - When the editr frist pens, the nly available ptin is the Select Grid buttn, clicking this will shw all available grids in the test in which t validate. Once a grid is selected, then the ability t add validatin clumns will be available. If yu want t validate the fact that the grid is empty (fr example, because yur query nly returns rws that fail) yu can select the 'Only pass validatin if n rws are present' ptin. Remve - clicking remve will delete the selected rule frm the manifest. New - Clicking new will expand the editr t shw the clumn selectr and cmparisn type picker.

205 Clumn - Selects a clumn frm the grid t applu the cmparisn t. Cmparisn Type - The available cmparisn types will vary depending n the type f the selected clumn. The cmparisn type will use the Cmparisn Value field t execute the validatin. Is Aggregated - If selected, and the clumn's type allws fr aggregatin, then anther field will appear t allw the user t select the type f aggregatin. Cmparisn Value - The cmparisn value is cmpared t the rw f each clumn using the previulsy selected Cmparisn Type. Cancel - Will cancel ut f the new cmparisn wiithut saving. Add - Add will be enabled nce all fields are ppulated fr the new rule. Clicking add will save the rule t the Validatin Manifest. Created with the Standard Editin f HelpNDc: Full-featured Help generatr

206 Directry Directry Assets Table f Cntents Directry Reference Created with the Standard Editin f HelpNDc: Prduce electrnic bks easily

207 Directry Reference Directry Reference The directry reference asset stres a reference t a directry path. The directry reference asset editr allws yu t enter the directry path that yu want t reference. Yu can click the ellipsis t select the directry with a nrmal directry brwser. The path can als be parameterized. Created with the Standard Editin f HelpNDc: Full-featured EBk editr

208 File File Assets The file assets include the the Text File asset, which is used in bth the File actins and asserts. Table f Cntents Text File Created with the Standard Editin f HelpNDc: Easy CHM and dcumentatin editr

209 Text File Text File The text file assets is used t specify the cntent f a text file. This asset is used fr the File Create actin as well as the File Cntent Cmparisn assert. Text File Editr File Cntent - The text t make up the file. Clicking the Pp Out buttn will prvide a larger space t type the cntent f the file. Pp Out Editr

210 Created with the Standard Editin f HelpNDc: Benefits f a Help Authring Tl

211 SQL Server SQL Server Assets The SQL Server assest prvide a way t Backup, Restre, r initiate a Bulk Insert. Having these items as assets allws fr quick develpment f tests withut needed t duplicate the cmmands cntained withing the asset. Table f Cntents T-SQL Backup / Restre T-SQL Bulk Insert Created with the Standard Editin f HelpNDc: Prduce electrnic bks easily

212 T-SQL Backup / Restre T-SQL Backup / Restre This asset can be used t either stre a backup r restre SQL cmmand, that can later be used with Execute Query Cmmand actin. Backups and restres will use the default backup lcatin f the system running the test. Backup / Restre Editr Mde - Select either Backup r Restre. Database - The name f the database t be backed up r restred. File Name - The name f the file t be restred, r the name t give the backup. Created with the Standard Editin f HelpNDc: Free help authring tl

213 T-SQL Bulk Insert T-SQL Bulk Insert This asset stres the infrmatin fr a bulk insert that can be executed using the Execute Query Cmmand actin. The user will specify the table the data is t be inserted int, a file that cntains the infrmatin, and the field separatr. Bulk Insert Editr Table - The table fr the data shuld be inserted int. File Name - The lcatin f the file that hlds the data t be inserted. Field Separatr - If the data uses a separatr ther than the default tab, the user can specify it here. Created with the Standard Editin f HelpNDc: Free Qt Help dcumentatin generatr

214 SSIS SSIS Assets The SSIS asset allws fr a quick way t reference a package fr tests multiple times, withut the need t re-select it fr each test yu may want t execute against it. Table f Cntents Package Reference Created with the Standard Editin f HelpNDc: Generate Kindle ebks with ease

215 Package Reference Package Reference The package reference assets are used t hld the lcatin f an SSIS package. LegiTest has supprt fr 2008, 2012, 2014, 2016 and 2017 packages. The user can brwse fr a package stred in a file system, r prvide the cnnectin string fr packages stred n server r catalg. The catalg ptin is nly available fr 2012, 2014, 2016 and 2017 package references. Once the file lcatin is added r cnnectin string supplied, the user will click the lad buttn t btain a list f available packages. Once selected, the package can later be laded using the Lad Package actin. Fr 2008, 2012, 2014, 2016 and 2017 File File - Lcatin f the package n the file system. The user can either type in directly, r use the brwse buttn t search the machine fr lcatin f the package. Selected - This area will be ppulated with available packages nce a lcatin is specified and the lad buttn is clicked. SQL

216 Cnnectin - The cnnectin string t the lcatin f stred packages. This can either be typed r pulled frm an existing Cnnectin asset. Selected - Once a cnnectin string as prvided and the user clicks lad, this area will be ppulated with packages fund n the server. Fr 2012, 2014, 2016 and 2017 Catalg Cnnectin - The cnnectin string t the catalg's lcatin. This can either be typed r pulled frm an existing Cnnectin asset. Selected - Once a cnnectin string is prvided and the user clicks lad, this area will be ppulated with

217 packages fund in the catalg. Created with the Standard Editin f HelpNDc: Create help files fr the Qt Help Framewrk

218 Wizards Wizards The wizards within LegiTest prvide cnvenient ways t create tests. Each wizard cntains cmmn usage patterns fr crafting the tests. Table f Cntents Data Validatin Interactive Cmparisn Recipes SSAS Validatin Testing SSIS Package Testing SSRS Reprt Executin There are several ways users can reach a wizard: Adding a new LegiTest grup t a prject (by right clicking n the prject nde in slutin explrer and then clicking Add -> LegiTest Grup...) Adding new grups r tests within an existing LegiTest suite / grup Chsing the wizard frm within the LegiTest Tlbx

219 Depending n the wizard selected, LegiTest will walk the user thrugh the steps necessary. Created with the Standard Editin f HelpNDc: Easily create Help dcuments

220 Data Validatin Data Validatin The data validatin wizard allws users t build tests that validate specific query results. This shrtens the time it takes t build tests that help detect crrupt r inaccurate data. Data Set When launched, the wizard presents an empty display. The data set windw specifies the cnnectin and query used within the data validatin wizard. T begin, users must cnfigure a cnnectin fr use within the data validatin wizard. T create a cnnectin, click the 'cnfigure' buttn. After selecting and cnfiguring the cnnectin prperties, users can begin building the query. 'Is Disk Based' specifies whether t stre the results within a temprary file r in memry. This ptin is best used fr larger data sets. The data set query uses the same advanced editr as the Query Asset. Once satisfied with the query, click "Next." Cnfiguratin The cnfiguratin windw species the clumns and aggregates t use within the data validatin. Select "Only pass validatin if n rws are present" if the user expects the query t return n rws. Otherwise, click "New" t add the first clumn validatin. Users can add as many validatin clumns as they wish. This validatins can be aggregatins r rw-byrw cmparisns. Users chices fr cmparisn types depend n the data type f the selected clumn.

221 Once satisfied with the validatin clumns, click "Finish"

222 Created with the Standard Editin f HelpNDc: Full-featured multi-frmat Help generatr

223 Interactive Cmparisn Interactive Cmparisn The interactive cmparisn wizard in LegiTest allws a data cmparisn t be built while inspecting the results that the cmparisn wuld prduce. This shrtens the cycle between intent and result and allws us t tailr the cmparisn. When launched, the wizard presents an empty display. T begin, we either select a cnnectin r create a new cnnectin fr each side f the cmparisn. T create a new cnnectin, click the +ʼ buttn t the right f the cnnectin selectr. Nte that nce we have selected a cnnectin, then the cde cmpletin becmes available in the editr if that cnnectin is t a SQL Server instance. When we have typed in ur queries fr the expected and actual sides f the cmparisn, we can click Cmpareʼ t run a cmparisn and the display shws the data.

224 Nte that at the mment, all f the clumns are faded ut. This means that they are nt part f the cmparisn. The first thing we need t d is define the key that uniquely identifies rws in the cmparisn, s we click n the clumn header f the clumn we want t be ur key and select Set as keyʼ. If mre than ne clumn makes up the key, then we can click n the clumn header f each key clumn in turn and select Add t keysʼ. Nte that we can als add keys manually by clicking n the Keysʼ buttn and then the Addʼ buttn in the lwer left panel. The display can then shw us rws that exist nly in the expected r actual result sets, and highlights the full rw n each side.

225 We can then click n cmparisnsʼ in the bttm right panel, and we are presented with a buttn allwing us t autmatically map the cmparisn clumns frm the expected and actual sets. It des this by finding clumns that have matching names and cmpatible types. Nte that we can als add cmparisns manually by clicking n the Cmparisnsʼ buttn and then the Addʼ buttn in the lwer left panel. This is needed if yu want t specify tlerances r match ptins fr the cmparisn (e.g. numerics within 2% tlerance r string matching that ignres case). Once we have dne this, we can see that all clumns are nw part f the cmparisn.

226 We can nw see that values that are different are being cmpared and highlighted. It is als pssible t cnfigure aggregates, s that yu culd, fr example, ensure that the ttal f a clumn frm the expected side is within 2% f the ttal frm the actual side. T d this, click the Aggregatesʼ buttn and then the Addʼ buttn in the lwer left panel. We can als view the results f aggregatins by clicking n the Aggregatin Resultsʼ buttn in the right hand panel.

227 We can als change the cnfiguratin f the cmparisn by clicking n the Cnfiguratin buttn in the lwer left panel. This allws us t cnfigure whether we ignre certain categries f difference and whether we use disk based sets. Disk based sets are used when we expect a large number f results frm the server and want t keep the memry usage t a minimum. Nte that when using disk based sets yur query must return the rws in the rder specified by yur keys as disk based sets cannt be srted. There are als cnfiguratin ptins in the right hand side panel. Nte that the cnfiguratin ptins n the right hand side nly apply t the peratin f the wizard and d nt change hw the actual generated tests are executed. Here we can decide t shw equal rws r nt, autmatically relad the cmparisn when we change things and set a limit n the number f rws. If we have autmatic relad cnfigured, then the queries will nt be re-run when changing the cmparisn cnfiguratin. They will nly be run if: A different cnnectin has been selected The query has changed The Cmpareʼ buttn is used. When we are happy with ur cmparisn cnfiguratin, we can click the Finishʼ buttn in rder t generate the elements in ur test:

228 Nte that the cmpare gridsʼ and cmparisn manifestʼ items have a quick actin marker in the bttm right. Clicking this allws quick access t the interactive wizard t enable yu t mdify an existing cmparisn. Created with the Standard Editin f HelpNDc: Free EPub and dcumentatin generatr

229 Recipes Recipes Recipes are a simple way t create tests based arund smaller pieces f functinality - allwing users t get started with testing even quicker than befre. Imprtant Nte Recipes d nt supprt cnnectins t an Oracle Database. The recipe first page allws yu t chse the recipe that yu want t use t create a test. If the recipe requires any cnnectins then yu can specify thse cnnectins n this page t, either using an existing asset r cnfiguring a new cnnectin.

230 The recipe secnd page is specific t the recipe. This is an example f the 'Uniqueness' recipe, in which we select a table t check and the clumns which frm the unique key. Fr infrmatin abut the individual recipes, please check the tpic fr the recipe. Recipes Data Prfile Validatin Dimensin Validatin Range Check Rw Cunt Cmparisn Standard Deviatin Text Frmat Validatin Uniqueness Created with the Standard Editin f HelpNDc: Full-featured EPub generatr

231 Data Prfile Validatin Data Prfile Validatin The Data Prfile Validatin allws users t test clumn data based n user-defined rules. After a cnnectin has been established, select a table. Imprtant Nte The Data Prfile Validatin recipe des nt supprt cnnectins t an Oracle Database. Select the Advanced tab t create a WHERE clause t filter the data (if needed.) D nt add the WHERE clause, just add the filter criteria (fr example: BusinessEntityID >= 500 AND BusinessEntityID <= 1500.)

232 Once a table is selected, the Clumn Validatin settings will becme visible. T create a validatin: Click New Select a Clumn Select a Cmparisn Type Define the Cmparisn Value Click Add. Mre than ne validatin can be added t clumn(s). In the example abve, validatin has been added t the DepartmentID clumn it des nt cntain NULL. Additinally, the MdifiedDate clumn is being cnfigured t validate dates greater than r equal t :50:02 PM.

233 Created with the Standard Editin f HelpNDc: Prduce Kindle ebks easily

234 Dimensin Validatin Dimensin Validatin The Dimensin Validatin allws users t test their dimensin tables fr incnsistent data. After cnfiguring the cnnectin, select a dimensin table. Imprtant Nte The Dimensin Validatin recipe des nt supprt cnnectins t an Oracle Database. Once a table is selected, identify each clumn based n its type (.e.g. Surrgate Key, Business Key, SCD Type 1 r Type 2 change, etc.) Als, users will need t select the Effective Date Handling ("Nne" r "End date equals start date f next versin") and the Gap Tlerance (the amunt f time allwed between the expired recrd and the start f the new recrd.)

235 Created with the Standard Editin f HelpNDc: Free iphne dcumentatin generatr

236 Range Check Range Check The Range Check recipe allws us t select a table and clumn t check that all values fall within a specific range. Imprtant Nte The Range Check recipe des nt supprt cnnectins t an Oracle Database. In the example abve, we are checking that the table 'db.datadictinarycategries' des nt have any values in the 'ScpeType' clumn that are nt between 1 and 6. Created with the Standard Editin f HelpNDc: Full-featured multi-frmat Help generatr

237 Rw Cunt Cmparisn Rw Cunt Cmparisn The Rw Cunt Cmparisn recipe allws us t generate a test that cmpares rw cunts between databases. Imprtant Nte The Rw Cunt Cmparisn recipe des nt supprt cnnectins t an Oracle Database. Fr this recipe, we chse tw cnnectins and then cnfigure tables t map. By default, all tables with the same name will be mapped autmatically. We can add new mappings by clicking the 'Add' buttn, and then selecting the surce and target tables using the drp-dwn bxes. Optinally, we can cnfigure filters fr bth sides - s the example abve will nly inlcude clumns fr the table 'db.slutin' where 'AccuntId' is equal t zer. Nt that the filter is any valid SQL syntax that can be placed in the WHERE clause. Additinally, we can create a data-driven test - where the rw cunt cmparisn fr each individual table is created as it's wn test case. Created with the Standard Editin f HelpNDc: Free help authring envirnment

238 Standard Deviatin Standard Deviatin The Standard Deviatin recipe allws us t check that the standard deviatin fr a clumn is belw a given maximum, ptinally specifying clumns t grup by. Imprtant Nte The Standard Deviatin recipe des nt supprt cnnectins t an Oracle Database. S, in the example abve, we are checking that the table 'Sales.SalesOrderDetail' des nt have a standard deviatin ver 2 fr the clumn 'UnitPrice' when gruped by the clumn 'PrductId'. Created with the Standard Editin f HelpNDc: Write ebks fr the Kindle

239 Text Frmat Validatin Text Frmat Validatin The Text Frmat Validatin allws users t validate clumns that use a cmmn frmat such as , phne numbers, and state cde patterns. After cnfiguring the cnnectin, select a table. Imprtant Nte The Text Frmat Validatin recipe des nt supprt cnnectins t an Oracle Database. Once a table is selected, the Clumn Validatin settings will becme visible. T create a validatin: Click New Select a Clumn Select the frmat type in the Is drpdwn frm the fllwing: Nrth American Phne Number Numeric Alpha Numeric Scial Security Number Cuntry Cde (ISO-3166) State Cde (ISO-3166) Click Add. In the example abve, the Address clumn's text frmat is being checked t ensure it fllws the name@dmain.cm frmat.

240 Once a table is selected, the Clumn Validatin settings will becme visible. T create a validatin: Click New Select a Clumn Select the frmat type in the Is drpdwn frm the fllwing: Nrth American Phne Number Numeric Alpha Numeric Scial Security Number Cuntry Cde (ISO-3166) State Cde (ISO-3166) Click Add. In the example abve, the Address clumn's text frmat is being checked t ensure it fllws the name@dmain.cm frmat. Created with the Standard Editin f HelpNDc: Qt Help dcumentatin made easy

241 Uniqueness Uniqueness The Uniqueness recipe allws us t select a table that we want t check fr duplicates, and als select the clumns that make up the unique key fr that check. Imprtant Nte The Uniqueness recipe des nt supprt cnnectins t an Oracle Database. In the example abve, we are checking that the table 'db.slutin' des nt have mre than 1 rw fr each pair f 'SlutinId' and 'AccuntId'. Created with the Standard Editin f HelpNDc: Create crss-platfrm Qt Help files

242 SSAS Validatin Testing SSAS Validatin Testing The SSAS Validatin Testing wizard builds a suite f tests spanning an entire database. This shrtens the time it takes t build tests. Building test cverage t help detect crrupt r inaccurate data within an SSAS database. Specify Database When launched, the wizard presents an empty display. The database windw specifies the server and database used within the validatin testing wizard. Select Items t Test Once lading cmpletes, select all items the user wishes t validate. The items available depends n whether the database mdel type and cmpatibility level. Multidimensinal databases will display the database's cubes.

243 Tabular databases with cmpatibility levels between 1100 and 1103 will display the database's cubes. Tabular databases with cmpatibility levels f 1200 r higher will display the database's tables.

244 Once satisfied with the items t include within the validatin testing, click "Next". Specify Optins On the specify ptins windw, users select the types f tests t generate. Once satisfied with the ptins, click "Finish". LegiTest will build several test grups and tests. The amunt generated depends n the number f measures and attributes present.

245 Due t the nature f the tests generated, users may need t crrect validitin errrs. These errrs typically ccur within the "Check if a specific attribute memeber exists" tests. In rder t remve the validatin errrs, users will need t specify the member. Replace "<INSERTMEMBERHERE>" with the desired member. Created with the Standard Editin f HelpNDc: Single surce CHM, PDF, DOC and HTML Help creatin

246 SSIS Package Testing SSIS Package Testing The SSIS Package wizards builds a suite f tests fr each package. These tests ensure smth executin, extractin, and validatin f data results. The SSIS Package wizard requires SSIS installed t build and execute the tests. Within the develpment envirnment, LegiTest nly displays versins f SSIS that are currently available. The tests generated by this wizard need SSIS installed n all systems planning t run the tests. Specify Surce When launched, the wizard presents an empty display. This windw allws navigating t the lcatin f the packages the user wishes t lad. Users can lad packages frm the fllwing lcatins: File SQL Catalg If the user wishes t deply these tests t LegiTest Server, it must have access t these packages as well. Select Packages The select packages windw allws users the ability t select the desired packages they wish t lad.

247 Enter Passwrd If any f the packages are encrypted using a passwrd, LegiTest requires the passwrd t be specified. Specify Optins On the specify ptins windw, users select the types f tests t generate.

248 Once satisfied with the ptins, click "Finish". LegiTest will build several test grups and tests. The amunt generated depends n the number f packages and data flws present. Due t the nature f the tests generated, users may need t crrect validitin errrs. These crrectins typically ccur within the data flw tests. Imprtant Nte The 'Ignre Tesks' filter is a wildcard filter - s * may be used t represent zer r mre characters and? may be used t represent a single character Created with the Standard Editin f HelpNDc: Easily create Help dcuments

249 SSRS Reprt Executin SSRS Reprt Executin The SSRS Reprt Executin wizard tests reprt executins based n specific reprt parameters. This wizard ensures the reprt executin results are accurate given the specified parameters. Specify Surce When launched, the wizard presents an empty display. This windw allws users t specify the SSRS web service they wish t use. The web service can be either a native r SharePint Web Service. When using a SharePint Web Service, be sure t select the "Is SharePint" checkbx. Depending ne the type f web service, the frmat fr the web service and initial path will be different. Native Web Service Service Address: http[s]://<servername>[:<prt>]/reprtserver[_<instancename>]/reprtservice2010.asmx Initial Path: T specify the rt flder f a native web service, use "/". Otherwise, users can build the path t the starting flder. Example initial paths: / /SharedDcuments/ReprtFlder SharePint Web Service Service Address: http[s]://<servername>[:<prt>]/_vti_bin/reprtserver[_<instancename>]/reprtservice2010.a smx Initial Path: T specify the rt flder f a SharePint web service, use

250 "http[s]://<servername>[:<prt>]/". Otherwise, users can build the path t the starting flder. Example initial paths: http[s]://<servername>[:<prt>] http[s]://<servername>[:<prt>]/shareddcuments/reprtflder Select Reprt On the select reprts windw, navigate thrugh the web service flders t the target reprt. After selecting the reprt and clicking "next", LegiTest will quickly lad the reprt's parameters. Enter Parameters On the enter parameters windw, users can update the parameters t the reprt.

251 Specify Tests On the specify ptins windw, users select the types f tests t generate.

252 Once satisfied with the parameters and ptins, click "Finish". LegiTest will build a test grup fr the reprt. Created with the Standard Editin f HelpNDc: Easy EPub and dcumentatin editr

253 Frequently Asked Questins Frequently Asked Questins Why are my LegiTest files shwing XML? Why are my tests failing due t a "Mixed Mde Assembly" errr? Hw d I add a NuGet package reference t my test prject? Ordering data sets in lw-memry mde Hw can I add custm assertins? Hw can I migrate frm suites t grups? Hw can I initialize a value nce per run? Created with the Standard Editin f HelpNDc: Prduce electrnic bks easily

254 LegiTest Files Shwing XML Why are my LegiTest files shwing XML? If the.legitest file is pening as XML, then yu will need t change which exe it is being pened with. T d s, right click the.legitest file and select pen with..., in this dialg that is pened, yu shuld see an item named LegiTest Files, select this and set as default. If the.legitest file is already pen, yu may need t clse and re-pen fr the changes t be applied. Created with the Standard Editin f HelpNDc: Create HTML Help, DOC, PDF and print manuals frm 1 single surce

255 Mixed mde assembly errr Why are my tests failing due t a "Mixed Mde Assembly" errr? If a test fails with the exceptin: "Mixed mde assembly is built against versin 'v ' f the runtime and cannt be laded in the 4.0 runtime withut additinal cnfiguratin infrmatin", then a change t the vstest.executinengine.x86.exe.cnfig file will be needed. Clse Micrsft Visual Studi 2012 (and IIS express) Launch ntepad.exe as an administratr Open the file "C:\Prgram Files (x86)\micrsft Visual Studi 11.0\Cmmn7\IDE\CmmnExtensins\Micrsft\TestWindw\vstest.executinengine.x86.exe.cnfi g". 4. Add and save the fllwing lines in bld: <?xml versin="1.0" encding="utf-8"?> <cnfiguratin> <runtime> <legacyunhandledexceptinplicy enabled="1" /> <assemblybinding xmlns="urn:schemas-micrsft-cm:asm.v1" > <prbing privatepath="extensins" /> </assemblybinding> </runtime> <system.diagnstics> <switches> <add name="tptracelevel" value="0" /> </switches> </system.diagnstics> <appsettings> <switches> <!--<add key="executinthreadapartmentstate" value ="MTA"/>--> <!--<add key="tracelgmaxfilesizeinkb" value ="10240"/>--> <!-- MsTest Adapter Specific AppSettings --> <add key="testprjectretargett35allwed" value="true" /> </switches> </appsettings> <startup uselegacyv2runtimeactivatinplicy="true" > <supprtedruntime versin="v4.0" sku=".netframewrk,versin=v4.0" /> </startup> </cnfiguratin> Created with the Standard Editin f HelpNDc: Easy EPub and dcumentatin editr

256 Adding a NuGet package reference Hw d I add a NuGet package reference t my test prject? Yu may find that yu need t add a NuGet package reference t yur prject - fr example, when switching a test prject frm MSTest t NUnit yu wuld need t add a reference t the 'NUnitTestAdapter' package. T d this, expand the prject nde in Slutin Explrer, right click n the 'References' nde and click n 'Manage NuGet Packages...' In the dialg that is shwn, click n 'Brwse' and then type the name f the package yu want t install. Select the package yu want when the search results are returned and click 'Install' in the right hand pane. The NuGet package is then installed in the prject. Created with the Standard Editin f HelpNDc: Full-featured multi-frmat Help generatr

257 Ordering data sets in lw-memry mde Ordering data sets in lw-memry mde When extracting data sets fr cmparisn, they must be rderable. Small data sets are n prblem, as they can be stred in memry and rdered simply. Fr larger data sets we can use lw-memry mde which stres the data in a file n disk. Hwever, a requirement fr data sets in lw-memry mde is that they are rdered when they are prduced. Mst f the time a simple ORDER BY clause allws us t rder the set in the same rder as the cmparisn keys. Hwever, when using a string as a key issues can arise frm the fact that SQL will rder strings accrding t the cllatin defined n the surce. The cmparisn within LegiTest uses binary cllatin - s the rder by clause has t be specified with a binary cllatin. Fr example: SELECT * FROM [Persn].[Persn] ORDER BY [LastName] COLLATE Latin1_General_100_BIN It is imprtant t nte that the clumns specified in the ORDER BY clause must match the keys specified in the cmparisn manifest, in the same rder. S, if yu cmparisn manifest has the keys 'LastName', 'FirstName', 'Age' then the ORDER BY clause must als specify LastName, FirstName, Age. Created with the Standard Editin f HelpNDc: Benefits f a Help Authring Tl

258 Hw can I add custm assertins? Hw can I add custm assertins? Smetimes the assertins in LegiTest dn't quite allw yu the flexibility that yu want, and yu want t write sme C# cde that adds sme mre lgic t yur tests. In rder t d this, we can add cde t the user file that LegiTest generates. There are fur types f cde that can be run: Befre Test After Test Befre Test Element After Test Element Fr each f thse, the fllwing methd declaratins shuld be added t the user file. static partial vid BefreTest(string testname, Dictinary<string, bject> testresurces, ref bl cancel) static partial vid AfterTest(string testname, Dictinary<string, bject> testresurces) static partial vid BefreTestElement(string testname, string elementname, Dictinary<string, bject> testresurces, ref bl cancel) static partial vid AfterTestElement(string testname, string elementname, Dictinary<string, bject> testresurces) Nte that the 'befre' methds have the 'cancel' parameter. This can be set t true within the bdy f the methd, which wuld cancel the executin f the element. Fr example, we might want t execute sme cde after an element called 'Execute Query (Grid)' in a test called 'Test 1' is run. The methd implementatin might be similar t the fllwing: static partial vid AfterTestElement(string testname, string elementname, Dictinary<string, bject> testresurces) { if (testname == "Test 1" && elementname == "Execute Query (Grid)") { if (!testresurces.cntainskey("executequery(grid)_targetresurcekey")) { NUnit.Framewrk.Assert.Fail("There was n grid placed in the resurces by the test element."); } var grid = (PragmaticWrks.Cmmn.Sql.RwStreGrid.IGrid) testresurces["executequery(grid)_targetresurcekey"]; if (grid.rwcunt < 100) { NUnit.Framewrk.Assert.Fail("We needed 100 r mre rws t be returned frm the execute query element."); } } } First, we check that the testname and the elementname are the nes we want. We can find these easily by searching fr 'AfterTestElement' in the generated cde file. After this, we check that the test resurces passed t us cntains the item we want. We are using the 'Resurce key' frm the execute query (grid) cnfiguratin t identify the resurce. If the resurce is nt present - we fail the test. This test was built with NUnit - s we are using NUnit.Framewrk.Assert. Once we are sure we have the resurce in place, we get it back as a lcal variable by casting it t the

259 crrect type. Grid resurces are always f the type PragmaticWrks.Cmmn.Sql.RwStreGrid.IGrid. We then check that the RwCunt is 100 r mre, and if nt then we again fail the test. Imprtant Nte This cde will nt be autmatically mdified when yu change the name f tests, elements r resurce keys. Make sure that any changes are reflected in the user cde. Created with the Standard Editin f HelpNDc: Full-featured EBk editr

260 Hw can I migrate frm suites t grups? Hw can I migrate frm suites t grups? Starting with the release, the cncept f individual grups was added t LegiTest, and is nw the preferred methd f implementing tests. There are several advantages t this apprach: Because a smaller set f tests exists in a single file, cnflicts between develpers are reduced Similarly, surce cntrl is easier t manage Assets can be created at the prject level and shared mre widely Parameters becme prject level cncerns and are easier t manipulate acrss a wider range f functins In rder t migrate t individual grups, right click n a LegiTest suite within slutin explrer and click 'Migrate t individual grups...' Imprtant Nte It is always a gd idea t ensure yu have a backup befre perfming any srt f migratin. Created with the Standard Editin f HelpNDc: Full-featured Kindle ebks generatr

261 Hw can I initialize a value nce per run? Hw can I initialize a value nce per run? One-Time Initializatin fr Values Smetimes we may want a parameter t apply t all grups / tests in an assembly, and initialize it dynamically nce per run. In rder t d that, we use sme custm cde. T achieve this, we will add a new file t ur prject by right-clicking n the prject in Slutin Explrer, and clicking Add -> Class... In this example we name the file 'OneTimeInitializatin'. Within this file, we define the parameters that we'd like t initialize nce nly - in this example we have PrcessingDate that we derive frm a database and FileCunt that represent the cunt f files in a particular directry. using using using using PragmaticWrks.LegiTest.Runtime; System; System.Data.SqlClient; System.IO; namespace LegiTestPrject { static class OneTimeInitializatin { public static Lazy<bject> PrcessingDate { get; } = new Lazy<bject>(LadPrcessingDate, true); static bject LadPrcessingDate() { var parameterprvider = new ParameterPrvider(Guid.Empty, typef(onetimeinitializatin)); using (var cnnectin = new SqlCnnectin(parameterPrvider.GetTypedParameter("SystemCnnectin", string.empty))) { cnnectin.open(); using (var cmd = new SqlCmmand("SELECT MAX(LastPrcessedDate) FROM db.prcesstracking", cnnectin)) { return cmd.executescalar(); } } } public static Lazy<bject> FileCunt { get; } = new Lazy<bject>(LadFileCunt, true); static bject LadFileCunt() { var parameterprvider = new ParameterPrvider(Guid.Empty, typef(onetimeinitializatin)); return Directry.GetFiles(parameterPrvider.GetTypedParameter("WrkingPath", string.empty)).length; } } } Here we have tw prperties 'PrcessingDate' and 'FileCunt' - bth f type Lazy<bject>. This is a system type that supprts lading a value nce and nce nly. There are als methds - ne fr each prperty - that are run nce t initialize the bject the first time it is requested. We are using parameters defined in the test suite 'SystemCnnectin' and 'WrkingPath'. In rder t d this we need t create a parameter prvider: var parameterprvider = new ParameterPrvider(Guid.Empty, typef(onetimeinitializatin));

262 We can then get the value f the parameter by calling the 'GetTypedParameter' methd: parameterprvider.gettypedparameter("wrkingpath", string.empty) In the examples abve, LadPrcessingData cnnects t the SQL Server using the cnnectin string defined in the 'SystemCnnectin' parameter, and then we run the query t select the MAX value f LastPrcessedDate frm the db.prcesstracking table. The LadFileCunt methd gets a list f the files frm the directry defined in the 'WrkingPath' parameter and returns the cunt. Using the Initialized Values in Tests In rder t use these ne-time values in ur tests, we use the 'BefreTest' methd t set the values int the resurces. Nte that we need t d this in each grup where we want t use thse values. T d this, we cpy cntent similar t the fllwing int the user file generated fr each test grup: namespace LegiTestPrject.TestGrup1_Output { using System.Cllectins.Generic; // This file prvides a pint at which partial methds can be implemented t augment tests. // The cntent f this file is preserved when the test suite is regenerated. public partial class TestGrup1 { static partial vid BefreTest(string testname, Dictinary<string, bject> testresurces, ref bl cancel) { testresurces["prcessingdate"] = OneTimeInitializatin.PrcessingDate.Value; testresurces["filecunt"] = OneTimeInitializatin.FileCunt.Value; } } } This cde makes the ne-time values available as a resurce t the test, and they can be referenced like a parameter, using the {{resurcename}} syntax. Fr example, if yu wanted t use the PrcessingDate value in a SQL query, yu wuld enter the query as: SELECT * FROM [MyTable] WHERE [LastMdifiedDate] >= '{{PrcessingDate date:"yyyymmdd"}}' Using this apprach, yu can set up and use values that are initialized nce and nly nce thrughut yur test suite. Fr mre infrmatin n using resurces and parameters please refer t the Using Parameters sectin. Created with the Standard Editin f HelpNDc: Write EPub bks fr the ipad

263 Cntact Us 8936 NrthPinte Executive Dr. Suite 200 Huntersville, NC Abut us: SentryOne creates unmatched slutins that empwer Micrsft data prfessinals t achieve breakthrugh perfrmance acrss physical, virtual, and clud envirnments. SentryOne prducts give custmers the capability and cnfidence t mnitr their databases, diagnse perfrmance issues, and ptimize the entire SQL Server estate t prvide real business value. The SentryOne team includes mre than 140 emplyees lcated in Charltte, NC, Jacksnville, FL, Salem, NH and Dublin, Ireland. Cmpany Culture: Our Missin: SentryOne empwers the Micrsft data prfessinal t achieve breakthrugh data envirnments. Our Cre Values: As SentryOne cntinues t grw, we knw that success depends n remaining true t Innvatin We create inspired, visinary slutins, and take n challenges that thers wnʼt r canʼt. Quality We embrace excellence by getting it right the first time. Agility We respnd and adapt quickly t the needs f ur clients. Created with the Standard Editin f HelpNDc: Prduce nline help fr Qt applicatins