From a658fb93837f66a86ad2c04f6c49afc94c65caa8 Mon Sep 17 00:00:00 2001 From: Alberto Vara Date: Wed, 23 Aug 2023 14:52:40 +0200 Subject: [PATCH] chore: rename _iast._util to _iast._utils (#6719) Typo, rename `ddtrace.appsec._iast._util` to `ddtrace.appsec._iast._utils` ## Checklist - [x] Change(s) are motivated and described in the PR description. - [x] Testing strategy is described if automated tests are not included in the PR. - [x] Risk is outlined (performance impact, potential for breakage, maintainability, etc). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] [Library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) are followed. If no release note is required, add label `changelog/no-changelog`. - [x] Documentation is included (in-code, generated user docs, [public corp docs](https://github.com/DataDog/documentation/)). - [x] Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Title is accurate. - [x] No unnecessary changes are introduced. - [x] Description motivates each change. - [x] Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Testing strategy adequately addresses listed risk(s). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] Release note makes sense to a user of the library. - [x] Reviewer has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment. - [x] Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) --- ddtrace/appsec/_asm_request_context.py | 2 +- ddtrace/appsec/handlers.py | 2 +- ddtrace/appsec/iast/_loader.py | 2 +- ddtrace/appsec/iast/_patch.py | 2 +- ddtrace/appsec/iast/_taint_tracking/__init__.py | 2 +- ddtrace/appsec/iast/{_util.py => _utils.py} | 0 ddtrace/appsec/iast/processor.py | 2 +- ddtrace/appsec/iast/taint_sinks/_base.py | 6 +++--- ddtrace/appsec/iast/taint_sinks/sql_injection.py | 2 +- ddtrace/bootstrap/sitecustomize.py | 2 +- ddtrace/contrib/dbapi/__init__.py | 2 +- ddtrace/contrib/dbapi_async/__init__.py | 2 +- ddtrace/contrib/trace_utils.py | 2 +- tests/appsec/iast/aspects/test_encode_decode_aspect.py | 2 +- tests/appsec/iast/ast/test_ast_patching.py | 2 +- tests/appsec/iast/conftest.py | 2 +- tests/appsec/iast/taint_tracking/test_taint_tracking.py | 2 +- tests/appsec/iast/test_env_var.py | 2 +- tests/appsec/iast/test_json_tainting.py | 2 +- tests/appsec/iast/test_path_traversal.py | 2 +- tests/appsec/iast/test_processor.py | 2 +- tests/appsec/iast/test_reporter.py | 2 +- tests/appsec/iast/test_taint_tracking.py | 2 +- tests/appsec/iast/test_telemetry.py | 2 +- tests/appsec/iast/test_weak_hash.py | 2 +- tests/contrib/dbapi/test_dbapi_appsec.py | 2 +- tests/contrib/django/django_app/appsec_urls.py | 2 +- tests/contrib/django/test_django_appsec_iast.py | 2 +- tests/contrib/flask/test_flask_appsec_iast.py | 2 +- 29 files changed, 30 insertions(+), 30 deletions(-) rename ddtrace/appsec/iast/{_util.py => _utils.py} (100%) diff --git a/ddtrace/appsec/_asm_request_context.py b/ddtrace/appsec/_asm_request_context.py index a540760c956..7c32d0c9945 100644 --- a/ddtrace/appsec/_asm_request_context.py +++ b/ddtrace/appsec/_asm_request_context.py @@ -6,7 +6,7 @@ from ddtrace.appsec import handlers from ddtrace.appsec._constants import SPAN_DATA_NAMES from ddtrace.appsec._constants import WAF_CONTEXT_NAMES -from ddtrace.appsec.iast._util import _is_iast_enabled +from ddtrace.appsec.iast._utils import _is_iast_enabled from ddtrace.internal import core from ddtrace.internal.compat import parse from ddtrace.internal.constants import REQUEST_PATH_PARAMS diff --git a/ddtrace/appsec/handlers.py b/ddtrace/appsec/handlers.py index 2b28350a8c6..baad7965d8c 100644 --- a/ddtrace/appsec/handlers.py +++ b/ddtrace/appsec/handlers.py @@ -7,7 +7,7 @@ from ddtrace import config from ddtrace.appsec.iast._patch import if_iast_taint_returned_object_for from ddtrace.appsec.iast._patch import if_iast_taint_yield_tuple_for -from ddtrace.appsec.iast._util import _is_iast_enabled +from ddtrace.appsec.iast._utils import _is_iast_enabled from ddtrace.contrib import trace_utils from ddtrace.internal import core from ddtrace.internal.logger import get_logger diff --git a/ddtrace/appsec/iast/_loader.py b/ddtrace/appsec/iast/_loader.py index 7fb1355882f..06197957b47 100644 --- a/ddtrace/appsec/iast/_loader.py +++ b/ddtrace/appsec/iast/_loader.py @@ -3,7 +3,7 @@ from ddtrace.internal.logger import get_logger from ._ast.ast_patching import astpatch_module -from ._util import _is_iast_enabled +from ._utils import _is_iast_enabled log = get_logger(__name__) diff --git a/ddtrace/appsec/iast/_patch.py b/ddtrace/appsec/iast/_patch.py index 883598c52f7..7703e03dd0f 100644 --- a/ddtrace/appsec/iast/_patch.py +++ b/ddtrace/appsec/iast/_patch.py @@ -3,7 +3,7 @@ import sys from typing import TYPE_CHECKING -from ddtrace.appsec.iast._util import _is_iast_enabled +from ddtrace.appsec.iast._utils import _is_iast_enabled from ddtrace.internal.logger import get_logger from ddtrace.vendor.wrapt import FunctionWrapper from ddtrace.vendor.wrapt import resolve_path diff --git a/ddtrace/appsec/iast/_taint_tracking/__init__.py b/ddtrace/appsec/iast/_taint_tracking/__init__.py index dcf812b16ab..387c1328242 100644 --- a/ddtrace/appsec/iast/_taint_tracking/__init__.py +++ b/ddtrace/appsec/iast/_taint_tracking/__init__.py @@ -3,7 +3,7 @@ from typing import TYPE_CHECKING from ddtrace.appsec.iast._metrics import _set_metric_iast_executed_source -from ddtrace.appsec.iast._util import _is_python_version_supported +from ddtrace.appsec.iast._utils import _is_python_version_supported if _is_python_version_supported(): diff --git a/ddtrace/appsec/iast/_util.py b/ddtrace/appsec/iast/_utils.py similarity index 100% rename from ddtrace/appsec/iast/_util.py rename to ddtrace/appsec/iast/_utils.py diff --git a/ddtrace/appsec/iast/processor.py b/ddtrace/appsec/iast/processor.py index 0331b9dc657..971d40410dc 100644 --- a/ddtrace/appsec/iast/processor.py +++ b/ddtrace/appsec/iast/processor.py @@ -7,7 +7,7 @@ from ddtrace.appsec._constants import IAST from ddtrace.appsec.iast import oce from ddtrace.appsec.iast._metrics import _set_metric_iast_request_tainted -from ddtrace.appsec.iast._util import _is_iast_enabled +from ddtrace.appsec.iast._utils import _is_iast_enabled from ddtrace.appsec.trace_utils import _asm_manual_keep from ddtrace.constants import ORIGIN_KEY from ddtrace.ext import SpanTypes diff --git a/ddtrace/appsec/iast/taint_sinks/_base.py b/ddtrace/appsec/iast/taint_sinks/_base.py index b6a656bf72a..63da341c110 100644 --- a/ddtrace/appsec/iast/taint_sinks/_base.py +++ b/ddtrace/appsec/iast/taint_sinks/_base.py @@ -7,9 +7,9 @@ from ddtrace.appsec.iast import oce from ddtrace.appsec.iast._metrics import _set_metric_iast_executed_sink from ddtrace.appsec.iast._overhead_control_engine import Operation -from ddtrace.appsec.iast._util import _has_to_scrub -from ddtrace.appsec.iast._util import _is_evidence_value_parts -from ddtrace.appsec.iast._util import _scrub +from ddtrace.appsec.iast._utils import _has_to_scrub +from ddtrace.appsec.iast._utils import _is_evidence_value_parts +from ddtrace.appsec.iast._utils import _scrub from ddtrace.appsec.iast.reporter import Evidence from ddtrace.appsec.iast.reporter import IastSpanReporter from ddtrace.appsec.iast.reporter import Location diff --git a/ddtrace/appsec/iast/taint_sinks/sql_injection.py b/ddtrace/appsec/iast/taint_sinks/sql_injection.py index 3d32cf8be7a..1eea3222b5d 100644 --- a/ddtrace/appsec/iast/taint_sinks/sql_injection.py +++ b/ddtrace/appsec/iast/taint_sinks/sql_injection.py @@ -5,7 +5,7 @@ from ddtrace.appsec.iast import oce from ddtrace.appsec.iast._taint_tracking import taint_ranges_as_evidence_info -from ddtrace.appsec.iast._util import _scrub_get_tokens_positions +from ddtrace.appsec.iast._utils import _scrub_get_tokens_positions from ddtrace.appsec.iast.constants import EVIDENCE_SQL_INJECTION from ddtrace.appsec.iast.constants import VULN_SQL_INJECTION from ddtrace.appsec.iast.taint_sinks._base import VulnerabilityBase diff --git a/ddtrace/bootstrap/sitecustomize.py b/ddtrace/bootstrap/sitecustomize.py index ee20d8aadc0..6b58c42749c 100644 --- a/ddtrace/bootstrap/sitecustomize.py +++ b/ddtrace/bootstrap/sitecustomize.py @@ -170,7 +170,7 @@ def _(threading): if asbool(os.getenv("DD_IAST_ENABLED", False)): - from ddtrace.appsec.iast._util import _is_python_version_supported + from ddtrace.appsec.iast._utils import _is_python_version_supported if _is_python_version_supported(): diff --git a/ddtrace/contrib/dbapi/__init__.py b/ddtrace/contrib/dbapi/__init__.py index fe5e1e719a7..8d05e4a8b2b 100644 --- a/ddtrace/contrib/dbapi/__init__.py +++ b/ddtrace/contrib/dbapi/__init__.py @@ -4,7 +4,7 @@ import six from ddtrace import config -from ddtrace.appsec.iast._util import _is_iast_enabled +from ddtrace.appsec.iast._utils import _is_iast_enabled from ddtrace.internal.constants import COMPONENT from ...constants import ANALYTICS_SAMPLE_RATE_KEY diff --git a/ddtrace/contrib/dbapi_async/__init__.py b/ddtrace/contrib/dbapi_async/__init__.py index 0e3d78b4704..6031334c923 100644 --- a/ddtrace/contrib/dbapi_async/__init__.py +++ b/ddtrace/contrib/dbapi_async/__init__.py @@ -1,5 +1,5 @@ from ddtrace import config -from ddtrace.appsec.iast._util import _is_iast_enabled +from ddtrace.appsec.iast._utils import _is_iast_enabled from ddtrace.internal.constants import COMPONENT from ...constants import ANALYTICS_SAMPLE_RATE_KEY diff --git a/ddtrace/contrib/trace_utils.py b/ddtrace/contrib/trace_utils.py index 48221a764ce..1d992e704be 100644 --- a/ddtrace/contrib/trace_utils.py +++ b/ddtrace/contrib/trace_utils.py @@ -515,7 +515,7 @@ def set_http_meta( span.set_tag_str(http.RETRIES_REMAIN, str(retries_remain)) if config._appsec_enabled: - from ddtrace.appsec.iast._util import _is_iast_enabled + from ddtrace.appsec.iast._utils import _is_iast_enabled if _is_iast_enabled(): from ddtrace.appsec.iast.taint_sinks.insecure_cookie import asm_check_cookies diff --git a/tests/appsec/iast/aspects/test_encode_decode_aspect.py b/tests/appsec/iast/aspects/test_encode_decode_aspect.py index 9903254b46a..60f7fa49140 100644 --- a/tests/appsec/iast/aspects/test_encode_decode_aspect.py +++ b/tests/appsec/iast/aspects/test_encode_decode_aspect.py @@ -8,7 +8,7 @@ from ddtrace.appsec.iast._taint_tracking import OriginType from ddtrace.appsec.iast._taint_tracking import contexts_reset from ddtrace.appsec.iast._taint_tracking import create_context - from ddtrace.appsec.iast._util import _is_python_version_supported as python_supported_by_iast + from ddtrace.appsec.iast._utils import _is_python_version_supported as python_supported_by_iast except (ImportError, AttributeError): pytest.skip("IAST not supported for this Python version", allow_module_level=True) diff --git a/tests/appsec/iast/ast/test_ast_patching.py b/tests/appsec/iast/ast/test_ast_patching.py index d60d80a66c5..d2d9d74e34c 100644 --- a/tests/appsec/iast/ast/test_ast_patching.py +++ b/tests/appsec/iast/ast/test_ast_patching.py @@ -1,7 +1,7 @@ #!/usr/bin/env python3 import pytest -from ddtrace.appsec.iast._util import _is_python_version_supported as python_supported_by_iast +from ddtrace.appsec.iast._utils import _is_python_version_supported as python_supported_by_iast try: diff --git a/tests/appsec/iast/conftest.py b/tests/appsec/iast/conftest.py index c9b3bc5ad3b..ec0916a0924 100644 --- a/tests/appsec/iast/conftest.py +++ b/tests/appsec/iast/conftest.py @@ -3,7 +3,7 @@ import pytest from ddtrace.appsec.iast import oce -from ddtrace.appsec.iast._util import _is_python_version_supported +from ddtrace.appsec.iast._utils import _is_python_version_supported from ddtrace.appsec.iast.taint_sinks._base import VulnerabilityBase from ddtrace.appsec.iast.taint_sinks.path_traversal import patch as path_traversal_patch from ddtrace.appsec.iast.taint_sinks.weak_cipher import patch as weak_cipher_patch diff --git a/tests/appsec/iast/taint_tracking/test_taint_tracking.py b/tests/appsec/iast/taint_tracking/test_taint_tracking.py index 34d38f9f505..246bf8caa31 100644 --- a/tests/appsec/iast/taint_tracking/test_taint_tracking.py +++ b/tests/appsec/iast/taint_tracking/test_taint_tracking.py @@ -11,7 +11,7 @@ from ddtrace.appsec.iast._taint_tracking import taint_pyobject from ddtrace.appsec.iast._taint_tracking import taint_ranges_as_evidence_info from ddtrace.appsec.iast._taint_tracking.aspects import add_aspect - from ddtrace.appsec.iast._util import _is_python_version_supported as python_supported_by_iast + from ddtrace.appsec.iast._utils import _is_python_version_supported as python_supported_by_iast except (ImportError, AttributeError): pytest.skip("IAST not supported for this Python version", allow_module_level=True) diff --git a/tests/appsec/iast/test_env_var.py b/tests/appsec/iast/test_env_var.py index b66d09b2862..9d6489bf479 100644 --- a/tests/appsec/iast/test_env_var.py +++ b/tests/appsec/iast/test_env_var.py @@ -5,7 +5,7 @@ import pytest from six import PY2 -from ddtrace.appsec.iast._util import _is_python_version_supported +from ddtrace.appsec.iast._utils import _is_python_version_supported def _run_python_file(*args, **kwargs): diff --git a/tests/appsec/iast/test_json_tainting.py b/tests/appsec/iast/test_json_tainting.py index 68cf61cd37c..bf4fd2d6344 100644 --- a/tests/appsec/iast/test_json_tainting.py +++ b/tests/appsec/iast/test_json_tainting.py @@ -15,7 +15,7 @@ from ddtrace.appsec.iast._taint_utils import LazyTaintDict from ddtrace.appsec.iast._taint_utils import LazyTaintList from ddtrace.appsec.iast._taint_utils import _is_tainted_struct - from ddtrace.appsec.iast._util import _is_python_version_supported as python_supported_by_iast + from ddtrace.appsec.iast._utils import _is_python_version_supported as python_supported_by_iast except (ImportError, AttributeError): pytest.skip("IAST not supported for this Python version", allow_module_level=True) diff --git a/tests/appsec/iast/test_path_traversal.py b/tests/appsec/iast/test_path_traversal.py index db1f1f35a40..0dd1e51d8b4 100644 --- a/tests/appsec/iast/test_path_traversal.py +++ b/tests/appsec/iast/test_path_traversal.py @@ -2,7 +2,7 @@ import pytest -from ddtrace.appsec.iast._util import _is_python_version_supported as python_supported_by_iast +from ddtrace.appsec.iast._utils import _is_python_version_supported as python_supported_by_iast from tests.appsec.iast.aspects.conftest import _iast_patched_module diff --git a/tests/appsec/iast/test_processor.py b/tests/appsec/iast/test_processor.py index 504df8fb9f0..09d9cd27566 100644 --- a/tests/appsec/iast/test_processor.py +++ b/tests/appsec/iast/test_processor.py @@ -4,7 +4,7 @@ from ddtrace.appsec._constants import IAST from ddtrace.appsec.iast._patch_modules import patch_iast -from ddtrace.appsec.iast._util import _is_python_version_supported +from ddtrace.appsec.iast._utils import _is_python_version_supported from ddtrace.constants import SAMPLING_PRIORITY_KEY from ddtrace.constants import USER_KEEP from ddtrace.ext import SpanTypes diff --git a/tests/appsec/iast/test_reporter.py b/tests/appsec/iast/test_reporter.py index 197528ff9ed..5b1d3201399 100644 --- a/tests/appsec/iast/test_reporter.py +++ b/tests/appsec/iast/test_reporter.py @@ -4,7 +4,7 @@ from ddtrace.appsec._constants import IAST from ddtrace.appsec.iast import oce -from ddtrace.appsec.iast._util import _is_python_version_supported as python_supported_by_iast +from ddtrace.appsec.iast._utils import _is_python_version_supported as python_supported_by_iast from ddtrace.appsec.iast.reporter import Evidence from ddtrace.appsec.iast.reporter import IastSpanReporter from ddtrace.appsec.iast.reporter import Location diff --git a/tests/appsec/iast/test_taint_tracking.py b/tests/appsec/iast/test_taint_tracking.py index a20b66923cf..d8c05e192dd 100644 --- a/tests/appsec/iast/test_taint_tracking.py +++ b/tests/appsec/iast/test_taint_tracking.py @@ -11,7 +11,7 @@ from ddtrace.appsec.iast._taint_tracking import taint_pyobject from ddtrace.appsec.iast._taint_tracking import taint_ranges_as_evidence_info from ddtrace.appsec.iast._taint_tracking.aspects import add_aspect - from ddtrace.appsec.iast._util import _is_python_version_supported as python_supported_by_iast + from ddtrace.appsec.iast._utils import _is_python_version_supported as python_supported_by_iast except (ImportError, AttributeError): pytest.skip("IAST not supported for this Python version", allow_module_level=True) diff --git a/tests/appsec/iast/test_telemetry.py b/tests/appsec/iast/test_telemetry.py index 8a349a4685e..317a324ab4e 100644 --- a/tests/appsec/iast/test_telemetry.py +++ b/tests/appsec/iast/test_telemetry.py @@ -9,7 +9,7 @@ from ddtrace.appsec.iast._patch_modules import patch_iast from ddtrace.appsec.iast._taint_tracking import OriginType from ddtrace.appsec.iast._taint_tracking import taint_pyobject - from ddtrace.appsec.iast._util import _is_python_version_supported + from ddtrace.appsec.iast._utils import _is_python_version_supported from ddtrace.ext import SpanTypes from ddtrace.internal.telemetry.constants import TELEMETRY_NAMESPACE_TAG_IAST from ddtrace.internal.telemetry.constants import TELEMETRY_TYPE_GENERATE_METRICS diff --git a/tests/appsec/iast/test_weak_hash.py b/tests/appsec/iast/test_weak_hash.py index 2de6a615469..c8a20775a78 100644 --- a/tests/appsec/iast/test_weak_hash.py +++ b/tests/appsec/iast/test_weak_hash.py @@ -3,7 +3,7 @@ import pytest from ddtrace.appsec._constants import IAST -from ddtrace.appsec.iast._util import _is_python_version_supported as python_supported_by_iast +from ddtrace.appsec.iast._utils import _is_python_version_supported as python_supported_by_iast from ddtrace.appsec.iast.constants import VULN_INSECURE_HASHING_TYPE from ddtrace.appsec.iast.taint_sinks.weak_hash import unpatch_iast from ddtrace.internal import core diff --git a/tests/contrib/dbapi/test_dbapi_appsec.py b/tests/contrib/dbapi/test_dbapi_appsec.py index 24b95963fe8..8067d7fc457 100644 --- a/tests/contrib/dbapi/test_dbapi_appsec.py +++ b/tests/contrib/dbapi/test_dbapi_appsec.py @@ -3,7 +3,7 @@ from ddtrace import Pin from ddtrace.appsec.iast import oce -from ddtrace.appsec.iast._util import _is_python_version_supported +from ddtrace.appsec.iast._utils import _is_python_version_supported from ddtrace.contrib.dbapi import TracedCursor from ddtrace.settings import Config from ddtrace.settings.integration import IntegrationConfig diff --git a/tests/contrib/django/django_app/appsec_urls.py b/tests/contrib/django/django_app/appsec_urls.py index 6009a3e3105..e1a3d07e2b7 100644 --- a/tests/contrib/django/django_app/appsec_urls.py +++ b/tests/contrib/django/django_app/appsec_urls.py @@ -8,7 +8,7 @@ from ddtrace import tracer from ddtrace.appsec import _asm_request_context -from ddtrace.appsec.iast._util import _is_python_version_supported as python_supported_by_iast +from ddtrace.appsec.iast._utils import _is_python_version_supported as python_supported_by_iast from ddtrace.appsec.trace_utils import block_request_if_user_blocked diff --git a/tests/contrib/django/test_django_appsec_iast.py b/tests/contrib/django/test_django_appsec_iast.py index e407c1f914d..74dcbe81632 100644 --- a/tests/contrib/django/test_django_appsec_iast.py +++ b/tests/contrib/django/test_django_appsec_iast.py @@ -8,7 +8,7 @@ from ddtrace.appsec._constants import IAST from ddtrace.appsec.iast import oce from ddtrace.appsec.iast._patch_modules import patch_iast -from ddtrace.appsec.iast._util import _is_python_version_supported as python_supported_by_iast +from ddtrace.appsec.iast._utils import _is_python_version_supported as python_supported_by_iast from ddtrace.internal.compat import urlencode from tests.appsec.iast.iast_utils import get_line_and_hash from tests.utils import override_global_config diff --git a/tests/contrib/flask/test_flask_appsec_iast.py b/tests/contrib/flask/test_flask_appsec_iast.py index daa862a2e41..82c18796adc 100644 --- a/tests/contrib/flask/test_flask_appsec_iast.py +++ b/tests/contrib/flask/test_flask_appsec_iast.py @@ -5,7 +5,7 @@ from ddtrace.appsec._constants import IAST from ddtrace.appsec.iast import oce -from ddtrace.appsec.iast._util import _is_python_version_supported as python_supported_by_iast +from ddtrace.appsec.iast._utils import _is_python_version_supported as python_supported_by_iast from ddtrace.appsec.iast.constants import VULN_SQL_INJECTION from ddtrace.contrib.sqlite3.patch import patch from tests.appsec.iast.iast_utils import get_line_and_hash