dkdeploy-core 8.0.0

data/features/support/env.rb

@@ -0,0 +1,22 @@
+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-core.dev', ssh_config)
+TEST_APPLICATION.mysql_connection_settings = { host: 'dkdeploy-core.dev', username: 'root', password: 'ilikerandompasswords' }
+
+# this configuration tricks Bundler into executing another Bundler project with clean enviroment
+# The official way via Bundler.with_clean_env did not work properly here
+Aruba.configure do |config|
+  config.command_runtime_environment = { 'BUNDLE_GEMFILE' => File.join(TEST_APPLICATION.test_app_path, 'Gemfile') }
+  config.exit_timeout = 10
+end

data/features/utils.feature

@@ -0,0 +1,81 @@
+Feature: Test tasks for namespace 'utils'
+
+	Background:
+		Given a test app with the default configuration
+		And the remote server is cleared
+
+	Scenario: Upload local file to server
+		Given an empty file named "htdocs/new_file.html"
+		Then I successfully run `cap dev utils:upload_file['htdocs/new_file.html']`
+		Then a remote file named "current_path/new_file.html" should exist
+
+	Scenario: Upload local file to server which does not exist locally
+		And I run `cap dev utils:upload_file['htdocs/new_file.html']`
+		Then the exit status should be 1
+
+	Scenario: Call task "utils:upload_file" without entering any file name
+		Given an empty file named "htdocs/new_file.html"
+		When I run `cap dev utils:upload_file` interactively
+		And I type ""
+		And I close the stdin stream
+		Then the exit status should be 1
+		And a remote file named "current_path/new_file.html" should not exist
+
+	Scenario: Download remote file
+		Given a remote directory named "current_path"
+		And a remote file named "current_path/download_file.txt" with:
+		"""
+Remote file content
+		"""
+		When I successfully run `cap dev utils:download_file['download_file.txt']`
+		Then a file named "temp/download_file.dkdeploy-core.dev.txt" should exist
+
+	Scenario: Download a file from server which does exist locally
+		Given a file named "temp/download_file.dkdeploy-core.dev.txt" with:
+		"""
+Local file content
+		"""
+		And a remote directory named "current_path"
+		And a remote file named "current_path/download_file.txt" with:
+		"""
+Remote file content
+		"""
+		When I successfully run `cap dev utils:download_file['download_file.txt']`
+		Then the file "temp/download_file.dkdeploy-core.dev.txt" should contain exactly:
+		"""
+Remote file content
+
+		"""
+
+	Scenario: Call task "utils:download_file" without entering any file name
+		When I run `cap dev utils:download_file` interactively
+		And I type ""
+		And I close the stdin stream
+		Then the exit status should be 1
+
+	Scenario: Rsync add new files to server
+		Given the project is deployed
+		And an empty file named "htdocs/new_file.txt"
+		And I successfully run `cap dev utils:rsync`
+		Then a remote file named "current_path/new_file.txt" should exist
+
+	Scenario: Rsync add new files at root to server
+		Given the project is deployed
+		And I extend the development capistrano configuration variable rsync_path with value '.'
+		And an empty file named "new_file.txt"
+		And I successfully run `cap dev utils:rsync`
+		Then a remote file named "current_path/new_file.txt" should exist
+
+	Scenario: Rsync exclude files
+		Given the project is deployed
+		And I extend the development capistrano configuration variable rsync_exclude with value ['file_to_exclude.txt']
+		And an empty file named "htdocs/file_to_exclude.txt"
+		And I successfully run `cap dev utils:rsync`
+		Then a remote file named "current_path/file_to_exclude.txt" should not exist
+
+	Scenario: Create custom directories within path shared
+		When I run `cap dev utils:create_custom_directories` interactively
+		And I type "mydirectory"
+		And I close the stdin stream
+		Then the exit status should be 0
+		And a remote directory named "shared_path/mydirectory" should exist

data/lib/capistrano/copy.rb

@@ -0,0 +1,2 @@
+# if capistrano scm is set to copy, the current file will be loaded
+load File.expand_path('../../dkdeploy/tasks/copy.rake', __FILE__)

data/lib/capistrano/dkdeploy/core.rb

@@ -0,0 +1,88 @@
+include Capistrano::DSL
+
+require 'dkdeploy/rollback_manager'
+
+# Load dkdeploy tasks
+load File.expand_path('../../../dkdeploy/tasks/deploy.rake', __FILE__)
+load File.expand_path('../../../dkdeploy/tasks/fail.rake', __FILE__)
+load File.expand_path('../../../dkdeploy/tasks/maintenance.rake', __FILE__)
+load File.expand_path('../../../dkdeploy/tasks/utils.rake', __FILE__)
+load File.expand_path('../../../dkdeploy/tasks/file_access.rake', __FILE__)
+load File.expand_path('../../../dkdeploy/tasks/assets.rake', __FILE__)
+load File.expand_path('../../../dkdeploy/tasks/apache.rake', __FILE__)
+load File.expand_path('../../../dkdeploy/tasks/project_version.rake', __FILE__)
+load File.expand_path('../../../dkdeploy/tasks/db.rake', __FILE__)
+load File.expand_path('../../../dkdeploy/tasks/enhanced_symlinks.rake', __FILE__)
+load File.expand_path('../../../dkdeploy/tasks/current_folder.rake', __FILE__)
+load File.expand_path('../../../dkdeploy/tasks/bower.rake', __FILE__)
+
+# Hook into symlink related tasks
+after 'deploy:check:linked_dirs', 'deploy:enhanced_symlinks:check:linked_dirs'
+after 'deploy:check:linked_files', 'deploy:enhanced_symlinks:check:linked_files'
+after 'deploy:check:make_linked_dirs', 'deploy:enhanced_symlinks:check:make_linked_dirs'
+after 'deploy:symlink:linked_dirs', 'deploy:enhanced_symlinks:symlink:linked_dirs'
+after 'deploy:symlink:linked_files', 'deploy:enhanced_symlinks:symlink:linked_files'
+
+namespace :load do
+  task :defaults do
+    # Set scm to new scm "copy"
+    set :scm, :copy
+
+    # Set default values for copy scm
+    set :copy_source, 'htdocs'
+    set :copy_exclude, Array[
+      'vendor/bundle/**',
+      'Gemfile*',
+      '**/.git',
+      '**/.svn',
+      '**/.DS_Store',
+      '.settings',
+      '.project',
+      '.buildpath',
+      'Capfile',
+      'Thumbs.db',
+      'composer.lock'
+    ]
+
+    # Set default web root paths
+    set :local_web_root_path, -> { fetch(:copy_source) }
+    set :remote_web_root_path, '.'
+
+    # Set default version file path
+    set :version_file_path, ''
+
+    # default file owner
+    set :default_file_access_owner_of_shared_path, 'www-data'
+    set :default_file_access_owner_of_release_path, 'www-data'
+    # default file group
+    set :default_file_access_group_of_shared_path, 'www-data'
+    set :default_file_access_group_of_release_path, 'www-data'
+    # default file access mode
+    set :default_file_access_mode_of_shared_path, 'u+rwX,g+rX,g-w,o-rwx'
+    set :default_file_access_mode_of_release_path, 'u+rwX,g+rX,g-w,o-rwx'
+    # custom file access properties
+    set :custom_file_access, {}
+
+    # Set default compass sources
+    set :compass_sources, []
+    set :compass_compile_arguments, []
+
+    # Number of archives to keep around
+    set :keep_rollback_archives, 5
+
+    # List of bower.json files
+    set :bower_path, -> { fetch(:copy_source) }
+    set :bower_paths, -> { Array(fetch(:copy_source)) }
+
+    # List of filters for file_access:set_selected_custom_access
+    set :selected_custom_file_access, []
+
+    # Set assets configuration
+    set :asset_default_content, []
+    set :asset_exclude_file, ''
+    set :asset_folders, []
+
+    # Airbrush configuration
+    set :format_options, command_output: true, log_file: nil, truncate: false
+  end
+end

data/lib/dkdeploy/constants.rb

@@ -0,0 +1,156 @@
+module Dkdeploy
+  # Global static methods
+  #
+  module Constants
+    #####################################################
+    # General constants
+    #####################################################
+
+    # Copy source path
+    #
+    # @return [String]
+    def copy_source
+      fetch :copy_source, '.'
+    end
+
+    # Local Dump Path
+    #
+    # @return [String]
+    def local_dump_path
+      fetch :local_dump_path, 'temp'
+    end
+
+    # Copy exclude pattern
+    #
+    # @return [Array]
+    def copy_exclude
+      fetch :copy_exclude, []
+    end
+
+    # Application name
+    #
+    # @return [String]
+    def application
+      fetch(:application)
+    end
+
+    # Assets path
+    #
+    # @return [String]
+    def assets_path
+      File.join shared_path, 'assets'
+    end
+
+    # File path to remote database config file
+    #
+    # @return [String]
+    def remote_database_config_path
+      File.join shared_path, 'config', "db_settings.#{fetch(:stage)}.yaml"
+    end
+
+    # File path to local database config file
+    #
+    # @return [String]
+    def local_database_config_path
+      File.join 'temp', "db_settings.#{fetch(:stage)}.yaml"
+    end
+
+    # Default timestamp format for database dump files
+    #
+    # @return [String]
+    def datetime_format
+      '%Y-%m-%d_%H-%M'
+    end
+
+    # List of table names to be ignored by default when dumping from database
+    #
+    # @return [String]
+    def default_ignore_tables
+      %w(
+        cache_extensions cache_hash cache_imagesizes cache_md5params
+        cache_pages cache_pagesection cache_sys_dmail_stat cache_treelist cache_typo3temp_log
+        cachingframework_cache_hash cachingframework_cache_hash_tags cachingframework_cache_pages
+        cachingframework_cache_pages_tags cachingframework_cache_pagesection
+        cachingframework_cache_pagesection_tags sys_workspace_cache sys_workspace_cache_tags
+        tt_news_cache tt_news_cache_tags tx_extbase_cache_object tx_extbase_cache_object_tags
+        tx_extbase_cache_reflection tx_extbase_cache_reflection_tags tx_realurl_chashcache
+        tx_realurl_pathcache tx_realurl_urldecodecache tx_realurl_urlencodecache be_users be_sessions
+        sys_domain fe_users fe_sessions fe_session_data
+        cf_cache_hash cf_cache_hash_tags cf_cache_pages cf_cache_pages_tags cf_cache_pagesection
+        cf_cache_pagesection_tags cf_cache_rootline cf_cache_rootline_tags cf_extbase_datamapfactory_datamap
+        cf_extbase_datamapfactory_datamap_tags cf_extbase_object cf_extbase_object_tags
+        cf_extbase_reflection cf_extbase_reflection_tags cf_extbase_typo3dbbackend_queries
+        cf_extbase_typo3dbbackend_queries_tags cf_extbase_typo3dbbackend_tablecolumns
+        cf_extbase_typo3dbbackend_tablecolumns_tags
+      )
+    end
+
+    # List of table names to be ignored when dumping from database defined via Capistrano variable or environment variable
+    #
+    # @return [String]
+    def additional_ignore_tables
+      env_string_list = ENV.fetch('ADDITIONAL_IGNORE_TABLES', '').split ' '
+      cap_string_list = fetch(:additional_ignore_tables, '').split ' '
+      env_string_list | cap_string_list
+    end
+
+    # List of table names to be ignored when dumping from database
+    #
+    # @return [String]
+    def ignore_tables
+      default_ignore_tables | additional_ignore_tables
+    end
+
+    #####################################################
+    # Local temporary directory constants
+    #####################################################
+
+    # Archive filename as singleton
+    # Note: if the archive filename doesn't already exist it will be generated
+    #
+    # @return [String]
+    def archive_filename
+      @archive_filename ||= Dir::Tmpname.make_tmpname [application + '_', '.tar.gz'], nil
+    end
+
+    # Local temporary directory path as singleton
+    # Note: if the directory doesn't already exist it will be created
+    #
+    # @return [String]
+    def local_tmp_dir
+      @local_tmp_dir ||= Dir.mktmpdir
+    end
+
+    # Archive path in a local temporary directory
+    #
+    # @return [String]
+    def local_exclude_path
+      File.join local_tmp_dir, 'exclude.txt'
+    end
+
+    # Archive path in a local temporary directory
+    #
+    # @return [String]
+    def local_archive_path
+      File.join local_tmp_dir, archive_filename
+    end
+
+    #####################################################
+    # remote paths constants
+    #####################################################
+
+    # Remote temporary directory path
+    #
+    # @return [String]
+    def remote_tmp_dir
+      File.join fetch(:tmp_dir), application
+    end
+
+    # Archive path in a remote temporary directory
+    #
+    # @return [String]
+    def remote_archive_path
+      File.join remote_tmp_dir, archive_filename
+    end
+  end
+end

data/lib/dkdeploy/copy.rb

@@ -0,0 +1,121 @@
+require 'tmpdir'
+require 'capistrano/scm'
+require 'capistrano/i18n'
+require 'dkdeploy/i18n'
+require 'dkdeploy/constants'
+
+include Capistrano::DSL
+
+module Dkdeploy
+  # Class for the capistrano copy
+  #
+  class Copy
+    include Dkdeploy::Constants
+
+    # Provide a wrapper for the SCM that loads a strategy for the user.
+    #
+    # @param [Rake] context     The context in which the strategy should run
+    # @param [Module] strategy  A module to include into the SCM instance. The
+    #    module should provide the abstract methods of Capistrano::SCM
+    #
+    def initialize(context, strategy)
+      @context = context
+      singleton = class << self; self; end
+      singleton.send(:include, strategy)
+    end
+
+    # Default copy strategy
+    #
+    module DefaultStrategy
+      # Checks if the local source directory exists.
+      #
+      def check
+        # scope object for the processing in the block
+        me = self
+        run_locally do
+          unless Dir.exist? me.copy_source
+            fatal I18n.t('directory.not_exists', name: me.copy_source, scope: :dkdeploy)
+            exit 1
+          end
+        end
+      end
+
+      # Copies the source file structure to the server excluding the not wanted elements.
+      #
+      def release
+        build_source_archive
+        copy_archive_to_server
+        clean_up_temporary_sources
+      end
+
+      # Builds a tar archive in a temporary directory
+      # excluding files and folders matching the configured pattern.
+      #
+      def build_source_archive
+        # scope object for the processing in the block
+        me = self
+        run_locally do
+          info I18n.t('tasks.copy.archive.generate', scope: :dkdeploy)
+
+          # generate an exclude.txt file with the patterns to be excluded
+          File.open(me.local_exclude_path, 'w+') do |file|
+            me.copy_exclude.each do |pattern|
+              file.puts pattern
+            end
+          end
+
+          # build the tar archive excluding the patterns from exclude.txt
+          within me.copy_source do
+            execute :tar, '-X ' + me.local_exclude_path, '-cpzf', me.local_archive_path, '.'
+          end
+        end
+      end
+
+      # Copies the tar archive on the remote server
+      # extracting it to the configured directory.
+      #
+      def copy_archive_to_server # rubocop:disable Metrics/AbcSize
+        # scope object for the processing in the block
+        me = self
+        on release_roles :app do
+          info I18n.t('file.upload', file: 'archive', target: me.remote_tmp_dir, scope: :dkdeploy)
+          execute :mkdir, '-p', me.remote_tmp_dir
+
+          upload! me.local_archive_path, me.remote_tmp_dir
+
+          info I18n.t('directory.create', directory: release_path, scope: :dkdeploy)
+          execute :mkdir, '-p', release_path
+
+          within release_path do
+            info I18n.t('tasks.copy.archive.extract', target: release_path, scope: :dkdeploy)
+            execute :tar, '-xpzf', me.remote_archive_path
+          end
+        end
+      end
+
+      # Cleans up the local and remote temporary directories
+      #
+      def clean_up_temporary_sources
+        # scope object for the processing in the block
+        me = self
+
+        # remove the local temporary directory
+        run_locally do
+          info I18n.t('file.remove', path: me.local_tmp_dir, scope: :dkdeploy)
+          execute :rm, '-rf', me.local_tmp_dir
+        end
+
+        # removes the remote archive
+        on release_roles :app do
+          info I18n.t('file.remove', path: me.remote_archive_path, scope: :dkdeploy)
+          execute :rm, '-f', me.remote_archive_path
+        end
+      end
+
+      # Fetches the current revision message
+      def fetch_revision
+        I18n.t('log.revision_log_message', copy_source: fetch(:copy_source), time: Time.now, scope: :dkdeploy)
+      end
+    end
+  end
+end