Emiel/release reference url specification (#37)

Author: emielver

README.md

@@ -29,6 +29,8 @@ pip install eppo-metrics-sync
 export EPPO_API_KEY="your-api-key"
 
 export EPPO_SYNC_TAG="your-sync-tag" # optional
+
+export EPPO_REFERENCE_URL="your-reference-url" # optional
 ```
 
 2. Create your metrics YAML files (see [Documentation](#documentation))
@@ -109,6 +111,7 @@ pytest tests
 ```bash
 export EPPO_API_KEY="your-api-key"
 export EPPO_SYNC_TAG="your-sync-tag"
+export EPPO_REFERENCE_URL="your-reference-url"
 python -m eppo_metrics_sync path/to/yaml/directory
 ```
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "eppo_metrics_sync"
-version = "0.1.9"
+version = "0.1.10"
 description = "Sync metrics to Eppo"
 readme = "README.md"
 requires-python = ">=3.7"

requirements.txt

@@ -3,7 +3,7 @@ certifi==2024.7.4
 charset-normalizer==3.3.2
 idna==3.7
 iniconfig==2.0.0
-jsonschema==3.2.0
+jsonschema==4.20.0
 packaging==24.0
 pluggy==1.5.0
 pyrsistent==0.20.0

tests/test_integration.py

@@ -1,9 +1,11 @@
 import os
+import sys
 import subprocess
 import tempfile
 from pathlib import Path
 import venv
 
+
 def test_package_installation_and_dependencies():
     """
     Test that the package can be installed in a fresh virtual environment
@@ -53,3 +55,170 @@ def test_package_installation_and_dependencies():
             # We consider the test passed if it can be installed and run
             # Even if it returns an error code for an empty directory
             assert True
+
+def test_reference_url_integration():
+    """
+    Test that the EPPO_REFERENCE_URL environment variable is correctly added to the payload.
+    """
+    # Create a temporary directory for test files
+    with tempfile.TemporaryDirectory() as temp_dir:
+        # Create a simple valid YAML file
+        test_dir = os.path.join(temp_dir, "reference_url_test")
+        os.makedirs(test_dir)
+
+        test_yaml = os.path.join(test_dir, "simple_metric.yaml")
+        with open(test_yaml, "w") as f:
+            f.write("""fact_sources:
+- name: Test Source
+  sql: |
+    SELECT
+      ts as TS,
+      user_id,
+      value
+    FROM test_table
+  timestamp_column: TS
+  entities:
+  - entity_name: User
+    column: user_id
+  facts:
+  - name: Test Fact
+    column: value
+metrics:
+- name: Test Metric
+  entity: User
+  type: simple
+  numerator:
+    fact_name: Test Fact
+    operation: sum
+""")
+
+        # Also create a YAML file with its own reference_url
+        yaml_with_ref = os.path.join(test_dir, "yaml_with_ref.yaml")
+        yaml_ref_url = "https://yaml-ref-url.example.com"
+        with open(yaml_with_ref, "w") as f:
+            f.write(f"""reference_url: {yaml_ref_url}
+fact_sources:
+- name: Test Source With Ref
+  sql: |
+    SELECT
+      ts as TS,
+      user_id,
+      value
+    FROM test_table
+  timestamp_column: TS
+  entities:
+  - entity_name: User
+    column: user_id
+  facts:
+  - name: Test Fact With Ref
+    column: value
+metrics:
+- name: Test Metric With Ref
+  entity: User
+  type: simple
+  numerator:
+    fact_name: Test Fact With Ref
+    operation: sum
+""")
+
+        # Set up test environment
+        test_reference_url = "https://test-reference-url.example.com"
+
+        # Save original environment
+        original_env = os.environ.copy()
+
+        try:
+
+            # Install the package first in the current environment
+            subprocess.run(
+                [sys.executable, '-m', 'pip', 'install', '-e', str(Path(__file__).parent.parent.absolute())],
+                check=True
+            )
+
+            # Now import after installation
+            from eppo_metrics_sync.helper import load_yaml
+            from eppo_metrics_sync.eppo_metrics_sync import EppoMetricsSync
+
+            # Set environment variables for testing
+            os.environ["EPPO_API_KEY"] = "test_api_key"
+            os.environ["EPPO_REFERENCE_URL"] = test_reference_url
+            os.environ["EPPO_SYNC_TAG"] = "test_tag"
+
+            # Test case 1: Directory with no reference_url - should use env var
+            eppo_sync = EppoMetricsSync(directory=test_dir)
+            eppo_sync.read_yaml_files()
+            eppo_sync.validate()
+
+            # Create the payload as it's done in the sync method
+            payload = {
+                "sync_tag": "test_tag",
+                "fact_sources": eppo_sync.fact_sources,
+                "metrics": eppo_sync.metrics
+            }
+            # Attach reference URL
+            payload = eppo_sync._attach_reference_url(payload)
+
+            # Verify the reference URL is in the payload
+            assert "reference_url" in payload, "reference_url not found in payload"
+            assert payload["reference_url"] == test_reference_url, \
+                f"Expected reference_url to be {test_reference_url}, got {payload.get('reference_url')}"
+
+            # Also check that the reference URL is not in the individual metrics/fact_sources
+            for fact_source in payload.get("fact_sources", []):
+                assert "reference_url" not in fact_source, "reference_url incorrectly set in fact_source"
+
+            for metric in payload.get("metrics", []):
+                assert "reference_url" not in metric, "reference_url incorrectly set in metric"
+
+            # Test case 2: Test without environment variable
+            os.environ.pop("EPPO_REFERENCE_URL", None)
+
+            eppo_sync_no_ref = EppoMetricsSync(directory=test_dir)
+            eppo_sync_no_ref.read_yaml_files()
+            eppo_sync_no_ref.validate()
+
+            # Create payload without reference URL
+            payload_no_ref = {
+                "sync_tag": "test_tag",
+                "fact_sources": eppo_sync_no_ref.fact_sources,
+                "metrics": eppo_sync_no_ref.metrics
+            }
+            payload_no_ref = eppo_sync_no_ref._attach_reference_url(payload_no_ref)
+
+            # Verify the reference URL is not in the payload when not provided
+            assert "reference_url" not in payload_no_ref, "reference_url found in payload when not provided"
+
+            # Test case 3: Test file with its own reference_url
+            # Since EppoMetricsSync doesn't store the reference_url from the YAML,
+            # we need to read it directly from the file
+            yaml_data = load_yaml(yaml_with_ref)
+            yaml_reference_url = yaml_data.get("reference_url")
+
+            assert yaml_reference_url == yaml_ref_url, \
+                f"Expected reference_url in YAML to be {yaml_ref_url}, got {yaml_reference_url}"
+
+            # Test case 4: Test env variable overriding YAML reference_url
+            os.environ["EPPO_REFERENCE_URL"] = test_reference_url
+
+            eppo_sync_override = EppoMetricsSync(directory=None)
+            eppo_sync_override.load_eppo_yaml(yaml_with_ref)
+            eppo_sync_override.validate()
+
+            # Create payload with env var
+            payload_override = {
+                "sync_tag": "test_tag",
+                "fact_sources": eppo_sync_override.fact_sources,
+                "metrics": eppo_sync_override.metrics
+            }
+            payload_override = eppo_sync_override._attach_reference_url(payload_override)
+
+            # The env variable should override the YAML file's reference_url
+            assert "reference_url" in payload_override, "reference_url not found in payload with env override"
+            assert payload_override["reference_url"] == test_reference_url, \
+                f"Expected reference_url to be {test_reference_url} (from env), got {payload_override.get('reference_url')}"
+
+        finally:
+            # Clean up
+            # Restore original environment
+            os.environ.clear()
+            os.environ.update(original_env)