Skip to content
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

refactor(internal): add a semver parsing utility function #2218

Merged
merged 5 commits into from
Sep 15, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
4 changes: 2 additions & 2 deletions examples/bzlmod/MODULE.bazel.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions python/private/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,11 @@ bzl_library(
srcs = ["repo_utils.bzl"],
)

bzl_library(
name = "semver_bzl",
srcs = ["semver.bzl"],
)

bzl_library(
name = "sentinel_bzl",
srcs = ["sentinel.bzl"],
Expand Down
1 change: 1 addition & 0 deletions python/private/pypi/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ bzl_library(
srcs = ["extension.bzl"],
deps = [
":attrs_bzl",
"//python/private:semver_bzl",
":hub_repository_bzl",
":parse_requirements_bzl",
":evaluate_markers_bzl",
Expand Down
17 changes: 2 additions & 15 deletions python/private/pypi/extension.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ load("@pythons_hub//:interpreters.bzl", "DEFAULT_PYTHON_VERSION", "INTERPRETER_L
load("//python/private:auth.bzl", "AUTH_ATTRS")
load("//python/private:normalize_name.bzl", "normalize_name")
load("//python/private:repo_utils.bzl", "repo_utils")
load("//python/private:semver.bzl", "semver")
load("//python/private:version_label.bzl", "version_label")
load(":attrs.bzl", "use_isolated")
load(":evaluate_markers.bzl", "evaluate_markers", EVALUATE_MARKERS_SRCS = "SRCS")
Expand All @@ -32,22 +33,8 @@ load(":simpleapi_download.bzl", "simpleapi_download")
load(":whl_library.bzl", "whl_library")
load(":whl_repo_name.bzl", "whl_repo_name")

def _parse_version(version):
major, _, version = version.partition(".")
minor, _, version = version.partition(".")
patch, _, version = version.partition(".")
build, _, version = version.partition(".")

return struct(
# use semver vocabulary here
major = major,
minor = minor,
patch = patch, # this is called `micro` in the Python interpreter versioning scheme
build = build,
)

def _major_minor_version(version):
version = _parse_version(version)
version = semver(version)
return "{}.{}".format(version.major, version.minor)

def _whl_mods_impl(mctx):
Expand Down
65 changes: 65 additions & 0 deletions python/private/semver.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Copyright 2024 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"A semver version parser"

def _key(version):
return (
version.major,
version.minor,
version.patch,
# non pre-release versions are higher
version.pre_release == "",
# then we compare each element of the pre_release tag separately
tuple([
(
i if not i.isdigit() else "",
# digit values take precedence
int(i) if i.isdigit() else 0,
)
for i in version.pre_release.split(".")
]) if version.pre_release else None,
# And build info is just alphabetic
version.build,
)

def semver(version):
"""Parse the semver version and return the values as a struct.

Args:
version: {type}`str` the version string

Returns:
A {type}`struct` with `major`, `minor`, `patch` and `build` attributes.
"""

# Implement the https://semver.org/ spec
major, _, tail = version.partition(".")
minor, _, tail = tail.partition(".")
patch, _, build = tail.partition("+")
patch, _, pre_release = patch.partition("-")

public = struct(
major = int(major),
minor = int(minor or "0"),
# NOTE: this is called `micro` in the Python interpreter versioning scheme
patch = int(patch or "0"),
pre_release = pre_release,
build = build,
# buildifier: disable=uninitialized
key = lambda: _key(self.actual),
str = lambda: version,
)
self = struct(actual = public)
return public
17 changes: 17 additions & 0 deletions tests/semver/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Copyright 2024 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

load(":semver_test.bzl", "semver_test_suite")

semver_test_suite(name = "semver_tests")
113 changes: 113 additions & 0 deletions tests/semver/semver_test.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
# Copyright 2023 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

""

load("@rules_testing//lib:test_suite.bzl", "test_suite")
load("//python/private:semver.bzl", "semver") # buildifier: disable=bzl-visibility

_tests = []

def _test_semver_from_major(env):
actual = semver("3")
env.expect.that_int(actual.major).equals(3)
env.expect.that_int(actual.minor).equals(0)
env.expect.that_int(actual.patch).equals(0)
env.expect.that_str(actual.build).equals("")

_tests.append(_test_semver_from_major)

def _test_semver_from_major_minor_version(env):
actual = semver("4.9")
env.expect.that_int(actual.major).equals(4)
env.expect.that_int(actual.minor).equals(9)
env.expect.that_int(actual.patch).equals(0)
env.expect.that_str(actual.build).equals("")

_tests.append(_test_semver_from_major_minor_version)

def _test_semver_with_build_info(env):
actual = semver("1.2.3+mybuild")
env.expect.that_int(actual.major).equals(1)
env.expect.that_int(actual.minor).equals(2)
env.expect.that_int(actual.patch).equals(3)
env.expect.that_str(actual.build).equals("mybuild")

_tests.append(_test_semver_with_build_info)

def _test_semver_with_build_info_multiple_pluses(env):
actual = semver("1.2.3-rc0+build+info")
env.expect.that_int(actual.major).equals(1)
env.expect.that_int(actual.minor).equals(2)
env.expect.that_int(actual.patch).equals(3)
env.expect.that_str(actual.pre_release).equals("rc0")
env.expect.that_str(actual.build).equals("build+info")

_tests.append(_test_semver_with_build_info_multiple_pluses)

def _test_semver_alpha_beta(env):
actual = semver("1.2.3-alpha.beta")
env.expect.that_int(actual.major).equals(1)
env.expect.that_int(actual.minor).equals(2)
env.expect.that_int(actual.patch).equals(3)
env.expect.that_str(actual.pre_release).equals("alpha.beta")

_tests.append(_test_semver_alpha_beta)

def _test_semver_sort(env):
want = [
semver(item)
for item in [
# The items are sorted from lowest to highest version
"0.0.1",
"0.1.0-rc",
"0.1.0",
"0.9.11",
"0.9.12",
"1.0.0-alpha",
"1.0.0-alpha.1",
"1.0.0-alpha.beta",
"1.0.0-beta",
"1.0.0-beta.2",
"1.0.0-beta.11",
"1.0.0-rc.1",
"1.0.0-rc.2",
"1.0.0",
# Also handle missing minor and patch version strings
"2.0",
"3",
# Alphabetic comparison for different builds
"3.0.0+build0",
"3.0.0+build1",
]
]
actual = sorted(want, key = lambda x: x.key())
env.expect.that_collection(actual).contains_exactly(want).in_order()
for i, greater in enumerate(want[1:]):
smaller = actual[i]
if greater.key() <= smaller.key():
env.fail("Expected '{}' to be smaller than '{}', but got otherwise".format(
smaller.str(),
greater.str(),
))

_tests.append(_test_semver_sort)

def semver_test_suite(name):
"""Create the test suite.

Args:
name: the name of the test suite
"""
test_suite(name = name, basic_tests = _tests)