Skip to content

feat: Add FirmwareVersion.Parse(versionString) #220

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.

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
Apr 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 30 additions & 0 deletions Yubico.YubiKey/src/Yubico/YubiKey/FirmwareVersion.cs
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,36 @@ public FirmwareVersion(byte major, byte minor = 0, byte patch = 0)
Minor = minor;
Patch = patch;
}

/// <summary>
/// Parse a string of the form "major.minor.patch"
/// </summary>
/// <param name="versionString"></param>
/// <returns>Returns a FirmwareVersion instance</returns>
/// <exception cref="ArgumentNullException"></exception>
/// <exception cref="ArgumentException"></exception>
public static FirmwareVersion Parse(string versionString)
{
if (versionString is null)
{
throw new ArgumentNullException(nameof(versionString));
}

string[] parts = versionString.Split('.');
if (parts.Length != 3)
{
throw new ArgumentException("Must include major.minor.patch", nameof(versionString));
}

if (!byte.TryParse(parts[0], out byte major) ||
!byte.TryParse(parts[1], out byte minor) ||
!byte.TryParse(parts[2], out byte patch))
{
throw new ArgumentException("Major, minor and patch must be valid numbers", nameof(versionString));
}

return new FirmwareVersion(major, minor, patch);
}

public static bool operator >(FirmwareVersion left, FirmwareVersion right)
{
Expand Down
32 changes: 32 additions & 0 deletions Yubico.YubiKey/tests/unit/Yubico/YubiKey/FirmwareVersionTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,38 @@ namespace Yubico.YubiKey
{
public class FirmwareVersionTests
{
[Fact]
public void Parse_GivenValidString_ReturnsFirmwareVersion()
{
// Arrange

string validString = "1.2.3";

// Act

var fw = FirmwareVersion.Parse(validString);

// Assert

Assert.Equal(1, fw.Major);
Assert.Equal(2, fw.Minor);
Assert.Equal(3, fw.Patch);
}


[Fact]
public void Parse_GivenInvalidString_ThrowsArgumentException()
{
// Arrange

string invalidString = "1.2";

// Act & Assert

Assert.Throws<ArgumentException>(() => FirmwareVersion.Parse(invalidString));
}


[Fact]
public void Major_GetSet_Succeeds()
{
Expand Down
Loading