cocoapods-humus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: daab17c7e517f60d47fa75b650e3d29dccc46e52
+  data.tar.gz: dd4bff6f4b532dcc9067acc1e174f2cfff18ad58
+SHA512:
+  metadata.gz: d71c2a34692f264ec7c843124b3cf32974529bb40bce1eabcc1bd7f345e29183739da244dad52c8493d635fa44a0fdf31a8492e06f1788b0b50436a3b7d22473
+  data.tar.gz: 273b8ec6c8fe5e1d9abbfab156400a9f71052737ca710aab103862b4758549ddace41862e91e86c8a17279868cc51b70a75de5b26ccb035ce23389361b38fbab

data/fixtures/README.md

@@ -0,0 +1 @@
+Sanitized trunk dumps are downloaded into this directory (repo or gem).

data/lib/cocoapods-humus.rb

@@ -0,0 +1,76 @@
+require File.expand_path('../snapshots', __FILE__)
+
+# Helper module for all projects in Strata that need
+# Database access and management.
+#
+# Load this in Strata via '../Humus/lib/cocoapods-humus'.
+# Then use the Humus helper methods:
+#  * Humus.with_snapshot(name, options = {})
+#
+module Humus
+  
+  # Load a specific snapshot into the database.
+  #
+  # Use this in integration tests in a CP project.
+  #
+  # For this to work,
+  #   ENV['DUMP_ACCESS_KEY_ID']
+  #   ENV['DUMP_SECRET_ACCESS_KEY']
+  # need to be set.
+  #
+  # Note: Does not ROLLBACK yet!
+  #
+  # @param [String] name The name of the snapshot.
+  # @param [Hash]   options Options: env, seed, rollback (not implemented yet).
+  #
+  # @example 
+  #   Humus.with_snapshot('b008') do
+  #     # Do something for which you need snapshot b008.
+  #   end
+  #
+  def self.with_snapshot name, options = {}
+    environment = options[:env]      || ENV['RACK_ENV'] || 'test'
+    seed        = options[:seed]     || true
+    rollback    = options[:rollback] && raise("Option :rollback not implemented yet.")
+    
+    # Currently, we only want this for tests.
+    #
+    return unless environment == 'test' 
+    
+    # If seed is falsy, just yield.
+    #
+    if seed
+      access_key_id = ENV['DUMP_ACCESS_KEY_ID']
+      secret_access_key = ENV['DUMP_SECRET_ACCESS_KEY']
+      unless access_key_id && secret_access_key
+        raise 'Set both DUMP_ACCESS_KEY_ID and DUMP_SECRET_ACCESS_KEY in ENV.'
+      end
+      
+      snapshots = Snapshots.new(access_key_id, secret_access_key)
+      begin
+        # Seed from dump.
+        #
+        snapshots.seed_from_dump(name)
+        
+        # All good. Call the code that needs the snapshot.
+        #
+        block_given? && yield
+      rescue RuntimeError => e # TODO Be more specific.
+        unless @retried
+          p e
+          
+          # Load snapshot.
+          snapshots.download_prepared_dump(name)
+          
+          # And retry to seed.
+          #
+          retry
+        end
+        @retried = true
+      end
+    else
+      block_given? && yield
+    end
+  end
+  
+end

data/lib/snapshots.rb

@@ -0,0 +1,117 @@
+module Humus
+  
+  # Helper class for downloading/seeding dumps.
+  #
+  class Snapshots
+    
+    attr_reader :access_key_id
+    attr_reader :secret_access_key
+    
+    def initialize access_key_id = nil, secret_access_key = nil
+      @access_key_id = access_key_id
+      @secret_access_key = secret_access_key
+    end
+    
+    # Download prepared dump from S3 (needs credentials).
+    #
+    def download_prepared_dump id
+      name = "trunk-#{id}.dump"
+      target_path = File.expand_path("../../fixtures/#{name}", __FILE__)
+      
+      puts "Accessing prepared DB test snapshot #{id} from S3."
+      
+      require 's3'
+      service = S3::Service.new(:access_key_id => access_key_id, :secret_access_key => secret_access_key)
+      bucket = service.buckets.find("cocoapods-org-testing-dumps")
+      
+      # Due to a bug in the s3 gem we are searching for the object via iterating.
+      bucket.objects.each do |obj|
+        if obj.key == name
+          puts "Downloading prepared DB test snapshot #{id} from S3."
+          File.open(target_path, 'w') do |file|
+            file.write(obj.content)
+          end
+          break
+        end
+      end
+      
+      puts "Prepared DB test snapshot #{id} downloaded to #{target_path}"
+    end
+    
+    # Seed the database from a downloaded dump.
+    #
+    def seed_from_dump id
+      target_path = File.expand_path("../../fixtures/trunk-#{id}.dump", __FILE__)
+      raise "Dump #{id} could not be found." unless File.exists? target_path
+      
+      puts "Restoring #{ENV['RACK_ENV']} database from #{target_path}"
+      
+      # Ensure we're starting from a clean DB.
+      system "dropdb trunk_cocoapods_org_test"
+      system "createdb trunk_cocoapods_org_test"
+      
+      # Restore the DB.
+      command = "pg_restore --no-privileges --clean --no-acl --no-owner -h localhost -d trunk_cocoapods_org_test #{target_path}"
+      puts "Executing:"
+      puts command
+      puts
+      result = system command
+      if result
+        puts "Database #{ENV['RACK_ENV']} restored from #{target_path}"
+      else
+        warn "Database #{ENV['RACK_ENV']} restored from #{target_path} with some errors."
+        # exit 1
+      end
+    end
+    
+    # Dump the production DB.
+    #
+    # TODO Also create a sanitized dump and upload to S3? (For now, we can do it manually)
+    #
+    # Preparing a dump.
+    #
+    # 1. Make a snapshot on Heroku.
+    # 2. SQL:
+    #   create or replace function random_string(length integer) returns text as
+    #   $$
+    #   declare
+    #     chars text[] := '{A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z}';
+    #     result text := '';
+    #     i integer := 0;
+    #   begin
+    #     if length < 0 then
+    #       raise exception 'Given length cannot be less than 0';
+    #     end if;
+    #     for i in 1..length loop
+    #       result := result || chars[1+random()*(array_length(chars, 1)-1)];
+    #     end loop;
+    #     return result;
+    #   end;
+    #   $$ language plpgsql;
+    #   
+    #   UPDATE owners
+    #   SET
+    #   	name = concat(random_string(1), lower(random_string(5)), ' ', random_string(1), lower(random_string(7))),
+    #   	email = lower(concat(random_string(15), '@', random_string(10), '.', random_string(3)))
+    #   TRUNCATE TABLE sessions;
+    #
+    # 3. Run
+    #   $ pg_dump -Fc trunk_cocoapods_org_test > fixtures/trunk-<date>-<Heroku snapshot id>.dump
+    #
+    def dump_prod id
+      target_path = File.expand_path("../../fixtures/trunk-#{id}.dump", __FILE__)
+      puts "Dumping production database from Heroku (works only if you have access to the database)"
+      command = "curl -o #{target_path} \`heroku pg:backups public-url #{id} -a cocoapods-trunk-service\`"
+      puts "Executing command:"
+      puts command
+      result = system command
+      if result
+        puts "Production database snapshot #{id} dumped into #{target_path}"
+      else
+        raise "Could not dump #{id} from production database."
+      end
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-humus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Florian Hanke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: CocoaPods database helper gem.
+email: florian.hanke+cocoapods.org@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- fixtures/README.md
+- lib/cocoapods-humus.rb
+- lib/snapshots.rb
+homepage: https://github.com/CocoaPods/Humus
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Manages DB dumps for testing.
+test_files: []
+has_rdoc: