chamber 2.4.0 → 2.7.1

data/spec/lib/chamber/commands/show_spec.rb

@@ -5,9 +5,14 @@ module    Chamber
 module    Commands
 describe  Show do
   let(:rootpath) { ::File.expand_path('./spec/fixtures') }
-  let(:options)  { {  basepath:   rootpath,
-                      rootpath:   rootpath,
-                      namespaces: 'test' } }
+  let(:options) do
+    {
+      basepath:       rootpath,
+      rootpath:       rootpath,
+      namespaces:     'test',
+      decryption_key: './spec/spec_key',
+    }
+  end
 
   it 'can return values formatted as environment variables' do
     expect(Show.call(options.merge(as_env: true))).to eql(
@@ -18,15 +23,25 @@ ANOTHER_LEVEL_SETTING_ONE="1"
 ANOTHER_LEVEL_SETTING_TWO="2"
 MY_BOOLEAN="false"
 MY_DYNAMIC_SETTING="2"
+MY_SECURE_SETTINGS="my_secure_value"
 MY_SETTING="my_value"
 HEREDOC
     )
   end
 
+  it 'can return values filtered by whether or not they are secure' do
+    expect(Show.call(options.merge(as_env: true, only_sensitive: true))).to eql(
+<<-HEREDOC.chomp
+MY_SECURE_SETTINGS="my_secure_value"
+HEREDOC
+    )
+  end
+
   it 'can return values formatted as a hash' do
     expect(Show.call(options)).to eql(
 <<-HEREDOC.chomp
 {"my_setting"=>"my_value",
+ "my_secure_settings"=>"my_secure_value",
  "my_boolean"=>false,
  "my_dynamic_setting"=>2,
  "another_level"=>

data/spec/lib/chamber/context_resolver_spec.rb

@@ -9,24 +9,26 @@ describe  ContextResolver do
   let(:rails_4_path) { ::File.expand_path('../../../rails-4-test', __FILE__) }
 
   it 'does not attempt to do any resolution if all valid options are passed in' do
-    options = ContextResolver.resolve(basepath:       'my_path',
-                                      namespaces:     'ns')
+    options = ContextResolver.resolve(basepath:   'my_path',
+                                      namespaces: 'ns')
 
     expect(options[:basepath].to_s).to  eql 'my_path'
     expect(options[:namespaces]).to     eql 'ns'
   end
 
-  it 'does not attempt to do any resolution if files are passed in in place of a basepath' do
-    options = ContextResolver.resolve(files:          'my_files',
-                                      namespaces:     'ns')
+  it 'does not attempt to do any resolution if files are passed in in place of a ' \
+     'basepath' do
+
+    options = ContextResolver.resolve(files:      'my_files',
+                                      namespaces: 'ns')
 
     expect(options[:files]).to          eql 'my_files'
     expect(options[:namespaces]).to     eql 'ns'
   end
 
   it 'defaults the basepath to the rootpath if none is explicitly set' do
-    options = ContextResolver.resolve(rootpath:       './app',
-                                      namespaces:     'ns')
+    options = ContextResolver.resolve(rootpath:   './app',
+                                      namespaces: 'ns')
 
     expect(options[:basepath].to_s).to  eql './app'
   end
@@ -40,14 +42,13 @@ describe  ContextResolver do
   it 'sets the default files if none are passed in' do
     options = ContextResolver.resolve(basepath: './app')
 
-    expect(options[:files].map(&:to_s)).to eql [  './app/credentials*.yml',
-                                                  './app/settings*.yml',
-                                                  './app/settings' ]
+    expect(options[:files].map(&:to_s)).to eql ['./app/settings*.yml',
+                                                './app/settings']
   end
 
   it 'can handle if keys are passed as strings' do
-    options = ContextResolver.resolve('files'      =>  'my_files',
-                                      'namespaces' =>  'ns')
+    options = ContextResolver.resolve('files'      => 'my_files',
+                                      'namespaces' => 'ns')
 
     expect(options[:files]).to          eql 'my_files'
     expect(options[:namespaces]).to     eql 'ns'
@@ -69,9 +70,20 @@ describe  ContextResolver do
   end
 
   it 'sets the decryption key to the default if not passed in' do
-    options = ContextResolver.resolve(rootpath: rails_3_path)
+    options      = ContextResolver.resolve(rootpath: rails_3_path)
+    key_contents = ::File.read(rails_3_path + '/.chamber.pem')
 
-    expect(options[:decryption_key].to_s).to  include 'rails-3-test/.chamber.pem'
+    expect(options[:decryption_key].to_s).to eql key_contents
+  end
+
+  it 'sets the decryption key to the value of the CHAMBER_KEY if available' do
+    ENV['CHAMBER_KEY'] = 'my key'
+
+    options = ContextResolver.resolve(rootpath: 'my_path')
+
+    expect(options[:decryption_key].to_s).to eql 'my key'
+
+    ENV['CHAMBER_KEY'] = nil
   end
 
   it 'does not set the encryption key if the keyfile does not exist' do
@@ -95,32 +107,40 @@ describe  ContextResolver do
   end
 
   it 'sets the information to a Rails preset when the rootpath is a Rails app' do
+    allow(Socket).to receive(:gethostname).and_return 'my_host'
+
     options = ContextResolver.resolve(rootpath: rails_3_path,
                                       preset:   'rails')
 
     expect(options[:basepath].to_s).to  include 'rails-3-test/config'
-    expect(options[:namespaces]).to     eql     ['development']
+    expect(options[:namespaces]).to     eql     %w{development my_host}
   end
 
   it 'sets the basepath if inside a Rails 2 project' do
+    allow(Socket).to receive(:gethostname).and_return 'my_host'
+
     options = ContextResolver.resolve(rootpath: rails_2_path)
 
     expect(options[:basepath].to_s).to  include 'rails-2-test/config'
-    expect(options[:namespaces]).to     eql     ['development']
+    expect(options[:namespaces]).to     eql     %w{development my_host}
   end
 
   it 'sets the basepath if inside a Rails 3 project' do
+    allow(Socket).to receive(:gethostname).and_return 'my_host'
+
     options = ContextResolver.resolve(rootpath: rails_3_path)
 
     expect(options[:basepath].to_s).to  include 'rails-3-test/config'
-    expect(options[:namespaces]).to     eql     ['development']
+    expect(options[:namespaces]).to     eql     %w{development my_host}
   end
 
   it 'sets the basepath if inside a Rails 4 project' do
+    allow(Socket).to receive(:gethostname).and_return 'my_host'
+
     options = ContextResolver.resolve(rootpath: rails_4_path)
 
     expect(options[:basepath].to_s).to  include 'rails-4-test/config'
-    expect(options[:namespaces]).to     eql     ['development']
+    expect(options[:namespaces]).to     eql     %w{development my_host}
   end
 end
 end

data/spec/lib/chamber/file_set_spec.rb

@@ -2,12 +2,13 @@ require 'rspectacular'
 require 'chamber/file_set'
 require 'fileutils'
 
-
 module    Chamber
 describe  FileSet do
-  before(:each) { FileUtils.mkdir '/tmp/settings' unless ::File.exist? '/tmp/settings'
-                  FileUtils.mkdir '/tmp/dash-set' unless ::File.exist? '/tmp/dash-set' }
-  after(:each)  { FileUtils.rm_rf '/tmp/settings' if     ::File.exist? '/tmp/settings' }
+  before(:each) do
+    FileUtils.mkdir '/tmp/settings' unless ::File.exist? '/tmp/settings'
+    FileUtils.mkdir '/tmp/dash-set' unless ::File.exist? '/tmp/dash-set'
+  end
+  after(:each)  { FileUtils.rm_rf '/tmp/settings' if ::File.exist? '/tmp/settings' }
 
   it 'can consider directories containing YAML files' do
     ::File.new('/tmp/settings/some_settings_file.yml', 'w+')
@@ -16,9 +17,9 @@ describe  FileSet do
     file_set = FileSet.new files: '/tmp/settings'
 
     expect(file_set.filenames).to eql  [
-                                         '/tmp/settings/another_settings_file.yml',
-                                         '/tmp/settings/some_settings_file.yml',
-                                       ]
+      '/tmp/settings/another_settings_file.yml',
+      '/tmp/settings/some_settings_file.yml',
+    ]
 
     ::FileUtils.rm_rf('/tmp/settings')
   end
@@ -30,9 +31,23 @@ describe  FileSet do
     file_set = FileSet.new files: '/tmp/settings/*.yml'
 
     expect(file_set.filenames).to eql  [
-                                         '/tmp/settings/another_settings_file.yml',
-                                         '/tmp/settings/some_settings_file.yml',
-                                       ]
+      '/tmp/settings/another_settings_file.yml',
+      '/tmp/settings/some_settings_file.yml',
+    ]
+
+    ::FileUtils.rm_rf('/tmp/settings')
+  end
+
+  it 'will process both *.yml and *.yml.erb files by default' do
+    ::File.new('/tmp/settings/some_settings_file.yml', 'w+')
+    ::File.new('/tmp/settings/another_settings_file.yml.erb', 'w+')
+
+    file_set = FileSet.new files: '/tmp/settings'
+
+    expect(file_set.filenames).to eql  [
+      '/tmp/settings/another_settings_file.yml.erb',
+      '/tmp/settings/some_settings_file.yml',
+    ]
 
     ::FileUtils.rm_rf('/tmp/settings')
   end
@@ -44,8 +59,8 @@ describe  FileSet do
                            namespaces: ['blue']
 
     expect(file_set.filenames).to eql [
-                                        '/tmp/settings/settings-blue.yml'
-                                      ]
+      '/tmp/settings/settings-blue.yml',
+    ]
 
     ::FileUtils.rm_f('/tmp/settings/settings-blue.yml')
   end
@@ -61,15 +76,17 @@ describe  FileSet do
     ::FileUtils.rm_f('/tmp/settings/settings-blue.yml')
   end
 
-  it 'does not consider non-namespaced files which have dashes in their paths as namespaced' do
+  it 'does not consider non-namespaced files which have dashes in their paths as ' \
+     'namespaced' do
+
     ::File.new('/tmp/dash-set/settings.yml', 'w+')
 
     file_set = FileSet.new files:      '/tmp/dash-set/settings*.yml',
                            namespaces: ['blue']
 
     expect(file_set.filenames).to eql [
-                                        '/tmp/dash-set/settings.yml'
-                                      ]
+      '/tmp/dash-set/settings.yml',
+    ]
 
     ::FileUtils.rm_r('/tmp/dash-set/settings.yml')
   end
@@ -78,13 +95,13 @@ describe  FileSet do
     ::File.new('/tmp/settings.yml', 'w+')
 
     file_set = FileSet.new files: [
-                                    '/tmp/settings.yml',
-                                    '/tmp/settings.yml',
-                                  ]
+      '/tmp/settings.yml',
+      '/tmp/settings.yml',
+    ]
 
     expect(file_set.filenames).to eql [
-                                        '/tmp/settings.yml'
-                                      ]
+      '/tmp/settings.yml',
+    ]
 
     ::FileUtils.rm_f('/tmp/settings.yml')
   end
@@ -94,14 +111,14 @@ describe  FileSet do
     ::File.new('/tmp/settings/new_file.yml', 'w+')
 
     file_set = FileSet.new files: [
-                                    '/tmp/settings.yml',
-                                    '/tmp/settings/*.yml',
-                                  ]
+      '/tmp/settings.yml',
+      '/tmp/settings/*.yml',
+    ]
 
     expect(file_set.filenames).to eql  [
-                                         '/tmp/settings.yml',
-                                         '/tmp/settings/new_file.yml',
-                                       ]
+      '/tmp/settings.yml',
+      '/tmp/settings/new_file.yml',
+    ]
 
     ::FileUtils.rm_rf('/tmp/settings*')
   end
@@ -112,8 +129,8 @@ describe  FileSet do
     file_set = FileSet.new files: '/tmp/settings.yml'
 
     expect(file_set.filenames).to eql  [
-                                         '/tmp/settings.yml',
-                                       ]
+      '/tmp/settings.yml',
+    ]
 
     ::FileUtils.rm_rf('/tmp/settings*')
   end
@@ -123,20 +140,20 @@ describe  FileSet do
     ::File.new('/tmp/settings/settings-green.yml', 'w+')
 
     file_set = FileSet.new files:      '/tmp/settings/settings*.yml',
-                           namespaces: ['blue', 'green']
+                           namespaces: %w{blue green}
 
     expect(file_set.filenames).to eql  [
-                                         '/tmp/settings/settings-blue.yml',
-                                         '/tmp/settings/settings-green.yml',
-                                       ]
+      '/tmp/settings/settings-blue.yml',
+      '/tmp/settings/settings-green.yml',
+    ]
 
     file_set = FileSet.new files:      '/tmp/settings/settings*.yml',
-                           namespaces: ['green', 'blue']
+                           namespaces: %w{green blue}
 
     expect(file_set.filenames).to eql  [
-                                         '/tmp/settings/settings-green.yml',
-                                         '/tmp/settings/settings-blue.yml',
-                                       ]
+      '/tmp/settings/settings-green.yml',
+      '/tmp/settings/settings-blue.yml',
+    ]
 
     ::FileUtils.rm_f('/tmp/settings/settings*.yml')
   end
@@ -149,9 +166,9 @@ describe  FileSet do
                            namespaces: ['blue']
 
     expect(file_set.filenames).to eql  [
-                                         '/tmp/settings.yml',
-                                         '/tmp/settings-blue.yml',
-                                       ]
+      '/tmp/settings.yml',
+      '/tmp/settings-blue.yml',
+    ]
 
     ::FileUtils.rm_f('/tmp/settings*.yml')
   end
@@ -164,25 +181,27 @@ describe  FileSet do
                            namespaces: ['blue']
 
     expect(file_set.filenames).to eql  [
-                                         '/tmp/settings.yml',
-                                         '/tmp/settings-blue.yml',
-                                       ]
+      '/tmp/settings.yml',
+      '/tmp/settings-blue.yml',
+    ]
 
     ::FileUtils.rm_f('/tmp/settings*.yml')
   end
 
-  it 'considers each glob independently, placing non-namespaced and namespaced versions of the globs files above those in subsequent globs' do
+  it 'considers each glob independently, placing non-namespaced and namespaced ' \
+     'versions of the globs files above those in subsequent globs' do
+
     ::File.new('/tmp/settings/credentials-development.yml', 'w+')
     ::File.new('/tmp/settings/settings.yml', 'w+')
 
-    file_set = FileSet.new files: ['/tmp/settings/credentials*.yml',
-                                   '/tmp/settings/settings*.yml'],
+    file_set = FileSet.new files:      ['/tmp/settings/credentials*.yml',
+                                        '/tmp/settings/settings*.yml'],
                            namespaces: ['development']
 
     expect(file_set.filenames).to eql [
-                                        '/tmp/settings/credentials-development.yml',
-                                        '/tmp/settings/settings.yml',
-                                      ]
+      '/tmp/settings/credentials-development.yml',
+      '/tmp/settings/settings.yml',
+    ]
 
     ::FileUtils.rm_rf('/tmp/settings')
   end
@@ -194,9 +213,9 @@ describe  FileSet do
     file_set = FileSet.new files: '/tmp/settings/*.yml'
 
     expect(file_set.filenames).to eql  [
-                                         '/tmp/settings/another_settings_file.yml',
-                                         '/tmp/settings/some_settings_file.yml',
-                                       ]
+      '/tmp/settings/another_settings_file.yml',
+      '/tmp/settings/some_settings_file.yml',
+    ]
 
     ::FileUtils.rm_rf('/tmp/settings')
   end
@@ -213,7 +232,9 @@ describe  FileSet do
     ::FileUtils.rm_f('/tmp/settings.yml')
   end
 
-  it 'can convert settings without yielding to the block by using an intermediate settings object' do
+  it 'can convert settings without yielding to the block by using an intermediate ' \
+     'settings object' do
+
     ::File.new('/tmp/settings.yml', 'w+')
 
     file_set = FileSet.new files: '/tmp/settings.yml'

data/spec/lib/chamber/file_spec.rb

@@ -4,6 +4,7 @@ require 'chamber/settings'
 require 'chamber/filters/encryption_filter'
 require 'tempfile'
 
+# rubocop:disable Metrics/LineLength
 def create_tempfile_with_content(content)
   tempfile = Tempfile.new('settings')
   tempfile.puts content
@@ -14,7 +15,7 @@ end
 module    Chamber
 describe  File do
   it 'can convert file contents to settings' do
-    tempfile      = create_tempfile_with_content %Q({ test: settings })
+    tempfile      = create_tempfile_with_content '{ test: settings }'
     settings_file = File.new path: tempfile.path
 
     allow(Settings).to receive(:new).
@@ -24,7 +25,7 @@ describe  File do
 
     expect(file_settings).to  eql :settings
     expect(Settings).to       have_received(:new).
-                              with(settings:       {'test' => 'settings'},
+                              with(settings:       { 'test' => 'settings' },
                                    namespaces:     {},
                                    decryption_key: nil,
                                    encryption_key: nil)
@@ -48,42 +49,42 @@ describe  File do
   end
 
   it 'throws an error when the file contents are malformed' do
-    tempfile      = create_tempfile_with_content %Q({ test : )
+    tempfile      = create_tempfile_with_content '{ test : '
     settings_file = File.new path: tempfile.path
 
     expect { settings_file.to_settings }.to raise_error
   end
 
   it 'passes any namespaces through to the settings' do
-    tempfile      = create_tempfile_with_content %Q({ test: settings })
+    tempfile      = create_tempfile_with_content '{ test: settings }'
     settings_file = File.new  path:       tempfile.path,
                               namespaces: {
-                                environment:  :development }
+                                environment: :development }
 
     allow(Settings).to  receive(:new)
 
     settings_file.to_settings
 
     expect(Settings).to have_received(:new).
-                        with( settings:    {'test' => 'settings'},
-                              namespaces: {
-                                environment:  :development },
-                              decryption_key: nil,
-                              encryption_key: nil)
+                        with(settings:       { 'test' => 'settings' },
+                             namespaces:     {
+                               environment: :development },
+                             decryption_key: nil,
+                             encryption_key: nil)
   end
 
   it 'can handle files which contain ERB markup' do
-    tempfile      = create_tempfile_with_content %Q({ test: <%= 1 + 1 %> })
+    tempfile      = create_tempfile_with_content '{ test: <%= 1 + 1 %> }'
     settings_file = File.new  path: tempfile.path
 
     allow(Settings).to      receive(:new)
 
     settings_file.to_settings
     expect(Settings).to have_received(:new).
-                        with( settings:   {'test' => 2},
-                              namespaces: {},
-                              decryption_key: nil,
-                              encryption_key: nil)
+                        with(settings:       { 'test' => 2 },
+                             namespaces:     {},
+                             decryption_key: nil,
+                             encryption_key: nil)
   end
 
   it 'does not throw an error when attempting to convert a file which does not exist' do
@@ -127,10 +128,20 @@ HEREDOC
 
     settings_file.secure
 
-    settings_file = File.new  path:           tempfile.path
-
-    expect(settings_file.to_settings.send(:raw_data)['_secure_setting']).to       match Filters::EncryptionFilter::BASE64_STRING_PATTERN
-    expect(settings_file.to_settings.send(:raw_data)['_secure_other_setting']).to eql   "g4ryOaWniDPht0x1pW10XWgtC7Bax2yQAM3+p9ZDMmBUKlVXgvCn8MvdvciX0126P7uuLylY7Pdbm8AnpjeaTvPOaDnDjPATkH1xpQG/HKBy+7zd67SMb3tJ3sxJNkYm6RrmydFHkDCghG37lvCnuZs1Jvd/mhpr/+thqKvtI+c/vzY+eFxM52lnoWWOgqwGCtUjb+PMbq+HjId6X8uRbpL1SpINA6WYJwvxTVK9XD/HYn67Fcqdova4dEHoqwzFfE+XVXM8uesE1DG3PFNhAzkT+mWXtBmo17i+K4wrOO06I13uDS3x+7LqoZz/Ez17SPXRJze4M/wyWfm43pnuVw=="
+    settings_file        = File.new  path:           tempfile.path
+    raw_data             = settings_file.to_settings.send(:raw_data)
+    secure_setting       = raw_data['_secure_setting']
+    other_secure_setting = raw_data['_secure_other_setting']
+
+    expect(secure_setting).to       match Filters::EncryptionFilter::BASE64_STRING_PATTERN
+    expect(other_secure_setting).to eql   'g4ryOaWniDPht0x1pW10XWgtC7Bax2yQAM3+p9ZDMmBU' \
+                                          'KlVXgvCn8MvdvciX0126P7uuLylY7Pdbm8AnpjeaTvPO' \
+                                          'aDnDjPATkH1xpQG/HKBy+7zd67SMb3tJ3sxJNkYm6Rrm' \
+                                          'ydFHkDCghG37lvCnuZs1Jvd/mhpr/+thqKvtI+c/vzY+' \
+                                          'eFxM52lnoWWOgqwGCtUjb+PMbq+HjId6X8uRbpL1SpIN' \
+                                          'A6WYJwvxTVK9XD/HYn67Fcqdova4dEHoqwzFfE+XVXM8' \
+                                          'uesE1DG3PFNhAzkT+mWXtBmo17i+K4wrOO06I13uDS3x' \
+                                          '+7LqoZz/Ez17SPXRJze4M/wyWfm43pnuVw=='
   end
 
   it 'does not rewrite the entire file but only the encrypted settings' do
@@ -153,8 +164,8 @@ HEREDOC
     settings_file.secure
 
     file_contents                  = ::File.read(tempfile.path)
-    secure_setting_encoded         = file_contents[/    _secure_setting:       ([A-Za-z0-9\+\/]{342}==)$/, 1]
-    secure_another_setting_encoded = file_contents[/    _secure_another_setting: ([A-Za-z0-9\+\/]{342}==)$/, 1]
+    secure_setting_encoded         = file_contents[%r{    _secure_setting:       ([A-Za-z0-9\+/]{342}==)$}, 1]
+    secure_another_setting_encoded = file_contents[%r{    _secure_another_setting: ([A-Za-z0-9\+/]{342}==)$}, 1]
 
     expect(::File.read(tempfile.path)).to eql <<-HEREDOC
 default:
@@ -170,7 +181,9 @@ other:
 HEREDOC
   end
 
-  it 'when rewriting the file, can handle names and values with regex special characters' do
+  it 'when rewriting the file, can handle names and values with regex special ' \
+     'characters' do
+
     tempfile      = create_tempfile_with_content <<-HEREDOC
 stuff:
   _secure_another+_setting: "Thanks for +all the fish"
@@ -182,7 +195,7 @@ HEREDOC
     settings_file.secure
 
     file_contents                  = ::File.read(tempfile.path)
-    secure_another_setting_encoded = file_contents[/  _secure_another\+_setting: ([A-Za-z0-9\+\/]{342}==)$/, 1]
+    secure_another_setting_encoded = file_contents[%r{  _secure_another\+_setting: ([A-Za-z0-9\+/]{342}==)$}, 1]
 
     expect(::File.read(tempfile.path)).to eql <<-HEREDOC
 stuff:
@@ -191,3 +204,4 @@ HEREDOC
   end
 end
 end
+# rubocop:enable Metrics/LineLength