Add Unit device (#33)

* Add Unit device

* Fix coding standard errors

Co-authored-by: Olivier Lechevalier <[email protected]>

Author: RageZBla

src/SystemCtl.php

@@ -6,6 +6,7 @@
 use icanhazstring\SystemCtl\Command\SymfonyCommandDispatcher;
 use icanhazstring\SystemCtl\Exception\UnitNotFoundException;
 use icanhazstring\SystemCtl\Exception\UnitTypeNotSupportedException;
+use icanhazstring\SystemCtl\Unit\Device;
 use icanhazstring\SystemCtl\Unit\Service;
 use icanhazstring\SystemCtl\Unit\Timer;
 use icanhazstring\SystemCtl\Unit\Socket;
@@ -311,4 +312,36 @@ public function setCommandDispatcher(CommandDispatcherInterface $dispatcher)
 
         return $this;
     }
+
+    /**
+     * @param string $name
+     *
+     * @return Device
+     */
+    public function getDevice(string $name): Device
+    {
+        $units = $this->listUnits($name, [Device::UNIT]);
+
+        $unitName = $this->searchForUnitInUnits($name, $units);
+
+        if (is_null($unitName)) {
+            throw UnitNotFoundException::create(Device::UNIT, $name);
+        }
+
+        return new Device($unitName, $this->getCommandDispatcher());
+    }
+
+    /**
+     * @param string|null $unitPrefix
+     *
+     * @return Device[]
+     */
+    public function getDevices(?string $unitPrefix = null): array
+    {
+         $units = $this->listUnits($unitPrefix, [Device::UNIT]);
+
+         return array_map(function ($unitName) {
+             return new Device($unitName, $this->getCommandDispatcher());
+         }, $units);
+    }
 }

src/Unit/Device.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace icanhazstring\SystemCtl\Unit;
+
+/**
+ * Class Device
+ *
+ * @package icanhazstring\SystemCtl\Unit
+ */
+class Device extends AbstractUnit
+{
+    /**
+     * @var string
+     */
+    public const UNIT = 'device';
+
+    /**
+     * @inheritdoc
+     */
+    protected function getUnitSuffix(): string
+    {
+        return static::UNIT;
+    }
+}

test/Integration/Unit/UnitTest.php

@@ -2,6 +2,7 @@
 
 namespace icanhazstring\SystemCtl\Test\Integration\Unit;
 
+use icanhazstring\SystemCtl\Unit\Device;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\Prophecy\ObjectProphecy;
@@ -144,4 +145,33 @@ public function testScopeCommandsIfProcessIsUnsuccessFulShouldRaiseException():
         $this->expectException(CommandFailedException::class);
         $scope->start();
     }
+
+    public function testDeviceCommandsIfProcessIsSuccessfulShouldReturnTrue()
+    {
+        $command = $this->prophesize(CommandInterface::class);
+        $command->isSuccessful()->willReturn(true);
+
+        $commandDispatcher = $this->createCommandDispatcherStub();
+        $commandDispatcher->dispatch(Argument::cetera())->willReturn($command);
+
+        $device = new Device('AwesomeDevice', $commandDispatcher->reveal());
+
+        $this->assertTrue($device->start());
+        $this->assertTrue($device->stop());
+        $this->assertTrue($device->enable());
+        $this->assertTrue($device->disable());
+        $this->assertTrue($device->reload());
+        $this->assertTrue($device->restart());
+    }
+
+    public function testDeviceCommandsIfProcessIsUnsuccessFulShouldRaiseException()
+    {
+        $commandDispatcher = $this->createCommandDispatcherStub();
+        $commandDispatcher->dispatch(Argument::cetera())->willThrow(CommandFailedException::class);
+
+        $device = new Device('AwesomeDevice', $commandDispatcher->reveal());
+
+        $this->expectException(CommandFailedException::class);
+        $device->start();
+    }
 }

test/Unit/SystemCtlTest.php

@@ -2,6 +2,7 @@
 
 namespace icanhazstring\SystemCtl\Test\Unit;
 
+use icanhazstring\SystemCtl\Unit\Device;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\Prophecy\ObjectProphecy;
@@ -261,4 +262,40 @@ public function itShouldReturnATimerWithTheCorrectNameOnTimerGetting(): void
         $service = $systemctl->getService($unitName);
         $this->assertEquals('testService', $service->getName());
     }
+
+    /**
+     * @test
+     */
+    public function itShouldCallCommandDispatcherWithListUnitsAndUnitPrefixOnDeviceGetting()
+    {
+        $unitName = 'testDevice';
+        $output = ' testDevice.device     Active running';
+        $commandDispatcherStub = $this->buildCommandDispatcherStub();
+        $commandDispatcherStub
+            ->dispatch(...['list-units', $unitName . '*'])
+            ->willReturn($this->buildCommandStub($output));
+
+        $systemctl = (new SystemCtl())->setCommandDispatcher($commandDispatcherStub->reveal());
+
+        $device = $systemctl->getDevice($unitName);
+        $this->assertInstanceOf(Device::class, $device);
+        $this->assertEquals($unitName, $device->getName());
+    }
+
+    /**
+     * @test
+     */
+    public function itShouldThrowAnExceptionIfNoDeviceCouldBeFound()
+    {
+        $unitName = 'testDevice';
+        $commandDispatcherStub = $this->buildCommandDispatcherStub();
+        $commandDispatcherStub
+            ->dispatch(...['list-units', $unitName . '*'])
+            ->willReturn($this->buildCommandStub(''));
+
+        $systemctl = (new SystemCtl())->setCommandDispatcher($commandDispatcherStub->reveal());
+
+        $this->expectException(UnitNotFoundException::class);
+        $systemctl->getSocket($unitName);
+    }
 }

test/Unit/Unit/AbstractUnitTest.php

@@ -58,6 +58,9 @@ public function itShouldReturnCorrectNameDataProvider(): array
             [
                 'name' => 'test1.mount',
             ],
+            [
+                'name' => 'test1.device',
+            ],
             [
                 'name' => '[email protected]',
             ],
@@ -113,6 +116,10 @@ public function itDetectsMultiInstanceUnitsCorrectlyDataProvider(): array
                 'name' => 'test1.socket',
                 'isMultiInstance' => false,
             ],
+            [
+                'name' => 'test1.device',
+                'isMultiInstance' => false,
+            ],
             [
                 'name' => 'test1.scope',
                 'isMultiInstance' => false,

test/Unit/Utils/OutputFetcherTest.php

@@ -39,11 +39,13 @@ public function itDeterminesTheCorrectAmountOfUnitsDataProvider(): array
   awesomeservice.service       active running
   nonservice.timer             active running
   nonservice.socket            active running
+  nonservice.device            active running
   nonservice.scope             active running
   superservice.mount           active running
   awesomeservice.mount         active running
   nonservice.timer             active running
   nonservice.socket            active running
+  nonservice.device            active running
   nonservice.scope             active running
   superservice.service         active running
   awesomeservice.service       active running
@@ -66,6 +68,11 @@ public function itDeterminesTheCorrectAmountOfUnitsDataProvider(): array
                 'suffix' => 'socket',
                 'amount' => 2,
             ],
+            [
+                'output' => $output,
+                'suffix' => 'device',
+                'amount' => 2,
+            ],
             [
                 'output' => $output,
                 'suffix' => 'scope',
@@ -108,11 +115,13 @@ public function itOnlyExtractsTheUnitNamesDataProvider(): array
   foo-bar.service    Active running
   a-timer.timer          Active running
   a-socket.socket          Active running
+  a-device.device          Active running
   a-scope.scope          Active running
   super.mount        Active running
   awesome.mount      Active running
   nonservice.timer          Active running
   nonservice.socket          Active running
+  nonservice.device          Active running
   nonservice.scope          Active running
   [email protected]      Active running
   [email protected]    Active running
@@ -139,6 +148,14 @@ public function itOnlyExtractsTheUnitNamesDataProvider(): array
                     'nonservice',
                 ],
             ],
+            [
+                'output' => $output,
+                'suffix' => 'device',
+                'units'  => [
+                    'a-device',
+                    'nonservice',
+                ],
+            ],
             [
                 'output' => $output,
                 'suffix' => 'socket',