capistrano-ops 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6897d38c35cb8b0dfb713d16d0eb0c390c431636ea5c6565e1dc457b96a29c6b
-  data.tar.gz: 9789f0e37f0767403324c1ca68c97759a8ebdbdb5a3e4ac6d362b76dfc5064ad
+  metadata.gz: 1ddab185886973237cac8aab6671b9bb580d5496f72e37f0678b6b0dd794c78a
+  data.tar.gz: 4c12ffe04071978d364f6a02b5d0cfd3a0e651a8669b86c00e2445c1830bc74b
 SHA512:
-  metadata.gz: 4607175b27284ed6d19ca2fe3032dccde17f54cb62dfbfc43c614af031abf9990b873b89b1d905c74d2acb48dc4e94a3eec6b50bbff18dee0079b2a5264d04dd
-  data.tar.gz: 1ce1060464559ce566320e9ef7a1700d5d94ee688e6f8aea85f7dbd2548e78bfc5e6cb1f5e751b38e9b566e7411e89587d4207eb6c0349592d0cacab854e6ffc
+  metadata.gz: 36dc0e5814ab7ff1b7370b366cf8dce0f8c4092f300319c7d2f936c554455ad7bd1edb5e519c80157515f0590d55ca4f995f9dbbadcd72d7803040e7c4ffb5bd
+  data.tar.gz: e2a9c85b8a361cca26a84bdade6500d31f8ab63e3f792e002dd7db5b3949779eb9fbfe5fccad7496fc4baff6baa7dbb3c6921e933ca7dd11a3f3ba61ca83bec0

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

@@ -3,7 +3,7 @@
 module Backup
   require 'aws-sdk-s3'
   class S3
-    attr_accessor :endpoint, :region, :access_key_id, :secret_access_key, :s3_client
+    attr_accessor :endpoint, :region, :access_key_id, :secret_access_key, :s3_resource
 
     def initialize(endpoint: ENV['S3_BACKUP_ENDPOINT'], region: ENV['S3_BACKUP_REGION'], access_key_id: ENV['S3_BACKUP_KEY'],
                    secret_access_key: ENV['S3_BACKUP_SECRET'])
@@ -11,42 +11,49 @@ module Backup
       self.region = region
       self.access_key_id = access_key_id
       self.secret_access_key = secret_access_key
-      config = {
+      configuration = {
         region: region,
         access_key_id: access_key_id,
         secret_access_key: secret_access_key
       }
-      config[:endpoint] = endpoint unless endpoint.nil?
-      self.s3_client = Aws::S3::Client.new(config)
+      configuration[:endpoint] = endpoint unless endpoint.nil?
+      self.s3_resource = Aws::S3::Resource.new(configuration)
     end
 
     def upload(backup_file, key)
       begin
-        s3_client.put_object(
-          bucket: ENV['S3_BACKUP_BUCKET'],
-          key: key,
-          body: File.open(backup_file)
-        )
-      rescue StandardError => e
-        puts "Error uploading backup to S3: #{e.message}"
+        s3_resource.bucket(ENV['S3_BACKUP_BUCKET']).object(key).upload_file(backup_file)
+      rescue Backup::Error => e
+        puts "Upload failed: #{e.message}"
         raise e
       end
       'File uploaded to S3'
     end
 
     def remove_old_backups(basename, keep: 5)
-      bucket = ENV['S3_BACKUP_BUCKET']
-      all_items = s3_client.list_objects_v2(bucket: bucket, prefix: basename).contents
+      all_items = s3_resource.bucket(ENV['S3_BACKUP_BUCKET']).objects(prefix: basename).map do |item|
+        { key: item.key, last_modified: item.last_modified }
+      end
+
+      all_items = all_items.sort_by { |hsh| hsh[:last_modified] }.reverse
+
       count = all_items.count
+
       if count <= keep
-        p 'Nothing to remove'
-        return
+        puts 'Nothing to remove'
+        exit(0)
       end
-      items = all_items.sort_by(&:last_modified).reverse.slice(keep..-1).map(&:key)
-      items.each do |item|
-        p "Removing #{item} from S3"
-        s3_client.delete_object(bucket: bucket, key: item)
+
+      delete_items = all_items.slice(keep..-1)
+
+      delete_items.each do |item_obj|
+        puts "Removing #{item_obj[:key]} from S3"
+        s3_resource.bucket(ENV['S3_BACKUP_BUCKET']).object(item_obj[:key]).delete
       end
+      puts 'Old backups removed from S3'
+    rescue Backup::Error => e
+      puts "Remove failed: #{e.message}"
+      raise e
     end
   end
 end

data/lib/capistrano/ops/capistrano/v3/tasks/backup/database/create.rake

@@ -6,7 +6,7 @@ namespace :backup do
     include BackupHelper
     # Default to :app role
     rake_roles = fetch(:rake_roles, :app)
-    
+
     desc 'create a backup of the server database'
     task :create do
       on roles(rake_roles) do

data/lib/capistrano/ops/capistrano/v3/tasks/backup/storage/create.rake

@@ -6,7 +6,7 @@ namespace :backup do
     include BackupHelper
     # Default to :app role
     rake_roles = fetch(:rake_roles, :app)
-    
+
     desc 'create storage dump on server'
     task :create do
       on roles(rake_roles) do

data/lib/capistrano/ops/tasks/pg/dump.rake

@@ -1,27 +1,25 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/BlockLength
+require_relative './postgres_helper'
 namespace :pg do
-  @database = Rails.configuration.database_configuration[Rails.env]['database']
-  @username = Rails.configuration.database_configuration[Rails.env]['username']
-  @password = Rails.configuration.database_configuration[Rails.env]['password']
-  @hostname = Rails.configuration.database_configuration[Rails.env]['host']
-  @portnumber = Rails.configuration.database_configuration[Rails.env]['port']
-  @backup_path = Rails.root.join(Rails.env.development? ? 'tmp/backups' : '../../shared/backups').to_s
-  backups_enabled = Rails.env.production? || ENV['BACKUPS_ENABLED'] == 'true'
-  external_backup = Rails.env.production? || ENV['EXTERNAL_BACKUP_ENABLED'] == 'true'
+  include PostgresHelper
+
   task :dump do
+    backup_path = configuration[:backup_path]
+    backups_enabled = configuration[:backups_enabled]
+    external_backup = configuration[:external_backup]
+
     unless backups_enabled
       puts 'dump: Backups are disabled'
       exit(0)
     end
 
     notification = Notification::Api.new
-    commandlist = dump_cmd
+    commandlist = dump_cmd(configuration)
 
-    system "mkdir -p #{@backup_path}" unless Dir.exist?(@backup_path)
+    system "mkdir -p #{backup_path}" unless Dir.exist?(backup_path)
 
-    result = system(commandlist.join(' && '))
+    result = system(commandlist)
 
     if ENV['BACKUP_PROVIDER'].present? && external_backup && result
       puts "Uploading #{@filename} to #{ENV['BACKUP_PROVIDER']}..."
@@ -33,40 +31,10 @@ namespace :pg do
         puts "#{@filename} upload failed: #{e.message}"
       end
     end
-    notification.send_backup_notification(result, title, content(result), { date: @date, database: @database, backup_path: @backup_path })
-    puts result ? "Backup created: #{@backup_path}/#{@filename}" : 'Backup failed removing dump file'
-    system "rm #{@backup_path}/#{@filename}" unless result
-  end
-
-  def title
-    ENV['DEFAULT_URL'] || "#{Rails.env} Backup"
-  end
-
-  def content(result)
-    messages = []
-    if result
-      messages << "Backup of #{@database} successfully finished at #{Time.now}"
-      messages << "Backup path:\`#{@backup_path}/#{@filename}\`"
-    else
-      messages << "Backup of #{@database} failed at #{Time.now}"
-    end
-    messages.join("\n")
-  end
+    notification.send_backup_notification(result, title, content(result, { database: @database, backup_path: @backup_path, filename: @filename }),
+                                          { date: @date, backup_path: @backup_path, database: @database })
+    puts result ? "Backup created: #{@backup_path}/#{@filename} (#{size_str(File.size("#{@backup_path}/#{@filename}"))})" : 'Backup failed removing dump file'
 
-  def dump_cmd
-    @date = Time.now.to_i
-    options = []
-    options << " -d #{@database}" if @database.present?
-    options << " -U #{@username}" if @username.present?
-    options << " -h #{@hostname}" if @hostname.present?
-    options << " -p #{@portnumber}" if @portnumber.present?
-
-    @filename = "#{@database}_#{@date}.dump"
-
-    commandlist = []
-    commandlist << "export PGPASSWORD='#{@password}'"
-    commandlist << "cd #{@backup_path}"
-    commandlist << "pg_dump -Fc #{options.join('')} > #{@filename}"
+    system "rm #{@backup_path}/#{@filename}" unless result
   end
 end
-# rubocop:enable Metrics/BlockLength

data/lib/capistrano/ops/tasks/pg/postgres_helper.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module PostgresHelper
+  def configuration
+    @configuration ||=
+      {
+        database: Rails.configuration.database_configuration[Rails.env]['database'],
+        username: Rails.configuration.database_configuration[Rails.env]['username'],
+        password: Rails.configuration.database_configuration[Rails.env]['password'],
+        hostname: Rails.configuration.database_configuration[Rails.env]['host'],
+        portnumber: Rails.configuration.database_configuration[Rails.env]['port'],
+        backup_path: Rails.root.join(Rails.env.development? ? 'tmp/backups' : '../../shared/backups').to_s,
+        backups_enabled: Rails.env.production? || ENV['BACKUPS_ENABLED'] == 'true',
+        external_backup: Rails.env.production? || ENV['EXTERNAL_BACKUP_ENABLED'] == 'true'
+      }
+  end
+
+  def title
+    ENV['DEFAULT_URL'] || "#{Rails.env} Backup"
+  end
+
+  def content(result, settings = {})
+    @database = settings[:database]
+    @backup_path = settings[:backup_path]
+    @filename = settings[:filename]
+
+    messages = []
+    if result
+      messages << "Backup of #{@database} successfully finished at #{Time.now}"
+      messages << "Backup path:\`#{@backup_path}/#{@filename}\`"
+    else
+      messages << "Backup of #{@database} failed at #{Time.now}"
+    end
+    messages.join("\n")
+  end
+
+  def dump_cmd(settings = {})
+    @hostname = settings[:hostname]
+    @database = settings[:database]
+    @username = settings[:username]
+    @password = settings[:password]
+    @portnumber = settings[:portnumber]
+    @backup_path = settings[:backup_path]
+
+    @date = Time.now.to_i
+    options = []
+    options << " -d #{@database}" if @database.present?
+    options << " -U #{@username}" if @username.present?
+    options << " -h #{@hostname}" if @hostname.present?
+    options << " -p #{@portnumber}" if @portnumber.present?
+
+    @filename = "#{@database}_#{@date}.dump"
+
+    commandlist = []
+    commandlist << "export PGPASSWORD='#{@password}'"
+    commandlist << "cd #{@backup_path}"
+    commandlist << "pg_dump -Fc #{options.join('')} > #{@filename}"
+    commandlist.join(' && ')
+  end
+
+  def size_str(size)
+    units = %w[B KB MB GB TB]
+    e = (Math.log(size) / Math.log(1024)).floor
+    s = format('%.2f', size.to_f / 1024**e)
+    s.sub(/\.?0*$/, units[e])
+  end
+end

data/lib/capistrano/ops/tasks/pg/remove_old_dumps.rake

@@ -4,8 +4,8 @@ require 'rake'
 namespace :pg do
   @backup_path = Rails.root.join(Rails.env.development? ? 'tmp/backups' : '../../shared/backups').to_s
   @database = Rails.configuration.database_configuration[Rails.env]['database']
-  @env_local_no = ENV['NUMBER_OF_LOCAL_BACKUPS']
-  @env_external_no = ENV['NUMBER_OF_EXTERNAL_BACKUPS']
+  @env_local_no = ENV['NUMBER_OF_LOCAL_BACKUPS'].present? ? ENV['NUMBER_OF_LOCAL_BACKUPS'] : nil
+  @env_external_no = ENV['NUMBER_OF_EXTERNAL_BACKUPS'].present? ? ENV['NUMBER_OF_EXTERNAL_BACKUPS'] : nil
   @total_local_backups_no = (@env_local_no || ENV['NUMBER_OF_BACKUPS'] || 7).to_i
   @total_external_backups_no = (@env_external_no || ENV['NUMBER_OF_BACKUPS'] || 7).to_i
   backups_enabled = Rails.env.production? || ENV['BACKUPS_ENABLED'] == 'true'
@@ -19,7 +19,7 @@ namespace :pg do
       exit(0)
     end
     unless @total_local_backups_no.positive?
-      puts "remove_old_dumps: No local cleanup because option '#{if @env_local_no
+      puts "remove_old_dumps: No local cleanup because option '#{if @env_local_no.present?
                                                                    'NUMBER_OF_LOCAL_BACKUPS='
                                                                  else
                                                                    'NUMBER_OF_BACKUPS='
@@ -35,11 +35,12 @@ namespace :pg do
       'xargs rm -rf'
     ]
 
-    system(commandlist.join(' | '))
+    result = system(commandlist.join(' | ')) if @total_local_backups_no.positive?
+    puts 'remove_old_dumps: local cleanup finished' if result
 
     if ENV['BACKUP_PROVIDER'].present? && external_backup
       unless @total_external_backups_no.positive?
-        puts "remove_old_dumps: No external cleanup because option '#{if @env_external_no
+        puts "remove_old_dumps: No external cleanup because option '#{if @env_external_no.present?
                                                                         'NUMBER_OF_EXTERNAL_BACKUPS='
                                                                       else
                                                                         'NUMBER_OF_BACKUPS='
@@ -48,7 +49,7 @@ namespace :pg do
       end
       provider = Backup::Api.new
       begin
-        result = provider.remove_old_backups(@database, @total_external_backups_no)
+        result = provider.remove_old_backups("#{@database}_", @total_external_backups_no)
       rescue StandardError => e
         puts "remove_old_dumps failed: #{e.message}"
       end

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/BlockLength
 namespace :storage do
   @backup_path = Rails.root.join(Rails.env.development? ? 'tmp/backups' : '../../shared/backups').to_s
   @storage_path = Rails.root.join(Rails.env.development? ? 'storage' : '../../shared/storage').to_s
@@ -18,11 +17,11 @@ namespace :storage do
     date = Time.now.to_i
     @filename = "storage_#{date}.tar.gz"
     FileUtils.mkdir_p(@backup_path) unless Dir.exist?(@backup_path)
-    result = system "tar -zcf #{@backup_path}/#{@filename} -C #{@storage_path} ."
-    FileUtils.rm_rf("#{@backup_path}/#{filename}") unless result
-    puts result ? "Backup created: #{@backup_path}/#{@filename} (#{size_str(File.size("#{@backup_path}/#{@filename}"))})" : 'Backup failed removing dump file'
+    response = system "tar -zcf #{@backup_path}/#{@filename} -C #{@storage_path} ."
+    FileUtils.rm_rf("#{@backup_path}/#{filename}") unless response
+    puts response ? "Backup created: #{@backup_path}/#{@filename} (#{size_str(File.size("#{@backup_path}/#{@filename}"))})" : 'Backup failed removing dump file'
 
-    if ENV['BACKUP_PROVIDER'].present? && external_backup && result
+    if ENV['BACKUP_PROVIDER'].present? && external_backup && response
       puts "Uploading #{@filename} to #{ENV['BACKUP_PROVIDER']}..."
       provider = Backup::Api.new
       begin
@@ -32,14 +31,14 @@ namespace :storage do
         puts "#{@filename} upload failed: #{e.message}"
       end
     end
-    notification.send_backup_notification(result, title, message(result), { date: date, backup_path: @backup_path, database: 'storage' })
+    notification.send_backup_notification(response, title, message(response), { date: date, backup_path: @backup_path, database: 'storage' })
   end
 
   def title
     ENV['DEFAULT_URL'] || "#{Rails.env} Backup"
   end
 
-  def message(result)
+  def message(result=false)
     messages = []
     if result
       messages << "Backup of storage folder successfully finished at #{Time.now}"
@@ -51,16 +50,9 @@ namespace :storage do
   end
 
   def size_str(size)
-    case size
-    when 0..1024
-      "#{size} B"
-    when 1024..1024 * 1024
-      "#{size / 1024} KB"
-    when 1024 * 1024..1024 * 1024 * 1024
-      "#{size / 1024 / 1024} MB"
-    when 1024 * 1024 * 1024..1024 * 1024 * 1024 * 1024
-      "#{size / 1024 / 1024 / 1024} GB"
-    end
+    units = %w[B KB MB GB TB]
+    e = (Math.log(size) / Math.log(1024)).floor
+    s = format('%.2f', size.to_f / 1024**e)
+    s.sub(/\.?0*$/, units[e])
   end
 end
-# rubocop:enable Metrics/BlockLength

data/lib/capistrano/ops/tasks/storage/remove_old_backups.rake

@@ -6,8 +6,8 @@ namespace :storage do
   backups_enabled = Rails.env.production? || ENV['BACKUPS_ENABLED'] == 'true'
   external_backup = Rails.env.production? || ENV['EXTERNAL_BACKUP_ENABLED'] == 'true'
 
-  @env_local_no = ENV['NUMBER_OF_LOCAL_BACKUPS']
-  @env_external_no = ENV['NUMBER_OF_EXTERNAL_BACKUPS']
+  @env_local_no = ENV['NUMBER_OF_LOCAL_BACKUPS'].present? ? ENV['NUMBER_OF_LOCAL_BACKUPS'] : nil
+  @env_external_no = ENV['NUMBER_OF_EXTERNAL_BACKUPS'].present? ? ENV['NUMBER_OF_EXTERNAL_BACKUPS'] : nil
   @total_local_backups_no = (@env_local_no || ENV['NUMBER_OF_BACKUPS'] || 7).to_i
   @total_external_backups_no = (@env_external_no || ENV['NUMBER_OF_BACKUPS'] || 7).to_i
   desc 'remove old storage backups'
@@ -35,7 +35,8 @@ namespace :storage do
       'xargs rm -rf'
     ]
 
-    system(commandlist.join(' | '))
+    result = system(commandlist.join(' | ')) if @total_local_backups_no.positive?
+    puts 'remove_old_backups: local cleanup finished' if result
 
     if ENV['BACKUP_PROVIDER'].present? && external_backup
       unless @total_external_backups_no.positive?

data/lib/capistrano/ops/version.rb

@@ -2,6 +2,6 @@
 
 module Capistrano
   module Ops
-    VERSION = '0.2.4'
+    VERSION = '0.2.6'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-ops
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Florian Crusius
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-13 00:00:00.000000000 Z
+date: 2023-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -135,6 +135,7 @@ files:
 - 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