Add Unit socket (#27)

Author: peter279k

src/SystemCtl.php

@@ -8,6 +8,7 @@
 use SystemCtl\Exception\UnitTypeNotSupportedException;
 use SystemCtl\Unit\Service;
 use SystemCtl\Unit\Timer;
+use SystemCtl\Unit\Socket;
 use SystemCtl\Unit\UnitInterface;
 
 /**
@@ -193,6 +194,38 @@ public function getTimers(?string $unitPrefix = null): array
         }, $units);
     }
 
+    /**
+     * @param string $name
+     *
+     * @return Socket
+     */
+    public function getSocket(string $name): Socket
+    {
+        $units = $this->listUnits($name, [Socket::UNIT]);
+
+        $unitName = $this->searchForUnitInUnits($name, $units);
+
+        if (is_null($unitName)) {
+            throw UnitNotFoundException::create(Socket::UNIT, $name);
+        }
+
+        return new Socket($unitName, $this->getCommandDispatcher());
+    }
+
+    /**
+     * @param null|string $unitPrefix
+     *
+     * @return Socket[]
+     */
+    public function getSockets(?string $unitPrefix = null): array
+    {
+        $units = $this->listUnits($unitPrefix, [Socket::UNIT]);
+
+        return array_map(function ($unitName) {
+            return new Socket($unitName, $this->getCommandDispatcher());
+        }, $units);
+    }
+
     /**
      * Restart the daemon to reload specs and new units
      *

src/Unit/Socket.php

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

tests/Integration/Unit/UnitTest.php

@@ -10,6 +10,7 @@
 use SystemCtl\Exception\CommandFailedException;
 use SystemCtl\Unit\Service;
 use SystemCtl\Unit\Timer;
+use SystemCtl\Unit\Socket;
 
 /**
  * Class UnitTest
@@ -84,4 +85,33 @@ public function testTimerCommandsIfProcessIsUnsuccessFulShouldRaiseException()
         $this->expectException(CommandFailedException::class);
         $timer->start();
     }
+
+    public function testSocketCommandsIfProcessIsSuccessfulShouldReturnTrue()
+    {
+        $command = $this->prophesize(CommandInterface::class);
+        $command->isSuccessful()->willReturn(true);
+
+        $commandDispatcher = $this->createCommandDispatcherStub();
+        $commandDispatcher->dispatch(Argument::cetera())->willReturn($command);
+
+        $socket = new Socket('AwesomeSocket', $commandDispatcher->reveal());
+
+        $this->assertTrue($socket->start());
+        $this->assertTrue($socket->stop());
+        $this->assertTrue($socket->enable());
+        $this->assertTrue($socket->disable());
+        $this->assertTrue($socket->reload());
+        $this->assertTrue($socket->restart());
+    }
+
+    public function testSocketCommandsIfProcessIsUnsuccessFulShouldRaiseException()
+    {
+        $commandDispatcher = $this->createCommandDispatcherStub();
+        $commandDispatcher->dispatch(Argument::cetera())->willThrow(CommandFailedException::class);
+
+        $socket = new Socket('AwesomeSocket', $commandDispatcher->reveal());
+
+        $this->expectException(CommandFailedException::class);
+        $socket->start();
+    }
 }

tests/Unit/SystemCtlTest.php

@@ -11,6 +11,7 @@
 use SystemCtl\SystemCtl;
 use SystemCtl\Unit\Service;
 use SystemCtl\Unit\Timer;
+use SystemCtl\Unit\Socket;
 
 /**
  * Class SystemCtlTest
@@ -135,6 +136,25 @@ public function itShouldCallCommandDispatcherWithListUnitsAndUnitPrefixOnTimerGe
         $this->assertEquals($unitName, $timer->getName());
     }
 
+    /**
+     * @test
+     */
+    public function itShouldCallCommandDispatcherWithListUnitsAndUnitPrefixOnSocketGetting()
+    {
+        $unitName = 'testSocket';
+        $output = ' testSocket.socket     Active running';
+        $commandDispatcherStub = $this->buildCommandDispatcherStub();
+        $commandDispatcherStub
+            ->dispatch(...['list-units', $unitName . '*'])
+            ->willReturn($this->buildCommandStub($output));
+
+        $systemctl = (new SystemCtl())->setCommandDispatcher($commandDispatcherStub->reveal());
+
+        $socket = $systemctl->getSocket($unitName);
+        $this->assertInstanceOf(Socket::class, $socket);
+        $this->assertEquals($unitName, $socket->getName());
+    }
+
     /**
      * @test
      */
@@ -152,6 +172,23 @@ public function itShouldThrowAnExeceptionIfNotTimerCouldBeFound()
         $systemctl->getTimer($unitName);
     }
 
+    /**
+     * @test
+     */
+    public function itShouldThrowAnExceptionIfNoSocketCouldBeFound()
+    {
+        $unitName = 'testSocket';
+        $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
      */

tests/Unit/Unit/AbstractUnitTest.php

@@ -49,6 +49,9 @@ public function itShouldReturnCorrectNameDataProvider(): array
             [
                 'name' => 'test1.timer',
             ],
+            [
+                'name' => 'test1.socket',
+            ],
             [
                 'name' => 'test1.mount',
             ],
@@ -103,6 +106,10 @@ public function itDetectsMultiInstanceUnitsCorrectlyDataProvider()
                 'name' => 'test1.timer',
                 'isMultiInstance' => false,
             ],
+            [
+                'name' => 'test1.socket',
+                'isMultiInstance' => false,
+            ],
         ];
     }
 
@@ -151,6 +158,10 @@ public function itDetectsMultiInstanceInstanceNamesCorrectlyDataProvider()
                 'name' => 'test1.timer',
                 'instanceName' => null,
             ],
+            [
+                'name' => 'test1.socket',
+                'instanceName' => null,
+            ],
         ];
     }
 

tests/Unit/Utils/OutputFetcherTest.php

@@ -38,12 +38,14 @@ public function itDeterminesTheCorrectAmountOfUnitsDataProvider(): array
   superservice.service         active running
   awesomeservice.service       active running
   nonservice.timer             active running
+  nonservice.socket            active running
   superservice.mount           active running
   awesomeservice.mount         active running
   nonservice.timer             active running
+  nonservice.socket            active running
   superservice.service         active running
   awesomeservice.service       active running
-● [email protected]   loaded failed failed  
+● [email protected]   loaded failed failed
 OUTPUT;
 
         return [
@@ -57,6 +59,11 @@ public function itDeterminesTheCorrectAmountOfUnitsDataProvider(): array
                 'suffix' => 'timer',
                 'amount' => 2,
             ],
+            [
+                'output' => $output,
+                'suffix' => 'socket',
+                'amount' => 2,
+            ],
             [
                 'output' => $output,
                 'suffix' => 'mount',
@@ -93,12 +100,14 @@ public function itOnlyExtractsTheUnitNamesDataProvider(): array
   foo.service      Active running
   foo-bar.service    Active running
   a-timer.timer          Active running
+  a-socket.socket          Active running
   super.mount        Active running
   awesome.mount      Active running
   nonservice.timer          Active running
+  nonservice.socket          Active running
   [email protected]      Active running
   [email protected]    Active running
-● [email protected] loaded failed failed  
+● [email protected] loaded failed failed
 OUTPUT;
 
         return [
@@ -121,6 +130,14 @@ public function itOnlyExtractsTheUnitNamesDataProvider(): array
                     'nonservice',
                 ],
             ],
+            [
+                'output' => $output,
+                'suffix' => 'socket',
+                'units'  => [
+                    'a-socket',
+                    'nonservice',
+                ],
+            ],
             [
                 'output' => $output,
                 'suffix' => 'mount',