sg_tiny_backup 1.0.0

data/lib/sg_tiny_backup/spawner.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "shellwords"
+require "sg_tiny_backup/error"
+
+module SgTinyBackup
+  class Spawner
+    attr_reader :stdout, :stderr, :exit_code_errors
+
+    def initialize(commands:, env: {}, output_path: nil)
+      @commands = commands
+      @env = env
+      @output_path = output_path
+      @stderr_message = nil
+      @exit_code_errors = []
+    end
+
+    def succeeded?
+      exit_code_errors.empty?
+    end
+
+    def stderr_message
+      @stderr_message ||=
+        if @stderr.empty?
+          ""
+        else
+          <<~END_OF_MESSAGE
+            STDERR messages:
+
+            #{@stderr}
+          END_OF_MESSAGE
+        end
+    end
+
+    def exit_code_error_message
+      if succeeded?
+        ""
+      else
+        <<~END_OF_MESSAGE
+          The following errors were returned:
+
+          #{@exit_code_errors.join("\n")}
+        END_OF_MESSAGE
+      end
+    end
+
+    def spawn_and_wait
+      spawn_pipeline_command do |pid, out_r, err_r, status_r|
+        @stdout = out_r.read
+        @stderr = err_r.read
+        pipe_status_str = status_r.read
+        Process.wait(pid)
+        parse_pipe_status(pipe_status_str)
+      end
+    rescue StandardError => e
+      raise SpawnError.new("Pipeline failed to execute", e)
+    end
+
+    private
+
+    def spawn_pipeline_command
+      opts = {}
+      out_r, out_w = IO.pipe
+      opts[:out] = out_w
+
+      err_r, err_w = IO.pipe
+      opts[:err] = err_w
+
+      status_r, status_w = IO.pipe
+      opts[3] = status_w
+
+      pid = spawn(@env, pipeline_command, opts)
+      out_w.close
+      err_w.close
+      status_w.close
+
+      yield pid, out_r, err_r, status_r
+    end
+
+    # pipe_status_str format:
+    #   {command index}|{exit status}:\n{command index}|{exit status}:\n
+    #
+    # For example, "0|2:\n1|0:\n" means:
+    # * command 0 exited with status 2
+    # * command 1 exited with status 0
+    def parse_pipe_status(pipe_status_str)
+      @exit_code_errors = []
+      pipe_statuses = pipe_status_str.delete("\n").split(":").sort
+      pipe_statuses.each do |status|
+        index, exit_code = status.split("|").map(&:to_i)
+        command = @commands[index]
+        next if command.success_codes.member?(exit_code)
+
+        @exit_code_errors << "`#{command.command}` returned exit code: #{exit_code}"
+      end
+    end
+
+    # Pipeline command example:
+    #
+    #   { tar -c log/production.log log/production.log.1 ; echo "0|$?:" >&3 ; } | { gzip ; echo "1|$?:" >&3 ; } > log.tar.gz
+    #
+    # This output each command's exit status to file descriptor 3.
+    def pipeline_command
+      parts = []
+      @commands.each_with_index do |command, index|
+        parts << %({ #{command.command} ; echo "#{index}|$?:" >&3 ; })
+      end
+      command = parts.join(" | ")
+      command += " > #{Shellwords.escape(@output_path)}" if @output_path
+      command
+    end
+  end
+end

data/lib/sg_tiny_backup/templates/sg_tiny_backup.yml

@@ -0,0 +1,43 @@
+s3:
+  db:
+    # Destination url is `s3://{BUCKET}/{PREFIX}_{TIMESTAMP}.sql.gz.enc`.
+    bucket: YOUR_S3_BUCKET_NAME
+    prefix: YOUR_PROJECT/YOUR_PROJECT
+    access_key_id: <%= ENV.fetch('AWS_ACCESS_KEY_ID') %>
+    secret_access_key: <%= ENV.fetch('AWS_SECRET_ACCESS_KEY') %>
+    # If your backup file size exceeds 50GB, you must specify `expected_upload_size`.
+    # It must be larger than your backup file size.
+    # It is passed to `aws s3 cp`'s `--expected-size` option.
+    # See https://docs.aws.amazon.com/cli/latest/reference/s3/cp.html
+    #
+    # It is used for the calculation of S3 multipart upload chunk size not to exceed the part number limit.
+    # See https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html
+    #
+    # expected_upload_size: 100000000000
+  log:
+    # Destination url is `s3://{BUCKET}/{PREFIX}_{HOSTNAME}_{TIMESTAMP}.tar.gz`.
+    bucket: YOUR_S3_BUCKET_NAME
+    prefix: YOUR_PROJECT/YOUR_PROJECT
+    access_key_id: <%= ENV.fetch('AWS_ACCESS_KEY_ID') %>
+    secret_access_key: <%= ENV.fetch('AWS_SECRET_ACCESS_KEY') %>
+    # expected_upload_size: 100000000000
+# You can generate ENCRYPTION_KEY with `bundle exec rails secret`.
+encryption_key: <%= ENV.fetch('ENCRYPTION_KEY') %>
+log:
+  files:
+    - log/production.log
+  optional_files:
+    - log/production.log.1
+pg_dump:
+  extra_options: -xc --if-exists --encoding=utf8
+mysqldump:
+  extra_options: --single-transaction --quick --hex-blob
+# gzip:
+#   level: 6  # 1 (fastest) to 9 (best compression), default: 6
+# The following settings is not required since database config can be loaded from config/database.yml in typical rails application.
+# db:
+#   adapter: postgresql
+#   host: localhost
+#   port: 5432
+#   username: postgres
+#   password: YOUR_DB_PASSWORD

data/lib/sg_tiny_backup/utils.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "socket"
+require "yaml"
+require "erb"
+
+module SgTinyBackup
+  module Utils
+    class << self
+      def timestamp
+        Time.now.strftime("%Y%m%d_%H%M%S")
+      end
+
+      def basename(target)
+        if target == "log"
+          "#{Socket.gethostname}_#{timestamp}"
+        else
+          timestamp
+        end
+      end
+
+      def load_yaml_with_erb(io)
+        yaml_content = io.read
+        resolved = ERB.new(yaml_content).result
+        YAML.safe_load(
+          resolved,
+          permitted_classes: [],
+          permitted_symbols: [],
+          aliases: true
+        )
+      end
+    end
+  end
+end

data/lib/sg_tiny_backup/version.rb

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

data/lib/sg_tiny_backup.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "logger"
+require "sg_tiny_backup/config"
+require "sg_tiny_backup/runner"
+require "sg_tiny_backup/utils"
+require "sg_tiny_backup/version"
+require "sg_tiny_backup/railtie" if defined?(Rails)
+
+module SgTinyBackup
+  class << self
+    attr_accessor :raise_on_error
+    attr_writer :logger
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+  end
+end
+
+SgTinyBackup.raise_on_error = true

data/lib/tasks/sg_tiny_backup.rake

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+namespace :sg_tiny_backup do
+  default_config_path = ENV["SG_TINY_BACKUP_CONFIG_PATH"] || "config/sg_tiny_backup.yml"
+  default_backup_target = ENV["BACKUP_TARGET"] || "db"
+
+  desc "Generate config file"
+  task generate: :environment do
+    SgTinyBackup::Config.generate_template_file(default_config_path)
+  end
+
+  desc "Backup and upload to s3"
+  task :backup, [:backup_target] => :environment do |_task, args|
+    backup_target = args[:backup_target] || default_backup_target
+    config = SgTinyBackup::Config.read_file(default_config_path)
+    runner = SgTinyBackup::Runner.new(
+      config: config,
+      target: backup_target,
+      basename: SgTinyBackup::Utils.basename(backup_target)
+    )
+    url = runner.s3_destination_url
+    SgTinyBackup.logger.info "Starting backup to #{url}"
+    if runner.run
+      SgTinyBackup.logger.info "Backup done!"
+    else
+      SgTinyBackup.logger.error "Backup failed!"
+      exit 1
+    end
+  end
+
+  desc "Backup to current directory"
+  task :backup_local, [:backup_target] => :environment do |_task, args|
+    backup_target = args[:backup_target] || default_backup_target
+    config = SgTinyBackup::Config.read_file(default_config_path)
+    runner = SgTinyBackup::Runner.new(
+      config: config,
+      target: backup_target,
+      basename: SgTinyBackup::Utils.basename(backup_target),
+      local: true
+    )
+    SgTinyBackup.logger.info "Starting backup to #{runner.base_filename}"
+    if runner.run
+      SgTinyBackup.logger.info "Backup done!"
+    else
+      SgTinyBackup.logger.error "Backup failed!"
+      exit 1
+    end
+  end
+
+  desc "Show backup command"
+  task :command, [:backup_target] => :environment do |_task, args|
+    backup_target = args[:backup_target] || default_backup_target
+    config = SgTinyBackup::Config.read_file(default_config_path)
+    runner = SgTinyBackup::Runner.new(
+      config: config,
+      target: backup_target,
+      basename: SgTinyBackup::Utils.timestamp
+    )
+    puts runner.piped_command
+  end
+
+  desc "Show backup command environment variables"
+  task :env, [:backup_target] => :environment do |_task, args|
+    backup_target = args[:backup_target] || default_backup_target
+    config = SgTinyBackup::Config.read_file(default_config_path)
+    runner = SgTinyBackup::Runner.new(
+      config: config,
+      target: backup_target,
+      basename: SgTinyBackup::Utils.timestamp
+    )
+    puts runner.env
+  end
+
+  desc "Show decryption command"
+  task decryption_command: :environment do
+    puts SgTinyBackup::Commands::Openssl.decryption_command
+  end
+end

data/sg_tiny_backup.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/sg_tiny_backup/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sg_tiny_backup"
+  spec.version       = SgTinyBackup::VERSION
+  spec.authors       = ["Shunichi Ikegami"]
+  spec.email         = ["shunichi@sonicgarden.jp"]
+
+  spec.summary       = "Tiny backup"
+  spec.description   = "Backup postgresql database and logs to S3"
+  spec.homepage      = "https://github.com/SonicGarden/sg_tiny_backup"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  # spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/SonicGarden/sg_tiny_backup"
+  spec.metadata["changelog_uri"] = "https://github.com/SonicGarden/sg_tiny_backup/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: sg_tiny_backup
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shunichi Ikegami
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-03-03 00:00:00.000000000 Z
+dependencies: []
+description: Backup postgresql database and logs to S3
+email:
+- shunichi@sonicgarden.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".octocov.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".simplecov"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/database.ci.yml
+- lib/sg_tiny_backup.rb
+- lib/sg_tiny_backup/commands.rb
+- lib/sg_tiny_backup/commands/aws_cli.rb
+- lib/sg_tiny_backup/commands/base.rb
+- lib/sg_tiny_backup/commands/gzip.rb
+- lib/sg_tiny_backup/commands/mysql_dump.rb
+- lib/sg_tiny_backup/commands/openssl.rb
+- lib/sg_tiny_backup/commands/pg_dump.rb
+- lib/sg_tiny_backup/commands/tar.rb
+- lib/sg_tiny_backup/config.rb
+- lib/sg_tiny_backup/error.rb
+- lib/sg_tiny_backup/pipeline.rb
+- lib/sg_tiny_backup/pipeline_builders/base.rb
+- lib/sg_tiny_backup/pipeline_builders/db.rb
+- lib/sg_tiny_backup/pipeline_builders/log.rb
+- lib/sg_tiny_backup/pipeline_builders/s3.rb
+- lib/sg_tiny_backup/railtie.rb
+- lib/sg_tiny_backup/runner.rb
+- lib/sg_tiny_backup/spawner.rb
+- lib/sg_tiny_backup/templates/sg_tiny_backup.yml
+- lib/sg_tiny_backup/utils.rb
+- lib/sg_tiny_backup/version.rb
+- lib/tasks/sg_tiny_backup.rake
+- sg_tiny_backup.gemspec
+homepage: https://github.com/SonicGarden/sg_tiny_backup
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/SonicGarden/sg_tiny_backup
+  source_code_uri: https://github.com/SonicGarden/sg_tiny_backup
+  changelog_uri: https://github.com/SonicGarden/sg_tiny_backup/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Tiny backup
+test_files: []