Merge pull request #15 from cms-DQM/backport/pr-12-13-14

Author: nothingface0

.github/workflows/test_package.yaml

@@ -7,10 +7,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
@@ -34,4 +36,8 @@ jobs:
           SSO_CLIENT_SECRET: ${{ secrets.SSO_CLIENT_SECRET }}
           ENVIRONMENT: ${{ vars.ENVIRONMENT }}
         run: |
-          pytest tests -s
+          pytest tests --cov=runregistry --cov-report xml --retries 2
+      - name: Upload results to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

runregistry/__init__.py

@@ -1,5 +1,2 @@
+from .runregistry import __version__
 from .runregistry import *
-
-# To update:
-# pip install wheel && pip install twine && python setup.py bdist_wheel && twine upload --skip-existing dist/*
-__version__ = "1.4.1"

runregistry/runregistry.py

@@ -1,15 +1,18 @@
 import os
+import sys
 import time
 import json
 import requests
 from dotenv import load_dotenv
-from cernrequests import get_api_token, get_with_token
+from cernrequests import get_api_token
 from runregistry.utils import (
     transform_to_rr_run_filter,
     transform_to_rr_dataset_filter,
     __parse_runs_arg,
 )
 
+__version__ = "1.5.0"
+
 # Look for .env file in the directory of the caller
 # first. If it exists, use it.
 if os.path.exists(os.path.join(os.getcwd(), ".env")):
@@ -32,12 +35,15 @@
 email = "api@api"
 client_id = os.environ.get("SSO_CLIENT_ID")
 client_secret = os.environ.get("SSO_CLIENT_SECRET")
+target_application = ""
+target_name = ""
 
 
 def setup(target):
     global api_url
     global target_application
     global use_cookies
+    global target_name
 
     if target == "local":
         api_url = "http://localhost:9500"
@@ -46,15 +52,17 @@ def setup(target):
     elif target == "development":
         api_url = "https://dev-cmsrunregistry.web.cern.ch/api"
         use_cookies = True
-        target_application = "webframeworks-paas-dev-cmsrunregistry"
-    # elif target == "qa":
-    #     api_url = "https://cmsrunregistry-qa.web.cern.ch/api"  # Temporary new SSO Proxy for production
-    #     use_cookies = True
-    #     target_application = "webframeworks-paas-qa-cmsrunregistry"
+        target_application = "dev-cmsrunregistry-sso-proxy"
     elif target == "production":
         api_url = "https://cmsrunregistry.web.cern.ch/api"
         use_cookies = True
-        target_application = "webframeworks-paas-cmsrunregistry"
+        target_application = "cmsrunregistry-sso-proxy"
+
+    target_name = target
+
+
+def _get_user_agent():
+    return f"runregistry_api_client/{__version__} ({_get_target()}, python {sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}, requests {requests.__version__})"
 
 
 def _get_headers(token: str = ""):
@@ -63,21 +71,26 @@ def _get_headers(token: str = ""):
         headers["email"] = email
     if token:
         headers["Authorization"] = "Bearer " + token
+    headers["User-Agent"] = _get_user_agent()
     return headers
 
 
 setup(os.environ.get("ENVIRONMENT", "production"))
 
 
+def _get_target():
+    return target_name
+
+
 def _get_token():
     # if not use_cookies:
     #     return {"dummy": "yammy"}
     """
     Gets the token required to query RR API through the CERN SSO.
     :return: the token required to query Run Registry API. In particular 'connect.sid' is the one we are interested in
     """
-    # if os.getenv("ENVIRONMENT") == "development":
-    #     return None
+    if _get_target() == "local":
+        return ""
     token, expiration_date = get_api_token(
         client_id=client_id,
         client_secret=client_secret,
@@ -100,7 +113,7 @@ def _get_page(
         query_filter = transform_to_rr_run_filter(run_filter=query_filter)
     elif data_type == "datasets" and not ignore_filter_transformation:
         query_filter = transform_to_rr_dataset_filter(dataset_filter=query_filter)
-    if os.getenv("ENVIRONMENT") == "development":
+    if _get_target() in ["development", "local"]:
         print(url)
         print(query_filter)
     payload = json.dumps(
@@ -121,7 +134,7 @@ def get_dataset_names_of_run(run_number, **kwargs):
     :return: Array of dataset names of the specified run_number
     """
     url = "{}/get_all_dataset_names_of_run/{}".format(api_url, run_number)
-    return get_with_token(url, target_application=target_application).json()
+    return requests.get(url, headers=_get_headers(token=_get_token())).json()
 
 
 def get_run(run_number, **kwargs):
@@ -259,7 +272,7 @@ def get_datasets(limit=40000, compress_attributes=True, **kwargs) -> list:
 def get_cycles():
     url = "{}/cycles/global".format(api_url)
     headers = _get_headers(token=_get_token())
-    if os.getenv("ENVIRONMENT") == "development":
+    if _get_target() in ["development", "local"]:
         print(url)
     return requests.get(url, headers=headers).json()
 

runregistry/utils.py

@@ -24,6 +24,8 @@ def __parse_runs_arg(runs):
             return []
     elif isinstance(runs, list):
         return runs
+    else:
+        return []
 
 
 def transform_to_rr_run_filter(run_filter):
@@ -32,7 +34,7 @@ def transform_to_rr_run_filter(run_filter):
     :param run_filter: a filter that the user inputs into the api client
     :return: returns a filter that runregistry back end understands.
     """
-    if not run_filter:
+    if not run_filter or not isinstance(run_filter, dict):
         return {}
     transformed_filter = {}
     for key, value in run_filter.items():
@@ -91,7 +93,7 @@ def transform_to_rr_dataset_filter(dataset_filter):
     :param dataset_filter: a filter that the user inputs into the api client
     :return: returns a filter that runregistry back end understands.
     """
-    if not dataset_filter:
+    if not dataset_filter or not isinstance(dataset_filter, dict):
         return {}
     transformed_filter = {}
     for key, value in dataset_filter.items():

setup.py

@@ -24,7 +24,7 @@ def find_version(*file_paths):
 
 setup(
     name="runregistry",
-    version=find_version("runregistry", "__init__.py"),
+    version=find_version("runregistry", "runregistry.py"),
     packages=find_packages(),
     author="Fabio Espinosa",
     description="CMS Run Registry client",

testing-requirements.txt

@@ -1,4 +1,5 @@
 pytest>=3.6
+pytest-retry
 pytest-cov
 codecov
 -e .