OpenMetadata/ingestion/tests/unit/utils/test_memory_limit.py
IceS2 e9c87c6adb
chore(ingestion): drop pylint, expand ruff (#27774)
* chore(ingestion): drop pylint, expand ruff to Stage 2c

Replace pylint with a coherent ruff-only stack (Stage 2c of the modernize
roadmap). Pylint is dropped from dev deps and CI workflows; ruff selected
ruleset expanded to ~22 families covering style, bug catchers, hygiene,
and the pylint port (PLE/PLC/PLW/PLR with the noisy "too-many-X"
complexity caps + magic-value disabled).

What's selected (with rationale in pyproject.toml):
  E, W, F, I, N         — style + correctness baseline + naming
  UP                    — pyupgrade (py>=3.10 modernizations)
  B, C4, C90, RET, SIM, TRY  — bug catchers
  PIE, ICN, T20, TC, TID, PTH, PERF  — hygiene
  PLE, PLC, PLW, PLR    — pylint port (PLR complexity caps ignored)
  RUF                   — ruff-native (incl. RUF100 unused-noqa)

What's removed:
  - .pylintrc (root) — duplicate of the ingestion pylint config
  - [tool.pylint.*] block in ingestion/pyproject.toml (~140 lines)
  - ingestion/plugins/{print_checker,import_checker}.py + tests + README
    (replaced by built-in T20 + TID251 banned-api respectively)
  - pylint dep from ingestion/setup.py and openmetadata-airflow-apis/pyproject.toml
  - `make lint` Makefile target + the pylint invocation in py_format_check
  - dead pylint TODO comment + ignored test entry in noxfile.py

Cwd-stable config: ruff is invoked both from the repo root (pre-commit,
CI) and from ingestion/ (`make py_format_check`). The `src`,
`extend-exclude`, and per-file-ignores entries are listed twice — once
relative to ingestion/ and once with the `ingestion/` prefix — so
first-party isort detection and exclusions match in both invocations.

Grandfathering: ran `ruff check --add-noqa` once + format-stable
iteration. ~12,130 noqa directives across ~1,400 files. Cleanup is
deferred to follow-up PRs that drop noqas one rule at a time.

Documentation sweep: replaced `make lint` references in CLAUDE.md,
AGENTS.md, DEVELOPER.md, copilot-instructions, and 6 SKILL files with
the apply+verify shape `make py_format && make py_format_check`.
`make py_format` is NOT a strict superset of pylint — it only applies
auto-fixable violations; `make py_format_check` catches the rest.

Basedpyright baseline regenerated: ruff format reflowed multi-line
signatures in ~70 files, shifting type-error column positions. The
basedpyright baseline matches by (file path, error code, range), so
column shifts caused 19 entries to mis-align. Net diff is small
(154 lines in/out of the 13MB baseline.json) — purely positional.

Verified locally:
  - make py_format_check         → All checks passed
  - nox --no-venv -s static-checks → 0 errors, 0 warnings, 0 notes

* chore(ingestion): finish ruff swap — nox lint session + skill docs

Three remaining stale-tooling references after Stage 2c:

  - `ingestion/noxfile.py` `lint` session was still calling `black --check`,
    `isort --check-only`, `pycln --diff`. Those tools aren't installed
    anywhere (we dropped them from dev deps). Replace with the ruff
    equivalents that mirror `make py_format_check`.
  - `skills/standards/code_style.md`: stack listed as `black + isort +
    pycln`; line length claimed 88 (black default). Both wrong: stack is
    ruff, line length is 120.
  - `skills/connector-building/SKILL.md`: `make py_format` comment said
    `# black + isort + pycln`. Same swap.

* chore(ingestion): keep main's baseline + globally ignore TRY400

Per gitar-bot's review on PR #27774:

1. Main's PR #27728 promoted ~60 `logger.warning()` → `logger.error()`
   inside `except` blocks. Those changes landed on main with their own
   baseline updates. Our PR doesn't promote anything — the merge from
   origin/main brought those `error` calls along with their baseline
   entries.

   The bot interpreted the `# noqa: TRY400` we added next to those lines
   as us silencing the rule case-by-case. Cleaner: globally ignore
   TRY400 in pyproject.toml, with a comment explaining why the codebase's
   `logger.error(...)` + separate `logger.debug(traceback.format_exc())`
   pattern is intentional. Strip ~430 per-line `# noqa: TRY400` markers
   from source.

2. Document that `S101` in `per-file-ignores` is a forward-looking
   entry — flake8-bandit (`S`) is not yet selected, so the rule is
   no-op today; the entry stays so when `S` lands later, tests don't
   immediately error.

Reverts the platform pin and Linux Docker–generated baseline. Keep
main's baseline intact and let CI surface the exact column-shifted
entries; the team will decide whether to fix in-place (revert format
on affected files) or add per-line `# pyright: ignore` markers.

* chore(ingestion): regen baseline for new connector type debt

Main's baseline was stale relative to recently-added connectors
(McpConnection, CustomDriveConnection) that lack common attributes
like `hostPort`, `database`, `catalog` etc. — all sites that access
those attributes via the union-typed `serviceConnection.root.config`
fire `reportAttributeAccessIssue` errors that aren't baselined.

71 errors + 58 warnings absorbed. Local macOS regen; pushing to see
CI's drift count. Per the basedpyright-baseline-and-ci PR experience,
macOS↔Linux column drift on this size of regen has historically been
1-7 residuals.
2026-04-28 07:21:59 +02:00

807 lines
30 KiB
Python

# Copyright 2025 Collate
# Licensed under the Collate Community License, Version 1.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# https://github.com/open-metadata/OpenMetadata/blob/main/ingestion/LICENSE
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Unit tests for memory_limit decorator
Tests that memory limits are enforced correctly and only track function-specific allocations
"""
import time
import unittest
import pytest
from metadata.utils.memory_limit import MemoryLimitExceeded, memory_limit
from metadata.utils.timeout import timeout
class TestMemoryLimit(unittest.TestCase):
"""Test cases for memory limit functionality"""
def test_memory_limit_enforcement(self):
"""
Test that memory limit is correctly enforced when function exceeds limit.
Function allocates 100MB with 50MB limit - should raise MemoryLimitExceeded.
"""
@memory_limit(max_memory_mb=50, context="test_enforcement", verbose=True)
def allocate_memory_100mb():
"""Function that allocates ~100MB of memory"""
data = []
for i in range(100):
# Each allocation is ~1MB of actual bytes
chunk = bytearray(1024 * 1024) # Exactly 1MB
data.append(chunk)
# Small sleep to allow monitor to check
if i % 10 == 0:
time.sleep(0.5)
return len(data)
# Should raise MemoryLimitExceeded
with self.assertRaises(MemoryLimitExceeded) as context:
allocate_memory_100mb()
# Verify exception message contains expected info
exception_message = str(context.exception)
self.assertIn("exceeded memory limit", exception_message.lower())
self.assertIn("50MB", exception_message)
def test_function_specific_memory_tracking(self):
"""
Test that memory limit only tracks function's OWN memory allocations.
Pre-allocate 80MB before function, function uses only 5MB.
Should NOT raise exception (proves delta-based tracking).
"""
# Pre-allocate 80MB BEFORE the decorated function
preexisting_data = []
for i in range(80): # noqa: B007
chunk = [0] * (1024 * 128) # ~1MB per chunk
preexisting_data.append(chunk)
@memory_limit(max_memory_mb=30, context="test_tracking", verbose=False)
def allocate_only_5mb():
"""Function that allocates only ~5MB (well under limit)"""
data = []
for i in range(5): # noqa: B007
chunk = [0] * (1024 * 128) # ~1MB per chunk
data.append(chunk)
return len(data)
try:
result = allocate_only_5mb()
# Should succeed - function only allocated 5MB despite process having 80MB
self.assertEqual(result, 5)
except MemoryLimitExceeded:
self.fail("Function should NOT have been killed - only allocated 5MB (under 30MB limit)")
finally:
# Clean up preexisting data
del preexisting_data
def test_memory_limit_with_context(self):
"""
Test that context parameter is properly included in exception messages.
"""
test_context = "query_abc123"
@memory_limit(max_memory_mb=10, context=test_context, verbose=False)
def small_allocation():
"""Function that allocates enough to trigger limit"""
data = []
for i in range(20): # noqa: B007
chunk = bytearray(1024 * 1024) # 1MB each
data.append(chunk)
time.sleep(0.1)
return len(data)
with self.assertRaises(MemoryLimitExceeded) as context:
small_allocation()
# Verify context appears in exception message
exception_message = str(context.exception)
self.assertIn(test_context, exception_message)
def test_memory_limit_success_case(self):
"""
Test that function completes successfully when staying under limit.
"""
@memory_limit(max_memory_mb=100, context="test_success", verbose=False)
def small_allocation():
"""Function that allocates small amount of memory"""
data = []
for i in range(10): # noqa: B007
chunk = bytearray(1024 * 1024) # 1MB each = 10MB total
data.append(chunk)
return len(data)
# Should complete successfully
result = small_allocation()
self.assertEqual(result, 10)
def test_verbose_mode(self):
"""
Test that verbose mode doesn't affect functionality.
Just ensures verbose=True doesn't break anything.
"""
@memory_limit(max_memory_mb=50, context="test_verbose", verbose=True)
def small_allocation():
"""Function with verbose logging enabled"""
data = []
for i in range(10): # noqa: B007
chunk = bytearray(1024 * 1024) # 1MB each
data.append(chunk)
time.sleep(0.1) # Allow checkpoint logs to appear
return len(data)
# Should complete successfully with verbose logs
result = small_allocation()
self.assertEqual(result, 10)
def test_no_context(self):
"""
Test that decorator works without context parameter.
"""
@memory_limit(max_memory_mb=50, verbose=False)
def small_allocation():
"""Function without context"""
data = []
for i in range(10): # noqa: B007
chunk = bytearray(1024 * 1024) # 1MB each
data.append(chunk)
return len(data)
# Should complete successfully
result = small_allocation()
self.assertEqual(result, 10)
def test_rapid_memory_allocation(self):
"""
Test rapid memory allocation without delays.
Tests if monitor can catch very fast allocations.
Note: May complete before monitor catches it due to speed.
"""
@memory_limit(max_memory_mb=30, context="test_rapid", verbose=True)
def rapid_allocation():
"""Rapidly allocate memory without sleeps"""
data = []
for i in range(50): # Try to allocate 50MB quickly
chunk = bytearray(1024 * 1024) # 1MB each
data.append(chunk)
# Small delay every few iterations to give monitor a chance
if i % 5 == 0:
time.sleep(0.1)
return len(data)
# Should raise MemoryLimitExceeded
with self.assertRaises(MemoryLimitExceeded) as context:
rapid_allocation()
exception_message = str(context.exception)
self.assertIn("exceeded memory limit", exception_message.lower())
self.assertIn("30MB", exception_message)
def test_memory_spike_then_release(self):
"""
Test memory spike followed by release.
Should track peak memory correctly.
"""
@memory_limit(max_memory_mb=80, context="test_spike", verbose=True)
def spike_and_release():
"""Allocate memory, then release some"""
# Allocate 60MB
data = []
for i in range(60): # noqa: B007
chunk = bytearray(1024 * 1024)
data.append(chunk)
# Release half
data = data[:30]
# Try to allocate more (should be fine since we released)
for i in range(10): # noqa: B007
chunk = bytearray(1024 * 1024)
data.append(chunk)
time.sleep(0.1)
return len(data)
# Should complete successfully - peak should be ~60MB
result = spike_and_release()
self.assertEqual(result, 40) # 30 + 10
def test_gradual_memory_leak(self):
"""
Test gradual memory growth (simulating a leak).
Should eventually hit the limit.
"""
@memory_limit(max_memory_mb=40, context="test_leak", verbose=True)
def gradual_leak():
"""Gradually allocate memory"""
data = []
for i in range(100): # noqa: B007
# Small allocations that add up
chunk = bytearray(512 * 1024) # 0.5MB each
data.append(chunk)
time.sleep(0.05) # Give monitor time to check
return len(data)
# Should raise MemoryLimitExceeded before completing all 100 iterations
with self.assertRaises(MemoryLimitExceeded) as context:
gradual_leak()
exception_message = str(context.exception)
self.assertIn("exceeded memory limit", exception_message.lower())
def test_large_single_allocation(self):
"""
Test a single large allocation that exceeds limit.
Should be caught immediately.
"""
@memory_limit(max_memory_mb=50, context="test_large_single", verbose=True)
def single_large_allocation():
"""Single allocation of 80MB"""
# Single large allocation
data = bytearray(80 * 1024 * 1024) # 80MB at once
time.sleep(1) # Give monitor time to detect
return len(data)
# Should raise MemoryLimitExceeded
with self.assertRaises(MemoryLimitExceeded):
single_large_allocation()
def test_multiple_data_structures(self):
"""
Test with multiple different data structures.
Should track total memory across all structures.
"""
@memory_limit(max_memory_mb=70, context="test_multi_struct", verbose=True)
def multiple_structures():
"""Allocate memory across different data types"""
# Lists
lists = [bytearray(10 * 1024 * 1024) for _ in range(3)] # 30MB
# Dictionaries
dicts = {i: bytearray(5 * 1024 * 1024) for i in range(4)} # 20MB
# Strings (less efficient but still counted)
strings = ["x" * (2 * 1024 * 1024) for _ in range(5)] # ~10MB
time.sleep(0.5)
return len(lists) + len(dicts) + len(strings)
# Should complete successfully - total ~60MB, limit 70MB
result = multiple_structures()
self.assertEqual(result, 12)
def test_allocation_with_processing(self):
"""
Test memory allocation combined with processing.
Simulates real-world scenario of parsing + storing data.
"""
@memory_limit(max_memory_mb=40, context="test_processing", verbose=False)
def allocate_and_process():
"""Allocate memory while doing processing"""
data = []
for i in range(30): # noqa: B007
# Allocate memory
chunk = bytearray(1024 * 1024) # 1MB
# Do some processing (simulate real work)
processed = bytes(chunk) # Convert to bytes
data.append(processed)
# Small delay
time.sleep(0.05)
return len(data)
# Should complete successfully
result = allocate_and_process()
self.assertEqual(result, 30)
def test_nested_function_memory(self):
"""
Test that nested function allocations are tracked correctly.
"""
@memory_limit(max_memory_mb=40, context="test_nested", verbose=True)
def outer_function():
"""Function that calls nested functions"""
def inner_allocate(size_mb):
"""Inner function that allocates memory"""
return bytearray(size_mb * 1024 * 1024)
data = []
# Call inner function multiple times
for i in range(10): # noqa: B007
chunk = inner_allocate(5) # 5MB each
data.append(chunk)
time.sleep(0.2) # Give monitor time to detect
return len(data)
# Should raise MemoryLimitExceeded (10 * 5MB = 50MB > 40MB limit)
with self.assertRaises(MemoryLimitExceeded):
outer_function()
def test_memory_with_exceptions(self):
"""
Test that memory tracking works even when exceptions occur.
"""
@memory_limit(max_memory_mb=100, context="test_exceptions", verbose=False)
def allocate_with_exception():
"""Allocate memory then raise an exception"""
data = []
for i in range(20):
chunk = bytearray(1024 * 1024) # 1MB each
data.append(chunk)
if i == 10:
raise ValueError("Test exception")
return len(data)
# Should raise ValueError, not MemoryLimitExceeded
with self.assertRaises(ValueError):
allocate_with_exception()
def test_zero_memory_function(self):
"""
Test function that allocates minimal/no memory.
Should complete successfully.
"""
@memory_limit(max_memory_mb=10, context="test_zero", verbose=False)
def minimal_allocation():
"""Function with minimal memory usage"""
# Just do some computation
result = sum(range(1000000))
return result # noqa: RET504
# Should complete successfully
result = minimal_allocation()
self.assertGreater(result, 0)
def test_concurrent_decorated_functions(self):
"""
Test that multiple decorated functions can run without interfering.
Each should track its own memory independently.
"""
@memory_limit(max_memory_mb=30, context="test_concurrent_1", verbose=False)
def function_1():
"""First function"""
data = [bytearray(1024 * 1024) for _ in range(20)] # 20MB
time.sleep(0.5)
return len(data)
@memory_limit(max_memory_mb=30, context="test_concurrent_2", verbose=False)
def function_2():
"""Second function"""
data = [bytearray(1024 * 1024) for _ in range(15)] # 15MB
time.sleep(0.5)
return len(data)
# Run sequentially (not parallel, just testing independence)
result1 = function_1()
result2 = function_2()
self.assertEqual(result1, 20)
self.assertEqual(result2, 15)
def test_repeated_executions(self):
"""
Test that decorator can be used multiple times on same function.
Memory should reset between executions.
"""
@memory_limit(max_memory_mb=50, context="test_repeated", verbose=False)
def repeated_function():
"""Function that will be called multiple times"""
data = [bytearray(1024 * 1024) for _ in range(30)] # 30MB
return len(data)
# Execute multiple times
for i in range(3): # noqa: B007
result = repeated_function()
self.assertEqual(result, 30)
time.sleep(0.5) # Brief pause between executions
def test_extremely_rapid_allocation_no_delay(self):
"""
Test extremely rapid memory allocation (500MB) without delays.
Note: Due to the 0.1s monitor interval, there's a race condition:
- If the function completes in <200ms, it may finish before monitor catches it
- The monitor WILL detect the violation but may not raise exception in time
This test verifies that:
1. Monitor detects the violation (warning logged)
2. Exception is raised either during or after execution
3. Adding a small delay at the end ensures exception propagates
"""
@memory_limit(max_memory_mb=300, context="test_extremely_rapid", verbose=True)
def extremely_rapid_allocation():
"""Allocate 500MB as fast as possible - ZERO delays during allocation"""
data = []
# Allocate 500 chunks of 1MB each = 500MB total
# This happens in milliseconds, much faster than 0.1s monitor interval
for i in range(500): # noqa: B007
chunk = bytearray(1024 * 1024) # 1MB
data.append(chunk)
# Give monitor a chance to detect and raise exception
# In real parsers, there's usually processing time after allocation
time.sleep(0.3)
return len(data)
# Should raise MemoryLimitExceeded
# The delay ensures monitor has time to detect and raise exception
with self.assertRaises(MemoryLimitExceeded):
extremely_rapid_allocation()
def test_timeout_then_memory_limit_timeout_triggers(self):
"""
Test CORRECT order: @timeout (outer) then @memory_limit (inner)
When timeout triggers FIRST (function runs too long but under memory limit).
This is the CORRECT order for production use because timeout
doesn't work inside threads (memory_limit uses threads).
"""
@timeout(seconds=1)
@memory_limit(max_memory_mb=100, context="test_timeout_first", verbose=False)
def slow_function_under_memory():
"""Function that takes too long but doesn't exceed memory"""
data = [bytearray(1024 * 1024) for _ in range(10)] # 10MB
time.sleep(2) # Exceeds 1 second timeout
return len(data)
# Should raise TimeoutError (timeout triggers first)
with self.assertRaises(TimeoutError):
slow_function_under_memory()
def test_timeout_then_memory_limit_memory_triggers(self):
"""
Test CORRECT order: @timeout (outer) then @memory_limit (inner)
When memory limit triggers FIRST (exceeds memory before timeout).
This is the CORRECT order for production use.
"""
@timeout(seconds=10) # Long timeout, won't trigger
@memory_limit(max_memory_mb=30, context="test_memory_first", verbose=False)
def fast_high_memory_function():
"""Function that exceeds memory quickly"""
data = []
for i in range(50):
chunk = bytearray(1024 * 1024) # 1MB
data.append(chunk)
if i % 5 == 0:
time.sleep(0.1) # Give monitor time
return len(data)
# Should raise MemoryLimitExceeded (memory limit triggers first)
with self.assertRaises(MemoryLimitExceeded):
fast_high_memory_function()
def test_timeout_then_memory_limit_both_within_limits(self):
"""
Test CORRECT order: @timeout (outer) then @memory_limit (inner)
When function completes successfully within both limits.
"""
@timeout(seconds=5)
@memory_limit(max_memory_mb=50, context="test_both_ok", verbose=False)
def normal_function():
"""Function within both limits"""
data = [bytearray(1024 * 1024) for _ in range(20)] # 20MB
time.sleep(0.5)
return len(data)
# Should complete successfully
result = normal_function()
self.assertEqual(result, 20)
def test_memory_limit_then_timeout_timeout_may_fail(self):
"""
Test INCORRECT order: @memory_limit (outer) then @timeout (inner)
This is the WRONG order but we document the behavior.
WARNING: In this order, timeout runs inside the memory_limit thread.
Timeout mechanisms may not work reliably inside threads!
This test documents that memory_limit still works but timeout
behavior is unpredictable when it's the inner decorator.
"""
@memory_limit(max_memory_mb=100, context="test_wrong_order", verbose=False)
@timeout(seconds=1)
def slow_function_wrong_order():
"""Function with decorators in WRONG order"""
data = [bytearray(1024 * 1024) for _ in range(10)] # 10MB
time.sleep(2) # Would exceed timeout
return len(data)
# Timeout may or may not work reliably in this order
# This test just documents that it exists - behavior is undefined
try:
result = slow_function_wrong_order()
# If it completes, memory limit still worked
self.assertIsNotNone(result)
except (TimeoutError, MemoryLimitExceeded):
# Either exception is possible depending on thread timing
pass
def test_combined_decorators_realistic_parser_scenario(self):
"""
Test realistic lineage parser scenario with both decorators.
Simulates a query parser that could fail due to either:
- Taking too long (timeout)
- Using too much memory (memory limit)
Uses CORRECT order: @timeout then @memory_limit
"""
@timeout(seconds=3)
@memory_limit(max_memory_mb=80, context="test_parser_scenario", verbose=False)
def simulate_query_parser(query_size: int, parse_time: float):
"""
Simulates a query parser that allocates memory based on query size
and takes time to parse.
"""
# Simulate parsing data structures
data = []
for i in range(query_size):
chunk = bytearray(1024 * 1024) # 1MB per query element
data.append(chunk)
if i % 5 == 0:
time.sleep(0.1) # Simulate parsing work
# Simulate additional parsing time
time.sleep(parse_time)
return len(data)
# Scenario 1: Normal query - should succeed
result = simulate_query_parser(query_size=30, parse_time=0.5)
self.assertEqual(result, 30)
# Scenario 2: Complex query - should hit memory limit
with self.assertRaises(MemoryLimitExceeded):
simulate_query_parser(query_size=100, parse_time=0.5)
# Scenario 3: Slow query - should hit timeout
with self.assertRaises(TimeoutError):
simulate_query_parser(query_size=10, parse_time=5)
def test_timeout_memory_limit_exception_precedence(self):
"""
Test which exception is raised when both limits could be exceeded.
With correct order (@timeout outer, @memory_limit inner),
whichever condition is detected first will raise its exception.
"""
@timeout(seconds=2)
@memory_limit(max_memory_mb=40, context="test_precedence", verbose=True)
def function_exceeding_both():
"""Function that will exceed both limits"""
data = []
# Allocate memory quickly to trigger memory limit first
for i in range(60):
chunk = bytearray(1024 * 1024) # 1MB
data.append(chunk)
if i % 10 == 0:
time.sleep(0.2) # Some delay but should hit memory first
return len(data)
# Memory limit should trigger first since we allocate quickly
with self.assertRaises(MemoryLimitExceeded):
function_exceeding_both()
def test_memory_limit_in_threaded_environment(self):
"""
Test that memory_limit works correctly when the decorated function
is called FROM WITHIN a thread (not the main thread).
This simulates environments like Airflow workers, ThreadPoolExecutor,
or any multi-threaded application where decorated functions run in worker threads.
"""
import threading
results = {"exception": None, "success": False}
@memory_limit(max_memory_mb=30, context="test_in_thread", verbose=False)
def allocate_in_thread():
"""Function that will run in a worker thread"""
data = []
for i in range(50):
chunk = bytearray(1024 * 1024) # 1MB
data.append(chunk)
if i % 5 == 0:
time.sleep(0.1)
return len(data)
def run_in_thread():
"""Wrapper to run decorated function in thread"""
try:
result = allocate_in_thread()
results["success"] = True
results["result"] = result
except MemoryLimitExceeded as e:
results["exception"] = e
# Run decorated function in a separate thread
thread = threading.Thread(target=run_in_thread)
thread.start()
thread.join(timeout=10) # Wait up to 10 seconds
# Should have caught memory limit violation even in thread
self.assertIsNotNone(results["exception"])
self.assertIsInstance(results["exception"], MemoryLimitExceeded)
self.assertFalse(results["success"])
def test_memory_limit_with_multiple_concurrent_threads(self):
"""
Test that memory_limit works correctly with multiple threads
running decorated functions concurrently.
IMPORTANT: tracemalloc tracks memory GLOBALLY across all threads,
not per-thread. This is correct behavior - we want to limit total
memory usage across all concurrent operations.
"""
from concurrent.futures import ThreadPoolExecutor
@memory_limit(max_memory_mb=100, context="test_multi_thread", verbose=False)
def allocate_in_concurrent_thread(thread_id: int, mb_to_allocate: int):
"""Function that allocates specified MB in a thread"""
data = []
for i in range(mb_to_allocate): # noqa: B007
chunk = bytearray(1024 * 1024) # 1MB
data.append(chunk)
time.sleep(0.05) # Small delay
return f"thread-{thread_id}-allocated-{mb_to_allocate}MB"
results = {}
# Run multiple threads sequentially (not concurrently) to test
# that memory_limit works correctly when called from threads
with ThreadPoolExecutor(max_workers=1) as executor:
# Thread 1: should succeed (20MB < 100MB limit)
future1 = executor.submit(allocate_in_concurrent_thread, 1, 20)
try:
result = future1.result()
results[1] = {"success": True, "result": result}
except MemoryLimitExceeded as e:
results[1] = {"success": False, "exception": e}
# Thread 2: should fail (120MB > 100MB limit)
future2 = executor.submit(allocate_in_concurrent_thread, 2, 120)
try:
result = future2.result()
results[2] = {"success": True, "result": result}
except MemoryLimitExceeded as e:
results[2] = {"success": False, "exception": e}
# Thread 1: should succeed (20MB < 100MB limit)
self.assertTrue(results[1]["success"])
self.assertIn("thread-1-allocated-20MB", results[1]["result"])
# Thread 2: should fail (120MB > 100MB limit)
self.assertFalse(results[2]["success"])
self.assertIsInstance(results[2]["exception"], MemoryLimitExceeded)
def test_memory_limit_with_thread_pool_executor(self):
"""
Test memory_limit with ThreadPoolExecutor specifically,
as this is commonly used in production (e.g., Airflow).
"""
from concurrent.futures import ThreadPoolExecutor
@memory_limit(max_memory_mb=50, context="test_thread_pool", verbose=False)
def process_item(item_id: int):
"""Simulates processing an item with memory allocation"""
# Allocate 10MB per item
data = [bytearray(1024 * 1024) for _ in range(10)]
time.sleep(0.2)
return f"processed-{item_id}-{len(data)}MB"
results = []
# Process 5 items in thread pool (each 10MB, all under 50MB limit)
with ThreadPoolExecutor(max_workers=3) as executor:
futures = [executor.submit(process_item, i) for i in range(5)]
for future in futures:
try:
result = future.result()
results.append({"success": True, "result": result})
except Exception as e:
results.append({"success": False, "exception": e})
# All should succeed (10MB each < 50MB limit)
success_count = sum(1 for r in results if r["success"])
self.assertEqual(success_count, 5)
@pytest.mark.skip(
reason=(
"We are aware memory_limit adds overhead. This test is for monitoring overhead"
" changes over time and enabled once we have better optimizations."
)
)
def test_memory_limit_performance_overhead(self):
"""
Test that memory_limit decorator has minimal performance overhead.
CPU-intensive function should take similar time with/without decorator.
Acceptable overhead: < 50% (ideally < 20%)
"""
def cpu_intensive_work():
"""Pure CPU work - calculate primes"""
result = 0
for n in range(2, 500000):
is_prime = True
for i in range(2, int(n**0.5) + 1):
if n % i == 0:
is_prime = False
break
if is_prime:
result += 1
return result
# Measure baseline (without decorator)
start_baseline = time.time()
result_baseline = cpu_intensive_work()
baseline_duration = time.time() - start_baseline
# Measure with memory_limit decorator
decorated_fn = memory_limit(max_memory_mb=100)(cpu_intensive_work)
start_decorated = time.time()
result_decorated = decorated_fn()
decorated_duration = time.time() - start_decorated
# Results should be identical
self.assertEqual(result_baseline, result_decorated)
# Calculate overhead percentage
overhead_pct = ((decorated_duration - baseline_duration) / baseline_duration) * 100
# Assert overhead is within acceptable limits
self.assertLessEqual(
overhead_pct,
1000,
"\n\tVERY HIGH OVERHEAD (>1000%)"
f"\n\t - Baseline time: {baseline_duration:.3f}s"
f"\n\t - Decorated time: {decorated_duration:.3f}s"
f"\n\t - Overhead: {overhead_pct:.1f}%",
)
self.assertLessEqual(
overhead_pct,
100,
"\n\tSIGNIFICANT OVERHEAD (>100%)"
f"\n\t - Baseline time: {baseline_duration:.3f}s"
f"\n\t - Decorated time: {decorated_duration:.3f}s"
f"\n\t - Overhead: {overhead_pct:.1f}%",
)
if __name__ == "__main__":
unittest.main()