Refactor tests testmodules #297

anamnavi · 2020-10-26T15:51:45Z

Refactored the Find tests to use test modules instead of production modules. Since the team has control and ownership over these test modules, testing for an exact version or anything else that is dependent upon the package not being updated is less error prone than before. This makes the tests more reliable as a failing test would indicate an error with the code, not dependent packages having changed. Resolves #263

…rest

…e yet in v3

SteveL-MSFT · 2020-11-02T18:07:43Z

test/FindResource.Command.Tests.ps1

- $res = Find-PSResource -Name NonExistantCommand
- $res | Should -BeNullOrEmpty
+ It "find Command resource given Name parameter" {
+ $res = Find-PSResource -Name "test_command_module"


I think test modules should use the namespace: Microsoft.PowerShell.Test.*

I discussed this with Amber and her view was that we may be better off changing this when we move to NuGet gallery or reach the situation when we need the names to have the Microsoft namespace to stand out and not conflict with generic test modules. The way to change the name from something like test_module to Microsoft.PowerShell.Test.* is to either create a new module with this name or to update it in the database/from the backend which Amber could do. It's not a simple update by publishing the module with an updated version (with the name change made in). So her suggestion was to update once when we know for sure what we want it to be like.

test/FindResource.Command.Tests.ps1

test/FindResource.Module.Tests.ps1

test/FindResource.RoleCapability.Tests.ps1

test/FindResource.Script.Tests.ps1

test/testRepositories.xml

SteveL-MSFT · 2020-11-02T18:21:20Z

test/testRepositories.xml

 <configuration>
- <Repository Name="psgettestlocal" Url="file:///c:/code/testdir" Priority="50" Trusted="false" />
+
+ <Repository Name="psgettestlocal" Url="file:///c:/code/testdir" Priority="40" Trusted="false" />


these file paths only work on Windows and only if that machine has C: drive which isn't guaranteed

Good point! My thought was that this filepath gets changed before it's ever used, but I see that it's better to not have to rely on that alone. Better to not introduce something that could cause an issue later or if misused. Additionally, this really helped my understanding of how PSGet registers the default repos and which ones. I removed this and instead register the test repo and unregister it in the PSGetTestUtils file now, with Join-Path to create the path.

…ect module

… into refactor-tests-testmodules

…ng load on PSGallery

… into refactor-tests-testmodules

test/FindResource.Command.Tests.ps1

SteveL-MSFT · 2020-11-17T17:47:27Z

test/FindResource.Command.Tests.ps1

- catch {}
-
- $res | Should -BeNullOrEmpty
+ {Find-PSResource -Name "test_command_module" -Version $Version -Repository $TestGalleryName -ErrorAction Ignore} | Should -Throw -ExceptionType ([ArgumentException])


Suggested change

{Find-PSResource -Name "test_command_module" -Version $Version -Repository $TestGalleryName -ErrorAction Ignore} | Should -Throw -ExceptionType ([ArgumentException])

{ Find-PSResource -Name "test_command_module" -Version $Version -Repository $TestGalleryName -ErrorAction Ignore } | Should -Throw -ExceptionType ([ArgumentException])

Why is -ErrorAction Ignore used here?

test/FindResource.Command.Tests.ps1

SteveL-MSFT · 2020-11-17T17:50:06Z

test/FindResource.Command.Tests.ps1

+ Find-PSResource -Name "test_command_module" -Version "*" -Repository $TestGalleryName | ForEach-Object {
+ if($_.Name -eq "test_command_module") {
+ $expectedModules += $_.Name
+ }


Is there a reason to filter out incorrect results that may be returned? Seems like this test should validate that each returned module has the right name

test/FindResource.DSCResource.Tests.ps1

SteveL-MSFT · 2020-11-17T17:52:27Z

test/FindResource.Command.Tests.ps1

+ ) {
+ param($Version, $Description)
+
+ $res = Find-PSResource -Name "test_command_module" -Version $Version -Repository $TestGalleryName -ErrorAction Ignore


I thought we were going to use namespaced test module names?

SteveL-MSFT · 2020-11-17T17:56:24Z

test/FindResource.Module.Tests.ps1

- $res = Find-PSResource -ModuleName "test_module" -Version "*" -Repository $TestGalleryName
- $res.Count | Should -Be 7
+ $expectedModules = @()
+ Find-PSResource -ModuleName "test_module" -Version "*" -Repository $TestGalleryName | ForEach-Object {


This code is similar in several cases, you can use -TestCases with splatting to cover different parameter variations and use the same validation code. Something like:

It "... with parameter '<Parameter>'" -TestCases @( @{ Parameter = 'Name' } @{ Parameter = 'ModuleName' } ) { param($parameter) ... $parameters = @{ $parameter = 'test_module' Version = '*' Repository = $TestGalleryName } Find-PSResource @parameters

SteveL-MSFT · 2020-11-17T17:57:32Z

test/PSGetTestUtils.psm1

 $script:PostTestGalleryLocation = 'https://www.poshtestgallery.com/api/v2'

+$script:command_test_module = @(
+ @{Name="test_command_module"; Version="2.5.0.0"; Repository="PoshTestGallery"; Description="this a test command resource of type module"},


lots of repetition, so recommend storing repeated values in a variable in case they need to change in the future or reused

stored in variable.

JamesWTruher · 2020-11-17T17:27:35Z

test/FindResource.Command.Tests.ps1

 $PSGalleryName = Get-PSGalleryName
+ $CommandTest = Get-CommandTestModule
 Get-NewPSResourceRepositoryFile
+ Get-RegisterLocalRepos


Suggested change

Get-RegisterLocalRepos

Register-LocalRepos

JamesWTruher · 2020-11-17T17:28:14Z

test/FindResource.Command.Tests.ps1

- $res = Find-PSResource -Name Az.Compute
- $res | Should -Not -BeNullOrEmpty
- $res.Name | Should -Be "Az.Compute"
+ Get-UnregisterLocalRepos


Suggested change

Get-UnregisterLocalRepos

Unregister-LocalRepos

Register and Unregister are approved verbs

…tUtils

anamnavi added 10 commits October 16, 2020 18:44

changed role capability and dsc resource tests to use test modules

6763540

refactored command tests to use test module

3886a28

refactored module test to use test module instead of production ones

8b19d29

refactored script tests to use test modules

8883dcf

added test to find resource published to local repos

0863aaa

fixing merge conflicts when pulled from upstream master

a366deb

fixed commented out DSC and Command tests, tests all work now

e46f1a5

added tests to get resource published to multiple local repos

00951ee

standardizing tests across module and command test files

5b42612

standardizing tests across script, role cap, dsc resource tests with …

30af8d4

…rest

anamnavi requested review from SteveL-MSFT and alerickson October 26, 2020 15:51

anamnavi added 2 commits October 26, 2020 11:53

removed unintended change from FindPSResource.cs

4aec128

remove wildcard tests, as implementation for that isn't fully reliabl…

8e64f12

…e yet in v3

anamnavi self-assigned this Oct 28, 2020

SteveL-MSFT requested changes Nov 2, 2020

View reviewed changes

SteveL-MSFT requested a review from JamesWTruher November 2, 2020 18:21

anamnavi added 9 commits November 9, 2020 15:42

modified version '*' test to check each returned resource is the corr…

0a2a555

…ect module

Merge branch 'development' of https://github.com/anamnavi/PowerShellGet…

9ed2998

… into refactor-tests-testmodules

stored test module versions as hashtables and used that to match count

d7fa794

stripped whitespace

f76569a

replaced try/catch with throw with specific error test

dd95534

refactored when/how local repos get registered and removed test putti…

afc5e85

…ng load on PSGallery

removed Set-PSResourceRepository comments

6c7b8e0

changed should throw from checking error msg to exception type

e4bfc5e

Merge branch 'development' of https://github.com/anamnavi/PowerShellGet…

96c667b

… into refactor-tests-testmodules

SteveL-MSFT requested changes Nov 17, 2020

View reviewed changes

JamesWTruher reviewed Nov 17, 2020

View reviewed changes

anamnavi added 2 commits November 18, 2020 20:36

changed expected to actual, and method noun name

9f26999

added space

5471325

used variable and methods to refactor test modules stored in PSGetTes…

b6da9d5

…tUtils

anamnavi closed this Jun 21, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Refactor tests testmodules #297

Refactor tests testmodules #297

Uh oh!

anamnavi commented Oct 26, 2020 •

edited

Loading

SteveL-MSFT Nov 2, 2020

anamnavi Nov 17, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SteveL-MSFT Nov 2, 2020

anamnavi Nov 17, 2020 •

edited

Loading

Uh oh!

Uh oh!

SteveL-MSFT Nov 17, 2020

SteveL-MSFT Nov 17, 2020

Uh oh!

SteveL-MSFT Nov 17, 2020

Uh oh!

SteveL-MSFT Nov 17, 2020

SteveL-MSFT Nov 17, 2020

SteveL-MSFT Nov 17, 2020

anamnavi Nov 19, 2020

JamesWTruher Nov 17, 2020

JamesWTruher Nov 17, 2020

Labels

3 participants

	{Find-PSResource -Name "test_command_module" -Version $Version -Repository $TestGalleryName -ErrorAction Ignore} \| Should -Throw -ExceptionType ([ArgumentException])
	{ Find-PSResource -Name "test_command_module" -Version $Version -Repository $TestGalleryName -ErrorAction Ignore } \| Should -Throw -ExceptionType ([ArgumentException])

Refactor tests testmodules #297

Refactor tests testmodules #297

Uh oh!

Conversation

anamnavi commented Oct 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

anamnavi Nov 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Labels

3 participants

anamnavi commented Oct 26, 2020 •

edited

Loading

anamnavi Nov 17, 2020 •

edited

Loading