dbtap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ff6f5b046d3324a54837496af2f0727b541a34f
+  data.tar.gz: 42f106382e26df6a255f32172f5e9f5c0423745a
+SHA512:
+  metadata.gz: e464b3b5d0f57c32185d6029381c9cd6442037527854d7e75134c8ad240f62ab39b70dde72be71bebc0f4c46738d5c1c6a5977de4cbf714156ec4eefa2eae910
+  data.tar.gz: 8ee1dd7ca87dc7ced01251f65fa250dc06eea9f67db701ad93c9760c63e6a1baf7d5d553cfde7d982e8c1f9bf29e03fa62921542e9e2746ecc94651555da5bd5

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## 0.0.1 - 2014-08-18
+
+### Added
+- The project itself
+
+### Deprecated
+- Nothing.
+
+### Removed
+- Nothing.
+
+### Fixed
+- Nothing.

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dbtap.gemspec
+gemspec
+gem 'pg' # ADDED BY SEQUELIZER

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Outcomes Insights, Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# Dbtap
+
+Dbtap aims to eventually be a database-agnostic replacement for the __amazing__ [pgTAP](http://pgtap.org/)
+
+## Why?
+
+[One of my projects](https://github.com/outcomesinsights/conceptql) started off using PostgreSQL as its sole RDBMS.  I had employed pgTAP to run the [tests for that project](https://github.com/outcomesinsights/test_conceptql) and was __very__ happy.  But, sadly, other databases needed to be supported and so my tests would no longer run against those new RDBMSs.
+
+But fortunately, [Sequel](http://sequel.jeremyevans.net/) exists and is great for writing database-agnostic SQL.  I am now porting over any functions I liked in pgTAP over into Dbtap.
+
+I'll probably never need the majority of functions that pgTAP provides, meaning I won't be porting them over myself, but I'll update this library as my needs arise.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dbtap'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dbtap
+
+
+## Usage
+
+1. Define a set of tests in a ruby file (see the examples directory)
+2. Run that file using Dbtap's command line tool, `dbtap`
+    - e.g. `dbtap run_file my_test_file.rb`
+3. Marvel at the TAP-compatible output that issues forth
+
+
+## Contributing
+
+1. Fork it ( http://github.com/outcomesinsights/dbtap/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Thanks
+
+- [Outcomes Insights, Inc.](http://outins.com)
+    - Many thanks for allowing me to release a portion of my work as Open Source Software!
+- David E. Wheeler
+    - For writing [pgTAP](http://pgtap.org/)!
+- Jeremy Evans
+    - For writing [Sequel](http://sequel.jeremyevans.net/)!
+
+## License
+Released under the MIT license, Copyright (c) 2014 Outcomes Insights, Inc.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/dbtap

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/dbtap/cli'
+
+Dbtap::CLI.start(ARGV)

data/dbtap.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dbtap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dbtap"
+  spec.version       = Dbtap::VERSION
+  spec.authors       = ["Ryan Duryea"]
+  spec.email         = ["aguynamedryan@gmail.com"]
+  spec.summary       = %q{Write database-agnostic, TAP-emitting unit tests for your database}
+  spec.description   = %q{A database-agnostic reimplementation of my favorite methods from pgTAP}
+  spec.homepage      = "https://github.com/outcomesinsights/dbtap"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'sequelizer', '~> 0.0', '>= 0.0.3'
+end

data/examples/basic_example.rb

@@ -0,0 +1,18 @@
+# Use the `dbtap` command line utility to run this file, e.g.:
+# bundle exec dbtap run_test examples/basic_example.rb
+
+# Start defining a set of tests
+define_tests do
+  # Test if these two queries return the same set of rows
+  set_eq(db[:person], db[:person], 'person should equal self')
+  # See if this query runs within 1.0 seconds (plus or minus 0.99999)
+  performs_within(db[:person], 1.0, 0.99999, 'person should be quick')
+end
+
+# Define another set of results
+define_tests do
+  set_eq(db['SELECT * FROM "person"'], db[:person], 'person should equal text-based self')
+  set_eq(db['SELECT * FROM "person"'], db['SELECT * FROM "person"'], 'text-based person should equal text-based self')
+  set_eq(db[:person], db[:person].limit(1), 'person should equal self')
+  performs_within(db[:person], 1.0, 0.99999, 'person should be quick')
+end

data/lib/dbtap/cli.rb

@@ -0,0 +1,15 @@
+require 'thor'
+require_relative '../dbtap'
+
+module Dbtap
+  class CLI < Thor
+    include Dbtap
+
+    desc 'run_test file1 [file2 ...]', 'runs tests in the selected file(s)'
+    def run_test(*files)
+      files.flatten.each do |file|
+        instance_eval(File.read(file))
+      end
+    end
+  end
+end

data/lib/dbtap/tapper.rb

@@ -0,0 +1,72 @@
+require 'sequelizer'
+
+module Dbtap
+  # The Tapper class provides the DSL for Dbtap#define_tests
+  #
+  # It also drives the evaluation of all the tests via #run
+  class Tapper
+    include Sequelizer
+
+    attr :tests
+    def initialize
+      @tests = []
+    end
+
+    # Drives the evaluation of each test, emitting TAP-compliant messages
+    # for each test
+    def run
+      puts (1..tests.length).to_s
+      tests.each_with_index do |test, i|
+        if test.is_ok?
+          ok(test, i)
+        else
+          not_ok(test, i)
+        end
+      end
+    end
+
+    private
+    # Emits a TAP-compliant OK message
+    def ok(test, i)
+      message = "ok #{i + 1}"
+      message += ' - ' + test.name if test.name
+      puts message
+    end
+
+    # Emits a TAP-compliant NOT OK message
+    def not_ok(test, i)
+      message = "not ok #{i + 1}"
+      message += ' - ' + test.name if test.name
+      message += "\n  " + test.errors.split.join("\n  ") if test.errors
+      puts message
+    end
+
+    # When dbtap is gem, this will require testers from the proper
+    # relative path
+    def local_require(file)
+      path = base_dir + 'testers' + file.to_s
+      require_relative path
+    end
+
+    # When we install dbtap as a gem, it will need to refer to the testers
+    # directory, so we'll first find where the gem lives
+    def base_dir
+      Pathname.new(__FILE__).dirname
+    end
+
+    # The following methods are hard-coded, and used to instantiate
+    # each type of test.  I imagine I can do some sort of thing where
+    # each Tester class can register with Tapper to get dynamically create
+    # a set of methods for Tapper to use, but for now, this is my approach
+    def set_eq(*args)
+      local_require(:set_eq)
+      tests << SetEq.new(*args)
+    end
+
+    def performs_within(*args)
+      local_require(:performs_within)
+      tests << PerformsWithin.new(*args)
+    end
+  end
+end
+

data/lib/dbtap/testers/performs_within.rb

@@ -0,0 +1,53 @@
+require 'benchmark'
+require_relative 'tester'
+
+module Dbtap
+  # Tests if a query performs within a certain period of time.
+  #
+  # Each query is run ten times and
+  #
+  # This is useful for benchmarking, and will verify that a query ran
+  # neither too slow nor too fast.
+  class PerformsWithin < Tester
+    attr :expected_time, :query, :elapsed_time, :delta
+    # +query+ - The query to benchmark
+    # +expected_time+ - The average expected time to run the query once (in milliseconds)
+    # +delta+ - The amount of time + or - that the query is allowed to deviate (in milliseconds)
+    # +name+ - (optional) the name of the test
+    def initialize(query, expected_time, delta, name = nil)
+      @name = name
+      @query = query
+      @expected_time = expected_time
+      @delta = delta
+    end
+
+    def ok?
+      (expected_time - elapsed_time).abs.to_f / repetitions <= delta
+    end
+
+    def errors
+      output = []
+      output << "  average runtime: #{elapsed_time} ms"
+      output << "  desired average: #{expected_time} +/- #{delta} ms"
+
+      output.join("\n")
+    end
+
+    private
+    def elapsed_time
+      @elapsed_time ||= bench_it
+    end
+
+    def bench_it
+      Benchmark.realtime do
+        repetitions.times do
+          query.count
+        end
+      end
+    end
+
+    def repetitions
+      10
+    end
+  end
+end

data/lib/dbtap/testers/set_eq.rb

@@ -0,0 +1,52 @@
+require_relative 'tester'
+
+module Dbtap
+  # Tests to see if two sets of results are equal
+  #
+  # Sets is a bit of a misnomer in that if a query returns duplicate rows,
+  # those rows are NOT deduplicated.
+  #
+  # The order in which either query returns the results is ignored when testing
+  # for equality.
+  class SetEq < Tester
+    attr :actual, :expected
+
+    # +actual+ - The query being tested
+    # +expected+ - The set of results expected.  Should be another query.
+    # +name+ - (optional) the name of the test
+    def initialize(actual, expected, name = nil)
+      @name = name
+      @actual = actual
+      @expected = expected
+    end
+
+    def ok?
+      missing.empty? && extras.empty?
+    end
+
+    def errors
+      output = []
+      unless missing.empty?
+        output << "Missing #{missing.count}/#{expected_count} Records:\n    " + missing.first.inspect
+      end
+
+      unless extras.empty?
+        output << "Extra #{extras.count} over #{expected_count} Records:\n    " + extras.first.inspect
+      end
+      output.join("\n")
+    end
+
+    private
+    def missing
+      @missing ||= expected.except(actual).all
+    end
+
+    def extras
+      @extras ||= actual.except(expected).all
+    end
+
+    def expected_count
+      @expected_count = expected.count
+    end
+  end
+end

data/lib/dbtap/testers/tester.rb

@@ -0,0 +1,21 @@
+module Dbtap
+  # Parent class to all classes that provide some sort of test
+  #
+  # Child classes must provide an <tt>ok?</tt> method which returns
+  # true if the test passes, or false otherwise
+  #
+  # Child classes can opt to provide an <tt>errors</tt> method with
+  # should return a string with any error information relavent to the test
+  class Tester
+    attr :name
+
+    def is_ok?
+      ok?
+    rescue
+      puts "Bail out! #{$!.message}"
+      puts $!.backtrace.join("\n")
+      raise
+    end
+  end
+end
+

data/lib/dbtap/version.rb

@@ -0,0 +1,3 @@
+module Dbtap
+  VERSION = "0.0.1"
+end

data/lib/dbtap.rb

@@ -0,0 +1,23 @@
+require "dbtap/version"
+require "dbtap/tapper"
+
+module Dbtap
+  # Starts a new set of tests.  Use like so:
+  #
+  #   require 'dbtap'
+  #   include Dbtap
+  #
+  #   define_tests do
+  #     set_eq(db[:table], db['select * from table'],
+  #       'Sequel selects all from table')
+  #     # Your other tests here
+  #   end
+  #
+  # Within the block, `db` is defined as a Sequel-based connection
+  # to your database as defined by your Sequelizer configuration
+  def define_tests(&block)
+    t = Tapper.new
+    t.instance_eval(&block)
+    t.run
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: dbtap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Duryea
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: sequelizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+description: A database-agnostic reimplementation of my favorite methods from pgTAP
+email:
+- aguynamedryan@gmail.com
+executables:
+- dbtap
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/dbtap
+- dbtap.gemspec
+- examples/basic_example.rb
+- lib/dbtap.rb
+- lib/dbtap/cli.rb
+- lib/dbtap/tapper.rb
+- lib/dbtap/testers/performs_within.rb
+- lib/dbtap/testers/set_eq.rb
+- lib/dbtap/testers/tester.rb
+- lib/dbtap/version.rb
+homepage: https://github.com/outcomesinsights/dbtap
+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: Write database-agnostic, TAP-emitting unit tests for your database
+test_files: []
+has_rdoc: