kamal-backup 0.3.0.beta8 → 0.3.0.beta10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d920c58d8ff83794df465f0549d8599ea6a5e815b800221fa850ce024241abfa
-  data.tar.gz: feb8374a19862349d1fb0b3d55e3e697b45df66d58fc0c0f63ddba4767ed01f9
+  metadata.gz: c534b081ef41f75a8d10e72ae0fcbaa7b81ad5a0f2cbb3a12c281353d74ab69b
+  data.tar.gz: 6bd3b48d5573ab6a1e19ec1452584b7d44fc62e852edb7c202e2191d3bac6743
 SHA512:
-  metadata.gz: 9e36489f2557dca0695be87b779a9b20f96148b141e67a9422bc8933c925ea68a17a73d221c56f4a51585258194752f0db4f0b6fed4a4845783334e6dc0d8e0e
-  data.tar.gz: f8bb63eb69f7da8bdfcc001e07c95495ac60fa6996eb4b4188cfb2a8bc453979176985703f897c8e5ac4a9b02faec5cf3d76aad15862b0c964d6c961c2910556
+  metadata.gz: fdef6636e464308da24e9bb11aa64d8e68535fc9a8fc261a4dce02dc7e0d0bd26f20320f9dfede598085d780764310b0b3a7ad71ba3fe8d48e61d5c756b3597a
+  data.tar.gz: de0667fae6cb0ae276f1b4511ea1c63ffe8655523648a0e3f1e40d6872e53ba2823b4d987d4e651ace4d47710d516d17dc32f9e269e9bd20115501a533f793be

data/README.md

@@ -112,6 +112,8 @@ bundle exec kamal-backup check
 bundle exec kamal-backup evidence
 ```
 
+`backup` respects `backup.schedule` and skips when the latest backup is still current. Use `bundle exec kamal-backup backup --force` when you deliberately want an immediate snapshot.
+
 ## What you get
 
 - **Scheduled backups:** the accessory runs continuously and backs up on `backup.schedule`.

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)
@@ -27,8 +29,11 @@ module KamalBackup
       @scheduler_class = scheduler_class
     end
 
-    def backup
+    def backup(force: false)
+      started_at = Time.now.utc
       config.validate_backup
+      return skipped_backup_result(started_at) unless force || backup_due?(started_at)
+
       require_restic!
 
       restic.ensure_repository
@@ -43,7 +48,10 @@ 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)
+        write_last_backup(summary)
+      end
     end
 
     def validate(check_files: true)
@@ -130,10 +138,48 @@ module KamalBackup
 
     def schedule
       config.validate_backup
-      @scheduler_class.new(config) { backup }.run
+      @scheduler_class.new(config) { backup(force: true) }.run
     end
 
     private
+      def backup_due?(now)
+        due_at = next_backup_at
+        due_at.nil? || now >= due_at
+      end
+
+      def skipped_backup_result(now)
+        {
+          kind: "backup_result",
+          status: "skipped",
+          reason: "not_due",
+          last_backup_at: last_backup_finished_at&.iso8601,
+          next_backup_at: next_backup_at&.iso8601,
+          force_command: "kamal-backup backup --force",
+          finished_at: now.iso8601
+        }
+      end
+
+      def next_backup_at
+        last_backup_finished_at + config.backup_schedule_seconds if last_backup_finished_at
+      end
+
+      def last_backup_finished_at
+        @last_backup_finished_at ||= begin
+          value = last_backup_record["finished_at"] || last_backup_record["last_backup_at"]
+          value ? Time.parse(value.to_s).utc : nil
+        rescue ArgumentError
+          nil
+        end
+      end
+
+      def last_backup_record
+        @last_backup_record ||= begin
+          JSON.parse(File.read(config.last_backup_path))
+        rescue JSON::ParserError, SystemCallError
+          {}
+        end
+      end
+
       def build_restore_result(scope, snapshot)
         started_at = Time.now.utc
         result = Schema.record(
@@ -241,6 +287,68 @@ 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 write_last_backup(result)
+        FileUtils.mkdir_p(config.state_dir)
+        File.write(config.last_backup_path, JSON.pretty_generate(result))
+        @last_backup_record = result.transform_keys(&:to_s)
+        @last_backup_finished_at = Time.parse(result.fetch(:finished_at)).utc
+      rescue SystemCallError, ArgumentError
+        nil
+      end
+
       def database_snapshot_tags(adapter)
         ["type:database", "database:#{database_config_name(adapter)}", "adapter:#{adapter.adapter_name}"]
       end

data/lib/kamal_backup/cli.rb

@@ -138,6 +138,26 @@ module KamalBackup
         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)
+
+        if result[:status] == "skipped"
+          puts("No backup due. Last backup finished at #{result.fetch(:last_backup_at)}.")
+          puts("Next backup is due at #{result.fetch(:next_backup_at)}.")
+          puts("Run `#{result.fetch(:force_command)}` to force a backup now.")
+          return
+        end
+
+        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
         config = Config.new(
           env: bridge.accessory_environment(accessory_name: accessory_name),
@@ -419,12 +439,15 @@ module KamalBackup
 
     include Helpers
 
-    desc "backup", "Run one database and Active Storage backup immediately"
+    method_option :force, type: :boolean, default: false, desc: "Run a backup even if the configured schedule is not due"
+    desc "backup", "Run a due database and Active Storage backup"
     def backup
       if remote_command_mode?
-        exec_remote(["kamal-backup", "backup"])
+        argv = ["kamal-backup", "backup"]
+        argv << "--force" if options[:force]
+        exec_remote(argv)
       else
-        direct_app.backup
+        print_backup_result(direct_app.backup(force: options[:force]))
       end
     end
 

data/lib/kamal_backup/config.rb

@@ -215,6 +215,10 @@ module KamalBackup
       File.join(state_dir, "last_check.json")
     end
 
+    def last_backup_path
+      File.join(state_dir, "last_backup.json")
+    end
+
     def last_restore_drill_path
       File.join(state_dir, "last_restore_drill.json")
     end

data/lib/kamal_backup/version.rb

@@ -1,3 +1,3 @@
 module KamalBackup
-  VERSION = "0.3.0.beta8"
+  VERSION = "0.3.0.beta10"
 end

metadata

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