Add tests to prove broken behavior. (#17)

* Add tests to prove broken behavior.

Fix OutputFetcher to properly fetch only the unit name.

Introduce new abstract method 'getUnitSuffix'

Revert AbstractUnit tests back to use UnitStub.

Fix command execution.

Fix Integration test for unit.

Change fetching of specific units from simply instacing them to properly fetching them from the systemctl output.

Fix command execution to apply to correct unit.

Add PHPDoc.

* Fix identation.

* Remove travis test-report tasks for pull requeusts.

Author: func0der

.travis.yml

@@ -18,4 +18,4 @@ before_script:
 script:
   - composer cs
   - composer test -- --coverage-clover=build/logs/clover.xml --coverage-text
-  - ./vendor/bin/test-reporter
+  - 'if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./vendor/bin/test-reporter; fi'

src/Command/CommandDispatcherInterface.php

@@ -4,6 +4,11 @@
 
 use SystemCtl\Exception\CommandFailedException;
 
+/**
+ * Interface CommandDispatcherInterface
+ *
+ * @package SystemCtl\Command
+ */
 interface CommandDispatcherInterface
 {
     /**

src/Exception/CommandFailedException.php

@@ -2,6 +2,11 @@
 
 namespace SystemCtl\Exception;
 
+/**
+ * Class CommandFailedException
+ *
+ * @package SystemCtl\Exception
+ */
 class CommandFailedException extends \Exception
 {
 }

src/Exception/ExceptionInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace SystemCtl\Exception;
+
+use Throwable;
+
+/**
+ * Interface ExceptionInterface
+ *
+ * @package SystemCtl\Exception
+ */
+interface ExceptionInterface extends Throwable
+{
+}

src/Exception/UnitNotFoundException.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace SystemCtl\Exception;
+
+use RuntimeException;
+
+/**
+ * Class UnitNotFoundException
+ *
+ * @package SystemCtl\Exception
+ */
+class UnitNotFoundException extends RuntimeException implements ExceptionInterface
+{
+    /**
+     * @param string $type
+     * @param string $name
+     *
+     * @return UnitNotFoundException
+     */
+    public static function create(string $type, string $name): self
+    {
+        return new self(
+            sprintf('Could not find %s "%s"', ucfirst($type), $name)
+        );
+    }
+}

src/Exception/UnitTypeNotSupportedException.php

@@ -3,6 +3,11 @@
 
 namespace SystemCtl\Exception;
 
+/**
+ * Class UnitTypeNotSupportedException
+ *
+ * @package SystemCtl\Exception
+ */
 class UnitTypeNotSupportedException extends \Exception
 {
 

src/SystemCtl.php

@@ -4,11 +4,17 @@
 
 use SystemCtl\Command\CommandDispatcherInterface;
 use SystemCtl\Command\SymfonyCommandDispatcher;
+use SystemCtl\Exception\UnitNotFoundException;
 use SystemCtl\Exception\UnitTypeNotSupportedException;
 use SystemCtl\Unit\Service;
 use SystemCtl\Unit\Timer;
 use SystemCtl\Unit\UnitInterface;
 
+/**
+ * Class SystemCtl
+ *
+ * @package SystemCtl
+ */
 class SystemCtl
 {
     /** @var string systemctl binary path */
@@ -94,7 +100,7 @@ public function listUnits(?string $unitPrefix = null, array $unitTypes = self::S
         $commands = ['list-units'];
 
         if ($unitPrefix) {
-            $commands[] = [$unitPrefix . '*'];
+            $commands[] = $unitPrefix . '*';
         }
 
         $output = $this->getCommandDispatcher()->dispatch(...$commands)->getOutput();
@@ -113,7 +119,32 @@ public function listUnits(?string $unitPrefix = null, array $unitTypes = self::S
      */
     public function getService(string $name): Service
     {
-        return new Service($name, $this->getCommandDispatcher());
+        $units = $this->listUnits($name, [Service::UNIT]);
+
+        $unitName = $this->searchForUnitInUnits($name, $units);
+
+        if (is_null($unitName)) {
+            throw UnitNotFoundException::create(Service::UNIT, $name);
+        }
+
+        return new Service($unitName, $this->getCommandDispatcher());
+    }
+
+    /**
+     * @param string $unitName
+     * @param array[] $units
+     *
+     * @return null|string
+     */
+    protected function searchForUnitInUnits(string $unitName, array $units): ?string
+    {
+        foreach ($units as $unit) {
+            if ($unit === $unitName) {
+                return $unit;
+            }
+        }
+
+        return null;
     }
 
     /**
@@ -137,7 +168,15 @@ public function getServices(?string $unitPrefix = null): array
      */
     public function getTimer(string $name): Timer
     {
-        return new Timer($name, $this->getCommandDispatcher());
+        $units = $this->listUnits($name, [Timer::UNIT]);
+
+        $unitName = $this->searchForUnitInUnits($name, $units);
+
+        if (is_null($unitName)) {
+            throw UnitNotFoundException::create(Timer::UNIT, $name);
+        }
+
+        return new Timer($unitName, $this->getCommandDispatcher());
     }
 
     /**

src/Unit/AbstractUnit.php

@@ -2,9 +2,14 @@
 
 namespace SystemCtl\Unit;
 
-use Symfony\Component\Process\Process;
 use SystemCtl\Command\CommandDispatcherInterface;
+use SystemCtl\Command\CommandInterface;
 
+/**
+ * Class AbstractUnit
+ *
+ * @package SystemCtl\Unit
+ */
 abstract class AbstractUnit implements UnitInterface
 {
     /** @var string */
@@ -13,6 +18,11 @@ abstract class AbstractUnit implements UnitInterface
     /** @var CommandDispatcherInterface */
     protected $commandDispatcher;
 
+    /**
+     * @var string
+     */
+    protected $unitSuffix;
+
     /**
      * Create new service with given name
      *
@@ -57,60 +67,83 @@ public function getInstanceName(): ?string
         return $instanceName;
     }
 
+    /**
+     * @return string
+     */
+    abstract protected function getUnitSuffix(): string;
+
+    /**
+     * @param array $commands
+     *
+     * @return CommandInterface
+     */
+    public function execute(...$commands): CommandInterface
+    {
+        $commands[] = implode(
+            '.',
+            [
+                $this->name,
+                $this->getUnitSuffix(),
+            ]
+        );
+
+        return $this->commandDispatcher->dispatch(...$commands);
+    }
+
     /**
      * @return bool
      */
     public function start(): bool
     {
-        return $this->commandDispatcher->dispatch(__FUNCTION__)->isSuccessful();
+        return $this->execute(__FUNCTION__)->isSuccessful();
     }
 
     /**
      * @return bool
      */
     public function stop(): bool
     {
-        return $this->commandDispatcher->dispatch(__FUNCTION__)->isSuccessful();
+        return $this->execute(__FUNCTION__)->isSuccessful();
     }
 
     /**
      * @return bool
      */
     public function disable(): bool
     {
-        return $this->commandDispatcher->dispatch(__FUNCTION__)->isSuccessful();
+        return $this->execute(__FUNCTION__)->isSuccessful();
     }
 
     /**
      * @return bool
      */
     public function reload(): bool
     {
-        return $this->commandDispatcher->dispatch(__FUNCTION__)->isSuccessful();
+        return $this->execute(__FUNCTION__)->isSuccessful();
     }
 
     /**
      * @return bool
      */
     public function restart(): bool
     {
-        return $this->commandDispatcher->dispatch(__FUNCTION__)->isSuccessful();
+        return $this->execute(__FUNCTION__)->isSuccessful();
     }
 
     /**
      * @return bool
      */
     public function enable(): bool
     {
-        return $this->commandDispatcher->dispatch(__FUNCTION__)->isSuccessful();
+        return $this->execute(__FUNCTION__)->isSuccessful();
     }
 
     /**
      * @return bool
      */
     public function isEnabled(): bool
     {
-        $output = $this->commandDispatcher->dispatch('is-enabled')->getOutput();
+        $output = $this->execute('is-enabled')->getOutput();
 
         return trim($output) === 'enabled';
     }
@@ -120,7 +153,7 @@ public function isEnabled(): bool
      */
     public function isActive(): bool
     {
-        $output = $this->commandDispatcher->dispatch('is-active')->getOutput();
+        $output = $this->execute('is-active')->getOutput();
 
         return trim($output) === 'active';
     }

src/Unit/Service.php

@@ -2,10 +2,23 @@
 
 namespace SystemCtl\Unit;
 
+/**
+ * Class Service
+ *
+ * @package SystemCtl\Unit
+ */
 class Service extends AbstractUnit
 {
     /**
      * @var string
      */
     public const UNIT = 'service';
+
+    /**
+     * @inheritdoc
+     */
+    protected function getUnitSuffix(): string
+    {
+        return static::UNIT;
+    }
 }

src/Unit/Timer.php

@@ -2,10 +2,23 @@
 
 namespace SystemCtl\Unit;
 
+/**
+ * Class Timer
+ *
+ * @package SystemCtl\Unit
+ */
 class Timer extends AbstractUnit
 {
     /**
      * @var string
      */
     public const UNIT = 'timer';
+
+    /**
+     * @inheritdoc
+     */
+    protected function getUnitSuffix(): string
+    {
+        return static::UNIT;
+    }
 }