kamal-backup 0.3.0.beta17 → 0.3.0.beta18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88d55c67a4d6276ea516c9d3149ee486c3da3587a438856fa08ba0050f0b99d0
-  data.tar.gz: '09290fe105b1ef100c9d59f8631426f86ee169977cb5561e4308aec05f3e3eb5'
+  metadata.gz: f7b7f6a104e974d738b46ed67b5ece749627d8d33737845f9e9e7ea0e921ce21
+  data.tar.gz: e95a651804aa74ec1146989f0db3428e4c8510dc247ef07383e8b0f3d0168f43
 SHA512:
-  metadata.gz: 3f0de6a3b23a06e127b860b63d2227ba154272ef6da3e011943f8d82fae445b4f676ae89e8f52931aaf11ea142c73d5fb417e8e360c04912bb42604d2fcf6b76
-  data.tar.gz: a26fb0fbc1b23f03a0e3316606e07c3df718368e42bb3ac8d082218dc9c1bf4e3ff010695812e3532b1f09bd1c878b979aaff0098b9c04389c07abd097a38354
+  metadata.gz: 447bbd9c378d92aef836e0f05cf751ef9b978121b9e3ff5d8675b943441f028aaa082809e9adf462d3380e6035e35dfd52cd74cac68c0ac6fef099632ff89429
+  data.tar.gz: 7f414a27f4c452371b9c88fb91ac7aece2bd9771d92ae835997487fa252aeb2f053955cce3a76741be12cd4f6fe31c7c206a2d2ccbdf356a595f34e5d007986b

data/lib/kamal_backup/cli.rb

@@ -503,6 +503,7 @@ module KamalBackup
       puts deploy_snippet
       puts
       puts "The accessory runs scheduled database and file backups with backup.schedule."
+      puts "kamal-backup passes RESTIC_PASSWORD to restic through a private temporary password file."
       puts "For most Rails apps, restore local and drill local can infer the development database, Active Storage path, and tmp state directory."
       puts "Local restore and drill also require the restic binary on your machine."
       puts "Create config/kamal-backup.local.yml only if you need to override those local defaults."

data/lib/kamal_backup/restic.rb

@@ -1,6 +1,7 @@
 require "fileutils"
 require "json"
 require "open3"
+require "tempfile"
 require "time"
 require_relative "command"
 
@@ -27,43 +28,49 @@ module KamalBackup
     end
 
     def backup_stream(command, filename:, tags:)
-      restic_command = CommandSpec.new(
-        argv: ["restic", "backup"] + host_args + ["--stdin", "--stdin-filename", filename] + tag_args(common_tags + tags),
-        env: restic_env
-      )
-      log("backing up stream as #{filename}")
-      pipe_commands(command, restic_command, producer_label: "dump", consumer_label: "restic backup")
+      with_restic_env do |env|
+        restic_command = CommandSpec.new(
+          argv: ["restic", "backup"] + host_args + ["--stdin", "--stdin-filename", filename] + tag_args(common_tags + tags),
+          env: env
+        )
+        log("backing up stream as #{filename}")
+        pipe_commands(command, restic_command, producer_label: "dump", consumer_label: "restic backup")
+      end
     end
 
     def backup_file(path, filename:, tags:)
-      command = CommandSpec.new(
-        argv: ["restic", "backup"] + host_args + ["--stdin", "--stdin-filename", filename] + tag_args(common_tags + tags),
-        env: restic_env
-      )
-      log("backing up file content as #{filename}")
+      command = nil
 
-      File.open(path, "rb") do |file|
-        output = Command.output
-        context = output&.command_start(command, redactor: redactor)
-        Open3.popen3(command.env, *command.argv) do |stdin, stdout, stderr, wait_thread|
-          stdout_reader = Thread.new { Command.collect_stream(stdout, command_output: output, context: context, stream: :stdout, redactor: redactor) }
-          stderr_reader = Thread.new { Command.collect_stream(stderr, command_output: output, context: context, stream: :stderr, redactor: redactor) }
-          copy_error = nil
-          begin
-            IO.copy_stream(file, stdin)
-          rescue Errno::EPIPE => e
-            copy_error = e
-          ensure
-            stdin.close unless stdin.closed?
+      with_restic_env do |env|
+        command = CommandSpec.new(
+          argv: ["restic", "backup"] + host_args + ["--stdin", "--stdin-filename", filename] + tag_args(common_tags + tags),
+          env: env
+        )
+        log("backing up file content as #{filename}")
+
+        File.open(path, "rb") do |file|
+          output = Command.output
+          context = output&.command_start(command, redactor: redactor)
+          Open3.popen3(command.env, *command.argv) do |stdin, stdout, stderr, wait_thread|
+            stdout_reader = Thread.new { Command.collect_stream(stdout, command_output: output, context: context, stream: :stdout, redactor: redactor) }
+            stderr_reader = Thread.new { Command.collect_stream(stderr, command_output: output, context: context, stream: :stderr, redactor: redactor) }
+            copy_error = nil
+            begin
+              IO.copy_stream(file, stdin)
+            rescue Errno::EPIPE => e
+              copy_error = e
+            ensure
+              stdin.close unless stdin.closed?
+            end
+            out = stdout_reader.value
+            err = stderr_reader.value
+            status = wait_thread.value
+            output&.command_exit(context, status.exitstatus)
+            raise_command_error(command, status, out, err) unless status.success?
+            raise_stream_error(command, copy_error, out, err) if copy_error
+
+            CommandResult.new(stdout: out, stderr: err, status: status.exitstatus)
           end
-          out = stdout_reader.value
-          err = stderr_reader.value
-          status = wait_thread.value
-          output&.command_exit(context, status.exitstatus)
-          raise_command_error(command, status, out, err) unless status.success?
-          raise_stream_error(command, copy_error, out, err) if copy_error
-
-          CommandResult.new(stdout: out, stderr: err, status: status.exitstatus)
         end
       end
     rescue Errno::ENOENT => e
@@ -153,26 +160,31 @@ module KamalBackup
     end
 
     def pipe_dump_to_command(snapshot, filename, command)
-      restic_command = CommandSpec.new(argv: ["restic", "dump", snapshot, filename], env: restic_env)
-      pipe_commands(restic_command, command, producer_label: "restic dump", consumer_label: command.argv.first)
+      with_restic_env do |env|
+        restic_command = CommandSpec.new(argv: ["restic", "dump", snapshot, filename], env: env)
+        pipe_commands(restic_command, command, producer_label: "restic dump", consumer_label: command.argv.first)
+      end
     end
 
     def write_dump_to_path(snapshot, filename, target_path)
-      command = CommandSpec.new(argv: ["restic", "dump", snapshot, filename], env: restic_env)
+      command = nil
       target_path = File.expand_path(target_path)
       FileUtils.mkdir_p(File.dirname(target_path))
       temp_path = "#{target_path}.kamal-backup-#{$$}.tmp"
 
-      output = Command.output
-      context = output&.command_start(command, redactor: redactor)
-      Open3.popen3(command.env, *command.argv) do |stdin, stdout, stderr, wait_thread|
-        stdin.close
-        stderr_reader = Thread.new { Command.collect_stream(stderr, command_output: output, context: context, stream: :stderr, redactor: redactor) }
-        File.open(temp_path, "wb") { |file| IO.copy_stream(stdout, file) }
-        err = stderr_reader.value
-        status = wait_thread.value
-        output&.command_exit(context, status.exitstatus)
-        raise_command_error(command, status, "", err) unless status.success?
+      with_restic_env do |env|
+        command = CommandSpec.new(argv: ["restic", "dump", snapshot, filename], env: env)
+        output = Command.output
+        context = output&.command_start(command, redactor: redactor)
+        Open3.popen3(command.env, *command.argv) do |stdin, stdout, stderr, wait_thread|
+          stdin.close
+          stderr_reader = Thread.new { Command.collect_stream(stderr, command_output: output, context: context, stream: :stderr, redactor: redactor) }
+          File.open(temp_path, "wb") { |file| IO.copy_stream(stdout, file) }
+          err = stderr_reader.value
+          status = wait_thread.value
+          output&.command_exit(context, status.exitstatus)
+          raise_command_error(command, status, "", err) unless status.success?
+        end
       end
       File.rename(temp_path, target_path)
       target_path
@@ -190,11 +202,13 @@ module KamalBackup
     end
 
     def run(args, log_output: true)
-      Command.capture(
-        CommandSpec.new(argv: ["restic"] + args, env: restic_env),
-        redactor: redactor,
-        log_output: log_output
-      )
+      with_restic_env do |env|
+        Command.capture(
+          CommandSpec.new(argv: ["restic"] + args, env: env),
+          redactor: redactor,
+          log_output: log_output
+        )
+      end
     end
 
     def common_tags
@@ -256,6 +270,25 @@ module KamalBackup
         end
       end
 
+      def with_restic_env
+        env = restic_env
+        password_file = nil
+
+        if env["RESTIC_PASSWORD_FILE"] || env["RESTIC_PASSWORD_COMMAND"]
+          env.delete("RESTIC_PASSWORD")
+        elsif env["RESTIC_PASSWORD"]
+          password_file = Tempfile.new("kamal-backup-restic-password")
+          password_file.write(env.delete("RESTIC_PASSWORD"))
+          password_file.flush
+          File.chmod(0o600, password_file.path)
+          env["RESTIC_PASSWORD_FILE"] = password_file.path
+        end
+
+        yield env
+      ensure
+        password_file&.close!
+      end
+
       def pipe_commands(producer, consumer, producer_label:, consumer_label:)
         output = Command.output
         producer_context = output&.command_start(producer, redactor: redactor)

data/lib/kamal_backup/version.rb

@@ -1,3 +1,3 @@
 module KamalBackup
-  VERSION = "0.3.0.beta17"
+  VERSION = "0.3.0.beta18"
 end

metadata

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