Applies to Pester 3.4.0<\/p>\n
Like any Windows PowerShell script, a script that contains Pester tests can include parameters. It’s easy enough to run the script and pass parameters and values in the usual way.<\/p>\n
But, when you use Invoke-Pester to run the script, you need to pass the parameters in a hash table. This blog explains how to do it.<\/p>\n
This post is the third in a series about how to run Pester tests. See also, How to Run Pester Tests<\/a> and Invoke-Pester: Run Selected Tests<\/a>.<\/p>\n \nSee the posts in this Pester series:<\/p>\n ————————–<\/p>\n To use Invoke-Pester to pass parameters to a script, use a command like this one:<\/p>\n Or, this one:<\/p>\n <\/p>\n The Script<\/strong> parameter of Invoke-Pester<\/strong> typically takes a array of paths, either paths to a directory or to scripts that typically contain Pester tests, or both.<\/p>\n But, it can also take a hash table. One hint is that Script parameter type is [System.Object[]], not [System.String[]].<\/p>\n Here are hash table keys:<\/p>\n <\/p>\n Invoke-Pester splats the parameters and arguments to the scripts as it calls them.<\/p>\n Typically, the Path<\/strong> value in the hash table resolves to a particular script that takes the specified named and\/or positional parameters. But, when you pass parameters to a script that has no parameters, the extraneous parameters are ignored, so you can use a directory value effectively.<\/p>\n For example, this command passes the ComputerName to one .Tests.ps1 file, but the command runs all .Tests.ps1 files in the directory and its subdirectories.<\/p>\n Of course, this strategy is error-prone and will not work when more than one of the scripts being run takes different parameters, so it’s probably not advisable.<\/p>\n But, it’s easy enough to pass parameters to a Pester test. Pester really is amazing!<\/p>\n <\/p>\n Learning Pester? Check out Real-World Test-Driven Development with Pester<\/a>. The code and slides are in Github at https:\/\/github.com\/juneb\/PesterTDD<\/a>.<\/p>\n June Blender is a technology evangelist at SAPIEN Technologies, Inc. and a Windows PowerShell MVP. You can reach her at <\/em>juneb@sapien.com <\/em><\/a>or follow her on Twitter at <\/em>@juneb_get_help<\/em><\/a>.<\/p>\n <\/p>\n","protected":false},"excerpt":{"rendered":" Applies to Pester 3.4.0 Like any Windows PowerShell script, a script that contains Pester tests can include parameters. It’s easy enough to run the script and pass parameters and values in the usual way. But, when you use Invoke-Pester to run the script, you need to pass the parameters in a hash table. This blog […]<\/p>\n","protected":false},"author":31,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[1122,2,1119,1121,1120,25],"tags":[1125,934,28,1124,622,997],"class_list":["post-12218","post","type-post","status-publish","format-standard","hentry","category-behavior-driven-development-bdd","category-general","category-pester","category-test-driven-development","category-testing","category-windows-powershell","tag-bdd","tag-juneb","tag-powershell","tag-tdd","tag-testing","tag-windows-powershell"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/12218","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/users\/31"}],"replies":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/comments?post=12218"}],"version-history":[{"count":13,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/12218\/revisions"}],"predecessor-version":[{"id":12501,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/12218\/revisions\/12501"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=12218"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=12218"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=12218"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}\n
Invoke-Pester -Script @{Path='C:\\Tests\\MyTests.Tests.ps1';Parameters=@{Name='Pester';Version='3.4.0'}}<\/pre>\nInvoke-Pester -Script @{Path = 'C:\\Tests\\MyTests.Tests.ps1'; Arguments = 'Pester', '3.4.0'}<\/pre>\n\n
Invoke-Pester -Script @{Path='C:\\Tests\\MyTests.Tests.ps1'}<\/pre>\n<\/li>\nInvoke-Pester -Script @{Path = 'C:\\Tests\\MyTests.Tests.ps1'; Parameters = @{Name = 'Pester'; Version = '3.4.0'}}<\/pre>\n<\/li>\nInvoke-Pester -Script @{Path = 'C:\\Tests\\MyTests.Tests.ps1'; Arguments = 'Pester', '3.4.0'}<\/pre>\n<\/li>\n<\/ul>\nInvoke-Pester -Script @{Path = 'C:\\Tests\\MyTests'; Parameters = @{ComputerName = 'localhost'}}<\/pre>\n