Как правильно развернуть веб-приложения через SFTP с помощью Git

 $contents = file_get_content('path/to/local/file');
$sftp->put('index.php', $contents);

В процессе развертывания нам нужно добавить еще один шаг удаления файлов и каталогов, которые больше не требуются приложению. Вы можете легко удалить один файл или рекурсивно удалить все файлы и каталоги из определенного каталога.

 //Deleting a single file. This does not delete directories.
$sftp->delete('index.php');

//Deleting directories and files recursively
$sftp->delete('dir_name', true);

Автоматизация развертывания с помощью Git

Git широко признан в качестве отраслевого стандарта инструментов управления версиями. Используя возможности Git, мы можем сэкономить некоторое время и пропускную способность, загружая только те файлы, которые изменились с момента последней загрузки. Используя SFTP API PHPSECLIB , мы попытаемся развернуть наши файлы на нашем SFTP-сервере.

Я разделил весь процесс развертывания на несколько шагов ниже, чтобы лучше объяснить каждый из них. Как только мы пройдем все этапы, мы соберем все вместе.

Некоторые основы Git

Во-первых, нам нужно понять некоторые конкретные команды Git, которые помогут нам в процессе развертывания. Мы создадим класс, который поможет нам выполнять задачи, связанные с Git. Команды Git выполняются из командной строки — для этого мы будем использовать компонент Process . Компонент обеспечивает уровень абстракции для выполнения команд оболочки и заботится о тонких различиях между различными платформами. Вы можете обратиться к его документации для получения дополнительной информации. Сейчас мы напишем код, специфичный для извлечения файлов, добавленных, измененных или удаленных между двумя заданными коммитами.

 <?php

namespace App;

use Symfony\Component\Process\Process;
use Symfony\Component\Process\Exception\ProcessFailedException;

class Git 
{
    public function diffFiles($start_commit, $end_commit)
        {
        //Get new and modified files
        $process = new Process("git diff --name-only --diff-filter=AM $start_commit $end_commit");

        $process->setTimeout(3600);
        $process->setWorkingDirectory('/path/to/local/repository');
        $process->run();

        if (!$process->isSuccessful()) {
            throw new ProcessFailedException($process);
        }

    //Extract all file paths from the process output
        $files["added"] = array_unique(
        array_merge($files["added"], 
        array_filter(explode("\n", $process->getOutput()), 'strlen'))
    );

    //Get deleted files
        $process = new Process("git diff-tree --diff-filter=D --name-only -t $start_commit $end_commit");

        $process->setTimeout(3600);
        $process->setWorkingDirectory('/path/to/local/repository');
        $process->run();

        if (!$process->isSuccessful()) {
            throw new ProcessFailedException($process);
        }

        $files["deleted"] = array_filter(explode("\n", $process->getOutput()), 'strlen');

        return $files;
    }
}

Получить содержимое файла при определенной фиксации

Git хранит исторические данные о данном хранилище в скрытой папке .git Чтобы продолжить процесс развертывания, нам нужно извлечь содержимое файлов, записанных Git, в указанный коммит. Мы добавим еще один метод в класс Git

 public function getContent($commit, $file)
{
    //Get contents of a file at a specific commit
    $process = new Process("git show \"$commit:$file\"");

    $process->setTimeout(3600);
    $process->setWorkingDirectory('path/to/repository');
    $process->run();

    if (!$process->isSuccessful()) {
        throw new ProcessFailedException($process);
    }

    return $process->getOutput();
}

Развертывание файлов

Далее нам нужно написать кусок кода, который позаботится о выполнении процесса развертывания. Давайте сначала перечислим важные шаги, которые нам необходимо предпринять:

1. Получать добавленные, измененные и удаленные файлы между двумя коммитами
2. Передача новых и измененных файлов на сервер SFTP
3. Удалить файлы, которые были удалены между двумя коммитами

Теперь, когда мы понимаем, чего нам нужно достичь, давайте вложим это в код:

 $files = $git->diffFiles($start_commit, $end_commit);

if(count($files['added']) > 0) {
    foreach($files['added'] as $file) {
        $content = $git->getContent($end_commit, $file);

        //Ensure a directory exists - if it doesn't create it recursively.
        if (!$sftp->file_exists(dirname($file))) {
            $sftp->mkdir(dirname($path), -1, true);
        }

        $sftp->put('/path/to/remote/file', $content);
    }
}

if(count($files['deleted']) > 0) {
    foreach($files['deleted'] as $file) {

        if ($sftp->file_exists($file)) {
            $sftp->delete($file, true);
        }

    }
}

Приведенный выше код перенесет все обновленные файлы и удалит файлы, удаленные между двумя указанными коммитами. Это также заботится об автоматическом создании каталога. Если каталоги отсутствуют, приведенный выше код гарантирует, что эти каталоги будут созданы в процессе.

Выполнение удаленных команд

Вы можете выполнять любые команды оболочки на удаленном сервере до или после завершения развертывания методом exec

 $sftp->exec("your-remote-command-here");

Как и в случае с SSH , вызов метода execexec Чтобы выполнить несколько команд без потери состояния:

 $sftp->exec(
    "php artisan up" . PHP_EOL
    "composer dump-autoload -o" . PHP_EOL
    "php artisan optimize"
);

Класс phpseclib\Net\SFTPphpseclib\Net\SSH Вы можете использовать полный API-интерфейс класса SSH Для всесторонней реализации SSHпредыдущий учебник .

Управление разрешениями

Разрешения — это базовая система защиты файла. Нам нужно назначить некоторые определенные права пользователям или группам пользователей для файлов на сервере, чтобы предотвратить потенциальные атаки.

Установка разрешений для одного файла возвращает разрешения для нового файла в случае успеха или false в случае ошибки:

 $sftp->chmod(0777, 'path/to/remote/file');

Кроме того, вы можете рекурсивно установить разрешения для всех файлов в каталоге:

 $sftp->chmod(0777, 'path/to/remote/file', true);

Ниже приведена сводка наиболее важных методов, касающихся прав доступа к файлам в классе SFTP

Скачивание файлов

Используя PHPSECLIB , мы также можем загружать с сервера такие вещи, как файлы резервных копий или пользовательский носитель:

 //Gets the remote file's contents
$content = $sftp->get('path/to/remote/file');

//Downloads and saves to the local file
$sftp->get('path/to/remote/file', 'path/to/local/file');

Если файл отсутствует локально, он будет создан автоматически для вас.

альтернативы

1. git-deploy-php — простой инструмент на основе PHP, который развертывает ваши измененные файлы на ваших серверах SFTP. Он автоматически передаст вам файлы для указанных коммитов.
2. PHPloy — еще один инструмент развертывания на основе PHP для передачи файлов на SFTP-серверы. Он имеет больше функций, таких как откат, поддержка нескольких серверов и субмодулей и многое другое. Недостатком является слишком большая вовлеченность в ручную настройку для запуска развертывания.
3. Deploy-Tantra — автоматически развертывает ваши репозитории на SFTP-серверах, когда вы отправляете в указанную ветку. Преимущество — более управляемый рабочий процесс. Недостатком является коммерческий.

Вывод

В этой статье мы представили конкретный способ, помогающий автоматизировать процесс развертывания SFTP-серверов, и рассмотрели параметры конфигурации, необходимые для начала работы.

Как вы развертываете на своих серверах SFTP? Можете ли вы придумать некоторые продвинутые способы развертывания? Кто они такие? Дайте нам знать об этом в комментариях!