dkdeploy-php 7.0.0

data/dkdeploy-php.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dkdeploy/php/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dkdeploy-php'
+  spec.version       = Dkdeploy::Php::Version
+  spec.license       = 'MIT'
+  spec.authors       = ['Lars Tode', 'Timo Webler', 'Kieran Hayes', 'Nicolai Reuschling']
+  spec.email         = ['lars.tode@dkd.de', 'timo.webler@dkd.de', 'kieran.hayes@dkd.de', 'nicolai.reuschling@dkd.de']
+  spec.description   = 'dkd PHP deployment tasks and strategies'
+  spec.summary       = 'dkd php deployment tasks and strategies'
+  spec.homepage      = 'https://github.com/dkdeploy/dkdeploy-php'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)\/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12.5'
+  spec.add_development_dependency 'rake', '~> 11.2'
+  spec.add_development_dependency 'rubocop', '~> 0.40'
+  spec.add_development_dependency 'dkdeploy-test_environment', '~> 1.0'
+
+  spec.add_dependency 'dkdeploy-core', '~> 8.0'
+end

data/features/composer.feature

@@ -0,0 +1,20 @@
+Feature: Test tasks for namespace 'composer'
+
+	Background:
+		Given a test app with the default configuration
+
+	Scenario: check for valid composer file
+		Then a file named "htdocs/composer.json" should exist
+		Then I successfully run `cap dev composer:local:validate`
+		Then the output should contain "composer.json is valid"
+
+	Scenario: Check if composer status is successful
+		Given the default aruba exit timeout is 120 seconds
+		And I successfully run `cap dev composer:local:run['install']`
+		When I successfully run `cap dev composer:local:check_status`
+		Then the output should contain "No local changes"
+
+	Scenario: Check if composer status is not successful
+		Given the default aruba exit timeout is 120 seconds
+		When I run `cap dev composer:local:check_status`
+		Then the exit status should not be 0

data/features/db.feature

@@ -0,0 +1,84 @@
+Feature: Test tasks for namespace 'db'
+
+	Background:
+		Given a test app with the default configuration
+		And I want to use the database `dkdeploy_php`
+		And I successfully run `cap dev "db:upload_settings[127.0.0.1,3306,dkdeploy_php,root,ilikerandompasswords,utf8]"`
+
+		Scenario Outline: Check if the basic file structure for doctrine migrations has been successfully created on the server
+			When I successfully run `cap dev db:migrations:copy_doctrine_to_server`
+			Then a remote file named "<remote_directory>/<target_file>" should exist
+			And a remote directory named "migrations_path/classes" should exist
+
+			Examples:
+				| target_file               | remote_directory |
+				| doctrine-migrations.phar  | migrations_path  |
+				| cli-config.php            | migrations_path  |
+				| migrations.yml            | migrations_path  |
+
+		Scenario Outline: Check the correct stage specifig configuration of remote migrations root directory
+			When I extend the development capistrano configuration variable remote_migrations_root_directory with value 'alternative_migrations_directory'
+			And I successfully run `cap dev db:migrations:copy_doctrine_to_server`
+			Then a remote file named "<remote_directory>/<target_file>" should exist
+			And a remote directory named "shared_path/alternative_migrations_directory/classes" should exist
+
+			Examples:
+				| target_file               | remote_directory                             |
+				| doctrine-migrations.phar  | shared_path/alternative_migrations_directory |
+				| cli-config.php            | shared_path/alternative_migrations_directory |
+				| migrations.yml            | shared_path/alternative_migrations_directory |
+
+		Scenario: Check if a generated migration has benn successfully downloaded to the local directory config/migrations/classes
+			When I successfully run `cap dev db:migrations:generate`
+			And a file matching %r</migrations/classes/Version.+.php> should exist
+
+		Scenario: Checking if the migrations status table is outputed on the console
+			When I successfully run `cap dev db:migrations:status`
+			Then the output should contain "Doctrine TYPO3 Migrations"
+
+		Scenario: Checking if only global and current stage specific doctrine migrations are uploaded on the server
+			Given an empty doctrine migration with name "config/migrations/classes/Version99999999999997.php"
+			And an empty doctrine migration with name "config/migrations/stage/dev/Version99999999999998.php"
+			And an empty doctrine migration with name "config/migrations/stage/integration/Version99999999999999.php"
+			When I successfully run `cap dev db:migrations:copy_migrations_to_server`
+			Then a remote file named "migrations_path/classes/Version99999999999997.php" should exist
+			And a remote file named "migrations_path/classes/Version99999999999998.php" should exist
+			And a remote file named "migrations_path/classes/Version99999999999999.php" should not exist
+
+		Scenario: Check if migrations copied recursive to server
+			Given an empty doctrine migration with name "config/migrations/classes/Version99999999999997.php"
+			And an empty doctrine migration with name "config/migrations/classes/test1/Version99999999999997.php"
+			And an empty doctrine migration with name "config/migrations/classes/test1/test2/Version99999999999997.php"
+			And an empty doctrine migration with name "config/migrations/classes/test3/Version99999999999997.php"
+			And an empty doctrine migration with name "config/migrations/stage/dev/Version99999999999998.php"
+			And an empty doctrine migration with name "config/migrations/stage/dev/test1/test2/Version99999999999998.php"
+			And an empty doctrine migration with name "config/migrations/stage/dev/test4/Version99999999999998.php"
+			When I successfully run `cap dev db:migrations:copy_migrations_to_server`
+			Then a remote file named "migrations_path/classes/Version99999999999997.php" should exist
+			And a remote file named "migrations_path/classes/Version99999999999998.php" should exist
+			And a remote file named "migrations_path/classes/test1/Version99999999999997.php" should exist
+			And a remote file named "migrations_path/classes/test1/test2/Version99999999999997.php" should exist
+			And a remote file named "migrations_path/classes/test1/test2/Version99999999999998.php" should exist
+			And a remote file named "migrations_path/classes/test3/Version99999999999997.php" should exist
+			And a remote file named "migrations_path/classes/test4/Version99999999999998.php" should exist
+
+		Scenario: Checking if executed migrations result in database entries
+			Given an empty doctrine migration with name "config/migrations/stage/dev/Version22222222222222.php"
+			And an empty doctrine migration with name "config/migrations/stage/dev/Version33333333333333.php"
+			When I successfully run `cap dev db:migrations:copy_migrations_to_server`
+			And I successfully run `cap dev db:migrations:migrate`
+			Then the database should have a value `22222222222222` in table `doctrine_migrations` for column `version`
+
+		Scenario: Checking if downgraded migration is deleted from migrations table, but not other migrations
+			Given an empty doctrine migration with name "config/migrations/stage/dev/Version22222222222222.php"
+			And an empty doctrine migration with name "config/migrations/stage/dev/Version33333333333333.php"
+			And an empty doctrine migration with name "config/migrations/stage/dev/Version44444444444444.php"
+			When I successfully run `cap dev db:migrations:copy_migrations_to_server`
+			And I successfully run `cap dev db:migrations:migrate`
+			And I run `cap dev db:migrations:execute_down` interactively
+			And I type "33333333333333"
+			And I close the stdin stream
+			And I wait 10 seconds to let the database commit the transaction
+			Then the database should not have a value `33333333333333` in table `doctrine_migrations` for column `version`
+			And the database should have a value `22222222222222` in table `doctrine_migrations` for column `version`
+			And the database should have a value `44444444444444` in table `doctrine_migrations` for column `version`

data/features/php.feature

@@ -0,0 +1,44 @@
+Feature: Test tasks for namespace 'php'
+
+	Background:
+		Given a test app with the default configuration
+		And the default aruba exit timeout is 120 seconds
+		And I successfully run `cap dev deploy`
+
+	Scenario: Clear APC cache on the server
+		When I run `cap dev php:clear_apc_cache`
+		Then the exit status should be 0
+
+	Scenario: Clear APC fails on non existing PHP file
+		When I run `cap dev php:clear_apc_cache['htdocs/apc_clear.php']`
+		Then the exit status should not be 0
+
+	Scenario: Clear APC use server domain configuration
+		And I extend the development capistrano configuration from the fixture file server_with_valid_domain.rb
+		When I run `cap dev php:clear_apc_cache`
+		Then the exit status should be 0
+		And the output should contain "200 - OK"
+
+	Scenario: Clear APC break non not valid configuration
+		And I extend the development capistrano configuration from the fixture file server_with_faulty_domain_configuration.rb
+		When I run `cap dev php:clear_apc_cache`
+		Then the exit status should not be 0
+
+	Scenario: Clear OPcache on the server
+		When I run `cap dev php:clear_opcache`
+		Then the exit status should be 0
+
+	Scenario: Clear OPcache fails on non existing PHP file
+		When I run `cap dev php:clear_opcache['htdocs/opcache_reset.php']`
+		Then the exit status should not be 0
+
+	Scenario: Clear OPcache use server domain configuration
+		And I extend the development capistrano configuration from the fixture file server_with_valid_domain.rb
+		When I run `cap dev php:clear_opcache`
+		Then the exit status should be 0
+		And the output should contain "200 - OK"
+
+	Scenario: Clear OPcache break non not valid configuration
+		And I extend the development capistrano configuration from the fixture file server_with_faulty_domain_configuration.rb
+		When I run `cap dev php:clear_opcache`
+		Then the exit status should not be 0

data/features/support/env.rb

@@ -0,0 +1,14 @@
+require 'dkdeploy/test_environment/application'
+ssh_config = {}
+
+ssh_key_files = Dir.glob(File.join(Dir.getwd, '.vagrant', 'machines', '**', 'virtualbox', 'private_key'))
+unless ssh_key_files.empty?
+  # Define generated ssh key files
+  ssh_config = {
+    user: 'vagrant',
+    keys: ssh_key_files
+  }
+end
+
+TEST_APPLICATION = Dkdeploy::TestEnvironment::Application.new(File.expand_path('../../../', __FILE__), 'dkdeploy-php.dev', ssh_config)
+TEST_APPLICATION.mysql_connection_settings = { host: 'dkdeploy-php.dev', username: 'root', password: 'ilikerandompasswords' }

data/features/support/path.rb

@@ -0,0 +1,30 @@
+# Navigation helper module for cucumber steps
+#
+module NavigationHelpers
+  # Mapping for path names to real remote path
+  #
+  # @param path [String]
+  # @return [String]
+  def path_to(path)
+    case path
+    when 'deploy_path'
+      TEST_APPLICATION.deploy_to
+    when 'current_path'
+      TEST_APPLICATION.current_path
+    when 'releases_path'
+      TEST_APPLICATION.remote.releases_path
+    when 'shared_path'
+      TEST_APPLICATION.remote.shared_path
+    when 'assets_path'
+      TEST_APPLICATION.remote.assets_path
+    when 'migrations_path'
+      File.join TEST_APPLICATION.remote.shared_path, 'migrations'
+    when 'tmp_path'
+      TEST_APPLICATION.remote_tmp_path
+    else
+      path
+    end
+  end
+end
+
+World(NavigationHelpers)

data/features/support/step_definitions/steps.rb

@@ -0,0 +1,15 @@
+require 'erb'
+require 'ostruct'
+
+# Creates an empty doctrine migration with a given migration version and basic content
+#
+# @yieldparam migration_version [String] the 14 digits migration number
+Given(/^an empty doctrine migration with name "([^"]*)"$/) do |file_path|
+  context_object = OpenStruct.new migration_name: file_path.scan(/Version[0-9]+/)[0]
+  def context_object.binding_for_erb
+    binding
+  end
+  empty_doctrine_migration_template_path = File.expand_path('../../templates/empty-doctrine-migration.erb', __FILE__)
+  empty_doctrine_migration_template = ERB.new File.read(empty_doctrine_migration_template_path)
+  write_file file_path, empty_doctrine_migration_template.result(context_object.binding_for_erb)
+end

data/features/support/templates/empty-doctrine-migration.erb

@@ -0,0 +1,20 @@
+<?php
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Migrations\AbstractMigration,
+	Doctrine\DBAL\Schema\Schema;
+
+/**
+ * Auto-generated Migration: Please modify to your need!
+ */
+class <%= migration_name %> extends AbstractMigration {
+
+	public function up(Schema $schema) {
+		// this up() migration is autogenerated, please modify it to your needs
+	}
+
+	public function down(Schema $schema) {
+		// this down() migration is autogenerated, please modify it to your needs
+	}
+
+}

data/lib/capistrano/dkdeploy/php.rb

@@ -0,0 +1,25 @@
+require 'capistrano/dkdeploy/core'
+
+include Capistrano::DSL
+
+# Load dkdeploy tasks
+load File.expand_path('../../../dkdeploy/php/tasks/php.rake', __FILE__)
+load File.expand_path('../../../dkdeploy/php/tasks/composer.rake', __FILE__)
+load File.expand_path('../../../dkdeploy/php/tasks/db.rake', __FILE__)
+
+namespace :load do
+  task :defaults do
+    set :composer_default_arguments, ['--no-interaction']
+    set :composer_install_arguments, []
+
+    set :doctrine_phar, './vendor/doctrine-migrations.phar'
+    set :remote_migrations_root_directory, 'migrations'
+    set :migrations_default_arguments, ['--no-interaction']
+
+    set :remote_apc_file_name, 'apc_clear.php'
+    set :local_apc_file, File.join(__dir__, '..', '..', '..', 'vendor', 'apc_clear.php')
+
+    set :remote_opcache_file_name, 'opcache_reset.php'
+    set :local_opcache_file, File.join(__dir__, '..', '..', '..', 'vendor', 'opcache_reset.php')
+  end
+end

data/lib/dkdeploy/php/helpers/db.rb

@@ -0,0 +1,43 @@
+module Dkdeploy
+  module Php
+    module Helpers
+      # DB related helpers
+      module DB
+        # Local migrations classes directory
+        #
+        # @return [String]
+        def local_migrations_root_directory
+          File.join 'config', 'migrations'
+        end
+
+        # Local migrations classes directory
+        #
+        # @return [String]
+        def local_migrations_classes_directory
+          File.join local_migrations_root_directory, 'classes'
+        end
+
+        # Local migrations stages directory
+        #
+        # @return [String]
+        def local_migrations_stage_directory
+          File.join local_migrations_root_directory, 'stage'
+        end
+
+        # Remote migrations root directory
+        #
+        # @return [String]
+        def remote_migrations_root_directory
+          File.join shared_path, fetch(:remote_migrations_root_directory)
+        end
+
+        # Remote migrations classes directory
+        #
+        # @return [String]
+        def remote_migrations_classes_directory
+          File.join(remote_migrations_root_directory, 'classes')
+        end
+      end
+    end
+  end
+end

data/lib/dkdeploy/php/helpers/http.rb

@@ -0,0 +1,60 @@
+require 'socket'
+require 'net/http'
+
+module Dkdeploy
+  module Php
+    module Helpers
+      # HTTP related helpers
+      module Http
+        # Local migrations classes directory
+        #
+        # @param filename [String]
+        # @param server [SSHKit::Host]
+        # @return [Net::HTTPResponse]
+        def call_file_on_server(filename, server)
+          # Setting up URL to call
+          domain_scheme = server.properties.respond_to?(:domain_scheme) ? server.fetch(:domain_scheme) : 'http'
+          domain = server.properties.respond_to?(:domain) ? server.fetch(:domain) : server.hostname
+          web_server_port = domain_scheme == 'https' ? 443 : 80
+          # Use server configuration, if exists
+          web_server_port = server.fetch(:web_server_port) if server.properties.respond_to?(:web_server_port)
+
+          url = URI.parse("#{domain_scheme}://#{domain}").merge("/#{filename}")
+          url.port = web_server_port
+          info "Call URL #{url}"
+
+          http_get_with_redirect url
+        end
+
+        # Sends a get request that handles redirects
+        #
+        # @param url [URI]
+        # @param limit [Integer] defines how many redirects are allowed
+        # @return [NET::HTTPResponse]
+        def http_get_with_redirect(url, limit = 5)
+          limit = Integer(limit)
+          raise ArgumentError, 'limit cannot be negative' if limit < 0
+          raise 'too many HTTP redirects' if limit.zero?
+          # configure Net::HTTP
+          http = Net::HTTP.new(url.host, url.port)
+          http.open_timeout = fetch :http_open_timeout, nil
+          http.read_timeout = fetch :http_read_timeout, 60
+          if url.scheme == 'https'
+            http.use_ssl = true
+            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          end
+          request = Net::HTTP::Get.new(url.path) # build request
+          # call url
+          response = http.request(request)
+          if response.is_a? Net::HTTPRedirection
+            # Does not handle multiple redirects. Code/idea from http://stackoverflow.com/a/7210600/1796645
+            location = URI.parse(response.header['location'])
+            info "redirected to #{location}"
+            response = http_get_with_redirect(location, limit - 1)
+          end
+          response
+        end
+      end
+    end
+  end
+end

data/lib/dkdeploy/php/i18n.rb

@@ -0,0 +1,74 @@
+require 'i18n'
+
+en = {
+  tasks: {
+    composer: {
+      local: {
+        check_status: {
+          run_install: 'Please run command "%{command}"',
+          failure: %q(You can't deploy Packages with local changes. Please run command "%{command}" to see which files are modified.')
+        }
+      }
+    },
+    php: {
+      clear_apc_cache: {
+        local_apc_file: 'Please enter the path to local apc clear cache file ',
+        result_msg: 'Result %{code} - %{message}',
+        cache_not_cleared: 'Can not clear apc cache. Result code is 2xx, but cache is not cleared. See php log for more information.',
+        response_not_success: 'Can not clear apc cache. Result code is not 2xx. %{code} - %{message}'
+      },
+      clear_opcache: {
+        local_opcache_file: 'Please enter the path to local OPcache clear cache file ',
+        result_msg: 'Result %{code} - %{message}',
+        cache_not_cleared: 'Can not clear OPcache. Result code is 2xx, but cache is not cleared. See php log for more information.',
+        response_not_success: 'Can not clear OPcache. Result code is not 2xx. %{code} - %{message}'
+      }
+    },
+    db: {
+      migrations: {
+        generate: {
+          info: 'Generating new migration.'
+        },
+        status: {
+          info: 'Getting status of migrations.'
+        },
+        migrate: {
+          info: 'Migrating database.'
+        },
+        execute_down: {
+          info: 'Migrating down to version %{migration_version}',
+          abort: "Please set the variable 'migration_version' before you execute the task"
+        },
+        copy_doctrine_to_server: {
+          info: {
+            doctrine_phar: '%{doctrine_phar} found.',
+            remove: 'Removing old migrations.',
+            create_directories: 'Creating directories for migrations.',
+            upload_doctrine: 'Copying doctrine-migrations.phar to %{migrations_root_directory} directory.',
+            upload_doctrine_configuration: 'Copying configuration.yml to %{migrations_root_directory}.',
+            upload_doctrine_db_configuration: 'Copying db-configuration.php to %{migrations_root_directory}.'
+          }
+        },
+        copy_migrations_to_server: {
+          info: {
+            upload_migrations: 'Uploading migrations to %{migrations_classes_directory}.',
+            upload_stage_migrations: 'Uploading migrations for stage %{stage} to %{migrations_classes_directory}.'
+          }
+        }
+      }
+    }
+  },
+  questions: {
+    db: {
+      migrations: {
+        migration_version: 'Please enter the doctrine migration version:'
+      }
+    }
+  }
+}
+
+I18n.backend.store_translations(:en, dkdeploy: en)
+
+if I18n.respond_to?(:enforce_available_locales=)
+  I18n.enforce_available_locales = true
+end