capistrano-ops 0.2.14 → 1.0.0

data/lib/capistrano/ops/figaro_yml/paths.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Capistrano
+  module Ops
+    module FigaroYml
+      module Paths
+        def figaro_yml_local_path
+          Pathname.new fetch(:figaro_yml_local_path)
+        end
+
+        def figaro_yml_remote_path
+          shared_path.join fetch(:figaro_yml_remote_path)
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/ops/figaro_yml/tasks/backup.rake

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+namespace :figaro_yml do
+  include Capistrano::Ops::FigaroYml::Helpers
+
+  task :backup do
+    on release_roles :all do
+      unless remote_file_exists?
+        puts 'No remote application.yml to backup.'
+        next
+      end
+
+      begin
+        puts 'Creating backup of remote application.yml...'
+        create_remote_backup
+        puts 'Backup created successfully.'
+
+        puts 'Cleaning up remote backups...'
+        cleanup_remote_backups
+        puts 'Remote backups cleaned up successfully.'
+      rescue StandardError => e
+        puts "Error during backup process: #{e.message}"
+      end
+    end
+  end
+end

data/lib/capistrano/ops/figaro_yml/tasks/check.rake

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+namespace :figaro_yml do
+  include Capistrano::Ops::FigaroYml::Paths
+  include Capistrano::Ops::FigaroYml::Helpers
+  desc 'figaro `application.yml` file checks'
+  task :check do
+    invoke 'figaro_yml:check_figaro_file_exists'
+    invoke 'figaro_yml:check_git_tracking'
+    invoke 'figaro_yml:check_config_present'
+  end
+end

data/lib/capistrano/ops/figaro_yml/tasks/check_config_present.rake

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+namespace :figaro_yml do
+  include Capistrano::Ops::FigaroYml::Paths
+  include Capistrano::Ops::FigaroYml::Helpers
+  task :check_config_present do
+    next unless local_figaro_yml(figaro_yml_env).nil?
+
+    check_config_present_error
+    exit 1
+  end
+end

data/lib/capistrano/ops/figaro_yml/tasks/check_figaro_file_exists.rake

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+namespace :figaro_yml do
+  include Capistrano::Ops::FigaroYml::Paths
+  include Capistrano::Ops::FigaroYml::Helpers
+  task :check_figaro_file_exists do
+    next if File.exist?(figaro_yml_local_path)
+
+    check_figaro_file_exists_error
+    exit 1
+  end
+end

data/lib/capistrano/ops/figaro_yml/tasks/check_git_tracking.rake

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+namespace :figaro_yml do
+  include Capistrano::Ops::FigaroYml::Paths
+  include Capistrano::Ops::FigaroYml::Helpers
+  task :check_git_tracking do
+    next unless system("git ls-files #{fetch(:figaro_yml_local_path)} --error-unmatch >/dev/null 2>&1")
+
+    check_git_tracking_error
+    exit 1
+  end
+end

data/lib/capistrano/ops/{capistrano/v3/tasks/figaro_yml → figaro_yml/tasks}/compare.rake

@@ -1,39 +1,30 @@
 # frozen_string_literal: true
 
-require_relative 'figaro_yaml_helper'
-
 namespace :figaro_yml do
-  include FigaroYmlHelper
-  rake_roles = fetch(:rake_roles, :app)
+  include Capistrano::Ops::FigaroYml::Paths
+  include Capistrano::Ops::FigaroYml::Helpers
 
   desc 'compare and set the figaro_yml file on the server'
   task :compare do
-    env = fetch(:stage).to_s
     # Read and parse local application.yml
-    local = local_yaml
+    local = local_figaro_yml(figaro_yml_env)
 
     # Split into stage-specific and global configurations
-    local_global_env, local_stage_env = configs(local, env)
+    local_global_env, local_stage_env = configs(local, figaro_yml_env)
 
-    # puts local_global_env.to_yaml
-    # puts "\n\n\n"
-    # puts({ env => local_stage_env }.to_yaml)
-    on roles(rake_roles) do
+    on release_roles :all do
       # Read and parse remote application.yml
-      remote = YAML.safe_load(capture("cat #{shared_path}/config/application.yml"))
-      remote_global_env, remote_stage_env = configs(remote, env)
-
-      # puts remote_global_env.to_yaml
-      # puts "\n\n\n"
-      # puts({ env => remote_stage_env }.to_yaml)
-      # puts "Comparing local and remote application.yml for '#{env}' environment..."
+      remote = YAML.safe_load(capture("cat #{figaro_yml_remote_path}"))
+      remote_global_env, remote_stage_env = configs(remote, figaro_yml_env)
 
       # Compare hashes and handle nil results with empty hashes
       differences_global = compare_hashes(local_global_env, remote_global_env)
       differences_stage = compare_hashes(local_stage_env, remote_stage_env)
 
       print_changes(differences_global, 'Local application.yml has extra/different global entries compared to remote.')
-      print_changes(differences_stage, "Local application.yml has extra/different entries in #{env} section compared to remote.") if differences_stage
+      if differences_stage
+        print_changes(differences_stage, "Local application.yml has extra/different entries in #{figaro_yml_env} section compared to remote.")
+      end
 
       puts 'No Differences found between remote and local application.yml' unless differences_global || differences_stage
 

data/lib/capistrano/ops/figaro_yml/tasks/create_local.rake

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+namespace :figaro_yml do
+  include Capistrano::Ops::FigaroYml::Paths
+  include Capistrano::Ops::FigaroYml::Helpers
+  task :create_local do
+    run_locally do
+      puts "found #{stages.count} stages"
+      yamls_combined = {}
+
+      stages.each do |f|
+        stage = File.basename(f, '.rb')
+        puts "download #{stage} application.yml"
+        begin
+          res = capture "cap #{stage} figaro_yml:get_stage"
+          stage_yaml = YAML.safe_load(res)
+          stage_yaml[stage.to_s] = stage_yaml[stage.to_s].sort.to_h
+          yamls_combined.merge!(stage_yaml) if stage_yaml
+        rescue StandardError
+          puts "could not get #{stage} application.yml"
+        end
+      end
+
+      write_combined_yaml(yamls_combined.sort.to_h)
+    end
+  end
+end

data/lib/capistrano/ops/figaro_yml/tasks/figaro_yml_symlink.rake

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+namespace :figaro_yml do
+  include Capistrano::Ops::FigaroYml::Paths
+  include Capistrano::Ops::FigaroYml::Helpers
+  task :figaro_yml_symlink do
+    set :linked_files, fetch(:linked_files, []).push(fetch(:figaro_yml_remote_path))
+  end
+  after 'deploy:started', 'figaro_yml:figaro_yml_symlink'
+end

data/lib/capistrano/ops/figaro_yml/tasks/get.rake

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+namespace :figaro_yml do
+  include Capistrano::Ops::FigaroYml::Paths
+  include Capistrano::Ops::FigaroYml::Helpers
+  task :get do
+    if !File.exist?(figaro_yml_local_path)
+      invoke 'figaro_yml:create_local'
+    else
+      local_yml = local_figaro_yml(figaro_yml_env)
+      local_global, local_stage = configs(local_yml, figaro_yml_env)
+      on release_roles :all do
+        remote = capture "cat #{figaro_yml_remote_path}"
+        remote_yml = YAML.safe_load(remote).sort.to_h
+        remote_global, remote_stage = configs(remote_yml, figaro_yml_env)
+        differences_global = compare_hashes(remote_global, local_global || {})
+        differences_stage = compare_hashes(remote_stage, local_stage || {})
+
+        print_changes(differences_global,
+                      'Remote application.yml has extra/different global entries compared to local.')
+        if differences_stage
+          print_changes(differences_stage, "Remote application.yml has extra/different entries in #{figaro_yml_env} section compared to local.")
+        end
+
+        puts 'No Differences found between remote and local application.yml' unless differences_global || differences_stage
+
+        # ask to overwrite local yml if differences found
+        stage_overwrite = ask_to_overwrite("Overwrite local application.yml #{figaro_yml_env} section") if differences_stage
+        global_overwrite = ask_to_overwrite('Overwrite local application.yml globals') if differences_global
+        puts 'Nothing written to local application.yml' unless stage_overwrite || global_overwrite
+        exit unless stage_overwrite || global_overwrite
+
+        # compose new yml
+        composed_yml = {}
+        composed_yml.merge!(local_yml) # local yml is always included to avoid losing any data
+        composed_yml.merge!(local_global) unless global_overwrite
+        composed_yml.merge!(remote_global) if global_overwrite
+        composed_yml[figaro_yml_env.to_s] = stage_overwrite ? remote_stage : local_stage
+
+        # write to new file
+        write_combined_yaml(composed_yml.sort.to_h)
+      end
+    end
+  end
+end

data/lib/capistrano/ops/figaro_yml/tasks/get_stage.rake

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+namespace :figaro_yml do
+  include Capistrano::Ops::FigaroYml::Paths
+  include Capistrano::Ops::FigaroYml::Helpers
+  rake_roles = fetch(:rake_roles, :app)
+
+  task :get_stage do
+    on roles(rake_roles) do
+      raise 'The file does not exist.' unless test "[ -f #{figaro_yml_remote_path} ]"
+
+      puts capture "cat #{figaro_yml_remote_path}"
+    end
+  end
+end

data/lib/capistrano/ops/figaro_yml/tasks/load.rake

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+namespace :load do
+  task :defaults do
+    set :figaro_yml_local_path, 'config/application.yml'
+    set :figaro_yml_remote_path, 'config/application.yml'
+    set :figaro_yml_env, -> { fetch(:rails_env) || fetch(:stage) }
+    set :figaro_yml_remote_backup, false
+  end
+end

data/lib/capistrano/ops/figaro_yml/tasks/rollback.rake

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+namespace :figaro_yml do
+  include Capistrano::Ops::FigaroYml::Helpers
+
+  task :rollback do
+    on release_roles :all do
+      unless remote_backup_exists?
+        puts 'No backup of remote application.yml to rollback.'
+        next
+      end
+
+      begin
+        puts 'Rolling back remote application.yml...'
+        rollback_remote_backup
+        puts 'Rollback completed successfully.'
+      rescue StandardError => e
+        puts "Error during rollback process: #{e.message}"
+      end
+    end
+  end
+end

data/lib/capistrano/ops/figaro_yml/tasks/setup.rake

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+namespace :figaro_yml do
+  include Capistrano::Ops::FigaroYml::Paths
+  include Capistrano::Ops::FigaroYml::Helpers
+
+  desc 'Setup figaro `application.yml` file on the server(s)'
+  task setup: [:check] do
+    content = figaro_yml_content
+    on release_roles :all do
+      execute :mkdir, '-pv', File.dirname(figaro_yml_remote_path)
+      upload! StringIO.new(content), figaro_yml_remote_path
+    end
+  end
+  before 'figaro_yml:setup', 'figaro_yml:backup'
+end

data/lib/capistrano/ops/{capistrano/v3/tasks/figaro_yml → figaro_yml/tasks}/sort_local.rake

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'figaro_yaml_helper'
-
 namespace :figaro_yml do
-  include FigaroYmlHelper
-
+  include Capistrano::Ops::FigaroYml::Paths
+  include Capistrano::Ops::FigaroYml::Helpers
   task :sort_local do
     run_locally do
       info 'Sorting local application.yml...'

data/lib/capistrano/ops/figaro_yml.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'capistrano/ops/helper'
+require 'capistrano/ops/figaro_yml/paths'
+require 'capistrano/ops/figaro_yml/helpers'
+
+module TaskLoader
+  extend Capistrano::Ops::Helper
+
+  def self.load_tasks_if_gem_present(gem_name, task_path, warning_message)
+    if gem_in_gemfile?(gem_name)
+      Dir.glob("#{File.expand_path(__dir__)}/#{task_path}/**/*.rake").each { |f| load f }
+    else
+      puts warning_message
+    end
+  end
+end
+
+TaskLoader.load_tasks_if_gem_present('figaro', 'figaro_yml/tasks', 'WARNING: Gemfile does not include figaro gem which is required for figaro_yml tasks')
+# include Capistrano::Ops::Helper
+
+# Dir.glob("#{File.expand_path(__dir__)}/figaro_yml/tasks/*.rake").each { |f| load f }
+
+# # gem 'figaro' is required for figaro_yml tasks
+
+# figaro_gem = gem_in_gemfile?('figaro')
+
+# # check if Gemfile environment includes figaro gem and warn user if not found
+# puts 'WARNING: Gemfile does not include figaro gem which is required for figaro_yml tasks' unless figaro_gem

data/lib/capistrano/ops/helper.rb

@@ -0,0 +1,14 @@
+module Capistrano
+  module Ops
+    module Helper
+      def gem_in_gemfile?(gem_name)
+        if File.exist?('Gemfile')
+          File.foreach('Gemfile') do |line|
+            return true if line.include?('gem') && line.include?("'#{gem_name}'") && !line.include?('#')
+          end
+        end
+        false
+      end
+    end
+  end
+end

data/lib/capistrano/ops/invoke/tasks/invoke.rake

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+namespace :invoke do
+  # Defalut to :app roles
+  rake_roles = fetch(:rake_roles, :app)
+
+  desc 'Execute a rake task on a remote server (cap invoke:rake TASK=db:migrate)'
+  task :rake do
+    task_name = ENV['TASK']
+    unless task_name
+      puts "\n\nFailed! You need to specify the 'TASK' parameter!",
+           'Usage: cap <stage> invoke:rake TASK=your:task',
+           'Example: cap production invoke:rake TASK=db:migrate'
+      exit 1
+    end
+
+    on roles(rake_roles) do
+      within current_path do
+        with rails_env: fetch(:rails_env) do
+          execute :rake, task_name
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/ops/invoke.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Dir.glob("#{File.expand_path(__dir__)}/invoke/tasks/**/*.rake").each { |f| load f }

data/lib/capistrano/ops/logrotate/helpers.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Ops
+    module Logrotate
+      module Helpers
+        def config_template
+          return nil unless File.exist?(File.expand_path(logrotate_config_file_template, __dir__))
+
+          ERB.new(File.read(File.expand_path(logrotate_config_file_template, __dir__))).result(binding)
+        end
+
+        def schedule_template
+          return nil unless File.exist?(File.expand_path(logrotate_schedule_file_template, __dir__))
+
+          ERB.new(File.read(File.expand_path(logrotate_schedule_file_template, __dir__))).result(binding)
+        end
+
+        def logrotate_enabled
+          test("[ -f #{logrotate_config_file_path} ]") && test("[ -f #{logrotate_schedule_file_path} ]")
+        end
+
+        def logrotate_disabled
+          !(test("[ -f #{logrotate_config_file_path} ]") && test("[ -f #{logrotate_schedule_file_path} ]"))
+        end
+
+        def make_basepath
+          puts capture "mkdir -pv #{logrotate_basepath}"
+        end
+
+        def delete_files
+          puts capture "rm -rfv #{logrotate_basepath}"
+        end
+
+        def whenever(type)
+          case type
+          when 'clear'
+            puts capture :bundle, :exec, :whenever, '--clear-crontab',
+                         "-f #{logrotate_schedule_file_path} #{fetch(:whenever_identifier)}_logrotate"
+          when 'update'
+            puts capture :bundle, :exec, :whenever, '--update-crontab', "-f #{logrotate_schedule_file_path}",
+                         "-i #{fetch(:whenever_identifier)}_logrotate"
+          else
+            puts 'type not found'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/ops/logrotate/paths.rb

@@ -0,0 +1,47 @@
+require 'pathname'
+
+module Capistrano
+  module Ops
+    module Logrotate
+      module Paths
+        # local paths
+        def logrotate_config_file_template
+          Pathname.new fetch(:logrotate_config_file_template)
+        end
+
+        def logrotate_schedule_file_template
+          Pathname.new fetch(:logrotate_schedule_file_template)
+        end
+
+        # remote paths
+        def logrotate_basepath
+          shared_path.join fetch(:logrotate_basepath)
+        end
+
+        def logrotate_config_path
+          shared_path.join fetch(:logrotate_config_path)
+        end
+
+        def logrotate_config_file_path
+          logrotate_basepath.join logrotate_config_filename
+        end
+
+        def logrotate_schedule_file_path
+          logrotate_basepath.join logrotate_schedule_filename
+        end
+
+        def log_file_path
+          shared_path.join fetch(:log_file_path)
+        end
+
+        def logrotate_schedule_filename
+          File.basename(logrotate_schedule_file_template, '.erb')
+        end
+
+        def logrotate_config_filename
+          File.basename(logrotate_config_file_template, '.erb')
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/ops/{capistrano/v3/tasks/logrotate → logrotate/tasks}/check.rake

@@ -1,18 +1,16 @@
 # frozen_string_literal: true
 
-require_relative 'logrotate_helper'
-
 namespace :logrotate do
-  include LogrotateHelper
+  include Capistrano::Ops::Logrotate::Helpers
+  include Capistrano::Ops::Logrotate::Paths
 
   desc 'show logrotate state and config'
   task :check do
     on roles(:app) do
       within release_path do
-        set_config
         if logrotate_enabled
           puts "logrotate running with config\n========================="
-          puts capture "cat #{@config_file_path}"
+          puts capture "cat #{logrotate_config_file_path}"
         else
           puts 'logrotate disabled'
         end

data/lib/capistrano/ops/{capistrano/v3/tasks/logrotate → logrotate/tasks}/disable.rake

@@ -1,15 +1,12 @@
 # frozen_string_literal: true
 
-require_relative 'logrotate_helper'
-
 namespace :logrotate do
-  include LogrotateHelper
-
+  include Capistrano::Ops::Logrotate::Paths
+  include Capistrano::Ops::Logrotate::Helpers
   desc 'disable logrotate'
   task :disable do
     on roles(:app) do
       within release_path do
-        set_config
         if logrotate_disabled
           puts 'logrotate already disabled'
         else

data/lib/capistrano/ops/logrotate/tasks/enable.rake

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+namespace :logrotate do
+  include Capistrano::Ops::Logrotate::Helpers
+  include Capistrano::Ops::Logrotate::Paths
+
+  desc 'Enable logrotate for the application'
+  task :enable do
+    on roles(:app) do
+      within release_path do
+        @log_file_path = log_file_path
+        @shared_path = shared_path
+
+        if logrotate_enabled
+          puts "logrotate already enabled:\n========================="
+          puts capture "cat #{logrotate_config_file_path}"
+        else
+          puts config_template
+          puts schedule_template
+          make_basepath
+          upload! StringIO.new(config_template), logrotate_config_file_path
+          upload! StringIO.new(schedule_template), logrotate_schedule_file_path
+          whenever 'update' if logrotate_enabled
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/ops/logrotate/tasks/load.rake

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+namespace :load do
+  task :defaults do
+    set :logrotate_config_file_template, File.expand_path('templates/logrotate.conf.erb', __dir__)
+    set :logrotate_schedule_file_template, File.expand_path('templates/schedule.rb.erb', __dir__)
+    set :logrotate_basepath, 'logrotate'
+    set :log_file_path, 'log'
+  end
+end

data/lib/capistrano/ops/logrotate.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'capistrano/ops/helper'
+require 'capistrano/ops/logrotate/helpers'
+require 'capistrano/ops/logrotate/paths'
+
+module TaskLoader
+  extend Capistrano::Ops::Helper
+
+  def self.load_tasks_if_gem_present(gem_name, task_path, warning_message)
+    if gem_in_gemfile?(gem_name)
+      Dir.glob("#{File.expand_path(__dir__)}/#{task_path}/**/*.rake").each { |f| load f }
+    else
+      puts warning_message
+    end
+  end
+end
+
+TaskLoader.load_tasks_if_gem_present('whenever', 'logrotate/tasks', 'WARNING: Gemfile does not include whenever gem which is required for logrotate tasks')

data/lib/capistrano/ops/logs/helpers.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Ops
+    module Logs
+      module Helpers
+        def trap_interrupt
+          trap('INT') do
+            print "\rDisconnecting... Done.\n"
+            exit 0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/ops/logs/paths.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Capistrano
+  module Ops
+    module Logs
+      module Paths
+        def rails_log_file_path
+          shared_path.join fetch(:rails_log_file_name) || "log/#{fetch(:rails_env)}.log"
+        end
+
+        def sidekiq_log_file_path
+          shared_path.join fetch(:sidekiq_log_file_name) || 'log/sidekiq.log'
+        end
+
+        def sidekiq_error_log_file_path
+          shared_path.join fetch(:sidekiq_error_log_file_name) || 'log/sidekiq.error.log'
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/ops/logs/tasks/load.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+namespace :load do
+  task :defaults do
+    set :rails_log_file_name, nil
+    set :sidekiq_log_file_name, nil
+    set :sidekiq_error_log_file_name, nil
+  end
+end

data/lib/capistrano/ops/logs/tasks/rails.rake

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+namespace :logs do
+  include Capistrano::Ops::Logs::Paths
+  include Capistrano::Ops::Logs::Helpers
+
+  desc 'Tail Rails logs'
+  task :rails do
+    on roles(fetch(:rake_roles, :app)) do
+      trap_interrupt
+
+      execute "tail -f #{rails_log_file_path}" do |_channel, stream, data|
+        puts data
+        break if stream == :err
+      end
+    end
+  end
+end