cibuild: Match Travis env variable behaviour

Whenever TRAVIS_TAG is non-empty, TRAVIS_BRANCH is over-ridden to match the
TRAVIS_TAG value. Adjust our tests to reflect this, and add a sanity check that
fails hard if this constraint is ever not met.

See https://github.com/travis-ci/travis-ci/issues/4745
This commit is contained in:
Aldo Cortesi 2018-06-16 10:17:59 +12:00
parent bf791ba1d5
commit 85526e5370
2 changed files with 25 additions and 9 deletions

View File

@ -63,6 +63,12 @@ class BuildEnviron:
self.travis_tag = travis_tag self.travis_tag = travis_tag
self.travis_branch = travis_branch self.travis_branch = travis_branch
if travis_tag and travis_tag != travis_branch:
raise ValueError(
f"Something is wrong - TRAVIS_TAG={travis_tag}, but TRAVIS_BRANCH={travis_branch}"
)
self.travis_pull_request = travis_pull_request self.travis_pull_request = travis_pull_request
self.should_build_wheel = should_build_wheel self.should_build_wheel = should_build_wheel
@ -202,7 +208,7 @@ class BuildEnviron:
@property @property
def is_prod_release(self) -> bool: def is_prod_release(self) -> bool:
if not self.tag: if not (self.tag and self.tag.startswith("v")):
return False return False
try: try:
v = parver.Version.parse(self.version, strict=True) v = parver.Version.parse(self.version, strict=True)

View File

@ -36,6 +36,14 @@ def test_buildenviron_common():
with pytest.raises(cibuild.BuildError): with pytest.raises(cibuild.BuildError):
be.platform_tag be.platform_tag
with pytest.raises(ValueError, match="TRAVIS_TAG"):
be = cibuild.BuildEnviron(
system="Linux",
root_dir="/foo",
travis_tag="one",
travis_branch="two",
)
def test_buildenviron_pr(): def test_buildenviron_pr():
# Simulates a PR. We build everything, but don't have access to secret # Simulates a PR. We build everything, but don't have access to secret
@ -83,7 +91,7 @@ def test_buildenviron_releasetag():
system="Linux", system="Linux",
root_dir="/foo", root_dir="/foo",
travis_tag="v0.0.1", travis_tag="v0.0.1",
travis_branch="v0.x", travis_branch="v0.0.1",
should_build_wheel=True, should_build_wheel=True,
should_build_docker=True, should_build_docker=True,
should_build_pyinstaller=True, should_build_pyinstaller=True,
@ -92,7 +100,7 @@ def test_buildenviron_releasetag():
docker_password="bar", docker_password="bar",
) )
assert be.tag == "v0.0.1" assert be.tag == "v0.0.1"
assert be.branch == "v0.x" assert be.branch == "v0.0.1"
assert be.version == "0.0.1" assert be.version == "0.0.1"
assert be.upload_dir == "0.0.1" assert be.upload_dir == "0.0.1"
assert be.docker_tag == "mitmproxy/mitmproxy:0.0.1" assert be.docker_tag == "mitmproxy/mitmproxy:0.0.1"
@ -107,7 +115,7 @@ def test_buildenviron_namedtag():
system="Linux", system="Linux",
root_dir="/foo", root_dir="/foo",
travis_tag="anyname", travis_tag="anyname",
travis_branch="v0.x", travis_branch="anyname",
should_build_wheel=True, should_build_wheel=True,
should_build_docker=True, should_build_docker=True,
should_build_pyinstaller=True, should_build_pyinstaller=True,
@ -116,7 +124,7 @@ def test_buildenviron_namedtag():
docker_password="bar", docker_password="bar",
) )
assert be.tag == "anyname" assert be.tag == "anyname"
assert be.branch == "v0.x" assert be.branch == "anyname"
assert be.version == "anyname" assert be.version == "anyname"
assert be.upload_dir == "anyname" assert be.upload_dir == "anyname"
assert be.docker_tag == "mitmproxy/mitmproxy:anyname" assert be.docker_tag == "mitmproxy/mitmproxy:anyname"
@ -152,7 +160,7 @@ def test_buildenviron_osx(tmpdir):
system="Darwin", system="Darwin",
root_dir="/foo", root_dir="/foo",
travis_tag="0.0.1", travis_tag="0.0.1",
travis_branch="v0.x", travis_branch="0.0.1",
) )
assert be.platform_tag == "osx" assert be.platform_tag == "osx"
assert be.bdists == { assert be.bdists == {
@ -170,8 +178,8 @@ def test_buildenviron_windows(tmpdir):
be = cibuild.BuildEnviron( be = cibuild.BuildEnviron(
system="Windows", system="Windows",
root_dir="/foo", root_dir="/foo",
travis_tag="0.0.1", travis_tag="v0.0.1",
travis_branch="v0.x", travis_branch="v0.0.1",
) )
assert be.platform_tag == "windows" assert be.platform_tag == "windows"
assert be.bdists == { assert be.bdists == {
@ -193,13 +201,15 @@ def test_buildenviron_windows(tmpdir):
("3.0.0", "v3.0.0", True), # regular release ("3.0.0", "v3.0.0", True), # regular release
("3.0.0.rc1", "v3.0.0.rc1", False), # non-canonical. ("3.0.0.rc1", "v3.0.0.rc1", False), # non-canonical.
("3.0.0.dev", "anyname", True), # tagged test/dev release ("3.0.0.dev", "anyname", True), # tagged test/dev release
("3.0.0", "3.0.0", False), # tagged, but without v prefix
]) ])
def test_buildenviron_check_version(version, tag, ok, tmpdir): def test_buildenviron_check_version(version, tag, ok, tmpdir):
tmpdir.mkdir("mitmproxy").join("version.py").write(f'VERSION = "{version}"') tmpdir.mkdir("mitmproxy").join("version.py").write(f'VERSION = "{version}"')
be = cibuild.BuildEnviron( be = cibuild.BuildEnviron(
root_dir=tmpdir, root_dir=tmpdir,
travis_tag=tag travis_tag=tag,
travis_branch=tag
) )
if ok: if ok:
be.check_version() be.check_version()