capistrano-ops 0.2.13 → 1.0.0

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

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+namespace :logs do
+  include Capistrano::Ops::Logs::Paths
+  include Capistrano::Ops::Logs::Helpers
+
+  desc 'Tail Rails info logs'
+  task 'sidekiq:info' do
+    on roles(fetch(:rake_roles, :app)) do
+      trap_interrupt
+
+      execute "tail -f #{sidekiq_log_file_path}" do |_channel, stream, data|
+        puts data
+        break if stream == :err
+      end
+    end
+  end
+
+  desc 'Tail Sidekiq error logs'
+  task 'sidekiq:errors' do
+    on roles(fetch(:rake_roles, :app)) do
+      trap_interrupt
+
+      execute "tail -f #{sidekiq_error_log_file_path}" do |_channel, stream, data|
+        puts data
+        break if stream == :err
+      end
+    end
+  end
+
+  desc 'Tail all Sidekiq logs'
+  task :sidekiq do
+    on roles(fetch(:rake_roles, :app)) do
+      trap_interrupt
+
+      execute "tail -f #{sidekiq_log_file_path} & tail -f #{sidekiq_error_log_file_path}" do |_channel, stream, data|
+        puts data
+        break if stream == :err
+      end
+    end
+  end
+end

data/lib/capistrano/ops/logs.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'capistrano/ops/helper'
+require 'capistrano/ops/logs/paths'
+require 'capistrano/ops/logs/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('rails', 'logs/tasks', 'WARNING: Gemfile does not include rails gem which is required for logs tasks')

data/lib/capistrano/ops/{backup → rails/lib/backup}/s3.rb

@@ -2,7 +2,7 @@
 
 module Backup
   require 'aws-sdk-s3'
-  require 'capistrano/ops/backup/s3_helper'
+  require 'capistrano/ops/rails/lib/backup/s3_helper'
   class S3
     include Backup::S3Helper
     attr_accessor :endpoint, :region, :access_key_id, :secret_access_key, :s3_resource

data/lib/capistrano/ops/rails/lib/backup.rb

@@ -0,0 +1,6 @@
+require 'capistrano/ops/rails/lib/backup/api'
+require 'capistrano/ops/rails/lib/backup/s3'
+
+module Backup
+  class Error < StandardError; end
+end

data/lib/capistrano/ops/rails/lib/notification.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'capistrano/ops/rails/lib/notification/api'
+require 'capistrano/ops/rails/lib/notification/slack'
+require 'capistrano/ops/rails/lib/notification/webhook'
+
+module Notification
+  class Error < StandardError; end
+end

data/lib/capistrano/ops/rails/lib/railtie.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails'
+# require 'capistrano/ops'
+module Capistrano
+  module Ops
+    module Libs
+      class Railtie < ::Rails::Railtie
+        railtie_name :ops
+        rake_tasks do
+          path = File.expand_path(__dir__)
+          Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/ops/{tasks → rails/lib/tasks}/pg/postgres_helper.rb

@@ -54,7 +54,7 @@ module PostgresHelper
     commandlist = []
     commandlist << "export PGPASSWORD='#{@password}'"
     commandlist << "cd #{@backup_path}"
-    commandlist << "pg_dump -Fc #{options.join('')} > #{@filename}"
+    commandlist << "pg_dump --no-acl --no-owner #{options.join('')} > #{@filename}"
     commandlist.join(' && ')
   end
 

data/lib/capistrano/ops/version.rb

@@ -2,6 +2,6 @@
 
 module Capistrano
   module Ops
-    VERSION = '0.2.13'
+    VERSION = '1.0.0'
   end
 end

data/lib/capistrano/ops/{capistrano/v3/tasks/whenever.rake → whenever/tasks/show_crontab.rake}

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
 namespace :whenever do
-  # Default to :app role
-  rake_roles = fetch(:rake_roles, :app)
   desc 'show crontab'
   task :show_crontab do
-    on roles(rake_roles) do
+    on roles(fetch(:rake_roles, :app)) do
       puts capture 'crontab -l'
     end
   end

data/lib/capistrano/ops/whenever.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'capistrano/ops/helper'
+
+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', 'whenever/tasks', 'WARNING: Gemfile does not include whenever gem which is required for logrotate tasks')

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Ops
+    module Helper
+      def binary_path
+        gem_path = capture(:bundle, 'show', 'wkhtmltopdf-binary').strip
+        "#{gem_path}/bin"
+      end
+
+      def gem_version
+        capture(:cat, 'config/initializers/wicked_pdf.rb').scan(/wkhtmltopdf_ubuntu_(\d+\.\d+)_amd64/).flatten.first
+      end
+
+      def binary_path_and_version
+        [binary_path, gem_version]
+      end
+
+      def file_existing?(file)
+        test("[ -f #{file} ]")
+      end
+
+      def right_permissions?(file)
+        test("[ $(stat -c '%a' #{file}) = '777' ]")
+      end
+
+      def check_file_and_permissions(binary_path, version)
+        binary_file = "#{binary_path}/wkhtmltopdf_ubuntu_#{version}_amd64"
+
+        if file_existing?(binary_file)
+          info('wkhtmltopdf binary already extracted')
+
+          if right_permissions?(binary_file)
+            info('wkhtmltopdf binary has already the right permissions')
+          else
+            info('adding right permissions to wkhtmltopdf binary')
+            execute("chmod 777 #{binary_file}")
+          end
+        else
+          info('extracting wkhtmltopdf binary')
+          # extract the binary but keep the gzip file
+          execute("cd #{binary_path} && gzip -dk  wkhtmltopdf_ubuntu_#{version}_amd64.gz")
+          # add execute permission to the binary
+          execute("chmod 777 #{binary_file}")
+        end
+        info('wkhtmltopdf setup finished')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+namespace :wkhtmltopdf do
+  include Capistrano::Ops::Wkhtmltopdf::Helpers
+  after 'deploy:symlink:release', 'wkhtmltopdf:setup'
+
+  desc 'unzip wkhtmltopdf if necessary'
+  task :setup do
+    on roles(:app) do
+      within release_path do
+        binary_path, version = binary_path_and_version
+        info("setup wkhtmltopdf version #{version}")
+        check_file_and_permissions(binary_path, version)
+      end
+    end
+  end
+end

data/lib/capistrano/ops/wkhtmltopdf.rb

@@ -1,3 +1,19 @@
 # frozen_string_literal: true
 
-load File.expand_path('capistrano/tasks/wkhtmltopdf.rake', __dir__)
+require 'capistrano/ops/helper'
+require 'capistrano/ops/wkhtmltopdf/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('wicked-pdf', 'wkhtmltopdf/tasks',
+                                     'WARNING: Gemfile does not include wkhtmltopdf-binary gem which is required for wkhtmltopdf tasks')

data/lib/capistrano/ops.rb

@@ -2,10 +2,11 @@
 
 module Capistrano
   module Ops
-    require 'capistrano/ops/backup'
-    require 'capistrano/ops/notification'
-    require 'capistrano/ops/railtie' if defined?(Rails)
+    require 'capistrano/ops/rails/lib/backup'
+    require 'capistrano/ops/rails/lib/notification'
+    require 'capistrano/ops/rails/lib/railtie' if defined?(Rails)
     require 'capistrano/ops/capistrano' if defined?(Capistrano::VERSION)
+
     def self.path
       Dir.pwd
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-ops
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 1.0.0
 platform: ruby
 authors:
 - Florian Crusius
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 2024-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.56.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.56.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
 description: A collection of devops tasks for rails applications
 email:
 - florian@zauberware.com
@@ -116,39 +144,68 @@ files:
 - capistrano-ops.gemspec
 - lib/capistrano/ops.rb
 - lib/capistrano/ops/backup.rb
-- lib/capistrano/ops/backup/api.rb
-- lib/capistrano/ops/backup/s3.rb
-- lib/capistrano/ops/backup/s3_helper.rb
+- lib/capistrano/ops/backup/helper.rb
+- lib/capistrano/ops/backup/tasks/database/create.rake
+- lib/capistrano/ops/backup/tasks/database/pull.rake
+- lib/capistrano/ops/backup/tasks/storage/create.rake
+- lib/capistrano/ops/backup/tasks/storage/pull.rake
 - lib/capistrano/ops/capistrano.rb
-- lib/capistrano/ops/capistrano/tasks/wkhtmltopdf.rake
 - lib/capistrano/ops/capistrano/v3/tasks/backup.rake
-- lib/capistrano/ops/capistrano/v3/tasks/backup/backup_helper.rb
-- lib/capistrano/ops/capistrano/v3/tasks/backup/database/create.rake
-- lib/capistrano/ops/capistrano/v3/tasks/backup/database/pull.rake
-- lib/capistrano/ops/capistrano/v3/tasks/backup/storage/create.rake
-- lib/capistrano/ops/capistrano/v3/tasks/backup/storage/pull.rake
-- lib/capistrano/ops/capistrano/v3/tasks/figaro_yml.rake
-- lib/capistrano/ops/capistrano/v3/tasks/invoke.rake
-- lib/capistrano/ops/capistrano/v3/tasks/logrotate/check.rake
-- lib/capistrano/ops/capistrano/v3/tasks/logrotate/disable.rake
-- lib/capistrano/ops/capistrano/v3/tasks/logrotate/enable.rake
-- lib/capistrano/ops/capistrano/v3/tasks/logrotate/logrotate_helper.rb
-- lib/capistrano/ops/capistrano/v3/tasks/logrotate/templates/logrotate.conf.erb
-- lib/capistrano/ops/capistrano/v3/tasks/logrotate/templates/schedule.rb.erb
-- lib/capistrano/ops/capistrano/v3/tasks/logs/rails.rake
-- lib/capistrano/ops/capistrano/v3/tasks/whenever.rake
-- lib/capistrano/ops/notification.rb
-- lib/capistrano/ops/notification/api.rb
-- lib/capistrano/ops/notification/slack.rb
-- lib/capistrano/ops/notification/webhook.rb
-- lib/capistrano/ops/railtie.rb
-- lib/capistrano/ops/tasks/pg/dump.rake
-- lib/capistrano/ops/tasks/pg/postgres_helper.rb
-- lib/capistrano/ops/tasks/pg/remove_old_dumps.rake
-- lib/capistrano/ops/tasks/storage/backup.rake
-- lib/capistrano/ops/tasks/storage/remove_old_backups.rake
+- lib/capistrano/ops/figaro_yml.rb
+- lib/capistrano/ops/figaro_yml/helpers.rb
+- lib/capistrano/ops/figaro_yml/paths.rb
+- lib/capistrano/ops/figaro_yml/tasks/backup.rake
+- lib/capistrano/ops/figaro_yml/tasks/check.rake
+- lib/capistrano/ops/figaro_yml/tasks/check_config_present.rake
+- lib/capistrano/ops/figaro_yml/tasks/check_figaro_file_exists.rake
+- lib/capistrano/ops/figaro_yml/tasks/check_git_tracking.rake
+- lib/capistrano/ops/figaro_yml/tasks/compare.rake
+- lib/capistrano/ops/figaro_yml/tasks/create_local.rake
+- lib/capistrano/ops/figaro_yml/tasks/figaro_yml_symlink.rake
+- lib/capistrano/ops/figaro_yml/tasks/get.rake
+- lib/capistrano/ops/figaro_yml/tasks/get_stage.rake
+- lib/capistrano/ops/figaro_yml/tasks/load.rake
+- lib/capistrano/ops/figaro_yml/tasks/rollback.rake
+- lib/capistrano/ops/figaro_yml/tasks/setup.rake
+- lib/capistrano/ops/figaro_yml/tasks/sort_local.rake
+- lib/capistrano/ops/helper.rb
+- lib/capistrano/ops/invoke.rb
+- lib/capistrano/ops/invoke/tasks/invoke.rake
+- lib/capistrano/ops/logrotate.rb
+- lib/capistrano/ops/logrotate/helpers.rb
+- lib/capistrano/ops/logrotate/paths.rb
+- lib/capistrano/ops/logrotate/tasks/check.rake
+- lib/capistrano/ops/logrotate/tasks/disable.rake
+- lib/capistrano/ops/logrotate/tasks/enable.rake
+- lib/capistrano/ops/logrotate/tasks/load.rake
+- lib/capistrano/ops/logrotate/tasks/templates/logrotate.conf.erb
+- lib/capistrano/ops/logrotate/tasks/templates/schedule.rb.erb
+- lib/capistrano/ops/logs.rb
+- lib/capistrano/ops/logs/helpers.rb
+- lib/capistrano/ops/logs/paths.rb
+- lib/capistrano/ops/logs/tasks/load.rake
+- lib/capistrano/ops/logs/tasks/rails.rake
+- lib/capistrano/ops/logs/tasks/sidekiq.rake
+- lib/capistrano/ops/rails/lib/backup.rb
+- lib/capistrano/ops/rails/lib/backup/api.rb
+- lib/capistrano/ops/rails/lib/backup/s3.rb
+- lib/capistrano/ops/rails/lib/backup/s3_helper.rb
+- lib/capistrano/ops/rails/lib/notification.rb
+- lib/capistrano/ops/rails/lib/notification/api.rb
+- lib/capistrano/ops/rails/lib/notification/slack.rb
+- lib/capistrano/ops/rails/lib/notification/webhook.rb
+- lib/capistrano/ops/rails/lib/railtie.rb
+- lib/capistrano/ops/rails/lib/tasks/pg/dump.rake
+- lib/capistrano/ops/rails/lib/tasks/pg/postgres_helper.rb
+- lib/capistrano/ops/rails/lib/tasks/pg/remove_old_dumps.rake
+- lib/capistrano/ops/rails/lib/tasks/storage/backup.rake
+- lib/capistrano/ops/rails/lib/tasks/storage/remove_old_backups.rake
 - lib/capistrano/ops/version.rb
+- lib/capistrano/ops/whenever.rb
+- lib/capistrano/ops/whenever/tasks/show_crontab.rake
 - lib/capistrano/ops/wkhtmltopdf.rb
+- lib/capistrano/ops/wkhtmltopdf/helpers.rb
+- lib/capistrano/ops/wkhtmltopdf/tasks/setup.rake
 homepage: https://github.com/zauberware/capistrano-ops
 licenses:
 - MIT