Skip to content

Throw error message when MaxumimVersion is less than Version when using Import-Module cmdlet with -FullyQualifiedName parameter. #7347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Sergey Vasin (sethvs) wants to merge 7 commits into from
Closed

Throw error message when MaxumimVersion is less than Version when using Import-Module cmdlet with -FullyQualifiedName parameter. #7347

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4d0da14
Throw error message when MaxumimVersion is less than Version when usi…
sethvs Jul 24, 2018
321537c
Fix logic and typos.
sethvs Jul 24, 2018
9b27ae8
Fix error message.
sethvs Aug 15, 2018
77241e1
Add test.
sethvs Aug 15, 2018
fdfe12e
Split nonrelated fixes into separate PRs.
sethvs Aug 30, 2018
3f4d778
Merge branch 'master' into importModule
sethvs Sep 5, 2018
1a784a4
Fix error introduced while resolving conflict.
sethvs Sep 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/System.Management.Automation/engine/Modules/ModuleSpecification.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ internal static Exception ModuleSpecificationInitHelper(ModuleSpecification modu
string message;
if (badKeys.Length != 0)
{
message = StringUtil.Format(Modules.InvalidModuleSpecificationMember, "ModuleName, ModuleVersion, RequiredVersion, GUID", badKeys);
message = StringUtil.Format(Modules.InvalidModuleSpecificationMember, "ModuleName, ModuleVersion, MaximumVersion, RequiredVersion, GUID", badKeys);

@anmenaga Andrew (anmenaga) Aug 1, 2018

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Please add to PR Summary:

Also fixing following error message to include 'MaximumVersion' in the list of 'valid members':
  <data name="InvalidModuleSpecificationMember" xml:space="preserve">
    <value>The hashtable describing a module contains one or more members that are not valid.  The valid members are ({0}). Remove the members that are not valid ({1}), then try again.</value>
  </data>

@sethvs Sergey Vasin (sethvs) Aug 2, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done.

@rjmholt Rob Holt (rjmholt) Aug 15, 2018

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Ideally this should use $"{nameof(...)}" for the bad members

@sethvs Sergey Vasin (sethvs) Aug 15, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

nameof(badKeys) returns 'badKeys', but we need its actual value.
Or am I missing something?

return new ArgumentException(message);
}

Expand All @@ -163,6 +163,13 @@ internal static Exception ModuleSpecificationInitHelper(ModuleSpecification modu
message = StringUtil.Format(SessionStateStrings.GetContent_TailAndHeadCannotCoexist, "MaximumVersion", "RequiredVersion");
return new ArgumentException(message);
}

if (moduleSpecification.Version != null && moduleSpecification.MaximumVersion != null &&
moduleSpecification.Version > ModuleCmdletBase.GetMaximumVersion(moduleSpecification.MaximumVersion))
{
message = StringUtil.Format(Modules.ModuleSpecificationMemberIsLessThanOther, "MaximumVersion", "ModuleVersion");
return new ArgumentException(message);
}
return null;
}

Expand Down
3 changes: 3 additions & 0 deletions src/System.Management.Automation/resources/Modules.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,9 @@
<data name="InvalidModuleSpecificationMember" xml:space="preserve">
<value>The hashtable describing a module contains one or more members that are not valid. The valid members are ({0}). Remove the members that are not valid ({1}), then try again.</value>
</data>
<data name="ModuleSpecificationMemberIsLessThanOther" xml:space="preserve">

@rjmholt Rob Holt (rjmholt) Aug 15, 2018

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The error message should ideally be slightly more specific. Something like:

The hashtable describing a module cannot have its ModuleVersion ({0}) greater than its MaximumVersion ({1}).

@sethvs Sergey Vasin (sethvs) Aug 15, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done.

<value>The member '{0}' cannot be less than '{1}'.</value>
</data>
<data name="ModuleTooDeeplyNested" xml:space="preserve">
<value>Cannot load the module '{0}' because the module nesting limit has been exceeded. Modules can only be nested to {1} levels. Evaluate and change the order in which you are loading modules to prevent exceeding the nesting limit, and then try running your script again.</value>
</data>
Expand Down
4 changes: 4 additions & 0 deletions test/powershell/Modules/Microsoft.PowerShell.Core/Import-Module.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ Describe "Import-Module" -Tags "CI" {
Import-Module TestModule -RequiredVersion 1.1
(Get-Module TestModule).Version | Should -BeIn "1.1"
}

It "should throw if 'MaximumVersion' is less than 'Version' when using -FullyQualifiedName parameter" {

@rjmholt Rob Holt (rjmholt) Aug 15, 2018

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

In addition to this test, we should add a more specific one using the [ModuleSpecification] constructor.

You should find those tests here (I know that's not an obvious place at all).

Note to self: once #7499 is merged, this test will be included in that.

@rjmholt Rob Holt (rjmholt) Aug 15, 2018

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Let me know if you need any help on creating that test btw, I'm always happy to

@sethvs Sergey Vasin (sethvs) Aug 15, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done.

{ Import-Module -FullyQualifiedName @{ModuleName = $moduleName; ModuleVersion = '2.0'; MaximumVersion = '1.0'} } | Should -Throw -ExceptionType 'System.Management.Automation.ParameterBindingException'
}
}

Describe "Import-Module with ScriptsToProcess" -Tags "CI" {
Expand Down