pax_global_header00006660000000000000000000000064144033440340014511gustar00rootroot0000000000000052 comment=7055784398eb8d51b5c10595a71d202eee23ce53 deployer.command-1.0.2/000077500000000000000000000000001440334403400147515ustar00rootroot00000000000000deployer.command-1.0.2/.env.dist000066400000000000000000000003771440334403400165130ustar00rootroot00000000000000# UID and GID of your current user (e.g. wwwdev or developer). Can be looked up by using the linux command "id" # By default it is 1001 for vagrant vms (vagrant is 1000 and the next user is 1001) UID=1001 GID=1001 SSH_AUTH_SOCK=/run/user/1001/keyring/ssh deployer.command-1.0.2/.github/000077500000000000000000000000001440334403400163115ustar00rootroot00000000000000deployer.command-1.0.2/.github/dependabot.yml000066400000000000000000000012071440334403400211410ustar00rootroot00000000000000# To get started with Dependabot version updates, you'll need to specify which # package ecosystems to update and where the package manifests are located. # Please see the documentation for all configuration options: # https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates version: 2 updates: - package-ecosystem: "composer" directory: "/" schedule: interval: "daily" - package-ecosystem: "docker" directory: "/docker/application" schedule: interval: "daily" - package-ecosystem: "github-actions" directory: "/" schedule: interval: "daily" deployer.command-1.0.2/.github/release-drafter.yml000066400000000000000000000001371440334403400221020ustar00rootroot00000000000000template: | ## What’s Changed $CHANGES exclude-labels: - "skip-changelog" - "invalid"deployer.command-1.0.2/.github/version-drafter.yml000066400000000000000000000002301440334403400221410ustar00rootroot00000000000000major-labels: [ 'semver:major', 'Breaking Change' ] minor-labels: [ 'semver:minor','enhancement', 'Deprecation' ] patch-labels: [ 'semver:patch','bug' ]deployer.command-1.0.2/.github/workflows/000077500000000000000000000000001440334403400203465ustar00rootroot00000000000000deployer.command-1.0.2/.github/workflows/ci.yml000066400000000000000000000004731440334403400214700ustar00rootroot00000000000000 name: CI on: push: branches: - main - release paths-ignore: - '**.md' pull_request: branches: - main - release paths-ignore: - '**.md' jobs: ci: uses: codenamephp/workflows.php/.github/workflows/ci.yml@1 with: php-versions: '["8.1","8.2"]' deployer.command-1.0.2/.github/workflows/prepare-release.yml000066400000000000000000000012731440334403400241500ustar00rootroot00000000000000name: Prepare Release on: push: branches: [ release ] paths-ignore: - '**.md' jobs: calculate_next_version: uses: codenamephp/workflows.common/.github/workflows/calculate-next-version.yml@1 draft_release: needs: calculate_next_version uses: codenamephp/workflows.common/.github/workflows/draft-release.yml@1 with: version: ${{ needs.calculate_next_version.outputs.version }} update_changelog: uses: codenamephp/workflows.common/.github/workflows/update-changelog.yml@1 needs: calculate_next_version with: ref: ${{github.ref_name}} future-release: ${{ needs.calculate_next_version.outputs.version }} release-branch: 'release'deployer.command-1.0.2/.github/workflows/update-changelog.yml000066400000000000000000000003601440334403400242770ustar00rootroot00000000000000name: Update Changelog on: push: branches: [ main ] paths-ignore: - "**.md" jobs: update_changelog: uses: codenamephp/workflows.common/.github/workflows/update-changelog.yml@1 with: ref: ${{github.ref_name}}deployer.command-1.0.2/CHANGELOG.md000066400000000000000000000034421440334403400165650ustar00rootroot00000000000000# Changelog ## [1.0.2](https://github.com/codenamephp/deployer.command/tree/1.0.2) (2023-03-12) [Full Changelog](https://github.com/codenamephp/deployer.command/compare/1.0.1...1.0.2) **Merged pull requests:** - PHPUnit10 [\#10](https://github.com/codenamephp/deployer.command/pull/10) ([bastianschwarz](https://github.com/bastianschwarz)) - Update phive [\#9](https://github.com/codenamephp/deployer.command/pull/9) ([bastianschwarz](https://github.com/bastianschwarz)) - Update codenamephp/deployer.base requirement from ^2.0 to ^2.0 || ^3.0 [\#8](https://github.com/codenamephp/deployer.command/pull/8) ([dependabot[bot]](https://github.com/apps/dependabot)) - Bump webdevops/php-dev from 8.1 to 8.2 in /docker/application [\#7](https://github.com/codenamephp/deployer.command/pull/7) ([dependabot[bot]](https://github.com/apps/dependabot)) - Workflow Versions [\#6](https://github.com/codenamephp/deployer.command/pull/6) ([bastianschwarz](https://github.com/bastianschwarz)) ## [1.0.1](https://github.com/codenamephp/deployer.command/tree/1.0.1) (2022-07-31) [Full Changelog](https://github.com/codenamephp/deployer.command/compare/1.0.0...1.0.1) **Merged pull requests:** - Update deployer to release [\#4](https://github.com/codenamephp/deployer.command/pull/4) ([bastianschwarz](https://github.com/bastianschwarz)) - Updated CI [\#3](https://github.com/codenamephp/deployer.command/pull/3) ([bastianschwarz](https://github.com/bastianschwarz)) ## [1.0.0](https://github.com/codenamephp/deployer.command/tree/1.0.0) (2022-02-05) [Full Changelog](https://github.com/codenamephp/deployer.command/compare/84d18737da9ccff8afe1dbe387afb9ae2aa9fa6c...1.0.0) \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)* deployer.command-1.0.2/LICENSE000066400000000000000000000260751440334403400157700ustar00rootroot00000000000000Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} 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. deployer.command-1.0.2/README.md000066400000000000000000000037301440334403400162330ustar00rootroot00000000000000# deployer.command ![Packagist Version](https://img.shields.io/packagist/v/codenamephp/deployer.command) ![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/codenamephp/deployer.command) ![Lines of code](https://img.shields.io/tokei/lines/github/codenamephp/deployer.command) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/codenamephp/deployer.command) ![CI](https://github.com/codenamephp/deployer.command/workflows/CI/badge.svg) ![Packagist Downloads](https://img.shields.io/packagist/dt/codenamephp/deployer.command) ![GitHub](https://img.shields.io/github/license/codenamephp/deployer.command) ## What is it? This package provides basic functionality for command line tasks and service handling. ## Installation Easiest way is via composer. Just run `composer require codenamephp/deployer.command` in your cli which should install the latest version for you. ## Usage ### Commands This package provides a `\de\codenamephp\deployer\command\runner\iRunner` that abstracts running of commands. The default implementation `\de\codenamephp\deployer\command\runner\WithDeployerFunctions` - as the name suggests - uses the `Deployer\run()` method to run commands. The `\de\codenamephp\deployer\command\iCommand` interface is designed to just get a command string along with a `\de\codenamephp\deployer\command\runConfiguration\iRunConfiguration` that holds the options like timeouts etc. to run the command with. The default `\de\codenamephp\deployer\command\Command` provides a simple API to build a command. Recommended usage is to create a Factory to build a command with the binary, arguments etc. This factory can then be used in tasks to build the command and the runner to run it. ### Service There is a `\de\codenamephp\deployer\command\service\iService` interface that is intended to manage service with `\de\codenamephp\deployer\command\service\Service` and `\de\codenamephp\deployer\command\service\Systemctl` to manage debian services. deployer.command-1.0.2/composer.json000066400000000000000000000040751440334403400175010ustar00rootroot00000000000000{ "name": "codenamephp/deployer.command", "description": "Extension to the deployer.base package that adds a system to define and run stable command line commands", "type": "library", "license": "Apache-2.0", "authors": [ { "name": "Bastian Schwarz", "email": "bastian@codename-php.de" } ], "require": { "php": "^8.1", "deployer/deployer": "^7.0", "codenamephp/deployer.base": "^2.0 || ^3.0" }, "require-dev": { "roave/security-advisories": "dev-latest" }, "autoload": { "psr-4": { "de\\codenamephp\\deployer\\command\\": [ "src" ] } }, "autoload-dev": { "psr-4": { "de\\codenamephp\\deployer\\command\\test\\": [ "test" ] } }, "config": { "sort-packages": true }, "scripts": { "phive-update": "XDEBUG_MODE=off phive update && git add tools/* phive.xml && git commit -m 'Updated phive dependencies'", "phpunit": "XDEBUG_MODE=coverage tools/phpunit.phar -c test/phpunit.dist.xml test/", "psalm": "XDEBUG_MODE=off tools/psalm --threads=10 --long-progress", "composer-unused": "XDEBUG_MODE=off tools/composer-unused --no-progress --no-interaction", "composer-require-checker": "XDEBUG_MODE=off tools/composer-require-checker --no-interaction", "infection": "XDEBUG_MODE=coverage tools/infection --min-msi=100 --min-covered-msi=100 --threads=4 --no-progress --show-mutations", "ci-all": [ "composer validate", "@phpunit", "@psalm", "@composer-unused", "@composer-require-checker", "@infection" ] }, "scripts-descriptions": { "phive-update": "Runs a phive update and commits all tools and the phive.xml so PHPStorm won't run code formatting on the phars", "phpunit": "Runs phpunit tests", "psalm": "Runs psalm static analysis", "composer-unused": "Checks for unused composer packages", "composer-require-checker": "Checks for missing required composer packages", "infection": "Creates mutation tests to discover missing test coverage", "ci-all": "Runs all ci tools in sequence" } } deployer.command-1.0.2/docker-compose.yml000066400000000000000000000014341440334403400204100ustar00rootroot00000000000000version: '3.6' services: application: user: "${UID:-1000}:${GID:-1000}" #don't run as root by default to prevent permission conflicts build: context: docker/application args: UID: ${UID:-1000} GID: ${GID:-1000} volumes: - ./:/app - $HOME/.phive:/home/application/.phive - $HOME/.ssh:/home/application/.ssh - $HOME/.gitconfig:/home/application/.gitconfig - ${SSH_AUTH_SOCK:-/ssh-agent}:/ssh-agent # Forward local machine SSH key to docker - /etc/timezone:/etc/timezone:ro - /etc/localtime:/etc/localtime:ro # cap and privileged needed for slowlog cap_add: - SYS_PTRACE privileged: true env_file: - docker/application/environment.yml environment: - SSH_AUTH_SOCK=/ssh-agent deployer.command-1.0.2/docker/000077500000000000000000000000001440334403400162205ustar00rootroot00000000000000deployer.command-1.0.2/docker/application/000077500000000000000000000000001440334403400205235ustar00rootroot00000000000000deployer.command-1.0.2/docker/application/Dockerfile000066400000000000000000000012471440334403400225210ustar00rootroot00000000000000FROM webdevops/php-dev:8.2 COPY --from=composer:2 /usr/bin/composer /usr/local/bin/composer COPY --from=phario/phive:0.15.2 /usr/local/bin/phive /usr/local/bin/phive # configure services RUN set -x \ && apt-get -q update \ && docker-service enable syslog \ && docker-run-bootstrap \ && docker-image-cleanup WORKDIR /app ARG UID ARG GID # Fix application uid/gid by given arguments RUN echo "Change uid/gid of 'application' user (${UID}:${GID})" && \ usermod -u ${UID} application && \ groupmod -g ${GID} application && \ usermod -g ${GID} application && \ chown "$APPLICATION_USER":"$APPLICATION_GROUP" -R /app "/home/$APPLICATION_USER" deployer.command-1.0.2/docker/application/environment.yml000066400000000000000000000000511440334403400236060ustar00rootroot00000000000000PHP_DEBUGGER=xdebug XDEBUG_MODE=develop deployer.command-1.0.2/src/000077500000000000000000000000001440334403400155405ustar00rootroot00000000000000deployer.command-1.0.2/src/Command.php000066400000000000000000000043251440334403400176330ustar00rootroot00000000000000. * * 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; use de\codenamephp\deployer\command\runConfiguration\iRunConfiguration; use de\codenamephp\deployer\command\runConfiguration\SimpleContainer; /** * Simple command where the binary is mandatory and arguments, env vars, sudo and a run configuration can be set */ final class Command implements iCommand { /** * @param string $binary The binary to be executed, e.g. ls or composer * @param array $arguments Arguments to use when running the command, e.g. '-l', 'install', '--composer', '--name=value' * @param array $envVars Env vars to set when running the command. They will be prepended to the binary with the key as name * @param bool $sudo Flag to run the command with sudo * @param iRunConfiguration $runConfiguration The run configuration to use when running the command */ public function __construct( public string $binary, public array $arguments = [], public array $envVars = [], public bool $sudo = false, public iRunConfiguration $runConfiguration = new SimpleContainer(), ) {} public function getRunConfiguration() : iRunConfiguration { return $this->runConfiguration; } public function __toString() : string { return implode(' ', array_filter([ ...array_map(static fn(string $name, string $value) : string => sprintf('%s=%s;', $name, $value), array_keys($this->envVars), $this->envVars), $this->sudo ? 'sudo' : '', $this->binary, ...$this->arguments, ])); } }deployer.command-1.0.2/src/iCommand.php000066400000000000000000000025011440334403400177760ustar00rootroot00000000000000. * * 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; use de\codenamephp\deployer\command\runConfiguration\iRunConfiguration; /** * Interface for commands that will be resolved to a string and most likely passed to Deployer\run * * Implementations should take care of the binary, arguments, options, sudo, ... */ interface iCommand { /** * The run configuration that is passed to the command line run * * @return iRunConfiguration */ public function getRunConfiguration() : iRunConfiguration; /** * The complete command line as string, e.g. 'composer install -vvv --no-dev' * * @return string */ public function __toString() : string; }deployer.command-1.0.2/src/runConfiguration/000077500000000000000000000000001440334403400210745ustar00rootroot00000000000000deployer.command-1.0.2/src/runConfiguration/SimpleContainer.php000066400000000000000000000032071440334403400247030ustar00rootroot00000000000000. * * 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\runConfiguration; /** * Interface that acts as a simple container by providing named fields. The fields are then packed into an array */ final class SimpleContainer implements iRunConfiguration { public function __construct( public int $timeout = 0, public int $idleTimeout = 0, public string $secret = '', public array $env = [], public bool $realTimeOutput = false, public bool $noThrow = false, public string $cwd = '', public string $shell = '' ) {} public function getOptions() : array { return array_filter([ 'timeout' => $this->timeout, 'idle_timeout' => $this->idleTimeout, 'secret' => $this->secret, 'env' => array_filter($this->env, static fn($value) : bool => !empty($value) && is_scalar($value)), 'real_time_output' => $this->realTimeOutput, 'no_throw' => $this->noThrow, 'cwd' => $this->cwd, 'shell' => $this->shell, ]); } }deployer.command-1.0.2/src/runConfiguration/iRunConfiguration.php000066400000000000000000000035321440334403400252550ustar00rootroot00000000000000. * * 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\runConfiguration; /** * Interface for the run configuration that is used when running commands. The interface is designed to work with the Deployer\run() and * Deployer\runLocally() methods. Sadly, the API has some bad design: Some options are available as named arguments but the options array will overwrite them * again. And to disable values they are supposed to be nulled. This creates a hard to follow state and options can be set twice. * * This interface only requires a options array that is built by implementations. So the implementations take care of the API and construct the array * and take care of fallbacks and cleaning empty values. */ interface iRunConfiguration { /** * Array of options to be passed to the run and runLocally methods * * Implementations MUST make sure to remove empty values in order for deployer to use defaults * * @return array{ * timeout?: int, * idle_timeout?: int, * secret?: string, * env?: array, * real_time_output?: bool, * no_throw?: bool, * cwd?: string, * shell?: string, * } */ public function getOptions() : array; }deployer.command-1.0.2/src/runner/000077500000000000000000000000001440334403400170515ustar00rootroot00000000000000deployer.command-1.0.2/src/runner/WithDeployerFunctions.php000066400000000000000000000023411440334403400240720ustar00rootroot00000000000000. * * 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\runner; use de\codenamephp\deployer\base\functions\All; use de\codenamephp\deployer\base\functions\iRun; use de\codenamephp\deployer\command\iCommand; /** * Uses the build in Deployer\run() function to run the command */ final class WithDeployerFunctions implements iRunner { public function __construct(public iRun $deployerFunction = new All()) {} public function run(iCommand $command) : string { return $this->deployerFunction->run($command->__toString(), $command->getRunConfiguration()->getOptions()); } }deployer.command-1.0.2/src/runner/iRunner.php000066400000000000000000000024721440334403400212110ustar00rootroot00000000000000. * * 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\runner; use de\codenamephp\deployer\command\iCommand; use Deployer\Exception\Exception; use Deployer\Exception\RunException; use Deployer\Exception\TimeoutException; /** * Interface for a command line runner. */ interface iRunner { /** * Implementations MUST run the command and return the output and pass on the runConfiguration. Implementations SHOULD support deployer-like placeholders. * * @param iCommand $command The command to run * @return string The output of the command * * @throws Exception|RunException|TimeoutException */ public function run(iCommand $command) : string; }deployer.command-1.0.2/src/service/000077500000000000000000000000001440334403400172005ustar00rootroot00000000000000deployer.command-1.0.2/src/service/Service.php000066400000000000000000000024621440334403400213150ustar00rootroot00000000000000. * * 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)); } }deployer.command-1.0.2/src/service/Systemctl.php000066400000000000000000000024701440334403400217030ustar00rootroot00000000000000. * * 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)); } }deployer.command-1.0.2/src/service/iService.php000066400000000000000000000027601440334403400214670ustar00rootroot00000000000000. * * 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; }