├── .github
    └── workflows
    │   ├── build.yaml
    │   ├── ci.yaml
    │   └── doc.yaml
├── .gitignore
├── .infrastructure
    └── php
    │   └── Dockerfile
├── .php-cs-fixer.dist.php
├── CODE_OF_CONDUCT.md
├── LICENSE
├── Makefile
├── README.md
├── bin
    └── automate
├── box.json
├── compose.yaml
├── composer.json
├── composer.lock
├── doc
    ├── assets
    │   ├── 404.png
    │   ├── app.scss
    │   ├── asciinema-player.css
    │   ├── asciinema-player.min.js
    │   ├── bg-starting.png
    │   ├── favicon.png
    │   ├── home.js
    │   ├── ico-ellipse.png
    │   ├── logo-automate-white.png
    │   ├── logo-automate.png
    │   ├── logo-mezcalito.svg
    │   ├── page.js
    │   ├── scss
    │   │   ├── 01_settings
    │   │   │   ├── _settings.breakpoints.scss
    │   │   │   ├── _settings.colors.scss
    │   │   │   ├── _settings.fonts.scss
    │   │   │   ├── _settings.hover.scss
    │   │   │   ├── _settings.media-queries.scss
    │   │   │   └── _settings.variables.scss
    │   │   ├── 02_generics
    │   │   │   └── _generics.reset.scss
    │   │   ├── 03_elements
    │   │   │   └── _elements.page.scss
    │   │   ├── 04_objects
    │   │   │   └── _objects.container.scss
    │   │   └── 05_components
    │   │   │   ├── _components.404.scss
    │   │   │   ├── _components.advantages.scss
    │   │   │   ├── _components.baseline.scss
    │   │   │   ├── _components.buttons.scss
    │   │   │   ├── _components.doc.scss
    │   │   │   ├── _components.flip-card.scss
    │   │   │   ├── _components.footer.scss
    │   │   │   ├── _components.header.scss
    │   │   │   ├── _components.layout.scss
    │   │   │   ├── _components.main.scss
    │   │   │   ├── _components.menu.scss
    │   │   │   └── _components.starting.scss
    │   └── typewriter.js
    ├── cecil.yml
    ├── layouts
    │   ├── 404.html.twig
    │   ├── _base.html.twig
    │   ├── home.html.twig
    │   ├── page.html.twig
    │   └── partials
    │   │   └── navigation.html.twig
    ├── pages
    │   ├── deployment-strategies.md
    │   ├── get-started.md
    │   └── reference.md
    └── static
    │   ├── bg-starting.png
    │   ├── config-example.yaml
    │   ├── demo.cast
    │   ├── fonts
    │       ├── anton-v25-latin-regular.woff2
    │       ├── work-sans-v19-latin-600.woff2
    │       ├── work-sans-v19-latin-700.woff2
    │       └── work-sans-v19-latin-regular.woff2
    │   ├── googleae5075fd86941943.html
    │   ├── ico-ellipse.png
    │   └── install
├── phpstan.dist.neon
├── phpunit.dist.xml
├── rector.php
├── src
    └── Automate
    │   ├── Application.php
    │   ├── Archiver.php
    │   ├── Command
    │       ├── BaseCommand.php
    │       ├── CheckCommand.php
    │       ├── DeployCommand.php
    │       └── ExecCommand.php
    │   ├── CommandDenormalizer.php
    │   ├── Configuration.php
    │   ├── DispatcherFactory.php
    │   ├── Event
    │       ├── DeployEvent.php
    │       ├── DeployEvents.php
    │       └── FailedDeployEvent.php
    │   ├── Listener
    │       ├── ClearListener.php
    │       └── LockListener.php
    │   ├── Loader.php
    │   ├── Logger
    │       ├── ConsoleLogger.php
    │       └── LoggerInterface.php
    │   ├── Model
    │       ├── Action.php
    │       ├── Command.php
    │       ├── Platform.php
    │       ├── Project.php
    │       ├── Server.php
    │       └── Upload.php
    │   ├── Ssh
    │       ├── Ssh.php
    │       └── SshFactory.php
    │   ├── VariableResolver.php
    │   └── Workflow
    │       ├── Context.php
    │       ├── Deployer.php
    │       └── Session.php
└── tests
    ├── Automate
        ├── AbstractMockTestCase.php
        ├── ApplicationTest.php
        ├── ArchiverTest.php
        ├── LoaderTest.php
        ├── VariableResolverTest.php
        └── Workflow
        │   ├── DeployerTest.php
        │   └── SessionTest.php
    ├── bootstrap.php
    └── fixtures
        ├── config.yml
        ├── folder
            ├── .d.txt
            ├── .sub
            │   └── c.txt
            ├── a.txt
            └── sub
            │   └── b.txt
        ├── simple.yml
        └── simpleWithSharedPath.yml


/.github/workflows/build.yaml:
--------------------------------------------------------------------------------
  1 | name: Build
  2 | 
  3 | on:
  4 |     release:
  5 |         types:
  6 |             - created
  7 |     workflow_dispatch:
  8 | 
  9 | permissions:
 10 |     contents: write
 11 | 
 12 | jobs:
 13 |     phar:
 14 |         name: Build PHAR
 15 |         runs-on: ubuntu-latest
 16 |         steps:
 17 |             -   uses: actions/checkout@v4
 18 | 
 19 |             -   name: Setup PHP
 20 |                 uses: shivammathur/setup-php@v2
 21 |                 with:
 22 |                     php-version: 8.3
 23 |                     coverage: none
 24 |                     tools: box
 25 | 
 26 |             -   name: Install dependencies
 27 |                 uses: ramsey/composer-install@v3
 28 | 
 29 |             -   name: Build PHAR
 30 |                 run: box compile
 31 | 
 32 |             -   name: Ensure the PHAR works
 33 |                 run: build/automate.phar --version
 34 | 
 35 |             -   uses: actions/upload-artifact@v4
 36 |                 name: Upload the PHAR artifact
 37 |                 with:
 38 |                     name: automate-phar
 39 |                     path: build/automate.phar
 40 | 
 41 |     static-binary:
 42 |         name: Build static binary ${{ matrix.filename }}
 43 |         needs: [ phar ]
 44 |         strategy:
 45 |             fail-fast: false
 46 |             matrix:
 47 |                 include:
 48 |                     # Linux amd64
 49 |                     -   runs_on: ubuntu-latest
 50 |                         spc_binary: https://dl.static-php.dev/static-php-cli/spc-bin/nightly/spc-linux-x86_64
 51 |                         build_options: --build-micro --with-upx-pack
 52 |                         filename: automate-linux-amd64
 53 |                     # MacOS amd64
 54 |                     -   runs_on: macos-13
 55 |                         spc_binary: https://dl.static-php.dev/static-php-cli/spc-bin/nightly/spc-macos-x86_64
 56 |                         build_options: --build-micro
 57 |                         filename: automate-darwin-amd64
 58 |                     # MacOS arm64
 59 |                     -   runs_on: macos-14
 60 |                         spc_binary: https://dl.static-php.dev/static-php-cli/spc-bin/nightly/spc-macos-aarch64
 61 |                         build_options: --build-micro
 62 |                         filename: automate-darwin-arm64
 63 | 
 64 |         runs-on: ${{ matrix.runs_on }}
 65 |         steps:
 66 |             -   uses: actions/checkout@v4
 67 | 
 68 |             -   uses: actions/download-artifact@v4
 69 |                 with:
 70 |                     path: build
 71 |                     merge-multiple: true
 72 | 
 73 |             -   name: Setup PHP
 74 |                 uses: shivammathur/setup-php@v2
 75 |                 with:
 76 |                     php-version: 8.3
 77 |                     coverage: none
 78 | 
 79 |             -   name: Get static-php-cli binary
 80 |                 run: |
 81 |                     curl -fsSL -o bin/spc ${{ matrix.spc_binary }}
 82 |                     chmod +x bin/spc
 83 | 
 84 |             -   name: Fixing missing requirements
 85 |                 run: |
 86 |                     bin/spc doctor --auto-fix
 87 | 
 88 |             -   name: Install UPX package
 89 |                 if: ${{ contains(matrix.build_options, 'upx') }}
 90 |                 run: |
 91 |                     bin/spc install-pkg upx
 92 | 
 93 |             -   name: Build static binary
 94 |                 run: |
 95 |                     bin/spc download --for-extensions="dom,gmp,openssl,phar,sodium,xml,xmlwriter,filter,tokenizer,iconv,mbstring" --with-php=8.3 --retry=3
 96 |                     bin/spc build "dom,gmp,openssl,phar,sodium,xml,xmlwriter,filter,tokenizer,iconv,mbstring" ${{ matrix.build_options }}
 97 |                     bin/spc micro:combine build/automate.phar --output build/${{ matrix.filename }}
 98 | 
 99 |             -   name: Ensure the static binary works
100 |                 run: build/${{ matrix.filename }} --version
101 | 
102 |             -   uses: actions/upload-artifact@v4
103 |                 name: Upload the static binary artifact
104 |                 with:
105 |                     name: ${{ matrix.filename }}
106 |                     path: build/${{ matrix.filename }}
107 | 
108 |     release:
109 |         name: Upload artifacts to the release
110 |         if: github.event_name == 'release'
111 |         needs: [ static-binary ]
112 |         runs-on: ubuntu-latest
113 |         steps:
114 |             -   uses: actions/checkout@v4
115 | 
116 |             -   uses: actions/download-artifact@v4
117 |                 with:
118 |                     path: build
119 |                     merge-multiple: true
120 | 
121 |             -   name: Upload files
122 |                 run: |
123 |                     gh release upload ${{ github.ref_name }} ./build/automate.phar
124 |                     gh release upload ${{ github.ref_name }} ./build/automate-linux-amd64
125 |                     gh release upload ${{ github.ref_name }} ./build/automate-darwin-amd64
126 |                     gh release upload ${{ github.ref_name }} ./build/automate-darwin-arm64
127 |                 env:
128 |                     GH_TOKEN: ${{ github.token }}


--------------------------------------------------------------------------------
/.github/workflows/ci.yaml:
--------------------------------------------------------------------------------
  1 | name: "Continuous Integration"
  2 | 
  3 | on:
  4 |     push:
  5 |         branches:
  6 |             - main
  7 |     pull_request:
  8 |         branches:
  9 |             - main
 10 | 
 11 | jobs:
 12 |     check-dependencies:
 13 |         runs-on: ubuntu-latest
 14 | 
 15 |         steps:
 16 |             - uses: actions/checkout@v4
 17 | 
 18 |             - name: Setup PHP
 19 |               uses: shivammathur/setup-php@v2
 20 |               with:
 21 |                   php-version: 8.3
 22 |                   coverage: none
 23 | 
 24 |             - name: Install dependencies
 25 |               uses: ramsey/composer-install@v3
 26 |               with:
 27 |                   dependency-versions: ${{ matrix.dependencies }}
 28 | 
 29 |     php-cs-fixer:
 30 |         runs-on: ubuntu-latest
 31 | 
 32 |         steps:
 33 |             - uses: actions/checkout@v4
 34 | 
 35 |             - name: Setup PHP
 36 |               uses: shivammathur/setup-php@v2
 37 |               with:
 38 |                   php-version: 8.3
 39 |                   coverage: none
 40 | 
 41 |             - name: Install dependencies
 42 |               uses: ramsey/composer-install@v3
 43 |               with:
 44 |                   dependency-versions: ${{ matrix.dependencies }}
 45 | 
 46 |             - name: PHP-CS-Fixer
 47 |               run: php vendor/bin/php-cs-fixer fix --dry-run --diff --no-ansi
 48 | 
 49 |     phpstan:
 50 |         runs-on: ubuntu-latest
 51 | 
 52 |         steps:
 53 |             - uses: actions/checkout@v4
 54 | 
 55 |             - name: Setup PHP
 56 |               uses: shivammathur/setup-php@v2
 57 |               with:
 58 |                   php-version: 8.3
 59 |                   coverage: none
 60 | 
 61 |             - name: Install dependencies
 62 |               uses: ramsey/composer-install@v3
 63 |               with:
 64 |                   dependency-versions: ${{ matrix.dependencies }}
 65 | 
 66 |             - name: PHPStan
 67 |               run: php vendor/bin/phpstan analyse
 68 | 
 69 |     rector:
 70 |       runs-on: ubuntu-latest
 71 | 
 72 |       steps:
 73 |         - uses: actions/checkout@v4
 74 | 
 75 |         - name: Setup PHP
 76 |           uses: shivammathur/setup-php@v2
 77 |           with:
 78 |             php-version: 8.3
 79 |             coverage: none
 80 | 
 81 |         - name: Install dependencies
 82 |           uses: ramsey/composer-install@v3
 83 |           with:
 84 |             dependency-versions: ${{ matrix.dependencies }}
 85 | 
 86 |         - name: Rector
 87 |           run: php vendor/bin/rector
 88 | 
 89 |     phpunit:
 90 |       runs-on: ubuntu-latest
 91 | 
 92 |       steps:
 93 |         - uses: actions/checkout@v4
 94 | 
 95 |         - name: Setup PHP
 96 |           uses: shivammathur/setup-php@v2
 97 |           with:
 98 |             php-version: 8.3
 99 |             coverage: none
100 | 
101 |         - name: Install dependencies
102 |           uses: ramsey/composer-install@v3
103 |           with:
104 |             dependency-versions: ${{ matrix.dependencies }}
105 | 
106 |         - name: PHPUnit
107 |           run: php vendor/bin/phpunit
108 | 


--------------------------------------------------------------------------------
/.github/workflows/doc.yaml:
--------------------------------------------------------------------------------
 1 | name: Build and deploy to GitHub Pages
 2 | on:
 3 |     push:
 4 |         branches: [main]
 5 |     workflow_dispatch: # run manually
 6 | 
 7 | permissions:
 8 |     contents: read
 9 |     pages: write
10 |     id-token: write
11 | 
12 | concurrency:
13 |     group: "pages"
14 |     cancel-in-progress: true
15 | 
16 | jobs:
17 |     build:
18 |         runs-on: ubuntu-latest
19 |         steps:
20 |             - name: Checkout source
21 |               uses: actions/checkout@v4
22 | 
23 |             - name: Setup PHP
24 |               uses: shivammathur/setup-php@v2
25 |               with:
26 |                   php-version: '8.3'
27 |                   extensions: fileinfo, gd, mbstring
28 | 
29 |             - name: Build site
30 |               uses: Cecilapp/Cecil-Action@v3
31 |               with:
32 |                 version: '8.9.1'
33 |                 args: 'doc/ -vv'
34 |                 install_themes: 'no'
35 |                 config: 'cecil.yml'
36 | 
37 |             - name: Upload artifact
38 |               uses: actions/upload-pages-artifact@v3
39 |               with:
40 |                 path: 'doc/_site/'
41 | 
42 |     deploy:
43 |         needs: build
44 |         environment:
45 |             name: github-pages
46 |             url: ${{ steps.deployment.outputs.page_url }}
47 |         runs-on: ubuntu-latest
48 |         steps:
49 |             - name: Deploy to GitHub Pages
50 |               id: deployment
51 |               uses: actions/deploy-pages@v4


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | coverage
 2 | vendor
 3 | phpunit.phar
 4 | box.phar
 5 | build
 6 | test.yml
 7 | .php-cs-fixer.cache
 8 | .phpunit.cache
 9 | doc/.cache
10 | doc/.cecil
11 | doc/_site


--------------------------------------------------------------------------------
/.infrastructure/php/Dockerfile:
--------------------------------------------------------------------------------
 1 | #syntax=docker/dockerfile:1.4
 2 | 
 3 | FROM php:8.3-cli-alpine
 4 | 
 5 | COPY --from=mlocati/php-extension-installer --link /usr/bin/install-php-extensions /usr/local/bin/
 6 | COPY --from=composer/composer:2-bin --link /composer /usr/bin/composer
 7 | 
 8 | RUN apk add --no-cache  \
 9 |       git \
10 |     ;
11 | 
12 | RUN set -eux; \
13 |     install-php-extensions \
14 |     	intl \
15 |         pcov \
16 |         pcntl \
17 |     	zip \
18 |     ;
19 | 


--------------------------------------------------------------------------------
/.php-cs-fixer.dist.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | $finder = PhpCsFixer\Finder::create()
 4 |     ->in([__DIR__.'/src', __DIR__.'/tests'])
 5 |     ->notPath('Automate/Plugin/AbstractNotificationPlugin.php')
 6 |     ->notPath('Automate/Plugin/CacheToolPlugin.php')
 7 |     ->notPath('Automate/Plugin/GitlabPlugin.php')
 8 |     ->notPath('Automate/Plugin/GitterPlugin.php')
 9 |     ->notPath('Automate/Plugin/SentryPlugin.php')
10 |     ->notPath('Automate/Plugin/SlackPlugin.php')
11 |     ->notPath('Automate/Configuration.php');
12 | 
13 | return (new PhpCsFixer\Config())
14 |     ->setRules(
15 |         [
16 |             '@PSR1' => true,
17 |             '@PSR2' => true,
18 |             '@Symfony' => true,
19 |             'phpdoc_order' => true,
20 |             'general_phpdoc_annotation_remove' => ['annotations' => ["author", "package"]],
21 |             'align_multiline_comment' => true,
22 |             'combine_consecutive_issets' => true,
23 |             'combine_consecutive_unsets' => true,
24 |             'compact_nullable_typehint' => true,
25 |             'linebreak_after_opening_tag' => true,
26 |             'method_chaining_indentation' => true,
27 |             'multiline_comment_opening_closing' => true,
28 |             'multiline_whitespace_before_semicolons' => true,
29 |             'no_superfluous_elseif' => true,
30 |             'no_useless_else' => true,
31 |             'no_useless_return' => true,
32 |             'phpdoc_add_missing_param_annotation' => true,
33 |             'phpdoc_types_order' => true,
34 |         ]
35 |     )
36 |     ->setFinder($finder);


--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
 1 | # Contributor Covenant Code of Conduct
 2 | 
 3 | ## Our Pledge
 4 | 
 5 | In the interest of fostering an open and welcoming environment, we as
 6 | contributors and maintainers pledge to making participation in our project and
 7 | our community a harassment-free experience for everyone, regardless of age, body
 8 | size, disability, ethnicity, sex characteristics, gender identity and expression,
 9 | level of experience, education, socio-economic status, nationality, personal
10 | appearance, race, religion, or sexual identity and orientation.
11 | 
12 | ## Our Standards
13 | 
14 | Examples of behavior that contributes to creating a positive environment
15 | include:
16 | 
17 | * Using welcoming and inclusive language
18 | * Being respectful of differing viewpoints and experiences
19 | * Gracefully accepting constructive criticism
20 | * Focusing on what is best for the community
21 | * Showing empathy towards other community members
22 | 
23 | Examples of unacceptable behavior by participants include:
24 | 
25 | * The use of sexualized language or imagery and unwelcome sexual attention or
26 |  advances
27 | * Trolling, insulting/derogatory comments, and personal or political attacks
28 | * Public or private harassment
29 | * Publishing others' private information, such as a physical or electronic
30 |  address, without explicit permission
31 | * Other conduct which could reasonably be considered inappropriate in a
32 |  professional setting
33 | 
34 | ## Our Responsibilities
35 | 
36 | Project maintainers are responsible for clarifying the standards of acceptable
37 | behavior and are expected to take appropriate and fair corrective action in
38 | response to any instances of unacceptable behavior.
39 | 
40 | Project maintainers have the right and responsibility to remove, edit, or
41 | reject comments, commits, code, wiki edits, issues, and other contributions
42 | that are not aligned to this Code of Conduct, or to ban temporarily or
43 | permanently any contributor for other behaviors that they deem inappropriate,
44 | threatening, offensive, or harmful.
45 | 
46 | ## Scope
47 | 
48 | This Code of Conduct applies both within project spaces and in public spaces
49 | when an individual is representing the project or its community. Examples of
50 | representing a project or community include using an official project e-mail
51 | address, posting via an official social media account, or acting as an appointed
52 | representative at an online or offline event. Representation of a project may be
53 | further defined and clarified by project maintainers.
54 | 
55 | ## Enforcement
56 | 
57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
58 | reported by contacting the project team at jjacottet@gmail.com. All
59 | complaints will be reviewed and investigated and will result in a response that
60 | is deemed necessary and appropriate to the circumstances. The project team is
61 | obligated to maintain confidentiality with regard to the reporter of an incident.
62 | Further details of specific enforcement policies may be posted separately.
63 | 
64 | Project maintainers who do not follow or enforce the Code of Conduct in good
65 | faith may face temporary or permanent repercussions as determined by other
66 | members of the project's leadership.
67 | 
68 | ## Attribution
69 | 
70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72 | 
73 | [homepage]: https://www.contributor-covenant.org
74 | 
75 | For answers to common questions about this code of conduct, see
76 | https://www.contributor-covenant.org/faq
77 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2016 Julien Jacottet
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | # Executables (local)
 2 | DOCKER_COMP = docker compose
 3 | 
 4 | # Docker containers
 5 | PHP_CONT = $(DOCKER_COMP) run --rm php
 6 | 
 7 | # Executables
 8 | PHP = $(PHP_CONT) php
 9 | 
10 | # Misc
11 | .DEFAULT_GOAL = help
12 | .PHONY        = help build up start down logs sh composer vendor sf cc
13 | 
14 | ## —— Help 🎵 ———————————————————————————————————————————————————————————————
15 | help: ## Outputs this help screen
16 | 	@grep -E '(^[a-zA-Z0-9_-]+:.*?##.*$$)|(^##)' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}{printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}' | sed -e 's/\[32m##/[33m/'
17 | 
18 | ## —— Docker 🐳 ————————————————————————————————————————————————————————————————
19 | docker-build: ## Builds the Docker images
20 | 	@$(DOCKER_COMP) build --pull --no-cache
21 | 
22 | logs: ## Show live logs
23 | 	@$(DOCKER_COMP) logs --tail=0 --follow
24 | 
25 | php: ## Connect to the PHP FPM container
26 | 	@$(PHP_CONT) sh
27 | 
28 | ## —— Project 🐝 ———————————————————————————————————————————————————————————————
29 | install: ## Install project
30 | 	@$(PHP_CONT) composer install
31 | 
32 | ## —— Doc 📖 ————————————————————————————————————————————————————————————————————
33 | doc-serve: ## Serve doc website
34 | 	cecil serve doc
35 | 
36 | ## —— CI ✨ ————————————————————————————————————————————————————————————————————
37 | ci: cs phpstan rector test ## Run all all checks
38 | 
39 | cs: ## Run tests
40 | 	$(PHP) vendor/bin/php-cs-fixer fix
41 | 
42 | phpstan: ## Run phpstan
43 | 	$(PHP) vendor/bin/phpstan  --memory-limit=1G
44 | 
45 | rector: ## Run rector
46 | 	$(PHP) vendor/bin/rector
47 | 
48 | test: ## Run tests
49 | 	$(PHP) vendor/bin/phpunit


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Automate
 2 | 
 3 | ![Status](https://github.com/automatephp/automate/actions/workflows/ci.yaml/badge.svg)
 4 | 
 5 | Automate allows you to automate your deployments to remote Linux servers simply.
 6 | You can use Automate from your workstation or through an integration server like Travis or Gitlab-ci
 7 | 
 8 | ## Installation
 9 | 
10 | > curl -LSs https://www.automate-deployer.com/install | bash
11 | 
12 | ## Usage
13 | 
14 | https://www.automate-deployer.com
15 | 
16 | ## Contributing
17 | 
18 | 1. Fork it!
19 | 2. Create your feature branch: `git checkout -b my-new-feature`
20 | 3. Commit your changes: `git commit -am 'Add some feature'`
21 | 4. Push to the branch: `git push origin my-new-feature`
22 | 5. Submit a pull request :D
23 | 
24 | 
25 | ## Credits
26 | 
27 | Julien Jacottet
28 | 
29 | ## License
30 | 
31 | The MIT License (MIT)
32 | 
33 | Copyright (c) 2016 Julien Jacottet
34 | 
35 | Permission is hereby granted, free of charge, to any person obtaining a copy
36 | of this software and associated documentation files (the "Software"), to deal
37 | in the Software without restriction, including without limitation the rights
38 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
39 | copies of the Software, and to permit persons to whom the Software is
40 | furnished to do so, subject to the following conditions:
41 | 
42 | The above copyright notice and this permission notice shall be included in
43 | all copies or substantial portions of the Software.
44 | 
45 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
46 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
47 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
48 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
49 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
50 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
51 | THE SOFTWARE.
52 | 


--------------------------------------------------------------------------------
/bin/automate:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env php
 2 | 
 3 | <?php
 4 | 
 5 | require __DIR__.'/../vendor/autoload.php';
 6 | 
 7 | use Automate\Application;
 8 | 
 9 | set_error_handler(
10 |     function ($code, $message, $file, $line) {
11 |         if (error_reporting() & $code) {
12 |             throw new ErrorException($message, 0, $code, $file, $line);
13 |         }
14 |         // @codeCoverageIgnoreStart
15 |     }
16 |     // @codeCoverageIgnoreEnd
17 | );
18 | 
19 | $application = new Application();
20 | 
21 | $application->run();
22 | 


--------------------------------------------------------------------------------
/box.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "chmod": "0755",
 3 |   "directories": ["src"],
 4 |   "files": [
 5 |     "LICENSE",
 6 |     "vendor/symfony/console/Resources/bin/hiddeninput.exe"
 7 |   ],
 8 |   "finder": [
 9 |     {
10 |       "name": "*.php",
11 |       "exclude": [
12 |         "sebastian",
13 |         "phpsec",
14 |         "Tester",
15 |         "Tests",
16 |         "tests"
17 |       ],
18 |       "in": "vendor"
19 |     }
20 |   ],
21 |   "main": "bin/automate",
22 |   "output": "build/automate.phar",
23 |   "git-commit": "git-commit",
24 |   "git-version": "git-version",
25 |   "stub": true
26 | }


--------------------------------------------------------------------------------
/compose.yaml:
--------------------------------------------------------------------------------
1 | services:
2 |     php:
3 |         build: .infrastructure/php/
4 |         working_dir: /srv/app
5 |         volumes:
6 |             - ./:/srv/app:rw,cached


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "automate/automate",
 3 |     "description": "Deployment Tool",
 4 |     "type": "project",
 5 |     "require": {
 6 |         "php": ">=8.3",
 7 |         "symfony/console": "^7.1",
 8 |         "symfony/yaml": "^7.1",
 9 |         "symfony/event-dispatcher": "^7.1",
10 |         "symfony/serializer": "^7.1",
11 |         "symfony/config": "^7.1",
12 |         "symfony/filesystem": "^7.1",
13 |         "symfony/process": "^7.1",
14 |         "symfony/http-client": "^7.1",
15 |         "symfony/property-access": "^7.1",
16 |         "phpseclib/phpseclib": "^3.0",
17 |         "phpdocumentor/reflection-docblock": "^5.6",
18 |         "symfony/finder": "^7.1"
19 |     },
20 |     "require-dev": {
21 |         "phpunit/phpunit": "^11.4",
22 |         "phpstan/phpstan": "^1.12",
23 |         "rector/rector": "^1.2",
24 |         "mockery/mockery": "^1.6",
25 |         "friendsofphp/php-cs-fixer": "^3.65",
26 |         "symfony/var-dumper": "^7.1"
27 |     },
28 |     "license": "MIT",
29 |     "authors": [
30 |         {
31 |             "name": "Julien Jacottet",
32 |             "email": "jjacottet@gmail.com"
33 |         }
34 |     ],
35 |     "minimum-stability": "stable",
36 |     "autoload": {
37 |         "psr-4": {
38 |             "Automate\\": "src/Automate",
39 |             "Automate\\Tests\\": "tests/Automate"
40 | 
41 |         }
42 |     }
43 | }
44 | 


--------------------------------------------------------------------------------
/doc/assets/404.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/doc/assets/404.png


--------------------------------------------------------------------------------
/doc/assets/app.scss:
--------------------------------------------------------------------------------
 1 | // ------------------ //
 2 | // SETTINGS
 3 | // ------------------ //
 4 | @import
 5 | "scss/01_settings/settings.breakpoints",
 6 | "scss/01_settings/settings.media-queries",
 7 | "scss/01_settings/settings.hover",
 8 | "scss/01_settings/settings.fonts",
 9 | "scss/01_settings/settings.colors",
10 | "scss/01_settings/settings.variables";
11 | 
12 | // ------------------ //
13 | // GENERICS
14 | // ------------------ //
15 | @import
16 | "scss/02_generics/generics.reset";
17 | 
18 | // ------------------ //
19 | // GENERICS
20 | // ------------------ //
21 | @import
22 | "scss/03_elements/elements.page";
23 | 
24 | // ------------------ //
25 | // OBJECTS
26 | // ------------------ //
27 | @import
28 | "scss/04_objects/objects.container";
29 | 
30 | // ------------------ //
31 | // COMPONENTS
32 | // ------------------ //
33 | @import
34 | "scss/05_components/components.buttons",
35 | "scss/05_components/components.starting",
36 | "scss/05_components/components.advantages",
37 | "scss/05_components/components.baseline",
38 | "scss/05_components/components.flip-card",
39 | "scss/05_components/components.layout",
40 | "scss/05_components/components.header",
41 | "scss/05_components/components.menu",
42 | "scss/05_components/components.main",
43 | "scss/05_components/components.footer",
44 | "scss/05_components/components.404",
45 | "scss/05_components/components.doc";


--------------------------------------------------------------------------------
/doc/assets/bg-starting.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/doc/assets/bg-starting.png


--------------------------------------------------------------------------------
/doc/assets/favicon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/doc/assets/favicon.png


--------------------------------------------------------------------------------
/doc/assets/home.js:
--------------------------------------------------------------------------------
 1 | 'use strict';
 2 | 
 3 | function toggleScrollClass(elem) {
 4 |   if (window.scrollY === 0) {
 5 |     elem.classList.remove('is-scrolled');
 6 |   } else {
 7 |     elem.classList.add('is-scrolled');
 8 |   }
 9 | }
10 | 
11 | async function loadYAML(path) {
12 |   const response = await fetch(path);
13 |   if (!response.ok) {
14 |     throw new Error("Response in not OK");
15 |   }
16 |   const code = await response.text();
17 |   let lineNb = 1;
18 |   document.querySelector('.c-flip-card__code').innerHTML = code.split('\n').map((line) => {
19 |     return '<span class="c-flip-card__position">&#x200b;<span class="c-flip-card__line">' + lineNb++ + '</span></span>' + line;
20 |   }).join('\n');
21 | }
22 | 
23 | document.addEventListener('DOMContentLoaded', function () {
24 |   const baselineBtn = document.querySelector('.c-baseline__button');
25 |   const header = document.querySelector('.c-header');
26 | 
27 |   // Add scroll class on click event for header
28 |   baselineBtn.addEventListener('click', function () {
29 |     header.classList.add('is-scrolled');
30 |   });
31 | 
32 |   // Toggle scroll class on scroll event for header
33 |   toggleScrollClass(header);
34 |   document.addEventListener('scroll', function () {
35 |     toggleScrollClass(header);
36 |   });
37 | 
38 |   // Load Yaml content in flip card back
39 |   loadYAML('./config-example.yaml');
40 | 
41 |   // Load asccinema in flip card front
42 |   AsciinemaPlayer.create('./demo.cast', document.getElementById('demo'), {
43 |     'autoPlay': true,
44 |     'loop': true,
45 |     'speed': 1,
46 |     'cols': 120,
47 |     'rows': 47,
48 |     'terminalFontSize': '12px',
49 |     'theme': "tango",
50 |     'controls': false,
51 |     'fit': false,
52 |   });
53 | 
54 |   // Load Typewriter on baseline titles
55 |   new Typewriter('#c-baseline-title-1', {
56 |     strings: 'One command line !',
57 |     autoStart: true,
58 |     delay: 80,
59 |   });
60 | 
61 |   new Typewriter('#c-baseline-title-2', {
62 |     strings: 'One YAML file to organize everything',
63 |     autoStart: true,
64 |     delay: 80,
65 |   });
66 | });


--------------------------------------------------------------------------------
/doc/assets/ico-ellipse.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/doc/assets/ico-ellipse.png


--------------------------------------------------------------------------------
/doc/assets/logo-automate-white.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/doc/assets/logo-automate-white.png


--------------------------------------------------------------------------------
/doc/assets/logo-automate.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/doc/assets/logo-automate.png


--------------------------------------------------------------------------------
/doc/assets/logo-mezcalito.svg:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?><svg id="Calque_1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 377.49 88.15"><defs><style>.cls-1{fill:#fff;stroke-width:0px;}</style></defs><path class="cls-1" d="M305.83,46.51c-3.18,0-5.77-2.59-5.77-5.77v-8.14c0-.39-.16-.77-.44-1.04-.28-.27-.64-.42-1.03-.42h-.97c-5.6,0-8.27-3.09-9.52-5.68-1.29-2.67-1.3-5.32-1.3-5.44v-6.25c0-2.97,2.42-5.39,5.39-5.39s5.39,2.42,5.39,5.39v1.07c0,1.05-.85,1.9-1.9,1.9s-1.9-.85-1.9-1.9v-1.07c0-.87-.71-1.59-1.59-1.59s-1.59.71-1.59,1.59v6.25c0,.74.26,7.31,7.03,7.31h.97c1.39,0,2.7.54,3.69,1.51,1,.98,1.57,2.35,1.57,3.75v8.14c0,1.08.88,1.96,1.96,1.96s1.96-.88,1.96-1.96V5.77c0-1.08-.88-1.96-1.96-1.96s-1.96.88-1.96,1.96v11.31c0,1.05-.85,1.9-1.9,1.9s-1.9-.85-1.9-1.9V5.77c0-3.18,2.59-5.77,5.77-5.77s5.76,2.59,5.76,5.77v34.98c0,3.18-2.59,5.77-5.76,5.77Z"/><path class="cls-1" d="M128.02,43.14c.36.36.54.78.54,1.24,0,.55-.18,1-.54,1.34-.36.34-.82.51-1.37.51h-30.56c-.6,0-1.07-.2-1.44-.61-.36-.4-.54-.86-.54-1.37,0-.38.13-.77.38-1.15L123.2,5.21h-25.52c-.55,0-1.01-.17-1.37-.51-.36-.34-.54-.79-.54-1.34,0-.51.18-.93.54-1.28.36-.34.82-.51,1.37-.51h29.03c.64,0,1.15.19,1.53.57.38.38.57.83.57,1.34,0,.38-.13.77-.38,1.15l-28.65,37.96h26.86c.55,0,1.01.18,1.37.54Z"/><path class="cls-1" d="M174.82,6.49c0,.38-.15.81-.45,1.28-.38.47-.87.7-1.47.7-.34,0-.68-.11-1.02-.32-3.4-2.25-7.12-3.38-11.17-3.38-3.45,0-6.56.81-9.35,2.43-2.79,1.62-4.98,3.88-6.57,6.79-1.59,2.91-2.39,6.22-2.39,9.92s.81,7.14,2.42,10.05c1.62,2.91,3.82,5.17,6.6,6.76,2.79,1.6,5.88,2.39,9.28,2.39,4.04,0,7.74-1.11,11.1-3.32.34-.21.7-.32,1.08-.32.6,0,1.08.25,1.47.77.3.34.45.74.45,1.21,0,.68-.3,1.19-.89,1.53-1.66,1.11-3.7,2.03-6.13,2.78-2.42.74-4.78,1.12-7.08,1.12-4.04,0-7.77-.97-11.2-2.9-3.42-1.94-6.15-4.65-8.17-8.13-2.02-3.49-3.03-7.47-3.03-11.93s1-8.2,3-11.71c2-3.51,4.7-6.25,8.1-8.23,3.4-1.98,7.17-2.97,11.29-2.97,2.38,0,4.71.34,6.99,1.02,2.28.68,4.33,1.64,6.16,2.87.64.38.96.92.96,1.6Z"/><path class="cls-1" d="M257.92,42.98c.36.34.54.79.54,1.34s-.18,1.01-.54,1.37c-.36.36-.82.54-1.37.54h-22.78c-.55,0-1.01-.18-1.37-.54-.36-.36-.54-.82-.54-1.37V3.49c0-.55.19-1.01.57-1.37.38-.36.87-.54,1.47-.54.55,0,1.02.18,1.4.54.38.36.57.82.57,1.37v38.98h20.67c.55,0,1.01.17,1.37.51Z"/><path class="cls-1" d="M273.01,45.66c-.38.38-.85.57-1.4.57-.6,0-1.07-.18-1.44-.54-.36-.36-.54-.84-.54-1.44V3.55c0-.59.19-1.07.57-1.44.38-.36.87-.54,1.47-.54.55,0,1.02.19,1.4.57.38.38.57.85.57,1.4v40.71c-.04.55-.25,1.02-.64,1.4Z"/><path class="cls-1" d="M374.75,35.71c-1.83,3.49-4.36,6.22-7.59,8.2-3.23,1.98-6.91,2.97-11.04,2.97s-7.81-.99-11.04-2.97c-3.23-1.98-5.76-4.71-7.59-8.2-1.83-3.49-2.74-7.42-2.74-11.8s.91-8.38,2.74-11.87c1.83-3.49,4.36-6.21,7.59-8.17,3.23-1.96,6.91-2.93,11.04-2.93s7.81.98,11.04,2.93c3.23,1.96,5.76,4.68,7.59,8.17,1.83,3.49,2.74,7.44,2.74,11.87s-.92,8.32-2.74,11.8ZM371.21,13.98c-1.47-2.91-3.51-5.18-6.12-6.79-2.62-1.62-5.61-2.43-8.97-2.43s-6.35.81-8.96,2.43-4.66,3.88-6.12,6.79c-1.47,2.91-2.2,6.22-2.2,9.92s.73,7.01,2.2,9.92c1.47,2.91,3.51,5.18,6.12,6.79,2.62,1.62,5.6,2.43,8.96,2.43s6.35-.81,8.97-2.43c2.62-1.62,4.66-3.88,6.12-6.79,1.47-2.91,2.2-6.22,2.2-9.92s-.73-7.01-2.2-9.92Z"/><path class="cls-1" d="M81.91,5.27h-23.51c-1.02,0-1.84-.82-1.84-1.84s.82-1.84,1.84-1.84h23.51c1.02,0,1.84.82,1.84,1.84s-.82,1.84-1.84,1.84Z"/><path class="cls-1" d="M40.23,2.12c.36.36.54.82.54,1.37v40.83c0,.55-.19,1.01-.57,1.37-.38.36-.85.54-1.4.54-.6,0-1.08-.18-1.47-.54-.38-.36-.57-.82-.57-1.37V9.23l-14.99,22.71c-.43.55-.92.81-1.47.77h-.13c-.51,0-.98-.26-1.4-.77L3.76,9.1v35.22c0,.55-.18,1.01-.54,1.37-.36.36-.82.54-1.37.54s-1-.18-1.34-.54c-.34-.36-.51-.82-.51-1.37V3.49c0-.51.18-.96.54-1.34.36-.38.82-.57,1.37-.57.3,0,.62.08.96.22.34.15.6.35.77.61l16.72,25.07L37.2,2.4c.47-.64,1.04-.91,1.72-.83.51,0,.95.18,1.31.54Z"/><path class="cls-1" d="M81.91,46.21h-23.51c-1.02,0-1.84-.82-1.84-1.84v-13.2c0-1.02.82-1.84,1.84-1.84h20.67c1.02,0,1.84.82,1.84,1.84s-.82,1.84-1.84,1.84h-18.83v9.52h21.67c1.02,0,1.84.82,1.84,1.84s-.82,1.84-1.84,1.84Z"/><path class="cls-1" d="M218.29,47.09c-.73,0-1.41-.43-1.7-1.14l-15.21-37.2-12.73,30.91,11.1-8.47c.81-.62,1.96-.46,2.58.35.62.81.46,1.96-.35,2.58l-16.51,12.6c-.66.5-1.58.5-2.24,0-.66-.51-.9-1.39-.58-2.16L199.68,3.21c.28-.69.96-1.14,1.7-1.14h0c.75,0,1.42.45,1.7,1.14l16.91,41.35c.38.94-.07,2.02-1.01,2.4-.23.09-.46.14-.7.14Z"/><path class="cls-1" d="M315.76,23.78c-1.05,0-1.9-.85-1.9-1.9s.85-1.9,1.9-1.9c4.82,0,4.96-4.85,4.96-5.4v-6.25c0-.87-.71-1.59-1.59-1.59s-1.59.71-1.59,1.59v1.07c0,1.05-.85,1.9-1.9,1.9s-1.9-.85-1.9-1.9v-1.07c0-2.97,2.42-5.39,5.39-5.39s5.39,2.42,5.39,5.39v6.25c0,3.18-1.83,9.2-8.76,9.2Z"/><path class="cls-1" d="M53,72.95v2.09c.54-1.53,1.66-2.34,3.18-2.34s2.64.82,3.1,2.3c.65-1.53,1.78-2.3,3.31-2.3,2.11,0,3.31,1.46,3.31,3.98v7.03h-1.5v-6.9c0-1.83-.77-2.82-2.26-2.82-1.63,0-2.64,1.2-2.64,3.18v6.54h-1.48v-6.99c0-1.74-.82-2.73-2.24-2.73-1.63,0-2.69,1.33-2.69,3.44v6.28h-1.48v-10.75h1.4Z"/><path class="cls-1" d="M72.57,80.86c0-1.03.45-1.87,1.31-2.41.77-.45,1.83-.75,3.53-.97l2.39-.28v-.17c0-2.21-.77-3.1-2.6-3.1-1.61,0-2.6.84-2.69,2.37h-1.61c.13-2.21,1.81-3.61,4.28-3.61,2.88,0,4.13,1.33,4.13,4.45v2.79c0,1.68.11,2.88.34,3.76h-1.57c-.11-.58-.17-1.35-.19-2.15-.52,1.51-1.89,2.41-3.74,2.41-2.15,0-3.57-1.25-3.57-3.1ZM79.82,79.01v-.69l-3.05.43c-1.83.26-2.62.88-2.62,2.06s.9,1.89,2.34,1.89c2,0,3.33-1.5,3.33-3.7Z"/><path class="cls-1" d="M88.98,72.95h1.42v2.37c.65-1.74,1.89-2.62,3.68-2.62,2.41,0,3.66,1.48,3.66,4.36v6.64h-1.51v-6.56c0-2.08-.9-3.16-2.6-3.16-1.94,0-3.16,1.55-3.16,4.06v5.65h-1.48v-10.75Z"/><path class="cls-1" d="M105.03,79.76v-6.82h1.48v6.67c0,2.11.99,3.05,2.45,3.05,1.96,0,3.14-1.68,3.14-3.85v-5.87h1.5v10.75h-1.42v-2.21c-.49,1.42-1.85,2.47-3.48,2.47-2.69,0-3.68-1.63-3.68-4.19Z"/><path class="cls-1" d="M126.32,74.19h-2.79v9.5h-1.48v-9.5h-2.02v-1.25h2.02v-1.78c0-1.94,1.14-3.18,3.01-3.18.47,0,.9.04,1.27.15v1.29c-.37-.06-.73-.11-1.08-.11-1.2,0-1.72.64-1.72,2.04v1.59h2.79v1.25Z"/><path class="cls-1" d="M131.63,80.86c0-1.03.45-1.87,1.31-2.41.77-.45,1.83-.75,3.53-.97l2.39-.28v-.17c0-2.21-.77-3.1-2.6-3.1-1.61,0-2.6.84-2.69,2.37h-1.61c.13-2.21,1.81-3.61,4.28-3.61,2.88,0,4.13,1.33,4.13,4.45v2.79c0,1.68.11,2.88.34,3.76h-1.57c-.11-.58-.17-1.35-.19-2.15-.52,1.51-1.89,2.41-3.74,2.41-2.15,0-3.57-1.25-3.57-3.1ZM138.87,79.01v-.69l-3.05.43c-1.83.26-2.62.88-2.62,2.06s.9,1.89,2.34,1.89c2,0,3.33-1.5,3.33-3.7Z"/><path class="cls-1" d="M146.94,78.32c0-3.5,1.87-5.63,4.88-5.63,2.45,0,4.08,1.44,4.34,3.89l-1.53.17c-.22-1.78-1.25-2.75-2.88-2.75-2,0-3.23,1.61-3.23,4.3s1.23,4.34,3.29,4.34c1.61,0,2.62-.97,2.9-2.75l1.44.21c-.39,2.43-1.98,3.85-4.34,3.85-2.99,0-4.88-2.17-4.88-5.63Z"/><path class="cls-1" d="M161.5,72.95h1.98v-2.84l1.5-.64v3.48h2.77v1.25h-2.77v6.45c0,1.27.56,1.83,1.68,1.83.43,0,.73-.04,1.1-.13v1.35c-.45.13-.88.19-1.48.19-2.09,0-2.79-1.27-2.79-3.18v-6.51h-1.98v-1.25Z"/><path class="cls-1" d="M174.15,79.76v-6.82h1.48v6.67c0,2.11.99,3.05,2.45,3.05,1.96,0,3.14-1.68,3.14-3.85v-5.87h1.5v10.75h-1.42v-2.21c-.49,1.42-1.85,2.47-3.48,2.47-2.69,0-3.68-1.63-3.68-4.19Z"/><path class="cls-1" d="M195.41,72.69c.15,0,.26,0,.41.02v1.46h-.17c-1.03,0-1.76.3-2.3.82-.99.99-1.18,2.43-1.18,3.78v4.92h-1.48v-10.75h1.4v2.62c.49-1.66,1.68-2.88,3.33-2.88Z"/><path class="cls-1" d="M210.34,78.71h-7.8c.02,2.43,1.35,3.91,3.44,3.91,1.5,0,2.58-.84,3.03-2.3l1.27.52c-.67,2-2.24,3.12-4.41,3.12-3.05,0-4.84-1.96-4.84-5.57s1.81-5.7,4.77-5.7,4.54,1.72,4.54,4.99v1.03ZM208.81,77.29c0-2.21-1.12-3.4-3.03-3.4s-3.2,1.38-3.25,3.59h6.28v-.19Z"/><path class="cls-1" d="M225.95,78.32c0-3.31,1.87-5.63,4.6-5.63,1.55,0,2.73.71,3.38,2.21v-6.79h1.5v15.59h-1.42v-2.28c-.62,1.59-1.91,2.54-3.63,2.54-2.67,0-4.43-2.28-4.43-5.63ZM233.95,78.56v-.45c0-2.45-1.18-4.08-3.18-4.08s-3.22,1.61-3.22,4.3,1.2,4.3,3.2,4.3,3.2-1.68,3.2-4.06Z"/><path class="cls-1" d="M243.37,68.65h1.7v2.37h-1.7v-2.37ZM243.48,72.95h1.48v10.75h-1.48v-10.75Z"/><path class="cls-1" d="M259.37,73.7c.69.64,1.08,1.55,1.08,2.6,0,2.08-1.48,3.63-3.91,3.63-.79,0-1.48-.17-2.06-.47-.54.21-.92.62-.92,1.18,0,.69.54,1.23,1.83,1.23h2.82c2.32,0,3.5,1.05,3.5,2.92,0,2.02-1.59,3.35-5.18,3.35s-4.82-1.35-4.82-2.99c0-1.03.64-1.91,1.81-2.28-.9-.37-1.29-1.05-1.29-1.85,0-1.01.6-1.72,1.53-2.06-.71-.67-1.12-1.59-1.12-2.67,0-2.09,1.5-3.61,3.91-3.61.82,0,1.53.17,2.11.47.3-1.12,1.14-1.93,2.54-1.93.19,0,.41.02.62.06v1.33c-.19-.04-.41-.09-.69-.09-.86,0-1.46.41-1.74,1.16ZM255.33,83.18c-.3,0-.58-.02-.84-.04-.88.34-1.31,1.03-1.31,1.76,0,1.44,1.4,2,3.5,2,2.67,0,3.5-.84,3.5-2.02,0-1.1-.8-1.7-2.34-1.7h-2.52ZM259.03,76.32c0-1.44-.99-2.47-2.49-2.47s-2.49,1.01-2.49,2.45.99,2.47,2.49,2.47,2.49-1.01,2.49-2.45Z"/><path class="cls-1" d="M268.12,68.65h1.7v2.37h-1.7v-2.37ZM268.23,72.95h1.48v10.75h-1.48v-10.75Z"/><path class="cls-1" d="M276.08,72.95h1.98v-2.84l1.5-.64v3.48h2.77v1.25h-2.77v6.45c0,1.27.56,1.83,1.68,1.83.43,0,.73-.04,1.1-.13v1.35c-.45.13-.88.19-1.48.19-2.09,0-2.79-1.27-2.79-3.18v-6.51h-1.98v-1.25Z"/><path class="cls-1" d="M287.98,80.86c0-1.03.45-1.87,1.31-2.41.77-.45,1.83-.75,3.53-.97l2.39-.28v-.17c0-2.21-.77-3.1-2.6-3.1-1.61,0-2.6.84-2.69,2.37h-1.61c.13-2.21,1.81-3.61,4.28-3.61,2.88,0,4.13,1.33,4.13,4.45v2.79c0,1.68.11,2.88.34,3.76h-1.57c-.11-.58-.17-1.35-.19-2.15-.52,1.51-1.89,2.41-3.74,2.41-2.15,0-3.57-1.25-3.57-3.1ZM295.22,79.01v-.69l-3.05.43c-1.83.26-2.62.88-2.62,2.06s.9,1.89,2.34,1.89c2,0,3.33-1.5,3.33-3.7Z"/><path class="cls-1" d="M305.98,83.7h-1.48v-15.59h1.48v15.59Z"/><path class="cls-1" d="M322.34,78.71h-7.8c.02,2.43,1.35,3.91,3.44,3.91,1.5,0,2.58-.84,3.03-2.3l1.27.52c-.67,2-2.24,3.12-4.41,3.12-3.05,0-4.84-1.96-4.84-5.57s1.81-5.7,4.77-5.7,4.54,1.72,4.54,4.99v1.03ZM320.81,77.29c0-2.21-1.12-3.4-3.03-3.4s-3.2,1.38-3.25,3.59h6.28v-.19Z"/></svg>


--------------------------------------------------------------------------------
/doc/assets/page.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 | 
3 | document.addEventListener('DOMContentLoaded', function () {
4 |   const burger = document.querySelector('.c-menu__header');
5 |   const nav = document.querySelector('.c-menu__list');
6 |   burger.addEventListener('click', function () {
7 |     nav.classList.toggle('is-active');
8 |   });
9 | });


--------------------------------------------------------------------------------
/doc/assets/scss/01_settings/_settings.breakpoints.scss:
--------------------------------------------------------------------------------
1 | $breakpoints: (
2 |   xs: 565px,
3 |   md: 768px,
4 |   lg: 992px,
5 |   xl: 1200px,
6 |   xxl: 1400px,
7 | ) !default;
8 | 


--------------------------------------------------------------------------------
/doc/assets/scss/01_settings/_settings.colors.scss:
--------------------------------------------------------------------------------
 1 | :root {
 2 |   --color-white:        #ffffff;
 3 |   --color-blue:         #2b3d50;
 4 |   --color-blue-grey:    #3a4b5c;
 5 |   --color-orange:       #fb320b;
 6 |   --color-grey-xlight:  #f7f7f7;
 7 |   --color-grey-light:   #efefef;
 8 |   --color-grey:         #8c8c8e;
 9 |   --color-grey-text:    #696a6c;
10 |   --color-pink:         #e409d2;
11 | 
12 |   --color-text:         var(--color-blue);
13 |   --color-bg:           var(--color-grey-light);
14 |   --color-code:         var(--color-white);
15 |   --color-code-bg-bash: var(--color-blue-grey);
16 |   --color-code-bg-yaml: var(--color-blue-grey);
17 |   --color-strong:       var(--color-grey-text);
18 | }


--------------------------------------------------------------------------------
/doc/assets/scss/01_settings/_settings.fonts.scss:
--------------------------------------------------------------------------------
 1 | :root {
 2 |   --font-primary: 'Work Sans', sans-serif;
 3 |   --font-secondary: 'Anton', sans-serif;
 4 | }
 5 | 
 6 | /* anton-regular - latin */
 7 | @font-face {
 8 |   font-display: swap;
 9 |   font-family: 'Anton';
10 |   font-style: normal;
11 |   font-weight: 400;
12 |   src: url('../fonts/anton-v25-latin-regular.woff2') format('woff2');
13 | }
14 | 
15 | /* work-sans-regular - latin */
16 | @font-face {
17 |   font-display: swap;
18 |   font-family: 'Work Sans';
19 |   font-style: normal;
20 |   font-weight: 400;
21 |   src: url('../fonts/work-sans-v19-latin-regular.woff2') format('woff2');
22 | }
23 | 
24 | /* work-sans-600 - latin */
25 | @font-face {
26 |   font-display: swap;
27 |   font-family: 'Work Sans';
28 |   font-style: normal;
29 |   font-weight: 600;
30 |   src: url('../fonts/work-sans-v19-latin-600.woff2') format('woff2');
31 | }
32 | 
33 | /* work-sans-700 - latin */
34 | @font-face {
35 |   font-display: swap;
36 |   font-family: 'Work Sans';
37 |   font-style: normal;
38 |   font-weight: 700;
39 |   src: url('../fonts/work-sans-v19-latin-700.woff2') format('woff2');
40 | }


--------------------------------------------------------------------------------
/doc/assets/scss/01_settings/_settings.hover.scss:
--------------------------------------------------------------------------------
1 | @mixin hover {
2 |   @media (hover: hover) {
3 |     &:hover {
4 |       @content;
5 |     }
6 |   }
7 | }


--------------------------------------------------------------------------------
/doc/assets/scss/01_settings/_settings.media-queries.scss:
--------------------------------------------------------------------------------
 1 | /* ===================================================================
 2 |  * MIXINS
 3 |  * =================================================================*/
 4 | 
 5 | /**
 6 |  * MIN-WIDTH
 7 |  */
 8 | @mixin min-width($breakpoint) {
 9 | 
10 |   // If the breakpoint exists in the map.
11 |   @if map-has-key($breakpoints, $breakpoint) {
12 | 
13 |     // Get the breakpoint value.
14 |     $breakpoint-value: map-get($breakpoints, $breakpoint);
15 | 
16 |     // Write the media query.
17 |     @media (min-width: $breakpoint-value) {
18 |       @content;
19 |     }
20 | 
21 |     // If the breakpoint doesn't exist in the map.
22 |   } @else {
23 | 
24 |     // Log a warning.
25 |     @warn 'Invalid breakpoint: #{$breakpoint}.';
26 |   }
27 | }
28 | 
29 | 
30 | /**
31 |  * MAX-WIDTH
32 |  */
33 | @mixin max-width($breakpoint) {
34 | 
35 |   // If the breakpoint exists in the map.
36 |   @if map-has-key($breakpoints, $breakpoint) {
37 | 
38 |     // Get the breakpoint value.
39 |     $breakpoint-value: map-get($breakpoints, $breakpoint);
40 | 
41 |     // Write the media query.
42 |     @media (max-width: ($breakpoint-value - 1)) {
43 |       @content;
44 |     }
45 | 
46 |     // If the breakpoint doesn't exist in the map.
47 |   } @else {
48 | 
49 |     // Log a warning.
50 |     @warn 'Invalid breakpoint: #{$breakpoint}.';
51 |   }
52 | }
53 | 
54 | 
55 | /**
56 |  * MIN-WIDTH and MAX-WIDTH
57 |  */
58 | @mixin min-max-width($lower, $upper) {
59 | 
60 |   // If both the lower and upper breakpoints exist in the map.
61 |   @if map-has-key($breakpoints, $lower) and map-has-key($breakpoints, $upper) {
62 | 
63 |     // Get the lower and upper breakpoints.
64 |     $lower-breakpoint: map-get($breakpoints, $lower);
65 |     $upper-breakpoint: map-get($breakpoints, $upper);
66 | 
67 |     // Write the media query.
68 |     @media (min-width: $lower-breakpoint) and (max-width: ($upper-breakpoint - 1)) {
69 |       @content;
70 |     }
71 | 
72 |     // If one or both of the breakpoints don't exist.
73 |   } @else {
74 | 
75 |     // If lower breakpoint is invalid.
76 |     @if (map-has-key($breakpoints, $lower) == false) {
77 | 
78 |       // Log a warning.
79 |       @warn 'Your lower breakpoint was invalid: #{$lower}.';
80 |     }
81 | 
82 |     // If upper breakpoint is invalid.
83 |     @if (map-has-key($breakpoints, $upper) == false) {
84 | 
85 |       // Log a warning.
86 |       @warn 'Your upper breakpoint was invalid: #{$upper}.';
87 |     }
88 |   }
89 | }
90 | 


--------------------------------------------------------------------------------
/doc/assets/scss/01_settings/_settings.variables.scss:
--------------------------------------------------------------------------------
 1 | :root {
 2 |   // Layout
 3 |   --page-max-width: 140rem;
 4 | 
 5 |   @include min-width(lg) {
 6 |     --page-gutter: 4rem;
 7 |   }
 8 | 
 9 |   @include max-width(lg) {
10 |     --page-gutter: 2rem;
11 |   }
12 | 
13 |   // Transitions
14 |   --transition-in-out: 0.2s ease-in-out;
15 | 
16 |   // Radius
17 |   --radius-full: 360px;
18 | }


--------------------------------------------------------------------------------
/doc/assets/scss/02_generics/_generics.reset.scss:
--------------------------------------------------------------------------------
  1 | html {
  2 |   -webkit-text-size-adjust: 100%;
  3 |   -ms-text-size-adjust: 100%;
  4 |   -ms-overflow-style: scrollbar;
  5 |   -webkit-tap-highlight-color: transparent;
  6 | }
  7 | 
  8 | *,
  9 | *::before,
 10 | *::after {
 11 |   box-sizing: border-box;
 12 | }
 13 | 
 14 | @-ms-viewport {
 15 |   width: device-width;
 16 | }
 17 | 
 18 | article, aside, dialog, figcaption, figure, footer, header, hgroup, main, nav, section {
 19 |   display: block;
 20 | }
 21 | 
 22 | body {
 23 |   margin: 0;
 24 |   text-align: left;
 25 | }
 26 | 
 27 | [tabindex="-1"]:focus {
 28 |   outline: 0 !important;
 29 | }
 30 | 
 31 | hr {
 32 |   box-sizing: content-box;
 33 |   height: 0.1rem;
 34 |   overflow: visible;
 35 | }
 36 | 
 37 | h1, h2, h3, h4, h5, h6 {
 38 |   font-weight: normal;
 39 |   margin-top: 0;
 40 |   margin-bottom: 0;
 41 | }
 42 | 
 43 | p {
 44 |   margin: 0;
 45 | }
 46 | 
 47 | abbr[title], abbr[data-original-title] {
 48 |   text-decoration: underline;
 49 |   -webkit-text-decoration: underline dotted;
 50 |   text-decoration: underline dotted;
 51 |   cursor: help;
 52 |   border-bottom: 0;
 53 | }
 54 | 
 55 | address {
 56 |   margin-bottom: 1rem;
 57 |   font-style: normal;
 58 |   line-height: inherit;
 59 | }
 60 | 
 61 | ol, ul, dl {
 62 |   list-style-type: none;
 63 |   margin: 0;
 64 |   padding: 0 0 0 2rem;
 65 | }
 66 | 
 67 | ol ol, ul ul, ol ul, ul ol {
 68 |   margin-bottom: 0;
 69 | }
 70 | 
 71 | dt {
 72 |   font-weight: 700;
 73 | }
 74 | 
 75 | dd {
 76 |   margin-bottom: .5rem;
 77 |   margin-left: 0;
 78 | }
 79 | 
 80 | blockquote {
 81 |   margin: 0 0 1rem;
 82 | }
 83 | 
 84 | dfn {
 85 |   font-style: italic;
 86 | }
 87 | 
 88 | b, strong {
 89 |   font-weight: 700;
 90 | }
 91 | 
 92 | small {
 93 |   font-size: 80%;
 94 | }
 95 | 
 96 | sub, sup {
 97 |   position: relative;
 98 |   line-height: 0;
 99 |   vertical-align: baseline;
100 | }
101 | 
102 | sub {
103 |   bottom: 0;
104 | }
105 | 
106 | sup {
107 |   top: -.5em;
108 | }
109 | 
110 | a {
111 |   color: inherit;
112 |   background-color: transparent;
113 |   text-decoration: none;
114 |   text-underline-offset: 0.3rem;
115 |   -webkit-text-decoration-skip: objects;
116 | }
117 | 
118 | a:not([href]):not([tabindex]) {
119 |   text-decoration: none;
120 | }
121 | 
122 | a:not([href]):not([tabindex]):focus, a:not([href]):not([tabindex]):hover {
123 |   text-decoration: none;
124 | }
125 | 
126 | a:not([href]):not([tabindex]):focus {
127 |   outline: 0;
128 | }
129 | 
130 | pre, code, kbd, samp {
131 |   font-family: monospace, monospace;
132 |   font-size: 1em;
133 | }
134 | 
135 | pre {
136 |   margin-top: 0;
137 |   margin-bottom: 1rem;
138 |   overflow: auto;
139 |   -ms-overflow-style: scrollbar;
140 | }
141 | 
142 | figure {
143 |   margin: 0 0 1rem;
144 | }
145 | 
146 | img,
147 | video {
148 |   vertical-align: middle;
149 |   border-style: none;
150 |   max-width: 100%;
151 |   height: auto;
152 | }
153 | 
154 | svg:not(:root) {
155 |   //fill: currentColor;
156 |   display: block;
157 |   overflow: hidden;
158 | }
159 | 
160 | a, area, button, [role="button"], input:not([type="range"]), label, select, summary, textarea {
161 |   -ms-touch-action: manipulation;
162 |   touch-action: manipulation;
163 | }
164 | 
165 | table {
166 |   border-collapse: collapse;
167 | }
168 | 
169 | caption {
170 |   padding-top: 0.75rem;
171 |   padding-bottom: 0.75rem;
172 |   color: #6c757d;
173 |   text-align: left;
174 |   caption-side: bottom;
175 | }
176 | 
177 | th {
178 |   text-align: inherit;
179 | }
180 | 
181 | label, button, select {
182 |   cursor: pointer;
183 | }
184 | 
185 | label {
186 |   display: inline-block;
187 | }
188 | 
189 | button {
190 |   background: none;
191 |   border: 0;
192 |   border-radius: 0;
193 |   text-underline-offset: 0.3rem;
194 | }
195 | 
196 | input, button, select, optgroup, textarea {
197 |   border-radius: 0;
198 |   margin: 0;
199 |   font-family: inherit;
200 |   font-size: inherit;
201 |   line-height: inherit;
202 | }
203 | 
204 | button, input {
205 |   overflow: visible;
206 | }
207 | 
208 | button, select {
209 |   text-transform: none;
210 | }
211 | 
212 | button, html [type="button"], [type="reset"], [type="submit"] {
213 |   -webkit-appearance: button;
214 | }
215 | 
216 | button::-moz-focus-inner, [type="button"]::-moz-focus-inner, [type="reset"]::-moz-focus-inner, [type="submit"]::-moz-focus-inner {
217 |   padding: 0;
218 |   border-style: none;
219 | }
220 | 
221 | input[type="radio"], input[type="checkbox"] {
222 |   box-sizing: border-box;
223 |   padding: 0;
224 | }
225 | 
226 | input[type="date"], input[type="time"], input[type="datetime-local"], input[type="month"] {
227 |   -webkit-appearance: listbox;
228 | }
229 | 
230 | textarea {
231 |   overflow: auto;
232 |   resize: vertical;
233 | }
234 | 
235 | fieldset {
236 |   min-width: 0;
237 |   padding: 0;
238 |   margin: 0;
239 |   border: 0;
240 | }
241 | 
242 | legend {
243 |   display: block;
244 |   width: 100%;
245 |   max-width: 100%;
246 |   padding: 0;
247 |   margin-bottom: .5rem;
248 |   font-size: 1.5rem;
249 |   line-height: inherit;
250 |   color: inherit;
251 |   white-space: normal;
252 | }
253 | 
254 | progress {
255 |   vertical-align: baseline;
256 | }
257 | 
258 | [type="number"]::-webkit-inner-spin-button, [type="number"]::-webkit-outer-spin-button {
259 |   height: auto;
260 | }
261 | 
262 | [type="search"] {
263 |   outline-offset: -2px;
264 |   -webkit-appearance: none;
265 | }
266 | 
267 | [type="search"]::-webkit-search-cancel-button, [type="search"]::-webkit-search-decoration {
268 |   -webkit-appearance: none;
269 | }
270 | 
271 | ::-webkit-file-upload-button {
272 |   font: inherit;
273 |   -webkit-appearance: button;
274 | }
275 | 
276 | output {
277 |   display: inline-block;
278 | }
279 | 
280 | summary {
281 |   display: list-item;
282 |   cursor: pointer;
283 | }
284 | 
285 | template {
286 |   display: none;
287 | }
288 | 
289 | [hidden] {
290 |   display: none !important;
291 | }
292 | 
293 | iframe {
294 |   border: 0;
295 | }
296 | 


--------------------------------------------------------------------------------
/doc/assets/scss/03_elements/_elements.page.scss:
--------------------------------------------------------------------------------
 1 | html {
 2 |   scroll-behavior: smooth;
 3 |   font-size: 62.5%;
 4 | }
 5 | 
 6 | @media (prefers-reduced-motion: reduce) {
 7 |   html {
 8 |     scroll-behavior: auto;
 9 |   }
10 | }
11 | 
12 | body {
13 |   font-family: var(--font-primary);
14 |   font-size: 1.6rem;
15 |   line-height: 2.4rem;
16 |   font-weight: 400;
17 |   color: var(--color-text);
18 |   overflow-x: hidden;
19 |   background-color: var(--color-bg);
20 | }
21 | 
22 | h1 {
23 |   font-size: 3.2rem;
24 |   line-height: 3.6rem;
25 |   margin-bottom: 2.4rem;
26 | }
27 | 
28 | h2 {
29 |   margin-top: 4rem;
30 |   margin-bottom: 1.6rem;
31 | }
32 | 
33 | h3 {
34 |   margin-top: 2.4rem;
35 |   margin-bottom: 1.6rem;
36 |   border-bottom: 1px solid var(--color-text);
37 | }
38 | 
39 | h4 {
40 |   font-size: 1.3rem;
41 |   font-weight: 600;
42 |   text-transform: uppercase;
43 |   margin-bottom: 0;
44 | }
45 | 
46 | strong {
47 |   color: var(--color-strong);
48 |   font-weight: 700;
49 | }
50 | 
51 | p {
52 |   margin-bottom: 2rem;
53 | }
54 | 
55 | ul {
56 |   margin-left: 3rem;
57 |   margin-bottom: 1.6rem;
58 | }
59 | 
60 | li {
61 |   list-style-type: disc;
62 | }
63 | 
64 | pre,
65 | code {
66 |   font-size: 1.4rem;
67 |   border: 1px solid #e8e8e8;
68 |   border-radius: 3px;
69 | }
70 | 
71 | 
72 | 


--------------------------------------------------------------------------------
/doc/assets/scss/04_objects/_objects.container.scss:
--------------------------------------------------------------------------------
1 | .o-container {
2 |   max-width: var(--page-max-width);
3 |   width: 100%;
4 |   margin-left: auto;
5 |   margin-right: auto;
6 |   padding-left: var(--page-gutter);
7 |   padding-right: var(--page-gutter);
8 | }


--------------------------------------------------------------------------------
/doc/assets/scss/05_components/_components.404.scss:
--------------------------------------------------------------------------------
 1 | .c-404 {
 2 |   display: flex;
 3 |   align-items: center;
 4 |   justify-content: center;
 5 |   flex-direction: column;
 6 |   gap: 4rem;
 7 |   height: 100%;
 8 | }
 9 | 
10 | .c-404__title {
11 |   font-family: var(--font-secondary);
12 |   font-size: 3.5rem;
13 |   line-height: 4.8rem;
14 |   margin: 0;
15 | }


--------------------------------------------------------------------------------
/doc/assets/scss/05_components/_components.advantages.scss:
--------------------------------------------------------------------------------
 1 | .c-advantages {
 2 |   background-color: var(--color-white);
 3 | 
 4 |   @include min-width(md) {
 5 |     padding: 14rem 0 6rem;
 6 |   }
 7 | 
 8 |   @include max-width(md) {
 9 |     padding: 6rem 0;
10 |   }
11 | }
12 | 
13 | .c-advantages__inner {
14 |   display: flex;
15 |   flex-direction: column;
16 |   align-items: center;
17 |   gap: 4.8rem;
18 | }
19 | 
20 | .c-advantages__title {
21 |   font-size: 2.8rem;
22 |   line-height: 4.2rem;
23 |   text-align: center;
24 |   margin: 0;
25 | }
26 | 
27 | .c-advantages__items {
28 |   display: flex;
29 |   justify-content: center;
30 |   gap: 5.6rem 4rem;
31 |   flex-wrap: wrap;
32 | }
33 | 
34 | .c-advantages__item {
35 |   display: flex;
36 |   flex-direction: column;
37 |   gap: 2rem;
38 | 
39 |   @include min-width(lg) {
40 |     flex: 0 1 calc(100% / 3 - 4rem);
41 |   }
42 | 
43 |   @include min-max-width(md, lg) {
44 |     flex: 0 1 calc(100% / 2 - 4rem);
45 |   }
46 | 
47 |   @include max-width(md) {
48 |     width: 100%;
49 |     align-items: center;
50 |   }
51 | }
52 | 
53 | .c-advantages__item-title {
54 |   font-size: 2.1rem;
55 |   line-height: normal;
56 |   font-weight: 600;
57 |   border-bottom: 0;
58 |   margin: 0;
59 | 
60 |   &::before {
61 |     content: '/';
62 |     color: var(--color-orange);
63 |     margin-right: 0.8rem;
64 |   }
65 | 
66 |   @include max-width(md) {
67 |     text-align: center;
68 |   }
69 | }
70 | 
71 | .c-advantages__item-description {
72 |   color: var(--color-grey-text);
73 | 
74 |   @include max-width(md) {
75 |     text-align: center;
76 |   }
77 | }
78 | 
79 | .c-advantages__logos {
80 |   display: flex;
81 |   align-items: center;
82 |   gap: 0.4rem;
83 | 
84 |   svg,
85 |   img {
86 |     width: 10rem;
87 |   }
88 | }


--------------------------------------------------------------------------------
/doc/assets/scss/05_components/_components.baseline.scss:
--------------------------------------------------------------------------------
 1 | .c-baseline {
 2 |   display: flex;
 3 |   flex-direction: column;
 4 |   gap: 4rem;
 5 | 
 6 |   @include max-width(md) {
 7 |     padding: 2rem 2rem 3rem;
 8 |   }
 9 | }
10 | 
11 | .c-baseline__inner {
12 |   display: flex;
13 |   flex-direction: column;
14 |   gap: 4rem;
15 | }
16 | 
17 | .c-baseline__inner-front {
18 |   .is-scrolled & {
19 |     @include min-width(md) {
20 |       display: none;
21 |     }
22 |   }
23 | }
24 | 
25 | .c-baseline__inner-back {
26 |   @include min-width(md) {
27 |     display: none;
28 | 
29 |     .is-scrolled & {
30 |       display: flex;
31 |     }
32 |   }
33 | }
34 | 
35 | .c-baseline__title {
36 |   transition: color var(--transition-in-out);
37 |   font-family: var(--font-secondary);
38 |   margin: 0;
39 | 
40 |   @include min-width(lg) {
41 |     font-size: 3.5rem;
42 |     line-height: 4.8rem;
43 |   }
44 | 
45 |   @include max-width(lg) {
46 |     font-size: 3rem;
47 |     line-height: 4.2rem;
48 |   }
49 | 
50 |   .is-scrolled & {
51 |     @include min-width(md) {
52 |       color: var(--color-white);
53 |     }
54 |   }
55 | }
56 | 
57 | .c-baseline__description {
58 |   transition: color var(--transition-in-out);
59 |   font-size: 1.8rem;
60 |   line-height: 3rem;
61 |   color: var(--color-grey-text);
62 |   margin-bottom: 0;
63 | 
64 |   .is-scrolled & {
65 |     @include min-width(md) {
66 |       color: var(--color-white);
67 |     }
68 |   }
69 | }
70 | 
71 | .c-baseline__button {
72 |   @include max-width(md) {
73 |     display: none;
74 |   }
75 | }


--------------------------------------------------------------------------------
/doc/assets/scss/05_components/_components.buttons.scss:
--------------------------------------------------------------------------------
 1 | .c-button {
 2 |   transition: color var(--transition-in-out), background-color var(--transition-in-out), box-shadow var(--transition-in-out);
 3 |   text-decoration: none;
 4 |   border-radius: var(--radius-full);
 5 |   display: inline-flex;
 6 |   justify-content: center;
 7 |   align-items: center;
 8 |   gap: 0.8rem;
 9 |   width: 16rem;
10 |   padding: 0.8rem 1.6rem;
11 |   font-size: 1.4rem;
12 | }
13 | 
14 | .c-button--plain {
15 |   color: var(--button-secondary);
16 |   background-color: var(--button-main);
17 |   box-shadow: 0 0 0 1px var(--button-main) inset;
18 | 
19 |   path {
20 |     fill: var(--button-secondary);
21 |   }
22 | 
23 |   @include hover {
24 |     color: var(--button-main);
25 |     background-color: var(--button-secondary);
26 | 
27 |     path {
28 |       fill: var(--button-main);
29 |     }
30 |   }
31 | }
32 | 
33 | .c-button--ghost {
34 |   color: var(--button-main);
35 |   background-color: transparent;
36 |   box-shadow: 0 0 0 1px var(--button-main) inset;
37 | 
38 |   @include hover {
39 |     color: var(--button-secondary);
40 |     background-color: var(--button-main);
41 |   }
42 | }
43 | 
44 | .c-button--blue {
45 |   --button-main: var(--color-blue);
46 |   --button-secondary: var(--color-white);
47 | }
48 | 
49 | .c-button--white {
50 |   --button-main: var(--color-white);
51 |   --button-secondary: var(--color-blue-grey);
52 | }
53 | 
54 | .c-button--orange {
55 |   --button-main: var(--color-orange);
56 |   --button-secondary: var(--color-white);
57 | }
58 | 
59 | .c-button__svg {
60 |   flex-shrink: 0;
61 |   width: 2rem;
62 | 
63 |   path {
64 |     transition: fill var(--transition-in-out);
65 |   }
66 | }


--------------------------------------------------------------------------------
/doc/assets/scss/05_components/_components.doc.scss:
--------------------------------------------------------------------------------
1 | .c-doc {
2 |   a {
3 |     text-decoration: underline !important;
4 |   }
5 | }


--------------------------------------------------------------------------------
/doc/assets/scss/05_components/_components.flip-card.scss:
--------------------------------------------------------------------------------
 1 | .c-flip-card {
 2 |   width: 100%;
 3 |   height: 100vh;
 4 |   perspective: 2000px;
 5 |   position: relative;
 6 |   top: 6rem;
 7 | 
 8 |   @include min-width(md) {
 9 |     flex: 1;
10 |   }
11 | 
12 |   @include max-width(md) {
13 |     display: none;
14 |   }
15 | 
16 |   .is-scrolled & {
17 |     .c-flip-card__inner {
18 |       transform: rotateX(180deg);
19 |     }
20 |   }
21 | }
22 | 
23 | .c-flip-card__inner {
24 |   position: relative;
25 |   width: 100%;
26 |   height: 100%;
27 |   transition: transform 0.6s;
28 |   transform-style: preserve-3d;
29 | }
30 | 
31 | .c-flip-card__face {
32 |   position: absolute;
33 |   width: 100%;
34 |   height: 100%;
35 |   -webkit-backface-visibility: hidden;
36 |   backface-visibility: hidden;
37 |   border-radius: 8px 0 0 8px;
38 |   overflow: hidden;
39 |   padding: 4.8rem 2rem 2rem;
40 | }
41 | 
42 | .c-flip-card__ellipsis {
43 |   background: url('../ico-ellipse.png') repeat-x 0 0;
44 |   position: absolute;
45 |   top: 2rem;
46 |   left: 2rem;
47 |   display: block;
48 |   width: 4.8rem;
49 |   height: 1.2rem;
50 |   z-index: 1;
51 | }
52 | 
53 | .c-flip-card__face--front {
54 |   background-color: var(--color-blue-grey);
55 | 
56 |   .ap-player {
57 |     --term-color-background: var(--color-blue-grey);
58 |   }
59 | }
60 | 
61 | .c-flip-card__face--back {
62 |   background-color: var(--color-grey-xlight);
63 |   transform: rotateX(180deg);
64 | }
65 | 
66 | .c-flip-card__pre {
67 |   border: 0;
68 |   background-color: transparent;
69 | }
70 | 
71 | .c-flip-card__code {
72 |   width: 100%;
73 |   display: block;
74 |   padding: 0;
75 |   border: 0;
76 |   color: black;
77 |   background-color: transparent;
78 | }
79 | 
80 | .c-flip-card__position {
81 |   position: relative;
82 |   top: 0;
83 |   display: inline-block;
84 |   width: 3.5rem;
85 |   font-size: 1.5rem;
86 |   line-height: 2.5rem;
87 |   letter-spacing: -1px;
88 |   border-right: 1px solid var(--color-grey);
89 |   color: var(--color-grey);
90 |   margin-right: 0.8rem;
91 | }
92 | 
93 | .c-flip-card__line {
94 |   position: absolute;
95 |   text-align: right;
96 |   right: 1.7rem;
97 |   font-size: 1.5rem;
98 | }


--------------------------------------------------------------------------------
/doc/assets/scss/05_components/_components.footer.scss:
--------------------------------------------------------------------------------
 1 | .c-footer {
 2 |   background-color: var(--color-blue-grey);
 3 |   padding: 3.2rem;
 4 |   display: flex;
 5 |   flex-wrap: wrap;
 6 |   align-items: center;
 7 |   justify-content: center;
 8 |   gap: 2rem;
 9 |   color: var(--color-white);
10 |   font-size: 1.8rem;
11 |   line-height: normal;
12 | 
13 |   @include max-width(md) {
14 |     flex-direction: column;
15 |     align-items: center;
16 |   }
17 | 
18 |   .c-layout-page & {
19 |     @include min-width(lg) {
20 |       grid-column: 1 / 2;
21 |       grid-row: 2 / 3;
22 |     }
23 |   }
24 | }
25 | 
26 | .c-footer__mezcalito {
27 |   width: 15rem;
28 |   fill: #fff;
29 |   stroke-width: 0;
30 | }


--------------------------------------------------------------------------------
/doc/assets/scss/05_components/_components.header.scss:
--------------------------------------------------------------------------------
  1 | .c-header {
  2 |   background-color: var(--color-grey-xlight);
  3 | 
  4 |   .c-layout-page & {
  5 |     @include min-width(xl) {
  6 |       padding: 8rem 6% 5.6rem;
  7 |     }
  8 | 
  9 |     @include min-max-width(lg, xl) {
 10 |       padding: 3rem 2rem 2rem;
 11 |     }
 12 | 
 13 |     @include min-width(lg) {
 14 |       grid-column: 1 / 2;
 15 |       grid-row: 1 / 2;
 16 |     }
 17 |   }
 18 | 
 19 |   .c-layout-homepage & {
 20 |     display: flex;
 21 |     background-color: var(--color-bg);
 22 |     transition: background-color var(--transition-in-out);
 23 | 
 24 |     &.is-scrolled {
 25 |       @include min-width(md) {
 26 |         background-color: var(--color-blue);
 27 |       }
 28 |     }
 29 |   }
 30 | }
 31 | 
 32 | .c-header__inner {
 33 |   .c-layout-homepage & {
 34 |     @include min-width(md) {
 35 |       flex: 1;
 36 |     }
 37 |   }
 38 | }
 39 | 
 40 | .c-header__content {
 41 |   display: flex;
 42 |   flex-direction: column;
 43 | 
 44 |   @include max-width(lg) {
 45 |     gap: 3.2rem;
 46 |   }
 47 | 
 48 |   .c-layout-page & {
 49 |     @include min-width(lg) {
 50 |       gap: 4rem;
 51 |     }
 52 |   }
 53 | 
 54 |   .c-layout-homepage & {
 55 |     @include min-width(lg) {
 56 |       gap: 5.6rem;
 57 |       padding: 8rem 10% 5.6rem;
 58 |     }
 59 | 
 60 |     @include min-max-width(md, lg) {
 61 |       padding: 4.8rem 3.2rem 3.2rem;
 62 |     }
 63 |   }
 64 | }
 65 | 
 66 | .c-header__actions {
 67 |   display: flex;
 68 |   flex-direction: column;
 69 | 
 70 |   @include min-width(lg) {
 71 |     gap: 4rem;
 72 |   }
 73 | 
 74 |   @include max-width(lg) {
 75 |     align-items: center;
 76 |     gap: 2rem;
 77 |   }
 78 | 
 79 |   .c-layout-page & {
 80 |     @include max-width(lg) {
 81 |       padding: 2rem 2rem 0;
 82 |     }
 83 |   }
 84 | 
 85 |   .c-layout-homepage & {
 86 |     @include min-max-width(md, lg) {
 87 |       padding: 0;
 88 |     }
 89 | 
 90 |     @include max-width(md) {
 91 |       padding: 2rem 2rem 0;
 92 |     }
 93 |   }
 94 | }
 95 | 
 96 | .c-header__logo-default {
 97 |   .c-layout-homepage .is-scrolled & {
 98 |     @include min-width(md) {
 99 |       display: none;
100 |     }
101 |   }
102 | }
103 | 
104 | .c-header__logo-white {
105 |   display: none;
106 | 
107 |   .c-layout-homepage .is-scrolled & {
108 |     @include min-width(md) {
109 |       display: block;
110 |     }
111 |   }
112 | }
113 | 
114 | .c-header__buttons {
115 |   display: flex;
116 |   align-items: center;
117 |   gap: 1.2rem 2rem;
118 | 
119 |   @include max-width(lg) {
120 |     flex-wrap: wrap;
121 |     justify-content: center;
122 |   }
123 | }
124 | 
125 | .c-header__button {
126 |   @include min-width(lg) {
127 |     .c-layout-homepage .is-scrolled & {
128 |       --button-main: var(--color-white);
129 |       --button-secondary: var(--color-blue-grey);
130 | 
131 |       path {
132 |         fill: var(--button-main);
133 |       }
134 | 
135 |       @include hover {
136 |         path {
137 |           fill: var(--button-secondary);
138 |         }
139 |       }
140 |     }
141 |   }
142 | }


--------------------------------------------------------------------------------
/doc/assets/scss/05_components/_components.layout.scss:
--------------------------------------------------------------------------------
 1 | .c-layout-page {
 2 |   @include min-width(lg) {
 3 |     display: grid;
 4 |     grid-template-columns: minmax(36rem, 30%) auto;
 5 |     grid-template-rows: 1fr auto;
 6 |   }
 7 | }
 8 | 
 9 | .c-layout-homepage {
10 | 
11 | }


--------------------------------------------------------------------------------
/doc/assets/scss/05_components/_components.main.scss:
--------------------------------------------------------------------------------
 1 | .c-main {
 2 |   .c-layout-page & {
 3 |     @include min-width(xl) {
 4 |       padding: 8rem 4rem 5.6rem;
 5 |     }
 6 | 
 7 |     @include max-width(xl) {
 8 |       padding: 3rem 2rem 2rem;
 9 |     }
10 | 
11 |     @include min-width(lg) {
12 |       height: 100vh;
13 |       overflow-y: auto;
14 |       grid-column: 2 / 3;
15 |       grid-row: 1 / 3;
16 |     }
17 |   }
18 | }


--------------------------------------------------------------------------------
/doc/assets/scss/05_components/_components.menu.scss:
--------------------------------------------------------------------------------
 1 | .c-menu {
 2 |   display: flex;
 3 |   flex-direction: column;
 4 | 
 5 |   @include min-width(lg) {
 6 |     gap: 2.4rem;
 7 |   }
 8 | 
 9 |   @include max-width(lg) {
10 |     gap: 0;
11 |   }
12 | }
13 | 
14 | .c-menu__header {
15 |   display: flex;
16 |   align-items: center;
17 |   justify-content: space-between;
18 |   gap: 1.2rem;
19 |   text-transform: uppercase;
20 |   font-size: 1.4rem;
21 |   font-weight: 600;
22 |   color: var(--color-grey);
23 |   text-align: left;
24 | 
25 |   @include min-width(lg) {
26 |     padding: 0;
27 |   }
28 | 
29 |   @include max-width(lg) {
30 |     padding: 1.2rem 2rem;
31 |     border-top: 1px solid var(--color-grey);
32 |     border-bottom: 1px solid var(--color-grey);
33 |   }
34 | }
35 | 
36 | .c-menu__list {
37 |   display: flex;
38 |   flex-direction: column;
39 |   list-style-type: none;
40 |   margin: 0;
41 |   padding: 0;
42 | 
43 |   @include min-width(lg) {
44 |     gap: 2rem;
45 |   }
46 | 
47 |   @include max-width(lg) {
48 |     display: none;
49 | 
50 |     &.is-active {
51 |       display: flex;
52 |     }
53 |   }
54 | }
55 | 
56 | .c-menu__item {
57 |   list-style-type: none;
58 | }
59 | 
60 | .c-menu__link {
61 |   font-size: 1.5rem;
62 |   font-weight: 600;
63 | 
64 |   @include hover {
65 |     color: var(--color-orange);
66 |     text-decoration: underline;
67 |   }
68 | 
69 |   @include max-width(lg) {
70 |     display: flex;
71 |     padding: 1.2rem 2rem;
72 |   }
73 | 
74 |   &.is-current {
75 |     color: var(--color-orange);
76 |   }
77 | }
78 | 
79 | .c-menu__burger {
80 |   @include min-width(lg) {
81 |     display: none !important;
82 |   }
83 | }


--------------------------------------------------------------------------------
/doc/assets/scss/05_components/_components.starting.scss:
--------------------------------------------------------------------------------
 1 | .c-starting {
 2 |   background: url('../bg-starting.png') no-repeat top var(--color-grey-light);
 3 |   padding-top: 10rem;
 4 |   padding-bottom: 6rem;
 5 | }
 6 | 
 7 | .c-starting__inner {
 8 |   display: flex;
 9 |   flex-direction: column;
10 |   align-items: center;
11 |   gap: 3.2rem;
12 | }
13 | 
14 | .c-starting__header {
15 |   display: flex;
16 |   flex-direction: column;
17 |   align-items: center;
18 |   gap: 2rem;
19 | }
20 | 
21 | .c-starting__title {
22 |   font-family: var(--font-secondary);
23 |   font-size: 3.5rem;
24 |   margin: 0;
25 | }
26 | 
27 | .c-starting__description {
28 |   margin-bottom: 0;
29 |   color: var(--color-grey-text);
30 |   text-align: center;
31 | }
32 | 
33 | .c-starting__command {
34 |   background-color: var(--color-code-bg-bash);
35 |   color: var(--color-code);
36 |   padding: 4rem 2.4rem;
37 |   text-align: center;
38 |   overflow-x: auto;
39 |   white-space: nowrap;
40 |   width: 74rem;
41 |   max-width: 100%;
42 | }
43 | 
44 | .c-starting__curl {
45 |   color: var(--color-pink);
46 | }


--------------------------------------------------------------------------------
/doc/assets/typewriter.js:
--------------------------------------------------------------------------------
1 | !function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define("Typewriter",[],t):"object"==typeof exports?exports.Typewriter=t():e.Typewriter=t()}("undefined"!=typeof self?self:this,(function(){return function(e){var t={};function n(r){if(t[r])return t[r].exports;var o=t[r]={i:r,l:!1,exports:{}};return e[r].call(o.exports,o,o.exports,n),o.l=!0,o.exports}return n.m=e,n.c=t,n.d=function(e,t,r){n.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:r})},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.t=function(e,t){if(1&t&&(e=n(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var r=Object.create(null);if(n.r(r),Object.defineProperty(r,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)n.d(r,o,function(t){return e[t]}.bind(null,o));return r},n.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(t,"a",t),t},n.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n.p="",n(n.s=1)}([function(e,t,n){(function(t){for(var r=n(3),o="undefined"==typeof window?t:window,a=["moz","webkit"],i="AnimationFrame",s=o["request"+i],u=o["cancel"+i]||o["cancelRequest"+i],l=0;!s&&l<a.length;l++)s=o[a[l]+"Request"+i],u=o[a[l]+"Cancel"+i]||o[a[l]+"CancelRequest"+i];if(!s||!u){var c=0,p=0,d=[];s=function(e){if(0===d.length){var t=r(),n=Math.max(0,1e3/60-(t-c));c=n+t,setTimeout((function(){var e=d.slice(0);d.length=0;for(var t=0;t<e.length;t++)if(!e[t].cancelled)try{e[t].callback(c)}catch(e){setTimeout((function(){throw e}),0)}}),Math.round(n))}return d.push({handle:++p,callback:e,cancelled:!1}),p},u=function(e){for(var t=0;t<d.length;t++)d[t].handle===e&&(d[t].cancelled=!0)}}e.exports=function(e){return s.call(o,e)},e.exports.cancel=function(){u.apply(o,arguments)},e.exports.polyfill=function(e){e||(e=o),e.requestAnimationFrame=s,e.cancelAnimationFrame=u}}).call(this,n(2))},function(e,t,n){"use strict";n.r(t);var r=n(0),o=n.n(r),a=function(e){return new RegExp(/<[a-z][\s\S]*>/i).test(e)},i=function(e){var t=document.createElement("div");return t.innerHTML=e,t.childNodes},s=function(e,t){return Math.floor(Math.random()*(t-e+1))+e},u=function(e){var t=document.createElement("style");t.appendChild(document.createTextNode(e)),document.head.appendChild(t)},l={TYPE_CHARACTER:"TYPE_CHARACTER",REMOVE_CHARACTER:"REMOVE_CHARACTER",REMOVE_ALL:"REMOVE_ALL",REMOVE_LAST_VISIBLE_NODE:"REMOVE_LAST_VISIBLE_NODE",PAUSE_FOR:"PAUSE_FOR",CALL_FUNCTION:"CALL_FUNCTION",ADD_HTML_TAG_ELEMENT:"ADD_HTML_TAG_ELEMENT",REMOVE_HTML_TAG_ELEMENT:"REMOVE_HTML_TAG_ELEMENT",CHANGE_DELETE_SPEED:"CHANGE_DELETE_SPEED",CHANGE_DELAY:"CHANGE_DELAY",CHANGE_CURSOR:"CHANGE_CURSOR"},c={HTML_TAG:"HTML_TAG",TEXT_NODE:"TEXT_NODE"};function p(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{},r=Object.keys(n);"function"==typeof Object.getOwnPropertySymbols&&(r=r.concat(Object.getOwnPropertySymbols(n).filter((function(e){return Object.getOwnPropertyDescriptor(n,e).enumerable})))),r.forEach((function(t){E(e,t,n[t])}))}return e}function d(e){return function(e){if(Array.isArray(e)){for(var t=0,n=new Array(e.length);t<e.length;t++)n[t]=e[t];return n}}(e)||function(e){if(Symbol.iterator in Object(e)||"[object Arguments]"===Object.prototype.toString.call(e))return Array.from(e)}(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance")}()}function f(e,t){for(var n=0;n<t.length;n++){var r=t[n];r.enumerable=r.enumerable||!1,r.configurable=!0,"value"in r&&(r.writable=!0),Object.defineProperty(e,r.key,r)}}function E(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}var v=function(){function e(t,n){var u=this;if(function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}(this,e),E(this,"state",{cursorAnimation:null,lastFrameTime:null,pauseUntil:null,eventQueue:[],eventLoop:null,eventLoopPaused:!1,reverseCalledEvents:[],calledEvents:[],visibleNodes:[],initialOptions:null,elements:{container:null,wrapper:document.createElement("span"),cursor:document.createElement("span")}}),E(this,"options",{strings:null,cursor:"|",delay:"natural",deleteSpeed:"natural",loop:!1,autoStart:!1,devMode:!1,skipAddStyles:!1,wrapperClassName:"Typewriter__wrapper",cursorClassName:"Typewriter__cursor",stringSplitter:null}),E(this,"setupWrapperElement",(function(){u.state.elements.wrapper.className=u.options.wrapperClassName,u.state.elements.cursor.className=u.options.cursorClassName,u.state.elements.cursor.innerHTML=u.options.cursor,u.state.elements.container.innerHTML="",u.state.elements.container.appendChild(u.state.elements.wrapper),u.state.elements.container.appendChild(u.state.elements.cursor)})),E(this,"start",(function(){return u.state.eventLoopPaused=!1,u.runEventLoop(),u})),E(this,"pause",(function(){return u.state.eventLoopPaused=!0,u})),E(this,"stop",(function(){return u.state.eventLoop&&(Object(r.cancel)(u.state.eventLoop),u.state.eventLoop=null),u})),E(this,"pauseFor",(function(e){return u.addEventToQueue(l.PAUSE_FOR,{ms:e}),u})),E(this,"typeOutAllStrings",(function(){return"string"==typeof u.options.strings?(u.typeString(u.options.strings).pauseFor(1500),u):(u.options.strings.forEach((function(e){u.typeString(e).pauseFor(1500).deleteAll()})),u)})),E(this,"typeString",(function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:null;if(a(e))return u.typeOutHTMLString(e,t);if(e){var n=u.options||{},r=n.stringSplitter,o="function"==typeof r?r(e):e.split("");u.typeCharacters(o,t)}return u})),E(this,"typeOutHTMLString",(function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:null,n=i(e);if(n.length>0)for(var r=0;r<n.length;r++){var o=n[r],a=o.innerHTML;o&&3!==o.nodeType?(o.innerHTML="",u.addEventToQueue(l.ADD_HTML_TAG_ELEMENT,{node:o,parentNode:t}),u.typeString(a,o)):o.textContent&&u.typeString(o.textContent,t)}return u})),E(this,"deleteAll",(function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:"natural";return u.addEventToQueue(l.REMOVE_ALL,{speed:e}),u})),E(this,"changeDeleteSpeed",(function(e){if(!e)throw new Error("Must provide new delete speed");return u.addEventToQueue(l.CHANGE_DELETE_SPEED,{speed:e}),u})),E(this,"changeDelay",(function(e){if(!e)throw new Error("Must provide new delay");return u.addEventToQueue(l.CHANGE_DELAY,{delay:e}),u})),E(this,"changeCursor",(function(e){if(!e)throw new Error("Must provide new cursor");return u.addEventToQueue(l.CHANGE_CURSOR,{cursor:e}),u})),E(this,"deleteChars",(function(e){if(!e)throw new Error("Must provide amount of characters to delete");for(var t=0;t<e;t++)u.addEventToQueue(l.REMOVE_CHARACTER);return u})),E(this,"callFunction",(function(e,t){if(!e||"function"!=typeof e)throw new Error("Callbak must be a function");return u.addEventToQueue(l.CALL_FUNCTION,{cb:e,thisArg:t}),u})),E(this,"typeCharacters",(function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:null;if(!e||!Array.isArray(e))throw new Error("Characters must be an array");return e.forEach((function(e){u.addEventToQueue(l.TYPE_CHARACTER,{character:e,node:t})})),u})),E(this,"removeCharacters",(function(e){if(!e||!Array.isArray(e))throw new Error("Characters must be an array");return e.forEach((function(){u.addEventToQueue(l.REMOVE_CHARACTER)})),u})),E(this,"addEventToQueue",(function(e,t){var n=arguments.length>2&&void 0!==arguments[2]&&arguments[2];return u.addEventToStateProperty(e,t,n,"eventQueue")})),E(this,"addReverseCalledEvent",(function(e,t){var n=arguments.length>2&&void 0!==arguments[2]&&arguments[2],r=u.options.loop;return r?u.addEventToStateProperty(e,t,n,"reverseCalledEvents"):u})),E(this,"addEventToStateProperty",(function(e,t){var n=arguments.length>2&&void 0!==arguments[2]&&arguments[2],r=arguments.length>3?arguments[3]:void 0,o={eventName:e,eventArgs:t||{}};return u.state[r]=n?[o].concat(d(u.state[r])):[].concat(d(u.state[r]),[o]),u})),E(this,"runEventLoop",(function(){u.state.lastFrameTime||(u.state.lastFrameTime=Date.now());var e=Date.now(),t=e-u.state.lastFrameTime;if(!u.state.eventQueue.length){if(!u.options.loop)return;u.state.eventQueue=d(u.state.calledEvents),u.state.calledEvents=[],u.options=p({},u.state.initialOptions)}if(u.state.eventLoop=o()(u.runEventLoop),!u.state.eventLoopPaused){if(u.state.pauseUntil){if(e<u.state.pauseUntil)return;u.state.pauseUntil=null}var n=d(u.state.eventQueue),r=n.shift(),a=0;if(!(t<=(a=r.eventName===l.REMOVE_LAST_VISIBLE_NODE||r.eventName===l.REMOVE_CHARACTER?"natural"===u.options.deleteSpeed?s(40,80):u.options.deleteSpeed:"natural"===u.options.delay?s(120,160):u.options.delay))){var i=r.eventName,f=r.eventArgs;switch(u.logInDevMode({currentEvent:r,state:u.state,delay:a}),i){case l.TYPE_CHARACTER:var E=f.character,v=f.node,h=document.createTextNode(E);v?v.appendChild(h):u.state.elements.wrapper.appendChild(h),u.state.visibleNodes=[].concat(d(u.state.visibleNodes),[{type:c.TEXT_NODE,node:h}]);break;case l.REMOVE_CHARACTER:n.unshift({eventName:l.REMOVE_LAST_VISIBLE_NODE,eventArgs:{removingCharacterNode:!0}});break;case l.PAUSE_FOR:var m=r.eventArgs.ms;u.state.pauseUntil=Date.now()+parseInt(m);break;case l.CALL_FUNCTION:var T=r.eventArgs,_=T.cb,y=T.thisArg;_.call(y,{elements:u.state.elements});break;case l.ADD_HTML_TAG_ELEMENT:var A=r.eventArgs,g=A.node,w=A.parentNode;w?w.appendChild(g):u.state.elements.wrapper.appendChild(g),u.state.visibleNodes=[].concat(d(u.state.visibleNodes),[{type:c.HTML_TAG,node:g,parentNode:w||u.state.elements.wrapper}]);break;case l.REMOVE_ALL:var L=u.state.visibleNodes,C=f.speed,N=[];C&&N.push({eventName:l.CHANGE_DELETE_SPEED,eventArgs:{speed:C,temp:!0}});for(var b=0,O=L.length;b<O;b++)N.push({eventName:l.REMOVE_LAST_VISIBLE_NODE,eventArgs:{removingCharacterNode:!1}});C&&N.push({eventName:l.CHANGE_DELETE_SPEED,eventArgs:{speed:u.options.deleteSpeed,temp:!0}}),n.unshift.apply(n,N);break;case l.REMOVE_LAST_VISIBLE_NODE:var S=r.eventArgs.removingCharacterNode;if(u.state.visibleNodes.length){var R=u.state.visibleNodes.pop(),M=R.type,D=R.node;D.parentNode.removeChild(D),M===c.HTML_TAG&&S&&n.unshift({eventName:l.REMOVE_LAST_VISIBLE_NODE,eventArgs:{}})}break;case l.CHANGE_DELETE_SPEED:u.options.deleteSpeed=r.eventArgs.speed;break;case l.CHANGE_DELAY:u.options.delay=r.eventArgs.delay;break;case l.CHANGE_CURSOR:u.options.cursor=r.eventArgs.cursor,u.state.elements.cursor.innerHTML=r.eventArgs.cursor}u.options.loop&&(r.eventName===l.REMOVE_LAST_VISIBLE_NODE||r.eventArgs&&r.eventArgs.temp||(u.state.calledEvents=[].concat(d(u.state.calledEvents),[r]))),u.state.eventQueue=n,u.state.lastFrameTime=e}}})),!t)throw new Error("No container element was provided");if("string"==typeof t){var f=document.querySelector(t);if(!f)throw new Error("Could not find container element");this.state.elements.container=f}else this.state.elements.container=t;n&&(this.options=p({},this.options,n)),this.state.initialOptions=p({},this.options),this.init()}var t,n,v;return t=e,(n=[{key:"init",value:function(){this.setupWrapperElement(),this.addEventToQueue(l.CHANGE_CURSOR,{cursor:this.options.cursor},!0),this.addEventToQueue(l.REMOVE_ALL,null,!0),!window||window.___TYPEWRITER_JS_STYLES_ADDED___||this.options.skipAddStyles||(u(".Typewriter__cursor{-webkit-animation:Typewriter-cursor 1s infinite;animation:Typewriter-cursor 1s infinite;margin-left:1px}@-webkit-keyframes Typewriter-cursor{0%{opacity:0}50%{opacity:1}100%{opacity:0}}@keyframes Typewriter-cursor{0%{opacity:0}50%{opacity:1}100%{opacity:0}}"),window.___TYPEWRITER_JS_STYLES_ADDED___=!0),!0===this.options.autoStart&&this.options.strings&&this.typeOutAllStrings().start()}},{key:"logInDevMode",value:function(e){this.options.devMode&&console.log(e)}}])&&f(t.prototype,n),v&&f(t,v),e}();n.d(t,"default",(function(){return v}))},function(e,t){var n;n=function(){return this}();try{n=n||new Function("return this")()}catch(e){"object"==typeof window&&(n=window)}e.exports=n},function(e,t,n){(function(t){(function(){var n,r,o,a,i,s;"undefined"!=typeof performance&&null!==performance&&performance.now?e.exports=function(){return performance.now()}:null!=t&&t.hrtime?(e.exports=function(){return(n()-i)/1e6},r=t.hrtime,a=(n=function(){var e;return 1e9*(e=r())[0]+e[1]})(),s=1e9*t.uptime(),i=a-s):Date.now?(e.exports=function(){return Date.now()-o},o=Date.now()):(e.exports=function(){return(new Date).getTime()-o},o=(new Date).getTime())}).call(this)}).call(this,n(4))},function(e,t){var n,r,o=e.exports={};function a(){throw new Error("setTimeout has not been defined")}function i(){throw new Error("clearTimeout has not been defined")}function s(e){if(n===setTimeout)return setTimeout(e,0);if((n===a||!n)&&setTimeout)return n=setTimeout,setTimeout(e,0);try{return n(e,0)}catch(t){try{return n.call(null,e,0)}catch(t){return n.call(this,e,0)}}}!function(){try{n="function"==typeof setTimeout?setTimeout:a}catch(e){n=a}try{r="function"==typeof clearTimeout?clearTimeout:i}catch(e){r=i}}();var u,l=[],c=!1,p=-1;function d(){c&&u&&(c=!1,u.length?l=u.concat(l):p=-1,l.length&&f())}function f(){if(!c){var e=s(d);c=!0;for(var t=l.length;t;){for(u=l,l=[];++p<t;)u&&u[p].run();p=-1,t=l.length}u=null,c=!1,function(e){if(r===clearTimeout)return clearTimeout(e);if((r===i||!r)&&clearTimeout)return r=clearTimeout,clearTimeout(e);try{r(e)}catch(t){try{return r.call(null,e)}catch(t){return r.call(this,e)}}}(e)}}function E(e,t){this.fun=e,this.array=t}function v(){}o.nextTick=function(e){var t=new Array(arguments.length-1);if(arguments.length>1)for(var n=1;n<arguments.length;n++)t[n-1]=arguments[n];l.push(new E(e,t)),1!==l.length||c||s(f)},E.prototype.run=function(){this.fun.apply(null,this.array)},o.title="browser",o.browser=!0,o.env={},o.argv=[],o.version="",o.versions={},o.on=v,o.addListener=v,o.once=v,o.off=v,o.removeListener=v,o.removeAllListeners=v,o.emit=v,o.prependListener=v,o.prependOnceListener=v,o.listeners=function(e){return[]},o.binding=function(e){throw new Error("process.binding is not supported")},o.cwd=function(){return"/"},o.chdir=function(e){throw new Error("process.chdir is not supported")},o.umask=function(){return 0}}]).default}));


--------------------------------------------------------------------------------
/doc/cecil.yml:
--------------------------------------------------------------------------------
 1 | title: Automate
 2 | baseline: ''
 3 | baseurl: 'https://automate-deployer.com/'
 4 | description: 'Automate, a deployment tool'
 5 | author:
 6 |   name: Julien Jacottet
 7 |   url: 'https://github.com/automatephp/automate'
 8 | image: favicon.png
 9 | menus:
10 |   main:
11 |     - id: index
12 |       enabled: false
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/doc/layouts/404.html.twig:
--------------------------------------------------------------------------------
1 | {% extends ['page.html.twig'] %}
2 | 
3 | {%- block content ~%}
4 |       <div class="c-404">
5 |             <img src="{{ asset('404.png') }}" alt="Page not found">
6 |             <h1 class="c-404__title">{% trans %}Page not found{% endtrans %}</h1>
7 |       </div>
8 | {%- endblock ~%}


--------------------------------------------------------------------------------
/doc/layouts/_base.html.twig:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="{{ site.language }}">
 3 |     <head>
 4 |         {% block head ~%}
 5 |             <meta charset="UTF-8">
 6 |             <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
 7 |             <meta http-equiv="X-UA-Compatible" content="ie=edge">
 8 |             <link rel="stylesheet" href="{{ asset('app.scss') }}">
 9 | 
10 |             {% if page.type == 'homepage'%}
11 |                 <link rel="stylesheet" type="text/css" href="{{ asset('asciinema-player.css') }}" />
12 |                 <script src="{{ asset('asciinema-player.min.js') }}"></script>
13 |                 <script src="{{ asset('home.js') }}"></script>
14 |                 <script src="{{ asset('typewriter.js') }}"></script>
15 |             {% else %}
16 |                 <script src="{{ asset('page.js') }}"></script>
17 | 
18 |                 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/atom-one-dark.min.css">
19 |                 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
20 |                 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/bash.min.js"></script>
21 |                 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/yaml.min.js"></script>
22 |                 <script>hljs.highlightAll();</script>
23 |                 {% endif %}
24 | 
25 |             {%- include 'partials/metatags.html.twig' with {page, site} only ~%}
26 |             
27 |         {% endblock head ~%}
28 |     </head>
29 |     <body>
30 |         <div class="{% if page.type == 'homepage' %}c-layout-homepage{% else %}c-layout-page{% endif %}">
31 | 
32 |             <header class="c-header" role="banner">
33 |                 <div class="c-header__inner">
34 |                     <div class="c-header__content">
35 |                         <div class="c-header__actions">
36 |                             <div>
37 |                                 {% if page.type == 'homepage' %}
38 |                                     <img class="c-header__logo-default" src="{{ asset('logo-automate.png') }}" alt="" width="290" height="62">
39 |                                     <img class="c-header__logo-white" src="{{ asset('logo-automate-white.png') }}" alt="" width="290" height="62">
40 |                                 {% else %}
41 |                                     <a href="/">
42 |                                         <img class="c-header__logo-default" src="{{ asset('logo-automate.png') }}" alt="" width="290" height="62">
43 |                                     </a>
44 |                                 {% endif %}
45 |                             </div>
46 |                             <div class="c-header__buttons">
47 |                                 {% if page.type == 'homepage' %}
48 |                                     <a class="c-header__button c-button c-button--ghost c-button--blue" href="/get-started">Documentation</a>
49 |                                 {% else %}
50 |                                     <a class="c-header__button c-button c-button--ghost c-button--blue" href="/">Home</a>
51 |                                 {% endif %}
52 |                                 <a class="c-header__button c-button c-button--ghost c-button--blue" href="https://github.com/automatephp/automate" target="_blank">
53 |                                     <svg class="c-button__svg" width="20" height="20" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 98 96">
54 |                                         <path fill-rule="evenodd" clip-rule="evenodd"
55 |                                               d="M48.854 0C21.839 0 0 22 0 49.217c0 21.756 13.993 40.172 33.405 46.69 2.427.49 3.316-1.059 3.316-2.362 0-1.141-.08-5.052-.08-9.127-13.59 2.934-16.42-5.867-16.42-5.867-2.184-5.704-5.42-7.17-5.42-7.17-4.448-3.015.324-3.015.324-3.015 4.934.326 7.523 5.052 7.523 5.052 4.367 7.496 11.404 5.378 14.235 4.074.404-3.178 1.699-5.378 3.074-6.6-10.839-1.141-22.243-5.378-22.243-24.283 0-5.378 1.94-9.778 5.014-13.2-.485-1.222-2.184-6.275.486-13.038 0 0 4.125-1.304 13.426 5.052a46.97 46.97 0 0 1 12.214-1.63c4.125 0 8.33.571 12.213 1.63 9.302-6.356 13.427-5.052 13.427-5.052 2.67 6.763.97 11.816.485 13.038 3.155 3.422 5.015 7.822 5.015 13.2 0 18.905-11.404 23.06-22.324 24.283 1.78 1.548 3.316 4.481 3.316 9.126 0 6.6-.08 11.897-.08 13.526 0 1.304.89 2.853 3.316 2.364 19.412-6.52 33.405-24.935 33.405-46.691C97.707 22 75.788 0 48.854 0z"
56 |                                               fill="#fb320b"/>
57 |                                     </svg>
58 |                                     Github
59 |                                 </a>
60 |                             </div>
61 |                         </div>
62 | 
63 |                         {% block nav %}
64 |                         {% endblock %}
65 |                     </div>
66 |                 </div>
67 | 
68 |                 {% block flipCard %}
69 |                 {% endblock %}
70 |             </header>
71 | 
72 |             <main class="c-main" role="main">
73 |                 {% block content %}
74 |                 {% endblock %}
75 |             </main>
76 | 
77 |             <footer class="c-footer" role="contentinfo">
78 |                 <span>Sponsored by</span>
79 |                 <a href="https://www.mezcalito.fr/" target="_blank">
80 |                     <img class="c-footer__mezcalito" src=" {{ asset('logo-mezcalito.svg') }}" alt="">
81 |                 </a>
82 |             </footer>
83 |         </div>
84 |     </body>
85 | </html>


--------------------------------------------------------------------------------
/doc/layouts/home.html.twig:
--------------------------------------------------------------------------------
  1 | {% extends '_base.html.twig' %}
  2 | 
  3 | {% block nav %}
  4 |     <div class="c-baseline">
  5 |         <div class="c-baseline__inner c-baseline__inner-front">
  6 |             <h2 id="c-baseline-title-1" class="c-baseline__title">One command line !</h2>
  7 |             <p class="c-baseline__description">Automate allows you to automate your deployments to remote Linux servers
  8 |                 simply. You can use Automate from your workstation or through an integration server like Github or
  9 |                 Gitlab-ci.</p>
 10 |             <button type="button" class="c-baseline__button c-button c-button--plain c-button--orange">Discover !
 11 |             </button>
 12 |         </div>
 13 |         <div class="c-baseline__inner c-baseline__inner-back">
 14 |             <h2 id="c-baseline-title-2" class="c-baseline__title">One YAML file to organize everything</h2>
 15 |             <p class="c-baseline__description">Define all linux environment you need and all command line on each to
 16 |                 deploy your application simply from the repository Git.</p>
 17 |             <a href="#section-advantages" type="button" class="c-button c-button--plain c-button--orange">Features
 18 |             </a>
 19 |         </div>
 20 |     </div>
 21 | {% endblock %}
 22 | 
 23 | {% block flipCard %}
 24 |     <div class="c-flip-card">
 25 |         <div class="c-flip-card__inner">
 26 |             <div class="c-flip-card__face c-flip-card__face--front">
 27 |                 <div class="c-flip-card__ellipsis"></div>
 28 |                 <div id="demo"></div>
 29 |             </div>
 30 |             <div class="c-flip-card__face c-flip-card__face--back">
 31 |                 <div class="c-flip-card__ellipsis"></div>
 32 |                 <pre class="c-flip-card__pre"><code class="c-flip-card__code"></code></pre>
 33 |             </div>
 34 |         </div>
 35 |     </div>
 36 | {% endblock %}
 37 | 
 38 |  {% block content %}
 39 |      <section id="section-advantages" class="c-advantages">
 40 |          <div class="o-container">
 41 |              <div class="c-advantages__inner">
 42 |                  <h2 class="c-advantages__title">Discover the advantages of Automate</h2>
 43 |                  <div class="c-advantages__items">
 44 |                      <div class="c-advantages__item">
 45 |                          <h3 class="c-advantages__item-title">Consistency</h3>
 46 |                          <p class="c-advantages__item-description">This is the end of much inconsistency between your
 47 |                              platforms, everything is deploying in
 48 |                              parallel. If one failed, all others are stopped immediately.</p>
 49 |                      </div>
 50 |                      <div class="c-advantages__item">
 51 |                          <h3 class="c-advantages__item-title">Atomic deploys</h3>
 52 |                          <p class="c-advantages__item-description">Your application is integrally built, then deployed
 53 |                              instantly with symlinks.</p>
 54 |                      </div>
 55 |                      <div class="c-advantages__item">
 56 |                          <h3 class="c-advantages__item-title">Zero downtime</h3>
 57 |                          <p class="c-advantages__item-description">As long as the new deployment is not succesful, the
 58 |                              last one stays online until the last
 59 |                              moment.</p>
 60 |                      </div>
 61 |                      <div class="c-advantages__item">
 62 |                          <h3 class="c-advantages__item-title">Deploy to multiples servers</h3>
 63 |                          <p class="c-advantages__item-description">Configure all your remotes servers: development,
 64 |                              pre-production and production one in the
 65 |                              same place. Automate take care of the rest!</p>
 66 |                      </div>
 67 |                      <div class="c-advantages__item">
 68 |                          <h3 class="c-advantages__item-title">Deploy any project</h3>
 69 |                          <p class="c-advantages__item-description">Automate can work with any type of project! PHP, JS,
 70 |                              Ruby,.. It’s a polyvalent Automate !
 71 |                              ;) </p>
 72 |                      </div>
 73 |                      <div class="c-advantages__item">
 74 |                          <h3 class="c-advantages__item-title">Github / Gitlab-ci</h3>
 75 |                          <p class="c-advantages__item-description">
 76 |                              You can use Automate from your workstation or through an integration server like Github or
 77 |                              Gitlab-ci.
 78 |                              <a href="https://test-seo-5.firebaseapp.com/" style="color: white;">Un test SEO!</a>
 79 |                          </p>
 80 |                      </div>
 81 | 
 82 |                  </div>
 83 |                  <a class="c-button c-button--plain c-button--orange" href="https://github.com/automatephp/automate"
 84 |                     target="_blank">
 85 |                      <svg class="c-button__svg" width="20" height="20" xmlns="http://www.w3.org/2000/svg"
 86 |                           viewBox="0 0 98 96">
 87 |                          <path fill-rule="evenodd" clip-rule="evenodd"
 88 |                                d="M48.854 0C21.839 0 0 22 0 49.217c0 21.756 13.993 40.172 33.405 46.69 2.427.49 3.316-1.059 3.316-2.362 0-1.141-.08-5.052-.08-9.127-13.59 2.934-16.42-5.867-16.42-5.867-2.184-5.704-5.42-7.17-5.42-7.17-4.448-3.015.324-3.015.324-3.015 4.934.326 7.523 5.052 7.523 5.052 4.367 7.496 11.404 5.378 14.235 4.074.404-3.178 1.699-5.378 3.074-6.6-10.839-1.141-22.243-5.378-22.243-24.283 0-5.378 1.94-9.778 5.014-13.2-.485-1.222-2.184-6.275.486-13.038 0 0 4.125-1.304 13.426 5.052a46.97 46.97 0 0 1 12.214-1.63c4.125 0 8.33.571 12.213 1.63 9.302-6.356 13.427-5.052 13.427-5.052 2.67 6.763.97 11.816.485 13.038 3.155 3.422 5.015 7.822 5.015 13.2 0 18.905-11.404 23.06-22.324 24.283 1.78 1.548 3.316 4.481 3.316 9.126 0 6.6-.08 11.897-.08 13.526 0 1.304.89 2.853 3.316 2.364 19.412-6.52 33.405-24.935 33.405-46.691C97.707 22 75.788 0 48.854 0z"
 89 |                                fill="#fb320b"/>
 90 |                      </svg>
 91 |                      Github
 92 |                  </a>
 93 |              </div>
 94 |          </div>
 95 |      </section>
 96 | 
 97 |      <section class="c-starting">
 98 |          <div class="o-container">
 99 |              <div class="c-starting__inner">
100 |                  <div class="c-starting__header">
101 |                      <h2 class="c-starting__title">Get starting</h2>
102 |                      <p class="c-starting__description">You can download the latest version of Automate with the
103 |                          following command</p>
104 |                  </div>
105 |                  <div class="c-starting__command">
106 |                      <span class="c-starting__curl">curl -LSs </span>https://www.automate-deployer.com/install | bash
107 |                  </div>
108 |                  <a class="c-button c-button--plain c-button--orange" href="/get-started">Documentation</a>
109 |              </div>
110 |          </div>
111 |      </section>
112 |  {% endblock %}
113 | 


--------------------------------------------------------------------------------
/doc/layouts/page.html.twig:
--------------------------------------------------------------------------------
 1 | {% extends '_base.html.twig' %}
 2 | 
 3 | {% block nav %}
 4 |     {% include 'partials/navigation.html.twig' with { menu: site.menus.main } %}
 5 | {% endblock %}
 6 | 
 7 | {% block content %}
 8 |     <div class="c-doc">
 9 |         {{ page.content }}
10 |     </div>
11 | {% endblock %}


--------------------------------------------------------------------------------
/doc/layouts/partials/navigation.html.twig:
--------------------------------------------------------------------------------
 1 | {% if menu|length > 1 %}
 2 |     <nav class="c-menu" role="navigation">
 3 |         <button class="c-menu__header" type="button">
 4 |             Documentation
 5 |             <svg class="c-menu__burger" width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
 6 |                 <path d="M20.8125 12C20.8125 12.1492 20.7532 12.2923 20.6477 12.3977C20.5423 12.5032 20.3992 12.5625 20.25 12.5625H3.75C3.60082 12.5625 3.45774 12.5032 3.35225 12.3977C3.24676 12.2923 3.1875 12.1492 3.1875 12C3.1875 11.8508 3.24676 11.7077 3.35225 11.6023C3.45774 11.4968 3.60082 11.4375 3.75 11.4375H20.25C20.3992 11.4375 20.5423 11.4968 20.6477 11.6023C20.7532 11.7077 20.8125 11.8508 20.8125 12ZM3.75 6.5625H20.25C20.3992 6.5625 20.5423 6.50324 20.6477 6.39775C20.7532 6.29226 20.8125 6.14918 20.8125 6C20.8125 5.85082 20.7532 5.70774 20.6477 5.60225C20.5423 5.49676 20.3992 5.4375 20.25 5.4375H3.75C3.60082 5.4375 3.45774 5.49676 3.35225 5.60225C3.24676 5.70774 3.1875 5.85082 3.1875 6C3.1875 6.14918 3.24676 6.29226 3.35225 6.39775C3.45774 6.50324 3.60082 6.5625 3.75 6.5625ZM20.25 17.4375H3.75C3.60082 17.4375 3.45774 17.4968 3.35225 17.6023C3.24676 17.7077 3.1875 17.8508 3.1875 18C3.1875 18.1492 3.24676 18.2923 3.35225 18.3977C3.45774 18.5032 3.60082 18.5625 3.75 18.5625H20.25C20.3992 18.5625 20.5423 18.5032 20.6477 18.3977C20.7532 18.2923 20.8125 18.1492 20.8125 18C20.8125 17.8508 20.7532 17.7077 20.6477 17.6023C20.5423 17.4968 20.3992 17.4375 20.25 17.4375Z" fill="#8c8c8e"/>
 7 |             </svg>
 8 |         </button>
 9 |         <ul class="c-menu__list">
10 |             {% for item in attribute(site.menus, menu)|sort_by_weight %}
11 |                 <li class="c-menu__item">
12 |                     <a class="c-menu__link{% if item.url == page~'/' %} is-current{% endif %}" href="{{ url(item.url) }}">{{ item.name }}</a>
13 |                 </li>
14 |             {% endfor %}
15 |         </ul>
16 |     </nav>
17 | {% endif %}
18 | 
19 | 


--------------------------------------------------------------------------------
/doc/pages/deployment-strategies.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: "Deployment strategies"
 3 | menu:
 4 |   main:
 5 |     weight: 30
 6 | ---
 7 | 
 8 | # Deployment strategies Automate
 9 | 
10 | Automate offers three deployment options, each tailored to specific needs:
11 | 
12 | ### 1. Git Deployment
13 | 
14 | In this approach, you specify a repository in Automate's configuration.
15 | Automate then clones this repository and uses commands to prepare the application directly on the remote server.
16 | This method is the simplest to implement.
17 | 
18 | example : 
19 | 
20 | ~~~~yaml
21 | repository: git@github.com:symfony/symfony-demo.git
22 | on_deploy:
23 |     - composer install
24 |     - yarn install
25 |     - yarn build
26 | post_deploy:
27 |     - cmd: "php bin/console doctrine:migrations:migrate"
28 |       only: [ dev-example-front-01]
29 | ~~~~
30 | 
31 | ### 2. Continuous Integration (CI) + Automate
32 | 
33 | Utilize your continuous integration (CI) tools to perform build steps in your CI environment.
34 | Then, Automate is used to push files directly to the server without using Git. 
35 | This approach allows executing commands on the server at the end of the process, such as updating your database.
36 | 
37 | example :
38 | 
39 | ~~~~yaml
40 | # do not specify a repository
41 | pre_deploy:
42 |     - upload: .
43 |       exclude: [node_modules]
44 | post_deploy:
45 |     - cmd: "php bin/console doctrine:migrations:migrate"
46 |       only: [ dev-example-front-01]
47 | ~~~~
48 | 
49 | ### 3. Mixed Deployment
50 | 
51 | In this setup, you use Git to download your sources and then send only specific files or folders from your CI. 
52 | For example, you might only send the build of your assets. This approach combines the simplicity of Git with the flexibility of custom deployment.
53 | ~~~~yaml
54 | repository: git@github.com:symfony/symfony-demo.git
55 | pre_deploy:
56 |     - upload: public/build
57 | post_deploy:
58 |     - cmd: "php bin/console doctrine:migrations:migrate"
59 |       only: [ dev-example-front-01]
60 | ~~~~
61 | 
62 | 
63 | 


--------------------------------------------------------------------------------
/doc/pages/get-started.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | title: "Get started"
  3 | menu:
  4 |   main:
  5 |     weight: 10
  6 | ---
  7 | # Automate
  8 | 
  9 | Automate allows you to automate your deployments to remote Linux servers simply.
 10 | You can use Automate from your workstation or through an integration server like Github or Gitlab-ci.
 11 | 
 12 | ### 1. Installation
 13 | 
 14 | You can download the latest version of Automate with the following command:    
 15 | 
 16 | ~~~~bash
 17 | curl -sS https://www.automate-deployer.com/install | bash
 18 | ~~~~
 19 | 
 20 | The command will verify your PHP settings and launch the download in the current directory.
 21 | 
 22 | Please note that this command is compatible with Linux and macOS systems.
 23 | If you are using Windows, you will need to download the .phar file manually from [github](https://github.com/automatephp/automate/releases).
 24 | 
 25 | 
 26 | 
 27 | ### 2. Creating your configuration file
 28 | 
 29 | Foremost, you have to create a configuration file for Automate.
 30 | This file is usually located at the root of your project. The name of this file must be .automate.yml.
 31 | 
 32 | Here is an example file:
 33 | 
 34 | ~~~~yaml
 35 | repository: git@github.com:symfony/symfony-demo.git
 36 | platforms:
 37 |     development:
 38 |         default_branch: dev
 39 |         max_releases: 3
 40 |         servers:
 41 |             dev-exemple-front-01:
 42 |                 host: dev.exemple.com
 43 |                 user: automate
 44 |                 password: "%dev_password%"
 45 |                 path: /home/wwwroot/
 46 |                 port: 22
 47 |     production:
 48 |         default_branch: master
 49 |         max_releases: 3
 50 |         servers:
 51 |             prod-exemple-front-01:
 52 |                 host: prod-1.exemple.com
 53 |                 user: automate
 54 |                 password: "%prod_password%"
 55 |                 path: /home/wwwroot/
 56 |             prod-exemple-front-02:
 57 |                 host: prod-2.exemple.com
 58 |                 user: automate
 59 |                 ssh_key: /path/to/key
 60 |                 path: /home/wwwroot/
 61 | shared_files:
 62 |     - .env.local
 63 | shared_folders:
 64 |     - app/data
 65 | pre_deploy:
 66 |     - "php -v"
 67 | on_deploy:
 68 |     - "composer install"
 69 | post_deploy:
 70 |     - cmd: "php bin/console doctrine:schema:update --force"
 71 |       only: [ dev-exemple-front-01, prod-exemple-front-01]
 72 | ~~~~
 73 | 
 74 | 
 75 | ### 3. Launching a deployment
 76 | 
 77 | The following command allows you to launch the deployment on remote server(s)
 78 | 
 79 | ~~~~bash
 80 | automate deploy development master
 81 | ~~~~
 82 | 
 83 | ~~~~bash
 84 | automate deploy ‹platform› [gitref] -c [path_of_config_file]
 85 | ~~~~
 86 | 
 87 | * **platform**
 88 | 
 89 | The target platform name (e.g. development)
 90 | 
 91 | * **gitref (optional)**
 92 | 
 93 | The branch, the tag, or the commit to be deployed.    
 94 | By default Automate will use the « default_branch » in the configuration file
 95 | 
 96 | * **-c [path_of_config_file] (optional)**
 97 | 
 98 | By default, Automate will search for the file ```.automate.yml``` in the current directory. You can specify it with the option ```-c /path/to/.automate.yml```
 99 | 
100 | 
101 | ### 4. Server Configuration
102 | 
103 | Automate will create the following directory structure to the remote server:
104 | 
105 | ~~~~yaml
106 | /your/project/path
107 |    /releases
108 |       /2024.04.22-1302.159
109 |          .env.local --> /your/project/path/shared/.env.local
110 |          /app
111 |             /data --> /your/project/path/shared/app/data
112 |  
113 |    /shared_files
114 |          .env.local #the real file is here
115 |          /app
116 |             /data #the real folder is here
117 |  
118 |    current -> /your/project/path/releases/2024.04.22-1302.159
119 | ~~~~
120 | 
121 | This is the schema of all your project’s architecture    
122 | You have to target your domain name inside the folder ```/your/project/path/current/```.


--------------------------------------------------------------------------------
/doc/pages/reference.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | title: "Reference"
  3 | menu:
  4 |   main:
  5 |     weight: 20
  6 | ---
  7 | 
  8 | # Reference
  9 | 
 10 | ### 1. Repository
 11 | 
 12 | ~~~~yaml
 13 | repository: git@github.com:symfony/symfony-demo.git
 14 | ~~~~
 15 | 
 16 | or for a public repository :
 17 | ~~~~yaml
 18 | repository: "https://github.com/symfony/demo"
 19 | ~~~~
 20 | 
 21 | ### 2. Platforms
 22 | 
 23 | List of platforms.
 24 | 
 25 | You can configure several platforms ; a project must have at least one platform.
 26 | 
 27 | ~~~~yaml
 28 | platforms:
 29 |     production:
 30 |         default_branch: master # The default branch to be launched if no branch is specified during the deployement
 31 |         max_releases: 1        # The number of releases to be kept on remote servers.
 32 |         servers:
 33 |             prod-exemple-front-01:
 34 |                 host: prod-1.exemple.com     # The domain name or the server's IP
 35 |                 user: automate               # The SSH user to be used for the deployment
 36 |                 password: "%prod_password%"  # Read more below in "The SSH password" section
 37 |                 path: /home/wwwroot/         # The path on the remote server
 38 |                 port: 22                     # The SSH port (default:22)    
 39 |             prod-exemple-front-02:
 40 |                 host: prod-2.exemple.com
 41 |                 user: automate
 42 |                 ssh_key: /keys/private       # A file path to private key
 43 |                 password: "%passphrase%"     # An optional passphrase
 44 |                 path: /home/wwwroot/
 45 | ~~~~
 46 | 
 47 | It’s possible to authenticate on the server with a password or with a private key. For the latter, you must define a path to the private key file and an optional passphrase (password) as the example above describes.
 48 | 
 49 | You can use a variable with the notation "%variable_name%"    
 50 | If one variable is detected Automate will search for the value in an environment variable « AUTOMATE__variable_name ».    
 51 | If the environment variable doesn’t exist, Automate will ask to you to provide your password upon each deployment through in your terminal.
 52 | 
 53 | ### 3. Shared_files
 54 | 
 55 | The list of files to be shared with releases.    
 56 | For example, some parameters files,…
 57 | 
 58 | ~~~~yaml
 59 | shared_files:
 60 |     - .env.local
 61 |     - ...
 62 | ~~~~
 63 | 
 64 | ### 4. Shared_folders
 65 | 
 66 | The list of folders to be shared between releases.    
 67 | For example some uploaded pictures,…
 68 | 
 69 | ~~~~yaml
 70 | shared_folders:
 71 |     - app/data
 72 |     - ...
 73 | ~~~~
 74 | 
 75 | ### 5. Deployment Hooks
 76 | 
 77 | Automate supports three types of deployment hooks to execute actions at different stages of the deployment process:
 78 | 
 79 | 1. **pre_deploy:** List of actions to be executed on remote servers after downloading sources and before setting up shared folders and files.
 80 | 
 81 | 2. **on_deploy:** The list of commands to be launched on remote servers **before deployment**.
 82 | 
 83 | 3. **post_deploy:** The list of commands to be launched on remote servers **after downloading sources** and **before** setting up shared folders and files.
 84 | 
 85 | 
 86 | #### Types of Actions
 87 | 
 88 | There are two types of actions that can be specified within the hooks:
 89 | 
 90 | 1. **command:** Allows executing a command on the remote server. For example, `composer install`.
 91 | 
 92 | 2. **upload:** Allows sending local files or directories to remote servers. You can specify files or directories to exclude.
 93 | 
 94 | In both cases, it is possible to restrict the servers on which the action should be executed using the `only` option. For example:
 95 | 
 96 | ~~~~yaml
 97 | pre_deploy:
 98 |     - "php -v" ## All server
 99 | 
100 | on_deploy:
101 |     - cmd: "composer install"
102 |       only: ['dddv-exemple-front-01']
103 | 
104 |     - upload: "build/assets"
105 |       exclude:
106 |         - '/^myfile.ext/'
107 |         - '/^folder/subfolder/'
108 |       only: ['dddv-exemple-front-01']
109 | ~~~~
110 | 


--------------------------------------------------------------------------------
/doc/static/bg-starting.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/doc/static/bg-starting.png


--------------------------------------------------------------------------------
/doc/static/config-example.yaml:
--------------------------------------------------------------------------------
 1 | repository: https://github.com/julienj/symfony-demo.git
 2 | platforms:
 3 |     dev:
 4 |         default_branch: master
 5 |         max_releases: 3
 6 |         servers:
 7 |             dddv-exemple-front-01:
 8 |                 host: dev.exemple.com
 9 |                 user: user
10 |                 password: "%dev_password%"
11 |                 path: /home/wwwroot/exemple
12 |     production:
13 |         default_branch: production
14 |         servers:
15 |             eddv-exemple-front-01:
16 |                 host: 12.9.9.1
17 |                 user: user
18 |                 password: "%prod_password%"
19 |                 path: /home/wwwroot/exemple
20 |             eddv-exemple-front-02:
21 |                 host: 12.9.9.2
22 |                 user: user
23 |                 password: "%prod_password%"
24 |                 path: /home/wwwroot/exemple
25 | shared_files:
26 |     - .env.local
27 | shared_folders:
28 |     - app/data
29 | on_deploy:
30 |     - "composer install"
31 | post_deploy:
32 |     - "php bin/console doctrine:schema:update --force"


--------------------------------------------------------------------------------
/doc/static/fonts/anton-v25-latin-regular.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/doc/static/fonts/anton-v25-latin-regular.woff2


--------------------------------------------------------------------------------
/doc/static/fonts/work-sans-v19-latin-600.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/doc/static/fonts/work-sans-v19-latin-600.woff2


--------------------------------------------------------------------------------
/doc/static/fonts/work-sans-v19-latin-700.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/doc/static/fonts/work-sans-v19-latin-700.woff2


--------------------------------------------------------------------------------
/doc/static/fonts/work-sans-v19-latin-regular.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/doc/static/fonts/work-sans-v19-latin-regular.woff2


--------------------------------------------------------------------------------
/doc/static/googleae5075fd86941943.html:
--------------------------------------------------------------------------------
1 | google-site-verification: googleae5075fd86941943.html


--------------------------------------------------------------------------------
/doc/static/ico-ellipse.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/doc/static/ico-ellipse.png


--------------------------------------------------------------------------------
/doc/static/install:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env bash
  2 | 
  3 | set -euo pipefail
  4 | 
  5 | CLI_NAME="Automate"
  6 | CLI_EXECUTABLE="automate"
  7 | CLI_CONFIG_DIR=".automate"
  8 | CLI_REPO_LATEST_RELEASE_URL="https://api.github.com/repos/automatephp/automate/releases/latest"
  9 | CLI_DOWNLOAD_URL_PATTERN="https://github.com/automatephp/automate/releases/download/~latest_version~/automate-~platform~"
 10 | CLI_BINARY_TMP_NAME="$CLI_EXECUTABLE-"$(date +"%s")
 11 | 
 12 | main() {
 13 | 
 14 |     # Print ASCII logo
 15 |     ascii
 16 | 
 17 |     # Run environment check
 18 |     output "Environment check" "heading"
 19 |     third_party_check
 20 |     platform_check
 21 | 
 22 |     # Download binary
 23 |     output "Download" "heading"
 24 |     last_release_version
 25 |     download_binary
 26 |     executable_binary
 27 |     move_binary
 28 | 
 29 |     # Print informations
 30 |     output "\nThe ${CLI_NAME} v${latest_version} was installed successfully!" "success"
 31 | 
 32 |     if [ "$EUID" -ne 0 ]; then
 33 |         output "\nInstall it globally on your system:" "info"
 34 |         output "  mv ${binary_dest}/${CLI_EXECUTABLE} /usr/local/bin/${CLI_EXECUTABLE}"
 35 |     fi
 36 | 
 37 |     output "\nDon't forget to start a new shell to use ${CLI_NAME}" "info"
 38 | }
 39 | 
 40 | third_party_check() {
 41 |     # cURL or wget
 42 |     downloader=""
 43 |     if command -v curl >/dev/null 2>&1; then
 44 |         downloader="curl"
 45 |         output "  [*] cURL is installed" "success"
 46 |     elif command -v wget >/dev/null 2>&1; then
 47 |         downloader="wget"
 48 |         output "  [*] wget is installed" "success"
 49 |     else
 50 |         output "  [ ] ERROR: cURL or wget is required for installation." "error"
 51 |         exit 1
 52 |     fi
 53 | }
 54 | 
 55 | platform_check() {
 56 |     # OS (linux|darwin)
 57 |     local os=$(uname -s 2>/dev/null || /usr/bin/uname -s)
 58 |     case ${os} in
 59 |         "Linux"|"linux")
 60 |             os="linux"
 61 |             ;;
 62 |         "Darwin"|"darwin")
 63 |             os="darwin"
 64 |             ;;
 65 |         *)
 66 |             output "OS '${os}' not supported" "error"
 67 |             exit 1
 68 |             ;;
 69 |     esac
 70 |     output "  [*] Your OS (${os}) is supported" "success"
 71 | 
 72 |     # Arch (amd64)
 73 |     local arch=$(uname -m 2>/dev/null || /usr/bin/uname -m)
 74 |     case ${arch} in
 75 |         arm64)
 76 |             arch="arm64"
 77 |             ;;
 78 |         x86_64)
 79 |             arch="amd64"
 80 |             ;;
 81 |         *)
 82 |             output "  [ ] Your architecture (${arch}) is not currently supported" "error"
 83 |             exit 1
 84 |             ;;
 85 |     esac
 86 |     output "  [*] Your architecture (${arch}) is supported" "success"
 87 | 
 88 |     platform="${os}-${arch}"
 89 | }
 90 | 
 91 | last_release_version() {
 92 |     output "  Last release version..." "" " ";
 93 | 
 94 |     case ${downloader} in
 95 |         "curl")
 96 |             latest_version=$(curl -sS "$CLI_REPO_LATEST_RELEASE_URL" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
 97 |             ;;
 98 |         "wget")
 99 |             latest_version=$(wget -q -nv -O- "$CLI_REPO_LATEST_RELEASE_URL" 2>/dev/null | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
100 |             ;;
101 |     esac
102 | 
103 |     if [ $? != 0 ]; then
104 |         output "Failed to download LATEST version file: ${CLI_LATEST_VERSION_URL}" "error"
105 |         exit 1
106 |     fi
107 | 
108 |     output "ok" "success"
109 | }
110 | 
111 | download_binary() {
112 |     local latest_url=${CLI_DOWNLOAD_URL_PATTERN/~latest_version~/${latest_version}}
113 |     latest_url=${latest_url/~platform~/${platform}}
114 | 
115 |     output "  Downloading binary..." "" " ";
116 |     case ${downloader} in
117 |         "curl")
118 |             curl -sSf --location "${latest_url}" > "/tmp/${CLI_BINARY_TMP_NAME}"
119 |             ;;
120 |         "wget")
121 |             wget -q "${latest_url}" -O "/tmp/${CLI_BINARY_TMP_NAME}"
122 |             ;;
123 |     esac
124 | 
125 |     if [ $? != 0 ]; then
126 |         output "The download failed." "error"
127 |         exit 1
128 |     fi
129 | 
130 |     output "ok" "success"
131 | }
132 | 
133 | executable_binary() {
134 |     output "  Making the binary executable..." "" " "
135 |     chmod 755 "/tmp/${CLI_BINARY_TMP_NAME}"
136 |     output "ok" "success"
137 | }
138 | 
139 | move_binary() {
140 |     output "  Installing the binary..." "" " "
141 | 
142 |     if [ "$EUID" -eq 0 ]; then
143 |         binary_dest="/usr/local/bin"
144 |     else
145 |         binary_dest="${HOME}/${CLI_CONFIG_DIR}/bin"
146 |         if [ ! -d "${binary_dest}" ]; then
147 |             if ! mkdir -p "${binary_dest}"; then
148 |                 binary_dest="."
149 |             fi
150 |         fi
151 |     fi
152 | 
153 |     mv "/tmp/${CLI_BINARY_TMP_NAME}" "${binary_dest}/${CLI_EXECUTABLE}"
154 | 
155 |     if [ $? != 0 ]; then
156 |         output "Failed to move the binary to ${binary_dest}." "error"
157 |         rm "/tmp/${CLI_BINARY_TMP_NAME}"
158 |         exit 1
159 |     fi
160 | 
161 |     output "ok" "success"
162 | }
163 | 
164 | ascii() {
165 |     cat << "EOF"
166 |    ___       __                  __
167 |   / _ |__ __/ /____  __ _  ___ _/ /____
168 |  / __ / // / __/ _ \/  ' \/ _ `/ __/ -_)
169 | /_/ |_\_,_/\__/\___/_/_/_/\_,_/\__/\__/
170 | EOF
171 | }
172 | 
173 | output() {
174 |     local style_start=""
175 |     local style_end=""
176 |     local carriage_return_start=""
177 |     local carriage_return_end="${3:-"\\n"}"
178 | 
179 |     if [ "${2:-}" != "" ]; then
180 |         case $2 in
181 |             "success")
182 |                 style_start="\033[0;32m"
183 |                 style_end="\033[0m"
184 |                 ;;
185 |             "error")
186 |                 style_start="\033[31;31m"
187 |                 style_end="\033[0m"
188 |                 ;;
189 |             "info"|"warning")
190 |                 style_start="\033[33m"
191 |                 style_end="\033[39m"
192 |                 ;;
193 |             "heading")
194 |                 carriage_return_start="\n"
195 |                 style_start="\033[1;33m"
196 |                 style_end="\033[22;39m"
197 |                 ;;
198 |         esac
199 |     fi
200 | 
201 |     builtin echo -ne "${carriage_return_start}${style_start}${1}${style_end}${carriage_return_end}"
202 | }
203 | 
204 | main "$@"; exit


--------------------------------------------------------------------------------
/phpstan.dist.neon:
--------------------------------------------------------------------------------
1 | parameters:
2 |     level: 6
3 |     paths:
4 |         - src
5 |     fileExtensions:
6 |         - php
7 |     excludePaths:
8 |         - src/Automate/Configuration.php
9 | 


--------------------------------------------------------------------------------
/phpunit.dist.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 3 |          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.0/phpunit.xsd"
 4 |          backupGlobals="false"
 5 |          backupStaticProperties="false"
 6 |          bootstrap="tests/bootstrap.php"
 7 |          cacheDirectory=".phpunit.cache"
 8 |          colors="true"
 9 |          processIsolation="false"
10 |          stopOnFailure="false"
11 | >
12 |     <testsuites>
13 |         <testsuite name="Automate Test Suite">
14 |             <directory>tests/Automate</directory>
15 |         </testsuite>
16 |     </testsuites>
17 | 
18 |     <source>
19 |         <include>
20 |             <directory suffix=".php">./src</directory>
21 |         </include>
22 |     </source>
23 | </phpunit>
24 | 


--------------------------------------------------------------------------------
/rector.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | use Rector\CodeQuality\Rector\Concat\JoinStringConcatRector;
 6 | use Rector\Config\RectorConfig;
 7 | use Rector\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector;
 8 | use Rector\PHPUnit\Set\PHPUnitSetList;
 9 | use Rector\Set\ValueObject\LevelSetList;
10 | use Rector\Set\ValueObject\SetList;
11 | use Rector\Symfony\Set\SymfonySetList;
12 | 
13 | return static function (RectorConfig $rectorConfig): void {
14 |     $rectorConfig->paths([
15 |         __DIR__.'/src',
16 |         __DIR__.'/tests',
17 |     ]);
18 | 
19 |     $rectorConfig->sets([
20 |         SetList::CODE_QUALITY,
21 |         SetList::CODING_STYLE,
22 |         SetList::TYPE_DECLARATION,
23 |         LevelSetList::UP_TO_PHP_83,
24 |         PHPUnitSetList::PHPUNIT_100,
25 |         SymfonySetList::SYMFONY_64,
26 |     ]);
27 | 
28 |     $rectorConfig->skip([
29 |         __DIR__.'/tests/fixtures/*',
30 |         AddOverrideAttributeToOverriddenMethodsRector::class,
31 |         JoinStringConcatRector::class => [
32 |             __DIR__ . '/src/Automate/Application.php',
33 |         ],
34 |     ]);
35 | };


--------------------------------------------------------------------------------
/src/Automate/Application.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate;
13 | 
14 | use Automate\Command\CheckCommand;
15 | use Automate\Command\DeployCommand;
16 | use Automate\Command\ExecCommand;
17 | use Symfony\Component\Console\Application as BaseApplication;
18 | 
19 | class Application extends BaseApplication
20 | {
21 |     public function __construct(string $name = 'Automate', string $version = '@git-version@')
22 |     {
23 |         parent::__construct($name, $version);
24 |     }
25 | 
26 |     public function getLongVersion(): string
27 |     {
28 |         if ('git-version' !== trim($this->getVersion(), '@')) {
29 |             return sprintf(
30 |                 '<info>%s</info> version <comment>%s</comment> build <comment>%s</comment>',
31 |                 $this->getName(),
32 |                 $this->getVersion(),
33 |                 '@git-commit@'
34 |             );
35 |         }
36 | 
37 |         return '<info>'.$this->getName().'</info> <comment>@dev</comment>';
38 |     }
39 | 
40 |     protected function getDefaultCommands(): array
41 |     {
42 |         // Keep the core default commands to have the HelpCommand
43 |         // which is used when using the --help option
44 |         $commands = parent::getDefaultCommands();
45 | 
46 |         $commands[] = new DeployCommand();
47 |         $commands[] = new CheckCommand();
48 |         $commands[] = new ExecCommand();
49 | 
50 |         return $commands;
51 |     }
52 | }
53 | 


--------------------------------------------------------------------------------
/src/Automate/Archiver.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate;
13 | 
14 | use Symfony\Component\Filesystem\Filesystem;
15 | use Symfony\Component\Filesystem\Path;
16 | use Symfony\Component\Finder\Finder;
17 | 
18 | use function Symfony\Component\String\u;
19 | 
20 | class Archiver
21 | {
22 |     private const string BASE_ARCHIVE_NAME = '.automate-';
23 | 
24 |     private readonly Filesystem $filesystem;
25 | 
26 |     public function __construct()
27 |     {
28 |         $this->filesystem = new Filesystem();
29 |     }
30 | 
31 |     /**
32 |      * @param string[] $exclude
33 |      */
34 |     public function archive(string $path, array $exclude = []): \PharData
35 |     {
36 |         $this->clear($path);
37 | 
38 |         $archive = new \PharData($this->getArchiveFileName($path, false));
39 |         $cwd = getcwd();
40 | 
41 |         if (is_dir($path)) {
42 |             $finder = new Finder();
43 |             $finder->files()
44 |                 ->ignoreDotFiles(false)
45 |                 ->in($path)
46 |                 ->notPath($exclude);
47 | 
48 |             $archive->buildFromIterator($finder->getIterator(), $cwd);
49 |         } else {
50 |             $archive->addFile($path, Path::makeRelative($path, $cwd));
51 |         }
52 | 
53 |         /** @var \PharData $compressed */
54 |         $compressed = $archive->compress(\Phar::GZ);
55 | 
56 |         return $compressed;
57 |     }
58 | 
59 |     public function getArchiveFileName(string $path, bool $compressed = true): string
60 |     {
61 |         $name = u(self::BASE_ARCHIVE_NAME.$path)->snake();
62 | 
63 |         return $compressed ? $name.'.tar.gz' : $name.'.tar';
64 |     }
65 | 
66 |     public function clear(string $path): void
67 |     {
68 |         $this->filesystem->remove($this->getArchiveFileName($path, false));
69 |         $this->filesystem->remove($this->getArchiveFileName($path));
70 |     }
71 | }
72 | 


--------------------------------------------------------------------------------
/src/Automate/Command/BaseCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Command;
13 | 
14 | use Automate\Logger\ConsoleLogger;
15 | use Automate\Logger\LoggerInterface;
16 | use Symfony\Component\Console\Command\Command;
17 | use Symfony\Component\Console\Style\SymfonyStyle;
18 | 
19 | abstract class BaseCommand extends Command
20 | {
21 |     public const string CONFIG_FILE = '.automate.yml';
22 | 
23 |     protected function getLogger(SymfonyStyle $io): LoggerInterface
24 |     {
25 |         return new ConsoleLogger($io);
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Automate/Command/CheckCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Command;
13 | 
14 | use Automate\Archiver;
15 | use Automate\Loader;
16 | use Automate\Ssh\SshFactory;
17 | use Automate\VariableResolver;
18 | use Automate\Workflow\Context;
19 | use Automate\Workflow\Session;
20 | use Symfony\Component\Console\Attribute\AsCommand;
21 | use Symfony\Component\Console\Command\Command;
22 | use Symfony\Component\Console\Input\InputArgument;
23 | use Symfony\Component\Console\Input\InputInterface;
24 | use Symfony\Component\Console\Input\InputOption;
25 | use Symfony\Component\Console\Output\OutputInterface;
26 | use Symfony\Component\Console\Style\SymfonyStyle;
27 | 
28 | #[AsCommand(
29 |     name: 'check',
30 |     description: 'check remote platform.',
31 | )]
32 | class CheckCommand extends BaseCommand
33 | {
34 |     protected function configure(): void
35 |     {
36 |         $this
37 |             ->addArgument('platform', InputArgument::REQUIRED, 'Platform name')
38 |             ->addOption('config', 'c', InputOption::VALUE_REQUIRED, 'Configuration file path', self::CONFIG_FILE);
39 |     }
40 | 
41 |     protected function execute(InputInterface $input, OutputInterface $output): int
42 |     {
43 |         $loader = new Loader();
44 |         $project = $loader->load($input->getOption('config'));
45 |         $platform = $project->getPlatform($input->getArgument('platform'));
46 |         $io = new SymfonyStyle($input, $output);
47 |         $variableResolver = new VariableResolver($io);
48 |         $variableResolver->process($platform);
49 | 
50 |         $logger = $this->getLogger($io);
51 |         $sshFactory = new SshFactory($platform, $variableResolver->getEnvVariables(), $input->getOption('config'));
52 | 
53 |         try {
54 |             $context = new Context($project, $platform, $logger, $sshFactory, new Archiver(), $platform->getDefaultBranch());
55 | 
56 |             $context->connect();
57 |             $logger->section('Check git access');
58 |             $context->exec(static function (Session $session) use ($project): void {
59 |                 $session->exec('git ls-remote '.$project->getRepository(), false);
60 |             });
61 |         } catch (\Exception $exception) {
62 |             $io->error($exception->getMessage());
63 | 
64 |             return Command::FAILURE;
65 |         }
66 | 
67 |         $io->success('All is OK');
68 | 
69 |         return Command::SUCCESS;
70 |     }
71 | }
72 | 


--------------------------------------------------------------------------------
/src/Automate/Command/DeployCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Command;
13 | 
14 | use Automate\Archiver;
15 | use Automate\Loader;
16 | use Automate\Model\Platform;
17 | use Automate\Ssh\SshFactory;
18 | use Automate\VariableResolver;
19 | use Automate\Workflow\Context;
20 | use Automate\Workflow\Deployer;
21 | use Symfony\Component\Console\Attribute\AsCommand;
22 | use Symfony\Component\Console\Command\Command;
23 | use Symfony\Component\Console\Input\InputArgument;
24 | use Symfony\Component\Console\Input\InputInterface;
25 | use Symfony\Component\Console\Input\InputOption;
26 | use Symfony\Component\Console\Output\OutputInterface;
27 | use Symfony\Component\Console\Style\SymfonyStyle;
28 | 
29 | #[AsCommand(
30 |     name: 'deploy',
31 |     description: 'Start remote deployment.',
32 | )]
33 | class DeployCommand extends BaseCommand
34 | {
35 |     protected function configure(): void
36 |     {
37 |         $this
38 |             ->addArgument('platform', InputArgument::REQUIRED, 'Platform name')
39 |             ->addArgument('gitRef', InputArgument::OPTIONAL, 'Branch or tag name')
40 |             ->addOption('config', 'c', InputOption::VALUE_REQUIRED, 'Configuration file path', self::CONFIG_FILE)
41 |             ->addOption('force', 'f', InputOption::VALUE_NONE, 'Force to deploy');
42 |     }
43 | 
44 |     protected function execute(InputInterface $input, OutputInterface $output): int
45 |     {
46 |         $loader = new Loader();
47 |         $project = $loader->load($input->getOption('config'));
48 |         $platform = $project->getPlatform($input->getArgument('platform'));
49 |         $io = new SymfonyStyle($input, $output);
50 | 
51 |         $variableResolver = new VariableResolver($io);
52 |         $variableResolver->process($platform);
53 | 
54 |         $logger = $this->getLogger($io);
55 |         $logger->section('Start deployment');
56 | 
57 |         $gitRef = $input->getArgument('gitRef');
58 | 
59 |         $io->table([], [
60 |             ['Repository', $project->getRepository()],
61 |             ['Platform', $platform->getName()],
62 |             ['Servers', $this->getServersList($platform)],
63 |             ['Version', $input->getArgument('gitRef') ?: $platform->getDefaultBranch()],
64 |         ]);
65 | 
66 |         $sshFactory = new SshFactory($platform, $variableResolver->getEnvVariables(), $input->getOption('config'));
67 | 
68 |         $context = new Context($project, $platform, $logger, $sshFactory, new Archiver(), $gitRef, $input->getOption('force'));
69 |         $workflow = new Deployer($context);
70 | 
71 |         if (!$workflow->deploy()) {
72 |             throw new \RuntimeException('Deployment failed');
73 |         }
74 | 
75 |         $io->success('All is OK');
76 | 
77 |         return Command::SUCCESS;
78 |     }
79 | 
80 |     private function getServersList(Platform $platform): string
81 |     {
82 |         $servers = [];
83 |         foreach ($platform->getServers() as $server) {
84 |             $servers[] = sprintf('%s (%s)', $server->getName(), $server->getHost());
85 |         }
86 | 
87 |         return implode("\n", $servers);
88 |     }
89 | }
90 | 


--------------------------------------------------------------------------------
/src/Automate/Command/ExecCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Command;
13 | 
14 | use Automate\Loader;
15 | use Automate\Ssh\Ssh;
16 | use Automate\VariableResolver;
17 | use Symfony\Component\Console\Attribute\AsCommand;
18 | use Symfony\Component\Console\Command\Command;
19 | use Symfony\Component\Console\Input\InputArgument;
20 | use Symfony\Component\Console\Input\InputInterface;
21 | use Symfony\Component\Console\Input\InputOption;
22 | use Symfony\Component\Console\Output\OutputInterface;
23 | use Symfony\Component\Console\Style\SymfonyStyle;
24 | 
25 | #[AsCommand(
26 |     name: 'exec',
27 |     description: 'Exec ssh command',
28 | )]
29 | class ExecCommand extends BaseCommand
30 | {
31 |     protected function configure(): void
32 |     {
33 |         $this
34 |             ->setHidden()
35 |             ->addArgument('platform', InputArgument::REQUIRED, 'Platform name')
36 |             ->addArgument('server', InputArgument::REQUIRED, 'server name')
37 |             ->addArgument('cmd', InputArgument::REQUIRED, 'Command')
38 |             ->addOption('config', 'c', InputOption::VALUE_REQUIRED, 'Configuration file path', self::CONFIG_FILE);
39 |     }
40 | 
41 |     protected function execute(InputInterface $input, OutputInterface $output): int
42 |     {
43 |         $loader = new Loader();
44 |         $project = $loader->load($input->getOption('config'));
45 |         $platform = $project->getPlatform($input->getArgument('platform'));
46 |         $server = $platform->getServer($input->getArgument('server'));
47 |         $command = $input->getArgument('cmd');
48 | 
49 |         $io = new SymfonyStyle($input, $output);
50 |         $variableResolver = new VariableResolver($io);
51 |         $variableResolver->process($platform);
52 | 
53 |         $ssh = new Ssh($platform, $server, $variableResolver->getEnvVariables(), $input->getOption('config'));
54 |         $ssh->login();
55 | 
56 |         try {
57 |             $rs = $ssh->exec($command);
58 |             $output->write($rs);
59 |         } catch (\Exception $exception) {
60 |             $output->write($exception->getMessage());
61 | 
62 |             return Command::FAILURE;
63 |         }
64 | 
65 |         return Command::SUCCESS;
66 |     }
67 | }
68 | 


--------------------------------------------------------------------------------
/src/Automate/CommandDenormalizer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate;
13 | 
14 | use Automate\Model\Action;
15 | use Automate\Model\Command;
16 | use Automate\Model\Upload;
17 | use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
18 | 
19 | class CommandDenormalizer implements DenormalizerInterface
20 | {
21 |     /**
22 |      * @param array<string, mixed> $context
23 |      */
24 |     public function denormalize(mixed $data, string $type, ?string $format = null, array $context = []): mixed
25 |     {
26 |         if (isset($data['cmd'])) {
27 |             $action = new Command($data['cmd']);
28 |         } elseif (isset($data['upload'])) {
29 |             $action = new Upload(
30 |                 path: $data['upload'],
31 |                 exclude: $data['exclude'] ?? null
32 |             );
33 |         } else {
34 |             throw new \InvalidArgumentException('Actions must have a "cmd" or "upload" parameter.');
35 |         }
36 | 
37 |         $action->setOnly($data['only'] ?? null);
38 | 
39 |         return $action;
40 |     }
41 | 
42 |     /**
43 |      * @param array<string, mixed> $context
44 |      */
45 |     public function supportsDenormalization(mixed $data, string $type, ?string $format = null, array $context = []): bool
46 |     {
47 |         return is_array($data);
48 |     }
49 | 
50 |     public function getSupportedTypes(?string $format): array
51 |     {
52 |         return [
53 |             Action::class => true,
54 |         ];
55 |     }
56 | }
57 | 


--------------------------------------------------------------------------------
/src/Automate/Configuration.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the Automate package.
  5 |  *
  6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | namespace Automate;
 13 | 
 14 | use Symfony\Component\Config\Definition\Builder\NodeDefinition;
 15 | use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 16 | use Symfony\Component\Config\Definition\ConfigurationInterface;
 17 | 
 18 | readonly class Configuration implements ConfigurationInterface
 19 | {
 20 |     public function getConfigTreeBuilder(): TreeBuilder
 21 |     {
 22 |         $treeBuilder = new TreeBuilder('automate');
 23 | 
 24 |         $treeBuilder->getRootNode()
 25 |             ->children()
 26 |                 ->scalarNode('repository')->end()
 27 |                 ->arrayNode('shared_files')
 28 |                     ->scalarPrototype()->end()
 29 |                 ->end()
 30 |                 ->arrayNode('shared_folders')
 31 |                     ->scalarPrototype()->end()
 32 |                 ->end()
 33 |                 ->append($this->addCommandsNode('pre_deploy'))
 34 |                 ->append($this->addCommandsNode('on_deploy'))
 35 |                 ->append($this->addCommandsNode('post_deploy'))
 36 |                 ->append($this->addPlatformsNode())
 37 |             ->end();
 38 | 
 39 |         return $treeBuilder;
 40 |     }
 41 | 
 42 |     private function addCommandsNode(string $name): NodeDefinition
 43 |     {
 44 |         $treeBuilder = new TreeBuilder($name);
 45 | 
 46 |         return $treeBuilder->getRootNode()
 47 |             ->arrayPrototype()
 48 |                 ->beforeNormalization()
 49 |                     ->ifString()
 50 |                     ->then(static fn($v): array => ['cmd' => $v])
 51 |                 ->end()
 52 |                 ->children()
 53 |                     ->scalarNode('cmd')->end()
 54 |                     ->scalarNode('upload')->end()
 55 |                     ->arrayNode('exclude')->scalarPrototype()->end()->end()
 56 |                     ->arrayNode('only')
 57 |                         ->defaultValue([])
 58 |                         ->beforeNormalization()
 59 |                         ->ifString()
 60 |                             ->then(static fn($v): array => [$v])
 61 |                         ->end()
 62 |                         ->scalarPrototype()->end()
 63 |                     ->end()
 64 |                 ->end()
 65 |             ->end();
 66 |     }
 67 | 
 68 |     private function addPlatformsNode(): NodeDefinition
 69 |     {
 70 |         $treeBuilder = new TreeBuilder('platforms');
 71 | 
 72 |         return $treeBuilder->getRootNode()
 73 |             ->isRequired()
 74 |             ->requiresAtLeastOneElement()
 75 |             ->normalizeKeys(false)
 76 |             ->useAttributeAsKey('name')
 77 |             ->arrayPrototype()
 78 |                 ->children()
 79 |                     ->scalarNode('default_branch')->isRequired()->cannotBeEmpty()->end()
 80 |                     ->integerNode('max_releases')->defaultValue(5)->end()
 81 |                     ->append($this->addServersNode())
 82 |                 ->end()
 83 |             ->end();
 84 |     }
 85 | 
 86 |     private function addServersNode(): NodeDefinition
 87 |     {
 88 |         $treeBuilder = new TreeBuilder('servers');
 89 | 
 90 |         return $treeBuilder->getRootNode()
 91 |             ->isRequired()
 92 |             ->requiresAtLeastOneElement()
 93 |             ->normalizeKeys(false)
 94 |             ->useAttributeAsKey('name')
 95 |             ->arrayPrototype()
 96 |                 ->children()
 97 |                     ->scalarNode('host')->isRequired()->cannotBeEmpty()->end()
 98 |                     ->scalarNode('user')->isRequired()->cannotBeEmpty()->end()
 99 |                     ->scalarNode('password')->end()
100 |                     ->scalarNode('ssh_key')->cannotBeEmpty()->end()
101 |                     ->scalarNode('path')->isRequired()->cannotBeEmpty()->end()
102 |                     ->scalarNode('shared_path')->cannotBeEmpty()->end()
103 |                     ->integerNode('port')->defaultValue(22)->end()
104 |                 ->end()
105 |             ->end();
106 |     }
107 | }
108 | 


--------------------------------------------------------------------------------
/src/Automate/DispatcherFactory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate;
13 | 
14 | use Automate\Listener\ClearListener;
15 | use Automate\Listener\LockListener;
16 | use Symfony\Component\EventDispatcher\EventDispatcher;
17 | 
18 | readonly class DispatcherFactory
19 | {
20 |     public static function create(): EventDispatcher
21 |     {
22 |         $dispatcher = new EventDispatcher();
23 | 
24 |         $dispatcher->addSubscriber(new LockListener());
25 |         $dispatcher->addSubscriber(new ClearListener());
26 | 
27 |         return $dispatcher;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/Automate/Event/DeployEvent.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Event;
13 | 
14 | use Automate\Workflow\Context;
15 | use Symfony\Contracts\EventDispatcher\Event;
16 | 
17 | class DeployEvent extends Event
18 | {
19 |     public function __construct(
20 |         private readonly Context $context,
21 |     ) {
22 |     }
23 | 
24 |     public function getContext(): Context
25 |     {
26 |         return $this->context;
27 |     }
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Automate/Event/DeployEvents.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Event;
13 | 
14 | final class DeployEvents
15 | {
16 |     public const string INIT = 'init';
17 | 
18 |     public const string BUILD = 'build';
19 | 
20 |     public const string DEPLOY = 'deploy';
21 | 
22 |     public const string FINISH = 'finish';
23 | 
24 |     public const string FAILED = 'failed';
25 | 
26 |     public const string TERMINATE = 'terminate';
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Automate/Event/FailedDeployEvent.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Event;
13 | 
14 | use Automate\Workflow\Context;
15 | 
16 | class FailedDeployEvent extends DeployEvent
17 | {
18 |     public function __construct(Context $context, private readonly \Exception $exception)
19 |     {
20 |         parent::__construct($context);
21 |     }
22 | 
23 |     public function getException(): \Exception
24 |     {
25 |         return $this->exception;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Automate/Listener/ClearListener.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Listener;
13 | 
14 | use Automate\Event\DeployEvent;
15 | use Automate\Event\DeployEvents;
16 | use Automate\Event\FailedDeployEvent;
17 | use Automate\Model\Server;
18 | use Automate\Workflow\Session;
19 | use Symfony\Component\EventDispatcher\EventSubscriberInterface;
20 | 
21 | class ClearListener implements EventSubscriberInterface
22 | {
23 |     public static function getSubscribedEvents(): array
24 |     {
25 |         return [
26 |             DeployEvents::INIT => 'removeFailedRelease',
27 |             DeployEvents::FAILED => 'moveFailedRelease',
28 |             DeployEvents::TERMINATE => 'clearReleases',
29 |         ];
30 |     }
31 | 
32 |     /**
33 |      * remove the lasted failed release.
34 |      */
35 |     public function removeFailedRelease(DeployEvent $event): void
36 |     {
37 |         $context = $event->getContext();
38 | 
39 |         $context->exec(function (Session $session): void {
40 |             if ($session->exists($this->getFailedPath($session->getServer()))) {
41 |                 $session->rm($this->getFailedPath($session->getServer()), true);
42 |             }
43 |         });
44 |     }
45 | 
46 |     /**
47 |      * Move current release to /releases/failed.
48 |      */
49 |     public function moveFailedRelease(FailedDeployEvent $event): void
50 |     {
51 |         $context = $event->getContext();
52 | 
53 |         // not move if deploy
54 |         if (!$context->isDeployed()) {
55 |             $context->exec(function (Session $session) use ($context): void {
56 |                 $release = $session->getReleasePath();
57 |                 $failed = $this->getFailedPath($session->getServer());
58 | 
59 |                 $context->getLogger()->info(sprintf('move release to %s', $failed), $session->getServer());
60 | 
61 |                 $session->mv($release, $failed);
62 |             });
63 |         }
64 |     }
65 | 
66 |     /**
67 |      * Clear olds releases.
68 |      */
69 |     public function clearReleases(DeployEvent $event): void
70 |     {
71 |         $context = $event->getContext();
72 | 
73 |         $context->getLogger()->section('Clear olds releases');
74 | 
75 |         $context->exec(static function (Session $session) use ($context): void {
76 |             $releases = $session->listDirectory($session->getReleasesPath());
77 |             $releases = array_map('trim', $releases);
78 |             rsort($releases);
79 |             // ignore others folders
80 |             $releases = array_filter($releases, static fn ($release): int|false => preg_match('/\d{4}\.\d{2}\.\d{2}-\d{4}\./', (string) $release));
81 |             $keep = $context->getPlatform()->getMaxReleases();
82 |             while ($keep > 0) {
83 |                 array_shift($releases);
84 |                 --$keep;
85 |             }
86 | 
87 |             foreach ($releases as $release) {
88 |                 $context->getLogger()->info('Remove old release : '.$release, $session->getServer());
89 |                 $session->rm($release, true);
90 |             }
91 |         });
92 |     }
93 | 
94 |     private function getFailedPath(Server $server): string
95 |     {
96 |         return $server->getPath().'/releases/failed';
97 |     }
98 | }
99 | 


--------------------------------------------------------------------------------
/src/Automate/Listener/LockListener.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Listener;
13 | 
14 | use Automate\Event\DeployEvent;
15 | use Automate\Event\DeployEvents;
16 | use Automate\Model\Server;
17 | use Automate\Workflow\Session;
18 | use Symfony\Component\EventDispatcher\EventSubscriberInterface;
19 | use Symfony\Component\Filesystem\Path;
20 | 
21 | class LockListener implements EventSubscriberInterface
22 | {
23 |     public const string LOCK_FILE = 'automate.lock';
24 | 
25 |     private bool $hasLock = false;
26 | 
27 |     public static function getSubscribedEvents(): array
28 |     {
29 |         return [
30 |             DeployEvents::INIT => 'initLockFile',
31 |             DeployEvents::TERMINATE => 'clearLockFile',
32 |             DeployEvents::FAILED => 'clearLockFile',
33 |         ];
34 |     }
35 | 
36 |     /**
37 |      * Check if a deployment is already in progress
38 |      * and create lock file.
39 |      */
40 |     public function initLockFile(DeployEvent $event): void
41 |     {
42 |         $context = $event->getContext();
43 | 
44 |         $context->exec(function (Session $session) use ($context): void {
45 |             if ($session->exists($this->getLockFilePath($session->getServer())) && !$context->isForce()) {
46 |                 throw new \RuntimeException('A deployment is already in progress');
47 |             }
48 | 
49 |             $session->touch($this->getLockFilePath($session->getServer()));
50 |         });
51 | 
52 |         $this->hasLock = true;
53 |     }
54 | 
55 |     /**
56 |      * Remove lock file.
57 |      */
58 |     public function clearLockFile(DeployEvent $event): void
59 |     {
60 |         $context = $event->getContext();
61 | 
62 |         if ($this->hasLock) {
63 |             $context->exec(function (Session $session): void {
64 |                 $session->rm($this->getLockFilePath($session->getServer()));
65 |             });
66 |         }
67 |     }
68 | 
69 |     /**
70 |      * Get lock file path.
71 |      */
72 |     private function getLockFilePath(Server $server): string
73 |     {
74 |         return Path::join($server->getPath(), self::LOCK_FILE);
75 |     }
76 | }
77 | 


--------------------------------------------------------------------------------
/src/Automate/Loader.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate;
13 | 
14 | use Automate\Model\Project;
15 | use Symfony\Component\Config\Definition\Processor;
16 | use Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor;
17 | use Symfony\Component\Serializer\Encoder\YamlEncoder;
18 | use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
19 | use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer;
20 | use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
21 | use Symfony\Component\Serializer\Serializer;
22 | use Symfony\Component\Yaml\Yaml;
23 | 
24 | /**
25 |  * Configuration loader.
26 |  */
27 | class Loader
28 | {
29 |     /**
30 |      * Load project configuration.
31 |      */
32 |     public function load(string $path): Project
33 |     {
34 |         $processor = new Processor();
35 | 
36 |         $configuration = new Configuration();
37 | 
38 |         if (!file_exists($path) || !$data = file_get_contents($path)) {
39 |             throw new \InvalidArgumentException(sprintf('Missing configuration file "%s', $path));
40 |         }
41 | 
42 |         $data = Yaml::parse($data);
43 | 
44 |         $processedConfiguration = $processor->processConfiguration($configuration, [$data]);
45 | 
46 |         foreach ($processedConfiguration['platforms'] as $platformName => $platform) {
47 |             $processedConfiguration['platforms'][$platformName]['name'] = $platformName;
48 |             foreach ($platform['servers'] as $serverName => $server) {
49 |                 $processedConfiguration['platforms'][$platformName]['servers'][$serverName]['name'] = $serverName;
50 |             }
51 |         }
52 | 
53 |         return $this->getSerializer()->denormalize($processedConfiguration, Project::class);
54 |     }
55 | 
56 |     private function getSerializer(): Serializer
57 |     {
58 |         $objectNormalizer = new ObjectNormalizer(
59 |             nameConverter: new CamelCaseToSnakeCaseNameConverter(),
60 |             propertyTypeExtractor: new PhpDocExtractor()
61 |         );
62 | 
63 |         return new Serializer(
64 |             [new CommandDenormalizer(), $objectNormalizer, new ArrayDenormalizer()],
65 |             [new YamlEncoder()]
66 |         );
67 |     }
68 | }
69 | 


--------------------------------------------------------------------------------
/src/Automate/Logger/ConsoleLogger.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Logger;
13 | 
14 | use Automate\Model\Server;
15 | use Symfony\Component\Console\Style\SymfonyStyle;
16 | 
17 | class ConsoleLogger implements LoggerInterface
18 | {
19 |     public function __construct(
20 |         private readonly SymfonyStyle $io,
21 |     ) {
22 |     }
23 | 
24 |     public function section(string $title): void
25 |     {
26 |         $this->io->block($title, '*', 'fg=white;bg=blue', ' ', true);
27 |     }
28 | 
29 |     public function command(string $name): void
30 |     {
31 |         $this->io->text(sprintf('<info>%s</info>', $name));
32 |     }
33 | 
34 |     public function result(string $response, Server $server): void
35 |     {
36 |         if (substr_count($response, "\n") > 0) {
37 |             $this->io->text(sprintf('<comment>[%s]</comment>', $server->getName()));
38 |             $this->io->text($response);
39 |         } else {
40 |             $this->io->text(sprintf('<comment>[%s]</comment> %s', $server->getName(), $response));
41 |         }
42 |     }
43 | 
44 |     public function info(string $text, ?Server $server = null): void
45 |     {
46 |         if ($server instanceof Server) {
47 |             $this->io->text(sprintf('<comment>[%s]</comment> %s', $server->getName(), $text));
48 |         } else {
49 |             $this->io->text($text);
50 |         }
51 |     }
52 | 
53 |     public function error(string $message): void
54 |     {
55 |         $this->io->error($message);
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/src/Automate/Logger/LoggerInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Logger;
13 | 
14 | use Automate\Model\Server;
15 | 
16 | interface LoggerInterface
17 | {
18 |     public function section(string $title): void;
19 | 
20 |     public function command(string $name): void;
21 | 
22 |     public function result(string $response, Server $server): void;
23 | 
24 |     public function info(string $text, ?Server $server = null): void;
25 | 
26 |     public function error(string $message): void;
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Automate/Model/Action.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Model;
13 | 
14 | abstract class Action
15 | {
16 |     /**
17 |      * @var ?string[]
18 |      */
19 |     protected ?array $only = null;
20 | 
21 |     /**
22 |      * @return null|string[]
23 |      */
24 |     public function getOnly(): ?array
25 |     {
26 |         return $this->only;
27 |     }
28 | 
29 |     /**
30 |      * @param string[] $only
31 |      */
32 |     public function setOnly(array $only): self
33 |     {
34 |         $this->only = $only;
35 | 
36 |         return $this;
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/src/Automate/Model/Command.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Model;
13 | 
14 | class Command extends Action
15 | {
16 |     /**
17 |      * @param null|string[] $only
18 |      */
19 |     public function __construct(
20 |         private ?string $cmd = null,
21 |         protected ?array $only = null,
22 |     ) {
23 |     }
24 | 
25 |     public function getCmd(): ?string
26 |     {
27 |         return $this->cmd;
28 |     }
29 | 
30 |     public function setCmd(string $cmd): self
31 |     {
32 |         $this->cmd = $cmd;
33 | 
34 |         return $this;
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/src/Automate/Model/Platform.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Model;
13 | 
14 | class Platform
15 | {
16 |     /**
17 |      * @param array<string, Server> $servers
18 |      */
19 |     public function __construct(
20 |         private ?string $name = null,
21 |         private ?string $defaultBranch = null,
22 |         private ?int $maxReleases = null,
23 |         private array $servers = [],
24 |     ) {
25 |     }
26 | 
27 |     public function getName(): ?string
28 |     {
29 |         return $this->name;
30 |     }
31 | 
32 |     public function setName(string $name): self
33 |     {
34 |         $this->name = $name;
35 | 
36 |         return $this;
37 |     }
38 | 
39 |     public function getDefaultBranch(): ?string
40 |     {
41 |         return $this->defaultBranch;
42 |     }
43 | 
44 |     public function setDefaultBranch(string $defaultBranch): self
45 |     {
46 |         $this->defaultBranch = $defaultBranch;
47 | 
48 |         return $this;
49 |     }
50 | 
51 |     public function getMaxReleases(): ?int
52 |     {
53 |         return $this->maxReleases;
54 |     }
55 | 
56 |     public function setMaxReleases(int $maxReleases): self
57 |     {
58 |         $this->maxReleases = $maxReleases;
59 | 
60 |         return $this;
61 |     }
62 | 
63 |     /**
64 |      * @return $this
65 |      */
66 |     public function addServer(Server $server): self
67 |     {
68 |         $this->servers[] = $server;
69 | 
70 |         return $this;
71 |     }
72 | 
73 |     /**
74 |      * @return Server[]
75 |      */
76 |     public function getServers(): array
77 |     {
78 |         return $this->servers;
79 |     }
80 | 
81 |     public function getServer(string $name): Server
82 |     {
83 |         foreach ($this->servers as $server) {
84 |             if ($name === $server->getName()) {
85 |                 return $server;
86 |             }
87 |         }
88 | 
89 |         throw new \InvalidArgumentException(sprintf('Missing server %s', $name));
90 |     }
91 | }
92 | 


--------------------------------------------------------------------------------
/src/Automate/Model/Project.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the Automate package.
  5 |  *
  6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | namespace Automate\Model;
 13 | 
 14 | class Project
 15 | {
 16 |     /**
 17 |      * @param string[]                $sharedFiles
 18 |      * @param string[]                $sharedFolders
 19 |      * @param Action[]                $preDeploy
 20 |      * @param Action[]                $onDeploy
 21 |      * @param Action[]                $postDeploy
 22 |      * @param array<string, Platform> $platforms
 23 |      */
 24 |     public function __construct(
 25 |         private ?string $repository = null,
 26 |         private array $sharedFiles = [],
 27 |         private array $sharedFolders = [],
 28 |         private array $preDeploy = [],
 29 |         private array $onDeploy = [],
 30 |         private array $postDeploy = [],
 31 |         private array $platforms = [],
 32 |     ) {
 33 |     }
 34 | 
 35 |     public function getRepository(): ?string
 36 |     {
 37 |         return $this->repository;
 38 |     }
 39 | 
 40 |     public function setRepository(string $repository): self
 41 |     {
 42 |         $this->repository = $repository;
 43 | 
 44 |         return $this;
 45 |     }
 46 | 
 47 |     /**
 48 |      * @return string[]
 49 |      */
 50 |     public function getSharedFiles(): array
 51 |     {
 52 |         return $this->sharedFiles;
 53 |     }
 54 | 
 55 |     /**
 56 |      * @param string[] $sharedFiles
 57 |      */
 58 |     public function setSharedFiles(array $sharedFiles): self
 59 |     {
 60 |         $this->sharedFiles = $sharedFiles;
 61 | 
 62 |         return $this;
 63 |     }
 64 | 
 65 |     /**
 66 |      * @return string[]
 67 |      */
 68 |     public function getSharedFolders(): array
 69 |     {
 70 |         return $this->sharedFolders;
 71 |     }
 72 | 
 73 |     /**
 74 |      * @param string[] $sharedFolders
 75 |      */
 76 |     public function setSharedFolders(array $sharedFolders): self
 77 |     {
 78 |         $this->sharedFolders = $sharedFolders;
 79 | 
 80 |         return $this;
 81 |     }
 82 | 
 83 |     /**
 84 |      * @return Action[]
 85 |      */
 86 |     public function getPreDeploy(): array
 87 |     {
 88 |         return $this->preDeploy;
 89 |     }
 90 | 
 91 |     /**
 92 |      * @param Action[] $preDeploy
 93 |      */
 94 |     public function setPreDeploy(array $preDeploy): self
 95 |     {
 96 |         $this->preDeploy = $preDeploy;
 97 | 
 98 |         return $this;
 99 |     }
100 | 
101 |     /**
102 |      * @return Action[]
103 |      */
104 |     public function getOnDeploy(): array
105 |     {
106 |         return $this->onDeploy;
107 |     }
108 | 
109 |     /**
110 |      * @param Action[] $onDeploy
111 |      */
112 |     public function setOnDeploy(array $onDeploy): self
113 |     {
114 |         $this->onDeploy = $onDeploy;
115 | 
116 |         return $this;
117 |     }
118 | 
119 |     /**
120 |      * @return Action[]
121 |      */
122 |     public function getPostDeploy(): array
123 |     {
124 |         return $this->postDeploy;
125 |     }
126 | 
127 |     /**
128 |      * @param Action[] $postDeploy
129 |      */
130 |     public function setPostDeploy(array $postDeploy): self
131 |     {
132 |         $this->postDeploy = $postDeploy;
133 | 
134 |         return $this;
135 |     }
136 | 
137 |     public function addPlatform(Platform $platform): self
138 |     {
139 |         $this->platforms[$platform->getName()] = $platform;
140 | 
141 |         return $this;
142 |     }
143 | 
144 |     /**
145 |      * @return Platform[]
146 |      */
147 |     public function getPlatforms(): array
148 |     {
149 |         return $this->platforms;
150 |     }
151 | 
152 |     public function getPlatform(string $name): Platform
153 |     {
154 |         if (!isset($this->platforms[$name])) {
155 |             throw new \InvalidArgumentException(sprintf('Missing platform %s', $name));
156 |         }
157 | 
158 |         return $this->platforms[$name];
159 |     }
160 | }
161 | 


--------------------------------------------------------------------------------
/src/Automate/Model/Server.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the Automate package.
  5 |  *
  6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | namespace Automate\Model;
 13 | 
 14 | class Server
 15 | {
 16 |     public function __construct(
 17 |         private ?string $name = null,
 18 |         private ?string $host = null,
 19 |         private ?string $user = null,
 20 |         private ?string $sshKey = null,
 21 |         private ?string $password = null,
 22 |         private ?string $path = null,
 23 |         private ?string $sharedPath = null,
 24 |         private ?int $port = null,
 25 |     ) {
 26 |     }
 27 | 
 28 |     public function getName(): ?string
 29 |     {
 30 |         return $this->name;
 31 |     }
 32 | 
 33 |     public function setName(string $name): self
 34 |     {
 35 |         $this->name = $name;
 36 | 
 37 |         return $this;
 38 |     }
 39 | 
 40 |     public function getHost(): ?string
 41 |     {
 42 |         return $this->host;
 43 |     }
 44 | 
 45 |     public function setHost(?string $host): self
 46 |     {
 47 |         $this->host = $host;
 48 | 
 49 |         return $this;
 50 |     }
 51 | 
 52 |     public function getUser(): ?string
 53 |     {
 54 |         return $this->user;
 55 |     }
 56 | 
 57 |     public function setUser(?string $user): self
 58 |     {
 59 |         $this->user = $user;
 60 | 
 61 |         return $this;
 62 |     }
 63 | 
 64 |     public function getSshKey(): ?string
 65 |     {
 66 |         return $this->sshKey;
 67 |     }
 68 | 
 69 |     public function setSshKey(?string $sshKey): self
 70 |     {
 71 |         $this->sshKey = $sshKey;
 72 | 
 73 |         return $this;
 74 |     }
 75 | 
 76 |     public function getPassword(): ?string
 77 |     {
 78 |         return $this->password;
 79 |     }
 80 | 
 81 |     public function setPassword(?string $password): self
 82 |     {
 83 |         $this->password = $password;
 84 | 
 85 |         return $this;
 86 |     }
 87 | 
 88 |     public function getPath(): ?string
 89 |     {
 90 |         return $this->path;
 91 |     }
 92 | 
 93 |     public function setPath(?string $path): self
 94 |     {
 95 |         $this->path = $path;
 96 | 
 97 |         return $this;
 98 |     }
 99 | 
100 |     public function getSharedPath(): ?string
101 |     {
102 |         return $this->sharedPath;
103 |     }
104 | 
105 |     public function setSharedPath(?string $sharedPath): self
106 |     {
107 |         $this->sharedPath = $sharedPath;
108 | 
109 |         return $this;
110 |     }
111 | 
112 |     public function getPort(): ?int
113 |     {
114 |         return $this->port;
115 |     }
116 | 
117 |     public function setPort(?int $port): self
118 |     {
119 |         $this->port = $port;
120 | 
121 |         return $this;
122 |     }
123 | }
124 | 


--------------------------------------------------------------------------------
/src/Automate/Model/Upload.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Model;
13 | 
14 | class Upload extends Action
15 | {
16 |     /**
17 |      * @param null|string[] $only
18 |      * @param null|string[] $exclude
19 |      */
20 |     public function __construct(
21 |         private string $path,
22 |         private ?array $exclude = null,
23 |         protected ?array $only = null,
24 |     ) {
25 |     }
26 | 
27 |     public function getPath(): string
28 |     {
29 |         return $this->path;
30 |     }
31 | 
32 |     public function setPath(string $path): self
33 |     {
34 |         $this->path = $path;
35 | 
36 |         return $this;
37 |     }
38 | 
39 |     /**
40 |      * @return ?string[]
41 |      */
42 |     public function getExclude(): ?array
43 |     {
44 |         return $this->exclude;
45 |     }
46 | 
47 |     /**
48 |      * @param ?string[] $exclude
49 |      */
50 |     public function setExclude(?array $exclude): self
51 |     {
52 |         $this->exclude = $exclude;
53 | 
54 |         return $this;
55 |     }
56 | }
57 | 


--------------------------------------------------------------------------------
/src/Automate/Ssh/Ssh.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Ssh;
13 | 
14 | use Automate\Model\Platform;
15 | use Automate\Model\Server;
16 | use phpseclib3\Crypt\PublicKeyLoader;
17 | use phpseclib3\Net\SFTP;
18 | use Symfony\Component\Filesystem\Path;
19 | use Symfony\Component\Process\Process;
20 | 
21 | class Ssh
22 | {
23 |     private ?SFTP $sftp = null;
24 | 
25 |     /**
26 |      * @param array<string, string> $variables
27 |      */
28 |     public function __construct(
29 |         private readonly Platform $platform,
30 |         private readonly Server $server,
31 |         private readonly array $variables,
32 |         private readonly string $configFile,
33 |     ) {
34 |     }
35 | 
36 |     public function login(): void
37 |     {
38 |         $this->sftp = new SFTP($this->server->getHost(), $this->server->getPort());
39 | 
40 |         // Connection with ssh key and optional
41 |         if (null !== $this->server->getSshKey()) {
42 |             if (!file_exists($this->server->getSshKey())) {
43 |                 throw new \Exception(sprintf('[%s] File "'.$this->server->getSshKey().'" not found', $this->server->getName()));
44 |             }
45 | 
46 |             $key = PublicKeyLoader::load(file_get_contents($this->server->getSshKey()), $this->server->getPassword());
47 |             if (!$this->sftp->login($this->server->getUser(), $key)) {
48 |                 throw new \Exception(sprintf('[%s] SSH key or passphrase is invalid', $this->server->getName()));
49 |             }
50 |         } elseif (!$this->sftp->login($this->server->getUser(), $this->server->getPassword())) {
51 |             throw new \Exception(sprintf('[%s] Invalid user or password', $this->server->getName()));
52 |         }
53 | 
54 |         $this->sftp->setTimeout(0);
55 |     }
56 | 
57 |     public function exec(string $command): string
58 |     {
59 |         if (!$this->sftp instanceof SFTP) {
60 |             throw new \RuntimeException('The connection is not active');
61 |         }
62 | 
63 |         $rs = (string) $this->sftp->exec($command);
64 | 
65 |         if (0 !== $this->sftp->getExitStatus()) {
66 |             throw new \RuntimeException($rs);
67 |         }
68 | 
69 |         return $rs;
70 |     }
71 | 
72 |     public function upload(string $path, string $target): void
73 |     {
74 |         if (!$this->sftp instanceof SFTP) {
75 |             throw new \RuntimeException('The connection is not active');
76 |         }
77 | 
78 |         $rs = $this->sftp->put($target, $path, SFTP::SOURCE_LOCAL_FILE);
79 | 
80 |         if (!$rs) {
81 |             throw new \RuntimeException('Sftp error');
82 |         }
83 |     }
84 | 
85 |     public function execAsync(string $command): Process
86 |     {
87 |         $bin = \Phar::running(false);
88 | 
89 |         if ('' === $bin) {
90 |             $bin = Path::join(dirname(__FILE__, 4), 'bin', 'automate');
91 |         }
92 | 
93 |         return new Process([
94 |             $bin, 'exec', $this->platform->getName(), $this->server->getName(), $command, '-c', $this->configFile,
95 |         ], env: $this->variables, timeout: 0);
96 |     }
97 | }
98 | 


--------------------------------------------------------------------------------
/src/Automate/Ssh/SshFactory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Ssh;
13 | 
14 | use Automate\Model\Platform;
15 | use Automate\Model\Server;
16 | 
17 | class SshFactory
18 | {
19 |     /**
20 |      * @param array<string, string> $variables
21 |      */
22 |     public function __construct(
23 |         private readonly Platform $platform,
24 |         private readonly array $variables,
25 |         private readonly string $configFile,
26 |     ) {
27 |     }
28 | 
29 |     public function create(Server $server): Ssh
30 |     {
31 |         return new Ssh($this->platform, $server, $this->variables, $this->configFile);
32 |     }
33 | }
34 | 


--------------------------------------------------------------------------------
/src/Automate/VariableResolver.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate;
13 | 
14 | use Automate\Model\Platform;
15 | use Symfony\Component\Console\Style\SymfonyStyle;
16 | 
17 | class VariableResolver
18 | {
19 |     private const string ENV_PREFIX = 'AUTOMATE__';
20 | 
21 |     private const string VAR_PREFIX = '%';
22 | 
23 |     private const string VAR_SUFFIX = '%';
24 | 
25 |     /** @var array<string, string> */
26 |     private array $variables = [];
27 | 
28 |     public function __construct(
29 |         private readonly SymfonyStyle $io,
30 |     ) {
31 |     }
32 | 
33 |     public function process(Platform $platform): void
34 |     {
35 |         foreach ($platform->getServers() as $server) {
36 |             if ($server->getPassword() && $this->isVariable($server->getPassword())) {
37 |                 $password = $this->resolveVariable($server->getPassword());
38 |                 $this->variables[$server->getPassword()] = $password;
39 |                 $server->setPassword($password);
40 |             }
41 |         }
42 |     }
43 | 
44 |     /**
45 |      * @return array<string, string>
46 |      */
47 |     public function getEnvVariables(): array
48 |     {
49 |         $envs = [];
50 |         foreach ($this->variables as $name => $variable) {
51 |             $name = trim($name, '%');
52 |             $envs[self::ENV_PREFIX.$name] = $variable;
53 |         }
54 | 
55 |         return $envs;
56 |     }
57 | 
58 |     /**
59 |      * Return true if value is a variable.
60 |      */
61 |     private function isVariable(string $value): bool
62 |     {
63 |         $first = substr($value, -1);
64 |         $last = substr($value, 0, 1);
65 | 
66 |         return self::VAR_PREFIX === $first && self::VAR_SUFFIX === $last;
67 |     }
68 | 
69 |     /**
70 |      * Resolve a variable.
71 |      */
72 |     private function resolveVariable(string $value): string
73 |     {
74 |         $name = substr($value, 1, strlen($value) - 2);
75 | 
76 |         if ($value = getenv(self::ENV_PREFIX.$name)) {
77 |             return $value;
78 |         }
79 | 
80 |         return $this->io->askHidden(sprintf('Enter a value for password "%s"', $name));
81 |     }
82 | }
83 | 


--------------------------------------------------------------------------------
/src/Automate/Workflow/Context.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the Automate package.
  5 |  *
  6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | namespace Automate\Workflow;
 13 | 
 14 | use Automate\Archiver;
 15 | use Automate\Logger\LoggerInterface;
 16 | use Automate\Model\Platform;
 17 | use Automate\Model\Project;
 18 | use Automate\Ssh\SshFactory;
 19 | use Symfony\Component\Filesystem\Path;
 20 | 
 21 | class Context
 22 | {
 23 |     protected bool $isDeployed = false;
 24 | 
 25 |     /**
 26 |      * @var Session[]
 27 |      */
 28 |     protected array $sessions = [];
 29 | 
 30 |     public function __construct(
 31 |         private readonly Project $project,
 32 |         private readonly Platform $platform,
 33 |         private readonly LoggerInterface $logger,
 34 |         private readonly SshFactory $sshFactory,
 35 |         private readonly Archiver $archiver,
 36 |         private readonly ?string $gitRef = null,
 37 |         private readonly bool $force = false,
 38 |         protected ?string $releaseId = null,
 39 |     ) {
 40 |         if (!$this->releaseId) {
 41 |             $this->generateReleaseId();
 42 |         }
 43 |     }
 44 | 
 45 |     public function connect(): void
 46 |     {
 47 |         foreach ($this->platform->getServers() as $server) {
 48 |             $ssh = $this->sshFactory->create($server);
 49 |             $session = new Session($server, $ssh, $this->getReleaseId());
 50 |             $session->login();
 51 |             $this->sessions[$server->getName()] = $session;
 52 |         }
 53 |     }
 54 | 
 55 |     /**
 56 |      * @param string[] $serversList
 57 |      */
 58 |     public function exec(string|callable $command, ?array $serversList = null, bool $addWorkingDir = true, bool $quiet = false): void
 59 |     {
 60 |         foreach ($this->sessions as $session) {
 61 |             if ($serversList && !in_array($session->getServer()->getName(), $serversList)) {
 62 |                 continue;
 63 |             }
 64 | 
 65 |             if (is_string($command)) {
 66 |                 if (!$quiet) {
 67 |                     $this->logger->command($command);
 68 |                 }
 69 | 
 70 |                 $result = $session->exec($command, $addWorkingDir);
 71 | 
 72 |                 if ($quiet || '' === trim($result)) {
 73 |                     continue;
 74 |                 }
 75 | 
 76 |                 $this->logger->result($result, $session->getServer());
 77 |             } else {
 78 |                 $command($session);
 79 |             }
 80 |         }
 81 |     }
 82 | 
 83 |     /**
 84 |      * @param string[] $serversList
 85 |      */
 86 |     public function execAsync(string $command, ?array $serversList = null, bool $addWorkingDir = true, bool $quiet = false): void
 87 |     {
 88 |         // if only one server: ignore asynchronous process
 89 |         if (($serversList && 1 === count($serversList)) || 1 === count($this->sessions)) {
 90 |             $this->exec($command, $serversList, $addWorkingDir, $quiet);
 91 | 
 92 |             return;
 93 |         }
 94 | 
 95 |         $process = [];
 96 |         if (!$quiet) {
 97 |             $this->logger->command($command);
 98 |         }
 99 | 
100 |         foreach ($this->sessions as $session) {
101 |             if ($serversList && !in_array($session->getServer()->getName(), $serversList)) {
102 |                 continue;
103 |             }
104 | 
105 |             $child = $session->execAsync($command, $addWorkingDir);
106 |             $child->start(function ($type, $output) use ($session, $quiet): void {
107 |                 if ($quiet || '' === trim($output)) {
108 |                     return;
109 |                 }
110 | 
111 |                 $this->logger->result($output, $session->getServer());
112 |             });
113 |             $process[] = $child;
114 |         }
115 | 
116 |         foreach ($process as $child) {
117 |             $child->wait();
118 |             if (!$child->isSuccessful()) {
119 |                 throw new \RuntimeException($child->getErrorOutput());
120 |             }
121 |         }
122 |     }
123 | 
124 |     /**
125 |      * @param ?string[] $exclude
126 |      * @param ?string[] $serversList
127 |      */
128 |     public function upload(string $path, ?array $exclude, ?array $serversList = null): void
129 |     {
130 |         $this->logger->command(sprintf('Upload [local] %s to [remote] %s', $path, $path));
131 | 
132 |         if (!file_exists($path)) {
133 |             throw new \InvalidArgumentException(sprintf('"%s" does not exist', $path));
134 |         }
135 | 
136 |         $this->logger->info('    Upload preparation ...');
137 |         $archive = $this->archiver->archive($path, $exclude);
138 |         $archiveFileName = $this->archiver->getArchiveFileName($path);
139 | 
140 |         $this->logger->info('    Send data ...');
141 |         $this->exec(static function (Session $session) use ($archive, $archiveFileName): void {
142 |             $targetPath = Path::join($session->getReleasePath(), $archiveFileName);
143 |             $session->upload($archive->getPath(), $targetPath);
144 |         }, $serversList);
145 | 
146 |         $this->logger->info('    Untar data...');
147 |         $this->execAsync(sprintf('tar xzvf %s', $archiveFileName), $serversList, quiet: true);
148 |         $this->execAsync(sprintf('rm %s', $archiveFileName), $serversList, quiet: true);
149 |         $this->archiver->clear($path);
150 |     }
151 | 
152 |     public function getProject(): Project
153 |     {
154 |         return $this->project;
155 |     }
156 | 
157 |     public function getPlatform(): Platform
158 |     {
159 |         return $this->platform;
160 |     }
161 | 
162 |     public function getLogger(): LoggerInterface
163 |     {
164 |         return $this->logger;
165 |     }
166 | 
167 |     public function getGitRef(): ?string
168 |     {
169 |         return $this->gitRef;
170 |     }
171 | 
172 |     public function isForce(): bool
173 |     {
174 |         return $this->force;
175 |     }
176 | 
177 |     public function isDeployed(): ?bool
178 |     {
179 |         return $this->isDeployed;
180 |     }
181 | 
182 |     public function setDeployed(bool $isDeployed): static
183 |     {
184 |         $this->isDeployed = $isDeployed;
185 | 
186 |         return $this;
187 |     }
188 | 
189 |     private function generateReleaseId(): void
190 |     {
191 |         $date = new \DateTime();
192 | 
193 |         $this->releaseId = sprintf(
194 |             '%s.%s.%s-%s%s.%s',
195 |             $date->format('Y'),
196 |             $date->format('m'),
197 |             $date->format('d'),
198 |             $date->format('H'),
199 |             $date->format('i'),
200 |             random_int(100, 999)
201 |         );
202 |     }
203 | 
204 |     public function getReleaseId(): string
205 |     {
206 |         return $this->releaseId;
207 |     }
208 | }
209 | 


--------------------------------------------------------------------------------
/src/Automate/Workflow/Deployer.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the Automate package.
  5 |  *
  6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | namespace Automate\Workflow;
 13 | 
 14 | use Automate\DispatcherFactory;
 15 | use Automate\Event\DeployEvent;
 16 | use Automate\Event\DeployEvents;
 17 | use Automate\Event\FailedDeployEvent;
 18 | use Automate\Model\Action;
 19 | use Automate\Model\Command;
 20 | use Automate\Model\Upload;
 21 | use Symfony\Component\Filesystem\Path;
 22 | 
 23 | /**
 24 |  * Deployment workflow.
 25 |  */
 26 | readonly class Deployer
 27 | {
 28 |     public function __construct(private Context $context)
 29 |     {
 30 |     }
 31 | 
 32 |     /**
 33 |      * Deploy project.
 34 |      */
 35 |     public function deploy(): bool
 36 |     {
 37 |         $dispatcher = DispatcherFactory::create();
 38 | 
 39 |         try {
 40 |             $this->context->connect();
 41 | 
 42 |             $dispatcher->dispatch(new DeployEvent($this->context), DeployEvents::INIT);
 43 |             $this->createReleaseDirectory();
 44 | 
 45 |             $dispatcher->dispatch(new DeployEvent($this->context), DeployEvents::BUILD);
 46 | 
 47 |             if ($this->context->getProject()->getRepository()) {
 48 |                 $this->deployWithGit();
 49 |             }
 50 | 
 51 |             $this->runHooks($this->context->getProject()->getPreDeploy(), 'Pre deploy');
 52 |             $this->initShared();
 53 |             $this->runHooks($this->context->getProject()->getOnDeploy(), 'On deploy');
 54 | 
 55 |             $dispatcher->dispatch(new DeployEvent($this->context), DeployEvents::DEPLOY);
 56 |             $this->activateSymlink();
 57 |             $this->context->setDeployed(true);
 58 | 
 59 |             $dispatcher->dispatch(new DeployEvent($this->context), DeployEvents::FINISH);
 60 |             $this->runHooks($this->context->getProject()->getPostDeploy(), 'Post deploy');
 61 | 
 62 |             $dispatcher->dispatch(new DeployEvent($this->context), DeployEvents::TERMINATE);
 63 | 
 64 |             return true;
 65 |         } catch (\Exception $exception) {
 66 |             $this->context->getLogger()->error($exception->getMessage());
 67 |             try {
 68 |                 $dispatcher->dispatch(new FailedDeployEvent($this->context, $exception), DeployEvents::FAILED);
 69 |             } catch (\Exception) {
 70 |                 // ignore exception
 71 |             }
 72 |         }
 73 | 
 74 |         return false;
 75 |     }
 76 | 
 77 |     /**
 78 |      * Prepare release.
 79 |      */
 80 |     private function deployWithGit(): void
 81 |     {
 82 |         $this->context->getLogger()->section('Prepare Release');
 83 | 
 84 |         if ($this->context->getPlatform()->getDefaultBranch()) {
 85 |             $clone = sprintf(
 86 |                 'git clone %s -q --recursive -b %s .',
 87 |                 $this->context->getProject()->getRepository(),
 88 |                 $this->context->getPlatform()->getDefaultBranch()
 89 |             );
 90 |         } else {
 91 |             $clone = sprintf(
 92 |                 'git clone %s -q --recursive .', $this->context->getProject()->getRepository());
 93 |         }
 94 | 
 95 |         $this->context->exec($clone);
 96 | 
 97 |         $gitRef = $this->context->getGitRef();
 98 | 
 99 |         if (null !== $gitRef) {
100 |             $listTagsCommand = sprintf("git tag --list '%s'", $gitRef);
101 | 
102 |             $this->context->exec(function (Session $session) use ($listTagsCommand, $gitRef): void {
103 |                 if ('' !== $session->exec($listTagsCommand)) {
104 |                     // checkout a tag
105 |                     $command = sprintf('git checkout tags/%s', $gitRef);
106 |                 } else {
107 |                     // checkout branch or revision
108 |                     $command = sprintf('git checkout %s', $gitRef);
109 |                 }
110 | 
111 |                 $this->context->getLogger()->command($command);
112 |                 $this->context->exec($command);
113 |             });
114 |         }
115 |     }
116 | 
117 |     /**
118 |      * Run hook.
119 |      *
120 |      * @param Action[] $actions
121 |      */
122 |     private function runHooks(array $actions, string $name): void
123 |     {
124 |         if ([] !== $actions) {
125 |             $this->context->getLogger()->section($name);
126 |             foreach ($actions as $action) {
127 |                 if ($action instanceof Command) {
128 |                     $this->context->execAsync($action->getCmd(), $action->getOnly());
129 |                 }
130 | 
131 |                 if ($action instanceof Upload) {
132 |                     $this->context->upload($action->getPath(), $action->getExclude(), $action->getOnly());
133 |                 }
134 |             }
135 |         }
136 |     }
137 | 
138 |     /**
139 |      * Setting up shared items.
140 |      */
141 |     private function initShared(): void
142 |     {
143 |         $folders = $this->context->getProject()->getSharedFolders();
144 |         $files = $this->context->getProject()->getSharedFiles();
145 | 
146 |         if (count($folders) || count($files)) {
147 |             $this->context->getLogger()->section('Setting up shared items');
148 |             $this->context->exec(function (Session $session) use ($folders, $files): void {
149 |                 foreach ($folders as $folder) {
150 |                     $this->doShared($folder, $session, true);
151 |                 }
152 | 
153 |                 foreach ($files as $file) {
154 |                     $this->doShared($file, $session, false);
155 |                 }
156 |             });
157 |         }
158 |     }
159 | 
160 |     private function doShared(string $path, Session $session, bool $isDirectory): void
161 |     {
162 |         $path = trim($path);
163 |         $path = ltrim($path, '/');
164 | 
165 |         $releasePath = Path::join($session->getReleasePath(), $path);
166 |         $sharedPath = Path::join($session->getSharedPath(), $path);
167 | 
168 |         // For the first deployment : create shared form source
169 |         if (!$session->exists($sharedPath) && $session->exists($releasePath)) {
170 |             $session->mv($releasePath, $sharedPath);
171 |         }
172 | 
173 |         // Remove from source
174 |         if ($session->exists($releasePath)) {
175 |             $session->rm($releasePath, true);
176 |         }
177 | 
178 |         // Create path to shared dir in release dir if it does not exist.
179 |         // (symlink will not create the path and will fail otherwise)
180 |         if (!$session->exists(dirname($releasePath))) {
181 |             $session->mkdir(dirname($releasePath), true);
182 |         }
183 | 
184 |         // ensure shared file or directory exists
185 |         if (!$session->exists($sharedPath)) {
186 |             if ($isDirectory) {
187 |                 $session->mkdir($sharedPath, true);
188 |             } else {
189 |                 $session->touch($sharedPath);
190 |             }
191 |         }
192 | 
193 |         // create symlink
194 |         $session->symlink($sharedPath, $releasePath);
195 |         $this->context->getLogger()->info(sprintf('%s --> %s', $releasePath, $sharedPath), $session->getServer());
196 |     }
197 | 
198 |     /**
199 |      * deploy.
200 |      */
201 |     private function activateSymlink(): void
202 |     {
203 |         $this->context->getLogger()->section('Publish new release');
204 | 
205 |         $this->context->exec(function (Session $session): void {
206 |             $currentPath = $session->getCurrentPath();
207 |             $releasePath = $session->getReleasePath();
208 | 
209 |             $session->symlink($releasePath, $currentPath);
210 |             $this->context->getLogger()->info(sprintf('%s --> %s', $currentPath, $releasePath), $session->getServer());
211 |         });
212 |     }
213 | 
214 |     /**
215 |      * Create release directory.
216 |      */
217 |     private function createReleaseDirectory(): void
218 |     {
219 |         $this->context->exec(static function (Session $session): void {
220 |             $session->mkdir($session->getReleasePath(), true);
221 |         });
222 |     }
223 | }
224 | 


--------------------------------------------------------------------------------
/src/Automate/Workflow/Session.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the Automate package.
  5 |  *
  6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | namespace Automate\Workflow;
 13 | 
 14 | use Automate\Model\Server;
 15 | use Automate\Ssh\Ssh;
 16 | use Symfony\Component\Filesystem\Path;
 17 | use Symfony\Component\Process\Process;
 18 | 
 19 | readonly class Session
 20 | {
 21 |     private const string SHARED_FOLDER = 'shared';
 22 | 
 23 |     private const string CURRENT_FOLDER = 'current';
 24 | 
 25 |     private const string RELEASES_FOLDER = 'releases';
 26 | 
 27 |     public function __construct(
 28 |         private Server $server,
 29 |         private Ssh $ssh,
 30 |         private string $releaseId,
 31 |     ) {
 32 |     }
 33 | 
 34 |     public function login(): void
 35 |     {
 36 |         $this->ssh->login();
 37 |     }
 38 | 
 39 |     public function exec(string $command, bool $addWorkingDir = true): string
 40 |     {
 41 |         $command = $addWorkingDir ? sprintf('cd %s; %s', $this->getReleasePath(), $command) : $command;
 42 | 
 43 |         return $this->ssh->exec($command);
 44 |     }
 45 | 
 46 |     public function execAsync(string $command, bool $addWorkingDir = true): Process
 47 |     {
 48 |         $command = $addWorkingDir ? sprintf('cd %s; %s', $this->getReleasePath(), $command) : $command;
 49 | 
 50 |         return $this->ssh->execAsync($command);
 51 |     }
 52 | 
 53 |     public function upload(string $path, string $target): void
 54 |     {
 55 |         $this->ssh->upload($path, $target);
 56 |     }
 57 | 
 58 |     public function mkdir(string $path, bool $recursive = false): void
 59 |     {
 60 |         $command = sprintf('mkdir%s %s', $recursive ? ' -p' : '', $path);
 61 | 
 62 |         $this->exec($command, false);
 63 |     }
 64 | 
 65 |     public function mv(string $from, string $to): void
 66 |     {
 67 |         if (!$this->exists(dirname($to))) {
 68 |             $this->mkdir(dirname($to), true);
 69 |         }
 70 | 
 71 |         $this->exec(sprintf('mv %s %s', $from, $to), false);
 72 |     }
 73 | 
 74 |     public function rm(string $path, bool $recursive = false): void
 75 |     {
 76 |         $this->exec(sprintf('rm%s %s', $recursive ? ' -R' : '', $path), false);
 77 |     }
 78 | 
 79 |     public function exists(string $path): bool
 80 |     {
 81 |         if ('Y' === trim($this->exec(sprintf('if test -d "%s"; then echo "Y";fi', $path), false))) {
 82 |             return true;
 83 |         }
 84 | 
 85 |         return 'Y' === trim($this->exec(sprintf('if test -f "%s"; then echo "Y";fi', $path), false));
 86 |     }
 87 | 
 88 |     public function symlink(string $target, string $link): void
 89 |     {
 90 |         $this->exec(sprintf('ln -sfn %s %s', $target, $link), false);
 91 |     }
 92 | 
 93 |     public function touch(string $path): void
 94 |     {
 95 |         $this->mkdir(dirname($path), true);
 96 |         $this->exec(sprintf('touch %s', $path), false);
 97 |     }
 98 | 
 99 |     /**
100 |      * @return string[]
101 |      */
102 |     public function listDirectory(string $path): array
103 |     {
104 |         $rs = $this->exec(sprintf('find %s -maxdepth 1 -mindepth 1 -type d', $path), false);
105 | 
106 |         return explode("\n", trim($rs));
107 |     }
108 | 
109 |     public function getServer(): Server
110 |     {
111 |         return $this->server;
112 |     }
113 | 
114 |     public function getReleasePath(): string
115 |     {
116 |         return Path::join($this->getReleasesPath(), $this->releaseId);
117 |     }
118 | 
119 |     public function getReleasesPath(): string
120 |     {
121 |         return Path::join($this->server->getPath(), self::RELEASES_FOLDER);
122 |     }
123 | 
124 |     public function getSharedPath(): string
125 |     {
126 |         $serverSharedPath = $this->server->getSharedPath();
127 | 
128 |         // if the shared path is not configured on the server configuration
129 |         if (null === $serverSharedPath) {
130 |             $serverSharedPath = Path::join($this->server->getPath(), self::SHARED_FOLDER);
131 |         }
132 | 
133 |         return $serverSharedPath;
134 |     }
135 | 
136 |     public function getCurrentPath(): string
137 |     {
138 |         return Path::join($this->server->getPath(), self::CURRENT_FOLDER);
139 |     }
140 | }
141 | 


--------------------------------------------------------------------------------
/tests/Automate/AbstractMockTestCase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Automate\Tests;
 4 | 
 5 | use PHPUnit\Framework\TestCase;
 6 | 
 7 | class AbstractMockTestCase extends TestCase
 8 | {
 9 |     protected function tearDown(): void
10 |     {
11 |         if ($container = \Mockery::getContainer()) {
12 |             $this->addToAssertionCount($container->mockery_getExpectationCount());
13 |         }
14 | 
15 |         \Mockery::close();
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/tests/Automate/ApplicationTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Tests;
13 | 
14 | use Automate\Application;
15 | use PHPUnit\Framework\TestCase;
16 | use Symfony\Component\Console\Input\ArrayInput;
17 | use Symfony\Component\Console\Output\StreamOutput;
18 | 
19 | class ApplicationTest extends TestCase
20 | {
21 |     public function testApp(): void
22 |     {
23 |         $app = new Application();
24 |         $app->setAutoExit(false);
25 | 
26 |         $input = new ArrayInput(['--version']);
27 |         $stream = fopen('php://memory', 'w', false);
28 |         $output = new StreamOutput($stream);
29 |         $app->run($input, $output);
30 |         rewind($stream);
31 |         $string = trim(fgets($stream));
32 |         $string = preg_replace(
33 |             ['/\x1b(\[|\(|\))[;?0-9]*[0-9A-Za-z]/', '/\x1b(\[|\(|\))[;?0-9]*[0-9A-Za-z]/', '/[\x03|\x1a]/'],
34 |             ['', '', ''],
35 |             $string
36 |         );
37 |         $this->assertEquals('Automate @dev', $string);
38 | 
39 |         $app->setVersion('1.2.3');
40 |         rewind($stream);
41 |         $app->run($input, $output);
42 |         rewind($stream);
43 |         $string = trim(fgets($stream));
44 |         $string = preg_replace(
45 |             ['/\x1b(\[|\(|\))[;?0-9]*[0-9A-Za-z]/', '/\x1b(\[|\(|\))[;?0-9]*[0-9A-Za-z]/', '/[\x03|\x1a]/'],
46 |             ['', '', ''],
47 |             $string
48 |         );
49 |         $this->assertEquals(
50 |             'Automate version 1.2.3 build @git-commit@',
51 |             $string
52 |         );
53 |     }
54 | }
55 | 


--------------------------------------------------------------------------------
/tests/Automate/ArchiverTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate;
13 | 
14 | use PHPUnit\Framework\TestCase;
15 | 
16 | class ArchiverTest extends TestCase
17 | {
18 |     private const string PATH = __DIR__.'/../fixtures/folder';
19 | 
20 |     private Archiver $archiver;
21 | 
22 |     protected function setUp(): void
23 |     {
24 |         $this->archiver = new Archiver();
25 |     }
26 | 
27 |     protected function tearDown(): void
28 |     {
29 |         $this->archiver->clear(self::PATH);
30 |     }
31 | 
32 |     public function testArchive(): void
33 |     {
34 |         $phar = $this->archiver->archive(self::PATH);
35 | 
36 |         $this->assertTrue($phar->offsetExists('tests/fixtures/folder/a.txt'));
37 |         $this->assertTrue($phar->offsetExists('tests/fixtures/folder/sub/b.txt'));
38 |         $this->assertTrue($phar->offsetExists('tests/fixtures/folder/.sub/c.txt'));
39 |         $this->assertTrue($phar->offsetExists('tests/fixtures/folder/.d.txt'));
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/tests/Automate/LoaderTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the Automate package.
  5 |  *
  6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | namespace Automate\Tests;
 13 | 
 14 | use Automate\Loader;
 15 | use Automate\Model\Action;
 16 | use Automate\Model\Command;
 17 | use Automate\Model\Project;
 18 | use Automate\Model\Server;
 19 | use Automate\Model\Upload;
 20 | use PHPUnit\Framework\TestCase;
 21 | 
 22 | class LoaderTest extends TestCase
 23 | {
 24 |     public function testLoader(): void
 25 |     {
 26 |         $loader = new Loader();
 27 | 
 28 |         $project = $loader->load(__DIR__.'/../fixtures/config.yml');
 29 | 
 30 |         $this->assertInstanceOf(Project::class, $project);
 31 |         $this->assertEquals('git@github.com:julienj/symfony-demo.git', $project->getRepository());
 32 |         $this->assertEquals(['app/data'], $project->getSharedFolders());
 33 |         $this->assertEquals(['app/config/parameters.yml'], $project->getSharedFiles());
 34 | 
 35 |         $this->assertcount(1, $project->getPreDeploy());
 36 |         $preDeploy = current($project->getPreDeploy());
 37 |         $this->assertInstanceOf(Command::class, $preDeploy);
 38 |         $this->assertEquals('php -v', $preDeploy->getCmd());
 39 | 
 40 |         foreach ($project->getOnDeploy() as $onDeploy) {
 41 |             $this->assertInstanceOf(Command::class, $onDeploy);
 42 |         }
 43 | 
 44 |         $this->assertEquals('composer install', $project->getOnDeploy()[0]->getCmd());
 45 |         $this->assertEquals('setfacl -R -m u:www-data:rwX -m u:`whoami`:rwX var', $project->getOnDeploy()[1]->getCmd());
 46 |         $this->assertEquals('setfacl -dR -m u:www-data:rwX -m u:`whoami`:rwX var', $project->getOnDeploy()[2]->getCmd());
 47 | 
 48 |         foreach ($project->getPostDeploy() as $postDeploy) {
 49 |             $this->assertInstanceOf(Action::class, $postDeploy);
 50 |         }
 51 | 
 52 |         $this->assertInstanceOf(Command::class, $project->getPostDeploy()[0]);
 53 |         $this->assertEquals('php bin/console doctrine:cache:clear-metadata', $project->getPostDeploy()[0]->getCmd());
 54 |         $this->assertEquals([], $project->getPostDeploy()[0]->getOnly());
 55 | 
 56 |         $this->assertInstanceOf(Command::class, $project->getPostDeploy()[1]);
 57 |         $this->assertEquals('php bin/console doctrine:schema:update --force', $project->getPostDeploy()[1]->getCmd());
 58 |         $this->assertEquals(['eddv-exemple-front-01'], $project->getPostDeploy()[1]->getOnly());
 59 | 
 60 |         $this->assertInstanceOf(Command::class, $project->getPostDeploy()[2]);
 61 |         $this->assertEquals('php bin/console doctrine:cache:clear-result', $project->getPostDeploy()[2]->getCmd());
 62 |         $this->assertEquals([], $project->getPostDeploy()[2]->getOnly());
 63 | 
 64 |         $this->assertInstanceOf(Command::class, $project->getPostDeploy()[3]);
 65 |         $this->assertEquals('php bin/console messenger:consume', $project->getPostDeploy()[3]->getCmd());
 66 |         $this->assertEquals(['eddv-exemple-front-01', 'dddv-exemple-front-01'], $project->getPostDeploy()[3]->getOnly());
 67 | 
 68 |         $this->assertInstanceOf(Upload::class, $project->getPostDeploy()[4]);
 69 |         $this->assertEquals('public/build', $project->getPostDeploy()[4]->getPath());
 70 |         $this->assertEquals(['vendor'], $project->getPostDeploy()[4]->getExclude());
 71 | 
 72 |         $this->assertCount(2, $project->getPlatforms());
 73 | 
 74 |         $platform = $project->getPlatform('development');
 75 |         $this->assertEquals('development', $platform->getName());
 76 |         $this->assertEquals('master', $platform->getDefaultBranch());
 77 |         $this->assertEquals(3, $platform->getMaxReleases());
 78 |         $this->assertCount(1, $platform->getServers());
 79 | 
 80 |         /** @var Server $server */
 81 |         $server = current($platform->getServers());
 82 | 
 83 |         $this->assertEquals('dddv-exemple-front-01', $server->getName());
 84 |         $this->assertEquals('192.168.1.18', $server->getHost());
 85 |         $this->assertEquals('root', $server->getUser());
 86 |         $this->assertEquals('%dev_password%', $server->getPassword());
 87 |         $this->assertEquals('/home/wwwroot/automate/demo', $server->getPath());
 88 |     }
 89 | 
 90 |     public function testSharedPathLoader(): void
 91 |     {
 92 |         $loader = new Loader();
 93 | 
 94 |         $project = $loader->load(__DIR__.'/../fixtures/simpleWithSharedPath.yml');
 95 | 
 96 |         $platform = $project->getPlatform('development');
 97 | 
 98 |         /** @var Server $server */
 99 |         $server = current($platform->getServers());
100 | 
101 |         $this->assertEquals('/home/wwwroot/shared', $server->getSharedPath());
102 |     }
103 | }
104 | 


--------------------------------------------------------------------------------
/tests/Automate/VariableResolverTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the Automate package.
 5 |  *
 6 |  * (c) Julien Jacottet <jjacottet@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | namespace Automate\Tests;
13 | 
14 | use Automate\Model\Platform;
15 | use Automate\Model\Server;
16 | use Automate\VariableResolver;
17 | use Symfony\Component\Console\Style\SymfonyStyle;
18 | 
19 | class VariableResolverTest extends AbstractMockTestCase
20 | {
21 |     public function testAskPassword(): void
22 |     {
23 |         $io = \Mockery::spy(SymfonyStyle::class);
24 |         $io->expects('askHidden')->with('Enter a value for password "server_password"')->andReturns('mypassword');
25 | 
26 |         $resolver = new VariableResolver($io);
27 |         $platform = new Platform();
28 |         $server = new Server();
29 | 
30 |         $server->setPassword('%server_password%');
31 | 
32 |         $platform->addServer($server);
33 | 
34 |         $resolver->process($platform);
35 | 
36 |         $this->assertEquals('mypassword', $server->getPassword());
37 |     }
38 | 
39 |     public function testSessionPassword(): void
40 |     {
41 |         $io = \Mockery::spy(SymfonyStyle::class);
42 | 
43 |         $resolver = new VariableResolver($io);
44 |         $platform = new Platform();
45 |         $server = new Server();
46 | 
47 |         $server->setPassword('%server_password%');
48 | 
49 |         $platform->addServer($server);
50 | 
51 |         putenv('AUTOMATE__server_password=sessionPassword');
52 |         $resolver->process($platform);
53 | 
54 |         $this->assertEquals('sessionPassword', $server->getPassword());
55 |     }
56 | }
57 | 


--------------------------------------------------------------------------------
/tests/Automate/Workflow/DeployerTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Automate\Tests\Workflow;
 4 | 
 5 | use Automate\Archiver;
 6 | use Automate\Loader;
 7 | use Automate\Logger\LoggerInterface;
 8 | use Automate\Ssh\Ssh;
 9 | use Automate\Ssh\SshFactory;
10 | use Automate\Tests\AbstractMockTestCase;
11 | use Automate\Workflow\Context;
12 | use Automate\Workflow\Deployer;
13 | 
14 | class DeployerTest extends AbstractMockTestCase
15 | {
16 |     public function testDeploy(): void
17 |     {
18 |         $loader = new Loader();
19 |         $project = $loader->load(__DIR__.'/../../fixtures/simple.yml');
20 |         $platform = $project->getPlatform('development');
21 |         $logger = \Mockery::spy(LoggerInterface::class);
22 | 
23 |         $ssh = \Mockery::spy(Ssh::class);
24 |         $sshFactory = \Mockery::spy(SshFactory::class);
25 |         $sshFactory->shouldReceive('create')->andReturns($ssh);
26 | 
27 |         $archiver = \Mockery::mock(Archiver::class);
28 | 
29 |         $context = new Context($project, $platform, $logger, $sshFactory, $archiver, releaseId: '2024.03.10-2340.241');
30 |         $deployer = new Deployer($context);
31 | 
32 |         // create project folder
33 |         $ssh->expects('exec')->with('mkdir -p /home/wwwroot/automate/demo')->once();
34 | 
35 |         // add lock file
36 |         $ssh->expects('exec')->with('touch /home/wwwroot/automate/demo/automate.lock')->once();
37 | 
38 |         // create releases folder
39 |         $ssh->expects('exec')->with('mkdir -p /home/wwwroot/automate/demo/releases/2024.03.10-2340.241')->once();
40 | 
41 |         // gi clone
42 |         $ssh->expects('exec')->with('cd /home/wwwroot/automate/demo/releases/2024.03.10-2340.241; git clone git@github.com:julienj/symfony-demo.git -q --recursive -b master .')->once();
43 | 
44 |         // hook pre_deploy
45 |         $ssh->expects('exec')->with('cd /home/wwwroot/automate/demo/releases/2024.03.10-2340.241; php -v')->once();
46 | 
47 |         $ssh->expects('exec')->with('ln -sfn /home/wwwroot/automate/demo/shared/app/data /home/wwwroot/automate/demo/releases/2024.03.10-2340.241/app/data')->once();
48 |         $ssh->expects('exec')->with('ln -sfn /home/wwwroot/automate/demo/shared/app/config/parameters.yml /home/wwwroot/automate/demo/releases/2024.03.10-2340.241/app/config/parameters.yml')->once();
49 | 
50 |         // deploy
51 |         $ssh->expects('exec')->with('ln -sfn /home/wwwroot/automate/demo/releases/2024.03.10-2340.241 /home/wwwroot/automate/demo/current')->once();
52 | 
53 |         // remove lock file
54 |         $ssh->expects('exec')->with('rm /home/wwwroot/automate/demo/automate.lock')->once();
55 | 
56 |         // search old releases
57 |         $ssh->expects('exec')->with('find /home/wwwroot/automate/demo/releases -maxdepth 1 -mindepth 1 -type d')->once();
58 | 
59 |         $deployer->deploy();
60 |     }
61 | }
62 | 


--------------------------------------------------------------------------------
/tests/Automate/Workflow/SessionTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Automate\Tests\Workflow;
  4 | 
  5 | use Automate\Model\Server;
  6 | use Automate\Ssh\Ssh;
  7 | use Automate\Tests\AbstractMockTestCase;
  8 | use Automate\Workflow\Session;
  9 | 
 10 | class SessionTest extends AbstractMockTestCase
 11 | {
 12 |     public function testSessionPath(): void
 13 |     {
 14 |         $ssh = \Mockery::spy(Ssh::class);
 15 |         $session = $this->getSession($ssh);
 16 | 
 17 |         $this->assertEquals('/var/www/current', $session->getCurrentPath());
 18 |         $this->assertEquals('/var/www/shared', $session->getSharedPath());
 19 |         $this->assertEquals('/var/www/releases', $session->getReleasesPath());
 20 |         $this->assertEquals('/var/www/releases/2024.03.10-2340.241', $session->getReleasePath());
 21 |     }
 22 | 
 23 |     public function testExecCommand(): void
 24 |     {
 25 |         $ssh = \Mockery::spy(Ssh::class);
 26 |         $ssh->expects('exec')->with('ls');
 27 | 
 28 |         $session = $this->getSession($ssh);
 29 | 
 30 |         $session->exec('ls', false);
 31 |     }
 32 | 
 33 |     public function testExecCommandWithWorkingDir(): void
 34 |     {
 35 |         $ssh = \Mockery::spy(Ssh::class);
 36 |         $ssh->expects('exec')->with('cd /var/www/releases/2024.03.10-2340.241; ls');
 37 | 
 38 |         $session = $this->getSession($ssh);
 39 | 
 40 |         $session->exec('ls');
 41 |     }
 42 | 
 43 |     public function testMkdir(): void
 44 |     {
 45 |         $ssh = \Mockery::spy(Ssh::class);
 46 |         $ssh->expects('exec')->with('mkdir /path/to/folder')->once();
 47 |         $ssh->expects('exec')->with('mkdir -p /path/to/folder')->once();
 48 |         $ssh->shouldReceive()->getExitStatus()->andReturns(0);
 49 | 
 50 |         $session = $this->getSession($ssh);
 51 | 
 52 |         $session->mkdir('/path/to/folder');
 53 |         $session->mkdir('/path/to/folder', true);
 54 |     }
 55 | 
 56 |     public function testMv(): void
 57 |     {
 58 |         $ssh = \Mockery::spy(Ssh::class);
 59 |         $ssh->expects('exec')->with('mv /home/a.txt /home/b.txt')->once();
 60 |         $ssh->shouldReceive()->getExitStatus()->andReturns(0);
 61 | 
 62 |         $session = $this->getSession($ssh);
 63 | 
 64 |         $session->mv('/home/a.txt', '/home/b.txt');
 65 |     }
 66 | 
 67 |     public function testMvWithMkdir(): void
 68 |     {
 69 |         $ssh = \Mockery::spy(Ssh::class);
 70 |         $ssh->expects('exec')->with('mkdir -p /data');
 71 |         $ssh->expects('exec')->with('mv /home/a /data/usr')->once();
 72 |         $ssh->shouldReceive()->getExitStatus()->andReturns(0);
 73 | 
 74 |         $session = $this->getSession($ssh);
 75 | 
 76 |         $session->mv('/home/a', '/data/usr');
 77 |     }
 78 | 
 79 |     public function testRm(): void
 80 |     {
 81 |         $ssh = \Mockery::spy(Ssh::class);
 82 |         $ssh->expects('exec')->with('rm /home/a.txt')->once();
 83 |         $ssh->shouldReceive()->getExitStatus()->andReturns(0);
 84 | 
 85 |         $session = $this->getSession($ssh);
 86 | 
 87 |         $session->rm('/home/a.txt');
 88 |     }
 89 | 
 90 |     public function testFolderExists(): void
 91 |     {
 92 |         $ssh = \Mockery::spy(Ssh::class);
 93 |         $ssh->expects('exec')->with('if test -d "/home/test"; then echo "Y";fi')->once()->andReturns('Y');
 94 |         $ssh->shouldReceive()->getExitStatus()->andReturns(0);
 95 | 
 96 |         $session = $this->getSession($ssh);
 97 | 
 98 |         $this->assertTrue($session->exists('/home/test'));
 99 |     }
100 | 
101 |     public function testFileExists(): void
102 |     {
103 |         $ssh = \Mockery::spy(Ssh::class);
104 |         $ssh->expects('exec')->with('if test -d "/home/test.txt"; then echo "Y";fi')->once()->andReturns('');
105 |         $ssh->expects('exec')->with('if test -f "/home/test.txt"; then echo "Y";fi')->once()->andReturns('Y');
106 |         $ssh->shouldReceive()->getExitStatus()->andReturns(0);
107 | 
108 |         $session = $this->getSession($ssh);
109 | 
110 |         $this->assertTrue($session->exists('/home/test.txt'));
111 |     }
112 | 
113 |     public function testSymlink(): void
114 |     {
115 |         $ssh = \Mockery::spy(Ssh::class);
116 |         $ssh->expects('exec')->with('ln -sfn /data/a.txt /data/b.txt')->once();
117 |         $ssh->shouldReceive()->getExitStatus()->andReturns(0);
118 | 
119 |         $session = $this->getSession($ssh);
120 | 
121 |         $session->symlink('/data/a.txt', '/data/b.txt');
122 |     }
123 | 
124 |     public function testTouch(): void
125 |     {
126 |         $ssh = \Mockery::spy(Ssh::class);
127 |         $ssh->expects('exec')->with('mkdir -p /data')->once();
128 |         $ssh->expects('exec')->with('touch /data/a.txt')->once();
129 |         $ssh->shouldReceive()->getExitStatus()->andReturns(0);
130 | 
131 |         $session = $this->getSession($ssh);
132 | 
133 |         $session->touch('/data/a.txt');
134 |     }
135 | 
136 |     public function testListDirectory(): void
137 |     {
138 |         $ssh = \Mockery::spy(Ssh::class);
139 |         $ssh->expects('exec')->with('find /data -maxdepth 1 -mindepth 1 -type d')->once();
140 |         $ssh->shouldReceive()->getExitStatus()->andReturns(0);
141 | 
142 |         $session = $this->getSession($ssh);
143 | 
144 |         $session->listDirectory('/data');
145 |     }
146 | 
147 |     private function getSession(Ssh $ssh): Session
148 |     {
149 |         $server = new Server(name : 'server1', path: '/var/www');
150 | 
151 |         return new Session($server, $ssh, '2024.03.10-2340.241');
152 |     }
153 | }
154 | 


--------------------------------------------------------------------------------
/tests/bootstrap.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | $loader = require_once __DIR__.'/../vendor/autoload.php';
4 | 


--------------------------------------------------------------------------------
/tests/fixtures/config.yml:
--------------------------------------------------------------------------------
 1 | repository: git@github.com:julienj/symfony-demo.git
 2 | 
 3 | platforms:
 4 |     development:
 5 |         default_branch: master
 6 |         max_releases: 3
 7 |         servers:
 8 |             dddv-exemple-front-01:
 9 |                 host: 192.168.1.18
10 |                 user: root
11 |                 password: "%dev_password%"
12 |                 path: /home/wwwroot/automate/demo
13 |     production:
14 |         default_branch: production
15 |         servers:
16 |             eddv-exemple-front-01:
17 |                 host: 12.9.9.1
18 |                 user: user
19 |                 password: "%prod_password%"
20 |                 path: /home/wwwroot/exemple
21 |             eddv-exemple-front-02:
22 |                 host: 12.9.9.2
23 |                 user: user
24 |                 password: "%prod_password%"
25 |                 path: /home/wwwroot/exemple
26 | 
27 | shared_files:
28 |     - app/config/parameters.yml
29 | 
30 | shared_folders:
31 |     - app/data
32 | 
33 | pre_deploy:
34 |     - "php -v"
35 | 
36 | on_deploy:
37 |     - "composer install"
38 |     - "setfacl -R -m u:www-data:rwX -m u:`whoami`:rwX var"
39 |     - "setfacl -dR -m u:www-data:rwX -m u:`whoami`:rwX var"
40 | 
41 | post_deploy:
42 |     - "php bin/console doctrine:cache:clear-metadata"
43 |     - cmd: "php bin/console doctrine:schema:update --force"
44 |       only: eddv-exemple-front-01
45 |     - "php bin/console doctrine:cache:clear-result"
46 |     - cmd: "php bin/console messenger:consume"
47 |       only: ["eddv-exemple-front-01", "dddv-exemple-front-01"]
48 |     - upload: "public/build"
49 |       exclude:
50 |           - vendor
51 | 


--------------------------------------------------------------------------------
/tests/fixtures/folder/.d.txt:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/tests/fixtures/folder/.d.txt


--------------------------------------------------------------------------------
/tests/fixtures/folder/.sub/c.txt:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/tests/fixtures/folder/.sub/c.txt


--------------------------------------------------------------------------------
/tests/fixtures/folder/a.txt:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/tests/fixtures/folder/a.txt


--------------------------------------------------------------------------------
/tests/fixtures/folder/sub/b.txt:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/automatephp/automate/69d116ee97d057b786d83f22bce19cdbcfc58fb7/tests/fixtures/folder/sub/b.txt


--------------------------------------------------------------------------------
/tests/fixtures/simple.yml:
--------------------------------------------------------------------------------
 1 | repository: git@github.com:julienj/symfony-demo.git
 2 | 
 3 | platforms:
 4 |     development:
 5 |         default_branch: master
 6 |         max_releases: 3
 7 |         servers:
 8 |             dddv-exemple-front-01:
 9 |                 host: 127.0.0.1
10 |                 user: automate
11 |                 password: p@ssw0rd
12 |                 path: /home/wwwroot/automate/demo
13 | shared_files:
14 |     - app/config/parameters.yml
15 | shared_folders:
16 |     - app/data
17 | pre_deploy:
18 |     - "php -v"
19 | on_deploy:
20 |     - "composer install"
21 | 


--------------------------------------------------------------------------------
/tests/fixtures/simpleWithSharedPath.yml:
--------------------------------------------------------------------------------
 1 | repository: git@github.com:julienj/symfony-demo.git
 2 | 
 3 | platforms:
 4 |     development:
 5 |         default_branch: master
 6 |         max_releases: 3
 7 |         servers:
 8 |             dddv-exemple-front-01:
 9 |                 host: 127.0.0.1
10 |                 user: automate
11 |                 password: p@ssw0rd
12 |                 path: /home/wwwroot/automate/demo
13 |                 shared_path: /home/wwwroot/shared
14 | shared_files:
15 |     - app/config/parameters.yml
16 | shared_folders:
17 |     - app/data
18 | pre_deploy:
19 |     - "php -v"
20 | on_deploy:
21 |     - "composer install"
22 | 


--------------------------------------------------------------------------------