pg_tester 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6cc3642ebdc410f3d73463b945c6cdead08b218
+  data.tar.gz: 9ba9d4a3f7686fea32f2d7cb8af152648c25d8d0
+SHA512:
+  metadata.gz: 0e50d0e50003c0082852aa14275de5b1d2e69a9845d282a7705a21f57144007cdfcb09e4aa26b0656844e5b2fe585b6b4a3dd8a130b7005e1cc7d8811057ed3a
+  data.tar.gz: c91ea27012d4b4406b7dd3b7166d253fa821ab63a0fc93d4e49be408d80ac13fe7ab95e586abd82b332a6572b5de9d0283237788eda10acdecc3f114eb3c8900

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pg_tester.gemspec
+gemspec
+
+group :development do
+  gem 'rspec'
+  gem 'pry-byebug'
+end

data/README.md

@@ -0,0 +1,77 @@
+# PgTester
+
+A handy gem to help with testing postgresql related scripts or anything postgresql related
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg_tester'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg_tester
+
+## Usage
+
+
+```
+require 'pg_tester'
+
+psql = PgTester.new({
+
+  port:             '312',
+  host:             'localhost',
+  db_name:          'testpostgresql',
+  user_name:        'testpostgresql',
+  data_dir:         '/tmp/',
+  initdb_path:      '/usr/local/bin/initdb',
+  pgctl_path:       '/usr/local/bin/which pg_ctl',
+  createuser_path:  '/usr/local/bin/which createuser',
+  createdb_path:    '/usr/local/bin/which createdb',
+  })
+
+## use case 1
+psql.setup # This will create a test postgres cluster in /tmp, connection as testpostgresql user and database name testpostgresql
+result = psql.exec(query)
+# ... do some expectation on result
+psql.teardown # Cluster is torn down and dir in /tmp deleted
+
+## use case 2 -- this setup, execute the block and teardown
+psql.exec(query) do |result|
+  # ... do some expectation on result
+end
+
+## use case 3 -- all in one using default
+PgTester.new({
+  port:             '312',
+  data_dir:         '/tmp/',
+}).exec(query) { |result| # some expectation }
+
+## use case 4 -- the rspec usage
+
+context 'run query in block' do
+  it 'should run exec query in a block' do
+    PgTester.new().exec('SELECT 2') do |result|
+      expect(result.getvalue(0,0)).to eq("2")
+    end
+  end
+
+  it 'should run exec query in a curly block' do
+    PgTester.new().exec('SELECT 3') { |result| expect(result.getvalue(0,0)).to eq("3") }
+  end
+end
+
+```
+
+## Contributing
+
+Pull requests are welcome! You can run the tests by doing
+
+`bundle exec rspec`

data/Rakefile

@@ -0,0 +1,6 @@
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+
+# If you want to make this the default task
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pg_tester"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pg_tester.rb

@@ -0,0 +1,100 @@
+require "pg_tester/version"
+require 'pg'
+require 'fileutils'
+
+class PgTester
+
+  attr_reader :user, :database, :port, :host, :data_dir, :initdb_path, 
+              :pgctl_path, :createuser_path, :createdb_path
+
+  def initialize(opts={})
+    @user            = opts.fetch(:user) { 'pgtester' }
+    @database        = opts.fetch(:database) { 'pgtester' }
+    @port            = opts.fetch(:port) { 6433 }
+    @host            = opts.fetch(:host) { 'localhost' }
+    @data_dir        = opts.fetch(:data_dir) { '/tmp/pg_tester' }
+    @initdb_path     = opts.fetch(:initdb_path) { shell_out('which initdb') }
+    @pgctl_path      = opts.fetch(:pgctl_path) { shell_out('which pg_ctl') }
+    @createuser_path = opts.fetch(:createuser_path) { shell_out('which createuser') }
+    @createdb_path   = opts.fetch(:createdb_path) { shell_out('which createdb') }
+    @connection      = nil
+
+    raise 'please install postgresql' unless @initdb_path && !@initdb_path.empty?
+  end
+
+  def create_data_dir()
+    Dir.mkdir(@data_dir) unless File.exists? @data_dir
+  end
+
+  def remove_data_dir()
+    FileUtils.remove_dir(@data_dir)
+  end
+
+  def initdb()
+    shell_out "#{@initdb_path} #{@data_dir} -A trust -E utf-8"
+  end
+
+  def rundb()
+    pid = Process.fork { shell_out "#{@pgctl_path} start -o '-p #{@port}' -D #{@data_dir}" }
+    # give a second for postgresql to startup
+    sleep(1)
+    Process.detach(pid)
+  end
+
+  def setup_test_user()
+    shell_out "#{@createuser_path} -s -p #{@port} -l #{user} -w"
+  end
+
+  def setup_test_database()
+    shell_out "#{@createdb_path} -p #{@port} #{database} -O #{user}"
+  end
+
+  def setup_pg_connection()
+    @connection = PG::Connection.open(:user => @user, :dbname => @database, :port => @port)
+  end
+
+  def setup()
+    create_data_dir
+    initdb
+    rundb
+    setup_test_user
+    setup_test_database
+    setup_pg_connection
+  end
+
+  def teardown()
+    @connection.close() if @connection
+    shell_out "#{@pgctl_path} stop -m fast -o '-p #{@port}' -D #{data_dir}"
+    remove_data_dir
+  end
+
+  def exec(query)
+    if block_given?
+      setup
+      yield(@connection.exec(query))
+      teardown
+    else
+      raise 'please run setup' unless @connection
+      return @connection.exec(query)
+    end
+  end
+
+  def exec_params(query, params)
+    if block_given?
+      setup
+      yield(@connection.exec_params(query, params))
+      teardown
+    else
+      raise 'please run setup' unless @connection
+      return @connection.exec_params(query, params)
+    end 
+  end
+
+  private
+
+  def shell_out(cmd)
+    result = `#{cmd}`
+    result.strip
+  end
+
+end

data/lib/pg_tester/version.rb

@@ -0,0 +1,3 @@
+class PgTester
+  VERSION = "0.1.0"
+end

data/pg_tester.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pg_tester/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pg_tester"
+  spec.version       = PgTester::VERSION
+  spec.authors       = ["yann ARMAND", "neeran GUL"]
+  spec.email         = ["yarmand@yammer-inc.com", "ngul@yammer-inc.com"]
+  spec.license       = "MIT"
+  spec.summary       = %q{Runs tests against a temporary postgresql instance}
+  spec.description   = %q{Test postgresql scripts and run queries against a temporary postgresql instance}
+  spec.homepage      = "https://github.int.yammer.com/yammer/pgtester"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_runtime_dependency 'pg', '~> 0.18', '>= 0.18.2'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: pg_tester
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yann ARMAND
+- neeran GUL
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+description: Test postgresql scripts and run queries against a temporary postgresql
+  instance
+email:
+- yarmand@yammer-inc.com
+- ngul@yammer-inc.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pg_tester.rb
+- lib/pg_tester/version.rb
+- pg_tester.gemspec
+homepage: https://github.int.yammer.com/yammer/pgtester
+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: Runs tests against a temporary postgresql instance
+test_files: []