No commit activity in last 3 years
No release in over 3 years
EnvTestHelpers is a collection of helpers to work with environment variables in tests. Right now is only working with Rspec.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.7
~> 10.0
 Project Readme

EnvTestHelpers

EnvTestHelpers is a collection of helpers to work with environment variables in tests. Right now is only working with Rspec.

Use case:

  • I have configurations set in ignored files, most of this variables are Api keys or passwords.
  • The code and tests needs this variables but I can not share them in my VCS.

Solution:

  • I mock or set this variables in the test they are required.

Installation

Add this line to your application's Gemfile:

gem 'env_test_helpers', group: :test

And then execute:

$ bundle

Or install it yourself as:

$ gem install env_test_helpers

RSpec

All done. The module gets included in the rspec configure block.

Else

Right now only works with RSpec.

Usage

Using the variables inside a block:

it 'does something with the FOO environment variable' do
  with_env_vars 'FOO' => 'bar' do
    # logic that depends upon ENV['FOO'] goes here
  end
end

As a before block:

describe Thing do
  before(:all) do
    mock_env_vars('FOO' => 'bar')
  end
  it 'does something with the FOO environment variable' do
    # logic that depends upon ENV['FOO'] goes here
  end
end

Contributing

  1. Fork it ( https://github.com/[my-github-username]/env_test_helpers/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 a new Pull Request