8000 Allow [SemanticVersion] to be constructed with just major or major+minor by SteveL-MSFT · Pull Request #3696 · PowerShell/PowerShell · GitHub
[go: up one dir, main page]
Skip to content

Allow [SemanticVersion] to be constructed with just major or major+minor #3696

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

Merged
merged 1 commit into from
May 8, 2017
Merged

Allow [SemanticVersion] to be constructed with just major or major+minor #3696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 23 additions & 4 deletions src/System.Management.Automation/engine/PSVersionInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,25 @@ public SemanticVersion(int major, int minor, int patch)
Label = null;
}

/// <summary>
/// Construct a SemanticVersion.
/// </summary>
/// <param name="major">The major version</param>
/// <param name="minor">The minor version</param>
/// <exception cref="PSArgumentException">
/// If <paramref name="major"/> or <paramref name="minor"/> is less than 0.
/// </exception>
public SemanticVersion(int major, int minor) : this(major, minor, 0) {}

/// <summary>
/// Construct a SemanticVersion.
/// </summary>
/// <param name="major">The major version</param>
/// <exception cref="PSArgumentException">
/// If <paramref name="major"/> is less than 0.
/// </exception>
public SemanticVersion(int major) : this(major, 0, 0) {}

private const string LabelPropertyName = "PSSemanticVersionLabel";

/// <summary>
Expand Down Expand Up @@ -544,24 +563,24 @@ private static bool TryParseVersion(string version, ref VersionResult result)

var versionSansLabel = (dashIndex < 0) ? version : version.Substring(0, dashIndex);
string[] parsedComponents = versionSansLabel.Split(Utils.Separators.Dot);
if (parsedComponents.Length != 3)
if (parsedComponents.Length > 3)
{
result.SetFailure(ParseFailureKind.ArgumentException);
return false;
}

int major, minor, patch;
int major = 0, minor = 0, patch = 0;
if (!TryParseComponent(parsedComponents[0], "major", ref result, out major))
{
return false;
}

if (!TryParseComponent(parsedComponents[1], "minor", ref result, out minor))
if (parsedComponents.Length >= 2 && !TryParseComponent(parsedComponents[1], "minor", ref result, out minor))
{
return false;
}

if (!TryParseComponent(parsedComponents[2], "patch", ref result, out patch))
if (parsedComponents.Length == 3 && !TryParseComponent(parsedComponents[2], "patch", ref result, out patch))
{
return false;
}
Expand Down
28 changes: 23 additions & 5 deletions test/powershell/engine/SemanticVersion.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,20 @@ Describe "SemanticVersion api tests" -Tags 'CI' {
$v.Patch | Should Be 0
$v.Label | Should BeNullOrEmpty
$v.ToString() | Should Be "1.0.0"

$v = [SemanticVersion]::new("3.0")
$v.Major | Should Be 3
$v.Minor | Should Be 0
$v.Patch | Should Be 0
$v.Label | Should BeNullOrEmpty
$v.ToString() | Should Be "3.0.0"

$v = [SemanticVersion]::new("2")
$v.Major | Should Be 2
$v.Minor | Should Be 0
$v.Patch | Should Be 0
$v.Label | Should BeNullOrEmpty
$v.ToString() | Should Be "2.0.0"
}

# After the above test, we trust the properties and rely on ToString for validation
Expand All @@ -27,6 +41,12 @@ Describe "SemanticVersion api tests" -Tags 'CI' {

$v = [SemanticVersion]::new(3, 2, 0, "beta.1")
$v.ToString() | Should Be "3.2.0-beta.1"

$v = [SemanticVersion]::new(3, 1)
$v.ToString() | Should Be "3.1.0"

$v = [SemanticVersion]::new(3)
$v.ToString() | Should Be "3.0.0"
}

It "version arg constructor" {
Expand Down Expand Up @@ -57,6 +77,8 @@ Describe "SemanticVersion api tests" -Tags 'CI' {
@{ lhs = $v1_0_0_alpha; rhs = $v1_0_0_beta }
@{ lhs = $v1_0_0_alpha; rhs = $v1_0_0 }
@{ lhs = $v1_0_0_beta; rhs = $v1_0_0 }
@{ lhs = $v2_1_0; rhs = "3.0"}
@{ lhs = "1.5"; rhs = $v2_1_0}
)
It "less than" -TestCases $testCases {
param($lhs, $rhs)
Expand Down Expand Up @@ -121,8 +143,8 @@ Describe "SemanticVersion api tests" -Tags 'CI' {
@{ expectedResult = $false; version = "" }
@{ expectedResult = $false; version = "1.0.0-" }
@{ expectedResult = $false; version = "-" }
@{ expectedResult = $false; version = "." }
@{ expectedResult = $false; version = "-alpha" }
@{ expectedResult = $false; version = "1.0" } # REVIEW - should this be allowed
@{ expectedResult = $false; version = "1..0" }
@{ expectedResult = $false; version = "1.0.-alpha" }
@{ expectedResult = $false; version = "1.0." }
Expand Down Expand Up @@ -178,10 +200,6 @@ Describe "SemanticVersion api tests" -Tags 'CI' {
# Revision isn't supported
{ [SemanticVersion]::new([Version]::new(0, 0, 0, 4)) } | Should Throw # PSArgumentException
{ [SemanticVersion]::new([Version]::new("1.2.3.4")) } | Should Throw # PSArgumentException

# Build is required
Copy link
Collaborator

Choose a reason for hiding this comment

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

is there a reason why [SemanticVersion]::new() is not supported? It's supported for System.Version

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't know if that was an explicit decision or accidentally left out. I don't see any reason why it shouldn't be supported as it seems 0.0.0 is a valid semver. I'll add support since it's a small change even if not related to this change :)

Copy link
Contributor

Choose a reason for hiding this comment

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

Under what scenario would we want a default constructor? If you want 0.0.0, be explicit.

Copy link
Member Author

Choose a reason for hiding this comment

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

For now, let's error on the side of simplicity and we can revisit this if there's customer demand for it

{ [SemanticVersion]::new([Version]::new(1, 2)) } | Should Throw # PSArgumentException
{ [SemanticVersion]::new([Version]::new("1.2")) } | Should Throw # PSArgumentException
}
}

Expand Down
0