capistrano-ops 0.2.11 → 0.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2744c35793b74ff96ed5933892458ed3bbb86d33b93b4a9aab119996ab099048
-  data.tar.gz: 8245cc91a46097474588d94f4b935dc0f2c83090bf1818c7da4e6f37662bfaa0
+  metadata.gz: cec4486500e5ddac70640e6f3d074b51b361d649079e98f9ef6d337712c3de23
+  data.tar.gz: ac8df454d33822890a673e800db7492bc7d4d2a7f54c0fe91378648fa163a2f8
 SHA512:
-  metadata.gz: ddc408fdde37cbc926b36ce1fd3dce989a2aa6c4a73e61a700af581c02b3432274b49837784d182fa1f07ea48cb1ca253e8c6e9647d5aadbe6313d8c319bb57f
-  data.tar.gz: 14c1223afe87285ced3ce3790ef73b3b515a2912dd62cfd15da8e08ea2bebee3945c0773ba2af423bfc6753756a3dbd3f7d22acebcdf3de5117c6051c0934615
+  metadata.gz: c97bd7b0f7b0f9968b30d81a8807da57d690a4700e6674596f64b970727e4d99606af7ac8e192691fae63a0e5cf67ee54936bda0d1d06d935c37e068b3afdf41
+  data.tar.gz: aac3a0d13aa1c8f78ab77f5943b2ee5944c561829831c117afd8dc1cfd0e0e638406c9bcda52f92c1cc53b1f8eeef455e9d62e1929ffe984e3408812a22de4eb

data/README.md

@@ -96,6 +96,9 @@ require 'capistrano/ops'
 | `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                                         |
@@ -232,6 +235,63 @@ 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.
+
+The capistrano-ops gem provides a set of tasks to manage logrotate on your server:
+
+- `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
+
+You can optionally specify the logrotate configuration file path (Defaults to `/etc/logrotate.conf`):
+
+```ruby
+# Defaults to '/etc/logrotate.conf'
+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:
+
+```bash
+sudo apt-get install logrotate
+```
+
+Once logrotate is installed, you can use the capistrano-ops tasks to manage it.
+
+## Wkhtmltopdf Setup
+
+This script is used to setup `wkhtmltopdf-binary` in your deployment environment. It is designed to work with Capistrano.
+
+The main task `setup` is hooked to run after the `deploy:symlink:release` task.
+It performs the following operations:
+
+- unzip the necessary binary file
+
+- set the binary file permissions
+
+The script assumes, that you have a intializer file for `wicked_pdf` gem, which sets the path to the binary file.
+for example:
+
+```ruby
+# config/initializers/wicked_pdf.rb
+WickedPdf.config = {
+  exe_path: "#{Bundler.bundle_path}/gems/wkhtmltopdf-binary-0.12.6.6/bin/wkhtmltopdf_ubuntu_18.04_amd64",
+}
+```
+
+To use this script, include it in your Capistrano tasks and it will automatically run during deployment.
+
+```ruby
+# Capfile
+require 'capistrano/ops/wkhtmltopdf'
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/zauberware/capistrano-ops/fork )
@@ -247,3 +307,7 @@ The gem is available as open source under the terms of the [MIT License](http://
 ```
 
 ```
+
+```
+
+```

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+namespace :wkhtmltopdf do
+  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
+def binary_path_and_version
+  # get the binary path of wkhtmltopdf-binary
+  gem_path = capture(:bundle, 'show', 'wkhtmltopdf-binary').strip
+  binary_path = "#{gem_path}/bin"
+
+  # get the use wkhtmltopdf_ubuntu version from the wicked_pdf initializer
+  version = capture(:cat, 'config/initializers/wicked_pdf.rb').scan(/wkhtmltopdf_ubuntu_(\d+\.\d+)_amd64/).flatten.first
+
+  [binary_path, version]
+end
+
+def check_file_and_permissions(binary_path, version)
+  binary_file = "#{binary_path}/wkhtmltopdf_ubuntu_#{version}_amd64"
+
+  if test("[ -f #{binary_file} ]")
+    info('wkhtmltopdf binary already extracted')
+
+    if test("[ $(stat -c '%a' #{binary_file}) = '777' ]")
+      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

data/lib/capistrano/ops/capistrano/v3/tasks/logrotate/check.rake

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'logrotate_helper'
+
+namespace :logrotate do
+  include LogrotateHelper
+
+  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}"
+        else
+          puts 'logrotate disabled'
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/ops/capistrano/v3/tasks/logrotate/disable.rake

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'logrotate_helper'
+
+namespace :logrotate do
+  include LogrotateHelper
+
+  desc 'disable logrotate'
+  task :disable do
+    on roles(:app) do
+      within release_path do
+        set_config
+        if logrotate_disabled
+          puts 'logrotate already disabled'
+        else
+          whenever 'clear' if logrotate_enabled
+          delete_files
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'logrotate_helper'
+
+namespace :logrotate do
+  include LogrotateHelper
+  desc 'Enable logrotate for the application'
+  task :enable do
+    on roles(:app) do
+      within release_path do
+        set_config
+        if logrotate_enabled
+          puts "logrotate already enabled:\n========================="
+          puts capture "cat #{@config_file_path}"
+        else
+          make_basepath
+          upload! StringIO.new(@config_template), @config_file_path
+          upload! StringIO.new(@schedule_template), @schedule_file_path
+          whenever 'update' if logrotate_enabled
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/ops/capistrano/v3/tasks/logrotate/logrotate_helper.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module LogrotateHelper
+  # rubocop:disable Naming/MemoizedInstanceVariableName
+  def set_config
+    info ''
+    @shared_path ||= shared_path
+    @log_file_path ||= fetch(:log_file_path) || "#{@shared_path}/log"
+    @template_config_filename ||= fetch(:logrotate_template_config_file) || 'templates/logrotate.conf.erb'
+    @template_schedule_filename ||= fetch(:logrotate_template_schedule_file) || 'templates/schedule.rb.erb'
+    @basepath ||= fetch(:logrotate_basepath) || "#{shared_path}/logrotate"
+    @config_filename ||= File.basename(@template_config_filename, '.erb')
+    @schedule_filename ||= File.basename(@template_schedule_filename, '.erb')
+    @config_file_path ||= "#{@basepath}/#{@config_filename}"
+    @schedule_file_path ||= "#{@basepath}/#{@schedule_filename}"
+    @config_template ||= config_template
+    @schedule_template ||= schedule_template
+  end
+  # rubocop:enable Naming/MemoizedInstanceVariableName
+
+  def config
+    {
+      template_config_file: fetch(:logrotate_template_config_file) || 'templates/logrotate.conf.erb',
+      template_schedule_file: fetch(:logrotate_template_schedule_file) || 'templates/schedule.rb.erb'
+    }
+  end
+
+  def make_basepath
+    puts capture "mkdir -pv #{@basepath}"
+  end
+
+  def delete_files
+    puts capture "rm -rfv #{@basepath}"
+  end
+
+  def config_template
+    return nil unless @template_config_filename && File.exist?(File.expand_path(@template_config_filename, __dir__))
+
+    ERB.new(File.read(File.expand_path(@template_config_filename, __dir__))).result(binding)
+  end
+
+  def schedule_template
+    return nil unless @template_schedule_filename && File.exist?(File.expand_path(@template_schedule_filename, __dir__))
+
+    ERB.new(File.read(File.expand_path(@template_schedule_filename, __dir__))).result(binding)
+  end
+
+  def logrotate_enabled
+    test("[ -f #{@config_file_path} ]") && test("[ -f #{@schedule_file_path} ]")
+  end
+
+  def logrotate_disabled
+    !(test("[ -f #{@config_file_path} ]") && test("[ -f #{@schedule_file_path} ]"))
+  end
+
+  def whenever(type)
+    case type
+    when 'clear'
+      puts capture :bundle, :exec, :whenever, '--clear-crontab',
+                   "-f #{@schedule_file_path} #{fetch(:whenever_identifier)}_logrotate"
+    when 'update'
+      puts capture :bundle, :exec, :whenever, '--update-crontab', "-f #{@schedule_file_path}",
+                   "-i #{fetch(:whenever_identifier)}_logrotate"
+    else
+      puts 'type not found'
+    end
+  end
+end

data/lib/capistrano/ops/capistrano/v3/tasks/logrotate/templates/logrotate.conf.erb

@@ -0,0 +1,10 @@
+<%= @log_file_path %>/*.log {
+        daily
+        dateext
+        missingok
+        rotate 52
+        compress
+        delaycompress
+        notifempty
+        copytruncate
+}

data/lib/capistrano/ops/capistrano/v3/tasks/logrotate/templates/schedule.rb.erb

@@ -0,0 +1,8 @@
+env :PATH, ENV['PATH']
+set :output, -> { '2>&1 | logger -t logrotate' }
+
+job_type :logrotate, '/usr/sbin/logrotate -s <%= @shared_path %>/logrotate/status <%= @shared_path %>/logrotate/logrotate.conf :output'
+
+every "0 0 * * *" do
+    logrotate "logrotate"
+end

data/lib/capistrano/ops/capistrano.rb

@@ -6,10 +6,11 @@ if defined?(Capistrano::VERSION) && Gem::Version.new(Capistrano::VERSION).releas
   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/logs.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
   puts 'Capistrano 3 is required to use this gem'
 end

data/lib/capistrano/ops/version.rb

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

data/lib/capistrano/ops/wkhtmltopdf.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+load File.expand_path('capistrano/tasks/wkhtmltopdf.rake', __dir__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-ops
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.13
 platform: ruby
 authors:
 - Florian Crusius
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-15 00:00:00.000000000 Z
+date: 2024-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -120,6 +120,7 @@ files:
 - lib/capistrano/ops/backup/s3.rb
 - lib/capistrano/ops/backup/s3_helper.rb
 - 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
@@ -128,7 +129,13 @@ files:
 - 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
+- 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
@@ -141,6 +148,7 @@ files:
 - lib/capistrano/ops/tasks/storage/backup.rake
 - lib/capistrano/ops/tasks/storage/remove_old_backups.rake
 - lib/capistrano/ops/version.rb
+- lib/capistrano/ops/wkhtmltopdf.rb
 homepage: https://github.com/zauberware/capistrano-ops
 licenses:
 - MIT