Remove default wildcard in listUnits()

Author: icanhazstring

src/SystemCtl.php

@@ -101,7 +101,14 @@ public static function setAssetPath(string $assetPath): void
     }
 
     /**
-     * List all supported units
+     * List all supported units by using a given unit prefix.
+     *
+     * This prefix can be used with any wildcard combination.
+     * E.G.:
+     *  - *name*
+     *  - name*
+     *  - *name
+     *  - *n*e*
      *
      * @param null|string $unitPrefix
      * @param string[]    $unitTypes
@@ -113,7 +120,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();
@@ -132,32 +139,13 @@ public function listUnits(?string $unitPrefix = null, array $unitTypes = self::S
      */
     public function getService(string $name): Service
     {
-        $units = $this->listUnits($name, [Service::UNIT]);
-
-        $unitName = $this->searchForUnitInUnits($name, $units);
+        $unitNames = $this->listUnits($name, [Service::UNIT]);
 
-        if (is_null($unitName)) {
+        if (empty($unitNames)) {
             throw UnitNotFoundException::create(Service::UNIT, $name);
         }
 
-        return new Service($unitName, $this->getCommandDispatcher());
-    }
-
-    /**
-     * @param string   $unitName
-     * @param string[] $units
-     *
-     * @return null|string
-     */
-    protected function searchForUnitInUnits(string $unitName, array $units): ?string
-    {
-        foreach ($units as $unit) {
-            if ($unit === $unitName) {
-                return $unit;
-            }
-        }
-
-        return null;
+        return new Service($unitNames[0], $this->getCommandDispatcher());
     }
 
     /**
@@ -181,15 +169,13 @@ public function getServices(?string $unitPrefix = null): array
      */
     public function getTimer(string $name): Timer
     {
-        $units = $this->listUnits($name, [Timer::UNIT]);
-
-        $unitName = $this->searchForUnitInUnits($name, $units);
+        $unitNames = $this->listUnits($name, [Timer::UNIT]);
 
-        if (is_null($unitName)) {
+        if (empty($unitNames)) {
             throw UnitNotFoundException::create(Timer::UNIT, $name);
         }
 
-        return new Timer($unitName, $this->getCommandDispatcher());
+        return new Timer($unitNames[0], $this->getCommandDispatcher());
     }
 
     /**

tests/Integration/SystemCtlTest.php

@@ -212,7 +212,7 @@ public function itShouldReturnUnitAfterInstall()
 
         $commandDispatcherStub = $this->buildCommandDispatcherStub();
         $commandDispatcherStub
-            ->dispatch('list-units', $unitName . '*')
+            ->dispatch('list-units', $unitName)
             ->willReturn($this->buildCommandStub('testService.service Active Running'))
             ->shouldBeCalled();
 

tests/Unit/SystemCtlTest.php

@@ -93,7 +93,7 @@ public function itShouldCallCommandDispatcherWithListUnitsAndUnitPrefixOnService
         $output = ' testService.service     Active running';
         $commandDispatcherStub = $this->buildCommandDispatcherStub();
         $commandDispatcherStub
-            ->dispatch('list-units', $unitName . '*')
+            ->dispatch('list-units', $unitName)
             ->willReturn($this->buildCommandStub($output));
 
         $systemctl = (new SystemCtl())->setCommandDispatcher($commandDispatcherStub->reveal());
@@ -112,7 +112,7 @@ public function itShouldReturnAServiceOnServiceGetting()
         $output = ' testService.service     Active running';
         $commandDispatcherStub = $this->buildCommandDispatcherStub();
         $commandDispatcherStub
-            ->dispatch('list-units', $unitName . '*')
+            ->dispatch('list-units', $unitName)
             ->willReturn($this->buildCommandStub($output));
 
         $systemctl = (new SystemCtl())->setCommandDispatcher($commandDispatcherStub->reveal());
@@ -130,7 +130,7 @@ public function itShouldReturnAServiceWithTheCorrectNameOnServiceGetting()
         $output = ' testService.service     Active running';
         $commandDispatcherStub = $this->buildCommandDispatcherStub();
         $commandDispatcherStub
-            ->dispatch('list-units', $unitName . '*')
+            ->dispatch('list-units', $unitName)
             ->willReturn($this->buildCommandStub($output));
 
         $systemctl = (new SystemCtl())->setCommandDispatcher($commandDispatcherStub->reveal());
@@ -147,7 +147,7 @@ public function itShouldThrowAnExceptionIfNoServiceCouldBeFound()
         $unitName = 'testService';
         $commandDispatcherStub = $this->buildCommandDispatcherStub();
         $commandDispatcherStub
-            ->dispatch('list-units', $unitName . '*')
+            ->dispatch('list-units', $unitName)
             ->willReturn($this->buildCommandStub(''));
 
         $systemctl = (new SystemCtl())->setCommandDispatcher($commandDispatcherStub->reveal());
@@ -165,7 +165,7 @@ public function itShouldCallCommandDispatcherWithListUnitsAndUnitPrefixOnTimerGe
         $output = ' testTimer.timer     Active running';
         $commandDispatcherStub = $this->buildCommandDispatcherStub();
         $commandDispatcherStub
-            ->dispatch('list-units', $unitName . '*')
+            ->dispatch('list-units', $unitName)
             ->willReturn($this->buildCommandStub($output));
 
         $systemctl = (new SystemCtl())->setCommandDispatcher($commandDispatcherStub->reveal());
@@ -183,7 +183,7 @@ public function itShouldThrowAnExeceptionIfNotTimerCouldBeFound()
         $unitName = 'testTimer';
         $commandDispatcherStub = $this->buildCommandDispatcherStub();
         $commandDispatcherStub
-            ->dispatch('list-units', $unitName . '*')
+            ->dispatch('list-units', $unitName)
             ->willReturn($this->buildCommandStub(''));
 
         $systemctl = (new SystemCtl())->setCommandDispatcher($commandDispatcherStub->reveal());
@@ -201,7 +201,7 @@ public function itShouldReturnATimerOnTimerGetting()
         $output = ' testService.service     Active running';
         $commandDispatcherStub = $this->buildCommandDispatcherStub();
         $commandDispatcherStub
-            ->dispatch('list-units', $unitName . '*')
+            ->dispatch('list-units', $unitName)
             ->willReturn($this->buildCommandStub($output));
 
         $systemctl = (new SystemCtl())->setCommandDispatcher($commandDispatcherStub->reveal());
@@ -219,7 +219,7 @@ public function itShouldReturnATimerWithTheCorrectNameOnTimerGetting()
         $output = ' testService.service     Active running';
         $commandDispatcherStub = $this->buildCommandDispatcherStub();
         $commandDispatcherStub
-            ->dispatch('list-units', $unitName . '*')
+            ->dispatch('list-units', $unitName)
             ->willReturn($this->buildCommandStub($output));
 
         $systemctl = (new SystemCtl())->setCommandDispatcher($commandDispatcherStub->reveal());