glacier_on_rails 0.9.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e064638350da90807ab8f7c14b788295bbdba127
-  data.tar.gz: 409fb6e65fd668c57265f8040f231e30a3c8f1a4
+  metadata.gz: 2c3545972de61ff80f578bb26a1e4d3df5b889e4
+  data.tar.gz: 707c970982ccdc1c57d22f2bcdf9710d9ec4159b
 SHA512:
-  metadata.gz: f38b8ea5ed087142468409256cad1d3a448ce036a6a8950c4593ebc2a70533c18f12a06733b3b1fd69f487d31e96d06953f1f7412b01ac29d4db8fd1c41047f2
-  data.tar.gz: 3618d038b088fdfb83bf6ea31fab36647bc4e96a8c5efac6836f167dc7c03578a77169a85ca9802c63becf8bcb1659b08a0ee7fb0a5ba14e8fa1a8606da397be
+  metadata.gz: 10246ae2a0d64d9b0df6bbf01bd90cbfd22392eda37f7a3f37ffcf1335de0decf8331a6155d19967fc9ecc794d9528db24e02c95a9311aa8ac801d56db594f77
+  data.tar.gz: 5bd6139d008f6c6cfa4417dbbb88b2758cb3bf2e3df5ea26726fdf10ec2daa3d6d40198ba732f8e3bef794408b7ffd542546b6414de97ffdaf4679f9b03a1e85

data/app/models/application_database.rb

@@ -1,8 +1,14 @@
 class ApplicationDatabase
-  class MissingConfigurationKeys < StandardError
+  class ConfigurationError < StandardError
+    def initialize(message)
+      AwsLog.error "#{self.class.name} exception: #{message}"
+      super
+    end
+  end
+
+  class MissingConfigurationKeys < ConfigurationError
     def initialize(missing_keys)
       message = "#{missing_keys.join(' and ')} must be specified in config/database.yml"
-      AwsLog.error "ApplicationDatabase::MissingConfigurationKeys exception: #{message}"
       super(message)
     end
   end
@@ -17,6 +23,8 @@ class ApplicationDatabase
                when "mysql"
                  MysqlAdapter.new(db_config)
                end
+  rescue ConfigurationError
+    @adapter = Struct.new(:contents).new(nil)
   end
 
   def db_config

data/app/models/application_database/postgres_adapter.rb

@@ -2,20 +2,6 @@ class ApplicationDatabase::PostgresAdapter < ApplicationDatabase::BaseAdapter
   class PgDumpCmdMissing < StandardError; end
   class PgRestoreCmdMissing < StandardError; end
   class PgRestoreFileMissing < StandardError; end
-  class PgPassFileMissing < StandardError
-    def initialize
-      message = "#{File.expand_path("~/.pgpass")} file not found, cannot dump database contents"
-      AwsLog.error "ApplicationDatabase::PostgresAdapter::PgPassFileMissing exception: #{message}"
-      super(message)
-    end
-  end
-  class PgPassFilePermissionsError < StandardError
-    def initialize
-      message = "password file #{File.expand_path("~/.pgpass")} has group or world access; permissions should be u=rw (0600)"
-      AwsLog.error "ApplicationDatabase::PostgresAdapter::PgPassFilePermissionsError exception: #{message}"
-      super(message)
-    end
-  end
 
   RestoreExclusions = %w{ application_data_backups
                           glacier_archives
@@ -24,12 +10,10 @@ class ApplicationDatabase::PostgresAdapter < ApplicationDatabase::BaseAdapter
   RestoreList = GlacierArchive::BackupFileDir.join('restore.list')
 
   def contents
-    if db_config["password"].present?
-      password_file = File.expand_path("~/.pgpass")
-      raise PgPassFileMissing unless File.exists?(password_file)
-      raise PgPassFilePermissionsError unless sprintf("%o", File.stat(password_file).mode) =~ /600$/
-    end
+    PgPass.ensure if db_config["password"].present?
     `#{pg_dump} -w -Fc -U #{db_config['username']} #{db_config['database']}`
+  rescue ApplicationDatabase::ConfigurationError
+    nil
   end
 
   def restore(file)

data/app/models/glacier_db_archive.rb

@@ -11,12 +11,6 @@ class GlacierDbArchive < GlacierArchive
 
   def archive_contents
     ApplicationDatabase.new.contents
-  rescue ApplicationDatabase::PostgresAdapter::PgPassFilePermissionsError
-    nil
-  rescue ApplicationDatabase::PostgresAdapter::PgPassFileMissing
-    nil
-  rescue ApplicationDatabase::MissingConfigurationKeys
-    nil
   end
 
   # for file archive, true inhibits fetching archive from AWS

data/app/models/pg_pass.rb

@@ -0,0 +1,24 @@
+class PgPass
+
+  class FileMissing < ApplicationDatabase::ConfigurationError
+    def initialize
+      message = "#{File.expand_path("~/.pgpass")} file not found, cannot dump database contents"
+      super(message)
+    end
+  end
+
+  class FilePermissionsError < ApplicationDatabase::ConfigurationError
+    def initialize
+      message = "password file #{File.expand_path("~/.pgpass")} has group or world access; permissions should be u=rw (0600)"
+      super(message)
+    end
+  end
+
+  def self.ensure
+    # TODO missing file and permissions errors are recoverable
+    # create or chmod the file instead of triggering an exception
+    password_file = File.expand_path("~/.pgpass")
+    raise FileMissing unless File.exists?(password_file)
+    raise FilePermissionsError unless sprintf("%o", File.stat(password_file).mode) =~ /600$/
+  end
+end

data/db/migrate/20170503133854_create_glacier_archives_table.rb

@@ -1,6 +1,6 @@
 class CreateGlacierArchivesTable < ActiveRecord::Migration[5.0]
   def change
-    create_table :glacier_archives do |t|
+    create_table :glacier_archives, :force => true do |t|
       t.text :description
       t.text :archive_id
       t.text :checksum

data/db/migrate/20170602135721_create_application_data_backups.rb

@@ -1,6 +1,6 @@
 class CreateApplicationDataBackups < ActiveRecord::Migration[5.0]
   def change
-    create_table :application_data_backups do |t|
+    create_table :application_data_backups, :force => true do |t|
       t.timestamps
     end
   end

data/db/migrate/20170602145526_create_glacier_file_archive_join_table.rb

@@ -1,5 +1,5 @@
 class CreateGlacierFileArchiveJoinTable < ActiveRecord::Migration[5.0]
   def change
-    create_join_table :application_data_backups, :glacier_file_archives
+    create_join_table :application_data_backups, :glacier_file_archives, :force => true
   end
 end

data/glacier_on_rails.gemspec

@@ -3,7 +3,7 @@
 
 Gem::Specification.new do |s|
   s.name = "glacier_on_rails"
-  s.version = "0.9.9"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Les Nightingill"]
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = "2.1.11"
   s.summary = "database backup/restore utilities"
 
-  s.add_runtime_dependency "rails", "~> 5.1"
+  s.add_runtime_dependency "rails", "~> 6.0.0rc1"
   s.add_runtime_dependency "httparty", "~> 0.15.5"
   s.add_development_dependency "byebug", "~> 9.0", ">= 9.0.6"
   s.add_development_dependency("capybara", "~> 2.4")

data/lib/tasks/aws.rake

@@ -1,6 +1,7 @@
 namespace :aws do
   desc "create and save to aws glacier a copy of the postgres database"
   task :create_db_archive => :environment do
+    puts "#{Time.now} create db archive"
     ApplicationDataBackup.create
   end
 end

data/spec/features/application_data_backup_spec.rb

@@ -192,7 +192,7 @@ feature "backup_now", :js => true do
       expect{page.find('#backup_now').click; wait_for_ajax}.not_to change{ApplicationDataBackup.count}
       expect(page).not_to have_selector("#application_data_backups .application_data_backup")
       expect(flash_message).to eq "failed to create backup"
-      expect(aws_log).to match /ApplicationDatabase::PostgresAdapter::PgPassFileMissing exception: #{File.expand_path("~/.pgpass")} file not found, cannot dump database contents/
+      expect(aws_log).to match /PgPass::FileMissing exception: #{File.expand_path("~/.pgpass")} file not found, cannot dump database contents/
     end
   end
 
@@ -215,7 +215,7 @@ feature "backup_now", :js => true do
       expect{page.find('#backup_now').click; wait_for_ajax}.not_to change{ApplicationDataBackup.count}
       expect(page).not_to have_selector("#application_data_backups .application_data_backup")
       expect(flash_message).to eq "failed to create backup"
-      expect(aws_log).to match /#{Regexp.escape ApplicationDatabase::PostgresAdapter::PgPassFilePermissionsError.new.message}/
+      expect(aws_log).to match /#{Regexp.escape PgPass::FilePermissionsError.new.message}/
     end
   end
 end

data/spec/models/pg_pass_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe "foo" do
+  it "bar" do
+    expect(1).to eq 0
+  end
+end

data/spec/models/postgres_adapter_spec.rb

@@ -28,8 +28,8 @@ describe "PostgresAdapter#contents dependence on password file ~/.pgpass" do
       allow(File).to receive(:exists?).with(File.expand_path("~/.pgpass")).and_return(false)
     end
 
-    it "should raise an exception" do
-      expect{ ApplicationDatabase.new.contents }.to raise_exception ApplicationDatabase::PostgresAdapter::PgPassFileMissing
+    it "should be nil" do
+      expect( ApplicationDatabase.new.contents ).to be_nil
     end
   end
 
@@ -58,8 +58,8 @@ describe "PostgresAdapter#contents dependence on password file ~/.pgpass" do
       allow(File).to receive(:stat).with(File.expand_path("~/.pgpass")).and_return(status)
     end
 
-    it "should raise an exception" do
-      expect{ ApplicationDatabase.new.contents }.to raise_exception ApplicationDatabase::PostgresAdapter::PgPassFilePermissionsError
+    it "should be nil" do
+      expect(ApplicationDatabase.new.contents).to be_nil
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glacier_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.9.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Les Nightingill
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 6.0.0rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 6.0.0rc1
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +192,7 @@ files:
 - app/models/glacier_archive.rb
 - app/models/glacier_db_archive.rb
 - app/models/glacier_file_archive.rb
+- app/models/pg_pass.rb
 - app/views/glacier_on_rails/aws_archive_retrieval_jobs/_application_data_backup.haml
 - app/views/glacier_on_rails/aws_archive_retrieval_jobs/_available.haml
 - app/views/glacier_on_rails/aws_archive_retrieval_jobs/_index.haml
@@ -267,6 +268,7 @@ files:
 - spec/models/application_file_spec.rb
 - spec/models/glacier_db_archive_spec.rb
 - spec/models/glacier_file_archive_spec.rb
+- spec/models/pg_pass_spec.rb
 - spec/models/postgres_adapter_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb