-
Notifications
You must be signed in to change notification settings - Fork 830
test: validate Micrometer vanilla compatibility #2121
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
Open
zeitlinger
wants to merge
1
commit into
prometheus:main
Choose a base branch
from
zeitlinger:validation/typed-descriptor-micrometer-2094
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| --- | ||
| name: Micrometer Compatibility | ||
|
|
||
| on: | ||
| pull_request: | ||
| workflow_dispatch: | ||
| inputs: | ||
| micrometer-repository: | ||
| description: Micrometer repository to test, in owner/name form | ||
| required: false | ||
| default: micrometer-metrics/micrometer | ||
| micrometer-ref: | ||
| description: Micrometer branch, tag, or commit to test | ||
| required: false | ||
| default: main | ||
|
|
||
| permissions: {} | ||
|
|
||
| jobs: | ||
| micrometer-compatibility: | ||
| runs-on: ubuntu-24.04 | ||
| steps: | ||
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 | ||
| with: | ||
| persist-credentials: false | ||
| - uses: jdx/mise-action@1648a7812b9aeae629881980618f079932869151 # v4.0.1 | ||
| with: | ||
| version: v2026.5.5 | ||
| sha256: 3aaab5c05a8a94a93b42b4f581779bbd5c44ddb251e7f3639fc671ec5c6aab8a | ||
| - name: Cache local Maven repository | ||
| uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 | ||
| with: | ||
| path: ~/.m2/repository | ||
| key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-maven- | ||
| - name: Run Micrometer compatibility tests | ||
| run: | | ||
| if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then | ||
| export MICROMETER_REPOSITORY="${{ github.event.inputs.micrometer-repository }}" | ||
| export MICROMETER_REF="${{ github.event.inputs.micrometer-ref }}" | ||
| fi | ||
| mise run micrometer:test |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import os | ||
| import subprocess | ||
| import xml.etree.ElementTree as ET | ||
| from pathlib import Path | ||
| from typing import Optional | ||
|
|
||
|
|
||
| DEFAULT_MICROMETER_DIR = Path( | ||
| os.environ.get("MICROMETER_DIR", "/tmp/micrometer-compat") | ||
| ) | ||
| DEFAULT_MICROMETER_REPOSITORY = os.environ.get( | ||
| "MICROMETER_REPOSITORY", "micrometer-metrics/micrometer" | ||
| ) | ||
| DEFAULT_MICROMETER_REMOTE = os.environ.get("MICROMETER_REMOTE", "origin") | ||
| DEFAULT_MICROMETER_REF = os.environ.get("MICROMETER_REF", "main") | ||
| DEFAULT_INIT_SCRIPT = Path( | ||
| os.environ.get("MICROMETER_INIT_SCRIPT", "/tmp/micrometer-prom-local.init.gradle") | ||
| ) | ||
| DEFAULT_PROM_VERSION = os.environ.get("PROM_VERSION") | ||
|
|
||
|
|
||
| def run_cmd(cmd: list[str], cwd: Optional[Path] = None) -> None: | ||
| subprocess.run(cmd, cwd=cwd, check=True) | ||
|
|
||
|
|
||
| def micrometer_repository_url(repository: str) -> str: | ||
| return f"https://github.com/{repository}.git" | ||
|
|
||
|
|
||
| def check_clean_worktree(micrometer_dir: Path) -> None: | ||
| result = subprocess.run( | ||
| ["git", "status", "--short"], | ||
| cwd=micrometer_dir, | ||
| check=True, | ||
| capture_output=True, | ||
| text=True, | ||
| ) | ||
| if result.stdout.strip(): | ||
| raise RuntimeError( | ||
| f"{micrometer_dir} has uncommitted changes; use a clean clone or set MICROMETER_DIR" | ||
| ) | ||
|
|
||
|
|
||
| def get_prom_version(root_dir: Path = Path.cwd()) -> str: | ||
| configured_version = DEFAULT_PROM_VERSION | ||
| if configured_version: | ||
| return configured_version | ||
| pom = ET.parse(root_dir / "pom.xml") | ||
| root = pom.getroot() | ||
| version = root.findtext("./{*}version") | ||
| if not version: | ||
| version = root.findtext("./{*}parent/{*}version") | ||
| if not version: | ||
| raise RuntimeError("could not determine Prometheus version from pom.xml") | ||
| return version | ||
|
|
||
|
|
||
| def write_init_script( | ||
| init_script: Path = DEFAULT_INIT_SCRIPT, prom_version: Optional[str] = None | ||
| ) -> None: | ||
| if prom_version is None: | ||
| prom_version = get_prom_version() | ||
| init_script.write_text( | ||
| f"""allprojects {{ | ||
| repositories {{ | ||
| mavenLocal() | ||
| mavenCentral() | ||
| gradlePluginPortal() | ||
| }} | ||
| configurations.configureEach {{ | ||
| resolutionStrategy.eachDependency {{ details -> | ||
| if (details.requested.group == 'io.prometheus') {{ | ||
| details.useVersion('{prom_version}') | ||
| details.because( | ||
| 'Use local prom_client_java artifacts for downstream compatibility testing' | ||
| ) | ||
| }} | ||
| }} | ||
| }} | ||
| }} | ||
| """, | ||
| encoding="utf-8", | ||
| ) | ||
|
|
||
|
|
||
| def prepare_repo( | ||
| micrometer_dir: Path = DEFAULT_MICROMETER_DIR, | ||
| repository: str = DEFAULT_MICROMETER_REPOSITORY, | ||
| remote: str = DEFAULT_MICROMETER_REMOTE, | ||
| ref: str = DEFAULT_MICROMETER_REF, | ||
| ) -> None: | ||
| repository_url = micrometer_repository_url(repository) | ||
| if (micrometer_dir / ".git").is_dir(): | ||
| check_clean_worktree(micrometer_dir) | ||
| run_cmd( | ||
| ["git", "remote", "set-url", remote, repository_url], cwd=micrometer_dir | ||
| ) | ||
| run_cmd(["git", "fetch", remote, ref], cwd=micrometer_dir) | ||
| else: | ||
| run_cmd( | ||
| [ | ||
| "git", | ||
| "clone", | ||
| repository_url, | ||
| str(micrometer_dir), | ||
| ] | ||
| ) | ||
| run_cmd(["git", "fetch", remote, ref], cwd=micrometer_dir) | ||
| run_cmd( | ||
| ["git", "checkout", "-B", "codex-micrometer-compat", "FETCH_HEAD"], | ||
| cwd=micrometer_dir, | ||
| ) | ||
|
|
||
|
|
||
| def install_local_artifacts(root_dir: Path = Path.cwd()) -> None: | ||
| run_cmd( | ||
| [ | ||
| "./mvnw", | ||
| "install", | ||
| "-DskipTests", | ||
| "-Dcoverage.skip=true", | ||
| "-Dcheckstyle.skip=true", | ||
| "-Dwarnings=-nowarn", | ||
| ], | ||
| cwd=root_dir, | ||
| ) | ||
|
|
||
|
|
||
| def run_gradle_test( | ||
| test_selector: Optional[str] = None, | ||
| micrometer_dir: Path = DEFAULT_MICROMETER_DIR, | ||
| init_script: Path = DEFAULT_INIT_SCRIPT, | ||
| ) -> None: | ||
| cmd = [ | ||
| "./gradlew", | ||
| "--no-daemon", | ||
| "-I", | ||
| str(init_script), | ||
| ":micrometer-registry-prometheus:test", | ||
| ] | ||
| if test_selector: | ||
| cmd.extend(["--tests", test_selector]) | ||
| run_cmd(cmd, cwd=micrometer_dir) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| # [MISE] description="Install local artifacts and check out a target Micrometer ref" | ||
| # [MISE] alias="micrometer:prepare" | ||
|
|
||
| import sys | ||
|
|
||
|
|
||
| sys.path.insert(0, ".mise/lib") | ||
|
|
||
|
|
||
| def main() -> int: | ||
| from micrometer_compat import ( | ||
| install_local_artifacts, | ||
| prepare_repo, | ||
| write_init_script, | ||
| ) | ||
|
|
||
| install_local_artifacts() | ||
| prepare_repo() | ||
| write_init_script() | ||
| return 0 | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| raise SystemExit(main()) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| # [MISE] description="Run Micrometer PrometheusMeterRegistryTest against a target Micrometer ref" | ||
| # [MISE] alias="micrometer:test-class" | ||
|
|
||
| import sys | ||
|
|
||
|
|
||
| sys.path.insert(0, ".mise/lib") | ||
|
|
||
|
|
||
| def main() -> int: | ||
| from micrometer_compat import ( | ||
| install_local_artifacts, | ||
| prepare_repo, | ||
| run_gradle_test, | ||
| write_init_script, | ||
| ) | ||
|
|
||
| install_local_artifacts() | ||
| prepare_repo() | ||
| write_init_script() | ||
| run_gradle_test("io.micrometer.prometheusmetrics.PrometheusMeterRegistryTest") | ||
| return 0 | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| raise SystemExit(main()) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| # [MISE] description="Run Micrometer Prometheus registry tests against a target Micrometer ref" | ||
| # [MISE] alias="micrometer:test" | ||
|
|
||
| import sys | ||
|
|
||
|
|
||
| sys.path.insert(0, ".mise/lib") | ||
|
|
||
|
|
||
| def main() -> int: | ||
| from micrometer_compat import ( | ||
| install_local_artifacts, | ||
| prepare_repo, | ||
| run_gradle_test, | ||
| write_init_script, | ||
| ) | ||
|
|
||
| install_local_artifacts() | ||
| prepare_repo() | ||
| write_init_script() | ||
| run_gradle_test() | ||
| return 0 | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| raise SystemExit(main()) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.