dkdeploy-core 9.0.0 → 9.3.0

data/dkdeploy-core.gemspec

@@ -1,4 +1,6 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'dkdeploy/core/version'
 
@@ -11,23 +13,23 @@ Gem::Specification.new do |spec|
   spec.description   = 'dkd basic deployment tasks and strategies'
   spec.summary       = 'dkd basic deployment tasks and strategies'
   spec.homepage      = 'https://github.com/dkdeploy/dkdeploy-core'
-  spec.required_ruby_version = '~> 2.2'
+  spec.required_ruby_version = '~> 2.5'
 
   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.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 'aruba', '~> 1.0'
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.5'
   spec.add_development_dependency 'cucumber', '~> 2.4'
-  spec.add_development_dependency 'rubocop', '~> 0.50.0'
-  spec.add_development_dependency 'aruba', '~> 0.14.1'
+  spec.add_development_dependency 'dkdeploy-test_environment', '~> 2.0'
   spec.add_development_dependency 'mysql2', '~> 0.3'
   spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_development_dependency 'dkdeploy-test_environment', '~> 2.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 0.86.0'
 
-  spec.add_dependency 'capistrano', '~> 3.9.0'
-  spec.add_dependency 'highline', '~> 1.7.1'
+  spec.add_dependency 'capistrano', '~> 3.14.1'
+  spec.add_dependency 'highline', '~> 2.0.3'
 end

data/features/assets.feature

@@ -37,7 +37,6 @@ Feature: Test tasks for namespace 'assets'
 		And I run `cap dev assets:add_htpasswd` interactively
 		And I type "dkd_test_user"
 		And I type "dkd_test_password"
-		And I close the stdin stream
 		Then the exit status should be 0
 		And a remote file named "shared_path/.htpasswd" should exist
 

data/features/file_access.feature

@@ -87,7 +87,7 @@ Feature: Test tasks for namespace 'file_permissions'
 		Given I extend the development capistrano configuration variable custom_file_access with value {app: {release_path: {catalog: {mode: 'u+rwx,g+rwx,o-wx'}, not_existing: {mode: 'u+rwx,g+rwx,o-wx'}}}}
 		And a remote directory named "releases_path/not_existing" should not exist
 		When I successfully run `cap dev file_access:set_custom_access`
-		Then the output should contain "The resource /var/www/dkdeploy/current/not_existing does not exist on host dkdeploy-core.dev"
+		Then the output should contain "The resource /var/www/dkdeploy/current/not_existing does not exist on host dkdeploy-core.test"
 		And the output should not contain "sudo chmod  u+rwx,g+rwx,o-wx /var/www/dkdeploy/current/not_existing"
 		And the output should contain "sudo chmod  u+rwx,g+rwx,o-wx /var/www/dkdeploy/current/catalog"
 
@@ -115,6 +115,6 @@ Feature: Test tasks for namespace 'file_permissions'
 		And I extend the development capistrano configuration variable selected_custom_file_access with value [:not_existing, :catalog]
 		And a remote directory named "releases_path/not_existing" should not exist
 		When I successfully run `cap dev file_access:set_selected_custom_access`
-		Then the output should contain "The resource /var/www/dkdeploy/current/not_existing does not exist on host dkdeploy-core.dev"
+		Then the output should contain "The resource /var/www/dkdeploy/current/not_existing does not exist on host dkdeploy-core.test"
 		And the output should not contain "sudo chmod -R u+rwx,g+rwx,o-wx /var/www/dkdeploy/current/not_existing"
 		And the output should contain "sudo chmod -R u+rwx,g+rwx,o-wx /var/www/dkdeploy/current/catalog"

data/features/mysql.feature

@@ -10,14 +10,14 @@ Feature: Test tasks for namespace 'mysql'
     And I successfully run `cap dev "db:update[temp,dkdeploy_core.sql.gz]"`
     And I successfully run `cap dev db:download_content`
     And I successfully run `cap dev mysql:download_slow_log`
-    Then a file named "temp/slow-queries.dev.dkdeploy-core.dev.log" should exist
+    Then a file named "temp/slow-queries.dev.dkdeploy-core.test.log" should exist
 
   Scenario: Downloading the MYSQL slow log analyze file
     When I successfully run `cap dev "db:upload_settings[127.0.0.1,3306,dkdeploy_core,root,ilikerandompasswords,utf8]"`
     And I successfully run `cap dev "db:update[temp,dkdeploy_core.sql.gz]"`
     And I successfully run `cap dev db:download_content`
     And I successfully run `cap dev mysql:analyze_download_slow_log`
-    Then a file named "temp/mysql_slow_log_analyze.dev.dkdeploy-core.dev.log" should exist
+    Then a file named "temp/mysql_slow_log_analyze.dev.dkdeploy-core.test.log" should exist
 
   Scenario: Clearing the MySQL slow log file
     When I successfully run `cap dev "db:upload_settings[127.0.0.1,3306,dkdeploy_core,root,ilikerandompasswords,utf8]"`

data/features/support/env.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dkdeploy/test_environment/application'
 
 ssh_config = {}
@@ -11,8 +13,8 @@ unless ssh_key_files.empty?
   }
 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' }
+TEST_APPLICATION = Dkdeploy::TestEnvironment::Application.new(File.expand_path('../..', __dir__), 'dkdeploy-core.test', ssh_config)
+TEST_APPLICATION.mysql_connection_settings = { host: 'dkdeploy-core.test', 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

data/features/utils.feature

@@ -28,10 +28,10 @@ Feature: Test tasks for namespace 'utils'
 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
+		Then a file named "temp/download_file.dkdeploy-core.test.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:
+		Given a file named "temp/download_file.dkdeploy-core.test.txt" with:
 		"""
 Local file content
 		"""
@@ -41,7 +41,7 @@ Local file content
 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:
+		Then the file "temp/download_file.dkdeploy-core.test.txt" should contain exactly:
 		"""
 Remote file content
 

data/lib/capistrano/dkdeploy/core.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 include Capistrano::DSL
 
 require 'dkdeploy/rollback_manager'
@@ -7,19 +9,18 @@ require 'dkdeploy/scm/copy'
 install_plugin Dkdeploy::SCM::Copy
 
 # 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__)
-load File.expand_path('../../../dkdeploy/tasks/mysql.rake', __FILE__)
+load File.expand_path('../../dkdeploy/tasks/deploy.rake', __dir__)
+load File.expand_path('../../dkdeploy/tasks/fail.rake', __dir__)
+load File.expand_path('../../dkdeploy/tasks/maintenance.rake', __dir__)
+load File.expand_path('../../dkdeploy/tasks/utils.rake', __dir__)
+load File.expand_path('../../dkdeploy/tasks/file_access.rake', __dir__)
+load File.expand_path('../../dkdeploy/tasks/assets.rake', __dir__)
+load File.expand_path('../../dkdeploy/tasks/apache.rake', __dir__)
+load File.expand_path('../../dkdeploy/tasks/project_version.rake', __dir__)
+load File.expand_path('../../dkdeploy/tasks/db.rake', __dir__)
+load File.expand_path('../../dkdeploy/tasks/enhanced_symlinks.rake', __dir__)
+load File.expand_path('../../dkdeploy/tasks/current_folder.rake', __dir__)
+load File.expand_path('../../dkdeploy/tasks/mysql.rake', __dir__)
 
 # Hook into symlink related tasks
 after 'deploy:check:linked_dirs', 'deploy:enhanced_symlinks:check:linked_dirs'
@@ -56,10 +57,6 @@ namespace :load do
     # 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, []
 

data/lib/dkdeploy.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'dkdeploy/core/version'

data/lib/dkdeploy/constants.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dkdeploy
   # Global static methods
   #

data/lib/dkdeploy/core/version.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Dkdeploy
   module Core
     # Class for version number
     #
     class Version
       MAJOR = 9
-      MINOR = 0
+      MINOR = 3
       PATCH = 0
 
       def self.to_s

data/lib/dkdeploy/dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dkdeploy
   # dsl api
   module DSL
@@ -6,15 +8,14 @@ module Dkdeploy
     # @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
+    def invoke_for_server(server, task, *args)
       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
+      invoke! task, *args
     ensure
       set :filter, backup_filter
       env.setup_filters

data/lib/dkdeploy/helpers/assets.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 include Capistrano::DSL
 
 module Dkdeploy

data/lib/dkdeploy/helpers/common.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'highline'
 
 module Dkdeploy

data/lib/dkdeploy/helpers/db.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 include Capistrano::DSL
@@ -7,7 +9,7 @@ module Dkdeploy
     # DB related helpers
     module DB
       def db_dump_file(infix = '')
-        date = DateTime.now.strftime(datetime_format)
+        date = Time.now.strftime(datetime_format)
         ['database', fetch(:stage), infix, date].join('-') << '.sql'
       end
 
@@ -22,12 +24,12 @@ module Dkdeploy
       def db_settings_hash
         {
           'database' => {
-            'host'     => fetch(:db_host),
-            'port'     => fetch(:db_port),
-            'name'     => fetch(:db_name),
+            'host' => fetch(:db_host),
+            'port' => fetch(:db_port),
+            'name' => fetch(:db_name),
             'username' => fetch(:db_username),
             'password' => fetch(:db_password),
-            'charset'  => fetch(:db_charset)
+            'charset' => fetch(:db_charset)
           }
         }
       end

data/lib/dkdeploy/helpers/file_system.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 include Capistrano::DSL
 
 module Dkdeploy
@@ -22,9 +24,8 @@ module Dkdeploy
       # @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
+        return context.capture :readlink, '-f', path if context.test " [ -L #{path} ] "
+
         path
       end
 
@@ -57,19 +58,13 @@ module Dkdeploy
         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
+        context.execute :chown, recursive, access_properties.fetch(:owner), resolved_path if access_properties.key?(:owner)
 
         # change group if set
-        if access_properties.key?(:group)
-          context.execute :chgrp, recursive, access_properties.fetch(:group), resolved_path
-        end
+        context.execute :chgrp, recursive, access_properties.fetch(:group), resolved_path if access_properties.key?(:group)
 
         # change mode if set
-        if access_properties.key?(:mode) # rubocop:disable Style/GuardClause
-          context.execute :chmod, recursive, access_properties.fetch(:mode), resolved_path
-        end
+        context.execute :chmod, recursive, access_properties.fetch(:mode), resolved_path if access_properties.key?(:mode)
       end
     end
   end

data/lib/dkdeploy/helpers/mysql.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 include Capistrano::DSL
 
 module Dkdeploy
@@ -9,6 +11,7 @@ module Dkdeploy
       # @return [Boolean]
       def slow_log_exists?(file_path)
         return true if !file_path.empty? && test("[ -f #{file_path} ]")
+
         error I18n.t('file.not_exists_or_not_accessible_on_host', file: file_path, host: server, scope: :dkdeploy)
         false
       end

data/lib/dkdeploy/i18n.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'i18n'
 
 en = {
@@ -42,11 +44,6 @@ en = {
       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)'
     },
@@ -94,10 +91,6 @@ en = {
       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.',
@@ -144,6 +137,4 @@ capistrano_i18n_overwritten = {
 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
+I18n.enforce_available_locales = true if I18n.respond_to?(:enforce_available_locales=)

data/lib/dkdeploy/interaction_handler/mysql.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dkdeploy
   module InteractionHandler
     # Interaction handler for mysql
@@ -26,8 +28,9 @@ module Dkdeploy
         else
           @mysql_error_seen = true if data =~ /.*ERROR.*/i
           return raise 'Unexpected data from stream. Can not send password to undefined stream' unless @mysql_error_seen
+
           # combine the multiple lines from error message. The fact that the error message will be shown multiple times is simply ignored
-          @return_message << data
+          @return_message += data
           message = 'Error on executing MySQL command! Response (error code) is: '
           SSHKit.config.output.send(:error, "#{message}\n         #{@return_message}")
           raise 'InteractionHandler caught a MySQL error'

data/lib/dkdeploy/interaction_handler/password.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dkdeploy
   module InteractionHandler
     # Interaction handler for password
@@ -20,7 +22,7 @@ module Dkdeploy
           channel.send_data("#{@password}\n")
         else
           channel.close
-          raise 'Unexpected data from stream. Can not send password to undefined stream'
+          raise 'Unexpected data from stream. Can not send password to undefined stream.'
         end
       end
     end

data/lib/dkdeploy/rollback_manager.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dkdeploy
   # The RollbackManager module is a mixin for managing rollback tasks.
   module RollbackManager

data/lib/dkdeploy/scm/copy.rake

@@ -1,5 +1,4 @@
-# This trick lets us access the copy plugin within `on` blocks.
-copy_plugin = self
+# frozen_string_literal: true
 
 namespace :copy do
   desc 'Check if all configuration variables and copy sources exist'
@@ -24,11 +23,11 @@ namespace :copy do
 
       # generate an exclude.txt file with the patterns to be excluded
       exclude_content = copy_exclude.join("\n")
-      File.write(copy_plugin.local_exclude_path, exclude_content)
+      File.write(local_exclude_path, exclude_content)
 
       # build the tar archive excluding the patterns from exclude.txt
       within copy_source do
-        execute :tar, '-X ' + copy_plugin.local_exclude_path, '-cpzf', copy_plugin.local_archive_path, '.'
+        execute :tar, '-X ' + local_exclude_path, '-cpzf', local_archive_path, '.'
       end
     end
   end
@@ -38,17 +37,17 @@ namespace :copy do
   #
   task :copy_archive_to_server do
     on release_roles :all do
-      info I18n.t('file.upload', file: 'archive', target: copy_plugin.remote_tmp_dir, scope: :dkdeploy)
-      execute :mkdir, '-p', copy_plugin.remote_tmp_dir
+      info I18n.t('file.upload', file: 'archive', target: remote_tmp_dir, scope: :dkdeploy)
+      execute :mkdir, '-p', remote_tmp_dir
 
-      upload! copy_plugin.local_archive_path, copy_plugin.remote_tmp_dir
+      upload! local_archive_path, 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', copy_plugin.remote_archive_path
+        execute :tar, '-xpzf', remote_archive_path
       end
     end
   end
@@ -58,14 +57,14 @@ namespace :copy do
   task :clean_up_temporary_sources do
     # remove the local temporary directory
     run_locally do
-      info I18n.t('file.remove', path: copy_plugin.local_tmp_dir, scope: :dkdeploy)
-      execute :rm, '-rf', copy_plugin.local_tmp_dir
+      info I18n.t('file.remove', path: fetch(:copy_local_tmp_dir), scope: :dkdeploy)
+      execute :rm, '-rf', fetch(:copy_local_tmp_dir)
     end
 
     # removes the remote temp path including the uploaded archive
     on release_roles :all do
-      info I18n.t('file.remove', path: copy_plugin.remote_archive_path, scope: :dkdeploy)
-      execute :rm, '-rf', copy_plugin.remote_tmp_dir
+      info I18n.t('file.remove', path: remote_archive_path, scope: :dkdeploy)
+      execute :rm, '-rf', remote_archive_path
     end
   end
 
@@ -73,4 +72,32 @@ namespace :copy do
   task :set_current_revision do
     set :current_revision, I18n.t('log.revision_log_message', copy_source: fetch(:copy_source), time: Time.now, scope: :dkdeploy)
   end
+
+  # Archive path in a local temporary directory
+  #
+  # @return [String]
+  def local_exclude_path
+    File.join fetch(:copy_local_tmp_dir), 'exclude.txt'
+  end
+
+  # Archive path in a local temporary directory
+  #
+  # @return [String]
+  def local_archive_path
+    File.join fetch(:copy_local_tmp_dir), fetch(:copy_archive_filename)
+  end
+
+  # 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, fetch(:copy_archive_filename)
+  end
 end