Move units and introduce multi instance

The units where moved to a more specific namespace.
Also a multi instance capability was introduced to get
the full unit name and the instance of it.

Author: Andreas Frömer

src/SystemCtl.php

@@ -4,42 +4,57 @@
 
 use Symfony\Component\Process\ProcessBuilder;
 use SystemCtl\Exception\UnitTypeNotSupportedException;
+use SystemCtl\Unit\Service;
+use SystemCtl\Unit\Timer;
+use SystemCtl\Unit\UnitInterface;
 
 class SystemCtl
 {
     /** @var string systemctl binary path */
     private static $binary = '/bin/systemctl';
 
-    /** @var bool */
-    private static $sudo = false;
+    /** @var int timeout for commands */
+    private static $timeout = 3;
 
     public const AVAILABLE_UNITS = [
-        'service',
+        Service::UNIT,
         'socket',
         'device',
         'mount',
         'automount',
         'swap',
         'target',
         'path',
-        'timer',
+        Timer::UNIT,
         'slice',
         'scope'
     ];
 
     public const SUPPORTED_UNITS = [
-        'service',
-        'timer'
+        Service::UNIT,
+        Timer::UNIT,
     ];
 
     /**
+     * Change systemctl binary
+     *
      * @param string $binary
      */
     public static function setBinary(string $binary): void
     {
         self::$binary = $binary;
     }
 
+    /**
+     * Change command execution timeout
+     *
+     * @param int $timeout
+     */
+    public static function setTimeout(int $timeout): void
+    {
+        self::$timeout = $timeout;
+    }
+
     /**
      * @param string $unitSuffix
      * @param string $unitName
@@ -49,13 +64,13 @@ public static function setBinary(string $binary): void
      */
     public static function unitFromSuffix(string $unitSuffix, string $unitName): UnitInterface
     {
-        $unitClass = 'SystemCtl\\' . ucfirst($unitSuffix);
+        $unitClass = 'SystemCtl\\Unit\\' . ucfirst($unitSuffix);
 
         if (!class_exists($unitClass)) {
             throw new UnitTypeNotSupportedException('Unit type ' . $unitSuffix . ' not supported');
         }
 
-        return new $unitClass($unitName, new ProcessBuilder(['sudo', self::$binary]));
+        return new $unitClass($unitName, new ProcessBuilder([self::$binary]));
     }
 
     /**
@@ -100,7 +115,7 @@ public function getService(string $name): Service
      */
     public function getServices(?string $unitPrefix = null): array
     {
-        $units = $this->listUnits($unitPrefix, ['service']);
+        $units = $this->listUnits($unitPrefix, [Service::UNIT]);
 
         return array_map(function ($unitName) {
             return new Service($unitName, $this->getProcessBuilder());
@@ -122,7 +137,7 @@ public function getTimer(string $name): Timer
      */
     public function getTimers(?string $unitPrefix = null): array
     {
-        $units = $this->listUnits($unitPrefix, ['timer']);
+        $units = $this->listUnits($unitPrefix, [Timer::UNIT]);
 
         return array_map(function ($unitName) {
             return new Timer($unitName, $this->getProcessBuilder());
@@ -136,7 +151,7 @@ public function getProcessBuilder(): ProcessBuilder
     {
         $builder = ProcessBuilder::create();
         $builder->setPrefix(self::$binary);
-        $builder->setTimeout(3);
+        $builder->setTimeout(self::$timeout);
 
         return $builder;
     }

src/AbstractUnit.php src/Unit/AbstractUnit.phpsrc/AbstractUnit.php renamed to src/Unit/AbstractUnit.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace SystemCtl;
+namespace SystemCtl\Unit;
 
 use Symfony\Component\Process\ProcessBuilder;
 
@@ -24,11 +24,31 @@ public function __construct(string $name, ProcessBuilder $processBuilder)
         $this->processBuilder = $processBuilder;
     }
 
+    /**
+     * @inheritdoc
+     */
     public function getName(): string
     {
         return $this->name;
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function isMultiInstance(): bool
+    {
+        return strpos($this->name, '@') !== false;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getInstanceName(): ?string
+    {
+        $parts = explode('@', $this->name);
+        return $parts[1] ?? null;
+    }
+
     /**
      * Execute a single command
      *

src/Service.php src/Unit/Service.phpsrc/Service.php renamed to src/Unit/Service.php

@@ -1,12 +1,14 @@
 <?php
 
 
-namespace SystemCtl;
+namespace SystemCtl\Unit;
 
 use SystemCtl\Exception\CommandFailedException;
 
 class Service extends AbstractUnit
 {
+    public const UNIT = 'service';
+
     protected function execute(string $command): bool
     {
         $process = $this->processBuilder

src/Timer.php src/Unit/Timer.phpsrc/Timer.php renamed to src/Unit/Timer.php

@@ -1,12 +1,14 @@
 <?php
 
 
-namespace SystemCtl;
+namespace SystemCtl\Unit;
 
 use SystemCtl\Exception\CommandFailedException;
 
 class Timer extends AbstractUnit
 {
+    public const UNIT = 'timer';
+
     protected function execute(string $command): bool
     {
         $process = $this->processBuilder

src/Unit/UnitInterface.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace SystemCtl\Unit;
+
+/**
+ * UnitInterface for handling single units
+ *
+ * @package SystemCtl
+ */
+interface UnitInterface
+{
+    /**
+     * Get the units full name
+     *
+     * @return string
+     */
+    public function getName(): string;
+
+    /**
+     * Whether the unit has multiple instances or not
+     *
+     * @return bool
+     */
+    public function isMultiInstance(): bool;
+
+    /**
+     * Get instance name
+     *
+     * @return null|string
+     */
+    public function getInstanceName(): ?string;
+
+    /**
+     * Start command
+     *
+     * @return bool
+     */
+    public function start(): bool;
+
+    /**
+     * Stop command
+     *
+     * @return bool
+     */
+    public function stop(): bool;
+
+    /**
+     * Disable command
+     *
+     * @return bool
+     */
+    public function disable(): bool;
+
+    /**
+     * Reload command
+     *
+     * @return bool
+     */
+    public function reload(): bool;
+
+    /**
+     * Restart command
+     *
+     * @return bool
+     */
+    public function restart(): bool;
+
+    /**
+     * Enable command
+     *
+     * @return bool
+     */
+    public function enable(): bool;
+}

src/UnitInterface.php

@@ -6,10 +6,10 @@
 use Symfony\Component\Process\Process;
 use Symfony\Component\Process\ProcessBuilder;
 use SystemCtl\Exception\UnitTypeNotSupportedException;
-use SystemCtl\Service;
+use SystemCtl\Unit\Service;
 use SystemCtl\SystemCtl;
-use SystemCtl\Timer;
-use SystemCtl\UnitInterface;
+use SystemCtl\Unit\Timer;
+use SystemCtl\Unit\UnitInterface;
 
 class SystemCtlTest extends TestCase
 {

tests/SystemCtlTest.php

@@ -1,12 +1,13 @@
 <?php
 
-namespace SystemCtl\Test;
+namespace SystemCtl\Test\Unit;
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Process\Process;
 use Symfony\Component\Process\ProcessBuilder;
 use SystemCtl\Exception\CommandFailedException;
 use SystemCtl\SystemCtl;
+use SystemCtl\Unit\Service;
 
 class UnitTest extends TestCase
 {
@@ -127,8 +128,27 @@ public function testTimerCommandsIfProcessIsUnsuccessFulShouldRaiseException()
 
         $timer = $systemctl->getTimer('AwesomeTimer');
 
-        $process->method('isSuccessful')->willReturn(false);
         $this->expectException(CommandFailedException::class);
         $timer->start();
     }
+
+    public function testMultiInstanceUnit()
+    {
+        $process = $this->getMockBuilder(Process::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        /** @var \PHPUnit_Framework_MockObject_MockObject|ProcessBuilder $processBuilder */
+        $processBuilder = $this->getMockBuilder(ProcessBuilder::class)
+            ->disableOriginalConstructor()
+            ->setMethods(['getProcess'])
+            ->getMock();
+
+        $processBuilder->method('getProcess')->willReturn($process);
+
+        $unit = new Service('service@1', $processBuilder);
+        $this->assertEquals('service@1', $unit->getName());
+        $this->assertTrue($unit->isMultiInstance());
+        $this->assertEquals('1', $unit->getInstanceName());
+    }
 }