zauberware-devops 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 06e76ef48ec28db7e06e1b00fda968e2e4fec43b407796be19077bf47f9fb228
+  data.tar.gz: 599ceabd442cdf60dad419d9567ab689e8d883c1288f53e81c1d75f197487e1a
+SHA512:
+  metadata.gz: bdf635c7efff594ac64211bf6981553462337fdc235602e36779938f89e93f9669e2a16d6821b869ba05b3b4bf0fe3197d85014689f110a1bd997dafa792b210
+  data.tar.gz: eab9bdc31bd4f6aaa206ae93b96359c391b1cff1bb79bf3c3d63426c2af848d5791b65af2de261223f29720464c2f954abb2fc3f8ce509ab5296f2f82e59a61b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+
+before_install: gem install bundler
+
+rvm:
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
+  - jruby-9.2.6.0
+
+env:
+  global:
+    - JRUBY_OPTS=--debug

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zauberware-devops.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sheharyar Naseer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,125 @@
+# zauberware-devops
+
+Library of useful scripts for DevOps using capistrano with rails.
+
+**Only supports Capistrano 3 and above**.
+
+## Requirements
+
+```ruby
+'capistrano', '~> 3.0'
+'whenever'
+```
+
+## Installation
+
+Add the gem to your `Gemfile` after setting up Capistrano
+group:
+
+```ruby
+group :development do
+  gem 'capistrano', require: false
+end
+
+gem 'zauberware-devops'
+```
+
+Then `bundle` and add it to your `Capfile`
+
+```ruby
+# Capfile
+
+require 'zauberware/devops/capistrano'
+```
+
+and `initializers`
+
+```ruby
+# initializers/zauberware_devops.rb
+require 'zauberware/devops'
+```
+
+## Script overview
+
+| Script                                           | Description                                                       |
+| ------------------------------------------------ | ----------------------------------------------------------------- |
+| `cap <environment> backup:create`                | creates backup of postgres database on the server                 |
+| `cap <environment> backup:pull`                  | download latest postgres 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                                        |
+| `rake pg:dump`                                   | creates postgres database backup                                  |
+| `rake pg:remove_old_dumps`                       | remove old postgres backups                                       |
+
+## Usage
+
+for all backup task you have to setup your database.yml properly:
+
+```
+production:
+
+  database: database_name
+  username: database_username
+  password: database_password
+  host: database_host
+  port: database_port
+```
+
+### Optional Settings for backup task
+
+| env               | description                         |
+| ----------------- | ----------------------------------- |
+| NUMBER_OF_BACKUPS | number of backups to keep           |
+| BACKUPS_ENABLED   | enable/disable backup task          |
+| DEFAULT_URL       | for slack integration message title |
+| SLACK_SECRET      | for slack integration               |
+| SLACK_CHANNEL     | for slack integration               |
+
+### use with whenever/capistrano
+
+install whenever gem and add this to your schedule.rb
+
+```ruby
+# config/schedule.rb
+# Use this file to easily define all of your cron jobs.
+env :PATH, ENV['PATH']
+set :output, -> { '2>&1 | logger -t whenever_cron' }
+
+every :day, at: '2:00 am' do
+  rake 'pg:dump'
+end
+
+every :day, at: '3:00 am' do
+  rake 'pg:remove_old_dumps'
+end
+```
+
+add this to your capfile
+
+```ruby
+# Capfile
+require 'whenever/capistrano'
+```
+
+## Configuration
+
+You can optionally specify the capistrano roles for the rake task (Defaults to `:app`):
+
+```ruby
+# Defaults to [:app]
+set :rake_roles, %i[db app]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/zauberware/zauberware-devops/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+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).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'capistrano/rake'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/zauberware/devops/capistrano/v3/tasks/backup.rake

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+namespace :backup do
+  # 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
+      env = "RAILS_ENV=#{fetch(:stage)}"
+      # rubocop:disable Layout/LineLength
+      path_cmd = "PATH=$HOME/.rbenv/versions/#{RUBY_VERSION}/bin:$PATH"
+      # rubocop:enable Layout/LineLength
+      execute "cd #{release_path} && #{path_cmd} && #{env} BACKUPS_ENABLED=true bundle exec rake pg:dump"
+    end
+  end
+  desc 'pull latest database backups from server to local'
+  task :pull do
+    on roles(rake_roles) do
+      # rubocop:disable Layout/LineLength
+      execute "cd #{shared_path}/backups && tar -czf #{shared_path}/backups.tar.gz $(ls -lt | grep -E -i '.{0,}\.dump' | head -n 1 | awk '{print $9}')"
+      # rubocop:enable Layout/LineLength
+      download! "#{shared_path}/backups.tar.gz", 'backups.tar.gz'
+      execute "rm #{shared_path}/backups.tar.gz"
+      system 'tar -xzf backups.tar.gz'
+      system 'rm backups.tar.gz'
+    end
+  end
+end

data/lib/zauberware/devops/capistrano/v3/tasks/figaro_yml.rake

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/BlockLength
+namespace :figaro_yml do
+  # Defaults to :app role
+  rake_roles = fetch(:rake_roles, :app)
+
+  desc 'get the figaro_yml file from the server'
+  task :get do
+    on roles(rake_roles) do
+      puts capture "cat #{shared_path}/config/application.yml"
+    end
+  end
+
+  task :compare do
+    env = fetch(:stage)
+    # read local application.yml
+    local = File.read('config/application.yml')
+
+    # convert to hash
+    local_global_env = YAML.safe_load(local)
+
+    # split into stage and global
+    local_stage_env = local_global_env[env.to_s]
+    local_global_env.delete('staging')
+    local_global_env.delete('production')
+
+    on roles(rake_roles) do
+      # read remote application.yml
+      remote = capture("cat #{shared_path}/config/application.yml")
+
+      remote_global_env = YAML.safe_load(remote)
+      remote_stage_env = remote_global_env[env.to_s]
+      remote_global_env.delete(env.to_s)
+
+      puts "with command 'cap #{env} figaro_yml:setup', following variables will be overwritten:"
+      puts '--------------------------------------------------------------------------------'
+      result1 = compare_hashes(local_global_env, remote_global_env)
+      result2 = compare_hashes(local_stage_env, remote_stage_env)
+      if !result1.empty? || !result2.empty?
+        loop do
+          print 'Update remote application.yml? (y/N): '  
+          input = $stdin.gets.strip.downcase
+          answer = (input.empty? ? 'N' : input).downcase.to_s
+
+          next unless %w(y n).include?(answer)
+        
+          if answer == 'y'
+            puts 'Updating remote application.yml'
+            invoke 'figaro_yml:setup'
+            exit
+          end
+          break
+        end
+        puts 'remote application.yml not updated'
+        exit
+      end
+      puts 'remote application.yml is up to date'
+    end
+  end
+  def compare_hashes(hash1, hash2)
+        changes = false
+        local_server = hash1.to_a - hash2.to_a
+        server_local = hash2.to_a - hash1.to_a
+        
+        [local_server + server_local].flatten(1).to_h.keys.each do |k|
+            new_value = hash1[k].to_s
+            new_value = new_value.empty? ? "nil" : new_value
+            old_value = hash2[k].to_s
+            old_value = old_value.empty? ? "nil" : old_value
+            if old_value != new_value
+                puts "#{k}: #{old_value} => #{new_value} \r\n"
+                changes = true
+            end
+        end
+    end
+end
+# rubocop:enable Metrics/BlockLength

data/lib/zauberware/devops/capistrano/v3/tasks/invoke.rake

@@ -0,0 +1,24 @@
+namespace :invoke do
+
+    # Defalut to :app roles
+    rake_roles = fetch(:rake_roles, :app)
+  
+    desc "Execute a rake task on a remote server (cap invoke:rake TASK=db:migrate)"
+    task :rake do
+      if ENV['TASK']
+        on roles(rake_roles) do
+          within current_path do
+            with rails_env: fetch(:rails_env) do
+              execute :rake, ENV['TASK']
+            end
+          end
+        end
+  
+      else
+        puts "\n\nFailed! You need to specify the 'TASK' parameter!",
+             "Usage: cap <stage> invoke:rake TASK=your:task"
+      end
+    end
+  
+  end
+  

data/lib/zauberware/devops/capistrano/v3/tasks/logs.rake

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+namespace :logs do
+  # Default to :app role
+  rake_roles = fetch(:rake_roles, :app)
+  desc 'tail rails logs'
+  task :rails do
+    on roles(rake_roles) do
+      trap('SIGINT') do
+        puts "\nDisconnecting..."
+        exit
+      end
+      execute "tail -f #{shared_path}/log/#{fetch(:rails_env)}.log"
+    end
+  end
+end

data/lib/zauberware/devops/capistrano/v3/tasks/whenever.rake

@@ -0,0 +1,12 @@
+# 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
+      puts capture 'crontab -l'
+    end
+  end
+end

data/lib/zauberware/devops/capistrano.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'capistrano/version'
+
+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/logs.rake', __dir__)
+  load File.expand_path('capistrano/v3/tasks/invoke.rake', __dir__)
+else
+  puts 'Capistrano 3 is required to use this gem'
+end

data/lib/zauberware/devops/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'zauberware/devops'
+require 'rails'
+module Zauberware
+  module DevOps
+    class Railtie < Rails::Railtie
+      railtie_name :devops
+      rake_tasks do
+        path = File.expand_path(__dir__)
+        Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+      end
+    end
+  end
+end

data/lib/zauberware/devops/tasks/pg/dump.rake

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/BlockLength
+namespace :pg do
+  default_backup_path = Rails.env.development? ? 'tmp/backups' : '../../shared/backups'
+  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(default_backup_path).to_s
+  backups_enabled = Rails.env.production? || ENV['BACKUPS_ENABLED'] == 'true'
+
+  task :dump do
+    date = Time.now.to_i
+    user = username.present? ? " -U #{username}" : ''
+    host = hostname.present? ? " -h #{hostname}" : ''
+    port = portnumber.present? ? " -p #{portnumber}" : ''
+    # rubocop:disable Layout/LineLength
+    dump_cmd = "export PGPASSWORD='#{password}' && cd #{backup_path} && pg_dump -d #{database}#{user}#{host}#{port} > #{database}_#{date}.dump"
+    # rubocop:enable Layout/LineLength
+    if backups_enabled
+      system "mkdir -p #{backup_path}" unless Dir.exist?(backup_path)
+      result = system(dump_cmd)
+      slack_notification(result, date, database, backup_path)
+    end
+    if backups_enabled
+      # rubocop:disable Layout/LineLength
+      p result ? "Backup created: #{backup_path}/#{database}_#{date}.dump" : "Backup failed, created empty file at #{backup_path}/#{database}_#{date}.dump"
+    # rubocop:enable Layout/LineLength
+    else
+      p 'dump: Backups are disabled'
+    end
+  end
+  # rubocop:disable Metrics/MethodLength
+  def slack_notification(result, date, database, backup_path)
+    return unless ENV['SLACK_SECRET'].present? && ENV['SLACK_CHANNEL'].present?
+
+    message_one = "Backup of #{database} successfully finished at #{Time.now}"
+    message_two = "Backup path:\`#{backup_path}/#{database}_#{date}.dump\`"
+    data = {
+      channel: ENV['SLACK_CHANNEL'],
+      blocks: [
+        {
+          type: 'header',
+          text: {
+            type: 'plain_text',
+            text: ENV['DEFAULT_URL'] || "#{database} Backup",
+            emoji: true
+          }
+        },
+        {
+          type: 'section',
+          text: {
+            type: 'mrkdwn',
+            text: result ? "#{message_one}\n#{message_two}" : "Backup of #{database} failed at #{Time.now}"
+          }
+        }
+      ]
+    }
+    # rubocop:disable Layout/LineLength
+    curl = "curl -X POST https://slack.com/api/chat.postMessage -H 'Content-type: application/json; charset=utf-8' --data '#{data.to_json}' -H 'Authorization: Bearer #{ENV['SLACK_SECRET']}'"
+    # rubocop:enable Layout/LineLength
+    system curl
+  end
+  # rubocop:enable Metrics/MethodLength
+end
+# rubocop:enable Metrics/BlockLength

data/lib/zauberware/devops/tasks/pg/remove_old_dumps.rake

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+namespace :pg do
+  default_backup_path = Rails.env.development? ? 'tmp/backups' : '../../shared/backups'
+  database = Rails.configuration.database_configuration[Rails.env]['database']
+
+  backup_path = Rails.root.join(default_backup_path).to_s
+  backups_enabled = Rails.env.production? || ENV['BACKUPS_ENABLED'] == 'true'
+
+  task :remove_old_dumps do
+    bash_regex = "'#{database}.{0,}\.dump'"
+    total_backups_no = ENV['NUMBER_OF_BACKUPS'] || 1
+    # rubocop:disable Layout/LineLength
+    cmd = "cd #{backup_path} && ls -lt | grep -E -i #{bash_regex} | tail -n +#{total_backups_no.to_i + 1} | awk '{print $9}'|xargs rm -rf"
+    # rubocop:enable Layout/LineLength
+    system(cmd) if backups_enabled
+    p backups_enabled ? 'Old backups removed' : 'remove_old_dumps: Backups are disabled'
+  end
+end

data/lib/zauberware/devops/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Zauberware
+  module DevOps
+    VERSION = '0.0.8'
+  end
+end

data/lib/zauberware/devops.rb

@@ -0,0 +1,21 @@
+module Zauberware
+    module DevOps
+        require 'zauberware/devops/railtie' if defined?(Rails)
+
+        def self.path
+            Dir.pwd
+        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.bundler?
+            File.exist?(File.join(path, 'Gemfile'))
+        end
+    end
+end

data/zauberware-devops.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+require 'zauberware/devops/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'zauberware-devops'
+  s.version       = Zauberware::DevOps::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ['Florian Crusius']
+  s.email         = ['florian@zauberware.com']
+  s.license       = 'MIT'
+  s.homepage      = 'https://github.com/zauberware/zauberware-devops'
+  s.summary       = 'devops tasks for rails applications'
+  s.description   = 'A collection of devops tasks for rails applications'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/{functional,unit}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'bundler', '~> 1.11'
+  s.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: zauberware-devops
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- Florian Crusius
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A collection of devops tasks for rails applications
+email:
+- florian@zauberware.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zauberware/devops.rb
+- lib/zauberware/devops/capistrano.rb
+- lib/zauberware/devops/capistrano/v3/tasks/backup.rake
+- lib/zauberware/devops/capistrano/v3/tasks/figaro_yml.rake
+- lib/zauberware/devops/capistrano/v3/tasks/invoke.rake
+- lib/zauberware/devops/capistrano/v3/tasks/logs.rake
+- lib/zauberware/devops/capistrano/v3/tasks/whenever.rake
+- lib/zauberware/devops/railtie.rb
+- lib/zauberware/devops/tasks/pg/dump.rake
+- lib/zauberware/devops/tasks/pg/remove_old_dumps.rake
+- lib/zauberware/devops/version.rb
+- zauberware-devops.gemspec
+homepage: https://github.com/zauberware/zauberware-devops
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: devops tasks for rails applications
+test_files: []