capistrano-ops 0.2.13 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cec4486500e5ddac70640e6f3d074b51b361d649079e98f9ef6d337712c3de23
-  data.tar.gz: ac8df454d33822890a673e800db7492bc7d4d2a7f54c0fe91378648fa163a2f8
+  metadata.gz: '03096171fc878362361e6d4f5c525db4e28fc2acfe10f7b2dcb15852ed8e6b99'
+  data.tar.gz: f50d51428cf175cff22f739373f5ce81e79982cfcb1e484323586fc181834aa8
 SHA512:
-  metadata.gz: c97bd7b0f7b0f9968b30d81a8807da57d690a4700e6674596f64b970727e4d99606af7ac8e192691fae63a0e5cf67ee54936bda0d1d06d935c37e068b3afdf41
-  data.tar.gz: aac3a0d13aa1c8f78ab77f5943b2ee5944c561829831c117afd8dc1cfd0e0e638406c9bcda52f92c1cc53b1f8eeef455e9d62e1929ffe984e3408812a22de4eb
+  metadata.gz: 0d32c02dfc012ed82cdbe2adf0a968d19eca1332661a1765158a1be92b12bd45e63755a0533a52b814b7d383a6124d436fd3d10b85907d262deb9207437d177e
+  data.tar.gz: 404850e368cddef350bf54ea6b3e681fa123029fa2a0bc7dfb74786ebc16e5c948e8fec1d0e182bc5c99d83fa073d4c26e5b3a7d61d63a3cd272f5b4ea8ee474

data/.rubocop.yml

@@ -1,3 +1,6 @@
+require:
+  - rubocop-performance
+  - rubocop-rails
 AllCops:
   NewCops: disable
   TargetRubyVersion: 2.7
@@ -19,3 +22,7 @@ Metrics/PerceivedComplexity:
   Max: 25
 Style/Documentation:
   Enabled: false
+Rails/RakeEnvironment:
+  Enabled: false
+Rails/Output:
+  Enabled: false

data/README.md

@@ -2,6 +2,33 @@
 
 The capistrano-ops gem is a valuable library, tailor-made for Rails DevOps professionals, offering an array of beneficial scripts to streamline and enhance operations with Capistrano. The focus is on seamless integration with Capistrano version 3 and above.
 
+## Table of Contents
+
+<details>
+<summary>Click to expand</summary>
+
+- [Main Features](#main-features)
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Script overview](#script-overview)
+- [Usage](#usage)
+  - [Optional Settings for backup task](#optional-settings-for-backup-task)
+  - [use with whenever/capistrano](#use-with-whenevercapistrano)
+- [Configuration](#configuration)
+- [Slack integration](#slack-integration)
+- [Webhook integration](#webhook-integration)
+- [Notification level](#notification-level)
+- [Backups](#backups)
+  - [Backup provider](#backup-provider)
+- [Logrotate](#logrotate)
+  - [Configuration](#configuration-1)
+  - [Usage](#usage-1)
+- [Wkhtmltopdf Setup](#wkhtmltopdf-setup)
+- [Contributing](#contributing)
+- [License](#license)
+
+</details>
+
 ## Main Features:
 
 🗃️ **Database and Storage Backups:**
@@ -11,12 +38,16 @@ The capistrano-ops gem is a valuable library, tailor-made for Rails DevOps profe
 
 🛠️ **Configuration Management:**
 
-- Compare application.yml files between local and server environments using figaro_yml:compare.
-- Fetch server environment variables set via Figaro with figaro_yml:get.
+- Compare `application.yml` files between local and server environments using `figaro_yml:compare`.
+- Fetch server environment variables set via Figaro with `figaro_yml:get`.
+- Copy local `application.yml` to the server with `figaro_yml:setup`. This task automatically triggers `figaro_yml:backup` before proceeding.
+- Create a backup of the server's `application.yml` with `figaro_yml:backup`. This is automatically executed before `figaro_yml:setup` to ensure a recovery point is available.
+- Roll back to the previous `application.yml` on the server using `figaro_yml:rollback`. This can be used to quickly revert changes made by `figaro_yml:setup` if needed.
 
 📜 **Logging and Task Management:**
 
 - Real-time viewing of Rails server logs.
+- Real-time viewing of sidekiq logs.
 - Showcase the server app's crontab generated with the 'whenever' gem.
 - Ability to invoke server-specific rake tasks.
 
@@ -43,16 +74,20 @@ The capistrano-ops gem is a valuable library, tailor-made for Rails DevOps profe
 
 - S3 and other S3-compatible services are supported to ensure your data remains secure and accessible.
 
+[↑](#)
+
 ## Requirements
 
 ```ruby
 'capistrano', '~> 3.0'
-'whenever'
-'capistrano-figaro-yml'
+'whenever' # for scheduling tasks
+'figaro' # for environment variables if you use figaro_yml tasks
 
 # hint: if you use other aws-sdk gems, its possible that you have to update them too
 ```
 
+[↑](#)
+
 ## Installation
 
 Add the gem to your `Gemfile` after setting up Capistrano
@@ -74,35 +109,64 @@ Then `bundle` and add it to your `Capfile`
 require 'capistrano/ops'
 ```
 
+or if you want to use only specific tasks one or more of the following:
+
+```ruby
+# Capfile
+
+
+require 'capistrano/ops/backup' # backup:database:create, backup:database:pull, backup:storage:create, backup:storage:pull
+require 'capistrano/ops/figaro_yml' # figaro_yml:compare, figaro_yml:get, figaro_yml:setup, figaro_yml:backup, figaro_yml:rollback
+require 'capistrano/ops/invoke' # invoke:rake
+require 'capistrano/ops/logrotate' # logrotate:enable, logrotate:disable, logrotate:check
+require 'capistrano/ops/logs' # logs:rails, logs:sidekiq, logs:sidekiq:info, logs:sidekiq:error
+require 'capistrano/ops/whenever' # whenever:show_crontab
+
+# optionally and not included in require 'capistrano/ops'
+require 'capistrano/ops/wkhtmltopdf' # setup wkhtmltopdf-binary on server
+```
+
 and `initializers`
 
 ```ruby
 # initializers/capistrano_ops.rb
+
+# needed for the backup tasks
 require 'capistrano/ops'
 ```
 
+[↑](#)
+
 ## Script overview
 
-| Script                                           | Description                                                       |
-| ------------------------------------------------ | ----------------------------------------------------------------- |
-| `cap <environment> backup:create`                | creates backup of postgres database on the server (deprecated)    |
-| `cap <environment> backup:pull`                  | download latest postgres backup from server (deprecated)          |
-| `cap <environment> backup:database:create`       | creates backup of postgres database on the server                 |
-| `cap <environment> backup:database:pull`         | download latest postgres backup from server                       |
-| `cap <environment> backup:storage:create`        | creates backup of storage on the server                           |
-| `cap <environment> backup:storage:pull`          | download latest storage backup from server                        |
-| `cap <environment> figaro_yml:compare`           | compare local application.yml with server application.yml         |
-| `cap <environment> figaro_yml:get`               | shows env vars from server application.yml configured thru figaro |
-| `cap <environment> logs:rails`                   | display server log live                                           |
-| `cap <environment> whenever:show_crontab`        | display server app crontab generated with whenever                |
-| `cap <environment> invoke:rake TASK=<your:task>` | invoke rake task on server                                        |
-| `cap <environment> logrotate:enable`             | enable logrotate for logfiles on server                           |
-| `cap <environment> logrotate:disable`            | disable logrotate for logfiles on server                          |
-| `cap <environment> logrotate:check`              | show logrotate status for logfiles on server                      |
-| `rake pg:dump`                                   | creates postgres database backup                                  |
-| `rake pg:remove_old_dumps`                       | remove old postgres backups                                       |
-| `rake storage:backup`                            | creates backup of storage                                         |
-| `rake storage:remove_old_backups`                | remove old storage backups                                        |
+| Script                                           | Description                                                              |
+| ------------------------------------------------ | ------------------------------------------------------------------------ |
+| `cap <environment> backup:create`                | creates backup of postgres database on the server (removed since v1.0.0) |
+| `cap <environment> backup:pull`                  | download latest postgres backup from server (removed since v1.0.0)       |
+| `cap <environment> backup:database:create`       | creates backup of postgres database on the server                        |
+| `cap <environment> backup:database:pull`         | download latest postgres backup from server                              |
+| `cap <environment> backup:storage:create`        | creates backup of storage on the server                                  |
+| `cap <environment> backup:storage:pull`          | download latest storage backup from server                               |
+| `cap <environment> figaro_yml:setup`             | copy local application.yml to server application.yml                     |
+| `cap <environment> figaro_yml:compare`           | compare local application.yml with server application.yml                |
+| `cap <environment> figaro_yml:get`               | shows env vars from server application.yml configured thru figaro        |
+| `cap <environment> figaro_yml:backup`            | creates backup of server application.yml (keeps last 5 versions)         |
+| `cap <environment> figaro_yml:rollback`          | rollback server application.yml to previous version                      |
+| `cap <environment> logs:rails`                   | display server log live                                                  |
+| `cap <environment> logs:sidekiq`                 | display sidekiq log live                                                 |
+| `cap <environment> logs:sidekiq:info`            | display sidekiq info log live                                            |
+| `cap <environment> logs:sidekiq:error`           | display sidekiq error log live                                           |
+| `cap <environment> whenever:show_crontab`        | display server app crontab generated with whenever                       |
+| `cap <environment> invoke:rake TASK=<your:task>` | invoke rake task on server                                               |
+| `cap <environment> logrotate:enable`             | enable logrotate for logfiles on server                                  |
+| `cap <environment> logrotate:disable`            | disable logrotate for logfiles on server                                 |
+| `cap <environment> logrotate:check`              | show logrotate status for logfiles on server                             |
+| `rake pg:dump`                                   | creates postgres database backup                                         |
+| `rake pg:remove_old_dumps`                       | remove old postgres backups                                              |
+| `rake storage:backup`                            | creates backup of storage                                                |
+| `rake storage:remove_old_backups`                | remove old storage backups                                               |
+
+[↑](#)
 
 ## Usage
 
@@ -118,6 +182,8 @@ production:
   port: database_port
 ```
 
+[↑](#)
+
 ### Optional Settings for backup task
 
 | env                        | description                                                                                         |                            type/options                            |
@@ -127,7 +193,7 @@ production:
 | NUMBER_OF_EXTERNAL_BACKUPS | number of backups to keep externally (default: nil)                                                 |                              `number`                              |
 | BACKUPS_ENABLED            | enable/disable backup task (default: Rails.env == 'production')                                     |                             `boolean`                              |
 | EXTERNAL_BACKUP_ENABLED    | enable/disable external backup (default: false) (only if 'BACKUPS_ENABLED', needs additional setup) |                             `boolean`                              |
-| KEEP_LOCAL_STORAGE_BACKUPS | keep local storage backups (default: Rails.env == 'production')                                     |                             `boolean`                              |
+| KEEP_LOCAL_STORAGE_BACKUPS | keep local storage backups (default: true)                                                          |                             `boolean`                              |
 | DEFAULT_URL                | notification message title (default: "#{database} Backup")                                          |                              `string`                              |
 | NOTIFICATION_TYPE          | for notification (default: nil)                                                                     |                    `string` (`webhook`/`slack`)                    |
 | NOTIFICATION_LEVEL         | for notification (default: nil)                                                                     |                     `string` (`info`/`error`)                      |
@@ -142,6 +208,8 @@ production:
 | S3_BACKUP_SECRET           | S3 secret key for backups                                                                           |                              `string`                              |
 | S3_BACKUP_ENDPOINT         | S3 endpoint for backups (optional, used for other S3 compatible services)                           |                              `string`                              |
 
+[↑](#)
+
 ### use with whenever/capistrano
 
 install whenever gem and add this to your schedule.rb
@@ -170,6 +238,8 @@ add this to your capfile
 require 'whenever/capistrano'
 ```
 
+[↑](#)
+
 ## Configuration
 
 You can optionally specify the capistrano roles for the rake task (Defaults to `:app`):
@@ -179,6 +249,8 @@ You can optionally specify the capistrano roles for the rake task (Defaults to `
 set :rake_roles, %i[db app]
 ```
 
+[↑](#)
+
 ## Slack integration
 
 if you want to use slack integration you have to add this to your `application.yml`
@@ -189,6 +261,8 @@ SLACK_SECRET: '<your-slack-secret>'
 SLACK_CHANNEL: '<your-slack-channel>'
 ```
 
+[↑](#)
+
 ## Webhook integration
 
 if you want to use webhook integration you have to add this to your `application.yml`
@@ -199,6 +273,8 @@ WEBHOOK_URL: '<your-webhook-url>'
 WEBHOOK_SECRET: '<your-webhook-secret>'
 ```
 
+[↑](#)
+
 ## Notification level
 
 if you want to use notification level you have to add this to your `application.yml`
@@ -207,6 +283,8 @@ if you want to use notification level you have to add this to your `application.
 NOTIFICATION_LEVEL: 'info' # default is 'error'
 ```
 
+[↑](#)
+
 ## Backups
 
 if you want to configure the number of backups you have to add this to your `application.yml`
@@ -222,6 +300,8 @@ NUMBER_OF_LOCAL_BACKUPS: 7 # default is nil (local)
 NUMBER_OF_EXTERNAL_BACKUPS: 7 # default is nil (local)
 ```
 
+[↑](#)
+
 ### Backup provider
 
 if you want to use an external backup provider you have to add this to your `application.yml`
@@ -235,6 +315,8 @@ S3_BACKUP_SECRET: '<your-s3-secret>'
 S3_BACKUP_ENDPOINT: '<your-s3-endpoint>' # optional, used for other S3 compatible services
 ```
 
+[↑](#)
+
 ## Logrotate
 
 Logrotate is a utility designed for administrators who manage servers producing a high volume of log files to help them save some disk space as well as to avoid a potential risk making a system unresponsive due to the lack of disk space.
@@ -244,6 +326,7 @@ The capistrano-ops gem provides a set of tasks to manage logrotate on your serve
 - `cap <environment> logrotate:enable` - This task enables logrotate for logfiles on the server.
 - `cap <environment> logrotate:disable` - This task disables logrotate for logfiles on the server.
 - `cap <environment> logrotate:check` - This task shows the logrotate status for logfiles on the server.
+  [↑](#)
 
 ### Configuration
 
@@ -254,6 +337,8 @@ You can optionally specify the logrotate configuration file path (Defaults to `/
 set :logrotate_path, '/path/to/your/logrotate.conf'
 ```
 
+[↑](#)
+
 ### Usage
 
 To use logrotate, you need to have it installed on your server. If it's not installed, you can install it using the package manager of your system. For example, on Ubuntu, you can install it using apt:
@@ -263,6 +348,7 @@ sudo apt-get install logrotate
 ```
 
 Once logrotate is installed, you can use the capistrano-ops tasks to manage it.
+[↑](#)
 
 ## Wkhtmltopdf Setup
 
@@ -292,6 +378,8 @@ To use this script, include it in your Capistrano tasks and it will automaticall
 require 'capistrano/ops/wkhtmltopdf'
 ```
 
+[↑](#)
+
 ## Contributing
 
 1. Fork it ( https://github.com/zauberware/capistrano-ops/fork )
@@ -300,14 +388,18 @@ require 'capistrano/ops/wkhtmltopdf'
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+[↑](#)
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
-```
+This gem contains code/snippets from the following sources:
 
-```
+- [capistrano-figaro-yml](https://github.com/ChouAndy/capistrano-figaro-yml) by Andy Chou under the [MIT License](https://github.com/chouandy/capistrano-figaro-yml/blob/master/LICENSE.md)
+- [capistranorb documentation](https://capistranorb.com/documentation/tasks/rails/)
 
-```
+props to the original authors 🎉
+check out their work too!
 
-```
+[↑](#)

data/capistrano-ops.gemspec

@@ -26,4 +26,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'rails'
   s.add_development_dependency 'bundler', '~> 2.4.12'
   s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rubocop', '~> 1.56.2' # rubocop ruby
+  s.add_development_dependency 'rubocop-performance', '~> 1.19.0' # speed up rubocop
 end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Ops
+    module Backup
+      module Helper
+        def backup_file_name(type)
+          regex = type == 'storage' ? "'.{0,}\.tar.gz'" : "'.{0,}\.dump'"
+          @backup_file_name ||= capture "cd #{shared_path}/backups && ls -lt | grep -E -i #{regex} | head -n 1 | awk '{print $9}'"
+        end
+
+        def backup_file_size
+          @backup_file_size ||= capture "cd #{shared_path}/backups && wc -c #{@backup_file_name} | awk '{print $1}'"
+        end
+
+        def download_backup(backup_file, type)
+          puts "Downloading #{type} backup"
+          download! "#{shared_path}/backups/#{backup_file}", backup_file
+          puts "Download finished\nDeleting temporary backup..."
+          cleanup_backup(backup_file, "Download finished\nDeleting temporary backup...")
+        end
+
+        def cleanup_backup(backup_file, message)
+          puts message
+          execute "cd #{shared_path}/backups && rm #{backup_file}"
+          puts 'Temporary backup deleted'
+        end
+
+        def question(question, default = 'n', &block)
+          print "#{question} #{default.downcase == 'n' ? '(y/N)' : '(Y/n)'}: "
+          input = $stdin.gets.strip.downcase
+          answer = (input.empty? ? default : input).downcase.to_s
+
+          if %w[y n].include?(answer)
+            yield(answer == 'y')
+          else
+            question(question, default, &block)
+          end
+        end
+
+        def prepare_env
+          @env = "RAILS_ENV=#{fetch(:stage)}"
+          @path_cmd = "PATH=$HOME/.rbenv/versions/#{RUBY_VERSION}/bin:$PATH"
+          @test_command = "cd #{release_path} && #{@path_cmd} && #{@env}"
+        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
+    end
+  end
+end

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

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../backup_helper'
 namespace :backup do
   namespace :database do
-    include BackupHelper
+    include Capistrano::Ops::Backup::Helper
     # Default to :app role
     rake_roles = fetch(:rake_roles, :app)
 

data/lib/capistrano/ops/{capistrano/v3/tasks/backup → backup/tasks}/database/pull.rake

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../backup_helper'
 namespace :backup do
   namespace :database do
-    include BackupHelper
+    include Capistrano::Ops::Backup::Helper
     # Default to :app role
     rake_roles = fetch(:rake_roles, :app)
 

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

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../backup_helper'
 namespace :backup do
   namespace :storage do
-    include BackupHelper
+    include Capistrano::Ops::Backup::Helper
     # Default to :app role
     rake_roles = fetch(:rake_roles, :app)
 

data/lib/capistrano/ops/{capistrano/v3/tasks/backup → backup/tasks}/storage/pull.rake

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../backup_helper'
 namespace :backup do
   namespace :storage do
-    include BackupHelper
+    include Capistrano::Ops::Backup::Helper
     # Default to :app role
     rake_roles = fetch(:rake_roles, :app)
     desc 'pull latest storage dump from server to local'

data/lib/capistrano/ops/backup.rb

@@ -1,8 +1,18 @@
 # frozen_string_literal: true
 
-require 'capistrano/ops/backup/api'
-require 'capistrano/ops/backup/s3'
+require 'capistrano/ops/helper'
+require 'capistrano/ops/backup/helper'
 
-module Backup
-  class Error < StandardError; end
+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', 'backup/tasks', 'WARNING: Gemfile does not include rails gem which is required for backup tasks')

data/lib/capistrano/ops/capistrano.rb

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
 
 require 'capistrano/version'
+require 'capistrano/ops/whenever'
+require 'capistrano/ops/figaro_yml'
+require 'capistrano/ops/logrotate'
+require 'capistrano/ops/logs'
+require 'capistrano/ops/invoke'
+require 'capistrano/ops/backup'
 
-if defined?(Capistrano::VERSION) && Gem::Version.new(Capistrano::VERSION).release >= Gem::Version.new('3.0.0')
-  load File.expand_path('capistrano/v3/tasks/whenever.rake', __dir__)
-  load File.expand_path('capistrano/v3/tasks/backup.rake', __dir__)
-  load File.expand_path('capistrano/v3/tasks/figaro_yml.rake', __dir__)
-  load File.expand_path('capistrano/v3/tasks/invoke.rake', __dir__)
-  path = File.expand_path(__dir__)
-  Dir.glob("#{path}/capistrano/v3/tasks/backup/**/*.rake").each { |f| load f }
-  Dir.glob("#{path}/capistrano/v3/tasks/logrotate/**/*.rake").each { |f| load f }
-  Dir.glob("#{path}/capistrano/v3/tasks/logs/**/*.rake").each { |f| load f }
-else
+unless defined?(Capistrano::VERSION) && Gem::Version.new(Capistrano::VERSION).release >= Gem::Version.new('3.0.0')
   puts 'Capistrano 3 is required to use this gem'
 end