From 0bb3e367d5d727d025d0f3e8283159fdcd7e09f6 Mon Sep 17 00:00:00 2001 From: Benny Zlotnik Date: Thu, 6 Feb 2025 19:26:33 +0200 Subject: [PATCH] snmp: drop return values for power control methods Signed-off-by: Benny Zlotnik --- docs/source/api-reference/drivers/snmp.md | 6 ++--- .../jumpstarter_driver_power/client.py | 25 ++++++++++--------- .../jumpstarter_driver_power/client_test.py | 6 ----- .../jumpstarter_driver_snmp/client.py | 8 +++--- 4 files changed, 20 insertions(+), 25 deletions(-) diff --git a/docs/source/api-reference/drivers/snmp.md b/docs/source/api-reference/drivers/snmp.md index c42f52fea..8332997e9 100644 --- a/docs/source/api-reference/drivers/snmp.md +++ b/docs/source/api-reference/drivers/snmp.md @@ -53,11 +53,11 @@ Turn power off for the configured outlet. Returns: - str: Confirmation message -#### cycle(quiescent_period: int = 2) +#### cycle(wait: int = 2) Power cycle the device with a configurable wait period between off and on states. Parameters: -- quiescent_period: Time to wait in seconds between power off and power on +- wait: Time to wait in seconds between power off and power on Returns: - str: Confirmation message @@ -66,7 +66,7 @@ Returns: Power cycling a device: ```python -snmp_client.cycle(quiescent_period=3) +snmp_client.cycle(wait=3) ``` Basic power control: diff --git a/packages/jumpstarter-driver-power/jumpstarter_driver_power/client.py b/packages/jumpstarter-driver-power/jumpstarter_driver_power/client.py index 23797fab9..96f64ffdc 100644 --- a/packages/jumpstarter-driver-power/jumpstarter_driver_power/client.py +++ b/packages/jumpstarter-driver-power/jumpstarter_driver_power/client.py @@ -8,21 +8,20 @@ class PowerClient(DriverClient): - def on(self) -> str: - return self.call("on") + def on(self): + self.call("on") - def off(self) -> str: - return self.call("off") + def off(self): + self.call("off") - def cycle(self, quiescent_period: int = 2) -> str: + def cycle(self, wait: int = 2): """Power cycle the device""" self.logger.info("Starting power cycle sequence") self.off() - self.logger.info(f"Waiting {quiescent_period} seconds...") - time.sleep(quiescent_period) + self.logger.info(f"Waiting {wait} seconds...") + time.sleep(wait) self.on() self.logger.info("Power cycle sequence complete") - return "Power cycled" def read(self) -> Generator[PowerReading, None, None]: for v in self.streamingcall("read"): @@ -37,17 +36,19 @@ def base(): @base.command() def on(): """Power on""" - click.echo(self.on()) + self.on() + click.echo("Powered on") @base.command() def off(): """Power off""" - click.echo(self.off()) + self.off() + click.echo("Powered off") @base.command() @click.option('--wait', '-w', default=2, help='Wait time in seconds between off and on') def cycle(wait): """Power cycle""" - click.echo(self.cycle(wait)) - + click.echo(f"Power cycling with {wait} seconds wait time...") + self.cycle(wait) return base diff --git a/packages/jumpstarter-driver-power/jumpstarter_driver_power/client_test.py b/packages/jumpstarter-driver-power/jumpstarter_driver_power/client_test.py index 0fd9ae8e6..622cf76ad 100644 --- a/packages/jumpstarter-driver-power/jumpstarter_driver_power/client_test.py +++ b/packages/jumpstarter-driver-power/jumpstarter_driver_power/client_test.py @@ -5,9 +5,6 @@ def test_client_mock_power(): with serve(MockPower()) as client: - assert client.on() == "ok" - assert client.off() == "ok" - assert list(client.read()) == [ PowerReading(voltage=0.0, current=0.0), PowerReading(voltage=5.0, current=2.0), @@ -16,9 +13,6 @@ def test_client_mock_power(): def test_client_sync_mock_power(): with serve(SyncMockPower()) as client: - assert client.on() == "ok" - assert client.off() == "ok" - assert list(client.read()) == [ PowerReading(voltage=0.0, current=0.0), PowerReading(voltage=5.0, current=2.0), diff --git a/packages/jumpstarter-driver-snmp/jumpstarter_driver_snmp/client.py b/packages/jumpstarter-driver-snmp/jumpstarter_driver_snmp/client.py index 97740388f..331859dd8 100644 --- a/packages/jumpstarter-driver-snmp/jumpstarter_driver_snmp/client.py +++ b/packages/jumpstarter-driver-snmp/jumpstarter_driver_snmp/client.py @@ -8,13 +8,13 @@ class SNMPServerClient(PowerClient): """Client interface for SNMP Power Control""" - def on(self) -> str: + def on(self): """Turn power on""" - return self.call("on") + self.call("on") - def off(self) -> str: + def off(self): """Turn power off""" - return self.call("off") + self.call("off") def cli(self): @click.group()