bamboolab_kaboom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6131743c73049e741f8e78b6523a920f7f43a169f268d7dee816a35b1cbfe5c
+  data.tar.gz: 0df5be6710bde734916305e1a9402ef83a040120cce5ede56430f289c8ce77f4
+SHA512:
+  metadata.gz: 60d8e4c9ce9a98bcbcf2a52bf75f068d785c5e7192700fd51b95ce22eae1e013eb99dc1d128dc206a438fb1d8a50d156f2003abe10cc3ff8170a386bf82fb87a
+  data.tar.gz: 5a5400c999c25135c3fb711df4805b2ce42eb6876a56ddc37805b4ee6728c7106879b4c48ee87d74042dea1917e2b58bab33558d5e6ba56e94e3a0c2c5d8b124

data/bin/kaboom

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'kaboom'
+Kaboom::CLI.start(ARGV)

data/lib/kaboom/backup.rb

@@ -0,0 +1,141 @@
+require 'google/cloud/storage'
+require 'fileutils'
+require 'tty-progressbar'
+
+module Kaboom
+  class Backup < Thor
+    include Thor::Actions
+    include Utils
+    include Config
+
+    desc 'pull', 'Pull the latest assets and database backup from the deploy destination'
+    def pull(destination = 'staging')
+      database_pull(destination)
+      puts "\n"
+      assets_pull(destination)
+      say "Completed!", :green
+    end
+
+    desc 'apply', 'Apply a local backup to the database'
+    method_option :file, aliases: '-f', type: :string, desc: 'Backup file in to apply', default: 'db/latest.sql'
+    def apply
+      backup_file = options[:file]
+      unless File.exist?(backup_file)
+        say_and_exit "Error: Backup file #{backup_file} not found", :red
+      end
+      confirm_proceed("Do you want to apply the backup to your local database? THIS WILL REMOVE YOUR EXISTING LOCAL DATABASE")
+
+      local_db_config = database_config('development')
+      if DatabaseHelper.apply_backup(local_db_config, backup_file)
+        say "Backup applied successfully to local database!", :green
+      else
+        say_and_exit \
+          "Error: Backup restore failed. Is there an open connection to the local database? Stop the Rails application and try again.",
+          :red
+      end
+    end
+
+    private
+
+      def database_pull(destination)
+        validate_repository!
+        validate_destination(destination)
+        confirm_production_action('database backup pull') if destination == 'production'
+  
+        load_env(destination)
+        db_config = database_config(destination)
+        connection_string = DatabaseHelper.connection_string(db_config)
+  
+        database_size = DatabaseHelper.database_size(connection_string, destination)
+
+        if confirm_proceed("Database backup size will be around #{database_size}. Do you want to continue?", exit_on_no: false)
+          backup_file = ask_for_backup_filename
+    
+          say "Started pulling backup from #{destination} | #{DateTime.now.strftime("%H:%M:%S")}"
+          if DatabaseHelper.pull_backup(connection_string, destination, backup_file)
+            say "Backup pulled successfully to db/#{backup_file}.sql | #{DateTime.now.strftime("%H:%M:%S")}", :green
+          else
+            say_and_exit "Error: Backup pull failed", :red
+          end
+    
+          if confirm_proceed("Do you want to apply the backup to your local database? THIS WILL REMOVE YOUR EXISTING LOCAL DATABASE")
+            say "Applying backup to local database...", :white
+            local_db_config = database_config('development')
+            if DatabaseHelper.apply_backup(local_db_config, "db/#{backup_file}.sql")
+              say "Backup applied successfully to local database!", :green
+            else
+              say_and_exit \
+                "Error: Backup restore failed. Is there an open connection to the local database? Stop the Rails application and try again.",
+                :red
+              
+            end
+    
+            remove_backup_file(backup_file) if confirm_proceed("Do you want to remove the local backup file?", exit_on_no: false)
+          end
+        end
+      end
+
+      def assets_pull(destination)
+        validate_repository!
+        validate_destination(destination)
+        confirm_production_action('assets pull') if destination == 'production'
+
+        if confirm_proceed("Do you want to pull assets from #{destination}? Your local uploads folder will be deleted.")
+          credentials = load_credentials(destination)
+          say_and_exit("Error: Google Storage credentials not found in #{destination}.yml", :red) if credentials[:google_storage].nil?
+
+          project_name = credentials[:google_storage][:project_name]
+          bucket_name = credentials[:google_storage][:bucket_name]
+
+          File.open('.keyfile.json', 'w'){ |f| f.write(credentials[:google_storage][:json_key_string]) }
+          storage = Google::Cloud::Storage.new(
+            project_id: project_name,
+            credentials: ".keyfile.json", # It apsolutely needs to be a file, for some reason 
+          )
+          FileUtils.rm('.keyfile.json')
+
+          bucket = storage.bucket(bucket_name, skip_lookup: true)
+
+          files_number = bucket.files(prefix: 'uploads/').all(request_limit: 10_000).count
+          if confirm_proceed("#{files_number} files will be downloaded. Do you want to continue?", exit_on_no: false)
+            say "WARNING: There is no way to estimate the total size of all assets, make sure you have enough disk space!", :yellow
+            say "WARNING: This will take a while, depending on the number of files", :yellow
+            say "Started pulling assets from #{destination} | #{DateTime.now.strftime("%H:%M:%S")}", :white
+        
+            FileUtils.rm_rf('public/uploads')
+            FileUtils.mkdir_p('public/uploads')
+            local_folder = 'public/uploads'
+          
+            progress_bar = TTY::ProgressBar.new("Downloading [:bar] :current/:total files", total: files_number, width: 60)
+          
+            bucket = storage.bucket(bucket_name, skip_lookup: true)
+            bucket.files(prefix: 'uploads/').all(request_limit: 1000) do |file|
+              local_file_path = File.join(local_folder, file.name.sub('uploads/', ''))
+              FileUtils.mkdir_p(File.dirname(local_file_path))
+              
+              file.download(local_file_path)
+              
+              progress_bar.advance
+            end
+
+            say "Assets pulled successfully to #{local_folder} | #{DateTime.now.strftime("%H:%M:%S")}", :green
+          end
+        end
+      end
+
+      def ask_for_backup_filename
+        prompt = TTY::Prompt.new
+        prompt.ask("Enter the backup filename:", required: true) do |q|
+          q.modify :trim
+          q.validate(/^[\w\-. ]+$/, "Filename must contain only valid characters (letters, digits, dashes, underscores, periods, and spaces)")
+          q.default 'latest'
+        end
+      end
+
+      def remove_backup_file(backup_file)
+        File.delete("db/#{backup_file}.sql")
+        say "Local backup file removed", :white
+      end
+
+  end
+end

data/lib/kaboom/helpers/config.rb

@@ -0,0 +1,86 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_support/encrypted_file'
+require 'base64'
+require 'yaml'
+require 'openssl'
+require 'bundler'
+
+module Kaboom
+  module Config
+    include Thor::Actions
+    include Utils
+    
+    DESTINATIONS = Dir.glob("./config/deploy.*.yml").map { |file| file.match(/deploy\.(\w+)\.yml/)[1].to_sym }.freeze
+
+    def validate_repository!
+      unless Dir.exist?('.git')
+        say_and_exit "Error: This command must be run in a Git repository", :red
+      end
+
+      unless File.exist?('Gemfile') && File.exist?('config/application.rb') && File.exist?('config/routes.rb')
+        say_and_exit "Error: This command must be run in a root folder of a Rails application", :red
+      end
+
+      unless File.exist?('config/credentials/development.key')
+        say_and_exit "Error: development.key credentials file not found (source it from 1Password)", :red
+      end
+    
+      if DESTINATIONS.empty? && !File.exist?('./config/deploy.yml')
+        say_and_exit "Error: No deploy configuration files found in config directory.", :red
+      end
+
+      if Bundler::Dsl.evaluate('Gemfile', nil, {})&.ruby_version&.versions&.first != RUBY_VERSION
+        say_and_exit "Error: Ruby version in current projects Gemfile is not the same as the currently running Ruby version.", :red
+      end
+    end
+
+    def load_env(destination)
+      env_file = ".env.#{destination}"
+      if File.exist?(env_file)
+        ENV.update(Dotenv::Environment.new(env_file))
+      else
+
+        say_and_exit "Environment file #{env_file} not found, run 'kamal envify -d destination'", :red
+      end
+
+      destination_clear_envs = YAML.load_file("config/deploy.#{destination}.yml")['env']['clear']
+      ENV.update(destination_clear_envs.transform_values(&:to_s))
+    end
+
+    def load_credentials(destination)
+      credentials_key_file = "config/credentials/#{destination}.key"
+      credentials_file = "config/credentials/#{destination}.yml.enc"
+      
+      unless File.exist?(credentials_file) && File.exist?(credentials_key_file)
+        say_and_exit "Credentials file #{credentials_file} not found, make sure it is present", :red
+      end
+
+      key = [File.read(credentials_key_file)].pack("H*")
+      encrypted_credentials = File.binread(credentials_file)
+      
+      cipher = OpenSSL::Cipher.new('aes-128-gcm')
+      encrypted_data, iv, auth_tag = encrypted_credentials.split("--".freeze).map { |v| Base64.strict_decode64(v) }
+      
+      cipher.decrypt
+      cipher.key = key
+      cipher.iv = iv
+      cipher.auth_tag = auth_tag
+      cipher.auth_data = ""
+      
+      decrypted_data = cipher.update(encrypted_data)
+      decrypted_data << cipher.final
+      
+      return YAML.safe_load(Marshal.load(decrypted_data), symbolize_names: true)
+    end
+
+    def database_config(destination)
+      config = YAML.load_file('config/database.yml')[destination]
+      {
+        name: ERB.new(config['database']).result,
+        username: ERB.new(config['username']).result.presence || 'rails',
+        password: ERB.new(config['password']).result
+      }
+    end
+  end
+end

data/lib/kaboom/helpers/database_helper.rb

@@ -0,0 +1,33 @@
+module Kaboom
+  class DatabaseHelper
+    def self.connection_string(config)
+      "postgresql://#{config[:username]}:#{config[:password]}@127.0.0.2/#{config[:name]}"
+    end
+
+    def self.database_size(connection_string, destination)
+      query = "SELECT pg_size_pretty(pg_database_size(current_database()));"
+      command = %Q{kamal accessory exec db --reuse -i -q "psql #{connection_string} -c \\"#{query}\\"" -d #{destination} 2>/dev/null}
+      result = `#{command}`.strip
+      result.match(/\n\s*(.+?)\s*\n\(/) ? $1 : "Unknown MB"
+    end
+
+    def self.pull_backup(connection_string, destination, backup_file)
+      command = %Q{kamal accessory exec db --reuse -i -q "pg_dump #{connection_string}" -d #{destination} > db/#{backup_file}.sql 2>/dev/null}
+      system(command)
+    end
+
+    def self.apply_backup(config, backup_file)
+      local_connection_string = "postgresql://#{config[:username]}:#{config[:password]}@localhost/template1"
+      
+      commands = [
+        %Q{psql #{local_connection_string} -c "DROP DATABASE IF EXISTS #{config[:name]}" >/dev/null 2>&1},
+        %Q{psql #{local_connection_string} -c "CREATE DATABASE #{config[:name]};" >/dev/null 2>&1},
+        %Q{psql #{local_connection_string.gsub('template1', config[:name])} < #{backup_file} >/dev/null 2>&1},
+        %Q{RAILS_MASTER_KEY=`cat config/credentials/development.key` env bin/rails db:environment:set RAILS_ENV=development >/dev/null 2>&1},
+        %Q{psql #{local_connection_string} -c "ALTER DATABASE #{config[:name]} OWNER TO #{config[:username]};" >/dev/null 2>&1},
+      ]
+      #require 'pry'; binding.pry
+      commands.all? { |cmd| system(cmd) }
+    end
+  end
+end

data/lib/kaboom/helpers/utils.rb

@@ -0,0 +1,22 @@
+module Kaboom
+  module Utils
+    def say_and_exit(message, color)
+      say message, color
+      exit(1)
+    end
+
+    def validate_destination(destination)
+      unless Config::DESTINATIONS.include?(destination.to_sym)
+        say_and_exit("Error: Unknown destination '#{destination}', valid destinations are: #{Config::DESTINATIONS.join(', ')}", :red)
+      end
+    end
+
+    def confirm_production_action(command)
+      confirm_proceed("You are about to run a #{command} on a production environment. Are you sure you want to continue?")
+    end
+
+    def confirm_proceed(message, exit_on_no: true)
+      yes?(message + " (y/n):", :yellow) || (exit_on_no ? (say("Action aborted", :red) && exit(1)) : false)
+    end
+  end
+end

data/lib/kaboom/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Kaboom
+  VERSION = "0.1.0"
+end

data/lib/kaboom.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative "kaboom/version"
+require 'yaml'
+require 'erb'
+require 'dotenv'
+require 'thor'
+require 'tty-prompt'
+require 'kamal'
+require 'google/cloud/storage'
+
+require_relative 'kaboom/helpers/utils'
+require_relative 'kaboom/helpers/config'
+require_relative 'kaboom/helpers/database_helper'
+
+require_relative 'kaboom/backup'
+
+module Kaboom
+  class Error < StandardError; end
+
+  class CLI < Thor
+    include Thor::Actions
+    include Utils
+    include Config
+    
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'backup', 'Run database backup/restore related commands'
+    subcommand 'backup', Kaboom::Backup
+
+    desc 'console DESTINATION', 'Run Rails console for deployed apps, defaults to staging'
+    method_option :role, aliases: '-r', type: :string, desc: 'Role to run the console at (web, sidekiq, cron...)', default: 'web'
+    def console(destination = 'staging')
+      validate_repository!
+      validate_destination(destination)
+
+      confirm_production_action('console') if destination == 'production'
+      run_command("bundle exec rails c", destination)
+    end
+
+    desc 'ssh DESTINATION', 'Run a bash SSH for deployed apps, defaults to staging'
+    method_option :role, aliases: '-r', type: :string, desc: 'Role to run the SSH at (web, sidekiq, cron...)', default: 'web'
+    def ssh(destination = 'staging')
+      validate_repository!
+      validate_destination(destination)
+
+      confirm_production_action('SSH') if destination == 'production'
+      run_command("bash", destination)
+    end
+
+    private
+
+      def run_command(command, destination)
+        say "Running #{command} on #{destination}...", :green
+        exec("kamal app exec -i --reuse -q '#{command}' -d #{destination} --roles=#{options[:role]}")
+      end
+
+  end
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: bamboolab_kaboom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Your Name
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kamal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-storage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Kaboom is a CLI tool to handle app maintenence, SSH connections, database
+  and assets backups for apps deployed by Kamal.
+email:
+- your.email@example.com
+executables:
+- kaboom
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/kaboom
+- lib/kaboom.rb
+- lib/kaboom/backup.rb
+- lib/kaboom/helpers/config.rb
+- lib/kaboom/helpers/database_helper.rb
+- lib/kaboom/helpers/utils.rb
+- lib/kaboom/version.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: A CLI for managing Rails apps deployed by Kamal.
+test_files: []