golem-vm-provider 0.1.55__tar.gz → 0.1.57__tar.gz

{golem_vm_provider-0.1.55 → golem_vm_provider-0.1.57}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: golem-vm-provider
-Version: 0.1.55
+Version: 0.1.57
 Summary: VM on Golem Provider Node - Run your own provider node to offer VMs on the Golem Network
 Keywords: golem,vm,provider,cloud,decentralized
 Author: Phillip Jensen
@@ -61,6 +61,69 @@ pip install golem-vm-provider
 golem-provider start --network testnet
 ```
 
+Verify your environment and connectivity anytime:
+
+```bash
+golem-provider status
+```
+This checks Multipass availability, local/external port reachability, and whether an update is available on PyPI.
+
+### Status Command (TTY and JSON)
+
+Use `golem-provider status` to quickly assess health.
+
+TTY output highlights
+
+```
+Overall         Error | Issues detected | Healthy
+
+Multipass       ✅ OK | ❌ Missing
+
+Provider Port   0.0.0.0:7466
+  Local         ✅ service is listening | ❌ port unavailable
+  External      ✅ reachable | ❌ unreachable — <reason>
+
+SSH Ports       <start>-<end> — OK | limited — N issue(s) | blocked
+  Usable free   <count>   # free AND externally reachable
+  In use        <count>
+  Issues        e.g. "100 not reachable externally" or "3 unreachable, 1 not listening"
+```
+
+Severity rules
+
+- Overall is Error when any critical prerequisite fails:
+  - Provider API port not externally reachable (or external check fails).
+  - No externally reachable SSH ports in the configured range.
+  - Multipass missing or provider local port not ready.
+- Otherwise it shows Issues detected or Healthy.
+
+Machine‑readable JSON
+
+```bash
+golem-provider status --json
+```
+
+Key fields:
+
+- `overall.status`: "healthy" | "issues" | "error"
+- `overall.issues`: list of concise issue strings
+- `ports.provider`:
+  - `port`: int, `host`: string
+  - `status`: "reachable" | "unreachable" (external check failures are treated as "unreachable")
+- `ports.ssh`:
+  - `range`: [start, end)
+  - `status`: "ok" | "limited" | "blocked"
+  - `usable_free`: integer — free AND externally reachable
+  - `in_use`: integer
+  - `issues`: `{ unreachable: int, not_listening: int }`
+  - `ports`: array of per‑port summaries:
+    - `{ port: int, status: "reachable" | "unreachable" | "unknown", listening: bool }`
+
+Notes
+
+- The concept of "free" in JSON is replaced by `usable_free` (free + externally reachable) to avoid misleading counts when ports are blocked.
+- When the external checker is unavailable, per‑port `status` is `"unknown"` and `listening` still reflects local state.
+
 3) Set pricing in USD (GLM rates auto‑compute):
 
 ```bash
@@ -592,13 +655,16 @@ The provider includes real-time port verification status:
 
 Example status output:
 
-```bash
-🌟 Port Verification Status
-==========================
-[✅] Provider Port {provider_port}: External ✓ | Internal ✓
-[✅] VM Access Ports: 3 ports available ({start_port}-{start_port+2})
-[✅] Overall Status: Provider Ready
-└─ Can handle up to {n} concurrent VMs
+```
+Overall         Healthy
+
+Provider Port   {host}:{provider_port}
+  Local         ✅ service is listening
+  External      ✅ reachable
+
+SSH Ports       {start_port}-{end_port_minus_one} — OK
+  Usable free   {usable_free}
+  In use        {in_use}
 ```
 
 ### Resource Allocation Issues

{golem_vm_provider-0.1.55 → golem_vm_provider-0.1.57}/README.md

@@ -16,6 +16,69 @@ pip install golem-vm-provider
 golem-provider start --network testnet
 ```
 
+Verify your environment and connectivity anytime:
+
+```bash
+golem-provider status
+```
+This checks Multipass availability, local/external port reachability, and whether an update is available on PyPI.
+
+### Status Command (TTY and JSON)
+
+Use `golem-provider status` to quickly assess health.
+
+TTY output highlights
+
+```
+Overall         Error | Issues detected | Healthy
+
+Multipass       ✅ OK | ❌ Missing
+
+Provider Port   0.0.0.0:7466
+  Local         ✅ service is listening | ❌ port unavailable
+  External      ✅ reachable | ❌ unreachable — <reason>
+
+SSH Ports       <start>-<end> — OK | limited — N issue(s) | blocked
+  Usable free   <count>   # free AND externally reachable
+  In use        <count>
+  Issues        e.g. "100 not reachable externally" or "3 unreachable, 1 not listening"
+```
+
+Severity rules
+
+- Overall is Error when any critical prerequisite fails:
+  - Provider API port not externally reachable (or external check fails).
+  - No externally reachable SSH ports in the configured range.
+  - Multipass missing or provider local port not ready.
+- Otherwise it shows Issues detected or Healthy.
+
+Machine‑readable JSON
+
+```bash
+golem-provider status --json
+```
+
+Key fields:
+
+- `overall.status`: "healthy" | "issues" | "error"
+- `overall.issues`: list of concise issue strings
+- `ports.provider`:
+  - `port`: int, `host`: string
+  - `status`: "reachable" | "unreachable" (external check failures are treated as "unreachable")
+- `ports.ssh`:
+  - `range`: [start, end)
+  - `status`: "ok" | "limited" | "blocked"
+  - `usable_free`: integer — free AND externally reachable
+  - `in_use`: integer
+  - `issues`: `{ unreachable: int, not_listening: int }`
+  - `ports`: array of per‑port summaries:
+    - `{ port: int, status: "reachable" | "unreachable" | "unknown", listening: bool }`
+
+Notes
+
+- The concept of "free" in JSON is replaced by `usable_free` (free + externally reachable) to avoid misleading counts when ports are blocked.
+- When the external checker is unavailable, per‑port `status` is `"unknown"` and `listening` still reflects local state.
+
 3) Set pricing in USD (GLM rates auto‑compute):
 
 ```bash
@@ -547,13 +610,16 @@ The provider includes real-time port verification status:
 
 Example status output:
 
-```bash
-🌟 Port Verification Status
-==========================
-[✅] Provider Port {provider_port}: External ✓ | Internal ✓
-[✅] VM Access Ports: 3 ports available ({start_port}-{start_port+2})
-[✅] Overall Status: Provider Ready
-└─ Can handle up to {n} concurrent VMs
+```
+Overall         Healthy
+
+Provider Port   {host}:{provider_port}
+  Local         ✅ service is listening
+  External      ✅ reachable
+
+SSH Ports       {start_port}-{end_port_minus_one} — OK
+  Usable free   {usable_free}
+  In use        {in_use}
 ```
 
 ### Resource Allocation Issues

{golem_vm_provider-0.1.55 → golem_vm_provider-0.1.57}/provider/api/routes.py

@@ -7,8 +7,7 @@ from fastapi import APIRouter, HTTPException, Request
 from dependency_injector.wiring import inject, Provide
 from fastapi import APIRouter, HTTPException, Depends
 
-from ..config import Settings
-from ..config import Settings as _Cfg
+from typing import TYPE_CHECKING, Any
 from ..container import Container
 from ..utils.logging import setup_logger
 from ..utils.ascii_art import vm_creation_animation, vm_status_change
@@ -27,7 +26,7 @@ router = APIRouter()
 async def create_vm(
     request: CreateVMRequest,
     vm_service: VMService = Depends(Provide[Container.vm_service]),
-    settings: Settings = Depends(Provide[Container.config]),
+    settings: Any = Depends(Provide[Container.config]),
     stream_map = Depends(Provide[Container.stream_map]),
 ) -> VMInfo:
     """Create a new VM."""
@@ -39,11 +38,12 @@ async def create_vm(
         # If payments are enabled, require a valid stream before starting
         # Determine if we should enforce gating
         enforce = False
-        spa = settings["STREAM_PAYMENT_ADDRESS"]
+        spa = (settings.get("STREAM_PAYMENT_ADDRESS") if isinstance(settings, dict) else getattr(settings, "STREAM_PAYMENT_ADDRESS", None))
         if spa and spa != "0x0000000000000000000000000000000000000000":
             if os.environ.get("PYTEST_CURRENT_TEST"):
                 # In pytest, skip gating only when using default deployment address
                 try:
+                    from ..config import Settings as _Cfg  # type: ignore
                     default_spa, _ = _Cfg._load_l2_deployment()  # type: ignore[attr-defined]
                 except Exception:
                     default_spa = None
@@ -54,8 +54,10 @@ async def create_vm(
         if enforce:
             if request.stream_id is None:
                 raise HTTPException(status_code=400, detail="stream_id required when payments are enabled")
-            reader = StreamPaymentReader(settings["POLYGON_RPC_URL"], settings["STREAM_PAYMENT_ADDRESS"])
-            ok, reason = reader.verify_stream(int(request.stream_id), settings["PROVIDER_ID"])
+            rpc_url = settings.get("POLYGON_RPC_URL") if isinstance(settings, dict) else getattr(settings, "POLYGON_RPC_URL", None)
+            reader = StreamPaymentReader(rpc_url, spa)
+            expected_recipient = settings.get("PROVIDER_ID") if isinstance(settings, dict) else getattr(settings, "PROVIDER_ID", None)
+            ok, reason = reader.verify_stream(int(request.stream_id), expected_recipient)
             try:
                 s = reader.get_stream(int(request.stream_id))
                 now = int(reader.web3.eth.get_block("latest")["timestamp"])  # type: ignore[attr-defined]
@@ -73,7 +75,7 @@ async def create_vm(
         # Create VM config
         config = VMConfig(
             name=request.name,
-            image=request.image or settings["DEFAULT_VM_IMAGE"],
+            image=request.image or (settings.get("DEFAULT_VM_IMAGE") if isinstance(settings, dict) else getattr(settings, "DEFAULT_VM_IMAGE", "")),
             resources=resources,
             ssh_key=request.ssh_key
         )
@@ -143,7 +145,7 @@ async def get_vm_status(
 async def get_vm_access(
     requestor_name: str,
     vm_service: VMService = Depends(Provide[Container.vm_service]),
-    settings: Settings = Depends(Provide[Container.config]),
+    settings: Any = Depends(Provide[Container.config]),
 ) -> VMAccessInfo:
     """Get VM access information."""
     try:
@@ -156,7 +158,7 @@ async def get_vm_access(
             raise HTTPException(404, "VM mapping not found")
         
         return VMAccessInfo(
-            ssh_host=settings["PUBLIC_IP"] or "localhost",
+            ssh_host=((settings.get("PUBLIC_IP") if isinstance(settings, dict) else getattr(settings, "PUBLIC_IP", None)) or "localhost"),
             ssh_port=vm.ssh_port,
             vm_id=requestor_name,
             multipass_name=multipass_name
@@ -222,7 +224,7 @@ async def delete_vm(
         raise HTTPException(status_code=500, detail="An unexpected error occurred")
 @router.get("/provider/info", response_model=ProviderInfoResponse)
 @inject
-async def provider_info(settings: Settings = Depends(Provide[Container.config])) -> ProviderInfoResponse:
+async def provider_info(settings: Any = Depends(Provide[Container.config])) -> ProviderInfoResponse:
     return ProviderInfoResponse(
         provider_id=settings["PROVIDER_ID"],
         stream_payment_address=settings["STREAM_PAYMENT_ADDRESS"],
@@ -234,7 +236,7 @@ async def provider_info(settings: Settings = Depends(Provide[Container.config]))
 @inject
 async def get_vm_stream_status(
     requestor_name: str,
-    settings: Settings = Depends(Provide[Container.config]),
+    settings: Any = Depends(Provide[Container.config]),
     stream_map = Depends(Provide[Container.stream_map]),
 ) -> StreamStatus:
     """Return on-chain stream status for a VM (if mapped)."""
@@ -266,7 +268,7 @@ async def get_vm_stream_status(
 @router.get("/payments/streams", response_model=List[StreamStatus])
 @inject
 async def list_stream_statuses(
-    settings: Settings = Depends(Provide[Container.config]),
+    settings: Any = Depends(Provide[Container.config]),
     stream_map = Depends(Provide[Container.stream_map]),
 ) -> List[StreamStatus]:
     """List stream status for all mapped VMs."""

{golem_vm_provider-0.1.55 → golem_vm_provider-0.1.57}/provider/config.py

@@ -38,7 +38,8 @@ def ensure_config() -> None:
         created = True
 
     if created:
-        print("Using default settings – run with --help to customize")
+        # Inform the user, but write to stderr so JSON outputs on stdout remain clean
+        logger.info("Using default settings – run with --help to customize")
 
 
 if not os.environ.get("GOLEM_PROVIDER_SKIP_BOOTSTRAP") and not os.environ.get("PYTEST_CURRENT_TEST"):

{golem_vm_provider-0.1.55 → golem_vm_provider-0.1.57}/provider/container.py

@@ -2,7 +2,6 @@ import os
 from dependency_injector import containers, providers
 from pathlib import Path
 
-from .config import settings
 from .discovery.resource_tracker import ResourceTracker
 from .discovery.golem_base_advertiser import GolemBaseAdvertiser
 from .discovery.advertiser import DiscoveryServerAdvertiser
@@ -49,12 +48,12 @@ class Container(containers.DeclarativeContainer):
 
     vm_name_mapper = providers.Singleton(
         VMNameMapper,
-        db_path=Path(settings.VM_DATA_DIR) / "vm_names.json",
+        db_path=providers.Callable(lambda base: Path(base) / "vm_names.json", config.VM_DATA_DIR),
     )
 
     stream_map = providers.Singleton(
         StreamMap,
-        storage_path=Path(settings.VM_DATA_DIR) / "streams.json",
+        storage_path=providers.Callable(lambda base: Path(base) / "streams.json", config.VM_DATA_DIR),
     )
 
     port_manager = providers.Singleton(