dkdeploy-core 8.0.0

data/lib/dkdeploy/core/version.rb

@@ -0,0 +1,15 @@
+module Dkdeploy
+  module Core
+    # Class for version number
+    #
+    class Version
+      MAJOR = 8
+      MINOR = 0
+      PATCH = 0
+
+      def self.to_s
+        [MAJOR, MINOR, PATCH].join('.')
+      end
+    end
+  end
+end

data/lib/dkdeploy/dsl.rb

@@ -0,0 +1,23 @@
+module Dkdeploy
+  # TYPO3 dsl api
+  module DSL
+    # Execute a rake/capistrano task only for given server
+    #
+    # @param server [Capistrano::Configuration::Server] Server to execute task
+    # @param task [String] Name of rake/capistrano task
+    # @param args [Array] Arguments of rake/capistrano task
+    def invoke_for_server(server, task, *args) # rubocop:disable Metrics/AbcSize
+      backup_filter = fetch :filter, {}
+      new_server_filter = Marshal.load(Marshal.dump(backup_filter))
+      new_server_filter[:host] = server.hostname
+      set :filter, new_server_filter
+      env.setup_filters
+      info I18n.t('dsl.invoke_for_server.set_filter', task: task, host: server.hostname, scope: :dkdeploy)
+      invoke task, *args
+      Rake::Task[task].reenable
+    ensure
+      set :filter, backup_filter
+      env.setup_filters
+    end
+  end
+end

data/lib/dkdeploy/helpers/assets.rb

@@ -0,0 +1,50 @@
+include Capistrano::DSL
+include SSHKit::DSL
+
+module Dkdeploy
+  module Helpers
+    # Helpers for Assets Tasks
+    module Assets
+      def assets_upload(name, folder = File.join('temp', 'assets')) # rubocop:disable Metrics/AbcSize
+        FileUtils.mkdir_p folder
+        on release_roles :web do
+          targz = name + '.tar.gz'
+          info I18n.t('tasks.assets.upload', file: targz, scope: :dkdeploy)
+          execute :mkdir, '-p', assets_path
+          upload! File.join(folder, targz), assets_path
+          within assets_path do
+            info I18n.t('tasks.assets.upload_extract', file: targz, scope: :dkdeploy)
+            execute :tar, 'xzfp', targz
+            execute :rm, '-f', targz
+          end
+          invoke 'file_access:set_custom_access'
+        end
+      end
+
+      def assets_download(folder) # rubocop:disable Metrics/AbcSize
+        FileUtils.mkdir_p File.join('temp', 'assets')
+        assets_exclude_file = fetch(:asset_exclude_file) || ''
+        on release_roles :web do
+          if File.exist?(assets_exclude_file)
+            exclude_filename = File.basename(assets_exclude_file)
+            execute :rm, '-f', File.join(assets_path, exclude_filename)
+            upload! assets_exclude_file, assets_path
+            exclude_option = "-X #{File.join(assets_path, exclude_filename)}"
+          else
+            info I18n.t('tasks.assets.exclude_file_not_found', scope: :dkdeploy)
+          end
+          within assets_path do
+            if test "[ -d #{assets_path}/#{folder} ]"
+              info I18n.t('tasks.assets.download', folder: folder, scope: :dkdeploy)
+              execute :tar, 'czfp', "#{folder}.tar.gz", exclude_option || '', folder
+              download! File.join(assets_path, "#{folder}.tar.gz"), File.join('temp', 'assets')
+              execute :rm, '-f', "#{folder}.tar.gz"
+            else
+              info I18n.t('tasks.assets.folder_not_found', folder: folder, scope: :dkdeploy)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dkdeploy/helpers/common.rb

@@ -0,0 +1,31 @@
+require 'highline'
+
+module Dkdeploy
+  module Helpers
+    # common helpers, which are not task specific
+    module Common
+      def terminal
+        @terminal ||= HighLine.new
+      end
+
+      def ask_via_terminal(question_selector, &block)
+        question = I18n.t(question_selector, scope: :dkdeploy)
+        answer = terminal.ask(question, &block)
+        String.new(answer)
+      end
+
+      def ask_variable(args, variable_name_symbol, question_selector, &block)
+        ENV[variable_name_symbol.to_s.upcase] || args[variable_name_symbol] ||
+          fetch(variable_name_symbol) || ask_via_terminal(question_selector, &block)
+      end
+
+      def ask_array_variable(args, variable_name_symbol, question_selector, &block)
+        variable_content = ask_variable(args, variable_name_symbol, question_selector, &block)
+        return variable_content if variable_content.is_a?(Array)
+        return variable_content.split if variable_content.is_a?(String)
+
+        raise(I18n.t('errors.variable_content_is_neither_string_nor_array', variable_name: variable_name_symbol, scope: :dkdeploy))
+      end
+    end
+  end
+end

data/lib/dkdeploy/helpers/db.rb

@@ -0,0 +1,49 @@
+require 'yaml'
+
+include Capistrano::DSL
+
+module Dkdeploy
+  module Helpers
+    # DB related helpers
+    module DB
+      def db_dump_file(infix = '')
+        date = DateTime.now.strftime(datetime_format)
+        ['database', fetch(:stage), infix, date].join('-') << '.sql'
+      end
+
+      def db_dump_file_content(table_name = nil)
+        db_dump_file ['content', table_name].compact.join('-')
+      end
+
+      def db_dump_file_structure(table_name = nil)
+        db_dump_file ['structure', table_name].compact.join('-')
+      end
+
+      def db_settings_hash
+        {
+          'database' => {
+            'host'     => fetch(:db_host),
+            'port'     => fetch(:db_port),
+            'name'     => fetch(:db_name),
+            'username' => fetch(:db_username),
+            'password' => fetch(:db_password),
+            'charset'  => fetch(:db_charset)
+          }
+        }
+      end
+
+      # Read db settings for given context
+      #
+      # @param context [SSHKit::Backend::Netssh] SSHKit context
+      # @return [Hash] Hash with database settings
+      def read_db_settings_for_context(context)
+        unless context.test("[ -f #{remote_database_config_path} ]")
+          context.error I18n.t('errors.database_config_file_missing', scope: :dkdeploy)
+          return
+        end
+        json_string = context.download! remote_database_config_path
+        YAML.load(json_string).fetch('database')
+      end
+    end
+  end
+end

data/lib/dkdeploy/helpers/file_system.rb

@@ -0,0 +1,76 @@
+include Capistrano::DSL
+
+module Dkdeploy
+  module Helpers
+    # Class for the capistrano copy
+    #
+    module FileSystem
+      # Adds the absolute path prefix to the given relative path depending whether this needs to be in shared or release path.
+      #
+      # @param release_or_shared_path [Symbol] symbol of :shared_path or :release_path
+      # @param path [String] the relative path
+      # @return [String] absolute path
+      def map_path_in_release_or_shared_path(release_or_shared_path, path)
+        prefix_path = release_or_shared_path == :shared_path ? shared_path : release_path
+        prefix_path.join(path)
+      end
+
+      # Resolves the symlink path to its target, otherwise returns the path without any changing
+      # Note: the function can only be run within SSHKit context
+      #
+      # @param context [SSHKit::Backend::Netssh] SSHKit context
+      # @param path [String] path to resolve
+      # @return [String]
+      def resolve_path_if_symlink(context, path)
+        if context.test " [ -L #{path} ] "
+          return context.capture :readlink, '-f', path
+        end
+        path
+      end
+
+      # Iterates over the given paths' array, resolves symlinks and merges them together
+      # Example merge_paths_with_resolved_symlinks [p_1, symlink_1, p_2], 'dkdeploy-core.dev' -> [p_1, symlink_1, p_2, resolved_symlink_1]
+      # Note: the function can only be run within SSHKit context
+
+      # @param context [SSHKit::Backend::Netssh] SSHKit context
+      # @param paths [Array] array with paths to resolve
+      # @return [Array] the merged array with paths
+      def merge_paths_with_resolved_symlinks(context, *paths)
+        paths.each do |path|
+          resolved_path = resolve_path_if_symlink context, path
+          paths.push resolved_path unless paths.include? resolved_path
+        end
+        paths
+      end
+
+      # Applies file owner/group/mode permissions to path on host via Capistrano - optionally recursively
+      def apply_file_access_permissions(context, host, path, access_properties, force_recursive = false) # rubocop:disable Metrics/AbcSize
+        unless context.test " [ -e #{path} ] "
+          context.error I18n.t('resource.not_exists_on_host', resource: path, host: host.hostname, scope: :dkdeploy)
+          return
+        end
+
+        # if the access properties should be applied recursively
+        recursive = access_properties.fetch(:recursive, false) || force_recursive
+        recursive = recursive ? '-R' : ''
+
+        resolved_path = resolve_path_if_symlink(context, path)
+
+        # change owner if set
+        if access_properties.key?(:owner)
+          context.execute :chown, recursive, access_properties.fetch(:owner), resolved_path
+        end
+
+        # change group if set
+        if access_properties.key?(:group)
+          context.execute :chgrp, recursive, access_properties.fetch(:group), resolved_path
+        end
+
+        # change mode if set
+        if access_properties.key?(:mode) # rubocop:disable Style/GuardClause
+          context.execute :chmod, recursive, access_properties.fetch(:mode), resolved_path
+        end
+      end
+    end
+  end
+end

data/lib/dkdeploy/i18n.rb

@@ -0,0 +1,143 @@
+require 'i18n'
+
+en = {
+  file: {
+    not_exists: 'File %{file} does not exist.',
+    not_exists_on_host: 'File %{file} does not exit on host %{host}.',
+    upload: 'Uploading %{file} to %{target}.',
+    download: 'Downloading %{file} to %{target}.',
+    copy: 'Copying %{file} to %{target}.',
+    remove: 'Removing %{path}.'
+  },
+  directory: {
+    create: 'Creating directory %{directory}.',
+    not_exists: 'Directory %{directory} does not exist.',
+    not_exists_on_host: 'Directory %{directory} does not exit on host %{host}.'
+  },
+  dsl: {
+    invoke_for_server: {
+      set_filter: "Invoking task '%{task}' for server '%{host}'"
+    }
+  },
+  resource: {
+    not_exists_on_host: 'The resource %{resource} does not exist on host %{host}.',
+    empty_selected_custom_file_access: "The variable 'selected_custom_file_access' is empty. Aborting task...",
+    skipping_selected_custom_file_access: "Skipped setting custom_file_access permissions for '%{path}' because it is not mentioned in selected_custom_file_access!"
+  },
+  configuration: {
+    argument_missing: "The '%{name}' argument missing.",
+    argument_or_configuration_missing: "The '%{name}' argument or '%{variable}' configuration variable missing."
+  },
+  questions: {
+    database: {
+      host: 'Please enter the hostname/IP of the database server',
+      port: 'Please enter the port of the database server',
+      name: 'Please enter the database name',
+      username: 'Please enter the database username',
+      password: 'Please enter the database password',
+      table_name: 'Please enter the table name',
+      table_names: 'Please enter a list of table names (entries separated by spaces)',
+      charset: 'Please enter the database character set',
+      zipped_db_file: 'Please enter the name of the zipped SQL script file'
+    },
+    bower: {
+      command: 'Please enter the command you want to run',
+      path: 'Please enter the path to the bower.json file',
+      paths: 'Please enter the paths bower.json files (separated by spaces)'
+    },
+    selected_custom_file_access: {
+      paths: 'Please enter a list of paths (entries separated by spaces)'
+    },
+    path: 'Please enter a local path',
+    file_name: 'Please enter a file name',
+    username: 'Please enter a username',
+    password: 'Please enter a password',
+    compass_sources: 'Please enter compass sources (entries separated by spaces)',
+    compass_compile_arguments: 'Please enter compass compile arguments (entries separated by spaces)',
+    asset_folders: 'Please enter asset folders (entries separated by spaces)',
+    asset_default_content: 'Please enter asset default content (entries separated by spaces)',
+    local_web_root_path: 'Please enter a local web root path',
+    version_file_path: 'Please enter a version file path',
+    dir_names: 'Please specify the direcotory names you wish to create'
+  },
+  success: {
+    settings_uploaded: 'The given database settings have been uploaded'
+  },
+  errors: {
+    file_not_found: 'File not found.',
+    password_was_empty: 'Password was empty. Please enter a password.',
+    connection_failed: 'Connection to database could not be established',
+    database_config_file_missing: 'Unable to locate database config file on remote server.',
+    variable_content_is_neither_string_nor_array: "Error setting value of variable '%{variable_name}'. This is neither a (by space splittable) string nor an array!"
+  },
+  info: {
+    local_md5: 'Local MD5 hash: %{md5_hash}',
+    remote_md5: 'Remote MD5 hash: %{md5_hash}',
+    md5_match: 'Local MD5 hash matches remote MD5 hash. Nothing to do!',
+    ignoring_current_folder: 'Ignoring current folder because either it does not exist or it is symlinked.'
+  },
+  tasks: {
+    apache: {
+      htaccess: {
+        render: 'Rendering .htaccess file.'
+      }
+    },
+    assets: {
+      add_htpasswd: {
+        successfully_created: 'htpasswd file successfully created.'
+      },
+      cleanup: 'Cleaning folder %{folder}.',
+      download: 'Downloading %{folder}',
+      upload: 'Uploading %{file}',
+      upload_extract: 'Extracting %{file}',
+      exclude_file_not_found: "No exclude file found. To use set variable 'assets_exclude_file'"
+    },
+    bower: {
+      skipping_missing_directory: 'Skipping directory %{bower_path} because it does not exist.',
+      skipping_directory_with_missing_bower_file: 'Skipping directory %{bower_path} because it does not contain a bower.json file.'
+    },
+    copy: {
+      archive: {
+        generate: 'Generating the tar archive.',
+        extract: 'Extracting archive to %{target}.'
+      }
+    },
+    maintenance: {
+      enabled: 'The %{mode} maintenance mode has successfully been enabled.',
+      disabled: 'The %{mode} maintenance mode has successfully been disabled.',
+      can_not_disable_by_reason_of_permanent: "Maintenance permanent mode has been enabled. Please call the task 'maintenance:disable_permanent'."
+    },
+    project_version: {
+      update: {
+        update: 'Updating the Version file.'
+      }
+    },
+    utils: {
+      rsync: {
+        no_host: 'No hosts for rsync found. Please check configuration "rsync_roles".',
+        use_host: "Use host '%{host}' for rsync."
+      }
+    }
+  },
+  log: {
+    revision_log_message: "Local deployment for directory '%{copy_source}' at '%{time}'"
+  },
+  error_during_deployment: 'Error occurred at deployment. Rollback to old release',
+  rollback_tasks: "Calling tasks '%{tasks_for_rollback}' for rollback action",
+  failing_on_purpose: 'Failing this deployment on purpose!',
+  rollback_finished: 'Rollback finished',
+  keep_rollback_archives: 'Keeping %{keep_rollback_archives} of %{rollback_archives} rolled back releases on %{host}',
+  setting_verbosity: 'Setting verbosity level to: %{verbosity_level} (from: %{old_verbosity})',
+  resetting_verbosity: 'Reset verbosity level to: %{old_verbosity} (from: %{verbosity_level})'
+}
+
+capistrano_i18n_overwritten = {
+  revision_log_message: "%{sha} on release '%{release}' by '%{user}'"
+}
+
+I18n.backend.store_translations(:en, dkdeploy: en)
+I18n.backend.store_translations(:en, capistrano: capistrano_i18n_overwritten)
+
+if I18n.respond_to?(:enforce_available_locales=)
+  I18n.enforce_available_locales = true
+end

data/lib/dkdeploy/interaction_handler/password.rb

@@ -0,0 +1,27 @@
+module Dkdeploy
+  module InteractionHandler
+    # Interaction handler for password
+    #
+    # @attr [String] password The password to send to terminal
+    class Password
+      def initialize(password)
+        @password = password
+      end
+
+      # Method to send password to terminal
+      #
+      # @param [SSHKit::Command] _command
+      # @param [Symbol] _stream_name
+      # @param [String] data
+      # @param [Net::SSH::Connection::Channel] channel
+      def on_data(_command, _stream_name, data, channel)
+        if data =~ /.*password.*/i
+          channel.send_data("#{@password}\n")
+        else
+          channel.close
+          raise 'Unexpected data from stream. Can not send password to undefined stream'
+        end
+      end
+    end
+  end
+end

data/lib/dkdeploy/rollback_manager.rb

@@ -0,0 +1,18 @@
+module Dkdeploy
+  # The RollbackManager module is a mixin for managing rollback tasks.
+  module RollbackManager
+    # Getter for rollback_tasks
+    #
+    # @return [Array]
+    def rollback_tasks
+      @rollback_tasks ||= []
+    end
+
+    # Add new rollback task
+    #
+    # @param [String]
+    def add_rollback_task(task_name)
+      rollback_tasks << task_name if Rake::Task.task_defined? task_name
+    end
+  end
+end

data/lib/dkdeploy/tasks/apache.rake

@@ -0,0 +1,29 @@
+require 'erb'
+require 'capistrano/i18n'
+require 'dkdeploy/i18n'
+
+include Capistrano::DSL
+include SSHKit::DSL
+
+namespace :apache do
+  desc 'Render .htaccess to web root from erb template(s)'
+  task :htaccess do |_, args|
+    local_web_root_path = ask_array_variable(args, :local_web_root_path, 'questions.local_web_root_path')
+
+    run_locally do
+      apache_configuration_path = File.join 'config', 'etc', 'apache2', 'conf'
+      htaccess_file_path = File.join apache_configuration_path, '.htaccess.erb'
+      destination_htaccess_file_path = File.join local_web_root_path, '.htaccess'
+
+      if File.exist? htaccess_file_path
+        info I18n.t('tasks.apache.htaccess.render', scope: :dkdeploy)
+        htaccess_template = ERB.new File.read(htaccess_file_path)
+
+        # write the new htaccess file content to the target .htaccess file
+        File.open(destination_htaccess_file_path, 'w') do |io|
+          io.write htaccess_template.result(binding)
+        end
+      end
+    end
+  end
+end