Class: KamalBackup::App

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

Constant Summary collapse

FRESH_BACKUP_GRACE_SECONDS = 
5

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.



25
26
27
28
29
30
31
32
33
 
# File 'lib/kamal_backup/app.rb', line 25

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.



23
24
25
 
# File 'lib/kamal_backup/app.rb', line 23

def config
  @config
end

#redactor ⇒ Object (readonly)

Returns the value of attribute redactor.



23
24
25
 
# File 'lib/kamal_backup/app.rb', line 23

def redactor
  @redactor
end

Instance Method Details

#backup(force: false) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/kamal_backup/app.rb', line 35

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
  databases.each { |database| database.backup(restic) }
  restic.backup_paths(config.backup_paths, tags: ['type:files'])

  restic.forget_after_success if config.forget_after_backup?

  restic.check if config.check_after_backup?

  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

#check ⇒ Object 



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

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

#drill_failed?(result) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

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



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/kamal_backup/app.rb', line 84

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 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/kamal_backup/app.rb', line 96

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 



139
140
141
142
143
 
# File 'lib/kamal_backup/app.rb', line 139

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

#prune ⇒ Object 



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

def prune
  config.validate_backup(check_files: false)
  require_restic!
  restic.prune
end

#restore_to_local_machine(snapshot = 'latest') ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/kamal_backup/app.rb', line 61

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 



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/kamal_backup/app.rb', line 73

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 



145
146
147
148
 
# File 'lib/kamal_backup/app.rb', line 145

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

#snapshots ⇒ Object 



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

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

#validate(check_files: true) ⇒ Object 



56
57
58
59
 
# File 'lib/kamal_backup/app.rb', line 56

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