deblan-mirror/magallanes
1
0
Fork 0
mirror of https://github.com/andres-montanez/Magallanes synced 2024-05-03 14:33:15 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #456 from andres-montanez/galactica

Browse source 
Galactica
This commit is contained in:
Andrés Montañez 2022-04-15 11:17:14 -03:00 committed by GitHub
parent d6432d732a a41e07eba6
commit 0ccc2bbe45
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
113 changed files with 1364 additions and 1006 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
.github/workflows/linters.yml vendored Normal file
View file

@ -0,0 +1,32 @@
name: Linters
on:
push:
branches:
- master
- galactica
pull_request:
release:
types:
- created
jobs:
linters:
name: Linters
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Composer install
uses: php-actions/composer@v5
with:
command: install
args: --ignore-platform-reqs --no-scripts
version: 2
php_version: 8.0
- name: PHPStan
run: ./vendor/bin/phpstan analyse
- name: PHP Code Sniffer
run: ./vendor/bin/phpcs

60
.github/workflows/tests.yml vendored Normal file
View file

@ -0,0 +1,60 @@
name: PHPUnit
on:
push:
branches:
- master
- galactica
pull_request:
release:
types:
- created
jobs:
unit_tests_80:
name: Unit tests with PHP 8.0
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Composer install
uses: php-actions/composer@v5
with:
command: install
args: --ignore-platform-reqs --no-scripts
version: 2
php_version: 8.0
- name: Run tests
env:
XDEBUG_MODE: coverage
run: |
mkdir .logs
./vendor/bin/phpunit --coverage-clover build/logs/coverage.xml
- name: Run Coveralls
env:
COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: ./vendor/bin/php-coveralls -v --coverage_clover build/logs/coverage.xml
unit_tests_81:
name: Unit tests with PHP 8.1
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Composer install
uses: php-actions/composer@v5
with:
command: install
args: --ignore-platform-reqs --no-scripts
version: 2
php_version: 8.1
- name: Run tests
env:
XDEBUG_MODE: coverage
run: |
mkdir .logs
./vendor/bin/phpunit --coverage-clover build/logs/coverage.xml

3
.gitignore vendored
View file

@ -3,4 +3,5 @@
composer.lock composer.lock
.mage.yml .mage.yml
.phpunit.result.cache .phpunit.result.cache
.phpcs-cache
.logs

3
.travis.yml
View file

@ -1,8 +1,7 @@
language: php language: php
php: php:
- '7.2'
- '7.4'
- '8.0' - '8.0'
- '8.1'
install: install:
- composer install - composer install

35
CHANGELOG.md
View file

@ -1,24 +1,15 @@
CHANGELOG for 4.X CHANGELOG for 5.X
================= =================
* 4.1.1 (2021-02-20) * 5.0.0 (2022-04-15)
* Add `copyDirectory` option * v5 series release.
* Bug fixes * Refactored for Symfony 6 and PHP 8.
* Improve testing and coverage * Added strong types.
* Removed task `composer/self-update`.
* Allow `exec` task to interpolate `%environment%` and `%release%`.
* 4.1.0 (2021-02-19) * Added new `sleep` task to day execution [PR#414].
* PHP 8 and Symfony 5 compatibility [PR#448] * Added new `symlink` option to define the name of symbolic link on the Release [PR#425].
* Timeout option for SSH [PR#436] * Improved Windows compatibility [PR#427].
* Improve compatibility with Windows [PR#434] [PR#429] * Added new `log_limit` option to limit how many logs are kept [Issue#403].
* Improve config load [PR#422] * Add new deploy option `--tag` to specify deploying a specific tag [Issue#192] [Issue#315].
* Bug fixes [PR#448] [PR#424] * Added new `scp_flags` option for the `scp` command when SSH flags are incompatible with [Issue#439].
* Readme Update [PR#438]
* 4.0.0 (2018-04-02)
* v4 series release
* Refactored for Symfony 4 and PHP 7.1
* Symfony Pool Clear task added
* Symfony Pool Prune task added
* Symfony Assetic task removed

25
CONTRIBUTING.md
View file

@ -7,7 +7,7 @@ Please read the following guidelines to make your and our work easier and cleane
1. Write clean code with no mess left 1. Write clean code with no mess left
2. Contribute the docs when adding configurable new feature 2. Contribute the docs when adding configurable new feature
3. Create your pull request from `nostromo` branch 3. Create your pull request from `galactica` branch
4. Ensure your code is fully covered by tests 4. Ensure your code is fully covered by tests
---------- ----------
@ -28,39 +28,36 @@ In order to have the PRs prioritized name them with the following tags.
[FEATURE] Create new PermissionsTask [FEATURE] Create new PermissionsTask
[HOTFIX] Exception not caught on deployment [HOTFIX] Exception not caught on deployment
``` ```
All Pull Requests must be done to the `nostromo` branch, only exception are Hotfixes. All Pull Requests must be done to the `galactica` branch, only exception are Hotfixes.
Remember of square brackets when adding issue number. If you'd forget adding them, your whole message will be a comment! Remember of square brackets when adding issue number. If you'd forget adding them, your whole message will be a comment!
# Developing Magallanes # Developing Magallanes
## Branches ## Branches
The flow is pretty simple. The flow is pretty simple.
In most common cases we work on the `nostromo` branch. It's the branch with the main development for the current major version. All Pull Requests must merge with that branch. The `master` branch is used to move the validated code and generate the releases in an orderly fashion, also we could use it for hotfixes. In most common cases we work on the `galactica` branch. It's the branch with the main development for the current major version. All Pull Requests must merge with that branch. The `master` branch is used to move the validated code and generate the releases in an orderly fashion, also we could use it for hotfixes.
If you want to use developing branch in your code, simple pass `dev-nostromo` to dependency version in your `composer.json` file: If you want to use developing branch in your code, simple pass `dev-galactica` to dependency version in your `composer.json` file:
```json ```json
{ {
"require": { "require": {
"andres-montanez/magallanes": "dev-nostromo" "andres-montanez/magallanes": "dev-galactica"
} }
} }
``` ```
## Organization and code quality ## Organization and code quality
We use [PSR2](http://www.php-fig.org/psr/psr-2/) as PHP coding standard. We use [PSR-12](http://www.php-fig.org/psr/psr-12/) as PHP coding standard.
### Tools you can use to ensure your code quality ### Tools you can use to ensure your code quality
1. PHP-CodeSniffer 1. PHPStan `./vendor/bin/phpstan analyse`
2. [PHP Mess Detector](https://phpmd.org/) 2. PHP Code Sniffer `./vendor/bin/phpcs`
3. PHP Copy/Paste Detector
4. PHP Dead Code Detector
5. [PHP Coding Standards Fixer](http://cs.sensiolabs.org) with --level=psr2
## Testing and quality ## Testing and quality
We use PHPUnit to test our code. Most of the project is covered with tests, so if you want your code to be merged push it with proper testing and coverage (at least 95%). To execute the tests with code coverage report: We use PHPUnit to test our code. Most of the project is covered with tests, so if you want your code to be merged push it with proper testing and coverage (at least 95%). To execute the tests with code coverage report:
``` ```bash
vendor/bin/phpunit --coverage-clover build/logs/coverage.xml ./vendor/bin/phpunit --coverage-clover build/logs/coverage.xml --coverage-text
vendor/bin/coveralls -v --coverage_clover build/logs/coverage.xml ./vendor/bin/php-coveralls -v --coverage_clover build/logs/coverage.xml
``` ```
Tests structure follow almost the same structure as production code with `Test` suffix in class and file name. Follow the tests already made as guidelines. Tests structure follow almost the same structure as production code with `Test` suffix in class and file name. Follow the tests already made as guidelines.

2
LICENSE
View file

@ -1,4 +1,4 @@
Copyright (c) 2011 - 2017 Andrés Montañez Copyright (c) 2011 - 2022 Andrés Montañez
Permission is hereby granted, free of charge, to any Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated person obtaining a copy of this software and associated

10
README.md
View file

@ -1,6 +1,6 @@
# Magallanes # Magallanes
[![SymfonyInsight](https://insight.symfony.com/projects/ed0de53a-a12e-459b-9464-34def5907b56/mini.svg)](https://insight.symfony.com/projects/ed0de53a-a12e-459b-9464-34def5907b56) ![Linters](https://github.com/andres-montanez/Magallanes/actions/workflows/linters.yml/badge.svg?)
[![Build Status](https://img.shields.io/travis/andres-montanez/Magallanes/master.svg)](https://travis-ci.org/andres-montanez/Magallanes) ![Tests](https://github.com/andres-montanez/Magallanes/actions/workflows/tests.yml/badge.svg?)
[![Coverage Status](https://img.shields.io/coveralls/andres-montanez/Magallanes/master.svg)](https://coveralls.io/github/andres-montanez/Magallanes?branch=master) [![Coverage Status](https://img.shields.io/coveralls/andres-montanez/Magallanes/master.svg)](https://coveralls.io/github/andres-montanez/Magallanes?branch=master)
[![Code Quality](https://img.shields.io/scrutinizer/g/andres-montanez/Magallanes.svg)](https://scrutinizer-ci.com/g/andres-montanez/Magallanes/) [![Code Quality](https://img.shields.io/scrutinizer/g/andres-montanez/Magallanes.svg)](https://scrutinizer-ci.com/g/andres-montanez/Magallanes/)
[![Latest Stable Version](https://img.shields.io/packagist/v/andres-montanez/magallanes.svg?label=stable)](https://packagist.org/packages/andres-montanez/magallanes) [![Latest Stable Version](https://img.shields.io/packagist/v/andres-montanez/magallanes.svg?label=stable)](https://packagist.org/packages/andres-montanez/magallanes)
@ -16,7 +16,7 @@ Simply add the following dependency to your project’s composer.json file:
```json ```json
"require-dev": { "require-dev": {
"andres-montanez/magallanes": "^4.0" "andres-montanez/magallanes": "^5.0"
} }
``` ```
Finally you can use **Magallanes** from the vendor's bin: Finally you can use **Magallanes** from the vendor's bin:
@ -25,5 +25,5 @@ Finally you can use **Magallanes** from the vendor's bin:
vendor/bin/mage version vendor/bin/mage version
``` ```
### Codename Discovery One ### Codename Galactica
Each new mayor version of **Magallanes** will have a codename (like Ubuntu), version 3 was _Nostromo_, and in the current version it is **_Discovery One_**, in homage to the spaceship from the ground breaking film *2001: A Space Odyssey (1968)*. Each new mayor version of **Magallanes** will have a codename (like Ubuntu), version 3 was _Nostromo_, version 4 was _Discovery One_, and in the current version it is **_Galactica_**, in homage to the space battleship from the TV series Battlestar Galactica, both the '70s and the mind blowing revision of 2005.

26
composer.json
View file

@ -12,18 +12,20 @@
} }
], ],
"require": { "require": {
"php": "^7.2 | ^8.0", "php": "^8.0",
"monolog/monolog": "~1.11 | ^2.0", "monolog/monolog": "^2.5",
"symfony/console": "^4.0 | ^5.0", "symfony/console": "^6.0",
"symfony/filesystem": "^4.0 | ^5.0", "symfony/filesystem": "^6.0",
"symfony/event-dispatcher": "^4.0 | ^5.0", "symfony/event-dispatcher": "^6.0",
"symfony/finder": "^4.0 | ^5.0", "symfony/finder": "^6.0",
"symfony/yaml": "^4.0 | ^5.0", "symfony/yaml": "^6.0",
"symfony/process": "^4.0 | ^5.0" "symfony/process": "^6.0"
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit": "^8.0", "phpunit/phpunit": "^9.5",
"php-coveralls/php-coveralls": "~2.0" "phpstan/phpstan": "^1.5",
"squizlabs/php_codesniffer": "^3.6",
"php-coveralls/php-coveralls": "^2.5"
}, },
"suggest": { "suggest": {
"ext-posix": "*" "ext-posix": "*"
@ -41,8 +43,8 @@
"bin": ["bin/mage"], "bin": ["bin/mage"],
"extra": { "extra": {
"branch-alias": { "branch-alias": {
"dev-master": "4.0.x-dev", "dev-master": "5.0.x-dev",
"dev-discovery-one": "4.x-dev" "dev-discovery-one": "5.x-dev"
} }
} }
} }

6
docs/dockers/docker-compose.yml
View file

@ -1,7 +1,7 @@
version: '2' version: '2'
services: services:
php7.4: php8.0:
container_name: mage-php7.4 container_name: mage-php8.0
build: ./php7.4 build: ./php8.0
volumes: volumes:
- ../../:/home/magephp - ../../:/home/magephp

4
docs/dockers/php7.4/Dockerfile → docs/dockers/php8.0/Dockerfile
View file

@ -1,11 +1,11 @@
FROM ubuntu:20.04 FROM ubuntu:21.10
ENV DEBIAN_FRONTEND=noninteractive \ ENV DEBIAN_FRONTEND=noninteractive \
TZ=UTC TZ=UTC
RUN apt-get update && apt-get upgrade -y RUN apt-get update && apt-get upgrade -y
RUN apt-get install -y vim curl git unzip RUN apt-get install -y vim curl git unzip
RUN apt-get install -y php7.4-cli php-zip php7.4-curl php7.4-xml php7.4-mbstring php7.4-xdebug RUN apt-get install -y php8.0-cli php8.0-zip php8.0-curl php8.0-xml php8.0-mbstring php8.0-xdebug
RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/bin/ --filename=composer RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/bin/ --filename=composer

8
docs/example-config.yml
View file

@ -7,10 +7,8 @@ magephp:
host_path: /var/www/test host_path: /var/www/test
releases: 4 releases: 4
exclude: exclude:
- vendor - var/cache
- app/cache - var/log
- app/log
- web/app_dev.php
hosts: hosts:
- webserver1 - webserver1
- webserver2 - webserver2
@ -18,7 +16,7 @@ magephp:
pre-deploy: pre-deploy:
- git/update - git/update
- composer/install - composer/install
- composer/generate-autoload - composer/dump-autoload
on-deploy: on-deploy:
- symfony/cache-warmup: { env: 'prod' } - symfony/cache-warmup: { env: 'prod' }
- symfony/assets-install: { env: 'prod' } - symfony/assets-install: { env: 'prod' }

14
phpcs.xml.dist Normal file
View file

@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
<arg name="basepath" value="."/>
<arg name="cache" value=".phpcs-cache"/>
<arg name="colors"/>
<arg name="extensions" value="php"/>
<rule ref="PSR12"/>
<file>src/</file>
</ruleset>

4
phpstan.neon Normal file
View file

@ -0,0 +1,4 @@
parameters:
level: 6
paths:
- src

61
phpunit.xml.dist
View file

@ -1,37 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" backupGlobals="false" colors="true" bootstrap="vendor/autoload.php">
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" <coverage>
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.1/phpunit.xsd" <include>
backupGlobals="false" <directory>./src/</directory>
colors="true" </include>
bootstrap="vendor/autoload.php" <exclude>
> <directory>./tests/</directory>
<php> </exclude>
<ini name="error_reporting" value="-1" /> </coverage>
<ini name="intl.default_locale" value="en" /> <php>
<ini name="intl.error_level" value="0" /> <ini name="error_reporting" value="-1"/>
<ini name="memory_limit" value="-1" /> <ini name="intl.default_locale" value="en"/>
</php> <ini name="intl.error_level" value="0"/>
<ini name="memory_limit" value="-1"/>
<testsuites> </php>
<testsuite name="Magallanes Test Suite"> <testsuites>
<directory>./tests/</directory> <testsuite name="Magallanes Test Suite">
</testsuite> <directory>./tests/</directory>
</testsuites> </testsuite>
</testsuites>
<groups> <groups>
<exclude> <exclude>
<group>benchmark</group> <group>benchmark</group>
<group>intl-data</group> <group>intl-data</group>
</exclude> </exclude>
</groups> </groups>
<filter>
<whitelist>
<directory>./src/</directory>
<exclude>
<directory>./tests/</directory>
</exclude>
</whitelist>
</filter>
</phpunit> </phpunit>

29
src/Command/AbstractCommand.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -23,46 +24,30 @@ use Symfony\Component\Console\Command\Command;
*/ */
abstract class AbstractCommand extends Command abstract class AbstractCommand extends Command
{ {
/** protected int $statusCode = 0;
* @var int protected Runtime $runtime;
*/
protected $statusCode = 0;
/**
* @var Runtime Current Runtime instance
*/
protected $runtime;
/** /**
* Set the Runtime configuration * Set the Runtime configuration
*
* @param Runtime $runtime Runtime container
* @return AbstractCommand
*/ */
public function setRuntime(Runtime $runtime) public function setRuntime(Runtime $runtime): self
{ {
$this->runtime = $runtime; $this->runtime = $runtime;
return $this; return $this;
} }
/** /**
* Logs a message * Logs a message
*
* @param string $message
* @param string $level
*/ */
public function log($message, $level = LogLevel::DEBUG) public function log(string $message, string $level = LogLevel::DEBUG): void
{ {
$this->runtime->log($message, $level); $this->runtime->log($message, $level);
} }
/** /**
* Get the Human friendly Stage name * Get the Human friendly Stage name
*
* @return string
*/ */
protected function getStageName() protected function getStageName(): string
{ {
$utils = new Utils(); $utils = new Utils();
return $utils->getStageName($this->runtime->getStage()); return $utils->getStageName($this->runtime->getStage());
@ -71,7 +56,7 @@ abstract class AbstractCommand extends Command
/** /**
* Requires the configuration to be loaded * Requires the configuration to be loaded
*/ */
protected function requireConfig() protected function requireConfig(): void
{ {
$app = $this->getApplication(); $app = $this->getApplication();
if ($app instanceof MageApplication) { if ($app instanceof MageApplication) {

14
src/Command/BuiltIn/Config/DumpCommand.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -24,22 +25,17 @@ class DumpCommand extends AbstractCommand
/** /**
* Configure the Command * Configure the Command
*/ */
protected function configure() protected function configure(): void
{ {
$this $this
->setName('config:dump') ->setName('config:dump')
->setDescription('Dumps the Magallanes configuration') ->setDescription('Dumps the Magallanes configuration');
;
} }
/** /**
* Execute the Command * Execute the Command
*
* @param InputInterface $input
* @param OutputInterface $output
* @return int|mixed
*/ */
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output): int
{ {
$this->requireConfig(); $this->requireConfig();
@ -51,6 +47,6 @@ class DumpCommand extends AbstractCommand
$output->writeln(''); $output->writeln('');
$output->writeln('Finished <fg=blue>Magallanes</>'); $output->writeln('Finished <fg=blue>Magallanes</>');
return 0; return self::SUCCESS;
} }
} }

14
src/Command/BuiltIn/Config/EnvironmentsCommand.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -25,22 +26,17 @@ class EnvironmentsCommand extends AbstractCommand
/** /**
* Configure the Command * Configure the Command
*/ */
protected function configure() protected function configure(): void
{ {
$this $this
->setName('config:environments') ->setName('config:environments')
->setDescription('List all Magallanes configured Environments') ->setDescription('List all Magallanes configured Environments');
;
} }
/** /**
* Execute the Command * Execute the Command
*
* @param InputInterface $input
* @param OutputInterface $output
* @return int|mixed
*/ */
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output): int
{ {
$this->requireConfig(); $this->requireConfig();
@ -66,6 +62,6 @@ class EnvironmentsCommand extends AbstractCommand
$output->writeln(''); $output->writeln('');
$output->writeln('Finished <fg=blue>Magallanes</>'); $output->writeln('Finished <fg=blue>Magallanes</>');
return 0; return self::SUCCESS;
} }
} }

128
src/Command/BuiltIn/DeployCommand.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -31,32 +32,37 @@ use Mage\Command\AbstractCommand;
*/ */
class DeployCommand extends AbstractCommand class DeployCommand extends AbstractCommand
{ {
/** protected TaskFactory $taskFactory;
* @var TaskFactory
*/
protected $taskFactory;
/** /**
* Configure the Command * Configure the Command
*/ */
protected function configure() protected function configure(): void
{ {
$this $this
->setName('deploy') ->setName('deploy')
->setDescription('Deploy code to hosts') ->setDescription('Deploy code to hosts')
->addArgument('environment', InputArgument::REQUIRED, 'Name of the environment to deploy to') ->addArgument('environment', InputArgument::REQUIRED, 'Name of the environment to deploy to.')
->addOption('branch', null, InputOption::VALUE_REQUIRED, 'Force to switch to a branch other than the one defined', false) ->addOption(
; 'branch',
null,
InputOption::VALUE_REQUIRED,
'Force to switch to a branch other than the one defined.',
false
)
->addOption(
'tag',
null,
InputOption::VALUE_REQUIRED,
'Deploys a specific tag.',
false
);
} }
/** /**
* Execute the Command * Execute the Command
*
* @param InputInterface $input
* @param OutputInterface $output
* @return integer
*/ */
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output): int
{ {
$this->requireConfig(); $this->requireConfig();
@ -84,14 +90,25 @@ class DeployCommand extends AbstractCommand
$output->writeln(sprintf(' Strategy: <fg=green>%s</>', $strategy->getName())); $output->writeln(sprintf(' Strategy: <fg=green>%s</>', $strategy->getName()));
if (($input->getOption('branch') !== false) && ($input->getOption('tag') !== false)) {
throw new RuntimeException('Branch and Tag options are mutually exclusive.');
}
if ($input->getOption('branch') !== false) { if ($input->getOption('branch') !== false) {
$this->runtime->setEnvOption('branch', $input->getOption('branch')); $this->runtime->setEnvOption('branch', $input->getOption('branch'));
} }
if ($input->getOption('tag') !== false) {
$this->runtime->setEnvOption('branch', false);
$this->runtime->setEnvOption('tag', $input->getOption('tag'));
$output->writeln(sprintf(' Tag: <fg=green>%s</>', $this->runtime->getEnvOption('tag')));
}
if ($this->runtime->getEnvOption('branch', false)) { if ($this->runtime->getEnvOption('branch', false)) {
$output->writeln(sprintf(' Branch: <fg=green>%s</>', $this->runtime->getEnvOption('branch'))); $output->writeln(sprintf(' Branch: <fg=green>%s</>', $this->runtime->getEnvOption('branch')));
} }
$output->writeln(''); $output->writeln('');
$this->runDeployment($output, $strategy); $this->runDeployment($output, $strategy);
} catch (RuntimeException $exception) { } catch (RuntimeException $exception) {
@ -103,17 +120,15 @@ class DeployCommand extends AbstractCommand
$output->writeln('Finished <fg=blue>Magallanes</>'); $output->writeln('Finished <fg=blue>Magallanes</>');
return $this->statusCode; return intval($this->statusCode);
} }
/** /**
* Run the Deployment Process * Run the Deployment Process
* *
* @param OutputInterface $output
* @param StrategyInterface $strategy
* @throws RuntimeException * @throws RuntimeException
*/ */
protected function runDeployment(OutputInterface $output, StrategyInterface $strategy) protected function runDeployment(OutputInterface $output, StrategyInterface $strategy): void
{ {
// Run "Pre Deploy" Tasks // Run "Pre Deploy" Tasks
$this->runtime->setStage(Runtime::PRE_DEPLOY); $this->runtime->setStage(Runtime::PRE_DEPLOY);
@ -140,16 +155,20 @@ class DeployCommand extends AbstractCommand
} }
} }
protected function runOnHosts(OutputInterface $output, $tasks) /**
* @param string[] $tasks
*/
protected function runOnHosts(OutputInterface $output, array $tasks): void
{ {
$hosts = $this->runtime->getEnvOption('hosts'); $hosts = $this->runtime->getEnvOption('hosts');
if (!is_array($hosts) && !$hosts instanceof \Countable) { if (!is_array($hosts) && !$hosts instanceof \Countable) {
$hosts = []; $hosts = [];
} }
if (count($hosts) == 0) {
if (count($hosts) === 0) {
$output->writeln(sprintf(' No hosts defined, skipping %s tasks', $this->getStageName())); $output->writeln(sprintf(' No hosts defined, skipping %s tasks', $this->getStageName()));
$output->writeln(''); $output->writeln('');
return true; return;
} }
foreach ($hosts as $host) { foreach ($hosts as $host) {
@ -165,21 +184,27 @@ class DeployCommand extends AbstractCommand
/** /**
* Runs all the tasks * Runs all the tasks
* *
* @param OutputInterface $output * @param string[] $tasks
* @param $tasks
* @return bool
* @throws RuntimeException * @throws RuntimeException
*/ */
protected function runTasks(OutputInterface $output, $tasks) protected function runTasks(OutputInterface $output, array $tasks): bool
{ {
if (count($tasks) == 0) { if (count($tasks) == 0) {
$output->writeln(sprintf(' No tasks defined for <fg=black;options=bold>%s</> stage', $this->getStageName())); $output->writeln(
sprintf(' No tasks defined for <fg=black;options=bold>%s</> stage', $this->getStageName())
);
$output->writeln(''); $output->writeln('');
return true; return true;
} }
if ($this->runtime->getHostName() !== null) { if ($this->runtime->getHostName() !== null) {
$output->writeln(sprintf(' Starting <fg=black;options=bold>%s</> tasks on host <fg=black;options=bold>%s</>:', $this->getStageName(), $this->runtime->getHostName())); $output->writeln(
sprintf(
' Starting <fg=black;options=bold>%s</> tasks on host <fg=black;options=bold>%s</>:',
$this->getStageName(),
$this->runtime->getHostName()
)
);
} else { } else {
$output->writeln(sprintf(' Starting <fg=black;options=bold>%s</> tasks:', $this->getStageName())); $output->writeln(sprintf(' Starting <fg=black;options=bold>%s</> tasks:', $this->getStageName()));
} }
@ -188,7 +213,6 @@ class DeployCommand extends AbstractCommand
$succeededTasks = 0; $succeededTasks = 0;
foreach ($tasks as $taskName) { foreach ($tasks as $taskName) {
/** @var AbstractTask $task */
$task = $this->taskFactory->get($taskName); $task = $this->taskFactory->get($taskName);
$output->write(sprintf(' Running <fg=magenta>%s</> ... ', $task->getDescription())); $output->write(sprintf(' Running <fg=magenta>%s</> ... ', $task->getDescription()));
$this->log(sprintf('Running task %s (%s)', $task->getDescription(), $task->getName())); $this->log(sprintf('Running task %s (%s)', $task->getDescription(), $task->getName()));
@ -196,25 +220,48 @@ class DeployCommand extends AbstractCommand
if ($this->runtime->inRollback() && !$task instanceof ExecuteOnRollbackInterface) { if ($this->runtime->inRollback() && !$task instanceof ExecuteOnRollbackInterface) {
$succeededTasks++; $succeededTasks++;
$output->writeln('<fg=yellow>SKIPPED</>'); $output->writeln('<fg=yellow>SKIPPED</>');
$this->log(sprintf('Task %s (%s) finished with SKIPPED, it was in a Rollback', $task->getDescription(), $task->getName())); $this->log(
sprintf(
'Task %s (%s) finished with SKIPPED, it was in a Rollback',
$task->getDescription(),
$task->getName()
)
);
} else { } else {
try { try {
if ($task->execute()) { if ($task->execute()) {
$succeededTasks++; $succeededTasks++;
$output->writeln('<fg=green>OK</>'); $output->writeln('<fg=green>OK</>');
$this->log(sprintf('Task %s (%s) finished with OK', $task->getDescription(), $task->getName())); $this->log(
sprintf('Task %s (%s) finished with OK', $task->getDescription(), $task->getName())
);
} else { } else {
$output->writeln('<fg=red>FAIL</>'); $output->writeln('<fg=red>FAIL</>');
$this->statusCode = 180; $this->statusCode = 180;
$this->log(sprintf('Task %s (%s) finished with FAIL', $task->getDescription(), $task->getName())); $this->log(
sprintf('Task %s (%s) finished with FAIL', $task->getDescription(), $task->getName())
);
} }
} catch (SkipException $exception) { } catch (SkipException $exception) {
$succeededTasks++; $succeededTasks++;
$output->writeln('<fg=yellow>SKIPPED</>'); $output->writeln('<fg=yellow>SKIPPED</>');
$this->log(sprintf('Task %s (%s) finished with SKIPPED, thrown SkipException', $task->getDescription(), $task->getName())); $this->log(
sprintf(
'Task %s (%s) finished with SKIPPED, thrown SkipException',
$task->getDescription(),
$task->getName()
)
);
} catch (ErrorException $exception) { } catch (ErrorException $exception) {
$output->writeln(sprintf('<fg=red>ERROR</> [%s]', $exception->getTrimmedMessage())); $output->writeln(sprintf('<fg=red>ERROR</> [%s]', $exception->getTrimmedMessage()));
$this->log(sprintf('Task %s (%s) finished with FAIL, with Error "%s"', $task->getDescription(), $task->getName(), $exception->getMessage())); $this->log(
sprintf(
'Task %s (%s) finished with FAIL, with Error "%s"',
$task->getDescription(),
$task->getName(),
$exception->getMessage()
)
);
$this->statusCode = 190; $this->statusCode = 190;
} }
} }
@ -229,7 +276,15 @@ class DeployCommand extends AbstractCommand
$alertColor = 'green'; $alertColor = 'green';
} }
$output->writeln(sprintf(' Finished <fg=%s>%d/%d</> tasks for <fg=black;options=bold>%s</>.', $alertColor, $succeededTasks, $totalTasks, $this->getStageName())); $output->writeln(
sprintf(
' Finished <fg=%s>%d/%d</> tasks for <fg=black;options=bold>%s</>.',
$alertColor,
$succeededTasks,
$totalTasks,
$this->getStageName()
)
);
$output->writeln(''); $output->writeln('');
return ($succeededTasks == $totalTasks); return ($succeededTasks == $totalTasks);
@ -238,8 +293,11 @@ class DeployCommand extends AbstractCommand
/** /**
* Exception for halting the the current process * Exception for halting the the current process
*/ */
protected function getException() protected function getException(): RuntimeException
{ {
return new RuntimeException(sprintf('Stage "%s" did not finished successfully, halting command.', $this->getStageName()), 50); return new RuntimeException(
sprintf('Stage "%s" did not finished successfully, halting command.', $this->getStageName()),
50
);
} }
} }

31
src/Command/BuiltIn/Releases/ListCommand.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -25,31 +26,21 @@ use Mage\Command\AbstractCommand;
*/ */
class ListCommand extends AbstractCommand class ListCommand extends AbstractCommand
{ {
/**
* @var int
*/
protected $statusCode = 0;
/** /**
* Configure the Command * Configure the Command
*/ */
protected function configure() protected function configure(): void
{ {
$this $this
->setName('releases:list') ->setName('releases:list')
->setDescription('List the releases on an environment') ->setDescription('List the releases on an environment')
->addArgument('environment', InputArgument::REQUIRED, 'Name of the environment to deploy to') ->addArgument('environment', InputArgument::REQUIRED, 'Name of the environment to deploy to');
;
} }
/** /**
* Execute the Command * Execute the Command
*
* @param InputInterface $input
* @param OutputInterface $output
* @return int|mixed
*/ */
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output): int
{ {
$this->requireConfig(); $this->requireConfig();
@ -102,7 +93,9 @@ class ListCommand extends AbstractCommand
} }
if (count($releases) == 0) { if (count($releases) == 0) {
$output->writeln(sprintf(' No releases available on host <fg=black;options=bold>%s</>:', $host)); $output->writeln(
sprintf(' No releases available on host <fg=black;options=bold>%s</>:', $host)
);
} else { } else {
// Get Current Release // Get Current Release
$cmdCurrentRelease = sprintf('readlink -f %s/current', $hostPath); $cmdCurrentRelease = sprintf('readlink -f %s/current', $hostPath);
@ -110,7 +103,10 @@ class ListCommand extends AbstractCommand
/** @var Process $process */ /** @var Process $process */
$process = $this->runtime->runRemoteCommand($cmdCurrentRelease, false); $process = $this->runtime->runRemoteCommand($cmdCurrentRelease, false);
if (!$process->isSuccessful()) { if (!$process->isSuccessful()) {
throw new RuntimeException(sprintf('Unable to retrieve current release from host "%s"', $host), 85); throw new RuntimeException(
sprintf('Unable to retrieve current release from host "%s"', $host),
85
);
} }
$currentReleaseId = explode('/', trim($process->getOutput())); $currentReleaseId = explode('/', trim($process->getOutput()));
@ -121,7 +117,8 @@ class ListCommand extends AbstractCommand
foreach ($releases as $releaseId) { foreach ($releases as $releaseId) {
$releaseDate = $utils->getReleaseDate($releaseId); $releaseDate = $utils->getReleaseDate($releaseId);
$output->write(sprintf(' Release ID: <fg=magenta>%s</> - Date: <fg=black;options=bold>%s</> [%s]', $output->write(sprintf(
' Release ID: <fg=magenta>%s</> - Date: <fg=black;options=bold>%s</> [%s]',
$releaseId, $releaseId,
$releaseDate->format('Y-m-d H:i:s'), $releaseDate->format('Y-m-d H:i:s'),
$utils->getTimeDiff($releaseDate) $utils->getTimeDiff($releaseDate)
@ -146,6 +143,6 @@ class ListCommand extends AbstractCommand
$output->writeln('Finished <fg=blue>Magallanes</>'); $output->writeln('Finished <fg=blue>Magallanes</>');
return $this->statusCode; return intval($this->statusCode);
} }
} }

35
src/Command/BuiltIn/Releases/RollbackCommand.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -25,32 +26,22 @@ use Mage\Command\BuiltIn\DeployCommand;
*/ */
class RollbackCommand extends DeployCommand class RollbackCommand extends DeployCommand
{ {
/**
* @var int
*/
protected $statusCode = 0;
/** /**
* Configure the Command * Configure the Command
*/ */
protected function configure() protected function configure(): void
{ {
$this $this
->setName('releases:rollback') ->setName('releases:rollback')
->setDescription('Rollback to a release on an environment') ->setDescription('Rollback to a release on an environment')
->addArgument('environment', InputArgument::REQUIRED, 'Name of the environment to deploy to') ->addArgument('environment', InputArgument::REQUIRED, 'Name of the environment to deploy to')
->addArgument('release', InputArgument::REQUIRED, 'The ID or the Index of the release to rollback to') ->addArgument('release', InputArgument::REQUIRED, 'The ID or the Index of the release to rollback to');
;
} }
/** /**
* Execute the Command * Execute the Command
*
* @param InputInterface $input
* @param OutputInterface $output
* @return int|mixed
*/ */
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output): int
{ {
$this->requireConfig(); $this->requireConfig();
@ -68,11 +59,14 @@ class RollbackCommand extends DeployCommand
} }
$releaseToRollback = $input->getArgument('release'); $releaseToRollback = $input->getArgument('release');
if (($releaseId = $this->checkReleaseAvailability($releaseToRollback)) === false) { if ($this->checkReleaseAvailability($releaseToRollback) === false) {
throw new RuntimeException(sprintf('Release "%s" is not available on all hosts', $releaseToRollback), 72); throw new RuntimeException(
sprintf('Release "%s" is not available on all hosts', $releaseToRollback),
72
);
} }
$this->runtime->setReleaseId($releaseId)->setRollback(true); $this->runtime->setReleaseId($releaseToRollback)->setRollback(true);
$output->writeln(sprintf(' Environment: <fg=green>%s</>', $this->runtime->getEnvironment())); $output->writeln(sprintf(' Environment: <fg=green>%s</>', $this->runtime->getEnvironment()));
$this->log(sprintf('Environment: %s', $this->runtime->getEnvironment())); $this->log(sprintf('Environment: %s', $this->runtime->getEnvironment()));
@ -95,16 +89,13 @@ class RollbackCommand extends DeployCommand
$output->writeln('Finished <fg=blue>Magallanes</>'); $output->writeln('Finished <fg=blue>Magallanes</>');
return $this->statusCode; return intval($this->statusCode);
} }
/** /**
* Check if the provided Release ID is available in all hosts * Check if the provided Release ID is available in all hosts
*
* @param string $releaseToRollback Release ID
* @return bool
*/ */
protected function checkReleaseAvailability($releaseToRollback) protected function checkReleaseAvailability(string $releaseToRollback): bool
{ {
$hosts = $this->runtime->getEnvOption('hosts'); $hosts = $this->runtime->getEnvOption('hosts');
$hostPath = rtrim($this->runtime->getEnvOption('host_path'), '/'); $hostPath = rtrim($this->runtime->getEnvOption('host_path'), '/');
@ -132,7 +123,7 @@ class RollbackCommand extends DeployCommand
} }
if ($availableInHosts === count($hosts)) { if ($availableInHosts === count($hosts)) {
return $releaseToRollback; return (bool) $releaseToRollback;
} }
return false; return false;

14
src/Command/BuiltIn/VersionCommand.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -25,25 +26,20 @@ class VersionCommand extends AbstractCommand
/** /**
* Configure the Command * Configure the Command
*/ */
protected function configure() protected function configure(): void
{ {
$this $this
->setName('version') ->setName('version')
->setDescription('Get the version of Magallanes') ->setDescription('Get the version of Magallanes');
;
} }
/** /**
* Executes the Command * Executes the Command
*
* @param InputInterface $input
* @param OutputInterface $output
* @return int
*/ */
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output): int
{ {
$output->writeln(sprintf('Magallanes v%s [%s]', Mage::VERSION, Mage::CODENAME)); $output->writeln(sprintf('Magallanes v%s [%s]', Mage::VERSION, Mage::CODENAME));
return 0; return self::SUCCESS;
} }
} }

45
src/Deploy/Strategy/ReleasesStrategy.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -20,27 +21,28 @@ use Mage\Runtime\Runtime;
*/ */
class ReleasesStrategy implements StrategyInterface class ReleasesStrategy implements StrategyInterface
{ {
/** protected Runtime $runtime;
* @var Runtime
*/
protected $runtime;
public function getName() public function getName(): string
{ {
return 'Releases'; return 'Releases';
} }
public function setRuntime(Runtime $runtime) public function setRuntime(Runtime $runtime): void
{ {
$this->runtime = $runtime; $this->runtime = $runtime;
} }
public function getPreDeployTasks() public function getPreDeployTasks(): array
{ {
$this->checkStage(Runtime::PRE_DEPLOY); $this->checkStage(Runtime::PRE_DEPLOY);
$tasks = $this->runtime->getTasks(); $tasks = $this->runtime->getTasks();
if ($this->runtime->getBranch() && !$this->runtime->inRollback() && !in_array('git/change-branch', $tasks)) { if (
($this->runtime->getBranch() || $this->runtime->getTag()) &&
!$this->runtime->inRollback() &&
!in_array('git/change-branch', $tasks)
) {
array_unshift($tasks, 'git/change-branch'); array_unshift($tasks, 'git/change-branch');
} }
@ -51,7 +53,7 @@ class ReleasesStrategy implements StrategyInterface
return $tasks; return $tasks;
} }
public function getOnDeployTasks() public function getOnDeployTasks(): array
{ {
$this->checkStage(Runtime::ON_DEPLOY); $this->checkStage(Runtime::ON_DEPLOY);
$tasks = $this->runtime->getTasks(); $tasks = $this->runtime->getTasks();
@ -67,7 +69,7 @@ class ReleasesStrategy implements StrategyInterface
return $tasks; return $tasks;
} }
public function getOnReleaseTasks() public function getOnReleaseTasks(): array
{ {
$this->checkStage(Runtime::ON_RELEASE); $this->checkStage(Runtime::ON_RELEASE);
$tasks = $this->runtime->getTasks(); $tasks = $this->runtime->getTasks();
@ -79,7 +81,7 @@ class ReleasesStrategy implements StrategyInterface
return $tasks; return $tasks;
} }
public function getPostReleaseTasks() public function getPostReleaseTasks(): array
{ {
$this->checkStage(Runtime::POST_RELEASE); $this->checkStage(Runtime::POST_RELEASE);
$tasks = $this->runtime->getTasks(); $tasks = $this->runtime->getTasks();
@ -91,17 +93,21 @@ class ReleasesStrategy implements StrategyInterface
return $tasks; return $tasks;
} }
public function getPostDeployTasks() public function getPostDeployTasks(): array
{ {
$this->checkStage(Runtime::POST_DEPLOY); $this->checkStage(Runtime::POST_DEPLOY);
$tasks = $this->runtime->getTasks(); $tasks = $this->runtime->getTasks();
if (!$this->runtime->inRollback() && !in_array('deploy/tar/cleanup', $tasks)) { if (
array_unshift($tasks, 'deploy/tar/cleanup'); ($this->runtime->getBranch() || $this->runtime->getTag()) &&
!$this->runtime->inRollback() &&
!in_array('git/change-branch', $tasks)
) {
array_unshift($tasks, 'git/change-branch');
} }
if ($this->runtime->getBranch() && !$this->runtime->inRollback() && !in_array('git/change-branch', $tasks)) { if (!$this->runtime->inRollback() && !in_array('deploy/tar/cleanup', $tasks)) {
array_push($tasks, 'git/change-branch'); array_unshift($tasks, 'deploy/tar/cleanup');
} }
return $tasks; return $tasks;
@ -110,13 +116,14 @@ class ReleasesStrategy implements StrategyInterface
/** /**
* Check the runtime stage is correct * Check the runtime stage is correct
* *
* @param string $stage
* @throws RuntimeException * @throws RuntimeException
*/ */
private function checkStage($stage) private function checkStage(string $stage): void
{ {
if ($this->runtime->getStage() !== $stage) { if ($this->runtime->getStage() !== $stage) {
throw new RuntimeException(sprintf('Invalid stage, got "%s" but expected "%s"', $this->runtime->getStage(), $stage)); throw new RuntimeException(
sprintf('Invalid stage, got "%s" but expected "%s"', $this->runtime->getStage(), $stage)
);
} }
} }
} }

40
src/Deploy/Strategy/RsyncStrategy.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -20,34 +21,35 @@ use Mage\Runtime\Runtime;
*/ */
class RsyncStrategy implements StrategyInterface class RsyncStrategy implements StrategyInterface
{ {
/** protected Runtime $runtime;
* @var Runtime
*/
protected $runtime;
public function getName() public function getName(): string
{ {
return 'Rsync'; return 'Rsync';
} }
public function setRuntime(Runtime $runtime) public function setRuntime(Runtime $runtime): void
{ {
$this->runtime = $runtime; $this->runtime = $runtime;
} }
public function getPreDeployTasks() public function getPreDeployTasks(): array
{ {
$this->checkStage(Runtime::PRE_DEPLOY); $this->checkStage(Runtime::PRE_DEPLOY);
$tasks = $this->runtime->getTasks(); $tasks = $this->runtime->getTasks();
if ($this->runtime->getBranch() && !$this->runtime->inRollback() && !in_array('git/change-branch', $tasks)) { if (
($this->runtime->getBranch() || $this->runtime->getTag()) &&
!$this->runtime->inRollback() &&
!in_array('git/change-branch', $tasks)
) {
array_unshift($tasks, 'git/change-branch'); array_unshift($tasks, 'git/change-branch');
} }
return $tasks; return $tasks;
} }
public function getOnDeployTasks() public function getOnDeployTasks(): array
{ {
$this->checkStage(Runtime::ON_DEPLOY); $this->checkStage(Runtime::ON_DEPLOY);
$tasks = $this->runtime->getTasks(); $tasks = $this->runtime->getTasks();
@ -59,22 +61,27 @@ class RsyncStrategy implements StrategyInterface
return $tasks; return $tasks;
} }
public function getOnReleaseTasks() public function getOnReleaseTasks(): array
{ {
return []; return [];
} }
public function getPostReleaseTasks() public function getPostReleaseTasks(): array
{ {
return []; return [];
} }
public function getPostDeployTasks() public function getPostDeployTasks(): array
{ {
$this->checkStage(Runtime::POST_DEPLOY); $this->checkStage(Runtime::POST_DEPLOY);
$tasks = $this->runtime->getTasks(); $tasks = $this->runtime->getTasks();
if ($this->runtime->getBranch() && !$this->runtime->inRollback() && !in_array('git/change-branch', $tasks)) { if (
($this->runtime->getBranch() ||
$this->runtime->getTag()) &&
!$this->runtime->inRollback() &&
!in_array('git/change-branch', $tasks)
) {
array_push($tasks, 'git/change-branch'); array_push($tasks, 'git/change-branch');
} }
@ -84,13 +91,14 @@ class RsyncStrategy implements StrategyInterface
/** /**
* Check the runtime stage is correct * Check the runtime stage is correct
* *
* @param $stage
* @throws RuntimeException * @throws RuntimeException
*/ */
private function checkStage($stage) private function checkStage(string $stage): void
{ {
if ($this->runtime->getStage() !== $stage) { if ($this->runtime->getStage() !== $stage) {
throw new RuntimeException(sprintf('Invalid stage, got "%s" but expected "%s"', $this->runtime->getStage(), $stage)); throw new RuntimeException(
sprintf('Invalid stage, got "%s" but expected "%s"', $this->runtime->getStage(), $stage)
);
} }
} }
} }

30
src/Deploy/Strategy/StrategyInterface.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -19,17 +20,32 @@ use Mage\Runtime\Runtime;
*/ */
interface StrategyInterface interface StrategyInterface
{ {
public function getName(); public function getName(): string;
public function setRuntime(Runtime $runtime); public function setRuntime(Runtime $runtime): void;
public function getPreDeployTasks(); /**
* @return string[]
*/
public function getPreDeployTasks(): array;
public function getOnDeployTasks(); /**
* @return string[]
*/
public function getOnDeployTasks(): array;
public function getOnReleaseTasks(); /**
* @return string[]
*/
public function getOnReleaseTasks(): array;
public function getPostReleaseTasks(); /**
* @return string[]
*/
public function getPostReleaseTasks(): array;
public function getPostDeployTasks(); /**
* @return string[]
*/
public function getPostDeployTasks(): array;
} }

5
src/Mage.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -17,6 +18,6 @@ namespace Mage;
*/ */
class Mage class Mage
{ {
const VERSION = '4.1.1'; public const VERSION = '5.0.0';
const CODENAME = 'Discovery One'; public const CODENAME = 'Galactica';
} }

63
src/MageApplication.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -22,8 +23,8 @@ use Symfony\Component\Console\ConsoleEvents;
use Symfony\Component\Console\Application; use Symfony\Component\Console\Application;
use Symfony\Component\Yaml\Parser; use Symfony\Component\Yaml\Parser;
use Symfony\Component\Yaml\Exception\ParseException; use Symfony\Component\Yaml\Exception\ParseException;
use ReflectionClass;
use Mage\Runtime\Exception\RuntimeException; use Mage\Runtime\Exception\RuntimeException;
use Symfony\Component\Filesystem\Filesystem;
/** /**
* The Console Application for launching the Mage command in a standalone instance * The Console Application for launching the Mage command in a standalone instance
@ -32,13 +33,13 @@ use Mage\Runtime\Exception\RuntimeException;
*/ */
class MageApplication extends Application class MageApplication extends Application
{ {
protected $runtime; protected Runtime $runtime;
protected $file; protected string $file;
/** /**
* @param string $file The YAML file from which to read the configuration * @param string $file The YAML file from which to read the configuration
*/ */
public function __construct($file) public function __construct(string $file)
{ {
parent::__construct('Magallanes', Mage::VERSION); parent::__construct('Magallanes', Mage::VERSION);
@ -49,7 +50,9 @@ class MageApplication extends Application
$dispatcher->addListener(ConsoleEvents::ERROR, function (ConsoleErrorEvent $event) { $dispatcher->addListener(ConsoleEvents::ERROR, function (ConsoleErrorEvent $event) {
$output = $event->getOutput(); $output = $event->getOutput();
$command = $event->getCommand(); $command = $event->getCommand();
$output->writeln(sprintf('Oops, exception thrown while running command <info>%s</info>', $command->getName())); $output->writeln(
sprintf('Oops, exception thrown while running command <info>%s</info>', $command->getName())
);
$exitCode = $event->getExitCode(); $exitCode = $event->getExitCode();
$event->setError(new \LogicException('Caught exception', $exitCode, $event->getError())); $event->setError(new \LogicException('Caught exception', $exitCode, $event->getError()));
}); });
@ -63,7 +66,7 @@ class MageApplication extends Application
* *
* @throws RuntimeException * @throws RuntimeException
*/ */
public function configure() public function configure(): void
{ {
if (!file_exists($this->file) || !is_readable($this->file)) { if (!file_exists($this->file) || !is_readable($this->file)) {
throw new RuntimeException(sprintf('The file "%s" does not exists or is not readable.', $this->file)); throw new RuntimeException(sprintf('The file "%s" does not exists or is not readable.', $this->file));
@ -78,15 +81,25 @@ class MageApplication extends Application
if (array_key_exists('magephp', $config) && is_array($config['magephp'])) { if (array_key_exists('magephp', $config) && is_array($config['magephp'])) {
$logger = null; $logger = null;
if (array_key_exists('log_dir', $config['magephp']) && file_exists($config['magephp']['log_dir']) && is_dir($config['magephp']['log_dir'])) { if (
array_key_exists('log_dir', $config['magephp']) &&
file_exists($config['magephp']['log_dir']) && is_dir($config['magephp']['log_dir'])
) {
$logfile = sprintf('%s/%s.log', $config['magephp']['log_dir'], date('Ymd_His')); $logfile = sprintf('%s/%s.log', $config['magephp']['log_dir'], date('Ymd_His'));
$config['magephp']['log_file'] = $logfile; $config['magephp']['log_file'] = $logfile;
$logger = new Logger('magephp'); $logger = new Logger('magephp');
$logger->pushHandler(new StreamHandler($logfile)); $logger->pushHandler(new StreamHandler($logfile));
$logLimit = isset($config['magephp']['log_limit']) ? intval($config['magephp']['log_limit']) : 30;
$this->clearOldLogs($config['magephp']['log_dir'], $logLimit);
} elseif (array_key_exists('log_dir', $config['magephp']) && !is_dir($config['magephp']['log_dir'])) { } elseif (array_key_exists('log_dir', $config['magephp']) && !is_dir($config['magephp']['log_dir'])) {
throw new RuntimeException(sprintf('The configured log_dir "%s" does not exists or is not a directory.', $config['magephp']['log_dir'])); throw new RuntimeException(
sprintf(
'The configured log_dir "%s" does not exists or is not a directory.',
$config['magephp']['log_dir']
)
);
} }
$this->runtime->setConfiguration($config['magephp']); $this->runtime->setConfiguration($config['magephp']);
@ -94,13 +107,33 @@ class MageApplication extends Application
return; return;
} }
throw new RuntimeException(sprintf('The file "%s" does not have a valid Magallanes configuration.', $this->file)); throw new RuntimeException(
sprintf('The file "%s" does not have a valid Magallanes configuration.', $this->file)
);
}
protected function clearOldLogs(string $logDir, int $logLimit): void
{
$filesystem = new Filesystem();
$finder = new Finder();
$finder
->files()
->followLinks()
->in($logDir)
->name('*.log')
->sortByModifiedTime()
->reverseSorting();
$logs = iterator_to_array($finder);
$logsToRemove = array_slice($logs, $logLimit - 1);
$filesystem->remove($logsToRemove);
} }
/** /**
* Loads the BuiltIn Commands * Loads the BuiltIn Commands
*/ */
protected function loadBuiltInCommands() protected function loadBuiltInCommands(): void
{ {
$finder = new Finder(); $finder = new Finder();
$finder->files()->in(__DIR__ . '/Command/BuiltIn')->name('*Command.php'); $finder->files()->in(__DIR__ . '/Command/BuiltIn')->name('*Command.php');
@ -109,7 +142,7 @@ class MageApplication extends Application
foreach ($finder as $file) { foreach ($finder as $file) {
$class = substr('\\Mage\\Command\\BuiltIn\\' . str_replace('/', '\\', $file->getRelativePathname()), 0, -4); $class = substr('\\Mage\\Command\\BuiltIn\\' . str_replace('/', '\\', $file->getRelativePathname()), 0, -4);
if (class_exists($class)) { if (class_exists($class)) {
$reflex = new ReflectionClass($class); $reflex = new \ReflectionClass($class);
if ($reflex->isInstantiable()) { if ($reflex->isInstantiable()) {
$command = new $class(); $command = new $class();
if ($command instanceof AbstractCommand) { if ($command instanceof AbstractCommand) {
@ -123,20 +156,16 @@ class MageApplication extends Application
/** /**
* Gets the Runtime instance to use * Gets the Runtime instance to use
*
* @return Runtime
*/ */
protected function instantiateRuntime() protected function instantiateRuntime(): Runtime
{ {
return new Runtime(); return new Runtime();
} }
/** /**
* Get the Runtime instance * Get the Runtime instance
*
* @return Runtime
*/ */
public function getRuntime() public function getRuntime(): Runtime
{ {
return $this->runtime; return $this->runtime;
} }

5
src/Runtime/Exception/RuntimeException.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -10,13 +11,11 @@
namespace Mage\Runtime\Exception; namespace Mage\Runtime\Exception;
use Exception;
/** /**
* An Error occurred while running * An Error occurred while running
* *
* @author Andrés Montañez <andresmontanez@gmail.com> * @author Andrés Montañez <andresmontanez@gmail.com>
*/ */
class RuntimeException extends Exception class RuntimeException extends \Exception
{ {
} }

259
src/Runtime/Runtime.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -17,6 +18,7 @@ use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel; use Psr\Log\LogLevel;
use Symfony\Component\Process\Process; use Symfony\Component\Process\Process;
use Mage\Runtime\Exception\RuntimeException; use Mage\Runtime\Exception\RuntimeException;
use Mage\Task\AbstractTask;
/** /**
* Runtime is a container of all run in time configuration, stages of progress, hosts being deployed, etc. * Runtime is a container of all run in time configuration, stages of progress, hosts being deployed, etc.
@ -25,63 +27,63 @@ use Mage\Runtime\Exception\RuntimeException;
*/ */
class Runtime class Runtime
{ {
const PRE_DEPLOY = 'pre-deploy'; public const PRE_DEPLOY = 'pre-deploy';
const ON_DEPLOY = 'on-deploy'; public const ON_DEPLOY = 'on-deploy';
const POST_DEPLOY = 'post-deploy'; public const POST_DEPLOY = 'post-deploy';
const ON_RELEASE = 'on-release'; public const ON_RELEASE = 'on-release';
const POST_RELEASE = 'post-release'; public const POST_RELEASE = 'post-release';
/** /**
* @var array Magallanes configuration * @var array<string, mixed> Magallanes configuration
*/ */
protected $configuration = []; protected array $configuration = [];
/** /**
* @var string|null Environment being deployed * @var string|null Environment being deployed
*/ */
protected $environment; protected ?string $environment = null;
/** /**
* @var string Stage of Deployment * @var string|null Stage of Deployment
*/ */
protected $stage; protected ?string $stage = null;
/** /**
* @var string|null The host being deployed to * @var string|null The host being deployed to
*/ */
protected $workingHost = null; protected ?string $workingHost = null;
/** /**
* @var string|null The Release ID * @var string|null The Release ID
*/ */
protected $releaseId = null; protected ?string $releaseId = null;
/** /**
* @var array Hold a bag of variables for sharing information between tasks, if needed * @var array<string, string> Hold a bag of variables for sharing information between tasks, if needed
*/ */
protected $vars = []; protected $vars = [];
/** protected ?LoggerInterface $logger = null;
* @var LoggerInterface|null The logger instance
*/
protected $logger;
/** /**
* @var bool Indicates if a Rollback operation is in progress * @var bool Indicates if a Rollback operation is in progress
*/ */
protected $rollback = false; protected bool $rollback = false;
public function isWindows() public function isWindows(): bool
{ {
return stripos(PHP_OS, 'WIN') === 0; return stripos(PHP_OS, 'WIN') === 0;
} }
public function hasPosix(): bool
{
return function_exists('posix_getpwuid');
}
/** /**
* Generate the Release ID * Generate the Release ID
*
* @return Runtime
*/ */
public function generateReleaseId() public function generateReleaseId(): self
{ {
$this->setReleaseId(date('YmdHis')); $this->setReleaseId(date('YmdHis'));
return $this; return $this;
@ -89,11 +91,8 @@ class Runtime
/** /**
* Sets the Release ID * Sets the Release ID
*
* @param string $releaseId Release ID
* @return Runtime
*/ */
public function setReleaseId($releaseId) public function setReleaseId(string $releaseId): self
{ {
$this->releaseId = $releaseId; $this->releaseId = $releaseId;
return $this; return $this;
@ -101,21 +100,16 @@ class Runtime
/** /**
* Retrieve the current Release ID * Retrieve the current Release ID
*
* @return null|string Release ID
*/ */
public function getReleaseId() public function getReleaseId(): ?string
{ {
return $this->releaseId; return $this->releaseId;
} }
/** /**
* Sets the Runtime in Rollback mode On or Off * Sets the Runtime in Rollback mode On or Off
*
* @param bool $inRollback
* @return Runtime
*/ */
public function setRollback($inRollback) public function setRollback(bool $inRollback): self
{ {
$this->rollback = $inRollback; $this->rollback = $inRollback;
return $this; return $this;
@ -123,35 +117,25 @@ class Runtime
/** /**
* Indicates if Runtime is in rollback * Indicates if Runtime is in rollback
*
* @return bool
*/ */
public function inRollback() public function inRollback(): bool
{ {
return $this->rollback; return $this->rollback;
} }
/** /**
* Sets a value in the Vars bag * Sets a value in the Vars bag
*
* @param string $key Variable name
* @param string $value Variable value
* @return Runtime
*/ */
public function setVar($key, $value) public function setVar(string $key, string $value): self
{ {
$this->vars[$key] = $value; $this->vars[$key] = $value;
return $this; return $this;
} }
/** /**
* Retrieve a value from the Vars bag * Retrieve a value from the Vars bag, or a default (null) if not set
*
* @param string $key Variable name
* @param mixed $default Variable default value, returned if not found
* @return string
*/ */
public function getVar($key, $default = null) public function getVar(string $key, mixed $default = null): ?string
{ {
if (array_key_exists($key, $this->vars)) { if (array_key_exists($key, $this->vars)) {
return $this->vars[$key]; return $this->vars[$key];
@ -162,11 +146,8 @@ class Runtime
/** /**
* Sets the Logger instance * Sets the Logger instance
*
* @param LoggerInterface $logger Logger instance
* @return Runtime
*/ */
public function setLogger(LoggerInterface $logger = null) public function setLogger(?LoggerInterface $logger = null): self
{ {
$this->logger = $logger; $this->logger = $logger;
return $this; return $this;
@ -175,10 +156,9 @@ class Runtime
/** /**
* Sets the Magallanes Configuration to the Runtime * Sets the Magallanes Configuration to the Runtime
* *
* @param array $configuration Configuration * @param array<string, mixed> $configuration
* @return Runtime
*/ */
public function setConfiguration($configuration) public function setConfiguration(array $configuration): self
{ {
$this->configuration = $configuration; $this->configuration = $configuration;
return $this; return $this;
@ -187,21 +167,17 @@ class Runtime
/** /**
* Retrieve the Configuration * Retrieve the Configuration
* *
* @return array * @return array<string, mixed> $configuration
*/ */
public function getConfiguration() public function getConfiguration(): array
{ {
return $this->configuration; return $this->configuration;
} }
/** /**
* Retrieves the Configuration Option for a specific section in the configuration * Retrieves the Configuration Option for a specific section in the configuration
*
* @param string $key Section name
* @param mixed $default Default value
* @return mixed
*/ */
public function getConfigOption($key, $default = null) public function getConfigOption(string $key, mixed $default = null): mixed
{ {
if (array_key_exists($key, $this->configuration)) { if (array_key_exists($key, $this->configuration)) {
return $this->configuration[$key]; return $this->configuration[$key];
@ -212,14 +188,13 @@ class Runtime
/** /**
* Returns the Configuration Option for a specific section the current Environment * Returns the Configuration Option for a specific section the current Environment
*
* @param string $key Section/Parameter name
* @param mixed $default Default value
* @return mixed
*/ */
public function getEnvOption($key, $default = null) public function getEnvOption(string $key, mixed $default = null): mixed
{ {
if (!array_key_exists('environments', $this->configuration) || !is_array($this->configuration['environments'])) { if (
!array_key_exists('environments', $this->configuration) ||
!is_array($this->configuration['environments'])
) {
return $default; return $default;
} }
@ -238,12 +213,10 @@ class Runtime
* Shortcut to get the the configuration option for a specific environment and merge it with * Shortcut to get the the configuration option for a specific environment and merge it with
* the global one (environment specific overrides the global one if present). * the global one (environment specific overrides the global one if present).
* *
* @param $key * @param array<string, mixed> $defaultEnv
* @param array $defaultEnv * @return array<string, mixed>
*
* @return array
*/ */
public function getMergedOption($key, $defaultEnv = []) public function getMergedOption(string $key, array $defaultEnv = []): array
{ {
$userGlobalOptions = $this->getConfigOption($key, $defaultEnv); $userGlobalOptions = $this->getConfigOption($key, $defaultEnv);
$userEnvOptions = $this->getEnvOption($key, $defaultEnv); $userEnvOptions = $this->getEnvOption($key, $defaultEnv);
@ -256,12 +229,8 @@ class Runtime
/** /**
* Overwrites an Environment Configuration Option * Overwrites an Environment Configuration Option
*
* @param string $key
* @param mixed $value
* @return Runtime
*/ */
public function setEnvOption($key, $value) public function setEnvOption(string $key, mixed $value): self
{ {
if (array_key_exists('environments', $this->configuration) && is_array($this->configuration['environments'])) { if (array_key_exists('environments', $this->configuration) && is_array($this->configuration['environments'])) {
if (array_key_exists($this->environment, $this->configuration['environments'])) { if (array_key_exists($this->environment, $this->configuration['environments'])) {
@ -275,13 +244,14 @@ class Runtime
/** /**
* Sets the working Environment * Sets the working Environment
* *
* @param string $environment Environment name
* @return Runtime
* @throws RuntimeException * @throws RuntimeException
*/ */
public function setEnvironment($environment) public function setEnvironment(string $environment): self
{ {
if (array_key_exists('environments', $this->configuration) && array_key_exists($environment, $this->configuration['environments'])) { if (
array_key_exists('environments', $this->configuration) &&
array_key_exists($environment, $this->configuration['environments'])
) {
$this->environment = $environment; $this->environment = $environment;
return $this; return $this;
} }
@ -291,21 +261,16 @@ class Runtime
/** /**
* Returns the current working Environment * Returns the current working Environment
*
* @return null|string
*/ */
public function getEnvironment() public function getEnvironment(): ?string
{ {
return $this->environment; return $this->environment;
} }
/** /**
* Sets the working stage * Sets the working stage
*
* @param string $stage Stage code
* @return Runtime
*/ */
public function setStage($stage) public function setStage(string $stage): self
{ {
$this->stage = $stage; $this->stage = $stage;
return $this; return $this;
@ -313,10 +278,8 @@ class Runtime
/** /**
* Retrieve the current working Stage * Retrieve the current working Stage
*
* @return string
*/ */
public function getStage() public function getStage(): ?string
{ {
return $this->stage; return $this->stage;
} }
@ -324,11 +287,14 @@ class Runtime
/** /**
* Retrieve the defined Tasks for the current Environment and Stage * Retrieve the defined Tasks for the current Environment and Stage
* *
* @return array * @return string[]
*/ */
public function getTasks() public function getTasks(): array
{ {
if (!array_key_exists('environments', $this->configuration) || !is_array($this->configuration['environments'])) { if (
!array_key_exists('environments', $this->configuration) ||
!is_array($this->configuration['environments'])
) {
return []; return [];
} }
@ -347,11 +313,8 @@ class Runtime
/** /**
* Sets the working Host * Sets the working Host
*
* @param string $host Host name
* @return Runtime
*/ */
public function setWorkingHost($host) public function setWorkingHost(?string $host): self
{ {
$this->workingHost = $host; $this->workingHost = $host;
return $this; return $this;
@ -359,21 +322,16 @@ class Runtime
/** /**
* Retrieve the working Host * Retrieve the working Host
*
* @return null|string
*/ */
public function getWorkingHost() public function getWorkingHost(): ?string
{ {
return $this->workingHost; return $this->workingHost;
} }
/** /**
* Logs a Message into the Logger * Logs a Message into the Logger
*
* @param string $message Log message
* @param string $level Log Level
*/ */
public function log($message, $level = LogLevel::DEBUG) public function log(string $message, string $level = LogLevel::DEBUG): void
{ {
if ($this->logger instanceof LoggerInterface) { if ($this->logger instanceof LoggerInterface) {
$this->logger->log($level, $message); $this->logger->log($level, $message);
@ -382,12 +340,8 @@ class Runtime
/** /**
* Executes a command, it will be run Locally or Remotely based on the working Stage * Executes a command, it will be run Locally or Remotely based on the working Stage
*
* @param string $cmd Command to execute
* @param int $timeout Seconds to wait
* @return Process
*/ */
public function runCommand($cmd, $timeout = 120) public function runCommand(string $cmd, int $timeout = 120): Process
{ {
switch ($this->getStage()) { switch ($this->getStage()) {
case self::ON_DEPLOY: case self::ON_DEPLOY:
@ -401,12 +355,8 @@ class Runtime
/** /**
* Execute a command locally * Execute a command locally
*
* @param string $cmd Command to execute
* @param int $timeout Seconds to wait
* @return Process
*/ */
public function runLocalCommand($cmd, $timeout = 120) public function runLocalCommand(string $cmd, int $timeout = 120): Process
{ {
$this->log($cmd, LogLevel::INFO); $this->log($cmd, LogLevel::INFO);
@ -424,13 +374,8 @@ class Runtime
/** /**
* Executes a command remotely, if jail is true, it will run inside the Host Path and the Release (if available) * Executes a command remotely, if jail is true, it will run inside the Host Path and the Release (if available)
*
* @param string $cmd Command to execute
* @param bool $jail Jail the command
* @param int $timeout Seconds to wait
* @return Process
*/ */
public function runRemoteCommand($cmd, $jail, $timeout = 120) public function runRemoteCommand(string $cmd, bool $jail, int $timeout = 120): Process
{ {
$user = $this->getEnvOption('user', $this->getCurrentUser()); $user = $this->getEnvOption('user', $this->getCurrentUser());
$sudo = $this->getEnvOption('sudo', false); $sudo = $this->getEnvOption('sudo', false);
@ -450,7 +395,14 @@ class Runtime
} }
$cmdRemote = str_replace('"', '\"', $cmdDelegate); $cmdRemote = str_replace('"', '\"', $cmdDelegate);
$cmdLocal = sprintf('ssh -p %d %s %s@%s "%s"', $sshConfig['port'], $sshConfig['flags'], $user, $host, $cmdRemote); $cmdLocal = sprintf(
'ssh -p %d %s %s@%s "%s"',
$sshConfig['port'],
$sshConfig['flags'],
$user,
$host,
$cmdRemote
);
return $this->runLocalCommand($cmdLocal, $timeout); return $this->runLocalCommand($cmdLocal, $timeout);
} }
@ -458,11 +410,17 @@ class Runtime
/** /**
* Get the SSH configuration based on the environment * Get the SSH configuration based on the environment
* *
* @return array * @return array<string, string>
*/ */
public function getSSHConfig() public function getSSHConfig(): array
{ {
$sshConfig = $this->getEnvOption('ssh', ['port' => 22, 'flags' => '-q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no']); $sshConfig = $this->getEnvOption(
'ssh',
[
'port' => 22,
'flags' => '-q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no'
]
);
if ($this->getHostPort() !== null) { if ($this->getHostPort() !== null) {
$sshConfig['port'] = $this->getHostPort(); $sshConfig['port'] = $this->getHostPort();
@ -485,67 +443,72 @@ class Runtime
/** /**
* Get the current Host Port or default ssh port * Get the current Host Port or default ssh port
*
* @return integer
*/ */
public function getHostPort() public function getHostPort(): ?int
{ {
$info = explode(':', $this->getWorkingHost()); $info = explode(':', strval($this->getWorkingHost()));
return isset($info[1]) ? $info[1] : null; return isset($info[1]) ? intval($info[1]) : null;
} }
/** /**
* Get the current Host Name * Get the current Host Name
*
* @return string
*/ */
public function getHostName() public function getHostName(): ?string
{ {
if (strpos($this->getWorkingHost(), ':') === false) { if (strpos(strval($this->getWorkingHost()), ':') === false) {
return $this->getWorkingHost(); return $this->getWorkingHost();
} }
$info = explode(':', $this->getWorkingHost()); $info = explode(':', $this->getWorkingHost());
return $info[0]; return strval($info[0]);
} }
/** /**
* Gets a Temporal File name * Gets a Temporal File name
*
* @return string
*/ */
public function getTempFile() public function getTempFile(): string
{ {
return tempnam(sys_get_temp_dir(), 'mage'); return tempnam(sys_get_temp_dir(), 'mage');
} }
/** /**
* Get the current user * Get the current user
*
* @return string
*/ */
public function getCurrentUser() public function getCurrentUser(): string
{ {
$userData = posix_getpwuid(posix_geteuid()); if ($this->hasPosix()) {
return $userData['name']; $userData = posix_getpwuid(posix_geteuid());
return $userData['name'];
}
// Windows fallback
return strval(getenv('USERNAME'));
} }
/** /**
* Shortcut for getting Branch information * Shortcut for getting Branch information
* *
* @return boolean|string * @return bool|string
*/ */
public function getBranch() public function getBranch(): mixed
{ {
return $this->getEnvOption('branch', false); return $this->getEnvOption('branch', false);
} }
/** /**
* Guesses the Deploy Strategy to use * Shortcut for getting Tag information
* *
* @return StrategyInterface * @return bool|string
*/ */
public function guessStrategy() public function getTag(): mixed
{
return $this->getEnvOption('tag', false);
}
/**
* Guesses the Deploy Strategy to use
*/
public function guessStrategy(): StrategyInterface
{ {
$strategy = new RsyncStrategy(); $strategy = new RsyncStrategy();

43
src/Task/AbstractTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -19,60 +20,41 @@ use Mage\Runtime\Runtime;
*/ */
abstract class AbstractTask abstract class AbstractTask
{ {
/** /** @var array<string, string|int|null> */
* @var array Task custom options protected array $options = [];
*/
protected $options = [];
/** protected Runtime $runtime;
* @var Runtime
*/
protected $runtime;
/** /**
* Get the Name/Code of the Task * Get the Name/Code of the Task
*
* @return string
*/ */
abstract public function getName(); abstract public function getName(): string;
/** /**
* Get a short Description of the Task * Get a short Description of the Task
*
* @return string
*/ */
abstract public function getDescription(); abstract public function getDescription(): string;
/** /**
* Executes the Command * Executes the Command
*
* @return bool
*/ */
abstract public function execute(); abstract public function execute(): bool;
/** /**
* Set additional Options for the Task * Set additional Options for the Task
* *
* @param array $options Options * @param array<string, string|int|null> $options
* @return AbstractTask
*/ */
public function setOptions($options = []) public function setOptions(array $options = []): self
{ {
if (!is_array($options)) {
$options = [];
}
$this->options = array_merge($this->getDefaults(), $options); $this->options = array_merge($this->getDefaults(), $options);
return $this; return $this;
} }
/** /**
* Set the Runtime instance * Set the Runtime instance
*
* @param Runtime $runtime
* @return AbstractTask
*/ */
public function setRuntime(Runtime $runtime) public function setRuntime(Runtime $runtime): self
{ {
$this->runtime = $runtime; $this->runtime = $runtime;
return $this; return $this;
@ -80,9 +62,10 @@ abstract class AbstractTask
/** /**
* Return Default options * Return Default options
* @return array *
* @return array<string, string|int|null>
*/ */
public function getDefaults() public function getDefaults(): array
{ {
return []; return [];
} }

11
src/Task/BuiltIn/Composer/AbstractComposerTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -19,7 +20,10 @@ use Mage\Task\AbstractTask;
*/ */
abstract class AbstractComposerTask extends AbstractTask abstract class AbstractComposerTask extends AbstractTask
{ {
protected function getOptions() /**
* @return string[]
*/
protected function getOptions(): array
{ {
$options = array_merge( $options = array_merge(
['path' => 'composer'], ['path' => 'composer'],
@ -31,7 +35,10 @@ abstract class AbstractComposerTask extends AbstractTask
return $options; return $options;
} }
protected function getComposerOptions() /**
* @return array<string, string|int>
*/
protected function getComposerOptions(): array
{ {
return []; return [];
} }

9
src/Task/BuiltIn/Composer/DumpAutoloadTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -19,17 +20,17 @@ use Symfony\Component\Process\Process;
*/ */
class DumpAutoloadTask extends AbstractComposerTask class DumpAutoloadTask extends AbstractComposerTask
{ {
public function getName() public function getName(): string
{ {
return 'composer/dump-autoload'; return 'composer/dump-autoload';
} }
public function getDescription() public function getDescription(): string
{ {
return '[Composer] Dump Autoload'; return '[Composer] Dump Autoload';
} }
public function execute() public function execute(): bool
{ {
$options = $this->getOptions(); $options = $this->getOptions();
$cmd = sprintf('%s dump-autoload %s', $options['path'], $options['flags']); $cmd = sprintf('%s dump-autoload %s', $options['path'], $options['flags']);
@ -40,7 +41,7 @@ class DumpAutoloadTask extends AbstractComposerTask
return $process->isSuccessful(); return $process->isSuccessful();
} }
protected function getComposerOptions() protected function getComposerOptions(): array
{ {
return ['flags' => '--optimize']; return ['flags' => '--optimize'];
} }

11
src/Task/BuiltIn/Composer/InstallTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -19,28 +20,28 @@ use Symfony\Component\Process\Process;
*/ */
class InstallTask extends AbstractComposerTask class InstallTask extends AbstractComposerTask
{ {
public function getName() public function getName(): string
{ {
return 'composer/install'; return 'composer/install';
} }
public function getDescription() public function getDescription(): string
{ {
return '[Composer] Install'; return '[Composer] Install';
} }
public function execute() public function execute(): bool
{ {
$options = $this->getOptions(); $options = $this->getOptions();
$cmd = sprintf('%s install %s', $options['path'], $options['flags']); $cmd = sprintf('%s install %s', $options['path'], $options['flags']);
/** @var Process $process */ /** @var Process $process */
$process = $this->runtime->runCommand(trim($cmd), $options['timeout']); $process = $this->runtime->runCommand(trim($cmd), intval($options['timeout']));
return $process->isSuccessful(); return $process->isSuccessful();
} }
protected function getComposerOptions() protected function getComposerOptions(): array
{ {
return ['flags' => '--optimize-autoloader', 'timeout' => 120]; return ['flags' => '--optimize-autoloader', 'timeout' => 120];
} }

86
src/Task/BuiltIn/Composer/SelfUpdateTask.php
View file

@ -1,86 +0,0 @@
<?php
/*
* This file is part of the Magallanes package.
*
* (c) Andrés Montañez <andres@andresmontanez.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Mage\Task\BuiltIn\Composer;
use Mage\Task\Exception\SkipException;
use Symfony\Component\Process\Process;
use DateTime;
/**
* Composer Task - Self update
*
* @author Yanick Witschi <https://github.com/Toflar>
*/
class SelfUpdateTask extends AbstractComposerTask
{
public function getName()
{
return 'composer/self-update';
}
public function getDescription()
{
return '[Composer] Self Update';
}
public function execute()
{
$options = $this->getOptions();
$cmdVersion = sprintf('%s --version', $options['path']);
/** @var Process $process */
$process = $this->runtime->runCommand(trim($cmdVersion));
if (!$process->isSuccessful()) {
return false;
}
$buildDate = $this->getBuildDate($process->getOutput());
if (!$buildDate instanceof DateTime) {
return false;
}
$compareDate = $this->getCompareDate();
if ($buildDate >= $compareDate) {
throw new SkipException();
}
$cmdUpdate = sprintf('%s self-update', $options['path']);
/** @var Process $process */
$process = $this->runtime->runCommand(trim($cmdUpdate));
return $process->isSuccessful();
}
protected function getBuildDate($output)
{
$buildDate = null;
$output = explode("\n", $output);
foreach ($output as $row) {
if (strpos($row, 'Composer version ') === 0) {
$buildDate = DateTime::createFromFormat('Y-m-d H:i:s', substr(trim($row), -19));
}
}
return $buildDate;
}
protected function getCompareDate()
{
$options = $this->getOptions();
$compareDate = new DateTime();
$compareDate->modify(sprintf('now -%d days', $options['days']));
return $compareDate;
}
protected function getComposerOptions()
{
return ['days' => 60];
}
}

9
src/Task/BuiltIn/Deploy/Release/CleanupTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -20,17 +21,17 @@ use Mage\Task\AbstractTask;
*/ */
class CleanupTask extends AbstractTask class CleanupTask extends AbstractTask
{ {
public function getName() public function getName(): string
{ {
return 'deploy/release/cleanup'; return 'deploy/release/cleanup';
} }
public function getDescription() public function getDescription(): string
{ {
return '[Release] Cleaning up old Releases'; return '[Release] Cleaning up old Releases';
} }
public function execute() public function execute(): bool
{ {
$hostPath = rtrim($this->runtime->getEnvOption('host_path'), '/'); $hostPath = rtrim($this->runtime->getEnvOption('host_path'), '/');
$currentReleaseId = $this->runtime->getReleaseId(); $currentReleaseId = $this->runtime->getReleaseId();
@ -48,7 +49,7 @@ class CleanupTask extends AbstractTask
sort($releases); sort($releases);
$releasesToDelete = array_slice($releases, 0, count($releases) - $maxReleases); $releasesToDelete = array_slice($releases, 0, count($releases) - $maxReleases);
foreach ($releasesToDelete as $releaseId) { foreach ($releasesToDelete as $releaseId) {
if ($releaseId != $currentReleaseId) { if ($releaseId !== $currentReleaseId) {
$cmdDeleteRelease = sprintf('rm -rf %s/releases/%s', $hostPath, $releaseId); $cmdDeleteRelease = sprintf('rm -rf %s/releases/%s', $hostPath, $releaseId);
/** @var Process $process */ /** @var Process $process */
$process = $this->runtime->runRemoteCommand($cmdDeleteRelease, false); $process = $this->runtime->runRemoteCommand($cmdDeleteRelease, false);

7
src/Task/BuiltIn/Deploy/Release/PrepareTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -20,17 +21,17 @@ use Mage\Task\AbstractTask;
*/ */
class PrepareTask extends AbstractTask class PrepareTask extends AbstractTask
{ {
public function getName() public function getName(): string
{ {
return 'deploy/release/prepare'; return 'deploy/release/prepare';
} }
public function getDescription() public function getDescription(): string
{ {
return '[Release] Preparing Release'; return '[Release] Preparing Release';
} }
public function execute() public function execute(): bool
{ {
$hostPath = rtrim($this->runtime->getEnvOption('host_path'), '/'); $hostPath = rtrim($this->runtime->getEnvOption('host_path'), '/');

13
src/Task/BuiltIn/Deploy/ReleaseTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -22,17 +23,17 @@ use Mage\Task\AbstractTask;
*/ */
class ReleaseTask extends AbstractTask implements ExecuteOnRollbackInterface class ReleaseTask extends AbstractTask implements ExecuteOnRollbackInterface
{ {
public function getName() public function getName(): string
{ {
return 'deploy/release'; return 'deploy/release';
} }
public function getDescription() public function getDescription(): string
{ {
return '[Release] Creating Symlink'; return '[Release] Creating Symlink';
} }
public function execute() public function execute(): bool
{ {
if (!$this->runtime->getEnvOption('releases', false)) { if (!$this->runtime->getEnvOption('releases', false)) {
throw new ErrorException('This task is only available with releases enabled', 40); throw new ErrorException('This task is only available with releases enabled', 40);
@ -41,10 +42,12 @@ class ReleaseTask extends AbstractTask implements ExecuteOnRollbackInterface
$hostPath = rtrim($this->runtime->getEnvOption('host_path'), '/'); $hostPath = rtrim($this->runtime->getEnvOption('host_path'), '/');
$releaseId = $this->runtime->getReleaseId(); $releaseId = $this->runtime->getReleaseId();
$cmdLinkRelease = sprintf('cd %s && ln -snf releases/%s current', $hostPath, $releaseId); $symlink = $this->runtime->getEnvOption('symlink', 'current');
$cmdLinkRelease = sprintf('cd %s && ln -snf releases/%s %s', $hostPath, $releaseId, $symlink);
/** @var Process $process */ /** @var Process $process */
$process = $this->runtime->runRemoteCommand($cmdLinkRelease, false, null); $process = $this->runtime->runRemoteCommand($cmdLinkRelease, false, 0);
return $process->isSuccessful(); return $process->isSuccessful();
} }
} }

23
src/Task/BuiltIn/Deploy/RsyncTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -21,17 +22,17 @@ use Mage\Task\AbstractTask;
*/ */
class RsyncTask extends AbstractTask class RsyncTask extends AbstractTask
{ {
public function getName() public function getName(): string
{ {
return 'deploy/rsync'; return 'deploy/rsync';
} }
public function getDescription() public function getDescription(): string
{ {
return '[Deploy] Copying files with Rsync'; return '[Deploy] Copying files with Rsync';
} }
public function execute() public function execute(): bool
{ {
$flags = $this->runtime->getEnvOption('rsync', '-avz'); $flags = $this->runtime->getEnvOption('rsync', '-avz');
$sshConfig = $this->runtime->getSSHConfig(); $sshConfig = $this->runtime->getSSHConfig();
@ -46,14 +47,24 @@ class RsyncTask extends AbstractTask
$excludes = $this->getExcludes(); $excludes = $this->getExcludes();
$from = $this->runtime->getEnvOption('from', './'); $from = $this->runtime->getEnvOption('from', './');
$cmdRsync = sprintf('rsync -e "ssh -p %d %s" %s %s %s %s@%s:%s', $sshConfig['port'], $sshConfig['flags'], $flags, $excludes, $from, $user, $host, $targetDir); $cmdRsync = sprintf(
'rsync -e "ssh -p %d %s" %s %s %s %s@%s:%s',
$sshConfig['port'],
$sshConfig['flags'],
$flags,
$excludes,
$from,
$user,
$host,
$targetDir
);
/** @var Process $process */ /** @var Process $process */
$process = $this->runtime->runLocalCommand($cmdRsync, null); $process = $this->runtime->runLocalCommand($cmdRsync, 0);
return $process->isSuccessful(); return $process->isSuccessful();
} }
protected function getExcludes() protected function getExcludes(): string
{ {
$excludes = $this->runtime->getMergedOption('exclude', []); $excludes = $this->runtime->getMergedOption('exclude', []);
$excludes = array_merge(['.git'], array_filter($excludes)); $excludes = array_merge(['.git'], array_filter($excludes));

7
src/Task/BuiltIn/Deploy/Tar/CleanupTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -21,17 +22,17 @@ use Mage\Task\AbstractTask;
*/ */
class CleanupTask extends AbstractTask class CleanupTask extends AbstractTask
{ {
public function getName() public function getName(): string
{ {
return 'deploy/tar/cleanup'; return 'deploy/tar/cleanup';
} }
public function getDescription() public function getDescription(): string
{ {
return '[Deploy] Cleanup Tar file'; return '[Deploy] Cleanup Tar file';
} }
public function execute() public function execute(): bool
{ {
if (!$this->runtime->getEnvOption('releases', false)) { if (!$this->runtime->getEnvOption('releases', false)) {
throw new ErrorException('This task is only available with releases enabled', 40); throw new ErrorException('This task is only available with releases enabled', 40);

20
src/Task/BuiltIn/Deploy/Tar/CopyTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -21,17 +22,17 @@ use Mage\Task\AbstractTask;
*/ */
class CopyTask extends AbstractTask class CopyTask extends AbstractTask
{ {
public function getName() public function getName(): string
{ {
return 'deploy/tar/copy'; return 'deploy/tar/copy';
} }
public function getDescription() public function getDescription(): string
{ {
return '[Deploy] Copying files with Tar'; return '[Deploy] Copying files with Tar';
} }
public function execute() public function execute(): bool
{ {
if (!$this->runtime->getEnvOption('releases', false)) { if (!$this->runtime->getEnvOption('releases', false)) {
throw new ErrorException('This task is only available with releases enabled', 40); throw new ErrorException('This task is only available with releases enabled', 40);
@ -50,10 +51,19 @@ class CopyTask extends AbstractTask
$tarLocal = $this->runtime->getVar('tar_local'); $tarLocal = $this->runtime->getVar('tar_local');
$tarRemote = basename($tarLocal); $tarRemote = basename($tarLocal);
$cmdCopy = sprintf('scp -P %d %s %s %s@%s:%s/%s', $sshConfig['port'], $sshConfig['flags'], $tarLocal, $user, $host, $targetDir, $tarRemote); $cmdCopy = sprintf(
'scp -P %d %s %s %s@%s:%s/%s',
$sshConfig['port'],
isset($sshConfig['scp_flags']) ? $sshConfig['scp_flags'] : $sshConfig['flags'],
$tarLocal,
$user,
$host,
$targetDir,
$tarRemote
);
/** @var Process $process */ /** @var Process $process */
$process = $this->runtime->runLocalCommand($cmdCopy, $sshConfig['timeout']); $process = $this->runtime->runLocalCommand($cmdCopy, intval($sshConfig['timeout']));
if ($process->isSuccessful()) { if ($process->isSuccessful()) {
$cmdUnTar = sprintf('cd %s && %s %s %s', $targetDir, $tarPath, $flags, $tarRemote); $cmdUnTar = sprintf('cd %s && %s %s %s', $targetDir, $tarPath, $flags, $tarRemote);
$process = $this->runtime->runRemoteCommand($cmdUnTar, false, 600); $process = $this->runtime->runRemoteCommand($cmdUnTar, false, 600);

14
src/Task/BuiltIn/Deploy/Tar/PrepareTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -21,17 +22,17 @@ use Mage\Task\AbstractTask;
*/ */
class PrepareTask extends AbstractTask class PrepareTask extends AbstractTask
{ {
public function getName() public function getName(): string
{ {
return 'deploy/tar/prepare'; return 'deploy/tar/prepare';
} }
public function getDescription() public function getDescription(): string
{ {
return '[Deploy] Preparing Tar file'; return '[Deploy] Preparing Tar file';
} }
public function execute() public function execute(): bool
{ {
if (!$this->runtime->getEnvOption('releases', false)) { if (!$this->runtime->getEnvOption('releases', false)) {
throw new ErrorException('This task is only available with releases enabled', 40); throw new ErrorException('This task is only available with releases enabled', 40);
@ -42,7 +43,10 @@ class PrepareTask extends AbstractTask
$excludes = $this->getExcludes(); $excludes = $this->getExcludes();
$tarPath = $this->runtime->getEnvOption('tar_create_path', 'tar'); $tarPath = $this->runtime->getEnvOption('tar_create_path', 'tar');
$flags = $this->runtime->getEnvOption('tar_create', $this->runtime->isWindows() ? '--force-local -c -z -p -f' : 'cfzp'); $flags = $this->runtime->getEnvOption(
'tar_create',
$this->runtime->isWindows() ? '--force-local -c -z -p -f' : 'cfzp'
);
$from = $this->runtime->getEnvOption('from', './'); $from = $this->runtime->getEnvOption('from', './');
if ($this->runtime->getEnvOption('copyDirectory', false)) { if ($this->runtime->getEnvOption('copyDirectory', false)) {
@ -56,7 +60,7 @@ class PrepareTask extends AbstractTask
return $process->isSuccessful(); return $process->isSuccessful();
} }
protected function getExcludes() protected function getExcludes(): string
{ {
$excludes = $this->runtime->getMergedOption('exclude', []); $excludes = $this->runtime->getMergedOption('exclude', []);
$excludes = array_merge(['.git'], array_filter($excludes)); $excludes = array_merge(['.git'], array_filter($excludes));

27
src/Task/BuiltIn/ExecTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -24,7 +25,7 @@ class ExecTask extends AbstractTask
/** /**
* @return string * @return string
*/ */
public function getName() public function getName(): string
{ {
return 'exec'; return 'exec';
} }
@ -32,7 +33,7 @@ class ExecTask extends AbstractTask
/** /**
* @return string * @return string
*/ */
public function getDescription() public function getDescription(): string
{ {
$options = $this->getOptions(); $options = $this->getOptions();
@ -48,7 +49,7 @@ class ExecTask extends AbstractTask
* *
* @throws ErrorException * @throws ErrorException
*/ */
public function execute() public function execute(): bool
{ {
$options = $this->getOptions(); $options = $this->getOptions();
@ -56,15 +57,29 @@ class ExecTask extends AbstractTask
throw new ErrorException('Parameter "cmd" is not defined'); throw new ErrorException('Parameter "cmd" is not defined');
} }
$mapping = [
'%environment%' => $this->runtime->getEnvironment(),
];
if ($this->runtime->getReleaseId() !== null) {
$mapping['%release%'] = $this->runtime->getReleaseId();
}
$cmd = str_replace(
array_keys($mapping),
array_values($mapping),
strval($options['cmd'])
);
/** @var Process $process */ /** @var Process $process */
$process = $this->runtime->runCommand($options['cmd'], $options['timeout']); $process = $this->runtime->runCommand($cmd, intval($options['timeout']));
return $process->isSuccessful(); return $process->isSuccessful();
} }
/** /**
* @return array * @return array<string, string|int>
*/ */
protected function getOptions() protected function getOptions(): array
{ {
$options = array_merge( $options = array_merge(
['cmd' => '', 'desc' => '', 'timeout' => 120], ['cmd' => '', 'desc' => '', 'timeout' => 120],

15
src/Task/BuiltIn/FS/AbstractFileTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -23,10 +24,10 @@ abstract class AbstractFileTask extends AbstractTask
/** /**
* Returns the Task options * Returns the Task options
* *
* @return array * @return array<string, string|int|null>
* @throws ErrorException * @throws ErrorException
*/ */
protected function getOptions() protected function getOptions(): array
{ {
$mandatory = $this->getParameters(); $mandatory = $this->getParameters();
$defaults = array_keys($this->getDefaults()); $defaults = array_keys($this->getDefaults());
@ -44,18 +45,16 @@ abstract class AbstractFileTask extends AbstractTask
/** /**
* Returns the mandatory parameters * Returns the mandatory parameters
* *
* @return array * @return string[]
*/ */
abstract protected function getParameters(); abstract protected function getParameters(): array;
/** /**
* Returns a file with the placeholders replaced * Returns a file with the placeholders replaced
* *
* @param string $file
* @return string
* @throws ErrorException * @throws ErrorException
*/ */
protected function getFile($file) protected function getFile(string $file): string
{ {
$mapping = [ $mapping = [
'%environment%' => $this->runtime->getEnvironment(), '%environment%' => $this->runtime->getEnvironment(),
@ -73,7 +72,7 @@ abstract class AbstractFileTask extends AbstractTask
return str_replace( return str_replace(
array_keys($mapping), array_keys($mapping),
array_values($mapping), array_values($mapping),
$options[$file] strval($options[$file])
); );
} }
} }

14
src/Task/BuiltIn/FS/ChangeModeTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -11,7 +12,6 @@
namespace Mage\Task\BuiltIn\FS; namespace Mage\Task\BuiltIn\FS;
use Symfony\Component\Process\Process; use Symfony\Component\Process\Process;
use Exception;
/** /**
* File System Task - Copy a File * File System Task - Copy a File
@ -20,21 +20,21 @@ use Exception;
*/ */
class ChangeModeTask extends AbstractFileTask class ChangeModeTask extends AbstractFileTask
{ {
public function getName() public function getName(): string
{ {
return 'fs/chmod'; return 'fs/chmod';
} }
public function getDescription() public function getDescription(): string
{ {
try { try {
return sprintf('[FS] Change mode of "%s" to "%s"', $this->getFile('file'), $this->options['mode']); return sprintf('[FS] Change mode of "%s" to "%s"', $this->getFile('file'), $this->options['mode']);
} catch (Exception $exception) { } catch (\Exception $exception) {
return '[FS] Chmod [missing parameters]'; return '[FS] Chmod [missing parameters]';
} }
} }
public function execute() public function execute(): bool
{ {
$file = $this->getFile('file'); $file = $this->getFile('file');
$mode = $this->options['mode']; $mode = $this->options['mode'];
@ -48,12 +48,12 @@ class ChangeModeTask extends AbstractFileTask
return $process->isSuccessful(); return $process->isSuccessful();
} }
protected function getParameters() protected function getParameters(): array
{ {
return ['file', 'mode', 'flags']; return ['file', 'mode', 'flags'];
} }
public function getDefaults() public function getDefaults(): array
{ {
return ['flags' => null]; return ['flags' => null];
} }

14
src/Task/BuiltIn/FS/CopyTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -11,7 +12,6 @@
namespace Mage\Task\BuiltIn\FS; namespace Mage\Task\BuiltIn\FS;
use Symfony\Component\Process\Process; use Symfony\Component\Process\Process;
use Exception;
/** /**
* File System Task - Copy a File * File System Task - Copy a File
@ -20,21 +20,21 @@ use Exception;
*/ */
class CopyTask extends AbstractFileTask class CopyTask extends AbstractFileTask
{ {
public function getName() public function getName(): string
{ {
return 'fs/copy'; return 'fs/copy';
} }
public function getDescription() public function getDescription(): string
{ {
try { try {
return sprintf('[FS] Copy "%s" to "%s"', $this->getFile('from'), $this->getFile('to')); return sprintf('[FS] Copy "%s" to "%s"', $this->getFile('from'), $this->getFile('to'));
} catch (Exception $exception) { } catch (\Exception $exception) {
return '[FS] Copy [missing parameters]'; return '[FS] Copy [missing parameters]';
} }
} }
public function execute() public function execute(): bool
{ {
$copyFrom = $this->getFile('from'); $copyFrom = $this->getFile('from');
$copyTo = $this->getFile('to'); $copyTo = $this->getFile('to');
@ -48,12 +48,12 @@ class CopyTask extends AbstractFileTask
return $process->isSuccessful(); return $process->isSuccessful();
} }
protected function getParameters() protected function getParameters(): array
{ {
return ['from', 'to', 'flags']; return ['from', 'to', 'flags'];
} }
public function getDefaults() public function getDefaults(): array
{ {
return ['flags' => '-p']; return ['flags' => '-p'];
} }

14
src/Task/BuiltIn/FS/LinkTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -11,7 +12,6 @@
namespace Mage\Task\BuiltIn\FS; namespace Mage\Task\BuiltIn\FS;
use Symfony\Component\Process\Process; use Symfony\Component\Process\Process;
use Exception;
/** /**
* File System Task - Symlink a File * File System Task - Symlink a File
@ -20,21 +20,21 @@ use Exception;
*/ */
class LinkTask extends AbstractFileTask class LinkTask extends AbstractFileTask
{ {
public function getName() public function getName(): string
{ {
return 'fs/link'; return 'fs/link';
} }
public function getDescription() public function getDescription(): string
{ {
try { try {
return sprintf('[FS] Link "%s" to "%s"', $this->getFile('from'), $this->getFile('to')); return sprintf('[FS] Link "%s" to "%s"', $this->getFile('from'), $this->getFile('to'));
} catch (Exception $exception) { } catch (\Exception $exception) {
return '[FS] Link [missing parameters]'; return '[FS] Link [missing parameters]';
} }
} }
public function execute() public function execute(): bool
{ {
$linkFrom = $this->getFile('from'); $linkFrom = $this->getFile('from');
$linkTo = $this->getFile('to'); $linkTo = $this->getFile('to');
@ -48,12 +48,12 @@ class LinkTask extends AbstractFileTask
return $process->isSuccessful(); return $process->isSuccessful();
} }
protected function getParameters() protected function getParameters(): array
{ {
return ['from', 'to', 'flags']; return ['from', 'to', 'flags'];
} }
public function getDefaults() public function getDefaults(): array
{ {
return ['flags' => '-snf']; return ['flags' => '-snf'];
} }

11
src/Task/BuiltIn/FS/MoveTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -20,12 +21,12 @@ use Exception;
*/ */
class MoveTask extends AbstractFileTask class MoveTask extends AbstractFileTask
{ {
public function getName() public function getName(): string
{ {
return 'fs/move'; return 'fs/move';
} }
public function getDescription() public function getDescription(): string
{ {
try { try {
return sprintf('[FS] Move "%s" to "%s"', $this->getFile('from'), $this->getFile('to')); return sprintf('[FS] Move "%s" to "%s"', $this->getFile('from'), $this->getFile('to'));
@ -34,7 +35,7 @@ class MoveTask extends AbstractFileTask
} }
} }
public function execute() public function execute(): bool
{ {
$moveFrom = $this->getFile('from'); $moveFrom = $this->getFile('from');
$moveTo = $this->getFile('to'); $moveTo = $this->getFile('to');
@ -48,12 +49,12 @@ class MoveTask extends AbstractFileTask
return $process->isSuccessful(); return $process->isSuccessful();
} }
protected function getParameters() protected function getParameters(): array
{ {
return ['from', 'to', 'flags']; return ['from', 'to', 'flags'];
} }
public function getDefaults() public function getDefaults(): array
{ {
return ['flags' => null]; return ['flags' => null];
} }

14
src/Task/BuiltIn/FS/RemoveTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -11,7 +12,6 @@
namespace Mage\Task\BuiltIn\FS; namespace Mage\Task\BuiltIn\FS;
use Symfony\Component\Process\Process; use Symfony\Component\Process\Process;
use Exception;
/** /**
* File System Task - Remove a File * File System Task - Remove a File
@ -20,21 +20,21 @@ use Exception;
*/ */
class RemoveTask extends AbstractFileTask class RemoveTask extends AbstractFileTask
{ {
public function getName() public function getName(): string
{ {
return 'fs/remove'; return 'fs/remove';
} }
public function getDescription() public function getDescription(): string
{ {
try { try {
return sprintf('[FS] Remove "%s"', $this->getFile('file')); return sprintf('[FS] Remove "%s"', $this->getFile('file'));
} catch (Exception $exception) { } catch (\Exception $exception) {
return '[FS] Remove [missing parameters]'; return '[FS] Remove [missing parameters]';
} }
} }
public function execute() public function execute(): bool
{ {
$file = $this->getFile('file'); $file = $this->getFile('file');
$flags = $this->options['flags']; $flags = $this->options['flags'];
@ -47,12 +47,12 @@ class RemoveTask extends AbstractFileTask
return $process->isSuccessful(); return $process->isSuccessful();
} }
protected function getParameters() protected function getParameters(): array
{ {
return ['file', 'flags']; return ['file', 'flags'];
} }
public function getDefaults() public function getDefaults(): array
{ {
return ['flags' => null]; return ['flags' => null];
} }

31
src/Task/BuiltIn/Git/ChangeBranchTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -21,29 +22,35 @@ use Mage\Task\AbstractTask;
*/ */
class ChangeBranchTask extends AbstractTask class ChangeBranchTask extends AbstractTask
{ {
public function getName() public function getName(): string
{ {
return 'git/change-branch'; return 'git/change-branch';
} }
public function getDescription() public function getDescription(): string
{ {
$options = $this->getOptions(); $options = $this->getOptions();
$tag = $options['tag'];
$branch = $options['branch']; $branch = $options['branch'];
if ($this->runtime->getVar('git_revert_branch', false)) { if ($this->runtime->getVar('git_revert_branch', null)) {
$branch = $this->runtime->getVar('git_revert_branch'); $branch = $this->runtime->getVar('git_revert_branch');
} }
if ($tag) {
return sprintf('[Git] Checkout Tag (%s)', $tag);
}
return sprintf('[Git] Change Branch (%s)', $branch); return sprintf('[Git] Change Branch (%s)', $branch);
} }
public function execute() public function execute(): bool
{ {
$options = $this->getOptions(); $options = $this->getOptions();
$branch = $this->runtime->getVar('git_revert_branch', false); /** @var string|bool */
$branch = $this->runtime->getVar('git_revert_branch', null);
if ($branch === false) { if (!$branch) {
$cmdGetCurrent = sprintf('%s branch | grep "*"', $options['path']); $cmdGetCurrent = sprintf('%s branch | grep "*"', $options['path']);
/** @var Process $process */ /** @var Process $process */
@ -53,11 +60,11 @@ class ChangeBranchTask extends AbstractTask
} }
$currentBranch = str_replace('* ', '', trim($process->getOutput())); $currentBranch = str_replace('* ', '', trim($process->getOutput()));
if ($currentBranch == $options['branch']) { if ($currentBranch === $options['branch']) {
throw new SkipException(); throw new SkipException();
} }
$branch = $options['branch']; $branch = $options['tag'] ? $options['tag'] : $options['branch'];
$this->runtime->setVar('git_revert_branch', $currentBranch); $this->runtime->setVar('git_revert_branch', $currentBranch);
} }
@ -68,11 +75,15 @@ class ChangeBranchTask extends AbstractTask
return $process->isSuccessful(); return $process->isSuccessful();
} }
protected function getOptions() /**
* @return array<string, string>
*/
protected function getOptions(): array
{ {
$tag = $this->runtime->getEnvOption('tag', false);
$branch = $this->runtime->getEnvOption('branch', 'master'); $branch = $this->runtime->getEnvOption('branch', 'master');
$options = array_merge( $options = array_merge(
['path' => 'git', 'branch' => $branch], ['path' => 'git', 'branch' => $branch, 'tag' => $tag],
$this->options $this->options
); );

22
src/Task/BuiltIn/Git/UpdateTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -12,6 +13,7 @@ namespace Mage\Task\BuiltIn\Git;
use Symfony\Component\Process\Process; use Symfony\Component\Process\Process;
use Mage\Task\AbstractTask; use Mage\Task\AbstractTask;
use Mage\Task\Exception\SkipException;
/** /**
* Git Task - Pull * Git Task - Pull
@ -20,32 +22,40 @@ use Mage\Task\AbstractTask;
*/ */
class UpdateTask extends AbstractTask class UpdateTask extends AbstractTask
{ {
public function getName() public function getName(): string
{ {
return 'git/update'; return 'git/update';
} }
public function getDescription() public function getDescription(): string
{ {
return '[Git] Update'; return '[Git] Update';
} }
public function execute() public function execute(): bool
{ {
$options = $this->getOptions(); $options = $this->getOptions();
if ($options['tag']) {
throw new SkipException();
}
$command = $options['path'] . ' pull'; $command = $options['path'] . ' pull';
/** @var Process $process */
$process = $this->runtime->runLocalCommand($command); $process = $this->runtime->runLocalCommand($command);
return $process->isSuccessful(); return $process->isSuccessful();
} }
protected function getOptions() /**
* @return array<string, string>
*/
protected function getOptions(): array
{ {
$branch = $this->runtime->getEnvOption('branch', 'master'); $branch = $this->runtime->getEnvOption('branch', 'master');
$tag = $this->runtime->getEnvOption('tag', false);
$options = array_merge( $options = array_merge(
['path' => 'git', 'branch' => $branch], ['path' => 'git', 'branch' => $branch, 'tag' => $tag],
$this->options $this->options
); );

61
src/Task/BuiltIn/SleepTask.php Normal file
View file

@ -0,0 +1,61 @@
<?php
/*
* This file is part of the Magallanes package.
*
* (c) Andrés Montañez <andres@andresmontanez.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Mage\Task\BuiltIn;
use Mage\Task\Exception\ErrorException;
use Mage\Task\AbstractTask;
/**
* Sleep task. Sleeps for a given number of seconds so you can delay task
* execution.
*
* @author Yanick Witschi <https://github.com/Toflar>
*/
class SleepTask extends AbstractTask
{
public function getName(): string
{
return 'sleep';
}
public function getDescription(): string
{
$options = $this->getOptions();
return sprintf('[Sleep] Sleeping for %d second(s)', $options['seconds']);
}
/**
* @throws ErrorException
*/
public function execute(): bool
{
$options = $this->getOptions();
sleep(intval($options['seconds']));
return true;
}
/**
* @return array<string, string|int>
*/
protected function getOptions(): array
{
$options = array_merge(
['seconds' => 1],
$this->options
);
return $options;
}
}

11
src/Task/BuiltIn/Symfony/AbstractSymfonyTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -19,7 +20,10 @@ use Mage\Task\AbstractTask;
*/ */
abstract class AbstractSymfonyTask extends AbstractTask abstract class AbstractSymfonyTask extends AbstractTask
{ {
protected function getOptions() /**
* @return array<string, string>
*/
protected function getOptions(): array
{ {
$options = array_merge( $options = array_merge(
['console' => 'bin/console', 'env' => 'dev', 'flags' => ''], ['console' => 'bin/console', 'env' => 'dev', 'flags' => ''],
@ -31,7 +35,10 @@ abstract class AbstractSymfonyTask extends AbstractTask
return $options; return $options;
} }
protected function getSymfonyOptions() /**
* @return array<string, string|null>
*/
protected function getSymfonyOptions(): array
{ {
return []; return [];
} }

18
src/Task/BuiltIn/Symfony/AssetsInstallTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -19,28 +20,33 @@ use Symfony\Component\Process\Process;
*/ */
class AssetsInstallTask extends AbstractSymfonyTask class AssetsInstallTask extends AbstractSymfonyTask
{ {
public function getName() public function getName(): string
{ {
return 'symfony/assets-install'; return 'symfony/assets-install';
} }
public function getDescription() public function getDescription(): string
{ {
return '[Symfony] Assets Install'; return '[Symfony] Assets Install';
} }
public function execute() public function execute(): bool
{ {
$options = $this->getOptions(); $options = $this->getOptions();
$command = sprintf('%s assets:install %s --env=%s %s', $options['console'], $options['target'], $options['env'], $options['flags']); $command = sprintf(
'%s assets:install %s --env=%s %s',
$options['console'],
$options['target'],
$options['env'],
$options['flags']
);
/** @var Process $process */
$process = $this->runtime->runCommand(trim($command)); $process = $this->runtime->runCommand(trim($command));
return $process->isSuccessful(); return $process->isSuccessful();
} }
protected function getSymfonyOptions() protected function getSymfonyOptions(): array
{ {
return ['target' => 'web', 'flags' => '--symlink --relative']; return ['target' => 'web', 'flags' => '--symlink --relative'];
} }

7
src/Task/BuiltIn/Symfony/CacheClearTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -19,17 +20,17 @@ use Symfony\Component\Process\Process;
*/ */
class CacheClearTask extends AbstractSymfonyTask class CacheClearTask extends AbstractSymfonyTask
{ {
public function getName() public function getName(): string
{ {
return 'symfony/cache-clear'; return 'symfony/cache-clear';
} }
public function getDescription() public function getDescription(): string
{ {
return '[Symfony] Cache Clear'; return '[Symfony] Cache Clear';
} }
public function execute() public function execute(): bool
{ {
$options = $this->getOptions(); $options = $this->getOptions();
$command = $options['console'] . ' cache:clear --env=' . $options['env'] . ' ' . $options['flags']; $command = $options['console'] . ' cache:clear --env=' . $options['env'] . ' ' . $options['flags'];

17
src/Task/BuiltIn/Symfony/CachePoolClearTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -20,17 +21,17 @@ use Symfony\Component\Process\Process;
*/ */
class CachePoolClearTask extends AbstractSymfonyTask class CachePoolClearTask extends AbstractSymfonyTask
{ {
public function getName() public function getName(): string
{ {
return 'symfony/cache-pool-clear'; return 'symfony/cache-pool-clear';
} }
public function getDescription() public function getDescription(): string
{ {
return '[Symfony] Cache Pool Clear'; return '[Symfony] Cache Pool Clear';
} }
public function execute() public function execute(): bool
{ {
$options = $this->getOptions(); $options = $this->getOptions();
@ -38,7 +39,13 @@ class CachePoolClearTask extends AbstractSymfonyTask
throw new ErrorException('Parameter "pools" is not defined'); throw new ErrorException('Parameter "pools" is not defined');
} }
$command = $options['console'] . ' cache:pool:clear ' . $options['pools'] . ' --env=' . $options['env'] . ' ' . $options['flags']; $command = sprintf(
'%s cache:pool:clear %s --env=%s %s',
$options['console'],
$options['pools'],
$options['env'],
$options['flags']
);
/** @var Process $process */ /** @var Process $process */
$process = $this->runtime->runCommand(trim($command)); $process = $this->runtime->runCommand(trim($command));
@ -46,7 +53,7 @@ class CachePoolClearTask extends AbstractSymfonyTask
return $process->isSuccessful(); return $process->isSuccessful();
} }
protected function getSymfonyOptions() protected function getSymfonyOptions(): array
{ {
return ['pools' => null]; return ['pools' => null];
} }

7
src/Task/BuiltIn/Symfony/CachePoolPruneTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -19,17 +20,17 @@ use Symfony\Component\Process\Process;
*/ */
class CachePoolPruneTask extends AbstractSymfonyTask class CachePoolPruneTask extends AbstractSymfonyTask
{ {
public function getName() public function getName(): string
{ {
return 'symfony/cache-pool-prune'; return 'symfony/cache-pool-prune';
} }
public function getDescription() public function getDescription(): string
{ {
return '[Symfony] Cache Pool Prune'; return '[Symfony] Cache Pool Prune';
} }
public function execute() public function execute(): bool
{ {
$options = $this->getOptions(); $options = $this->getOptions();
$command = $options['console'] . ' cache:pool:prune --env=' . $options['env'] . ' ' . $options['flags']; $command = $options['console'] . ' cache:pool:prune --env=' . $options['env'] . ' ' . $options['flags'];

7
src/Task/BuiltIn/Symfony/CacheWarmupTask.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -19,17 +20,17 @@ use Symfony\Component\Process\Process;
*/ */
class CacheWarmupTask extends AbstractSymfonyTask class CacheWarmupTask extends AbstractSymfonyTask
{ {
public function getName() public function getName(): string
{ {
return 'symfony/cache-warmup'; return 'symfony/cache-warmup';
} }
public function getDescription() public function getDescription(): string
{ {
return '[Symfony] Cache Warmup'; return '[Symfony] Cache Warmup';
} }
public function execute() public function execute(): bool
{ {
$options = $this->getOptions(); $options = $this->getOptions();
$command = $options['console'] . ' cache:warmup --env=' . $options['env'] . ' ' . $options['flags']; $command = $options['console'] . ' cache:warmup --env=' . $options['env'] . ' ' . $options['flags'];

7
src/Task/Exception/ErrorException.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -10,16 +11,14 @@
namespace Mage\Task\Exception; namespace Mage\Task\Exception;
use Exception;
/** /**
* The Task Failed, and it has a Custom Message * The Task Failed, and it has a Custom Message
* *
* @author Andrés Montañez <andresmontanez@gmail.com> * @author Andrés Montañez <andresmontanez@gmail.com>
*/ */
class ErrorException extends Exception class ErrorException extends \Exception
{ {
public function getTrimmedMessage($maxLength = 60) public function getTrimmedMessage(int $maxLength = 60): string
{ {
$message = $this->getMessage(); $message = $this->getMessage();

5
src/Task/Exception/SkipException.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -10,13 +11,11 @@
namespace Mage\Task\Exception; namespace Mage\Task\Exception;
use Exception;
/** /**
* The Task will be Skipped * The Task will be Skipped
* *
* @author Andrés Montañez <andresmontanez@gmail.com> * @author Andrés Montañez <andresmontanez@gmail.com>
*/ */
class SkipException extends Exception class SkipException extends \Exception
{ {
} }

1
src/Task/ExecuteOnRollbackInterface.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *

42
src/Task/TaskFactory.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -23,20 +24,15 @@ use ReflectionClass;
*/ */
class TaskFactory class TaskFactory
{ {
/** protected Runtime $runtime;
* @var Runtime
*/
protected $runtime;
/** /**
* @var array Registered Tasks * @var AbstractTask[] Registered Tasks
*/ */
protected $registeredTasks = []; protected array $registeredTasks = [];
/** /**
* Constructor * Constructor
*
* @param Runtime $runtime
*/ */
public function __construct(Runtime $runtime) public function __construct(Runtime $runtime)
{ {
@ -47,10 +43,8 @@ class TaskFactory
/** /**
* Add a Task * Add a Task
*
* @param AbstractTask $task
*/ */
public function add(AbstractTask $task) public function add(AbstractTask $task): void
{ {
$task->setRuntime($this->runtime); $task->setRuntime($this->runtime);
$this->registeredTasks[$task->getName()] = $task; $this->registeredTasks[$task->getName()] = $task;
@ -60,11 +54,10 @@ class TaskFactory
* Get a Task by it's registered Name/Code, or it can be a Class Name, * Get a Task by it's registered Name/Code, or it can be a Class Name,
* in that case the class will be instantiated * in that case the class will be instantiated
* *
* @param string $name Name/Code or Class of the Task * @param string|mixed[] $name
* @return AbstractTask
* @throws RuntimeException * @throws RuntimeException
*/ */
public function get($name) public function get(mixed $name): AbstractTask
{ {
$options = []; $options = [];
if (is_array($name)) { if (is_array($name)) {
@ -96,14 +89,22 @@ class TaskFactory
/** /**
* Load BuiltIn Tasks * Load BuiltIn Tasks
*/ */
protected function loadBuiltInTasks() protected function loadBuiltInTasks(): void
{ {
$finder = new Finder(); $finder = new Finder();
$finder->files()->in(__DIR__ . '/BuiltIn')->name('*Task.php'); $finder->files()->in(__DIR__ . '/BuiltIn')->name('*Task.php');
/** @var SplFileInfo $file */ /** @var SplFileInfo $file */
foreach ($finder as $file) { foreach ($finder as $file) {
$taskClass = substr('\\Mage\\Task\\BuiltIn\\' . str_replace('/', '\\', $file->getRelativePathname()), 0, -4); $taskClass = substr(
'\\Mage\\Task\\BuiltIn\\' . str_replace(
'/',
'\\',
$file->getRelativePathname()
),
0,
-4
);
if (class_exists($taskClass)) { if (class_exists($taskClass)) {
$reflex = new ReflectionClass($taskClass); $reflex = new ReflectionClass($taskClass);
if ($reflex->isInstantiable()) { if ($reflex->isInstantiable()) {
@ -118,10 +119,11 @@ class TaskFactory
/** /**
* Load Custom Tasks * Load Custom Tasks
* @param array $tasksToLoad PreRegistered Tasks *
* @param string[] $tasksToLoad
* @throws RuntimeException * @throws RuntimeException
*/ */
protected function loadCustomTasks($tasksToLoad) protected function loadCustomTasks(array $tasksToLoad): void
{ {
foreach ($tasksToLoad as $taskClass) { foreach ($tasksToLoad as $taskClass) {
if (!class_exists($taskClass)) { if (!class_exists($taskClass)) {
@ -135,7 +137,9 @@ class TaskFactory
$task = new $taskClass(); $task = new $taskClass();
if (!$task instanceof AbstractTask) { if (!$task instanceof AbstractTask) {
throw new RuntimeException(sprintf('Custom Task "%s" must inherit "Mage\\Task\\AbstractTask".', $taskClass)); throw new RuntimeException(
sprintf('Custom Task "%s" must inherit "Mage\\Task\\AbstractTask".', $taskClass)
);
} }
// Add Task // Add Task

47
src/Utils.php
View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* This file is part of the Magallanes package. * This file is part of the Magallanes package.
* *
@ -11,8 +12,6 @@
namespace Mage; namespace Mage;
use Mage\Runtime\Runtime; use Mage\Runtime\Runtime;
use DateTime;
use DateInterval;
/** /**
* Utility class for resolving trivial operations * Utility class for resolving trivial operations
@ -23,11 +22,8 @@ class Utils
{ {
/** /**
* Given a stage code it will resolve a human friendly name * Given a stage code it will resolve a human friendly name
*
* @param string $stage
* @return string
*/ */
public function getStageName($stage) public function getStageName(string $stage): string
{ {
switch ($stage) { switch ($stage) {
case Runtime::PRE_DEPLOY: case Runtime::PRE_DEPLOY:
@ -51,35 +47,36 @@ class Utils
/** /**
* Given a Release ID, convert it to a DateTime instance * Given a Release ID, convert it to a DateTime instance
*
* @param string $releaseId The Release ID
* @return DateTime
*/ */
public function getReleaseDate($releaseId) public function getReleaseDate(string $releaseId): \DateTime
{ {
$formatted = sprintf('%d%d%d%d-%d%d-%d%d %d%d:%d%d:%d%d', $formatted = sprintf(
$releaseId[0], $releaseId[1], $releaseId[2], $releaseId[3], '%d%d%d%d-%d%d-%d%d %d%d:%d%d:%d%d',
$releaseId[4], $releaseId[5], $releaseId[0],
$releaseId[6], $releaseId[7], $releaseId[1],
$releaseId[8], $releaseId[9], $releaseId[2],
$releaseId[10], $releaseId[11], $releaseId[3],
$releaseId[12], $releaseId[13] $releaseId[4],
$releaseId[5],
$releaseId[6],
$releaseId[7],
$releaseId[8],
$releaseId[9],
$releaseId[10],
$releaseId[11],
$releaseId[12],
$releaseId[13]
); );
return new DateTime($formatted); return new \DateTime($formatted);
} }
/** /**
* Given a Date, calculate friendly how much time has passed * Given a Date, calculate friendly how much time has passed
*
* @param DateTime $releaseDate
* @return string
*/ */
public function getTimeDiff(DateTime $releaseDate) public function getTimeDiff(\DateTime $releaseDate): string
{ {
$now = new DateTime(); $now = new \DateTime();
/** @var DateInterval $diff */
$diff = $now->diff($releaseDate); $diff = $now->diff($releaseDate);
if ($diff->days > 7) { if ($diff->days > 7) {

20
tests/Command/BuiltIn/DeployCommandMiscTest.php
View file

@ -37,6 +37,26 @@ class DeployCommandMiscTest extends TestCase
$this->assertEquals(0, $tester->getStatusCode()); $this->assertEquals(0, $tester->getStatusCode());
} }
public function testTagAndBranch()
{
$application = new MageApplicationMockup(__DIR__ . '/../../Resources/no-hosts.yml');
/** @var AbstractCommand $command */
$command = $application->find('deploy');
$this->assertTrue($command instanceof DeployCommand);
$tester = new CommandTester($command);
$tester->execute([
'command' => $command->getName(),
'environment' => 'test',
'--branch' => 'branch',
'--tag' => 'tag'
]);
$this->assertTrue(strpos($tester->getDisplay(), 'Branch and Tag options are mutually exclusive.') !== false);
$this->assertGreaterThan(0, $tester->getStatusCode());
}
public function testInvalidLog() public function testInvalidLog()
{ {
$application = new MageApplicationMockup(__DIR__ . '/../../Resources/invalid-log.yml'); $application = new MageApplicationMockup(__DIR__ . '/../../Resources/invalid-log.yml');

198
tests/Command/BuiltIn/DeployCommandWithReleasesTest.php
View file

@ -69,6 +69,105 @@ class DeployCommandWithReleasesTest extends TestCase
$this->assertEquals(0, $tester->getStatusCode()); $this->assertEquals(0, $tester->getStatusCode());
} }
public function testDeploymentWithReleasesCommandsWithTag()
{
$application = new MageApplicationMockup(__DIR__ . '/../../Resources/testhost.yml');
$application->getRuntime()->setReleaseId('20170101015120');
/** @var AbstractCommand $command */
$command = $application->find('deploy');
$this->assertTrue($command instanceof DeployCommand);
$tester = new CommandTester($command);
$tester->execute(['command' => $command->getName(), 'environment' => 'test', '--tag' => 'v1.0.0']);
$ranCommands = $application->getRuntime()->getRanCommands();
$testCase = array(
0 => 'git branch | grep "*"',
1 => 'git checkout v1.0.0',
2 => 'composer install --optimize-autoloader',
3 => 'composer dump-autoload --optimize',
4 => 'tar cfzp /tmp/mageXYZ --exclude=".git" --exclude="./var/cache/*" --exclude="./var/log/*" --exclude="./web/app_dev.php" ./',
5 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "mkdir -p /var/www/test/releases/1234567890"',
6 => 'scp -P 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no /tmp/mageXYZ tester@testhost:/var/www/test/releases/1234567890/mageXYZ',
7 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && tar xfzop mageXYZ"',
8 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm /var/www/test/releases/1234567890/mageXYZ"',
9 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && bin/console cache:warmup --env=dev"',
10 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && bin/console assets:install web --env=dev --symlink --relative"',
11 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && bin/console cache:pool:prune --env=dev"',
12 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test && ln -snf releases/1234567890 current"',
13 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "ls -1 /var/www/test/releases"',
14 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm -rf /var/www/test/releases/20170101015110"',
15 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm -rf /var/www/test/releases/20170101015111"',
16 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm -rf /var/www/test/releases/20170101015112"',
17 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm -rf /var/www/test/releases/20170101015113"',
18 => 'rm /tmp/mageXYZ',
19 => 'git checkout master',
);
// Check total of Executed Commands
$this->assertEquals(count($testCase), count($ranCommands));
// Check Generated Commands
foreach ($testCase as $index => $command) {
$this->assertEquals($command, $ranCommands[$index]);
}
$this->assertEquals(0, $tester->getStatusCode());
}
public function testDeploymentWithReleasesCommandsCustomSymlink()
{
$application = new MageApplicationMockup(__DIR__ . '/../../Resources/testhost-custom-symlink.yml');
$application->getRuntime()->setReleaseId('20170101015120');
/** @var AbstractCommand $command */
$command = $application->find('deploy');
$this->assertTrue($command instanceof DeployCommand);
$tester = new CommandTester($command);
$tester->execute(['command' => $command->getName(), 'environment' => 'test']);
$ranCommands = $application->getRuntime()->getRanCommands();
$testCase = array(
0 => 'git branch | grep "*"',
1 => 'git checkout test',
2 => 'git pull',
3 => 'composer install --optimize-autoloader',
4 => 'composer dump-autoload --optimize',
5 => 'tar cfzp /tmp/mageXYZ --exclude=".git" --exclude="./var/cache/*" --exclude="./var/log/*" --exclude="./web/app_dev.php" ./',
6 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "mkdir -p /var/www/test/releases/1234567890"',
7 => 'scp -P 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no /tmp/mageXYZ tester@testhost:/var/www/test/releases/1234567890/mageXYZ',
8 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && tar xfzop mageXYZ"',
9 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm /var/www/test/releases/1234567890/mageXYZ"',
10 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && bin/console cache:warmup --env=dev"',
11 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && bin/console assets:install web --env=dev --symlink --relative"',
12 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && bin/console cache:pool:prune --env=dev"',
13 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test && ln -snf releases/1234567890 prod"',
14 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "ls -1 /var/www/test/releases"',
15 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm -rf /var/www/test/releases/20170101015110"',
16 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm -rf /var/www/test/releases/20170101015111"',
17 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm -rf /var/www/test/releases/20170101015112"',
18 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm -rf /var/www/test/releases/20170101015113"',
19 => 'rm /tmp/mageXYZ',
20 => 'git checkout master',
);
// Check total of Executed Commands
$this->assertEquals(count($testCase), count($ranCommands));
// Check Generated Commands
foreach ($testCase as $index => $command) {
$this->assertEquals($command, $ranCommands[$index]);
}
$this->assertEquals(0, $tester->getStatusCode());
}
public function testDeploymentWithReleasesWithPortCommands() public function testDeploymentWithReleasesWithPortCommands()
{ {
$application = new MageApplicationMockup(__DIR__ . '/../../Resources/testhost-with-port.yml'); $application = new MageApplicationMockup(__DIR__ . '/../../Resources/testhost-with-port.yml');
@ -319,6 +418,56 @@ class DeployCommandWithReleasesTest extends TestCase
$this->assertEquals(0, $tester->getStatusCode()); $this->assertEquals(0, $tester->getStatusCode());
} }
public function testDeploymentWithReleasesWithSCPFlags()
{
$application = new MageApplicationMockup(__DIR__ . '/../../Resources/testhost-with-release-scp-flags.yml');
$application->getRuntime()->setReleaseId('20170101015120');
/** @var AbstractCommand $command */
$command = $application->find('deploy');
$this->assertTrue($command instanceof DeployCommand);
$tester = new CommandTester($command);
$tester->execute(['command' => $command->getName(), 'environment' => 'test']);
$ranCommands = $application->getRuntime()->getRanCommands();
$testCase = array(
0 => 'git branch | grep "*"',
1 => 'git checkout test',
2 => 'git pull',
3 => 'composer install --optimize-autoloader',
4 => 'composer dump-autoload --optimize',
5 => 'tar cfzp /tmp/mageXYZ --exclude=".git" --exclude="./var/cache/*" --exclude="./var/log/*" --exclude="./web/app_dev.php" ./',
6 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "mkdir -p /var/www/test/releases/1234567890"',
7 => 'scp -P 22 -p -l 1000 /tmp/mageXYZ tester@testhost:/var/www/test/releases/1234567890/mageXYZ',
8 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && tar xfzop mageXYZ"',
9 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm /var/www/test/releases/1234567890/mageXYZ"',
10 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && bin/console cache:warmup --env=dev"',
11 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && bin/console assets:install web --env=dev --symlink --relative"',
12 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && bin/console cache:pool:prune --env=dev"',
13 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test && ln -snf releases/1234567890 current"',
14 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "ls -1 /var/www/test/releases"',
15 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm -rf /var/www/test/releases/20170101015110"',
16 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm -rf /var/www/test/releases/20170101015111"',
17 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm -rf /var/www/test/releases/20170101015112"',
18 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm -rf /var/www/test/releases/20170101015113"',
19 => 'rm /tmp/mageXYZ',
20 => 'git checkout master',
);
// Check total of Executed Commands
$this->assertEquals(count($testCase), count($ranCommands));
// Check Generated Commands
foreach ($testCase as $index => $command) {
$this->assertEquals($command, $ranCommands[$index]);
}
$this->assertEquals(0, $tester->getStatusCode());
}
public function testDeploymentWithoutReleasesTarPrepare() public function testDeploymentWithoutReleasesTarPrepare()
{ {
$application = new MageApplicationMockup(__DIR__ . '/../../Resources/testhost-force-tar1.yml'); $application = new MageApplicationMockup(__DIR__ . '/../../Resources/testhost-force-tar1.yml');
@ -530,6 +679,55 @@ class DeployCommandWithReleasesTest extends TestCase
$this->assertNotEquals(0, $tester->getStatusCode()); $this->assertNotEquals(0, $tester->getStatusCode());
} }
public function testDeploymentFailCleanupReleases()
{
$application = new MageApplicationMockup(__DIR__ . '/../../Resources/testhost.yml');
$application->getRuntime()->setReleaseId('20170101015120');
/** @var AbstractCommand $command */
$command = $application->find('deploy');
$this->assertTrue($command instanceof DeployCommand);
$application->getRuntime()->forceFail('ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm -rf /var/www/test/releases/20170101015110"');
$tester = new CommandTester($command);
$tester->execute(['command' => $command->getName(), 'environment' => 'test']);
$ranCommands = $application->getRuntime()->getRanCommands();
$testCase = array(
0 => 'git branch | grep "*"',
1 => 'git checkout test',
2 => 'git pull',
3 => 'composer install --optimize-autoloader',
4 => 'composer dump-autoload --optimize',
5 => 'tar cfzp /tmp/mageXYZ --exclude=".git" --exclude="./var/cache/*" --exclude="./var/log/*" --exclude="./web/app_dev.php" ./',
6 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "mkdir -p /var/www/test/releases/1234567890"',
7 => 'scp -P 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no /tmp/mageXYZ tester@testhost:/var/www/test/releases/1234567890/mageXYZ',
8 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && tar xfzop mageXYZ"',
9 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm /var/www/test/releases/1234567890/mageXYZ"',
10 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && bin/console cache:warmup --env=dev"',
11 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && bin/console assets:install web --env=dev --symlink --relative"',
12 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test/releases/1234567890 && bin/console cache:pool:prune --env=dev"',
13 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "cd /var/www/test && ln -snf releases/1234567890 current"',
14 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "ls -1 /var/www/test/releases"',
15 => 'ssh -p 22 -q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no tester@testhost "rm -rf /var/www/test/releases/20170101015110"',
);
// Check total of Executed Commands
$this->assertEquals(count($testCase), count($ranCommands));
// Check Generated Commands
foreach ($testCase as $index => $command) {
$this->assertEquals($command, $ranCommands[$index]);
}
$this->assertStringContainsString('Running [Release] Cleaning up old Releases ... FAIL', $tester->getDisplay());
$this->assertStringContainsString('Stage "Post Release" did not finished successfully, halting command.', $tester->getDisplay());
$this->assertNotEquals(0, $tester->getStatusCode());
}
public function testDeploymentFailMidway() public function testDeploymentFailMidway()
{ {
$application = new MageApplicationMockup(__DIR__ . '/../../Resources/testhost.yml'); $application = new MageApplicationMockup(__DIR__ . '/../../Resources/testhost.yml');

1
tests/Deploy/StrategyTest.php
View file

@ -114,5 +114,4 @@ class StrategyTest extends TestCase
$this->assertEquals(sprintf('Invalid stage, got "%s" but expected "%s"', Runtime::PRE_DEPLOY, Runtime::POST_DEPLOY), $exception->getMessage()); $this->assertEquals(sprintf('Invalid stage, got "%s" but expected "%s"', Runtime::PRE_DEPLOY, Runtime::POST_DEPLOY), $exception->getMessage());
} }
} }
} }

2
tests/MageApplicationMockup.php
View file

@ -20,7 +20,7 @@ class MageApplicationMockup extends MageApplication
* *
* @return RuntimeMockup * @return RuntimeMockup
*/ */
protected function instantiateRuntime() protected function instantiateRuntime(): RuntimeMockup
{ {
return new RuntimeMockup(); return new RuntimeMockup();
} }

3
tests/MageApplicationWindowsMockup.php
View file

@ -12,6 +12,7 @@ namespace Mage\Tests;
use Mage\Tests\Runtime\RuntimeWindowsMockup; use Mage\Tests\Runtime\RuntimeWindowsMockup;
use Mage\MageApplication; use Mage\MageApplication;
use Mage\Runtime\Runtime;
class MageApplicationWindowsMockup extends MageApplication class MageApplicationWindowsMockup extends MageApplication
{ {
@ -20,7 +21,7 @@ class MageApplicationWindowsMockup extends MageApplication
* *
* @return RuntimeWindowsMockup * @return RuntimeWindowsMockup
*/ */
protected function instantiateRuntime() protected function instantiateRuntime(): Runtime
{ {
return new RuntimeWindowsMockup(); return new RuntimeWindowsMockup();
} }

4
tests/Resources/basic.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
production: production:
user: app user: app
@ -24,4 +24,4 @@ magephp:
- symfony/cache-pool-prune: { env: 'dev' } - symfony/cache-pool-prune: { env: 'dev' }
on-release: on-release:
post-release: post-release:
post-deploy: post-deploy:

2
tests/Resources/broken-git-branch.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester

2
tests/Resources/composer-env.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
composer: composer:
path: /usr/bin/composer.phar path: /usr/bin/composer.phar
environments: environments:

2
tests/Resources/composer.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
composer: composer:
path: /usr/bin/composer.phar path: /usr/bin/composer.phar
environments: environments:

2
tests/Resources/global-exclude.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
composer: composer:
path: /usr/bin/composer.phar path: /usr/bin/composer.phar
exclude: exclude:

2
tests/Resources/invalid-task.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester

4
tests/Resources/no-hosts.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -20,4 +20,4 @@ magephp:
- symfony/cache-pool-prune: { env: 'dev' } - symfony/cache-pool-prune: { env: 'dev' }
on-release: on-release:
post-release: post-release:
post-deploy: post-deploy:

2
tests/Resources/symfony-envconf.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
symfony: { env: 'testenv' } symfony: { env: 'testenv' }

28
tests/Resources/testhost-custom-symlink.yml Normal file
View file

@ -0,0 +1,28 @@
magephp:
log_dir: .logs/
environments:
test:
user: tester
branch: test
host_path: /var/www/test
releases: 4
symlink: prod
exclude:
- ./var/cache/*
- ./var/log/*
- ./web/app_dev.php
-
-
hosts:
- testhost
pre-deploy:
- git/update
- composer/install
- composer/dump-autoload
on-deploy:
- symfony/cache-warmup: { env: 'dev' }
- symfony/assets-install: { env: 'dev' }
- symfony/cache-pool-prune: { env: 'dev' }
on-release:
post-release:
post-deploy:

4
tests/Resources/testhost-custom-task.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -17,4 +17,4 @@ magephp:
- Mage\Tests\Task\CustomTask - Mage\Tests\Task\CustomTask
on-release: on-release:
post-release: post-release:
post-deploy: post-deploy:

2
tests/Resources/testhost-fail-copy-tar.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester

2
tests/Resources/testhost-fail-get-current.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester

2
tests/Resources/testhost-fail-get-releases.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester

4
tests/Resources/testhost-force-release.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -12,4 +12,4 @@ magephp:
hosts: hosts:
- host2 - host2
on-deploy: on-deploy:
- deploy/release - deploy/release

4
tests/Resources/testhost-force-tar1.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -12,4 +12,4 @@ magephp:
hosts: hosts:
- host2 - host2
pre-deploy: pre-deploy:
- deploy/tar/prepare - deploy/tar/prepare

4
tests/Resources/testhost-force-tar2.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -12,4 +12,4 @@ magephp:
hosts: hosts:
- host2 - host2
on-deploy: on-deploy:
- deploy/tar/copy - deploy/tar/copy

4
tests/Resources/testhost-force-tar3.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -12,4 +12,4 @@ magephp:
hosts: hosts:
- host2 - host2
post-deploy: post-deploy:
- deploy/tar/cleanup - deploy/tar/cleanup

2
tests/Resources/testhost-no-hosts.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester

2
tests/Resources/testhost-no-releases.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester

2
tests/Resources/testhost-not-have-release.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester

4
tests/Resources/testhost-skipping.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -21,4 +21,4 @@ magephp:
- symfony/cache-pool-prune: { env: 'dev' } - symfony/cache-pool-prune: { env: 'dev' }
on-release: on-release:
post-release: post-release:
post-deploy: post-deploy:

4
tests/Resources/testhost-sudo.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -23,4 +23,4 @@ magephp:
- symfony/cache-pool-prune: { env: 'dev' } - symfony/cache-pool-prune: { env: 'dev' }
on-release: on-release:
post-release: post-release:
post-deploy: post-deploy:

4
tests/Resources/testhost-with-error.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -20,4 +20,4 @@ magephp:
- deploy/rsync - deploy/rsync
on-release: on-release:
post-release: post-release:
post-deploy: post-deploy:

4
tests/Resources/testhost-with-from-copy-directory.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -26,4 +26,4 @@ magephp:
- symfony/cache-pool-prune: { env: 'dev' } - symfony/cache-pool-prune: { env: 'dev' }
on-release: on-release:
post-release: post-release:
post-deploy: post-deploy:

4
tests/Resources/testhost-with-from.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -25,4 +25,4 @@ magephp:
- symfony/cache-pool-prune: { env: 'dev' } - symfony/cache-pool-prune: { env: 'dev' }
on-release: on-release:
post-release: post-release:
post-deploy: post-deploy:

4
tests/Resources/testhost-with-port.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -24,4 +24,4 @@ magephp:
- symfony/cache-pool-prune: { env: 'prod' } - symfony/cache-pool-prune: { env: 'prod' }
on-release: on-release:
post-release: post-release:
post-deploy: post-deploy:

4
tests/Resources/testhost-with-postdeploy-error.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -20,4 +20,4 @@ magephp:
on-release: on-release:
post-release: post-release:
post-deploy: post-deploy:
- deploy/tar/cleanup - deploy/tar/cleanup

30
tests/Resources/testhost-with-release-scp-flags.yml Normal file
View file

@ -0,0 +1,30 @@
magephp:
log_dir: .logs/
environments:
test:
user: tester
branch: test
from: ./
host_path: /var/www/test
releases: 4
exclude:
- ./var/cache/*
- ./var/log/*
- ./web/app_dev.php
-
-
hosts:
- testhost
ssh:
scp_flags: '-p -l 1000'
pre-deploy:
- git/update
- composer/install
- composer/dump-autoload
on-deploy:
- symfony/cache-warmup: { env: 'dev' }
- symfony/assets-install: { env: 'dev' }
- symfony/cache-pool-prune: { env: 'dev' }
on-release:
post-release:
post-deploy:

4
tests/Resources/testhost-with-release-timeout.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -28,4 +28,4 @@ magephp:
- symfony/cache-pool-prune: { env: 'dev' } - symfony/cache-pool-prune: { env: 'dev' }
on-release: on-release:
post-release: post-release:
post-deploy: post-deploy:

4
tests/Resources/testhost-without-releases-with-from.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -22,4 +22,4 @@ magephp:
- symfony/cache-pool-prune: { env: 'dev' } - symfony/cache-pool-prune: { env: 'dev' }
on-release: on-release:
post-release: post-release:
post-deploy: post-deploy:

4
tests/Resources/testhost-without-releases-with-port.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -21,4 +21,4 @@ magephp:
- symfony/cache-pool-prune: { env: 'dev' } - symfony/cache-pool-prune: { env: 'dev' }
on-release: on-release:
post-release: post-release:
post-deploy: post-deploy:

4
tests/Resources/testhost-without-releases.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -21,4 +21,4 @@ magephp:
- symfony/cache-pool-prune: { env: 'dev' } - symfony/cache-pool-prune: { env: 'dev' }
on-release: on-release:
post-release: post-release:
post-deploy: post-deploy:

4
tests/Resources/testhost.yml
View file

@ -1,5 +1,5 @@
magephp: magephp:
log_dir: /tmp log_dir: .logs/
environments: environments:
test: test:
user: tester user: tester
@ -24,4 +24,4 @@ magephp:
- symfony/cache-pool-prune: { env: 'dev' } - symfony/cache-pool-prune: { env: 'dev' }
on-release: on-release:
post-release: post-release:
post-deploy: post-deploy:

Some files were not shown because too many files have changed in this diff Show more