confswap 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63dffdfc16d8f6f014cc33d485e978b8cc8e98ae
-  data.tar.gz: a115a0ad6878127a50ddb6fe417219b8a13a78e1
+  metadata.gz: 215b9df2a80e58dc45557cb8359c50e87077480c
+  data.tar.gz: b00ef6a97570079f5dd225eba7685347cf8f62bd
 SHA512:
-  metadata.gz: 41e987aebba28bc2d7faf14b0e3a1a3d9326389c258f6414201b057f8c831b0c9ce66034845d196935875fc81b7dadf9f993ce0f5a6bca40e3d811600686ce93
-  data.tar.gz: 5975397d4553080610508565f53ac613e3f0f483c0bbb5ec02292b30f120a18e87f8e47a69fa5d3353bbc4b1d7a92170b4fbb6fc906277f7643e844878416fc6
+  metadata.gz: 16bf29af5ea5965625970900ae230813e7c7267393212343532114e5b0eb46eeb20e65b23246cf0b2c3dc13d51248b513598c869b12377d969b8d79f05dafcda
+  data.tar.gz: 9814d9e753eba16381f24d07ad22aeed0d1fb87c79717f4e2ab15b55d65bd238f8f7cc2e23083b2071ca8d04f5407c5085df958538e03ef1011417ba6b09beb8

data/.gitignore

@@ -4,6 +4,9 @@
 ## My little test files
 test.conf
 test.conf.out
+test.txt
+test.txt.out
+pfile.txt
 
 ## Ignore Vim swp
 *.swp

data/README.md

@@ -3,33 +3,27 @@
 
 
 
-
 A simple command line tool to take a configuration file with template placeholders and replace those placeholders with environment variables.
 
-It appears to be taking the shape of a ruby gem...
-
-## Introduction
-
-This is mostly for me to use as a convenience tool when creating docker containers.
-
-When working with elasticsearch, I have used their system for using environment variables in the config, and this has worked very well for me especially when using ENV variables with docker run.
+The variables can come explicitly from the command, or read from a properties file.
 
 ## Usage
 
-Config files can use the `%{}` style to replace a token in a stirng with a variable
+Configuration files come in different shapes and forms, confswap doesn't care if its toml or yaml
 
-`export GIBLET_STATUS=active`
-`export SPLENETIC_JUICE_FACTOR=10`
-
-`example.conf|.toml|.yaml`
 ```
+# example.conf|.toml|.yaml
+
 # This is a configuration file
+
 giblet_status=%{GIBLETS_STATUS}
 splenetic_juice_factor=%{SPLENETIC_JUICE_FACTOR}
 ``` 
 
 Then run confswap on the file
 
+confswap 
+
 ## Requirements
 
 Requires ruby version > 2.0
@@ -45,19 +39,20 @@ Get the dependencies
 Run the tests
 ``rake spec`` 
 
-### Optional:
-Use guard to rerun tests as you go...
-``guard``
+## Thoughts?
+
+Why not just use sed and replace in some kind of bash script?
+
+I originally used this approach but the script grew unwieldy, maybe I don't do good bash or maybe its just because of lack of testing.  Whilst the benefit of a bash script is that it will run as-is on many systems, I find it better to treat a tool like this as software and therefore use the ecosystems already available to manage dependencies and deploy.  I also enjoy programming in ruby :)
 
 ## Tasks to do and improvement ideas
 
 - ~~error message when config contains env variable that doesnt exist~~
+- ~~acceptance tests~~
+- Read config from properties file
 - verbose command
 - summary of what will change?  dry-run maybe?
+- diff on what has changed in a config if overwriting?
 - test command.rb
-- ~~acceptance tests~~
-
-- internationalization :) 
 - document...
-- diff on what has changed in a config if overwriting?
 

data/Rakefile

@@ -1,4 +1,5 @@
 begin
+  require 'rubygems'
 	require 'bundler/gem_tasks'
   require 'rspec/core/rake_task'
 	require 'cucumber'
@@ -10,6 +11,10 @@ begin
 
   RSpec::Core::RakeTask.new(:spec)
 
+  task :bump do
+  end
+
+  task :build   => ['bump']
   task :default => ['spec']
   task :test    => ['spec','features']
 

data/confswap.gemspec

@@ -1,13 +1,14 @@
 Gem::Specification.new do |s|
   s.name        = 'confswap'
-  s.version     = '0.0.2'
+  s.version     = '0.0.3'
   s.licenses    = ['APACHE2']
   s.summary     = "Confswap swaps conf variables!"
   s.description = "Create a configuration from a template using environment variables"
   s.authors     = ["Tom Cowling"]
   s.email       = 'tom.cowling@gmail.com'
   s.homepage    = 'https://www.tlcowling.com/gems/confswap'
-  s.add_runtime_dependency 'clamp', '~> 0.6.3'
+  s.add_runtime_dependency 'clamp'
+  s.add_runtime_dependency 'thor'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/features/version.feature

@@ -0,0 +1,7 @@
+Feature: See what version of confswap you're running
+  Scenario: Type confswap --version
+    Given I run `confswap --version` 
+    Then the output should contain:
+    """
+    0.0.2
+    """

data/lib/confswap/command.rb

@@ -3,73 +3,81 @@ require 'confswap'
 
 module Confswap
   class Command < Clamp::Command
+
     def initialize(*args)
       super(*args)	
     end
-		def help(*args)
+
+    def help(*args)
       return [
         "This is confswap version #{Confswap::VERSION}",
-				super
-			].join("\n")
-		end
+        super
+      ].join("\n")
+    end
 
-		def run(*args)
+    def run(*args)
       super(*args)
-		end
+    end
 
     def execute
-
        if version?
-				 puts Confswap::VERSION
-				 return 0 
+         puts Confswap::VERSION
+         return 0 
        end
 
        if configuration_filename.nil?
          puts 'Specify a template file or use --help for usage information'
-				 return 0
+         return 0
        end
 
-			 if File.exists? configuration_filename
-		     swap_config configuration_filename	   			   
-			   return 0
-			 else
+       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
+         return 1
+       end
     end
 
-		def swap_config configuration_filename
+    def swap_config configuration_filename
       output_filename_default = configuration_filename + '.out' if output_filename.nil?
 
       configuration_template = Confswap::ConfigurationFileReader.read configuration_filename
       env_variables = Confswap::EnvironmentVariableReader.read_variables
+
+      if (!property_file.nil?) || (File.exists? property_file)
+        puts 'pfile specified'
+        env_variables = Confswap::PropertyFileVariableReader.read_variables_from_file property_file
+        p env_variables
+      end
       
-			begin
+      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."
-				exit(1)
-			end
+      rescue KeyError => error
+        puts "#{error.message}.  Your configuration specifies this variable, but it was not found as an environment variable."
+        exit(1)
+      end
 
       write_file output, output_filename || output_filename_default
-		end
+    end
 
-		def write_file output_file_contents, output_filename
-			return File.write output_filename, output_file_contents unless File.exists? output_filename
+    def write_file output_file_contents, output_filename
+      return File.write output_filename, output_file_contents unless File.exists? output_filename
       
       if File.exists? output_filename and force?
         puts "Overwriting #{output_filename}..."
         File.write output_filename, output_file_contents
-			else
+      else
         puts "#{output_filename} already exists, use the --force flag to overwrite"
       end
-		end
-		
-		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", "Specifies the filepath for the file", :attribute_name => :output_filename
-		option ['--verbose'], :flag, "Be more verbose"
+    end
 
-		parameter "[TEMPLATE_FILE]", "Path to the configuration file", :attribute_name => :configuration_filename
+    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 ['-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
+    option ['--verbose'], :flag, "Be more verbose"
+    parameter "[TEMPLATE_FILE]", "Path to the configuration file", :attribute_name => :configuration_filename
   end
 end

data/lib/confswap/env_reader.rb

@@ -1,7 +1,7 @@
 module Confswap
   class EnvironmentVariableReader
-	  def self.read_variables
-			Hash[ENV.map { |key, value| [key.to_sym, value] }]
-	  end
+    def self.read_variables
+      Hash[ENV.map { |key, value| [key.to_sym, value] }]
+    end
   end
 end

data/lib/confswap/property_reader.rb

@@ -0,0 +1,45 @@
+class Confswap::PropertyFileVariableReader
+  def self.read_variables_from_file file_path
+    contents = File.read file_path
+    self.parse_file_contents contents
+  end
+
+  private
+  def self.parse_file_contents contents
+    raise InvalidPropertyFileException unless self.valid_property_file_contents? contents
+    raw_file_contents = contents.split(/\n/)
+    variables = self.ignore_blank_or_comment_lines(raw_file_contents)
+    variables_hash = {}
+
+    variables.each { |variable_line|
+      split_variable_line = variable_line.split(/:/, 2)
+      variable_key = split_variable_line.first.to_sym
+      variable_value = split_variable_line.at(1).strip
+
+      variables_hash[variable_key] = variable_value
+    }
+    
+    variables_hash
+  end
+
+  def self.ignore_blank_or_comment_lines file_contents
+    file_contents.reject{|v| v.empty? || self.comment_line?(v) }
+  end
+
+  def self.comment_line? line
+    line.start_with? '#'
+  end
+  
+  def self.valid_property_file_contents? property_file_contents
+    file_contents_not_empty = !property_file_contents.empty?
+    file_contents_not_empty
+  end
+end
+
+class Confswap::PropertyFileVariableReader::InvalidPropertyFileException < Exception
+  def initalize message
+    super message
+  end
+end
+
+

data/lib/confswap/version.rb

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

data/lib/confswap.rb

@@ -1,3 +1,4 @@
 require 'confswap/env_reader'
 require 'confswap/conf_reader'
+require 'confswap/property_reader'
 require 'confswap/version'

data/spec/conf_reader_spec.rb

@@ -7,14 +7,14 @@ describe 'Confswap::ConfigFileReader' do
   end
 
   it 'should read the contents of a file specified' do 
-	  expect(Confswap::ConfigurationFileReader.read '/tmp/test.txt').to eql(sample_config)
-	end
-	
+    expect(Confswap::ConfigurationFileReader.read '/tmp/test.txt').to eql(sample_config)
+  end
+
   it 'should return nil if the file does not exist' do
     expect(Confswap::ConfigurationFileReader.read '/path/does/not/exist.txt').to be_nil
   end
 
-	after(:each) do
-	  File.delete('/tmp/test.txt') if File.exists?('/tmp/test.txt')
-	end
+  after(:each) do
+    File.delete('/tmp/test.txt') if File.exists?('/tmp/test.txt')
+  end
 end

data/spec/env_reader_spec.rb

@@ -2,11 +2,11 @@ require 'confswap/env_reader'
 
 describe 'Confswap::EnvironmentVariableReader' do
   it 'should read environment variables and store them in a hash' do
-		env_variables = Confswap::EnvironmentVariableReader.read_variables
-		expect(env_variables).to be_instance_of Hash
+    env_variables = Confswap::EnvironmentVariableReader.read_variables
+    expect(env_variables).to be_instance_of Hash
+  end
+  it 'should store the environment variable FOO=bar in a hash' do
+    ENV['FOO']="bar"
+    expect(Confswap::EnvironmentVariableReader.read_variables).to include(:FOO => "bar")
   end
-	it 'should store the environment variable FOO=bar in a hash' do
-		ENV['FOO']="bar"
-		expect(Confswap::EnvironmentVariableReader.read_variables).to include(:FOO => "bar")
-	end
 end

data/spec/property_reader_spec.rb

@@ -0,0 +1,50 @@
+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'
+
+    expect(vars.length).to equal(3)
+    expect(vars).to eq({
+      :VAR1 => '192.168.0.1', 
+      :VAR2 => 'giblets', 
+      :VAR3 => 'this should : : have: colons' 
+    })
+    
+  end
+
+  it 'should ignore comments in a property file' do
+    file_contents = "# this is a comment \nVAR1: 192.168.0.1\n\n\nVAR2: giblets\nVAR3: this should : : have: colons" 
+    File.write 'tmp/property_file_with_comments', file_contents
+    vars = Confswap::PropertyFileVariableReader.read_variables_from_file 'tmp/property_file_with_comments'
+    expect(vars.length).to eq(3)
+    expect(vars).to eq({
+      :VAR1 => '192.168.0.1',
+      :VAR2 => 'giblets',
+      :VAR3 => 'this should : : have: colons'
+    })
+  end
+
+  it 'should warn for invalid property file when property file is empty' do
+    file_contents = ""
+    File.write 'tmp/invalid_property_file', file_contents
+    expect {
+      Confswap::PropertyFileVariableReader.read_variables_from_file 'tmp/invalid_property_file'
+    }.to raise_exception Confswap::PropertyFileVariableReader::InvalidPropertyFileException
+  end
+
+  pending 'should warn for invalid property file when property file is invalid' do
+    file_contents = "# this is a comment \nVAR1: "
+    File.write 'tmp/invalid_property_file', file_contents
+    expect {
+      Confswap::PropertyFileVariableReader.read_variables_from_file 'tmp/invalid_property_file'
+    }.to raise_exception Confswap::PropertyFileVariableReader::InvalidPropertyFileException
+  end
+end

data/spec/spec_helper.rb

@@ -3,12 +3,12 @@ SimpleCov.start
 
 def sample_config
   [ "# This is a sample config",
-		"# A bunch of lines that will be in a file",
-		"# Because thats what its all about",
-		"test=%{ITEM1}",
-		"test2=%{ITEM2}",
-		"test3=%{ITEM3}"
-	].join("\n")
+    "# A bunch of lines that will be in a file",
+    "# Because thats what its all about",
+    "test=%{ITEM1}",
+    "test2=%{ITEM2}",
+    "test3=%{ITEM3}"
+  ].join("\n")
 end
 
 def sample_variables

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: confswap
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tom Cowling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-16 00:00:00.000000000 Z
+date: 2015-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Create a configuration from a template using environment variables
 email: tom.cowling@gmail.com
 executables:
@@ -44,13 +58,16 @@ files:
 - features/support/env.rb
 - features/support/hooks.rb
 - features/swap.feature
+- features/version.feature
 - lib/confswap.rb
 - lib/confswap/command.rb
 - lib/confswap/conf_reader.rb
 - lib/confswap/env_reader.rb
+- lib/confswap/property_reader.rb
 - lib/confswap/version.rb
 - spec/conf_reader_spec.rb
 - spec/env_reader_spec.rb
+- spec/property_reader_spec.rb
 - spec/spec_helper.rb
 homepage: https://www.tlcowling.com/gems/confswap
 licenses:
@@ -72,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Confswap swaps conf variables!
@@ -81,6 +98,8 @@ test_files:
 - features/support/env.rb
 - features/support/hooks.rb
 - features/swap.feature
+- features/version.feature
 - spec/conf_reader_spec.rb
 - spec/env_reader_spec.rb
+- spec/property_reader_spec.rb
 - spec/spec_helper.rb