Class: KamalBackup::App

Inherits:
Object
  • Object
show all
Defined in:
lib/kamal_backup/app.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(env: ENV, config: nil, redactor: nil, restic: nil, database: nil, evidence_class: Evidence, scheduler_class: Scheduler) ⇒ App

Returns a new instance of App.



21
22
23
24
25
26
27
28
 
# File 'lib/kamal_backup/app.rb', line 21

def initialize(env: ENV, config: nil, redactor: nil, restic: nil, database: nil, evidence_class: Evidence, scheduler_class: Scheduler)
  @config = config || Config.new(env: env)
  @redactor = redactor || Redactor.new(env: @config.env)
  @restic = restic
  @database = database
  @evidence_class = evidence_class
  @scheduler_class = scheduler_class
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



19
20
21
 
# File 'lib/kamal_backup/app.rb', line 19

def config
  @config
end

#redactor ⇒ Object (readonly)

Returns the value of attribute redactor.



19
20
21
 
# File 'lib/kamal_backup/app.rb', line 19

def redactor
  @redactor
end

Instance Method Details

#backup ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/kamal_backup/app.rb', line 30

def backup
  config.validate_backup
  require_restic!

  timestamp = current_timestamp
  restic.ensure_repository
  databases.each { |database| database.backup(restic, timestamp) }
  restic.backup_paths(config.backup_paths, tags: ["type:files", "run:#{timestamp}"])

  if config.forget_after_backup?
    restic.forget_after_success
  end

  if config.check_after_backup?
    restic.check
  end

  true
end

#check ⇒ Object 



120
121
122
123
124
 
# File 'lib/kamal_backup/app.rb', line 120

def check
  config.validate_restic
  require_restic!
  restic.check.stdout
end

#drill_failed?(result) ⇒ Boolean

Returns:

  • (Boolean) 


108
109
110
111
112
 
# File 'lib/kamal_backup/app.rb', line 108

def drill_failed?(result)
  result.fetch(:status) != "ok"
rescue KeyError
  true
end

#drill_on_local_machine(snapshot = "latest", check_command: nil) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/kamal_backup/app.rb', line 78

def drill_on_local_machine(snapshot = "latest", check_command: nil)
  validate_local_machine_restore
  require_restic!

  run_drill("local", snapshot, check_command: check_command) do |result|
    databases.each { |adapter| validate_local_machine_database_target(adapter) }
    database_results = perform_database_restores_to_current(snapshot)
    file_results = perform_replacement_file_restores(snapshot, production_source: false)
    assign_restore_results(result, database_results, file_results)
  end
end

#drill_on_production(snapshot = "latest", database_name: nil, sqlite_path: nil, file_target: "/restore/files", check_command: nil) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/kamal_backup/app.rb', line 90

def drill_on_production(snapshot = "latest", database_name: nil, sqlite_path: nil, file_target: "/restore/files", check_command: nil)
  validate_production_drill(file_target, database_name, sqlite_path)
  require_restic!

  run_drill("production", snapshot, check_command: check_command) do |result|
    database_results = databases.map do |adapter|
      perform_database_restore_to_scratch(
        snapshot,
        adapter: adapter,
        database_name: database_name,
        sqlite_path: sqlite_path
      )
    end
    file_results = [perform_file_restore(snapshot, target: file_target)]
    assign_restore_results(result, database_results, file_results)
  end
end

#evidence ⇒ Object 



126
127
128
129
130
 
# File 'lib/kamal_backup/app.rb', line 126

def evidence
  config.validate_restic
  require_restic!
  @evidence_class.new(config, restic: restic, redactor: redactor).to_json
end

#restore_to_local_machine(snapshot = "latest") ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/kamal_backup/app.rb', line 55

def restore_to_local_machine(snapshot = "latest")
  validate_local_machine_restore
  require_restic!

  build_restore_result("local", snapshot) do |result|
    databases.each { |adapter| validate_local_machine_database_target(adapter) }
    database_results = perform_database_restores_to_current(snapshot)
    file_results = perform_replacement_file_restores(snapshot, production_source: false)
    assign_restore_results(result, database_results, file_results)
  end
end

#restore_to_production(snapshot = "latest") ⇒ Object 



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/kamal_backup/app.rb', line 67

def restore_to_production(snapshot = "latest")
  validate_production_restore
  require_restic!

  build_restore_result("production", snapshot) do |result|
    database_results = perform_database_restores_to_current(snapshot)
    file_results = perform_replacement_file_restores(snapshot, production_source: true)
    assign_restore_results(result, database_results, file_results)
  end
end

#schedule ⇒ Object 



132
133
134
135
 
# File 'lib/kamal_backup/app.rb', line 132

def schedule
  config.validate_backup
  @scheduler_class.new(config) { backup }.run
end

#snapshots ⇒ Object 



114
115
116
117
118
 
# File 'lib/kamal_backup/app.rb', line 114

def snapshots
  config.validate_restic
  require_restic!
  restic.snapshots.stdout
end

#validate(check_files: true) ⇒ Object 



50
51
52
53
 
# File 'lib/kamal_backup/app.rb', line 50

def validate(check_files: true)
  config.validate_backup(check_files: check_files)
  true
end