Skip to content

Add specialized parsing function for utsname.release to std.SemanticVersion #25019

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+39 −7
Open

Add specialized parsing function for utsname.release to std.SemanticVersion #25019

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
40 changes: 37 additions & 3 deletions lib/std/SemanticVersion.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,21 @@ pub fn parse(text: []const u8) !Version {
return ver;
}

/// Parse versions coming from `uname` releases that are not fully semver compliant: a '+' sign can be appended without a build version.
/// See https://github.com/torvalds/linux/blob/8f5ae30d69d7543eee0d70083daf4de8fe15d585/scripts/setlocalversion#L197-L210
pub fn parseUtsnameRelease(release: []const u8) !Version {
// Directly parse release if no '+'.
const build_index = std.mem.indexOfScalar(u8, release, '+') orelse return parse(release);

if (build_index == release.len - 1) {
// If '+' is the last character, strip it.
return parse(release[0..build_index]);
}

// There is a '+', but it is not the last character. Keep everything.
return parse(release);
}

fn parseNum(text: []const u8) error{ InvalidVersion, Overflow }!usize {
// Leading zeroes are not allowed.
if (text.len > 1 and text[0] == '0') return error.InvalidVersion;
Expand Down Expand Up @@ -195,7 +210,10 @@ test format {
"1.0.0+0.build.1-rc.10000aaa-kk-0.1",
"5.4.0-1018-raspi",
"5.7.123",
}) |valid| try std.testing.expectFmt(valid, "{f}", .{try parse(valid)});
}) |valid| {
try std.testing.expectFmt(valid, "{f}", .{try parse(valid)});
try std.testing.expectFmt(valid, "{f}", .{try parseUtsnameRelease(valid)});
}

// Invalid version strings should be rejected.
for ([_][]const u8{
Expand Down Expand Up @@ -257,17 +275,24 @@ test format {
"+4",
".",
"....3",
}) |invalid| try expectError(error.InvalidVersion, parse(invalid));
}) |invalid| {
try expectError(error.InvalidVersion, parse(invalid));
try expectError(error.InvalidVersion, parseUtsnameRelease(invalid));
}

// Valid version string that may overflow.
const big_valid = "99999999999999999999999.999999999999999999.99999999999999999";
if (parse(big_valid)) |ver| {
try std.testing.expectFmt(big_valid, "{f}", .{ver});
} else |err| try expect(err == error.Overflow);
if (parseUtsnameRelease(big_valid)) |ver| {
try std.testing.expectFmt(big_valid, "{f}", .{ver});
} else |err| try expect(err == error.Overflow);

// Invalid version string that may overflow.
const big_invalid = "99999999999999999999999.999999999999999999.99999999999999999----RC-SNAPSHOT.12.09.1--------------------------------..12";
if (parse(big_invalid)) |ver| std.debug.panic("expected error, found {f}", .{ver}) else |_| {}
if (parseUtsnameRelease(big_invalid)) |ver| std.debug.panic("expected error, found {f}", .{ver}) else |_| {}
}

test "precedence" {
Expand All @@ -292,9 +317,18 @@ test "precedence" {

test "zig_version" {
// An approximate Zig build that predates this test.
const older_version: Version = .{ .major = 0, .minor = 8, .patch = 0, .pre = "dev.874" };
const older_version: std.SemanticVersion = .{ .major = 0, .minor = 8, .patch = 0, .pre = "dev.874" };
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Without this change, I was getting this error while trying to run zig test lib/std/SemanticVersion.zig:

lib/std/SemanticVersion.zig:323:70: error: expected type 'SemanticVersion', found 'SemanticVersion'
    const compatible = comptime @import("builtin").zig_version.order(older_version) == .gt;
                                                                     ^~~~~~~~~~~~~
lib/std/SemanticVersion.zig:1:1: note: struct declared here
//! A software version formatted according to the Semantic Versioning 2.0.0 specification.
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/home/tibbo/Builds/Zig/zig-x86_64-linux-0.16.0-dev.27+83f773fc6/lib/std/SemanticVersion.zig:1:1: note: struct declared here
/home/tibbo/Builds/Zig/zig-x86_64-linux-0.16.0-dev.27+83f773fc6/lib/std/SemanticVersion.zig:33:33: note: parameter type declared here
pub fn order(lhs: Version, rhs: Version) std.math.Order {
                                ^~~~~~~

Copy link
Member

Choose a reason for hiding this comment

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

Looks like you didn't use --zig-lib-dir to test and ended up with two standard libraries.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, messed up zig lib dir on my side. I will revert this change if the PR is accepted to avoid wasting CI resources.


// Simulated compatibility check using Zig version.
const compatible = comptime @import("builtin").zig_version.order(older_version) == .gt;
if (!compatible) @compileError("zig_version test failed");
}

test "utsname release version" {
// Non compliant utsname release version strings should be correctly parsed.
for ([_][2][]const u8{
.{ "0.0.4", "0.0.4" },
.{ "0.0.4+", "0.0.4" },
.{ "0.0.4+build-info", "0.0.4+build-info" },
}) |valid| try std.testing.expectFmt(valid[1], "{f}", .{try parseUtsnameRelease(valid[0])});
}
6 changes: 2 additions & 4 deletions lib/std/zig/system.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,9 +191,7 @@ pub fn resolveTargetQuery(query: Target.Query) DetectError!Target {
.linux => {
const uts = posix.uname();
const release = mem.sliceTo(&uts.release, 0);
// The release field sometimes has a weird format,
// `Version.parse` will attempt to find some meaningful interpretation.
if (std.SemanticVersion.parse(release)) |ver| {
if (std.SemanticVersion.parseUtsnameRelease(release)) |ver| {
os.version_range.linux.range.min = ver;
os.version_range.linux.range.max = ver;
} else |err| switch (err) {
Expand All @@ -204,7 +202,7 @@ pub fn resolveTargetQuery(query: Target.Query) DetectError!Target {
.solaris, .illumos => {
const uts = posix.uname();
const release = mem.sliceTo(&uts.release, 0);
if (std.SemanticVersion.parse(release)) |ver| {
if (std.SemanticVersion.parseUtsnameRelease(release)) |ver| {
os.version_range.semver.min = ver;
os.version_range.semver.max = ver;
} else |err| switch (err) {
Expand Down