Merge pull request #550 from golemfactory/az/service-cluster-properties

Read-only properties for some Service/Cluster private fields

tests/test_engine.py

@@ -0,0 +1,35 @@
+"""Unit tests for `yapapi.engine` module."""
+from unittest.mock import Mock
+
+import pytest
+
+from yapapi import Golem
+import yapapi.engine
+import yapapi.rest
+
+
+@pytest.fixture(autouse=True)
+def mock_rest_configuration(monkeypatch):
+    """Mock `yapapi.rest.Configuration`."""
+    monkeypatch.setattr(yapapi.rest, "Configuration", Mock)
+
+
+@pytest.mark.parametrize(
+    "default_subnet, subnet_arg, expected_subnet",
+    [
+        (None, None, None),
+        ("my-little-subnet", None, "my-little-subnet"),
+        (None, "whole-golem", "whole-golem"),
+        ("my-little-subnet", "whole-golem", "whole-golem"),
+    ],
+)
+def test_set_subnet_tag(default_subnet, subnet_arg, expected_subnet, monkeypatch):
+    """Check that `subnet_tag` argument takes precedence over `yapapi.engine.DEFAULT_SUBNET`."""
+
+    monkeypatch.setattr(yapapi.engine, "DEFAULT_SUBNET", default_subnet)
+
+    if subnet_arg is not None:
+        golem = Golem(budget=1.0, subnet_tag=subnet_arg)
+    else:
+        golem = Golem(budget=1.0)
+    assert golem.subnet_tag == expected_subnet

yapapi/engine.py

@@ -218,6 +218,11 @@ def strategy(self) -> MarketStrategy:
         """Return the instance of `MarketStrategy` used by this engine."""
         return self._strategy
 
+    @property
+    def subnet_tag(self) -> Optional[str]:
+        """Return the name of the subnet used by this engine, or `None` if it is not set."""
+        return self._subnet
+
     def emit(self, event: events.Event) -> None:
         """Emit an event to be consumed by this engine's event consumer."""
         if self._wrapped_consumer:

yapapi/services.py

@@ -119,6 +119,11 @@ def __init__(self, cluster: "Cluster", ctx: WorkContext):
         # stopping the service externally (e.g., via `cluster.stop()`) from internal transition
         # (e.g., via returning from `Service.run()`).
 
+    @property
+    def cluster(self) -> "Cluster":
+        """Return the Cluster to which this service instance belongs."""
+        return self._cluster
+
     @property
     def id(self):
         """Return the id of this service instance.
@@ -281,7 +286,9 @@ def __init__(
         self._engine = engine
         self._service_class = service_class
         self._payload = payload
-        self._expiration = expiration or datetime.now(timezone.utc) + DEFAULT_SERVICE_EXPIRATION
+        self._expiration: datetime = (
+            expiration or datetime.now(timezone.utc) + DEFAULT_SERVICE_EXPIRATION
+        )
         self._task_ids = itertools.count(1)
         self._stack = AsyncExitStack()
         self._respawn_unstarted_instances = respawn_unstarted_instances
@@ -292,6 +299,21 @@ def __init__(
         self._instance_tasks: Set[asyncio.Task] = set()
         """Set of asyncio tasks that run spawn_service()"""
 
+    @property
+    def expiration(self) -> datetime:
+        """Return the expiration datetime for agreements related to services in this Cluster."""
+        return self._expiration
+
+    @property
+    def payload(self) -> Payload:
+        """Return the service runtime definition for this Cluster."""
+        return self._payload
+
+    @property
+    def service_class(self) -> Type[Service]:
+        """Return the class instantiated by all service instances in this Cluster."""
+        return self._service_class
+
     def __repr__(self):
         return (
             f"Cluster {self.id}: {len(self.__instances)}x[Service: {self._service_class.__name__}, "