SchemaDev

Gem Version

Development tools for the SchemaPlus family of gems.

Provides support for working with multiple ruby versions, rails adapaters, and db versions. In particular provides a command schema_dev for running rspec (or whatever) on the matrix or a slice or element of it. It also auto-generates the .travis.yml file for travis-ci testing.

Installation

Include this as a development dependency in the client gem's <ame>.gemfile:

s.add_development_dependency "schema_dev"

Setup

schema_dev.yml

The client gem needs a file schema_dev.yml in it's root, which specifies the testing matrix, among other things.

  • ruby: A single version of ruby, or a list of ruby versions.
  • rails: A single version of rails, or a list of rails versions
  • db: (Optional) The list of db adapters to test. Leave this out if the gem will hardwire its tests for a single adapter.
  • quick: (Optional) Hash listing the version of ruby, rails, and db to use with --quick option. If not specified, the default is to use the last entry in each list.

Gemfiles

The client gem must organize its Gemfiles along the lines of:

gemfiles/rails-4.0/Gemfile.postgresql  # if testing against multiple db adapter

gemfiles/Gemfile-rails.4.0             # if hardwired to a single db adapter

Rspec

The client gem should include this in its spec/spec_helper

require 'schema_dev/rspec'
SchemaDev::Rspec.setup_db            # if testing against multiple dbs, the db will be filled in automatically
SchemaDev::Rspec.setup_db 'sqlite3' # to hardwire a single database

This will take care of connecting to the test database appropriately, and will set up logging to a file specific to the test matrix cell.

Rake

The client gem should include this in its Rakefile:

require 'schema_dev/tasks'

Ruby selection

You must have one of chruby, rbenv or rvm installed and working. Within it, have available whichever ruby versions you want to test.

Database

Of course you must have installed whichever database(s) you want to test.

For PostgreSQL and MySQL the tests need a db user with permissions to create and access databases: The default username used by the specs is 'schema_plus' for both PostgreSQL and MySQL; you can change them via:

    $ export POSTGRESQL_DB_USER = pgusername
    $ export MYSQL_DB_USER = mysqlusername

For PostgreSQL and MySQL you must explicitly create the databases used by the tests:

    $ rake create_databases  # creates postgresql and/or mysql as needed

Running The Tests

In the root directory, you can run, e.g.,

$ schema_dev bundle install
$ schema_dev rspec

Which will run those commands over the whole matrix. You can also specify slices, via any combination of --ruby, --rails and (if the gem tests multiple dbs) --db

$ schema_dev rspec --ruby 2.1.3 --rails 4.0

For convenience you can also use --quick to run just one as specified in schema_dev.yml

If you want to pass extra arguments to a command, make sure to use -- to avoid them being processed by schema_dev. e.g.

$ schema_dev rspec --quick -- -e 'select which spec'

For more info, see

$ schema_dev help
$ schema_dev help rspec   # etc.

Generating .travis.yml

To keep things in sync .travis.yml gets automatically updated whenever you run schema_dev matrix or any of its shorthands. There's also a command to just explicitly update .travis.yml

$ schema_dev travis