Pester v5 #1444

bergmeister · 2020-04-17T16:20:16Z

PR Summary

Migration to use new Pester v5.
It has cleaner scoping and test setup has to go into a BeforeAll block, except for things that need to be evaluated at discovery time (therefore test cases also had to be inlined), see https://github.com/pester/Pester/blob/v5.0/README.md
Some cleanup had to be done as part of it. PSScriptAnalyzer is now only imported once before running tests (import is needed as some tests reference the PSSA types). Some tests were also cleaned up to not depend on PSScriptAnalyzerTestHelper.psm1 any more. I also started adding the Copyright header to the test files. The speed of test execution is roughly the same as v4.

A diff that ignores indentation/whitespace will make the review much easier

I suggest we wait for the GA of v5 but the PR is already ready.

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
Change is not breaking
Make sure all .cs, .ps1 and .psm1 files have the correct copyright header
Make sure you've added a new test if existing tests do not effectively test the code changed and/or updated documentation
This PR is ready to merge and is not Work in Progress.
- If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.


        Replace usage of $MyInvocation.MyCommand.Pat with $PSScriptRoot and c…

…leanup tests


        Fix 2 small mistakes, test should now be green again


        Adapt build.psm1


        Engine tests migration to Pester v5


        use pester v5 in ci and always upload test results


        Upgrade Rule tests to Pester v5 using BeforeAll block and addressing …

…some -Skip problems already


        -AllowPrerelease


        try bootstrap in wmf4


        fix invoke-pester call in CI


        fix CorrectionExtent.tests.ps1


        fix Helper.tests.ps1


        Fix remaining tests with BeforeAll/AfterAll (discovery works now)


        fix UseUsingScopeModifierInNewRunspaces.tests.ps1


        make test cases more readable


        cleanup UseUsingScopeModifierInNewRunspaces.tests.ps1


        Fix UseShouldProcessForStateChangingFunctions.tests.ps1


        cleanup UseShouldProcessForStateChangingFunctions.tests.ps1


        Fix PSCompatibilityCollector/Tests/UtilityApi.Tests.ps1


        Fix InvokeScriptAnalyzer.tests.ps1


        Format InvokeScriptAnalyzer.tests.ps1


        Fix ModuleHelp.Tests.ps1 and cleanup


        Fix RuleSuppression.tests.ps1


        Fix Settings.tests.ps1


        format Settings.tests.ps1


        Fix Tests/Engine/TextEdit.tests.ps1 and format


        Fix AllCompatibilityRules.Tests.ps1


        Fix AvoidUnloadableModuleOrMissingRequiredFieldInManifest.tests.ps1


        Format AvoidUnloadableModuleOrMissingRequiredFieldInManifest.tests.ps…

…1 to fix indentation


        Fix AvoidUsingPlainTextForPassword.tests.ps1


        fix place*brace tests

rc8


        Update appveyor.psm1


        Merge branch 'master' of https://github.com/powershell/PSScriptAnalyzer…

… into pesterv5PoC


        don't use -CI switch for local build and disable code coverage in CI


        import pester module before running tests to import types


        fix property name


        actually use configuration object (doh)


        config object


        fix output verbosity


        fix type casting of [string[]] of pester paths


        pester 5 GA


        Merge branch 'master' of https://github.com/powershell/psscriptanalyzer…

… into pesterv5PoC # Conflicts: # Tests/Rules/UseUsingScopeModifierInNewRunspaces.tests.ps1

bergmeister · 2020-05-27T17:24:55Z

@rjmholt @JamesWTruher Pester v5 has released today after multiple RC iterations. It's much cleaner but a tad slower, especially on PowerShell 5.1, which hasn't back-ported the speculative execution perf fix PowerShell/PowerShell#10269
Do you think it's worthwhile merging already as it might make porting of tests to PSSA v2 test easier/cleaner?


        Pester 5.0.2

rjmholt

Part way through the review, will continue later

PSCompatibilityCollector/Tests/UtilityApi.Tests.ps1

Tests/Engine/CustomizedRule.tests.ps1

Tests/Engine/InvokeScriptAnalyzer.tests.ps1

Tests/Engine/CustomizedRule.tests.ps1


        move testcases declaration before test


        remove left-over comments


        remove unnecessary [bool] in if condition


        simplify version check to not require [version] type and patch version


        fix missing whitespace in test that made test invalid


        empty commit since Azure Pipelines did not trigger


        empty commit since Azure Pipelines did not trigger again


        empty commit since Azure Pipelines did not trigger again

Christoph Bergmeister added 30 commits Apr 12, 2020

Replace usage of $MyInvocation.MyCommand.Pat with $PSScriptRoot and c…

2811ab7

…leanup tests

Fix 2 small mistakes, test should now be green again

Loading status checks…

d4f54f5

Adapt build.psm1

eeb251f

Engine tests migration to Pester v5

36d213a

use pester v5 in ci and always upload test results

b25714d

Upgrade Rule tests to Pester v5 using BeforeAll block and addressing …

a498236

…some -Skip problems already

-AllowPrerelease

765aad3

try bootstrap in wmf4

7a67f0e

fix invoke-pester call in CI

9d17571

fix CorrectionExtent.tests.ps1

2de4c20

fix Helper.tests.ps1

a10983e

Fix remaining tests with BeforeAll/AfterAll (discovery works now)

c6dd640

fix UseUsingScopeModifierInNewRunspaces.tests.ps1

35ed07c

make test cases more readable

a350f2b

cleanup UseUsingScopeModifierInNewRunspaces.tests.ps1

5350e87

Fix UseShouldProcessForStateChangingFunctions.tests.ps1

f2e37f3

cleanup UseShouldProcessForStateChangingFunctions.tests.ps1

2a9fa9f

Fix PSCompatibilityCollector/Tests/UtilityApi.Tests.ps1

a5df593

Fix InvokeScriptAnalyzer.tests.ps1

b6e6fda

Format InvokeScriptAnalyzer.tests.ps1

bce0a88

Fix ModuleHelp.Tests.ps1 and cleanup

afb1b98

Fix RuleSuppression.tests.ps1

3413419

Fix Settings.tests.ps1

350f840

format Settings.tests.ps1

6bdf977

Fix Tests/Engine/TextEdit.tests.ps1 and format

f5ef381

Fix AllCompatibilityRules.Tests.ps1

184081f

Fix AvoidUnloadableModuleOrMissingRequiredFieldInManifest.tests.ps1

8c43725

Format AvoidUnloadableModuleOrMissingRequiredFieldInManifest.tests.ps…

be4b0a2

…1 to fix indentation

Fix AvoidUsingPlainTextForPassword.tests.ps1

51a9fa9

fix place*brace tests

78ff1ab

rc8

Verified

This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.

GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits

Loading status checks…

de8889b

bergmeister changed the title ~~Pester v5-rc7~~ Pester v5-rc8 May 14, 2020

Update appveyor.psm1

Verified

This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.

GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits

Loading status checks…

53f1f0b

bergmeister changed the title ~~Pester v5-rc8~~ Pester v5-rc9 May 16, 2020

Christoph Bergmeister added 10 commits May 16, 2020

Merge branch 'master' of https://github.com/powershell/PSScriptAnalyzer…

98fdaf5

… into pesterv5PoC

don't use -CI switch for local build and disable code coverage in CI

Loading status checks…

4b4a976

import pester module before running tests to import types

Loading status checks…

e6d1497

fix property name

Loading status checks…

1dff12d

actually use configuration object (doh)

Loading status checks…

1bd9e96

config object

Loading status checks…

b683115

fix output verbosity

Loading status checks…

edfbd10

fix type casting of [string[]] of pester paths

Loading status checks…

570d287

pester 5 GA

8baab13

Merge branch 'master' of https://github.com/powershell/psscriptanalyzer…

Loading status checks…

752307e

… into pesterv5PoC # Conflicts: # Tests/Rules/UseUsingScopeModifierInNewRunspaces.tests.ps1

bergmeister changed the title ~~Pester v5-rc9~~ Pester v5 May 27, 2020

bergmeister marked this pull request as ready for review May 27, 2020

Pester 5.0.2

Verified

This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.

GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits

Loading status checks…

b4eb871

rjmholt reviewed Jun 2, 2020

View changes

rjmholt approved these changes Jun 4, 2020

View changes

Christoph Bergmeister added 8 commits Jun 7, 2020

move testcases declaration before test

932ca10

remove left-over comments

b540737

remove unnecessary [bool] in if condition

ea23a46

simplify version check to not require [version] type and patch version

6a44a18

fix missing whitespace in test that made test invalid

Loading status checks…

5ee8a38

empty commit since Azure Pipelines did not trigger

Loading status checks…

1619ad8

empty commit since Azure Pipelines did not trigger again

Loading status checks…

6a13f04

empty commit since Azure Pipelines did not trigger again

Loading status checks…

3b21278

bergmeister merged commit 7354892 into PowerShell:master Jun 11, 2020
2 checks passed

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details

license/cla All CLA requirements met.
Details

PowerShell / PSScriptAnalyzer

Pester v5 #1444

Pester v5 #1444

bergmeister commented Apr 17, 2020 •

edited

bergmeister commented May 27, 2020

rjmholt left a comment

PowerShell / PSScriptAnalyzer

Join GitHub today

Pester v5 #1444

Pester v5 #1444

Conversation

bergmeister commented Apr 17, 2020 • edited

PR Summary

PR Checklist

bergmeister commented May 27, 2020

rjmholt left a comment

bergmeister commented Apr 17, 2020 •

edited