Merge branch 'master' into 1.0

Author: icanhazstring

README.md

@@ -18,6 +18,8 @@ PHP wrapper for systemctl (PHP7.1)
 - disable
 - reload
 - restart
+- isEnabled
+- isActive
 
 > If you like to add support for more commands, feel free to contribute.
 

composer.json

@@ -14,12 +14,16 @@
     },
     "autoload": {
         "psr-4": {
-            "SystemCtl\\": "src/"
+            "SystemCtl\\": [
+                "src/"
+            ]
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "SystemCtl\\Test\\": "tests/"
+            "SystemCtl\\Tests\\": [
+                "tests/"
+            ]
         }
     },
     "license": "MIT",

phpunit.xml

@@ -12,8 +12,11 @@
          bootstrap="./vendor/autoload.php"
 >
     <testsuites>
-        <testsuite name="unittests">
-            <directory>./tests/</directory>
+        <testsuite name="unit-tests">
+            <directory>./tests/Unit</directory>
+        </testsuite>
+        <testsuite name="integration-tests">
+            <directory>./tests/Integration</directory>
         </testsuite>
     </testsuites>
 
@@ -26,4 +29,4 @@
         </whitelist>
     </filter>
 
-</phpunit>
+</phpunit>

src/Unit/AbstractUnit.php

@@ -2,19 +2,23 @@
 
 namespace SystemCtl\Unit;
 
+use Symfony\Component\Process\Process;
 use Symfony\Component\Process\ProcessBuilder;
 use SystemCtl\Exception\CommandFailedException;
 
 abstract class AbstractUnit implements UnitInterface
 {
     /** @var string */
-    protected $type;
+    private $name;
 
     /** @var string */
-    private $name;
+    private $type;
 
     /** @var ProcessBuilder */
-    protected $processBuilder;
+    private $processBuilder;
+
+    /** @var bool */
+    private $yell = false;
 
     /**
      * Create new service with given name
@@ -38,6 +42,16 @@ public function getName(): string
         return $this->name;
     }
 
+    /**
+     * Set a flag whether to yell with an exception if an command failes or not
+     *
+     * @param $state
+     */
+    public function yell($state)
+    {
+        $this->yell = $state;
+    }
+
     /**
      * @inheritDoc
      */
@@ -48,33 +62,35 @@ public function isMultiInstance(): bool
 
     /**
      * @inheritDoc
+     * @todo: Everything in here should happen inside the constructor and stored
+     *      afterwards.
      */
     public function getInstanceName(): ?string
     {
-        $parts = explode('@', $this->name);
-        return $parts[1] ?? null;
+        $instanceName = explode('@', $this->name, 2)[1] ?? null;
+
+        if (is_string($instanceName) && strpos($instanceName, '.') !== false) {
+            $instanceName = explode('.', $instanceName, 2)[0];
+        }
+
+        return $instanceName;
     }
 
     /**
      * Execute a single command
      *
      * @param string $command
-     * @param bool $raise
      *
      * @throws CommandFailedException Raised if process was not successful and user wants to raise exception
      *                                instead of returning the actual process exit code
      *
      * @return bool
      */
-    protected function execute(string $command, bool $raise = true): bool
+    protected function execute(string $command): bool
     {
-        $process = $this->processBuilder
-            ->setArguments([$command, $this->getName()])
-            ->getProcess();
+        $process = $this->runCommandAgainstService($command);
 
-        $process->run();
-
-        if (!$process->isSuccessful() && $raise) {
+        if (!$process->isSuccessful() && $this->yell) {
             $exceptionCall = CommandFailedException::class . '::from' . ucfirst($this->type);
             throw call_user_func_array($exceptionCall, [$this->getName(), $command]);
         }
@@ -83,88 +99,94 @@ protected function execute(string $command, bool $raise = true): bool
     }
 
     /**
-     * @inheritdoc
+     * @param string $command
+     *
+     * @return Process
      */
-    public function start(bool $raise = false): bool
+    protected function runCommandAgainstService(string $command): Process
     {
-        return $this->execute(__FUNCTION__, $raise);
+        $process = $this->processBuilder
+            ->setArguments([$command, $this->getName()])
+            ->getProcess();
+
+        $process->run();
+
+        return $process;
     }
 
     /**
-     * @inheritdoc
+     * @return bool
      */
-    public function stop(bool $raise = false): bool
+    public function start(): bool
     {
-        return $this->execute(__FUNCTION__, $raise);
+        return $this->execute(__FUNCTION__);
     }
 
     /**
-     * @inheritdoc
+     * @return bool
      */
-    public function disable(bool $raise = false): bool
+    public function stop(): bool
     {
-        return $this->execute(__FUNCTION__, $raise);
+        return $this->execute(__FUNCTION__);
     }
 
     /**
-     * @inheritdoc
+     * @return bool
      */
-    public function reload(bool $raise = false): bool
+    public function disable(): bool
     {
-        return $this->execute(__FUNCTION__, $raise);
+        return $this->execute(__FUNCTION__);
     }
 
     /**
-     * @inheritdoc
+     * @return bool
      */
-    public function restart(bool $raise = false): bool
+    public function reload(): bool
     {
-        return $this->execute(__FUNCTION__, $raise);
+        return $this->execute(__FUNCTION__);
     }
 
     /**
-     * @inheritdoc
+     * @return bool
      */
-    public function enable(bool $raise = false): bool
+    public function restart(): bool
     {
-        return $this->execute(__FUNCTION__, $raise);
+        return $this->execute(__FUNCTION__);
     }
 
     /**
-     * @inheritdoc
+     * @return bool
      */
-    public function isActive(bool $raise = false): bool
+    public function enable(): bool
     {
-        $process = $this->processBuilder
-            ->setArguments(['is-active', $this->getName()])
-            ->getProcess();
-
-        $process->run();
+        return $this->execute(__FUNCTION__);
+    }
 
-        if (!$process->isSuccessful() && $raise) {
-            $exceptionCall = CommandFailedException::class . '::from' . ucfirst($this->type);
-            throw call_user_func_array($exceptionCall, [$this->getName(), 'is-active']);
-        }
+    /**
+     * @return bool
+     */
+    public function isEnabled(): bool
+    {
+        $process = $this->runCommandAgainstService('is-enabled');
 
-        return trim($process->getOutput()) === 'active';
+        return $process->isSuccessful() && trim($process->getOutput()) === 'enabled';
     }
 
     /**
-     * @inheritDoc
+     * @return bool
      */
-    public function isEnabled(bool $raise = false): bool
+    public function isActive(): bool
     {
-        $process = $this->processBuilder
-            ->setArguments(['is-enabled', $this->getName()])
-            ->getProcess();
-
-        $process->run();
+        $process = $this->runCommandAgainstService('is-active');
 
-        if (!$process->isSuccessful() && $raise) {
-            $exceptionCall = CommandFailedException::class . '::from' . ucfirst($this->type);
-            throw call_user_func_array($exceptionCall, [$this->getName(), 'is-enabled']);
-        }
+        return $process->isSuccessful() && trim($process->getOutput()) === 'active';
+    }
 
-        return trim($process->getOutput()) === 'enabled';
+    /**
+     * @return bool
+     */
+    public function isRunning(): bool
+    {
+        return $this->isActive();
     }
 }

src/Unit/Service.php

@@ -6,6 +6,9 @@
 
 class Service extends AbstractUnit
 {
+    /**
+     * @var string
+     */
     public const UNIT = 'service';
 
     /**

src/Unit/Timer.php

@@ -6,6 +6,9 @@
 
 class Timer extends AbstractUnit
 {
+    /**
+     * @var string
+     */
     public const UNIT = 'timer';
 
     /**

src/Unit/UnitInterface.php

@@ -33,72 +33,56 @@ public function getInstanceName(): ?string;
     /**
      * Start command
      *
-     * @param bool $raise Raise exception on failure instead of process result
-     *
      * @return bool
      */
-    public function start(bool $raise = false): bool;
+    public function start(): bool;
 
     /**
      * Stop command
      *
-     * @param bool $raise Raise exception on failure instead of process result
-     *
      * @return bool
      */
-    public function stop(bool $raise = false): bool;
+    public function stop(): bool;
 
     /**
      * Disable command
      *
-     * @param bool $raise Raise exception on failure instead of process result
-     *
      * @return bool
      */
-    public function disable(bool $raise = false): bool;
+    public function disable(): bool;
 
     /**
      * Reload command
      *
-     * @param bool $raise Raise exception on failure instead of process result
-     *
      * @return bool
      */
-    public function reload(bool $raise = false): bool;
+    public function reload(): bool;
 
     /**
      * Restart command
      *
-     * @param bool $raise Raise exception on failure instead of process result
-     *
      * @return bool
      */
-    public function restart(bool $raise = false): bool;
+    public function restart(): bool;
 
     /**
      * Enable command
      *
-     * @param bool $raise Raise exception on failure instead of process result
-     *
      * @return bool
      */
-    public function enable(bool $raise = false): bool;
+    public function enable(): bool;
 
     /**
      * Check whether unit is active
      *
-     * @param bool $raise Raise exception on failure instead of process result
-     *
      * @return bool
      */
-    public function isActive(bool $raise = false): bool;
+    public function isActive(): bool;
 
     /**
      * Check whether unit is enabled
      *
-     * @param bool $raise Raise exception on failure instead of process result
-     *
      * @return bool
      */
-    public function isEnabled(bool $raise = false): bool;
+    public function isEnabled(): bool;
 }