Add threaded utils tests, update CRC usage, add OWNERS (#1)

* Add threaded utils tests

* Update to openshift-python-wrapper 11.0.44

* update owners

* Add PR template and in-solidarity action

* Add vme-perf to reviewers

* Correct typing and update dependencies

* Update OWNERS

* Update pyproject.toml links

Author: sarahbx

.github/in-solidarity.yml

@@ -0,0 +1,13 @@
+rules:
+  master:
+    level: failure  # default rules are set to warning
+  slave:
+    level: failure
+  blacklist:
+    level: failure
+  whitelist:
+    level: failure
+ignore:
+ - ".github/in-solidarity.yml"  # default
+ - ".github/workflows/*.yml"
+ - "**/*.yml"

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+### Short description:
+
+### More details:
+
+### What this PR does / why we need it:
+
+### Which issue(s) this PR fixes:
+
+### Special notes for reviewer:
+
+### Bug:

.gitignore

@@ -5,3 +5,5 @@
 .ruff_cache
 dist
 __pycache__
+.tests_coverage
+.pytest_cache

OWNERS

@@ -0,0 +1,10 @@
+approvers:
+  - sarahbx
+  - m0rdechai
+reviewers:
+  - sarahbx
+  - qwang1
+  - TzahiAshkenazi
+  - duduvaa
+  - m0rdechai
+  - guchen11

ocp_scale_utilities/threaded/scale.py

@@ -2,7 +2,7 @@
 
 import time
 from contextlib import ExitStack, contextmanager
-from typing import Any, Optional
+from typing import Any, Optional, Sequence
 
 import pytest
 from ocp_resources.resource import Resource
@@ -19,18 +19,18 @@
 class ThreadedScaleResources(ExitStack):
     def __init__(
         self,
-        resources: list[Resource],
-        request_resources: Optional[list[Resource]] = None,
+        resources: Sequence[Resource],
+        request_resources: Optional[Sequence[Resource]] = None,
         pytest_cache: Optional[pytest.Cache] = None,
         cache_key_prefix: Optional[str] = None,
-        wait_for_status: Optional[Resource.Status] = None,
+        wait_for_status: Optional[str] = None,
     ):
         """
         Args:
-            resources (list): List of Resource objects to be managed
+            resources (Sequence): List of Resource objects to be managed
             pytest_cache (pytest.Cache): config.cache from python run to store results in
             cache_key_prefix (str): prefix to use for cache_keys
-            wait_for_status (Resource.Status): Wait for provided status upon deploy
+            wait_for_status (str): Wait for provided status upon deploy
         """
         super().__init__()
         self.resources = resources
@@ -61,6 +61,7 @@ def __enter__(self) -> ThreadedScaleResources:
 
             stop_time = time.time()
             if self.pytest_cache and self.cache_key_prefix:
+                self.pytest_cache.set(f"{self.cache_key_prefix}-deploy-count", len(self.resources))
                 self.pytest_cache.set(f"{self.cache_key_prefix}-deploy-start", start_time)
                 self.pytest_cache.set(f"{self.cache_key_prefix}-deploy-stop", stop_time)
                 self.pytest_cache.set(f"{self.cache_key_prefix}-deploy-elapsed", stop_time - start_time)

ocp_scale_utilities/threaded/utils.py

@@ -3,7 +3,7 @@
 import logging
 from concurrent.futures import ThreadPoolExecutor
 from contextlib import ExitStack
-from typing import Any, Optional
+from typing import Any, Optional, Sequence
 
 from ocp_resources.resource import Resource
 
@@ -12,7 +12,7 @@
 LOGGER = logging.getLogger(__name__)
 
 
-def threaded_clean_up_resources(resources: list[Resource]) -> list[Any]:
+def threaded_clean_up_resources(resources: Sequence[Resource]) -> list[Any]:
     """
     Call clean_up() for multiple resources via threads
 
@@ -26,7 +26,7 @@ def threaded_clean_up_resources(resources: list[Resource]) -> list[Any]:
         return list(executor.map(lambda x: x.clean_up(), resources))
 
 
-def threaded_delete_resources(resources: list[Resource]) -> list[Any]:
+def threaded_delete_resources(resources: Sequence[Resource]) -> list[Any]:
     """
     Call delete() for multiple resources via threads
 
@@ -40,7 +40,7 @@ def threaded_delete_resources(resources: list[Resource]) -> list[Any]:
         return list(executor.map(lambda x: x.delete(), resources))
 
 
-def threaded_wait_deleted_resources(resources: list[Resource]) -> list[Any]:
+def threaded_wait_deleted_resources(resources: Sequence[Resource]) -> list[Any]:
     """
     Call wait_deleted() for multiple resources via threads
 
@@ -55,7 +55,7 @@ def threaded_wait_deleted_resources(resources: list[Resource]) -> list[Any]:
 
 
 def threaded_deploy_requested_resources(
-    resources: list[Resource], request_resources: list[Resource], exit_stack: Optional[ExitStack] = None
+    resources: Sequence[Resource], request_resources: Sequence[Resource], exit_stack: Optional[ExitStack] = None
 ) -> list[Any]:
     """
     Deploy multiple resources via threads
@@ -81,7 +81,7 @@ def _deploy(_resource: tuple[Resource, Resource]) -> Any:
         return list(executor.map(_deploy, zip(request_resources, resources)))
 
 
-def threaded_deploy_resources(resources: list[Resource], exit_stack: Optional[ExitStack] = None) -> list[Any]:
+def threaded_deploy_resources(resources: Sequence[Resource], exit_stack: Optional[ExitStack] = None) -> list[Any]:
     """
     Deploy multiple resources via threads
 
@@ -104,14 +104,14 @@ def _deploy(_resource: Resource) -> Any:
 
 
 def threaded_wait_for_resources_status(
-    resources: list[Resource], status: Resource.Status, timeout: int = TIMEOUT_2MIN
+    resources: Sequence[Resource], status: str, timeout: int = TIMEOUT_2MIN
 ) -> list[Any]:
     """
     Wait for multiple resources to to reach status via threads
 
     Args:
         resources (list): List of Resources
-        status: (Resource.Status): Status to wait for
+        status: (str): Status to wait for
         timeout: (int): Length of time for each thread to wait for resource to reach status
 
     Returns:

pyproject.toml

@@ -20,7 +20,7 @@ omit = [
 ]
 
 [tool.coverage.report]
-fail_under = 45
+fail_under = 90
 skip_empty = true
 
 [tool.coverage.html]
@@ -49,7 +49,7 @@ dev-dependencies = [ "ipdb>=0.13.13", "ipython>=8.12.3" ]
 [project]
 name = "openshift-python-scale-utilities"
 requires-python = ">=3.12.0"
-version = "0.1.1.3"
+version = "0.1.1.4"
 description = "OpenShift Python Scale Utilities"
 readme = "README.md"
 license = "Apache-2.0"
@@ -59,23 +59,26 @@ classifiers = [
   "Operating System :: OS Independent"
 ]
 dependencies = [
-  "pytest>=8.3.3",
-  "timeout-sampler>=1.0.1",
-  "openshift-python-wrapper~=11.0.10",
+  "openshift-python-wrapper>=11.0.44",
   "openshift-python-utilities>=6.0.0",
+  "pytest>=8.3.3",
+  "pytest-order>=1.3.0",
   "python-simple-logger~=2.0.9",
+  "timeout-sampler>=1.0.1",
 ]
 
   [[project.authors]]
   name = "Sarah Bennert"
+  email = "sarahbx@redhat.com"
 
   [[project.maintainers]]
   name = "Sarah Bennert"
+  email = "sarahbx@redhat.com"
 
   [project.urls]
-  homepage = "https://github.com/sarahbx/openshift-python-scale-utilities"
+  homepage = "https://github.com/redhat-vmeperf/openshift-python-scale-utilities"
   Download = "https://pypi.org/project/openshift-python-scale-utilities/"
-  "Bug Tracker" = "https://github.com/sarahbx/openshift-python-scale-utilities/issues"
+  "Bug Tracker" = "https://github.com/redhat-vmeperf/openshift-python-scale-utilities/issues"
 
 
 [build-system]

tests/README.md

@@ -1,20 +1,16 @@
 # Running Tests
 
-## Pre-configuration
+## Setup uv
+https://github.com/astral-sh/uv
 
-### Existing Running Cluster (CRC or otherwise)
-Simply set the KUBECONFIG environment variable
-```
-export KUBECONFIG=...
-```
+## OpenShift Local (CRC)
 
-### OpenShift Local (CRC)
-
-#### Download CRC
+### Download CRC
 https://console.redhat.com/openshift/create/local
 
-#### Setup CRC
+### Setup CRC
 https://crc.dev/docs/installing/
+
 https://crc.dev/docs/configuring/
 
 Example setup:
@@ -27,16 +23,15 @@ Example setup:
 ./crc setup
 ```
 
-#### Set ENV vars to provide necessary paths to pytest
+### Set ENV vars to provide necessary paths to pytest
 
-If you wish to use a running CRC cluster set the KUBECONFIG path only
+Set CRC_PATH only. If CRC is already running, will use it, otherwise will start/stop CRC.
 ```
-unset CRC_PATH
-export KUBECONFIG=~/.crc/machines/crc/kubeconfig
+unset KUBECONFIG
+export CRC_PATH=~/openshift-local/crc-linux-2.49.0-amd64/crc
 ```
 
-If you want the test automation to start and stop CRC, set the CRC_PATH only
+## Run tests
 ```
-unset KUBECONFIG
-export CRC_PATH=~/openshift-local/crc-linux-2.49.0-amd64/crc
+uv run pytest tests
 ```