aissemble-inference-common-test 1.5.0rc3__tar.gz

aissemble_inference_common_test-1.5.0rc3/.gitignore

@@ -0,0 +1,39 @@
+
+# Log file
+*.log
+
+# Package Files #
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.tgz
+*.rar
+*.jar
+
+# Package lock json
+package-lock.json
+
+# no uv.lock files for libraries
+uv.lock
+
+# node modules
+node_modules/
+
+docs/site
+dist/
+target/
+.idea/
+*.iml
+.venv/
+__pycache__/
+.python-version
+.vscode/
+
+# claude code items
+settings.local.json
+
+# don't store downloaded modules
+*.pt
+

aissemble_inference_common_test-1.5.0rc3/.python-version

@@ -0,0 +1 @@
+3.11.4

aissemble_inference_common_test-1.5.0rc3/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   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.

aissemble_inference_common_test-1.5.0rc3/PKG-INFO

@@ -0,0 +1,172 @@
+Metadata-Version: 2.4
+Name: aissemble-inference-common-test
+Version: 1.5.0rc3
+Summary: Reusable MLServer test utilities for aiSSEMBLE Inference
+Author-email: aiSSEMBLE Team <aissemble@bah.com>
+License-File: LICENSE.txt
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Requires-Dist: requests>=2.31.0
+Description-Content-Type: text/markdown
+
+# aiSSEMBLE OIP Common Test Utilities
+
+Reusable MLServer test utilities for aiSSEMBLE Inference modules and examples.
+
+## Overview
+
+This module provides consolidated MLServer lifecycle management utilities to eliminate code duplication across test suites. It offers two primary usage patterns:
+
+1. **Simple mode**: For examples with static model directories
+2. **Dynamic mode**: For module tests with temporary config generation
+
+## Installation
+
+```bash
+# As a test dependency in pyproject.toml
+[dependency-groups]
+test = [
+    "aissemble-inference-common-test",
+]
+
+[tool.uv.sources]
+aissemble-inference-common-test = { path = "../aissemble-inference-common-test", editable = true }
+```
+
+## Usage
+
+### Simple Mode (Examples)
+
+For tests that use pre-configured model directories:
+
+```python
+# tests/features/environment.py
+from pathlib import Path
+from aissemble_inference_common_test.behave_helpers import (
+    setup_mlserver_simple,
+    teardown_mlserver,
+)
+
+def before_all(context):
+    example_dir = Path(__file__).parent.parent.parent
+    models_dir = example_dir / "models"
+
+    setup_mlserver_simple(context, models_dir=models_dir, port=8080)
+    context.mlserver_fixture.start()
+
+def after_all(context):
+    teardown_mlserver(context)
+```
+
+### Dynamic Mode (Module Tests)
+
+For tests that generate model configurations dynamically:
+
+```python
+# tests/features/environment.py
+from aissemble_inference_common_test.behave_helpers import (
+    setup_mlserver_dynamic,
+    teardown_mlserver,
+    start_mlserver_with_model,
+)
+
+def before_all(context):
+    setup_mlserver_dynamic(context)
+
+def after_scenario(context, scenario):
+    if hasattr(context, "mlserver_fixture") and context.mlserver_fixture.process:
+        context.mlserver_fixture.stop()
+
+def after_all(context):
+    teardown_mlserver(context)
+
+# In your step definitions:
+start_mlserver_with_model(
+    context,
+    model_name="yolo",
+    runtime="aissemble_inference_yolo.YOLORuntime",
+    model="yolov8n.pt"
+)
+```
+
+## Features
+
+- **Process Management**: Robust MLServer subprocess handling with zombie process detection
+- **Health Checking**: Automatic polling of `/v2/health/ready` endpoint
+- **Graceful Shutdown**: Terminate with timeout, then kill if needed (with safety timeouts)
+- **Dynamic Port Allocation**: Automatic free port discovery
+- **Config Generation**: JSON settings and model-settings creation
+- **Context Manager Support**: Automatic cleanup with Python `with` statement
+- **Error Logging**: Detailed warnings for cleanup and shutdown failures
+- **Backward Compatible**: Drop-in replacement for existing test code
+
+## API Reference
+
+### MLServerFixture
+
+Main fixture class for MLServer lifecycle management.
+
+#### Basic Usage
+
+```python
+from aissemble_inference_common_test import MLServerFixture
+
+# Simple mode
+fixture = MLServerFixture.simple(port=8080, models_dir=Path("models"))
+fixture.start()
+
+# Dynamic mode
+fixture = MLServerFixture.dynamic()
+fixture.start_with_model(
+    model_name="yolo",
+    runtime="aissemble_inference_yolo.YOLORuntime",
+    model="yolov8n.pt"
+)
+
+# Cleanup
+fixture.stop()
+fixture.cleanup()
+```
+
+#### Context Manager Usage (Recommended)
+
+For automatic cleanup even when tests fail:
+
+```python
+from aissemble_inference_common_test import MLServerFixture
+from pathlib import Path
+
+# Simple mode with context manager
+with MLServerFixture.simple(port=8080, models_dir=Path("models")) as fixture:
+    fixture.start()
+    # Run tests...
+    # Automatic cleanup on exit
+
+# Dynamic mode with context manager
+with MLServerFixture.dynamic() as fixture:
+    fixture.start_with_model(
+        model_name="yolo",
+        runtime="aissemble_inference_yolo.YOLORuntime",
+        model="yolov8n.pt"
+    )
+    # Run tests...
+    # Automatic stop() and cleanup() on exit, even if exception occurs
+```
+
+### Behave Helpers
+
+- `setup_mlserver_simple(context, models_dir, port)` - Initialize simple fixture
+- `setup_mlserver_dynamic(context)` - Initialize dynamic fixture
+- `start_mlserver_with_model(context, model_name, runtime, **params)` - Start with config
+- `teardown_mlserver(context)` - Cleanup and shutdown
+
+## License
+
+Apache 2.0

aissemble_inference_common_test-1.5.0rc3/README.md

@@ -0,0 +1,154 @@
+# aiSSEMBLE OIP Common Test Utilities
+
+Reusable MLServer test utilities for aiSSEMBLE Inference modules and examples.
+
+## Overview
+
+This module provides consolidated MLServer lifecycle management utilities to eliminate code duplication across test suites. It offers two primary usage patterns:
+
+1. **Simple mode**: For examples with static model directories
+2. **Dynamic mode**: For module tests with temporary config generation
+
+## Installation
+
+```bash
+# As a test dependency in pyproject.toml
+[dependency-groups]
+test = [
+    "aissemble-inference-common-test",
+]
+
+[tool.uv.sources]
+aissemble-inference-common-test = { path = "../aissemble-inference-common-test", editable = true }
+```
+
+## Usage
+
+### Simple Mode (Examples)
+
+For tests that use pre-configured model directories:
+
+```python
+# tests/features/environment.py
+from pathlib import Path
+from aissemble_inference_common_test.behave_helpers import (
+    setup_mlserver_simple,
+    teardown_mlserver,
+)
+
+def before_all(context):
+    example_dir = Path(__file__).parent.parent.parent
+    models_dir = example_dir / "models"
+
+    setup_mlserver_simple(context, models_dir=models_dir, port=8080)
+    context.mlserver_fixture.start()
+
+def after_all(context):
+    teardown_mlserver(context)
+```
+
+### Dynamic Mode (Module Tests)
+
+For tests that generate model configurations dynamically:
+
+```python
+# tests/features/environment.py
+from aissemble_inference_common_test.behave_helpers import (
+    setup_mlserver_dynamic,
+    teardown_mlserver,
+    start_mlserver_with_model,
+)
+
+def before_all(context):
+    setup_mlserver_dynamic(context)
+
+def after_scenario(context, scenario):
+    if hasattr(context, "mlserver_fixture") and context.mlserver_fixture.process:
+        context.mlserver_fixture.stop()
+
+def after_all(context):
+    teardown_mlserver(context)
+
+# In your step definitions:
+start_mlserver_with_model(
+    context,
+    model_name="yolo",
+    runtime="aissemble_inference_yolo.YOLORuntime",
+    model="yolov8n.pt"
+)
+```
+
+## Features
+
+- **Process Management**: Robust MLServer subprocess handling with zombie process detection
+- **Health Checking**: Automatic polling of `/v2/health/ready` endpoint
+- **Graceful Shutdown**: Terminate with timeout, then kill if needed (with safety timeouts)
+- **Dynamic Port Allocation**: Automatic free port discovery
+- **Config Generation**: JSON settings and model-settings creation
+- **Context Manager Support**: Automatic cleanup with Python `with` statement
+- **Error Logging**: Detailed warnings for cleanup and shutdown failures
+- **Backward Compatible**: Drop-in replacement for existing test code
+
+## API Reference
+
+### MLServerFixture
+
+Main fixture class for MLServer lifecycle management.
+
+#### Basic Usage
+
+```python
+from aissemble_inference_common_test import MLServerFixture
+
+# Simple mode
+fixture = MLServerFixture.simple(port=8080, models_dir=Path("models"))
+fixture.start()
+
+# Dynamic mode
+fixture = MLServerFixture.dynamic()
+fixture.start_with_model(
+    model_name="yolo",
+    runtime="aissemble_inference_yolo.YOLORuntime",
+    model="yolov8n.pt"
+)
+
+# Cleanup
+fixture.stop()
+fixture.cleanup()
+```
+
+#### Context Manager Usage (Recommended)
+
+For automatic cleanup even when tests fail:
+
+```python
+from aissemble_inference_common_test import MLServerFixture
+from pathlib import Path
+
+# Simple mode with context manager
+with MLServerFixture.simple(port=8080, models_dir=Path("models")) as fixture:
+    fixture.start()
+    # Run tests...
+    # Automatic cleanup on exit
+
+# Dynamic mode with context manager
+with MLServerFixture.dynamic() as fixture:
+    fixture.start_with_model(
+        model_name="yolo",
+        runtime="aissemble_inference_yolo.YOLORuntime",
+        model="yolov8n.pt"
+    )
+    # Run tests...
+    # Automatic stop() and cleanup() on exit, even if exception occurs
+```
+
+### Behave Helpers
+
+- `setup_mlserver_simple(context, models_dir, port)` - Initialize simple fixture
+- `setup_mlserver_dynamic(context)` - Initialize dynamic fixture
+- `start_mlserver_with_model(context, model_name, runtime, **params)` - Start with config
+- `teardown_mlserver(context)` - Cleanup and shutdown
+
+## License
+
+Apache 2.0

aissemble_inference_common_test-1.5.0rc3/pom.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>com.boozallen.aissemble</groupId>
+        <artifactId>aissemble-inference-modules</artifactId>
+        <version>1.5.0-RC3</version>
+    </parent>
+
+    <artifactId>aissemble-inference-common-test</artifactId>
+    <packaging>habushu</packaging>
+
+    <name>aiSSEMBLE::Inference::Common Test Utilities</name>
+    <description>Reusable MLServer test utilities for aiSSEMBLE Inference modules and examples</description>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.technologybrewery.habushu</groupId>
+                <artifactId>habushu-maven-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

aissemble_inference_common_test-1.5.0rc3/pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name = "aissemble-inference-common-test"
+version = "1.5.0rc3"
+description = "Reusable MLServer test utilities for aiSSEMBLE Inference"
+readme = "README.md"
+authors = [
+    { name = "aiSSEMBLE Team", email = "aissemble@bah.com" }
+]
+requires-python = ">=3.11"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "requests>=2.31.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+exclude = ["target/"]
+
+[tool.ruff.lint]
+ignore = ["E741"]
+
+[[tool.uv.index]]
+name = "pypi"
+url = "https://pypi.org/simple/"
+publish-url = "https://pypi.org/simple/"
+
+[dependency-groups]
+dev = [
+    "ruff>=0.14.9",
+    "behave>=1.2.6",
+    "mlserver>=1.6.0",
+]
+
+test = [
+    "behave>=1.2.6",
+    "mlserver>=1.6.0",
+]

aissemble_inference_common_test-1.5.0rc3/src/aissemble_inference_common_test/__init__.py

@@ -0,0 +1,42 @@
+###
+# #%L
+# aiSSEMBLE::Open Inference Protocol::Common Test Utilities
+# %%
+# Copyright (C) 2024 Booz Allen Hamilton Inc.
+# %%
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+# #L%
+###
+"""aiSSEMBLE OIP Common Test Utilities.
+
+Reusable MLServer test fixtures and utilities for aiSSEMBLE OIP modules and examples.
+"""
+
+from .behave_helpers import (
+    setup_mlserver_dynamic,
+    setup_mlserver_simple,
+    start_mlserver_with_model,
+    teardown_mlserver,
+)
+from .config_builder import create_model_settings, create_settings
+from .mlserver_fixture import MLServerFixture
+
+__all__ = [
+    "MLServerFixture",
+    "create_settings",
+    "create_model_settings",
+    "setup_mlserver_simple",
+    "setup_mlserver_dynamic",
+    "start_mlserver_with_model",
+    "teardown_mlserver",
+]