GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Fixed ScriptsToProcess when -Version param is used in Import-Module by anmenaga · Pull Request #3897 · PowerShell/PowerShell

Conversation

@anmenaga

@anmenaga Andrew (anmenaga) commented May 31, 2017

Copy link
Copy Markdown

This is fix for #3738 "ScriptsToProcess not honored when Import-Module is passed -Version param".

The bug was cased by existing check in LoadModule functions:

If MinimumVersion/RequiredVersion/MaximumVersion has been specified, then only try to process manifest modules...
If the -Version flag was specified, don't look for non-manifest modules.

When loading usual module files, this check is valid;
However, same LoadModule function is used to load ScriptsToProcess - and this when this check was
triggered and ScriptsToProcess were not executed.

The fix is to work around that condition for ScriptsToProcess in the same way it is currently done for NestedModules - temporary reset the version info for the duration of processing ScriptsToProcess / NestedModules.

Test results before the fix:
befoerfix

Test results after the fix:
afterfix

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Andrew
Fixed ScriptsToProcess when -Version param is used in Import-Module
71098a3
@anmenaga
Andrew (anmenaga) requested a review from Aditya Patwardhan (adityapatwardhan) May 31, 2017 18:04
@msftclas Microsoft Contribution License Agreements (msftclas) added the cla-not-required label May 31, 2017
adityapatwardhan
Aditya Patwardhan (adityapatwardhan) requested changes May 31, 2017
View reviewed changes
Comment thread src/System.Management.Automation/engine/Modules/ModuleCmdletBase.cs
manifestInfo.AddDetectedCmdletExport(detectedCmdlet);
}
bool found = false;
PSModuleInfo module = LoadModule(scriptFile,

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) May 31, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you use named parameters. Example: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/named-and-optional-arguments

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@anmenaga Andrew (anmenaga) May 31, 2017

Copy link
Copy Markdown
Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is actually existing code; I didn't change it; looks like Github's diff'er has room for improvement :) - see picture below.
Anyway, there are multiple LoadModule calls like this one throughout the file, so if refactoring is to be done - it has to be done to all of them - and that is out of scope of this bugfix.

diff

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread src/System.Management.Automation/engine/Modules/ModuleCmdletBase.cs
}
foreach (string detectedCmdlet in module.ExportedCmdlets.Keys)
{
manifestInfo.AddDetectedCmdletExport(detectedCmdlet);

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) May 31, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AddDetected* methods from PSModuleInfo in most cases seem to be called multiple times using a for loop. Will it make sense to add an overload which accepts IEnumerable?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@anmenaga Andrew (anmenaga) May 31, 2017

Copy link
Copy Markdown
Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe. But as previous comment - this would be refactoring of unrelated code - out of scope of this bug fix.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread test/powershell/Modules/Microsoft.PowerShell.Core/Import-Module.Tests.ps1 Outdated
Import-Module .\module2.psd1 -Version 1.0
Get-Content out.txt | Should Be '21'
}
} No newline at end of file

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) May 31, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add new line at the end.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@anmenaga Andrew (anmenaga) May 31, 2017

Copy link
Copy Markdown
Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread test/powershell/Modules/Microsoft.PowerShell.Core/Import-Module.Tests.ps1 Outdated

AfterAll {
Pop-Location
#Remove-Item $moduleRootPath -Recurse -Force -ErrorAction SilentlyContinue

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) May 31, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove commented line.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@anmenaga Andrew (anmenaga) May 31, 2017

Copy link
Copy Markdown
Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread test/powershell/Modules/Microsoft.PowerShell.Core/Import-Module.Tests.ps1 Outdated
Remove-Item out.txt -Force -ErrorAction SilentlyContinue
}

It "Verify ScriptsToProcess are executed for top-level module" {

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) May 31, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You may want to take a look at TestCases parameter of Pester It.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@anmenaga Andrew (anmenaga) May 31, 2017

Copy link
Copy Markdown
Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for suggestion; I did give it a try. I believe that semantic difference between these tests is larger than what TestCases parameter is aimed for; plus I don't like that TestCases parameter has worse logging (same test name repeated several times vs individual, descriptive test names in case of individual 'It's).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) Jun 1, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can have custom test case names for individual test cases. Have look at: https://github.com/PowerShell/PowerShell/blob/02b5f357a20e6dee9f8e60e3adb9025be3c94490/test/powershell/engine/ParameterBinding/NullableBooleanDCR.Tests.ps1

Here the parameters will be parameter splat for Import-Module, and expected result, test name.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@anmenaga Andrew (anmenaga) Jun 2, 2017

Copy link
Copy Markdown
Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is actually cool; thank you!
I've updated tests.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@anmenaga Andrew (anmenaga) Jun 2, 2017

Copy link
Copy Markdown
Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea; I've updated tests.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread test/powershell/Modules/Microsoft.PowerShell.Core/Import-Module.Tests.ps1
BeforeAll {
$moduleRootPath = Join-Path $TestDrive 'TestModules'
New-Item $moduleRootPath -ItemType Directory -Force | Out-Null
Push-Location $moduleRootPath

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) May 31, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do you need to push location? Can you use full paths for all cmdlets like New-Item, New-ModuleManifest etc?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@anmenaga Andrew (anmenaga) May 31, 2017

Copy link
Copy Markdown
Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I chose push location specifically because I didn't want to deal with full paths. :)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Andrew
Addressed feedback
9ec6651
adityapatwardhan
Aditya Patwardhan (adityapatwardhan) requested changes Jun 1, 2017
View reviewed changes
Comment thread test/powershell/Modules/Microsoft.PowerShell.Core/Import-Module.Tests.ps1 Outdated
Remove-Item out.txt -Force -ErrorAction SilentlyContinue
}

It "Verify ScriptsToProcess are executed for top-level module" {

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) Jun 1, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can have custom test case names for individual test cases. Have look at: https://github.com/PowerShell/PowerShell/blob/02b5f357a20e6dee9f8e60e3adb9025be3c94490/test/powershell/engine/ParameterBinding/NullableBooleanDCR.Tests.ps1

Here the parameters will be parameter splat for Import-Module, and expected result, test name.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Andrew
Updated tests
03d4772
adityapatwardhan
Aditya Patwardhan (adityapatwardhan) approved these changes Jun 2, 2017
View reviewed changes
@anmenaga Andrew (anmenaga) assigned Dongbo Wang (daxian-dbw) Jun 2, 2017
@daxian-dbw
Dongbo Wang (daxian-dbw) merged commit 28ec9a3 into PowerShell:master Jun 5, 2017
@anmenaga
Andrew (anmenaga) deleted the ScriptsToProcessVersionFix branch October 31, 2018 21:20
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
Andrew @daxian-dbw
Fix Import-Module to honor 'ScriptsToProcess' when '-Version' is spec…
29ad5c4 
…ified (PowerShell#3897)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) adityapatwardhan approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@daxian-dbw Dongbo Wang (daxian-dbw)

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@anmenaga @adityapatwardhan @daxian-dbw @msftclas
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.