Added service commands

Signed-off-by: Bastian Schwarz <bastian@codename-php.de>

Author: bastianschwarz

src/service/Service.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2022 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+namespace de\codenamephp\deployer\command\service;
+
+use de\codenamephp\deployer\command\Command;
+use de\codenamephp\deployer\command\runner\iRunner;
+use de\codenamephp\deployer\command\runner\WithDeployerFunctions;
+
+/**
+ * Uses service to handle the service. The command is executed using an iRunner instance
+ */
+final class Service implements iService {
+
+  public function __construct(public iRunner $runner = new WithDeployerFunctions()) {}
+
+  public function run(string $serviceName, string $action, bool $sudo = true) : string {
+    return $this->runner->run(new Command(binary: 'service', arguments: [$serviceName, $action], sudo: $sudo));
+  }
+}

src/service/Systemctl.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2022 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+namespace de\codenamephp\deployer\command\service;
+
+use de\codenamephp\deployer\command\Command;
+use de\codenamephp\deployer\command\runner\iRunner;
+use de\codenamephp\deployer\command\runner\WithDeployerFunctions;
+
+/**
+ * Uses systemctl to handle the service. The command is executed using an iRunner instance
+ */
+final class Systemctl implements iService {
+
+  public function __construct(public iRunner $runner = new WithDeployerFunctions()) {}
+
+  public function run(string $serviceName, string $action, bool $sudo = true) : string {
+    return $this->runner->run(new Command(binary: 'systemctl', arguments: [$action, $serviceName], sudo: $sudo));
+  }
+}

src/service/iService.php

@@ -0,0 +1,40 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2022 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+namespace de\codenamephp\deployer\command\service;
+
+use Deployer\Exception\Exception;
+use Deployer\Exception\RunException;
+use Deployer\Exception\TimeoutException;
+
+/**
+ * Interface to control services, e.g. through service, init.d or systemctl
+ */
+interface iService {
+
+  /**
+   * Performs the given action for the given service. Implementations should use an iRunner implementation to execute the command
+   *
+   * @param string $serviceName The name of the service to handle, e.g. apache2, docker, ...
+   * @param string $action The action to perform, e.g. restart, reload, ...
+   * @param bool $sudo To use sudo or not, defaults to true
+   * @return string The output of the command
+   *
+   * @throws Exception|RunException|TimeoutException
+   */
+  public function run(string $serviceName, string $action, bool $sudo = true) : string;
+}

test/service/ServiceTest.php

@@ -0,0 +1,58 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2022 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+namespace de\codenamephp\deployer\command\test\service;
+
+use de\codenamephp\deployer\command\Command;
+use de\codenamephp\deployer\command\runner\iRunner;
+use de\codenamephp\deployer\command\runner\WithDeployerFunctions;
+use de\codenamephp\deployer\command\service\Service;
+use PHPUnit\Framework\TestCase;
+
+final class ServiceTest extends TestCase {
+
+  private Service $sut;
+
+  protected function setUp() : void {
+    parent::setUp();
+
+    $this->sut = new Service();
+  }
+
+  public function test__construct() : void {
+    $this->sut = new Service();
+
+    self::assertInstanceOf(WithDeployerFunctions::class, $this->sut->runner);
+  }
+
+  public function test__construct_withArguments() : void {
+    $runner = $this->createMock(iRunner::class);
+
+    $this->sut = new Service($runner);
+
+    self::assertSame($runner, $this->sut->runner);
+  }
+
+  public function testRun() : void {
+    $command = new Command(binary: 'service', arguments: ['apache2', 'restart'], sudo: true);
+
+    $this->sut->runner = $this->createMock(iRunner::class);
+    $this->sut->runner->expects(self::once())->method('run')->with($command)->willReturn('some output');
+
+    self::assertEquals('some output', $this->sut->run('apache2', 'restart'));
+  }
+}

test/service/SystemctlTest.php

@@ -0,0 +1,58 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2022 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+namespace de\codenamephp\deployer\command\test\service;
+
+use de\codenamephp\deployer\command\Command;
+use de\codenamephp\deployer\command\runner\iRunner;
+use de\codenamephp\deployer\command\runner\WithDeployerFunctions;
+use de\codenamephp\deployer\command\service\Systemctl;
+use PHPUnit\Framework\TestCase;
+
+final class SystemctlTest extends TestCase {
+
+  private Systemctl $sut;
+
+  protected function setUp() : void {
+    parent::setUp();
+
+    $this->sut = new Systemctl();
+  }
+
+  public function test__construct() : void {
+    $this->sut = new Systemctl();
+
+    self::assertInstanceOf(WithDeployerFunctions::class, $this->sut->runner);
+  }
+
+  public function test__construct_withArguments() : void {
+    $runner = $this->createMock(iRunner::class);
+
+    $this->sut = new Systemctl($runner);
+
+    self::assertSame($runner, $this->sut->runner);
+  }
+
+  public function testRun() : void {
+    $command = new Command(binary: 'systemctl', arguments: ['restart', 'apache2'], sudo: true);
+
+    $this->sut->runner = $this->createMock(iRunner::class);
+    $this->sut->runner->expects(self::once())->method('run')->with($command)->willReturn('some output');
+
+    self::assertEquals('some output', $this->sut->run('apache2', 'restart'));
+  }
+}