capistrano-ops 0.2.3 → 0.2.4

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

@@ -1,38 +1,58 @@
 # frozen_string_literal: true
 
+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']
-  @total_backups_no = (ENV['NUMBER_OF_BACKUPS'] || 7).to_i
+  @env_local_no = ENV['NUMBER_OF_LOCAL_BACKUPS']
+  @env_external_no = ENV['NUMBER_OF_EXTERNAL_BACKUPS']
+  @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'
+  external_backup = Rails.env.production? || ENV['EXTERNAL_BACKUP_ENABLED'] == 'true'
 
   task :remove_old_dumps do
     bash_regex = "'#{@database}.{0,}\.dump'"
 
-    unless backups_enabled && @total_backups_no > 0
-      p 'remove_old_dumps: Backups are disabled'
+    unless backups_enabled
+      puts 'remove_old_dumps: Backups are disabled'
       exit(0)
     end
+    unless @total_local_backups_no.positive?
+      puts "remove_old_dumps: No local cleanup because option '#{if @env_local_no
+                                                                   'NUMBER_OF_LOCAL_BACKUPS='
+                                                                 else
+                                                                   'NUMBER_OF_BACKUPS='
+                                                                 end}#{@total_local_backups_no}' sets unlimited backups"
+
+    end
 
-    
     commandlist = [
       "cd #{@backup_path} && ls -lt ",
       "grep -E -i #{bash_regex} ",
-      "tail -n +#{@total_backups_no + 1} ",
+      "tail -n +#{@total_local_backups_no + 1} ",
       "awk '{print $9}' ",
-      "xargs rm -rf"
+      'xargs rm -rf'
     ]
 
     system(commandlist.join(' | '))
 
-    if ENV['BACKUP_PROVIDER'].present?
+    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
+                                                                        'NUMBER_OF_EXTERNAL_BACKUPS='
+                                                                      else
+                                                                        'NUMBER_OF_BACKUPS='
+                                                                      end}#{@total_external_backups_no}' sets unlimited backups"
+        exit(0)
+      end
       provider = Backup::Api.new
       begin
-        result = provider.remove_old_backups(@database, @total_backups_no)
+        result = provider.remove_old_backups(@database, @total_external_backups_no)
       rescue StandardError => e
-        p "remove_old_dumps failed: #{e.message}"
+        puts "remove_old_dumps failed: #{e.message}"
       end
-      p 'remove_old_dumps finished' if result
+      puts 'remove_old_dumps finished' if result
     end
   end
 end

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

@@ -1,71 +1,66 @@
+# 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
-    backups_enabled = Rails.env.production? || ENV['BACKUPS_ENABLED'] == 'true'
-    
-    desc 'backup storage'
-    task :backup do
-        unless backups_enabled
-            puts 'storage: Backups are disabled'
-            exit(0)
-        end
-        notification = Notification::Api.new
+  @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
+  backups_enabled = Rails.env.production? || ENV['BACKUPS_ENABLED'] == 'true'
+  external_backup = Rails.env.production? || ENV['EXTERNAL_BACKUP_ENABLED'] == 'true'
 
-        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
-        
-        
-        filesize = size_str(File.size("#{@backup_path}/#{@filename}"))
-        
-        p result ? "Backup created: #{@backup_path}/#{@filename} (#{filesize})" : "Backup failed removing dump file"
-        
-        if ENV["BACKUP_PROVIDER"].present? && result
-            puts "Uploading #{@filename} to #{ENV["BACKUP_PROVIDER"]}..."
-            provider = Backup::Api.new
-            begin
-                provider.upload("#{@backup_path}/#{@filename}", "#{@filename}")
-                puts "#{@filename} uploaded to #{ENV["BACKUP_PROVIDER"]}"
-            rescue => e
-                puts "#{@filename} upload failed: #{e.message}"
-            end
-        end
-        notification.send_backup_notification(result,title,message(result))
-        
+  desc 'backup storage'
+  task :backup do
+    unless backups_enabled
+      puts 'storage: Backups are disabled'
+      exit(0)
     end
+    notification = Notification::Api.new
 
+    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'
 
-    
-    def title
-        ENV['DEFAULT_URL'] || "#{Rails.env} Backup"
+    if ENV['BACKUP_PROVIDER'].present? && external_backup && result
+      puts "Uploading #{@filename} to #{ENV['BACKUP_PROVIDER']}..."
+      provider = Backup::Api.new
+      begin
+        provider.upload("#{@backup_path}/#{@filename}", @filename.to_s)
+        puts "#{@filename} uploaded to #{ENV['BACKUP_PROVIDER']}"
+      rescue StandardError => e
+        puts "#{@filename} upload failed: #{e.message}"
+      end
     end
-    
-    
-    def message(result)
-        messages = []
-        if result
-            messages << "Backup of storage folder successfully finished at #{Time.now}"
-            messages << "Backup path:\`#{@backup_path}/#{@filename}\`"
-        else
-            messages << "Backup of storage folder failed at #{Time.now}"
-        end
-        messages.join("\n")
+    notification.send_backup_notification(result, title, message(result), { date: date, backup_path: @backup_path, database: 'storage' })
+  end
+
+  def title
+    ENV['DEFAULT_URL'] || "#{Rails.env} Backup"
+  end
+
+  def message(result)
+    messages = []
+    if result
+      messages << "Backup of storage folder successfully finished at #{Time.now}"
+      messages << "Backup path:\`#{@backup_path}/#{@filename}\`"
+    else
+      messages << "Backup of storage folder failed at #{Time.now}"
     end
+    messages.join("\n")
+  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
+  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
-end
+  end
+end
+# rubocop:enable Metrics/BlockLength

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

@@ -1,41 +1,58 @@
 # frozen_string_literal: true
+
 require 'rake'
 namespace :storage do
-    default_backup_path = Rails.env.development? ? 'tmp/backups' : '../../shared/backups'
-    backup_path = Rails.root.join(default_backup_path).to_s
-    backups_enabled = Rails.env.production? || ENV['BACKUPS_ENABLED'] == 'true'
-    
+  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'
 
-    desc 'remove old storage backups'
-    task :remove_old_backups do
-      bash_regex = "'storage_.{0,}\.tar.gz'"
-      total_backups_no = (ENV['NUMBER_OF_BACKUPS'] || 7).to_i
-      
-      unless backups_enabled && total_backups_no.to_i > 0
-        p 'remove_old_backups: Backups are disabled'
-        exit(0)
-      end
+  @env_local_no = ENV['NUMBER_OF_LOCAL_BACKUPS']
+  @env_external_no = ENV['NUMBER_OF_EXTERNAL_BACKUPS']
+  @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'
+  task :remove_old_backups do
+    bash_regex = "'storage_.{0,}\.tar.gz'"
+
+    unless backups_enabled
+      puts 'remove_old_backups: Backups are disabled'
+      exit(0)
+    end
 
-      
-      commandlist = [
-        "cd #{backup_path} && ls -lt ",
-        "grep -E -i #{bash_regex} ",
-        "tail -n +#{total_backups_no + 1} ",
-        "awk '{print $9}' ",
-        "xargs rm -rf"
-      ]
+    unless @total_local_backups_no.positive?
+      puts "remove_old_backups: No local cleanup because option '#{if @env_local_no
+                                                                     'NUMBER_OF_LOCAL_BACKUPS='
+                                                                   else
+                                                                     'NUMBER_OF_BACKUPS='
+                                                                   end}#{@total_local_backups_no}' sets unlimited backups"
+    end
 
-      system(commandlist.join(' | '))
+    commandlist = [
+      "cd #{backup_path} && ls -lt ",
+      "grep -E -i #{bash_regex} ",
+      "tail -n +#{@total_local_backups_no + 1} ",
+      "awk '{print $9}' ",
+      'xargs rm -rf'
+    ]
 
-      if ENV['BACKUP_PROVIDER'].present?
-        provider = Backup::Api.new
-        begin
-          result = provider.remove_old_backups('storage_', total_backups_no)
-        rescue StandardError => e
-          p "remove_old_backups failed: #{e.message}"
-        end
-        p 'remove_old_backups finished' if result
-      end
+    system(commandlist.join(' | '))
 
+    if ENV['BACKUP_PROVIDER'].present? && external_backup
+      unless @total_external_backups_no.positive?
+        puts "remove_old_backups: No external cleanup because option '#{if @env_external_no
+                                                                          'NUMBER_OF_EXTERNAL_BACKUPS='
+                                                                        else
+                                                                          'NUMBER_OF_BACKUPS='
+                                                                        end}#{@total_external_backups_no}' sets unlimited backups"
+        exit(0)
+      end
+      provider = Backup::Api.new
+      begin
+        result = provider.remove_old_backups('storage_', @total_external_backups_no)
+      rescue StandardError => e
+        puts "remove_old_backups failed: #{e.message}"
+      end
+      puts 'remove_old_backups finished' if result
     end
+  end
 end

data/lib/capistrano/ops/version.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 module Capistrano
   module Ops
-    VERSION = '0.2.3'
+    VERSION = '0.2.4'
   end
 end

data/lib/capistrano/ops.rb

@@ -1,25 +1,25 @@
-
+# frozen_string_literal: true
 
 module Capistrano
-    module Ops
-        require 'capistrano/ops/backup'
-        require 'capistrano/ops/notification'
-        require 'capistrano/ops/railtie' if defined?(Rails)
-        require 'capistrano/ops/capistrano' if defined?(Capistrano::VERSION)
-        def self.path
-            Dir.pwd
-        end
+  module Ops
+    require 'capistrano/ops/backup'
+    require 'capistrano/ops/notification'
+    require 'capistrano/ops/railtie' if defined?(Rails)
+    require 'capistrano/ops/capistrano' if defined?(Capistrano::VERSION)
+    def self.path
+      Dir.pwd
+    end
 
-        def self.bin_rails?
-            File.exist?(File.join(path, 'bin', 'rails'))
-        end
+    def self.bin_rails?
+      File.exist?(File.join(path, 'bin', 'rails'))
+    end
 
-        def self.script_rails?
-            File.exist?(File.join(path, 'script', 'rails'))
-        end
+    def self.script_rails?
+      File.exist?(File.join(path, 'script', 'rails'))
+    end
 
-        def self.bundler?
-            File.exist?(File.join(path, 'Gemfile'))
-        end
+    def self.bundler?
+      File.exist?(File.join(path, 'Gemfile'))
     end
-end
+  end
+end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-ops
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Florian Crusius
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-24 00:00:00.000000000 Z
+date: 2023-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.128'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.128'
+- !ruby/object:Gem::Dependency
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk-s3
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.128'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.128'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +104,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
@@ -105,6 +120,11 @@ files:
 - lib/capistrano/ops/backup/s3.rb
 - lib/capistrano/ops/capistrano.rb
 - 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/logs.rake
@@ -129,12 +149,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: 2.5.0
-  - - "<"
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="