howler-api 3.3.0.dev763__tar.gz → 3.3.0.dev764__tar.gz

{howler_api-3.3.0.dev763 → howler_api-3.3.0.dev764}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: howler-api
-Version: 3.3.0.dev763
+Version: 3.3.0.dev764
 Summary: Howler - API server
 License: MIT
 Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs
@@ -8,7 +8,7 @@ Author: Canadian Centre for Cyber Security
 Author-email: howler@cyber.gc.ca
 Maintainer: Matthew Rafuse
 Maintainer-email: matthew.rafuse@cyber.gc.ca
-Requires-Python: >=3.9.17,<4.0.0
+Requires-Python: >=3.10,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License

{howler_api-3.3.0.dev763 → howler_api-3.3.0.dev764}/howler/api/__init__.py

@@ -10,6 +10,7 @@ from howler import odm
 from howler.common.loader import APP_NAME
 from howler.common.logging import get_logger, log_with_traceback
 from howler.config import QUOTA_TRACKER, get_version
+from howler.utils.constants import TESTING
 from howler.utils.str_utils import safe_str
 
 API_PREFIX = "/api"
@@ -72,7 +73,8 @@ def _make_api_response(
             resp.set_cookie(k, v, secure=True, httponly=True, samesite="Lax")
 
     RAW_API_COUNTER.labels(request.method, str(request.url_rule), status_code).inc()
-    logger.info("%s %s - %s", request.method, request.path, status_code)
+    if not TESTING:
+        logger.info("%s %s - %s", request.method, request.path, status_code)
 
     return resp
 

{howler_api-3.3.0.dev763 → howler_api-3.3.0.dev764}/howler/api/v1/clue.py

@@ -1,4 +1,3 @@
-import sys
 import time
 from typing import Callable, Optional
 
@@ -12,6 +11,7 @@ from howler.common.swagger import generate_swagger_docs
 from howler.config import cache, config
 from howler.plugins import get_plugins
 from howler.security import api_login
+from howler.utils.constants import TESTING
 
 SUB_API = "clue"
 clue_api = make_subapi_blueprint(SUB_API, api_version=1)
@@ -22,7 +22,7 @@ logger = get_logger(__file__)
 
 def skip_cache(*args):
     "Function to skip cache in testing mode"
-    return "pytest" in sys.modules
+    return TESTING
 
 
 @cache.memoize(15 * 60, unless=skip_cache)

{howler_api-3.3.0.dev763 → howler_api-3.3.0.dev764}/howler/cronjobs/rules.py

@@ -3,7 +3,6 @@ import json
 import os
 import random
 import re
-import sys
 from datetime import datetime
 from typing import Any, Optional
 
@@ -23,6 +22,7 @@ from howler.datastore.operations import OdmHelper, OdmUpdateOperation
 from howler.odm.models.analytic import Analytic
 from howler.odm.models.hit import Hit
 from howler.odm.models.howler_data import HitOperationType
+from howler.utils.constants import TESTING
 
 logger = get_logger(__file__)
 hit_helper = OdmHelper(Hit)
@@ -217,7 +217,7 @@ def register_rules(new_rule: Optional[Analytic] = None, test_override: bool = Fa
         logger.error("Scheduler instance does not exist!")
         return
 
-    if "pytest" in sys.modules and not test_override:
+    if TESTING and not test_override:
         logger.info("Skipping registration, running in a test environment")
         return
 

{howler_api-3.3.0.dev763 → howler_api-3.3.0.dev764}/howler/helper/discover.py

@@ -1,4 +1,3 @@
-import sys
 import typing
 from typing import Optional
 
@@ -6,6 +5,7 @@ import requests
 
 from howler.common.logging import get_logger
 from howler.config import config
+from howler.utils.constants import TESTING
 
 logger = get_logger(__file__)
 DISCO_CACHE = {}
@@ -20,7 +20,7 @@ def get_apps_list(discovery_url: Optional[str]) -> list[dict[str, str]]:
     if discovery_url not in DISCO_CACHE:
         apps = []
 
-        if "pytest" in sys.modules:
+        if TESTING:
             logger.info("Skipping discovery, running in a test environment")
 
         try:

{howler_api-3.3.0.dev763 → howler_api-3.3.0.dev764}/howler/odm/helper.py

@@ -1,6 +1,5 @@
 import json
 import random
-import sys
 from datetime import datetime, timedelta
 from hashlib import md5
 from math import ceil
@@ -29,6 +28,7 @@ from howler.odm.randomizer import (
 )
 from howler.plugins import get_plugins
 from howler.security.utils import get_password_hash
+from howler.utils.constants import TESTING
 from howler.utils.uid import get_random_id
 
 APPS = get_apps_list(discovery_url=config.ui.discover_url)
@@ -360,7 +360,7 @@ def create_users_with_username(ds: HowlerDatastore, usernames: list[str]):
         )
         ds.user.save(username, user_data)
 
-        if "pytest" not in sys.modules:
+        if not TESTING:
             logger.info("%s:%s", username, username)
 
     ds.user.commit()

{howler_api-3.3.0.dev763 → howler_api-3.3.0.dev764}/howler/odm/random_data.py

@@ -6,6 +6,7 @@ from dotenv import load_dotenv
 
 from howler.odm.models.clue import Clue
 from howler.plugins import get_plugins
+from howler.utils.constants import TESTING
 
 load_dotenv()
 
@@ -136,7 +137,7 @@ def create_users(ds):
     )
     ds.view.save(admin_view.view_id, admin_view)
 
-    if "pytest" not in sys.modules:
+    if not TESTING:
         logger.info("\t%s:%s", user_data.uname, admin_pass)
 
     user_hash = get_password_hash(user_pass)
@@ -183,7 +184,7 @@ def create_users(ds):
     )
     ds.view.save(user_view.view_id, user_view)
 
-    if "pytest" not in sys.modules:
+    if not TESTING:
         logger.info("\t%s:%s", user_data.uname, user_pass)
 
     huey_hash = get_password_hash(huey_pass)
@@ -230,7 +231,7 @@ def create_users(ds):
     )
     ds.view.save(huey_view.view_id, huey_view)
 
-    if "pytest" not in sys.modules:
+    if not TESTING:
         logger.info("\t%s:%s", huey_data.uname, huey_pass)
 
     shawnh_view = View(
@@ -260,7 +261,7 @@ def create_users(ds):
     ds.user.save("shawn-h", shawn_data)
     ds.view.save(shawnh_view.view_id, shawnh_view)
 
-    if "pytest" not in sys.modules:
+    if not TESTING:
         logger.info("\t%s:%s", shawn_data.uname, shawnh_pass)
 
     goose_view = View(
@@ -290,7 +291,7 @@ def create_users(ds):
     ds.user.save("goose", goose_data)
     ds.view.save(goose_view.view_id, goose_view)
 
-    if "pytest" not in sys.modules:
+    if not TESTING:
         logger.info("\t%s:%s", goose_data.uname, goose_pass)
 
     ds.user.commit()
@@ -566,10 +567,10 @@ def create_hits(ds: HowlerDatastore, hit_count: int = 200):
 
         ds.hit.commit()
 
-        if hit_idx % 25 == 0 and "pytest" not in sys.modules:
+        if hit_idx % 25 == 0 and not TESTING:
             logger.info("\tCreated %s/%s", hit_idx, hit_count)
 
-    if "pytest" not in sys.modules:
+    if not TESTING:
         logger.info("\tCreated %s/%s", hit_idx + 1, hit_count)
 
     logger.info(

{howler_api-3.3.0.dev763 → howler_api-3.3.0.dev764}/howler/security/__init__.py

@@ -1,5 +1,4 @@
 import functools
-import sys
 from typing import Optional
 
 import requests
@@ -23,6 +22,7 @@ from howler.common.logging import get_logger
 from howler.common.logging.audit import audit
 from howler.config import AUDIT, QUOTA_TRACKER, config
 from howler.odm.models.user import User
+from howler.utils.constants import TESTING
 
 logger = get_logger(__file__)
 
@@ -184,7 +184,7 @@ class api_login(object):  # noqa: D101, N801
                     )
 
                 ip = request.headers.get("X-Forwarded-For", request.remote_addr)
-                if "pytest" not in sys.modules:
+                if not TESTING:
                     logger.info("Logged in as %s from %s for path %s", user["uname"], ip, request.path)
 
                 # If auditing is enabled, write this successful access to the audit logs

{howler_api-3.3.0.dev763 → howler_api-3.3.0.dev764}/howler/services/action_service.py

@@ -1,5 +1,4 @@
 import json
-import sys
 from typing import Any, Optional
 
 from flask import Response
@@ -12,6 +11,7 @@ from howler.common.logging import get_logger
 from howler.common.logging.audit import audit
 from howler.odm.models.action import VALID_TRIGGERS, Action
 from howler.odm.models.user import User
+from howler.utils.constants import TESTING
 from howler.utils.str_utils import sanitize_lucene_query
 
 logger = get_logger(__file__)
@@ -67,7 +67,7 @@ def bulk_execute_on_query(query: str, trigger: str = "create", user: Optional[Us
         intersected_query = f"({query}) AND ({action.query})"
 
         if datastore().hit.search(intersected_query, rows=0)["total"] < 1:
-            if "pytest" in sys.modules:
+            if TESTING:
                 logger.debug("Action %s does not apply to query %s", action.action_id, query)
 
             continue

{howler_api-3.3.0.dev763 → howler_api-3.3.0.dev764}/howler/services/lucene_service.py

@@ -17,6 +17,7 @@ from howler.common.exceptions import InvalidDataException
 from howler.common.loader import datastore
 from howler.config import redis
 from howler.remote.datatypes.hash import Hash
+from howler.utils.constants import TESTING
 from howler.utils.dict_utils import flatten_deep
 from howler.utils.lucene import coerce, normalize_phrase, try_parse_date, try_parse_ip, try_parse_number
 
@@ -235,7 +236,7 @@ def match(lucene: str, obj: dict[str, Any]):
     hash_key = sha256(lucene.encode()).hexdigest()
 
     # We cache the results back from ES, since we will frequently run the same validation queries over and over again.
-    if (normalized_query := NORMALIZED_QUERY_CACHE.get(hash_key)) is None or "pytest" in sys.modules:
+    if (normalized_query := NORMALIZED_QUERY_CACHE.get(hash_key)) is None or TESTING:
         # This regex checks for lucene phrases (i.e. the "Example Analytic" part of howler.analytic:"Example Analytic")
         # And then escapes them.
         # https://regex101.com/r/8u5F6a/1

howler_api-3.3.0.dev764/howler/utils/constants.py

@@ -0,0 +1,4 @@
+import os
+import sys
+
+TESTING = os.getenv("TESTING", "false").lower() in ["true", "1", "yes"] or "pytest" in sys.modules

{howler_api-3.3.0.dev763 → howler_api-3.3.0.dev764}/pyproject.toml

@@ -152,7 +152,7 @@ suppress-none-returning = true
 [tool.poetry]
 package-mode = true
 name = "howler-api"
-version = "3.3.0.dev763"
+version = "3.3.0.dev764"
 description = "Howler - API server"
 authors = [
     "Canadian Centre for Cyber Security <howler@cyber.gc.ca>",
@@ -195,7 +195,7 @@ homepage = "https://cybercentrecanada.github.io/howler/"
 repository = "https://github.com/CybercentreCanada/howler-api"
 
 [tool.poetry.dependencies]
-python = "^3.9.17"
+python = "^3.10"
 apscheduler = "3.11.2"
 authlib = "^1.6.0"
 chardet = "5.2.0"
@@ -240,7 +240,7 @@ pyright = {extras = ["nodejs"], version = "^1.1.408"}
 mypy = "^1.6.1"
 
 [tool.poetry.group.test.dependencies]
-pytest = "^8.1.1"
+pytest = "9.0.3"
 retrying = "^1.3.4"
 pyftpdlib = "^1.5.9"
 pyopenssl = ">=24.1,<27.0"