|
| 1 | +# Copyright The OpenTelemetry Authors |
| 2 | +# SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +import importlib.util |
| 5 | +from configparser import ConfigParser |
| 6 | +from pathlib import Path |
| 7 | +from textwrap import dedent |
| 8 | + |
| 9 | +from toml import load |
| 10 | + |
| 11 | +PACKAGE_ROOT_GLOBS = ( |
| 12 | + "opentelemetry-*/pyproject.toml", |
| 13 | + "exporter/opentelemetry-*/pyproject.toml", |
| 14 | + "propagator/opentelemetry-*/pyproject.toml", |
| 15 | + "shim/opentelemetry-*/pyproject.toml", |
| 16 | + "tests/opentelemetry-*/pyproject.toml", |
| 17 | + "codegen/opentelemetry-*/pyproject.toml", |
| 18 | +) |
| 19 | +PRIVATE_PACKAGE_CLASSIFIER = "Private :: Do Not Upload" |
| 20 | + |
| 21 | + |
| 22 | +def load_eachdist(): |
| 23 | + script = Path(__file__).parents[1] / "eachdist.py" |
| 24 | + spec = importlib.util.spec_from_file_location("eachdist", script) |
| 25 | + module = importlib.util.module_from_spec(spec) |
| 26 | + spec.loader.exec_module(module) |
| 27 | + return module |
| 28 | + |
| 29 | + |
| 30 | +def write_pyproject(target, dependencies): |
| 31 | + target.mkdir() |
| 32 | + target.joinpath("pyproject.toml").write_text( |
| 33 | + dedent( |
| 34 | + f""" |
| 35 | + [project] |
| 36 | + dependencies = [ |
| 37 | + {dependencies} |
| 38 | + ] |
| 39 | + """ |
| 40 | + ), |
| 41 | + encoding="utf-8", |
| 42 | + ) |
| 43 | + |
| 44 | + |
| 45 | +def write_versioned_project(target, name, version): |
| 46 | + version_file = target / "src" / "opentelemetry" / "version" / "__init__.py" |
| 47 | + version_file.parent.mkdir(parents=True) |
| 48 | + version_file.write_text( |
| 49 | + f'__version__ = "{version}"\n', |
| 50 | + encoding="utf-8", |
| 51 | + ) |
| 52 | + target.mkdir(exist_ok=True) |
| 53 | + target.joinpath("pyproject.toml").write_text( |
| 54 | + dedent( |
| 55 | + f""" |
| 56 | + [project] |
| 57 | + name = "{name}" |
| 58 | +
|
| 59 | + [tool.hatch.version] |
| 60 | + path = "src/opentelemetry/version/__init__.py" |
| 61 | + """ |
| 62 | + ), |
| 63 | + encoding="utf-8", |
| 64 | + ) |
| 65 | + |
| 66 | + |
| 67 | +def project_root(): |
| 68 | + return Path(__file__).parents[2] |
| 69 | + |
| 70 | + |
| 71 | +def package_name(pyproject): |
| 72 | + project = load(pyproject)["project"] |
| 73 | + if PRIVATE_PACKAGE_CLASSIFIER in project.get("classifiers", ()): |
| 74 | + return None |
| 75 | + return project["name"] |
| 76 | + |
| 77 | + |
| 78 | +def test_all_release_packages_are_listed_in_eachdist(): |
| 79 | + root = project_root() |
| 80 | + releasable_package_names = { |
| 81 | + name |
| 82 | + for package_glob in PACKAGE_ROOT_GLOBS |
| 83 | + for pyproject in root.glob(package_glob) |
| 84 | + if (name := package_name(pyproject)) is not None |
| 85 | + } |
| 86 | + |
| 87 | + config = ConfigParser() |
| 88 | + config.read(root / "eachdist.ini") |
| 89 | + eachdist_package_names = set(config["stable"]["packages"].split()) | set( |
| 90 | + config["prerelease"]["packages"].split() |
| 91 | + ) |
| 92 | + |
| 93 | + missing_package_names = sorted( |
| 94 | + releasable_package_names - eachdist_package_names |
| 95 | + ) |
| 96 | + assert not missing_package_names, ( |
| 97 | + "packages missing from eachdist.ini: " |
| 98 | + f"{', '.join(missing_package_names)}" |
| 99 | + ) |
| 100 | + |
| 101 | + |
| 102 | +def test_update_dependencies_matches_exact_package_name(tmp_path): |
| 103 | + eachdist = load_eachdist() |
| 104 | + target = tmp_path / "target" |
| 105 | + write_pyproject( |
| 106 | + target, |
| 107 | + '"opentelemetry-proto == 1.44.0.dev",\n' |
| 108 | + ' "opentelemetry-proto-json == 0.65b0.dev",', |
| 109 | + ) |
| 110 | + |
| 111 | + eachdist.update_dependencies( |
| 112 | + [target], |
| 113 | + "1.44.0", |
| 114 | + ["opentelemetry-proto"], |
| 115 | + ) |
| 116 | + |
| 117 | + pyproject = target.joinpath("pyproject.toml").read_text(encoding="utf-8") |
| 118 | + assert '"opentelemetry-proto == 1.44.0",' in pyproject |
| 119 | + assert '"opentelemetry-proto-json == 0.65b0.dev",' in pyproject |
| 120 | + |
| 121 | + |
| 122 | +def test_update_patch_dependencies_matches_exact_package_name(tmp_path): |
| 123 | + eachdist = load_eachdist() |
| 124 | + target = tmp_path / "target" |
| 125 | + write_pyproject( |
| 126 | + target, |
| 127 | + '"opentelemetry-proto == 1.43.0",\n' |
| 128 | + ' "opentelemetry-proto-json == 1.43.0",', |
| 129 | + ) |
| 130 | + |
| 131 | + eachdist.update_patch_dependencies( |
| 132 | + [target], |
| 133 | + "1.43.1", |
| 134 | + "1.43.0", |
| 135 | + ["opentelemetry-proto"], |
| 136 | + ) |
| 137 | + |
| 138 | + pyproject = target.joinpath("pyproject.toml").read_text(encoding="utf-8") |
| 139 | + assert '"opentelemetry-proto == 1.43.1",' in pyproject |
| 140 | + assert '"opentelemetry-proto-json == 1.43.0",' in pyproject |
| 141 | + |
| 142 | + |
| 143 | +def test_update_version_files_matches_exact_project_name(tmp_path): |
| 144 | + eachdist = load_eachdist() |
| 145 | + proto = tmp_path / "opentelemetry-proto" |
| 146 | + proto_json = tmp_path / "opentelemetry-proto-json" |
| 147 | + write_versioned_project( |
| 148 | + proto, |
| 149 | + "opentelemetry-proto", |
| 150 | + "1.44.0.dev", |
| 151 | + ) |
| 152 | + write_versioned_project( |
| 153 | + proto_json, |
| 154 | + "opentelemetry-proto-json", |
| 155 | + "0.65b0.dev", |
| 156 | + ) |
| 157 | + |
| 158 | + eachdist.update_version_files( |
| 159 | + [proto, proto_json], |
| 160 | + "1.45.0.dev", |
| 161 | + ["opentelemetry-proto"], |
| 162 | + ) |
| 163 | + |
| 164 | + assert ( |
| 165 | + proto.joinpath("src/opentelemetry/version/__init__.py").read_text( |
| 166 | + encoding="utf-8" |
| 167 | + ) |
| 168 | + == '__version__ = "1.45.0.dev"\n' |
| 169 | + ) |
| 170 | + assert ( |
| 171 | + proto_json.joinpath("src/opentelemetry/version/__init__.py").read_text( |
| 172 | + encoding="utf-8" |
| 173 | + ) |
| 174 | + == '__version__ = "0.65b0.dev"\n' |
| 175 | + ) |
0 commit comments