kamal-backup 0.3.0.beta7 → 0.3.0.beta9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 841b29d2ee8cc4598cb1880da4a7bf884cef141816432a9d960ff400b7535d25
-  data.tar.gz: 3784f1bfe50f1480f457bfb40a18e30ab5905db4a300a193fe5d68ac50d67f2f
+  metadata.gz: c7c67946461c23a767a12d31d82389bb4e0fb3c75a5494f102c4dad8facecb2e
+  data.tar.gz: f0265c16c92bdf291bf19f0586589af08938962c5a6b79635f782559dee75d39
 SHA512:
-  metadata.gz: 9929349441963b8297254c10faa1446cf4f7602638a7637ab655ffcadb32d31d012ea8827890fc29175dfc4e344a5afc1edacbf960cfe86d6aec2a83c88385c6
-  data.tar.gz: fbfee00eae64424a92e5d039512ff51d01abecb6dd6a61d8d44ec97dc2e86208f06fd5c191947107a9c9adaa4da80a77a9eebabc9e9e12b96d7e60dcb0ce0e06
+  metadata.gz: f919b9df92d55407c57745e61cfa4fd011c15060ab6edd5d93b75516fef13b22f0490e7010531bb6c464578df6a25faf8a485d6a35f5431f9a6e53331cef90a5
+  data.tar.gz: d7243e236effb7c4da158c70993af8896e39764952f9dc2155a123655ddac49931804c67dd10424d10a5ddcdd0208542a28fe798256691a4cb2287ef35bba242

data/lib/kamal_backup/app.rb

@@ -16,6 +16,8 @@ require_relative "schema"
 
 module KamalBackup
   class App
+    FRESH_BACKUP_GRACE_SECONDS = 5
+
     attr_reader :config, :redactor
 
     def initialize(env: ENV, config: nil, redactor: nil, restic: nil, database: nil, evidence_class: Evidence, scheduler_class: Scheduler)
@@ -28,6 +30,7 @@ module KamalBackup
     end
 
     def backup
+      started_at = Time.now.utc
       config.validate_backup
       require_restic!
 
@@ -43,7 +46,9 @@ module KamalBackup
         restic.check
       end
 
-      true
+      backup_summary(started_at: started_at, finished_at: Time.now.utc).tap do |summary|
+        validate_fresh_backup_summary!(summary, started_at: started_at)
+      end
     end
 
     def validate(check_files: true)
@@ -241,6 +246,59 @@ module KamalBackup
         result[:files] = file_results.size == 1 ? file_results.first : file_results
       end
 
+      def backup_summary(started_at:, finished_at:)
+        {
+          kind: "backup_result",
+          status: "ok",
+          started_at: started_at.iso8601,
+          finished_at: finished_at.iso8601,
+          databases: databases.map { |adapter| backup_snapshot_summary(adapter) },
+          files: backup_file_snapshot_summary
+        }
+      end
+
+      def backup_snapshot_summary(adapter)
+        snapshot = restic.latest_snapshot(tags: database_snapshot_tags(adapter))
+        snapshot_summary(snapshot).merge(
+          database: database_config_name(adapter),
+          adapter: adapter.adapter_name
+        )
+      end
+
+      def backup_file_snapshot_summary
+        return nil if config.backup_paths.empty?
+
+        snapshot_summary(restic.latest_snapshot(tags: ["type:files"]))
+      end
+
+      def snapshot_summary(snapshot)
+        {
+          snapshot: snapshot && (snapshot["short_id"] || snapshot["id"]),
+          time: snapshot && snapshot["time"]
+        }
+      end
+
+      def validate_fresh_backup_summary!(summary, started_at:)
+        stale_databases = summary.fetch(:databases).reject { |entry| fresh_snapshot?(entry, started_at) }
+
+        unless stale_databases.empty?
+          names = stale_databases.map { |entry| entry.fetch(:database) }.join(", ")
+          raise ConfigurationError, "backup did not create a fresh database snapshot for #{names}"
+        end
+
+        files = summary[:files]
+        if files && !fresh_snapshot?(files, started_at)
+          raise ConfigurationError, "backup did not create a fresh file snapshot"
+        end
+      end
+
+      def fresh_snapshot?(entry, started_at)
+        snapshot_time = Time.parse(entry[:time].to_s)
+        snapshot_time >= started_at - FRESH_BACKUP_GRACE_SECONDS
+      rescue ArgumentError
+        false
+      end
+
       def database_snapshot_tags(adapter)
         ["type:database", "database:#{database_config_name(adapter)}", "adapter:#{adapter.adapter_name}"]
       end

data/lib/kamal_backup/cli.rb

@@ -129,11 +129,26 @@ module KamalBackup
 
       def print_remote_version_status
         status = remote_version == VERSION ? "in sync" : "out of sync"
+        status_color = status == "in sync" ? :green : :red
+        status_output = CommandOutput.new(io: $stdout, env: command_env)
 
         puts("local: #{VERSION}")
         puts("remote: #{remote_version}")
-        puts("status: #{status}")
-        puts("fix: #{accessory_reboot_command}") if status == "out of sync"
+        puts("status: #{status_output.decorate(status, status_color, :bold)}")
+        puts("fix: #{status_output.decorate(accessory_reboot_command, :yellow, :bold)}") if status == "out of sync"
+      end
+
+      def print_backup_result(result)
+        return unless result.is_a?(Hash)
+
+        puts("Backup completed at #{result.fetch(:finished_at)}")
+        result.fetch(:databases).each do |database|
+          puts("database #{database.fetch(:database)}: #{database.fetch(:snapshot)} at #{database.fetch(:time)}")
+        end
+
+        if files = result[:files]
+          puts("files: #{files.fetch(:snapshot)} at #{files.fetch(:time)}")
+        end
       end
 
       def validate_deploy_config
@@ -399,14 +414,17 @@ module KamalBackup
 
     def self.start(argv = ARGV, env: ENV)
       self.command_env = env
-      Command.with_output(CommandOutput.new(io: $stderr)) do
+      output = CommandOutput.new(io: $stderr, env: env)
+      Command.with_output(output) do
         super(normalize_global_options(argv))
       end
     rescue Error => e
-      warn("kamal-backup: #{Redactor.new(env: env).redact_string(e.message)}")
+      output ||= CommandOutput.new(io: $stderr, env: env)
+      output.error("(#{e.class}): #{e.message}", redactor: Redactor.new(env: env))
       exit(1)
     rescue Interrupt
-      warn("kamal-backup: interrupted")
+      output ||= CommandOutput.new(io: $stderr, env: env)
+      output.error("(Interrupt): interrupted", redactor: Redactor.new(env: env))
       exit(130)
     ensure
       self.command_env = nil
@@ -419,7 +437,7 @@ module KamalBackup
       if remote_command_mode?
         exec_remote(["kamal-backup", "backup"])
       else
-        direct_app.backup
+        print_backup_result(direct_app.backup)
       end
     end
 

data/lib/kamal_backup/command.rb

@@ -72,6 +72,14 @@ module KamalBackup
       write_message("INFO", redactor.redact_string(message))
     end
 
+    def error(message, redactor:)
+      write_message("ERROR", colorize(redactor.redact_string(message), :red, :bold))
+    end
+
+    def decorate(value, color, mode = nil)
+      colorize(value, color, mode)
+    end
+
     def command_start(spec, redactor:)
       id = SecureRandom.hex(4)
       started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)

data/lib/kamal_backup/kamal_bridge.rb

@@ -215,10 +215,10 @@ module KamalBackup
       end
 
       def capture_kamal(argv, stream: false)
-        spec = CommandSpec.new(argv: argv)
+        spec = CommandSpec.new(argv: argv, env: kamal_stream_env(stream))
         options = {
           redactor: @redactor,
-          log: false,
+          log: !stream,
           log_output: false,
           tee_stdout: stream ? @stdout : nil,
           tee_stderr: stream ? @stderr : nil
@@ -231,6 +231,20 @@ module KamalBackup
         end
       end
 
+      def kamal_stream_env(stream)
+        return {} unless stream
+
+        if @env["SSHKIT_COLOR"].to_s.empty?
+          stream_color? ? { "SSHKIT_COLOR" => "1" } : {}
+        else
+          { "SSHKIT_COLOR" => @env["SSHKIT_COLOR"] }
+        end
+      end
+
+      def stream_color?
+        [@stdout, @stderr].any? { |io| io.respond_to?(:tty?) && io.tty? }
+      end
+
       def parse_version_line(output)
         output.to_s.lines.map(&:strip).reverse.find { |line| line.match?(VERSION_LINE_PATTERN) }.to_s
       end

data/lib/kamal_backup/version.rb

@@ -1,3 +1,3 @@
 module KamalBackup
-  VERSION = "0.3.0.beta7"
+  VERSION = "0.3.0.beta9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kamal-backup
 version: !ruby/object:Gem::Version
-  version: 0.3.0.beta7
+  version: 0.3.0.beta9
 platform: ruby
 authors:
 - crmne