confswap 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 215b9df2a80e58dc45557cb8359c50e87077480c
-  data.tar.gz: b00ef6a97570079f5dd225eba7685347cf8f62bd
+  metadata.gz: bf14a7b12e576ef8ed3a80def9604890cb741567
+  data.tar.gz: a2460ccf7e5e02b1759d2f549633529e849bab01
 SHA512:
-  metadata.gz: 16bf29af5ea5965625970900ae230813e7c7267393212343532114e5b0eb46eeb20e65b23246cf0b2c3dc13d51248b513598c869b12377d969b8d79f05dafcda
-  data.tar.gz: 9814d9e753eba16381f24d07ad22aeed0d1fb87c79717f4e2ab15b55d65bd238f8f7cc2e23083b2071ca8d04f5407c5085df958538e03ef1011417ba6b09beb8
+  metadata.gz: e3d8797cd327f6314d0bb4d529efac96be10e590f4fd59f81dd5b33f2ed9e99a3cd83385cb839cfa9c7e3130526f1695b89343d6242b330059d26fd55317ce9f
+  data.tar.gz: 93491351e0d1b33ad9c2ff34cb66211abd6fcaf442356c11b9876a0ad88066c3a2f24d5af0585c3f4af5c57c43b5f03e02be268f6119309d3e5e6c79d7815cab

data/.gitignore

@@ -4,8 +4,10 @@
 ## My little test files
 test.conf
 test.conf.out
+test.out
 test.txt
 test.txt.out
+sample.properties
 pfile.txt
 
 ## Ignore Vim swp

data/Gemfile

@@ -7,7 +7,7 @@ group :development, :test do
 	gem 'simplecov'
 	gem 'travis-lint'
   gem 'rspec'
-	gem 'cucumber'
+	gem 'cucumber', '1.3.18'
 	gem 'guard-rspec'
 	gem 'aruba'
 end

data/confswap.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'confswap'
-  s.version     = '0.0.3'
+  s.version     = '0.0.4'
   s.licenses    = ['APACHE2']
   s.summary     = "Confswap swaps conf variables!"
   s.description = "Create a configuration from a template using environment variables"

data/features/pass_environment_variables_with_command_line.feature

@@ -0,0 +1,17 @@
+Feature: Add environment variables with command line
+  Background: 
+    Given a file named "test.conf" with:
+      """
+      # This is a test config
+      # that has some variables in it
+      %{TEST}
+      """
+  Scenario: Single environment variable
+    When I run `confswap -e TEST=giblets test.conf`
+    Then a file named "test.conf.out" should exist
+    And the file "test.conf.out" should contain:
+    """
+    giblets
+    """
+
+  Scenario: Multiple environment variable

data/features/property_file.feature

@@ -0,0 +1,27 @@
+Feature: Confswap should read template variables from a properties file
+  Scenario: Fill in a configuration file with variables from a properties file
+    
+    Given a file named "config_template_for_properties.conf" with:
+      """
+      I like %{VAR1}
+      but I really don't like %{VAR2}
+      # I can handle comments
+      and finally %{VAR3}
+      """
+    And a file named "sample.properties" with:
+      """
+      # This is a test config
+      # that has some variables in it
+      # some comments, and some new lines
+      VAR1: Giblets
+      VAR2: Not so giblets
+
+      # This is a descriptive comment
+      VAR3: so many giblets
+      """
+    When I run `confswap -p sample.properties -o sample.conf config_template_for_properties.conf`
+    Then a file named "sample.conf" should exist
+    And the file "sample.conf" should contain:
+    """
+    I like Giblets
+    """

data/features/support/env.rb

@@ -1,2 +1,5 @@
 require 'fileutils'
 require 'aruba/cucumber'
+
+tmp_dir = File.expand_path(File.dirname(__FILE__)) + '/../../tmp'
+puts tmp_dir

data/features/support/hooks.rb

@@ -1,7 +1,5 @@
 Before do
-  FileUtils.rm_rf '/tmp/confswap'
 end
 
 After do
-  FileUtils.rm_rf '/tmp/confswap'
 end

data/features/variable_replace.feature

@@ -0,0 +1,34 @@
+Feature: Confswap should replace variables in config template with environment variables
+  Background:
+    Given a file named "test.conf" with:
+    """
+    # This is a test config
+    # that has some variables in it
+    %{TEST}
+    """
+    And I set the environment variables to:
+      | variable       | value    |
+      | TEST           | giblets  |
+
+  Scenario: Config file should be created with a default name and contain environment variables
+    When I run `confswap test.conf`
+    Then a file named "test.conf.out" should exist
+    And the file "test.conf.out" should contain:
+    """
+    giblets
+    """
+  Scenario: Config file should be created with a specific name and contain environment variables
+    When I run `confswap --output=named.conf test.conf`
+    Then a file named "named.conf" should exist
+    And the file "named.conf" should contain:
+    """
+    giblets
+    """
+  Scenario: Force an overwrite of a config when a file already exists
+    Given a file named "existing.conf" with:
+    """
+    # This is an exising config 
+    """
+    When I run `confswap --output=existing.conf test.conf`
+    Then a file named "existing.conf" should exist
+

data/features/version.feature

@@ -3,5 +3,5 @@ Feature: See what version of confswap you're running
     Given I run `confswap --version` 
     Then the output should contain:
     """
-    0.0.2
+    0.0.4
     """

data/lib/confswap/command.rb

@@ -4,8 +4,8 @@ require 'confswap'
 module Confswap
   class Command < Clamp::Command
 
-    def initialize(*args)
-      super(*args)	
+    def initialize *args
+      super *args
     end
 
     def help(*args)
@@ -15,28 +15,28 @@ module Confswap
       ].join("\n")
     end
 
-    def run(*args)
-      super(*args)
+    def run *args
+      super *args
     end
 
     def execute
-       if version?
-         puts Confswap::VERSION
-         return 0 
-       end
-
-       if configuration_filename.nil?
-         puts 'Specify a template file or use --help for usage information'
-         return 0
-       end
-
-       if File.exists? configuration_filename
-         swap_config configuration_filename
-         return 0
-       else
-         puts "Error: Configuration template file with name #{configuration_filename} does not exist"
-         return 1
-       end
+      if version?
+        puts Confswap::VERSION
+        return 0 
+      end
+
+      if configuration_filename.nil?
+        puts 'Specify a template file or use --help for usage information'
+        return 0
+      end
+
+      if File.exists? configuration_filename
+        swap_config configuration_filename
+        return 0
+      else
+        puts "Error: Configuration template file with name #{configuration_filename} does not exist"
+        return 1
+      end
     end
 
     def swap_config configuration_filename
@@ -45,7 +45,28 @@ module Confswap
       configuration_template = Confswap::ConfigurationFileReader.read configuration_filename
       env_variables = Confswap::EnvironmentVariableReader.read_variables
 
-      if (!property_file.nil?) || (File.exists? property_file)
+      if envvars
+        envvars.each {|envvar|
+          key_and_value = envvar.split(/=/, 2)
+          key = key_and_value.first
+          value = key_and_value.last
+          if key_and_value.count != 2
+            puts "Invalid envvar specified #{key} and #{value}"
+            return 1 
+          end
+
+          env_variables[key.to_sym]=value
+        }   
+
+        if verbose?
+          puts "Environment variables:"
+          env_variables.each { |var|
+            puts "#{var.first} = #{var.last}"
+          }
+        end
+      end
+
+      if !property_file.nil? and File.exists? property_file
         puts 'pfile specified'
         env_variables = Confswap::PropertyFileVariableReader.read_variables_from_file property_file
         p env_variables
@@ -54,7 +75,7 @@ module Confswap
       begin
         output = configuration_template % env_variables
       rescue KeyError => error
-        puts "#{error.message}.  Your configuration specifies this variable, but it was not found as an environment variable."
+        puts "#{error.message}.  Your configuration requires this variable, but no environment variable was found or specified."
         exit(1)
       end
 
@@ -73,7 +94,7 @@ module Confswap
     end
 
     option ['-p', '--property-file'], "FILE PATH", 'A path to a property file to use for your template variables', :attribute_name => :property_file
-    option ['-e', '--envvar'], "VARIABLE", 'Specify one or more additional environment variables', :multivalued => true
+    option ['-e', '--envvar'], "VARIABLE", 'Specify one or more additional environment variables', :multivalued => true, :attribute_name => :envvars
     option ['-f','--force'], :flag, "Overwrite file if it already exists", :attribute_name => :force
     option ['-v', '--version'], :flag, "The version of confswap you are running", :attribute_name => :version
     option ['-o', '--output'], "FILE PATH", "Specifies the filepath for the file", :attribute_name => :output_filename

data/lib/confswap/version.rb

@@ -1,3 +1,3 @@
 module Confswap
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/property_reader_spec.rb

@@ -1,16 +1,12 @@
 require 'confswap/property_reader'
 
 describe 'Confswap::PropertyFileVariableReader' do
-  it 'should read environment variables from a file and store them in a hash' do
-    read_variables = Confswap::PropertyFileVariableReader.read_variables_from_file 'tmp/test1vars'
-    expect(read_variables).to be_instance_of Hash
-  end
-
   it 'should split only on first colon and extra newlines' do
     variables = "VAR1: 192.168.0.1\n\n\nVAR2: giblets\nVAR3: this should : : have: colons"
-    File.write 'tmp/test2vars', variables
-    vars = Confswap::PropertyFileVariableReader.read_variables_from_file 'tmp/test2vars'
+    File.write 'tmp/property_vars', variables
+    vars = Confswap::PropertyFileVariableReader.read_variables_from_file 'tmp/property_vars'
 
+    expect(vars).to be_instance_of Hash
     expect(vars.length).to equal(3)
     expect(vars).to eq({
       :VAR1 => '192.168.0.1', 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: confswap
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Tom Cowling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-01 00:00:00.000000000 Z
+date: 2015-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -54,10 +54,11 @@ files:
 - Rakefile
 - bin/confswap
 - confswap.gemspec
-- features/overwrite_existing_file.feature
+- features/pass_environment_variables_with_command_line.feature
+- features/property_file.feature
 - features/support/env.rb
 - features/support/hooks.rb
-- features/swap.feature
+- features/variable_replace.feature
 - features/version.feature
 - lib/confswap.rb
 - lib/confswap/command.rb
@@ -94,10 +95,11 @@ signing_key:
 specification_version: 4
 summary: Confswap swaps conf variables!
 test_files:
-- features/overwrite_existing_file.feature
+- features/pass_environment_variables_with_command_line.feature
+- features/property_file.feature
 - features/support/env.rb
 - features/support/hooks.rb
-- features/swap.feature
+- features/variable_replace.feature
 - features/version.feature
 - spec/conf_reader_spec.rb
 - spec/env_reader_spec.rb

data/features/overwrite_existing_file.feature

@@ -1,3 +0,0 @@
-Feature:  Overwrite a config that already exists
-  Scenario: A file already exists
-

data/features/swap.feature

@@ -1,26 +0,0 @@
-Feature: Confswap should swap template variables
-  Background:
-    Given a file named "/tmp/confswap/test.conf" with:
-    """
-    # This is a test config
-    # that has some variables in it
-    %{TEST}
-    """
-    And I set the environment variables to:
-      | variable       | value    |
-      | TEST           | giblets  |
-
-  Scenario: Test config file with placeholders rename standard
-    When I run `confswap /tmp/confswap/test.conf`
-    Then the file "/tmp/confswap/test.conf.out" should contain:
-    """
-    giblets
-    """
-  Scenario: Test config file specifying the output
-    When I run `confswap --output=/tmp/confswap/different.conf /tmp/confswap/test.conf`
-    Then a file named "/tmp/confswap/different.conf" should exist
-    And the file "/tmp/confswap/different.conf" should contain:
-    """
-    giblets
-    """
-