dkdeploy-php 7.0.0

data/lib/dkdeploy/php/tasks/composer.rake

@@ -0,0 +1,50 @@
+require 'dkdeploy/helpers/common'
+require 'capistrano/i18n'
+require 'dkdeploy/php/i18n'
+
+include Dkdeploy::Helpers::Common
+
+namespace :composer do
+  namespace :local do
+    desc 'Check the status of the composer.json file'
+    task :check_status do
+      default_arguments = fetch(:composer_default_arguments)
+      install_arguments = fetch(:composer_install_arguments)
+
+      run_locally do
+        # Try dry install --dry-run
+        output = capture :composer, :install, '--dry-run', *install_arguments, *default_arguments, '2>&1', verbosity: SSHKit::Logger::INFO
+        unless output.include? 'Nothing to install or update'
+          command = SSHKit::Command.new :composer, :install, *install_arguments, *default_arguments
+          error I18n.t('tasks.composer.local.check_status.run_install', command: command.to_s, scope: :dkdeploy)
+          exit 1
+        end
+      end
+
+      begin
+        # run composer status
+        invoke 'composer:local:run', :status
+      rescue
+        run_locally do
+          command = SSHKit::Command.new :composer, :status, '-v', *default_arguments
+          error I18n.t('tasks.composer.local.check_status.failure', command: command.to_s, scope: :dkdeploy)
+          exit 1
+        end
+      end
+    end
+
+    desc 'Validate composer file'
+    task :validate do
+      invoke 'composer:local:run', :validate
+    end
+
+    desc 'Execute composer command'
+    task :run, :command do |_t, args|
+      args.with_defaults(command: :list, verbosity: :debug)
+      default_arguments = fetch(:composer_default_arguments)
+      run_locally do
+        execute :composer, args[:command], *args.extras, *default_arguments, '2>&1'
+      end
+    end
+  end
+end

data/lib/dkdeploy/php/tasks/db.rake

@@ -0,0 +1,121 @@
+require 'erb'
+require 'dkdeploy/php/helpers/db'
+include Dkdeploy::Php::Helpers::DB
+
+namespace :db do
+  desc 'Database migrations with Doctrine2. See http://www.doctrine-project.org/projects/migrations'
+  namespace :migrations do
+    desc 'Generate and download new migration'
+    task generate: [:copy_doctrine_to_server] do
+      on primary :backend do
+        info I18n.t('tasks.db.migrations.generate.info', scope: :dkdeploy)
+        execute :mkdir, '-p', remote_migrations_root_directory
+        within remote_migrations_root_directory do
+          execute :php, 'doctrine-migrations.phar', 'migrations:generate', fetch(:migrations_default_arguments)
+        end
+        download! remote_migrations_classes_directory, local_migrations_root_directory, via: :scp, recursive: true
+      end
+    end
+
+    desc 'Show migration status'
+    task status: [:copy_doctrine_to_server, :copy_migrations_to_server] do
+      run_locally do
+        info I18n.t('tasks.db.migrations.status.info', scope: :dkdeploy)
+      end
+      on primary :backend do
+        within remote_migrations_root_directory do
+          execute :php, 'doctrine-migrations.phar', 'migrations:status'
+        end
+      end
+    end
+
+    desc 'Migrate Database'
+    task migrate: [:copy_doctrine_to_server, :copy_migrations_to_server] do
+      run_locally do
+        info I18n.t('tasks.db.migrations.migrate.info', scope: :dkdeploy)
+      end
+      on primary :backend do
+        within remote_migrations_root_directory do
+          execute :php, 'doctrine-migrations.phar', 'migrations:migrate', fetch(:migrations_default_arguments)
+        end
+      end
+    end
+
+    desc 'Downgrade database'
+    task :execute_down, :migration_version do |_, args|
+      migration_version = ask_variable(args, :migration_version, 'questions.db.migrations.migration_version')
+      invoke 'db:migrations:copy_doctrine_to_server'
+      invoke 'db:migrations:copy_migrations_to_server'
+      run_locally do
+        info I18n.t('tasks.db.migrations.execute_down.info', migration_version: migration_version, scope: :dkdeploy)
+      end
+      on primary :backend do
+        within remote_migrations_root_directory do
+          execute :php, 'doctrine-migrations.phar', 'migrations:execute', migration_version.to_s, '--down', fetch(:migrations_default_arguments)
+        end
+      end
+    end
+
+    desc 'Copy Doctrine to server'
+    task :copy_doctrine_to_server do
+      if File.exist? fetch(:doctrine_phar)
+        run_locally do
+          info I18n.t('tasks.db.migrations.copy_doctrine_to_server.info.doctrine_phar',
+                      doctrine_phar: fetch(:doctrine_phar),
+                      scope: :dkdeploy)
+        end
+        on primary :backend do
+          info I18n.t('tasks.db.migrations.copy_doctrine_to_server.info.remove', scope: :dkdeploy)
+          execute :rm, '-rf', remote_migrations_root_directory
+          info I18n.t('tasks.db.migrations.copy_doctrine_to_server.info.create_directories', scope: :dkdeploy)
+          execute :mkdir, '-p', remote_migrations_classes_directory
+
+          info I18n.t('tasks.db.migrations.copy_doctrine_to_server.info.upload_doctrine',
+                      migrations_root_directory: remote_migrations_root_directory,
+                      scope: :dkdeploy)
+          upload! fetch(:doctrine_phar), File.join(remote_migrations_root_directory, 'doctrine-migrations.phar')
+
+          info I18n.t('tasks.db.migrations.copy_doctrine_to_server.info.upload_doctrine_db_configuration',
+                      migrations_root_directory: remote_migrations_root_directory,
+                      scope: :dkdeploy)
+          cli_config_template = ERB.new File.read(File.join(local_migrations_root_directory, 'cli-config.php.erb'))
+          upload! StringIO.new(cli_config_template.result(binding)), File.join(remote_migrations_root_directory, 'cli-config.php')
+
+          I18n.t('tasks.db.migrations.copy_doctrine_to_server.info.upload_doctrine_configuration',
+                 migrations_root_directory: remote_migrations_root_directory,
+                 scope: :dkdeploy)
+          cli_config_template = ERB.new File.read(File.join(local_migrations_root_directory, 'migrations.yml.erb'))
+          upload! StringIO.new(cli_config_template.result(binding)), File.join(remote_migrations_root_directory, 'migrations.yml')
+        end
+      end
+    end
+
+    desc 'Copies your Doctrine migrations to server'
+    task :copy_migrations_to_server do
+      on primary :backend do
+        info I18n.t('tasks.db.migrations.copy_migrations_to_server.info.upload_migrations',
+                    migrations_classes_directory: remote_migrations_classes_directory,
+                    scope: :dkdeploy)
+        execute :rm, '-rf', remote_migrations_classes_directory
+
+        # Copy common migrations to server
+        if Dir.exist? local_migrations_classes_directory
+          upload! local_migrations_classes_directory, remote_migrations_root_directory, via: :scp, recursive: true
+        end
+
+        # Copy stage specific migrations
+        if Dir.exist? File.join(local_migrations_stage_directory, fetch(:stage).to_s)
+          info I18n.t('tasks.db.migrations.copy_migrations_to_server.info.upload_stage_migrations',
+                      stage: fetch(:stage).to_s,
+                      migrations_classes_directory: remote_migrations_classes_directory,
+                      scope: :dkdeploy)
+          execute :mkdir, '-p', remote_migrations_classes_directory
+          local_stage_directory = File.join(local_migrations_stage_directory, fetch(:stage).to_s)
+          Dir[File.join(local_stage_directory, '*')].each do |file|
+            upload! file, remote_migrations_classes_directory, via: :scp, recursive: true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dkdeploy/php/tasks/php.rake

@@ -0,0 +1,90 @@
+require 'socket'
+require 'net/http'
+require 'uri'
+require 'json'
+require 'dkdeploy/php/helpers/http'
+include Dkdeploy::Php::Helpers::Http
+
+namespace :php do
+  desc 'Show PHP Version'
+  task :version do
+    on roles :app, :web do
+      php_version = capture :php, '-v'
+      info php_version
+    end
+  end
+
+  desc 'Clear APC cache on stage'
+  task :clear_apc_cache, :local_apc_file do |_, args|
+    local_apc_file = ask_variable(args, :local_apc_file, 'tasks.php.clear_apc_cache.local_apc_file') { |question| question.default = 'vendor/apc_clear.php' }
+
+    web_root = File.join current_path, fetch(:remote_web_root_path)
+    remote_apc_file_name = fetch(:remote_apc_file_name)
+    remote_apc_file = File.join web_root, remote_apc_file_name
+
+    on roles :app do |server|
+      delete_apc_file = false
+      unless test("[ -f #{remote_apc_file} ]")
+        # upload file, if not exists
+        upload! local_apc_file, remote_apc_file, via: :scp
+        delete_apc_file = true
+      end
+
+      begin
+        # call url
+        response = call_file_on_server remote_apc_file_name, server
+        info I18n.t('tasks.php.clear_apc_cache.result_msg', code: response.code, message: response.message, scope: :dkdeploy)
+        if response.is_a? Net::HTTPSuccess
+          result = JSON.parse response.body
+          unless result['success']
+            warn I18n.t('tasks.php.clear_apc_cache.cache_not_cleared', scope: :dkdeploy)
+          end
+        else
+          error I18n.t('tasks.php.clear_apc_cache.response_not_success', code: response.code, message: response.message, scope: :dkdeploy)
+          raise
+        end
+
+      ensure
+        # Delete file, if uploaded before
+        execute(:rm, '-f', remote_apc_file) if delete_apc_file
+      end
+    end
+  end
+
+  desc 'Clear OPcache on stage'
+  task :clear_opcache, :local_opcache_file do |_, args|
+    local_opcache_file = ask_variable(args, :local_opcache_file, 'tasks.php.clear_opcache.local_opcache_file') { |question| question.default = 'vendor/opcache_reset.php' }
+
+    web_root = File.join current_path, fetch(:remote_web_root_path)
+    remote_opcache_file_name = fetch(:remote_opcache_file_name)
+    remote_opcache_file = File.join web_root, remote_opcache_file_name
+
+    on roles :app do |server|
+      delete_opcache_file = false
+      unless test("[ -f #{remote_opcache_file} ]")
+        # upload file, if not exists
+        upload! local_opcache_file, remote_opcache_file, via: :scp
+        delete_opcache_file = true
+      end
+
+      begin
+        # call url
+        response = call_file_on_server remote_opcache_file_name, server
+        info I18n.t('tasks.php.clear_opcache.result_msg', code: response.code, message: response.message, scope: :dkdeploy)
+        if response.is_a? Net::HTTPSuccess
+          result = JSON.parse response.body
+          unless result['success']
+            warn I18n.t('tasks.php.clear_opcache.cache_not_cleared', scope: :dkdeploy)
+          end
+        else
+          error I18n.t('tasks.php.clear_opcache.response_not_success', code: response.code, message: response.message, scope: :dkdeploy)
+          raise
+        end
+
+      ensure
+        # Delete file, if uploaded before
+        execute(:rm, '-f', remote_opcache_file) if delete_opcache_file
+      end
+    end
+  end
+end

data/lib/dkdeploy/php/version.rb

@@ -0,0 +1,15 @@
+module Dkdeploy
+  module Php
+    # Class for version number
+    #
+    class Version
+      MAJOR = 7
+      MINOR = 0
+      PATCH = 0
+
+      def self.to_s
+        "#{MAJOR}.#{MINOR}.#{PATCH}"
+      end
+    end
+  end
+end

data/spec/fixtures/application/Capfile

@@ -0,0 +1,8 @@
+# Load DSL and Setup Up Stages
+require 'capistrano/setup'
+
+# Includes default deployment tasks
+require 'capistrano/deploy'
+
+# Includes dkdeploy php tasks
+require 'capistrano/dkdeploy/php'

data/spec/fixtures/application/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'dkdeploy-php', path: '../../'
+
+# Gem for task "assets:compile_compass"
+gem 'compass', '~> 0.12.0'

data/spec/fixtures/application/config/deploy.rb

@@ -0,0 +1,8 @@
+set :application, 'test_app'
+set :composer_default_arguments, fetch(:composer_default_arguments) + ['-d=htdocs/']
+SSHKit.config.command_map.prefix[:compass].push 'bundle exec'
+SSHKit.config.command_map.prefix[:chown].push 'sudo'
+SSHKit.config.command_map.prefix[:chgrp].push 'sudo'
+SSHKit.config.command_map.prefix[:chmod].push 'sudo'
+SSHKit.config.command_map[:composer] = 'php ./vendor/composer.phar'
+SSHKit.config.command_map[:php] = '/usr/bin/php'

data/spec/fixtures/application/config/deploy/dev.rb

@@ -0,0 +1,40 @@
+set :deploy_to, '/var/www/dkdeploy'
+server 'dkdeploy-php.dev', roles: %w(web app backend), primary: true
+
+# no ssh compression on the dev stage
+set :ssh_options, {
+  compression: 'none'
+}
+
+ssh_key_files = Dir.glob(File.join(Dir.getwd, '..', '..', '.vagrant', 'machines', '**', 'virtualbox', 'private_key'))
+unless ssh_key_files.empty?
+  # Define generated ssh key files
+  set :ssh_options, fetch(:ssh_options).merge(
+    {
+      user: 'vagrant',
+      keys: ssh_key_files
+    }
+  )
+end
+
+set :copy_source, 'htdocs'
+set :copy_exclude, %w(
+  Gemfile*
+  .hidden
+  **/.hidden
+)
+
+# Set http open timeout to 1 second
+set :http_open_timeout, 60
+
+# custom file access properties
+set :custom_file_access, {
+  app: {
+    catalog: {
+      owner: 'test-user',
+      group: 'test-group',
+      mode: 'a+rwx,o-wx',
+      recursive: true
+    }
+  }
+}

data/spec/fixtures/application/config/migrations/cli-config.php.erb

@@ -0,0 +1,23 @@
+<?php
+<% db_settings = read_db_settings_for_context(self) %>
+$connection = \Doctrine\DBAL\DriverManager::getConnection(
+	array(
+		'dbname' => '<%= db_settings.fetch('name') %>',
+		'user' => '<%= db_settings.fetch('username') %>',
+		'password' => '<%= db_settings.fetch('password') %>',
+		'host' => '<%= db_settings.fetch('host') %>',
+		'port' => '<%= db_settings.fetch('port') %>',
+		'charset' => '<%= db_settings.fetch('charset') %>',
+		'driver' => 'pdo_mysql'
+	)
+);
+$connection->getDatabasePlatform()->registerDoctrineTypeMapping('mediumblob', 'string');
+$connection->getDatabasePlatform()->registerDoctrineTypeMapping('tinyblob', 'string');
+$connection->getDatabasePlatform()->registerDoctrineTypeMapping('longblob', 'string');
+$connection->getDatabasePlatform()->registerDoctrineTypeMapping('blob', 'string');
+
+$helperSet = new \Symfony\Component\Console\Helper\HelperSet(
+	array(
+		'db' => new \Doctrine\DBAL\Tools\Console\Helper\ConnectionHelper($connection)
+	)
+);

data/spec/fixtures/application/config/migrations/migrations.yml.erb

@@ -0,0 +1,4 @@
+name: Doctrine TYPO3 Migrations
+migrations_namespace: DoctrineMigrations
+table_name: doctrine_migrations
+migrations_directory: <%= remote_migrations_classes_directory %>

data/spec/fixtures/application/htdocs/composer.json

@@ -0,0 +1,22 @@
+{
+    "name": "dkdeploy/example",
+    "description": "Just a sample composer.json",
+    "type": "library",
+    "keywords": [
+        "phpunit",
+        "xunit",
+        "testing"
+    ],
+    "homepage": "https://dkd.de/",
+    "license": "GPL-3.0",
+    "authors": [
+        {
+            "name": "Random Coder",
+            "email": "mail@example.com",
+            "role": "lead"
+        }
+    ],
+    "require": {
+        "symfony/yaml": "~2.0"
+    }
+}

data/spec/fixtures/capistrano/configuration/server_with_faulty_domain_configuration.rb

@@ -0,0 +1,2 @@
+
+server 'dkdeploy-php.dev', roles: %w(web app backend), domain: 'not-existing-dkdeploy.dev'

data/spec/fixtures/capistrano/configuration/server_with_valid_domain.rb

@@ -0,0 +1,2 @@
+
+server 'dkdeploy-php.dev', roles: %w(web app backend), domain: 'second-dkdeploy-php.dev'

data/vendor/apc_clear.php

@@ -0,0 +1,14 @@
+<?php
+$result = false;
+/**
+ * Clear apc cache
+ *
+ * @see http://stackoverflow.com/questions/911158/how-to-clear-apc-cache-entries/3580939#3580939
+ */
+if (isset($_SERVER['REMOTE_ADDR']) && function_exists('apc_clear_cache')) {
+	apc_clear_cache();
+	apc_clear_cache('user');
+	apc_clear_cache('opcode');
+	$result = true;
+}
+echo json_encode(array('success' => $result));

data/vendor/opcache_reset.php

@@ -0,0 +1,10 @@
+<?php
+/**
+ * Clear OPcache
+ *
+ */
+$result = false;
+if (isset($_SERVER['REMOTE_ADDR']) && function_exists('opcache_reset')) {
+	$result = opcache_reset();
+}
+echo json_encode(array('success' => $result));