vscripts 0.1.3 → 0.1.5

data/spec/integration/commands/identify_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+require 'vscripts'
+
+describe 'Command: Identify' do
+  include_context 'VScripts'
+  include_context 'Suppressed output'
+  include_context 'Temporary'
+
+  subject { VScripts.run }
+
+  let(:identify)      { VScripts::Commands::Identify }
+  let(:hostname_file) { "#{TEMP_DIR}/test-hostname" }
+  let(:hosts_file)    { "#{TEMP_DIR}/test-hosts" }
+
+  before(:each) do
+    allow_any_instance_of(identify)
+      .to receive(:hostname_path).and_return(hostname_file)
+    allow_any_instance_of(identify)
+      .to receive(:hosts_path).and_return(hosts_file)
+    allow_any_instance_of(identify).to receive('`')
+  end
+
+  describe 'when \'--help\'' do
+    it 'exits and shows help' do
+      stub_cli_with('identify --help')
+      expect{subject}.to raise_error(SystemExit)
+      expect($stdout.string).to match(/USAGE:/)
+    end
+  end
+
+  context 'when unknown argument' do
+    it 'returns error with message' do
+      stub_cli_with('identify --xyz')
+      expect{subject}.to raise_error(SystemExit)
+      expect($stderr.string).to match(/Error: unknown argument/)
+    end
+  end
+
+  context 'when not an EC2 instance' do
+    include_context 'Not an EC2 Instance', VScripts::Commands::Identify
+    it 'returns error with message' do
+      stub_cli_with('identify')
+      expect{subject}.to raise_error(SystemExit)
+      expect($stderr.string)
+        .to match('FATAL: NOT an EC2 instance or could not connect to Metadata')
+    end
+  end
+
+  context 'when EC2 instance' do
+    include_context 'EC2 Instance without tags', VScripts::Commands::Identify
+
+    context 'without tags' do
+      it 'writes default hostname' do
+        stub_cli_with('identify')
+        allow_any_instance_of(identify).to receive(:tag)
+        subject
+        expect(IO.read(hostname_file)).to eq('1')
+        expect($stdout.string).to match('Done.')
+      end
+    end
+
+    context 'and when \'--ec2-tag-theme\'' do
+      it 'returns the themed host' do
+        stub_cli_with('identify --ec2-tag-theme=Test-#')
+        allow_any_instance_of(identify).to receive(:tag)
+          .and_return('TestValue')
+        subject
+        expect(IO.read(hostname_file)).to eq('TestValue-1')
+      end
+    end
+
+    context 'and when \'--host\'' do
+      it 'returns the new host' do
+        stub_cli_with('identify --host=test-host')
+        subject
+        expect(IO.read(hostname_file)).to eq('test-host')
+      end
+    end
+
+    context 'and when \'--domain\'' do
+      it 'returns the new domain' do
+        stub_cli_with('identify --domain=example.tld')
+        subject
+        expect(IO.read(hosts_file)).to match('example.tld')
+      end
+    end
+
+    context 'and when similar found' do
+      it 'returns the incremented host' do
+        stub_cli_with('identify --ec2-tag-theme=Test-#')
+        allow_any_instance_of(identify).to receive(:tag)
+          .and_return('TestName')
+        allow_any_instance_of(identify).to receive(:domain)
+          .and_return('TestDomain.tld')
+        subject
+        expect(IO.read(hostname_file)).to eq('TestName-2')
+        expect(IO.read(hosts_file)).to match('TestName-2.TestDomain.tld')
+      end
+    end
+   end
+end

data/spec/integration/commands/tags2facts_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+require 'vscripts'
+
+describe 'Command: Tags2Facts' do
+  include_context 'VScripts'
+  include_context 'Suppressed output'
+  include_context 'Temporary'
+
+  subject { VScripts.run }
+
+  let(:tags2facts) { VScripts::Commands::Tags2facts }
+
+  before(:each) do
+    stub_cli_with('tags2facts')
+  end
+
+  context 'when \'--help\'' do
+    it 'returns command specific help' do
+      stub_cli_with('tags2facts --help')
+      expect{subject}.to raise_error(SystemExit)
+      expect($stdout.string).to match(/USAGE:/)
+      expect($stdout.string).to match(/OPTIONS:/)
+    end
+  end
+
+  context 'when unknown argument' do
+    it 'returns error with message' do
+      stub_cli_with('tags2facts --xyz')
+      expect{subject}.to raise_error(SystemExit)
+      expect($stderr.string).to match(/Error: unknown argument/)
+    end
+  end
+
+  context 'when not an EC2 instance' do
+    include_context 'Not an EC2 Instance', VScripts::Commands::Tags2facts
+    it 'returns error with message' do
+      expect{subject}.to raise_error(SystemExit)
+      expect($stderr.string)
+        .to match('FATAL: NOT an EC2 instance or could not connect to Metadata')
+    end
+  end
+
+  context 'when EC2 instance' do
+    context 'without tags' do
+      include_context 'EC2 Instance without tags', VScripts::Commands::Tags2facts
+      it 'returns error with message' do
+        expect{subject}.to raise_error(SystemExit)
+        expect($stderr.string).to match(/No tags were found/)
+      end
+    end
+
+    context 'with tags' do
+      before(:each) do
+        allow_any_instance_of(tags2facts)
+          .to receive_message_chain('cli.file')
+          .and_return(test_file)
+        allow_any_instance_of(tags2facts)
+          .to receive_message_chain('cli.all').and_return(false)
+      end
+
+      context '--all specified' do
+        include_context 'EC2 Instance with tags', VScripts::Commands::Tags2facts
+        it 'creates file' do
+          stub_cli_with('tags2facts --all')
+          allow_any_instance_of(tags2facts)
+            .to receive_message_chain('cli.all').and_return(true)
+          subject
+          expect(IO.read(test_file)).to match(tags['Name'])
+        end
+      end
+
+      context '--all not specified' do
+        include_context 'EC2 Instance with tags', VScripts::Commands::Tags2facts
+        it 'creates file' do
+          subject
+          expect(IO.read(test_file)).to match(tags.keys.last)
+        end
+      end
+
+      context '--file specified' do
+        include_context 'EC2 Instance with tags', VScripts::Commands::Tags2facts
+        it 'creates file' do
+          stub_cli_with("tags2facts --file #{test_file}")
+          subject
+          expect(IO.read(test_file)).to match(tags.keys.last)
+        end
+      end
+
+      context '--file not specified' do
+        include_context 'EC2 Instance with tags', VScripts::Commands::Tags2facts
+        it 'creates file' do
+          subject
+          expect(IO.read(test_file)).to match(tags.keys.last)
+        end
+      end
+    end
+  end
+end

data/spec/integration/commands_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'vscripts'
+
+describe 'Command: Unknown' do
+  include_context 'VScripts'
+  include_context 'Suppressed output'
+
+  it 'returns error with message' do
+    expect{stub_cli_with('xyz')}.to raise_error(SystemExit)
+    expect($stderr.string).to match(/Error: unknown subcommand/)
+  end
+end

data/spec/integration/config_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'vscripts'
+
+describe 'Configuration' do
+  let(:dotcfg) { "#{File.expand_path('~')}/.vscripts.yml" }
+  let(:syscfg) { '/etc/vscripts/config.yml' }
+
+  subject { VScripts::Config.new }
+
+  before(:each) do
+    allow(File).to receive(:read).with(dotcfg)
+      .and_return('loaded: dot_file')
+    allow(File).to receive(:read).with(syscfg)
+      .and_return('loaded: sys_file')
+  end
+
+  it 'loads the configuration' do
+    expect(subject.get).to be_a Hash
+  end
+
+  context 'and if a config file exists' do
+    it 'returns an empty hash if file is empty' do
+      allow(File).to receive(:exist?).and_return(false)
+      expect(subject.get).to be_empty
+    end
+    it 'returns a hash if file not empty' do
+      allow(File).to receive(:exist?).and_return(true)
+      expect(subject.get).to be_a Hash
+      expect(subject.get).not_to be_empty
+    end
+  end
+
+  context 'and if both files exist' do
+    it 'returns the command line configuration first' do
+      allow(File).to receive(:exist?).and_return(true)
+      allow(File).to receive(:read)
+        .and_return('---\nloaded: cli_file')
+      expect(subject.get).to be_a Hash
+      expect(subject.get.values.first).to eq('cli_file')
+    end
+
+    it 'returns the dotfiles second' do
+      allow(File).to receive(:exist?).with(dotcfg).and_return(true)
+      allow(File).to receive(:exist?).with(syscfg).and_return(true)
+      expect(subject.get).to be_a Hash
+      expect(subject.get.values.first).to eq('dot_file')
+    end
+
+    it 'and system file second third' do
+      allow(File).to receive(:exist?).with(dotcfg).and_return(false)
+      allow(File).to receive(:exist?).with(syscfg).and_return(true)
+      expect(subject.get).to be_a Hash
+      expect(subject.get.values.first).to eq('sys_file')
+    end
+  end
+end

data/spec/integration/global_opts_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'vscripts'
+
+describe 'Global Options' do
+  include_context 'VScripts'
+  include_context 'Suppressed output'
+
+  subject { VScripts.run }
+
+  describe 'Help' do
+    context 'when \'-h\'' do
+      it 'returns help and exits' do
+        expect{stub_cli_with('-h')}.to raise_error(SystemExit)
+        expect($stdout.string).to match(/Available commands/)
+      end
+    end
+
+    context 'when \'--help\'' do
+      it 'returns help and exits' do
+        expect{stub_cli_with('--help')}.to raise_error(SystemExit)
+        expect($stdout.string).to match(/Available commands/)
+      end
+    end
+  end
+
+  describe 'Version' do
+    context 'when \'-v\'' do
+      it 'returns version and exits' do
+        expect{stub_cli_with('-v')}.to raise_error(SystemExit)
+        expect($stdout.string).to match(/VScripts.*(c)/)
+      end
+    end
+
+    context 'when \'--version\'' do
+      it 'returns version and exits' do
+        expect{stub_cli_with('--version')}.to raise_error(SystemExit)
+        expect($stdout.string).to match(/VScripts.*(c)/)
+      end
+    end
+  end
+  describe 'Unknown argument' do
+    context 'when short' do
+      it 'returns error with message' do
+        expect{stub_cli_with('-z')}.to raise_error(SystemExit)
+        expect($stderr.string).to match(/Error: unknown argument/)
+      end
+    end
+
+    context 'when long' do
+      it 'returns error with message' do
+        expect{stub_cli_with('--xyz')}.to raise_error(SystemExit)
+        expect($stderr.string).to match(/Error: unknown argument/)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,6 +2,8 @@
 require 'coveralls'
 Coveralls.wear!
 
+TEMP_DIR = File.join(File.dirname(__FILE__),'..','tmp')
+
 # Development code coverage
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   Coveralls::SimpleCov::Formatter,
@@ -19,13 +21,135 @@ RSpec.configure {|config|
   # Use color not only in STDOUT but also in pagers and files
   config.tty = true
 
+  # Show test times
+  config.profile_examples = true
+
   # Use the specified formatter
   config.formatter = :documentation # :progress, :html, :textmate
 
+  # Create temporary files
+  config.before(:suite) {
+    FileUtils.mkdir_p TEMP_DIR
+    FileUtils.touch "#{TEMP_DIR}/test-file"
+    File.open("#{TEMP_DIR}/test-hostname", 'w') do |newfile|
+      newfile.write('TestHostname')
+    end
+    File.open("#{TEMP_DIR}/test-hosts", 'w') do |newfile|
+      newfile.write('127.0.0.1 TestHostname')
+    end
+  }
+
   # Clean up
   config.after(:suite) {
-    unless ENV['TRAVIS']
-      `ls /tmp/vscripts-test-* &> /dev/null && rm -r /tmp/vscripts-test-*`
-    end
+    FileUtils.rm_rf TEMP_DIR if Dir[TEMP_DIR]
   }
 }
+
+shared_context 'Temporary' do
+  let(:temp_dir) { TEMP_DIR }
+  let(:test_dir) { "#{TEMP_DIR}/test-dir" }
+  let(:test_file) { "#{TEMP_DIR}/test-file" }
+  let(:test_missing_file) { "#{test_dir}/test-file" }
+  let(:test_cont) { 'VScripts Test Content.' }
+end
+
+shared_context 'Suppressed output' do
+  before(:each) do
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+  end
+
+  after(:each) do
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end
+
+def stub_cli_with(args)
+  allow(VScripts).to receive(:cli)
+    .and_return(VScripts::CommandLine.new(args.split))
+end
+
+shared_context 'VScripts' do
+  let(:cmd) { VScripts::Commands.list.first.to_s.downcase }
+end
+
+shared_context 'Not an EC2 Instance' do
+  before(:each) do
+   allow(Net::HTTP).to receive(:get_response).and_return(false)
+  end
+end
+
+shared_context 'Amazon Web Services' do |subject|
+  # Preload AWS library
+  AWS.eager_autoload! AWS::Core     # Make sure to load Core first.
+  AWS.eager_autoload! AWS::EC2      # Load the EC2 class
+
+  ::AWS.config({
+    :access_key_id => '1234',
+    :secret_access_key => '5678',
+    :logger => nil,
+    :stub_requests => true
+  })
+
+  let(:region) {'us-east-1'}
+
+  let(:fake_instances) {::AWS::Core::Data.new([
+    {id: 'i-abcdefg1', status: :running, tags: tags},
+    {id: 'i-abcdefg2', status: :terminated, tags: tags},
+    {id: 'i-abcdefg3', status: :running, tags: {}},
+    {id: 'i-abcdefg4', status: :terminated, tags: {}},
+  ])}
+
+  let(:tags) {{
+    'Name' => 'TestName-1.TestDomain.tld',
+    'Domain' => 'TestDomainValue.tld',
+    'TestTagKey' => 'TestTagValue',
+  }}
+
+  before(:each) do
+    allow_any_instance_of(subject)
+      .to receive_message_chain('ec2.instances.tagged')
+      .and_return(fake_instances[0..1])
+    allow_any_instance_of(subject)
+      .to receive_message_chain(:named_instances)
+      .and_return(fake_instances[0..1])
+  end
+end
+
+shared_context 'EC2 Instance' do |subject|
+  include_context 'Amazon Web Services', subject
+
+  before(:each) do
+    allow(Net::HTTP).to receive(:get_response).and_return(true)
+    allow(subject).to receive_message_chain('open.read')
+      .and_return('Remote server response')
+    allow_any_instance_of(subject).to receive(:zone)
+    allow_any_instance_of(subject).to receive(:region)
+      .and_return('us-east-1')
+    allow_any_instance_of(subject).to receive(:instance_id)
+      .and_return(fake_instances[1].id)
+    allow_any_instance_of(subject)
+      .to receive_message_chain('ec2.tags.create')
+  end
+end
+
+shared_context 'EC2 Instance without tags' do |subject|
+  include_context 'EC2 Instance', subject
+
+  before(:each) do
+    allow_any_instance_of(subject)
+      .to receive_message_chain('instance.tags')
+      .and_return({})
+  end
+end
+
+shared_context 'EC2 Instance with tags' do |subject|
+  include_context 'EC2 Instance', subject
+
+  before(:each) do
+     allow_any_instance_of(subject)
+      .to receive_message_chain('instance.tags')
+      .and_return(tags)
+  end
+end