vscripts 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fabee91a36a3e793e9d2e46fb62e3e0295e5e16e
-  data.tar.gz: 303858f79990e9d93781469001dae7564f9b05ca
+  metadata.gz: f136dbab318d66e5849bc3fd0c919f705f3f4628
+  data.tar.gz: 1a8fc5ec87de153df9422c606b8bcb92e10a1d42
 SHA512:
-  metadata.gz: 0334b47473a8e5208dbfa85a30ef5777b95f519798680e8f3985376de40742e87c6c82cd7453361fd573bb3d78fa082cdcea0f9b5fc18fb52ee528afdcd9e3a9
-  data.tar.gz: 17d85ac616ce98308f089ccc63f5f1424dffb90da70380bc5ebc77bca0aa06b22b48d4fd694336eb3a1f299e487b48c04a9d0363c71681c3d255fa73a28e1b18
+  metadata.gz: 6102d72f4aaed7bf46c3bda322ec5f9d8a41b631c402da8572adde1ebde9b0e63ea51bf07971951a2bfc55b9ac7f0b90cb57d14f2a0e6c0375d9b5df25de3b58
+  data.tar.gz: e9d7926d647076d643f8d3f898d990298eb5f268d287335f0dfae69db2703ca3c030f2ba1a05669107355fac20f73e5740d9e5673330702b0159d682873928f6

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+Version 0.1.0
+---
+  * Domain fallback to local ([Vlad Ghinea - c0d176f](https://github.com/vghn/vscripts/commit/c0d176fe244c10dd8d2b394075d5d6ef1c0ef332))
+  * Add EC2 region support ([Vlad Ghinea - 8bc9561](https://github.com/vghn/vscripts/commit/8bc956128ca6495392d553366ad34aa15b375afa))
+  * Fix JSON tags generation ([Vlad Ghinea - 0134d42](https://github.com/vghn/vscripts/commit/0134d421abb875a1e948927162606b8cfbd7ab43))
+  * Fix filtered tags hash ([Vlad Ghinea - 8f72637](https://github.com/vghn/vscripts/commit/8f72637a555d5f0535d1a87be6c50f36fb8ee181))
+  * Clean-up code ([Vlad Ghinea - 9d1d544](https://github.com/vghn/vscripts/commit/9d1d544eb8c824ab42e0c3cde5485846833b9af8))
+  * New tag query and creation functions ([Vlad Ghinea - 12f1ca0](https://github.com/vghn/vscripts/commit/12f1ca069fef78699c02b8818c8da299e024a785))
+  * Clean up code ([Vlad Ghinea - f7a9d16](https://github.com/vghn/vscripts/commit/f7a9d16eb69365b01365285dba4f9ec5052cae53))
+  * Add identify command ([Vlad Ghinea - eea3876](https://github.com/vghn/vscripts/commit/eea387656e36137f93b84a8437632f5ca1cbe17d))
+  * Update README ([Vlad Ghinea - 90dcf2e](https://github.com/vghn/vscripts/commit/90dcf2eda7640f4705e385e5df0d99abda81ec68))
+  * Add automated semantic versioning task ([Vlad Ghinea - 5b60e02](https://github.com/vghn/vscripts/commit/5b60e02d64588b1b09dfc3b5848e9ea1aada535e))
+
 Version 0.0.3
 ---
   * Fix command line ([Vlad - 78c776a](https://github.com/vghn/vscripts/commit/78c776ab75f4b4469a73fd08d083b43291b20db0))

data/README.md

@@ -52,8 +52,45 @@ can be overridden by adding `[-a|--all]` command line option.
 
     > **EXAMPLES**:
     ```
-$ vscripts tags2facts
-$ vscripts tags2facts --file /tmp/my_tags.json --all
+    $ vscripts tags2facts
+    $ vscripts tags2facts --file /tmp/my_tags.json --all
+    ```
+
+2. **identify**
+  This command creates a themed host name and fully qualified domain name for
+the server, using AWS EC2 tags. The default theme is `Group-Role-#` which means
+that the command collects the value of the `Group` and the `Role` AWS EC2 tags
+(if they are associated with the instance). Additionally, the value of the
+`Domain` tag is also collected so the resulting new host name will be
+`MYGROUP-MYROLE-#.MYDOMAIN`.
+These tags can be any existing EC2 tags. `#` is used as a placeholder for a
+number. This number starts at 1, and, in case other similarly named instances
+exist in the current AWS account, it will be incremented accordingly.
+Once a new host name is composed, both `/etc/hostname` and `/etc/hosts` are
+modified on the local instance and a new `Name` EC2 tag is created and
+associated with the current instance.
+
+    If a ***--host*** argument is provided it will override the default theme.
+    *DOMAIN* is still looked up.
+    If a ***--domain*** argument is provided it will override the default
+    domain.
+
+    > Options:
+    > ```
+    --ec2-tag-theme, -e <s>: Theme (default: Group-Role-#)
+    --host, -n <s>: Host name
+    --domain, -d <s>: Domain
+    --help, -h: Shows help
+    ```
+
+    > EXAMPLES:
+    ```
+    $ vscripts identify
+    MyGroup-MyRole-1.Example.tld
+    $ vscripts identify --ec2-tag-theme NAME-#
+    MyName-1.Example.tld
+    $ vscripts identify --host myhost --domain example.com
+    myhost.example.com
     ```
 
 

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.1.0

data/lib/vscripts/aws/ec2.rb

@@ -12,7 +12,7 @@ module VScripts
 
       # Load AWS SDK for EC2
       def initialize
-        @ec2 ||= ::AWS::EC2.new
+        @ec2 ||= ::AWS::EC2.new(region: region)
       end
 
       # @return [AWS::EC2]
@@ -29,6 +29,16 @@ module VScripts
         instance.tags
       end
 
+      # @return [AWS::EC2::ResourceTagCollection] Tags collection
+      def tag(key)
+        instance.tags[key]
+      end
+
+      # @return [AWS::EC2::Tag] Creates an EC2 Tag
+      def create_tag(resource, key, value)
+        ec2.tags.create(resource, key, value)
+      end
+
       # Get a list of tags
       def tags_without(list = [])
         all = all_tags
@@ -59,9 +69,8 @@ module VScripts
       def similar_instances
         check_instance
         functional_instances.map do |functional_instance|
-          if functional_instance.id != instance_id
-            functional_instance.tags['Name']
-          end
+          next if functional_instance.id == instance_id
+          functional_instance.tags['Name']
         end
       end
     end # class EC2

data/lib/vscripts/aws/metadata.rb

@@ -41,9 +41,8 @@ module VScripts
 
       # Fail if the current instance is not an EC2 instance
       def check_instance
-        unless ec2_instance?
-          abort 'FATAL: NOT an EC2 instance or could not connect to Metadata'
-        end
+        return if ec2_instance?
+        abort 'FATAL: NOT an EC2 instance or could not connect to Metadata'
       end
     end # module Metadata
   end # module AWS

data/lib/vscripts/command.rb

@@ -1,4 +1,5 @@
 require 'vscripts/commands/tags2facts'
+require 'vscripts/commands/identify'
 
 module VScripts
   # Main Command class

data/lib/vscripts/commands/identify.rb

@@ -0,0 +1,169 @@
+require 'trollop'
+require 'vscripts/aws/ec2'
+require 'vscripts/util/local_system'
+
+module VScripts
+  # Commands module
+  module Commands
+    # @ec2 smells of :reek:UncommunicativeVariableName
+
+    # Identify Class
+    class Identify # rubocop:disable ClassLength
+      include VScripts::Util::LocalSystem
+
+      # HELP
+      USAGE = <<-EOS
+This command creates a themed host name and fully qualified domain name for
+the server, using AWS EC2 tags. The default theme is `Group-Role-#` which means
+that the command collects the value of the `Group` and the `Role` AWS EC2 tags
+(if they are associated with the instance). Additionally, the value of the
+`Domain` tag is also collected so the resulting new host name will be
+`MYGROUP-MYROLE-#.MYDOMAIN`.
+These tags can be any existing EC2 tags. `#` is used as a placeholder for a
+number. This number starts at 1, and, in case other similarly named instances
+exist in the current AWS account, it will be incremented accordingly.
+Once a new host name is composed, both `/etc/hostname` and `/etc/hosts` are
+modified on the local instance and a new `Name` EC2 tag is created and
+associated with the current instance.
+
+    If a ***--host*** argument is provided it will override the default theme.
+    *DOMAIN* is still looked up.
+    If a ***--domain*** argument is provided it will override the default
+    domain.
+
+    EXAMPLES:
+    $ vscripts identify
+    MyGroup-MyRole-1.Example.tld
+    $ vscripts identify --ec2-tag-theme NAME-#
+    MyName-1.Example.tld`
+    $ vscripts identify --host myhost --domain example.com
+    myhost.example.com`
+
+    Options:
+      EOS
+
+      # @return [AWS::EC2] EC2 SDK
+      attr_reader :ec2
+      # @return [String] Theme string
+      attr_reader :theme
+      # @return [String] Host name
+      attr_reader :host
+      # @return [String] Domain name
+      attr_reader :domain
+      # @return [Array] Command specific arguments
+      attr_reader :arguments
+
+      def initialize(argv = [])
+        @arguments ||= argv
+        @theme     ||= cli.ec2_tag_theme
+        @host      ||= cli.host
+        @domain    ||= cli.domain
+      end
+
+      # Specifies command line options
+      # This method smells of :reek:TooManyStatements but ignores them
+      def parser
+        Trollop::Parser.new do
+          banner USAGE
+          opt :ec2_tag_theme, 'Theme (default: Group-Role-#)',
+              type: :string, default: 'Group-Role-#', short: '-t'
+          opt :host, 'Host name', type: :string, short: '-n'
+          opt :domain, 'Domain name', type: :string, short: '-d'
+          stop_on_unknown
+        end
+      end
+
+      # Parses command line arguments
+      def cli
+        @cli ||= Trollop.with_standard_exception_handling parser do
+          parser.parse arguments
+        end
+      end
+
+      # Loads AWS::EC2
+      # This method smells of :reek:UncommunicativeMethodName but ignores it
+      def ec2
+        @ec2 ||= VScripts::AWS::EC2.new
+      end
+
+      # @return [Array] Splits theme into elements
+      def theme_elements
+        theme.split('-')
+      end
+
+      # @return [Array] An array of values for each tag specified in the theme
+      def map2tags
+        theme_elements.map do |element|
+          element == '#' ? element : ec2.tag(element)
+        end
+      end
+
+      # @return [String] Compose host name based on found tags
+      def themed_host_name
+        map2tags.compact.join('-')
+      end
+
+      # @return [String] The incremented host name
+      def incremented_hostname
+        number = 1
+        while ec2.similar_instances.include? "#{themed_host_name}.#{domain}"
+          .sub(/#/, "#{number}")
+          number += 1
+        end
+        "#{themed_host_name}".sub(/#/, "#{number}")
+      end
+
+      # @return [String] The command line --host argument or the themed hostname
+      def new_hostname
+        host || incremented_hostname || local_host_name
+      end
+
+      # @return [String] The value of the command line --domain argument, or the
+      #   value of the 'Domain' EC2 tag or the local domain name.
+      def new_domain
+        domain || ec2.tag('Domain') || local_domain_name
+      end
+
+      # @return [String] The fully qualified domain name
+      def new_fqdn
+        "#{new_hostname}.#{new_domain}"
+      end
+
+      # Modify the 'Name' tag
+      def set_name_tag
+        return if ec2.tag('Name') == new_fqdn
+        puts "Setting name tag to \"#{new_fqdn}\"..."
+        ec2.create_tag(ec2.instance, 'Name', value: new_fqdn)
+      end
+
+      # Modify the host name
+      def set_hostname
+        return if File.read(hostname_path).strip == new_hostname
+        puts "Setting local hostname (#{new_hostname})..."
+        write_file(hostname_path, new_hostname)
+        `hostname -F /etc/hostname`
+      end
+
+      # Modify the hosts file
+      def update_hosts
+        return if File.readlines(hosts_path)
+          .grep(/#{new_fqdn} #{new_hostname}/)
+          .any?
+        hosts_body = hosts_file.gsub(
+          /^127\.0\.0\.1.*/,
+          "127\.0\.0\.1 #{new_fqdn} #{new_hostname} localhost"
+        )
+        puts "Adding \"#{new_fqdn}\" to #{hosts_path}..."
+        write_file(hosts_path, hosts_body)
+      end
+
+      # Executes the command
+      def execute
+        set_name_tag
+        set_hostname
+        update_hosts
+        puts 'Done.'
+      end
+    end # class Identify
+  end # module Commands
+end # module VScripts

data/lib/vscripts/commands/tags2facts.rb

@@ -36,7 +36,6 @@ module VScripts
 
       def initialize(argv = [])
         @arguments ||= argv
-        @ec2 ||= VScripts::AWS::EC2.new
       end
 
       # Specifies command line options
@@ -50,6 +49,12 @@ module VScripts
         end
       end
 
+      # Loads AWS EC2
+      # This method smells of :reek:UncommunicativeMethodName but ignores it
+      def ec2
+        @ec2 ||= VScripts::AWS::EC2.new
+      end
+
       # Parses command line arguments
       def cli
         @cli ||= Trollop.with_standard_exception_handling parser do
@@ -62,14 +67,22 @@ module VScripts
         cli.all ? [] : %w(Name Domain)
       end
 
-      # @return [Hash] Tags table
-      def tags_hash
-        ec2.tags_without(exclude_list).to_h
+      # @return [Hash] Filtered tags
+      def filtered_tags
+        ec2.tags_without(exclude_list).each_with_object({}) do |tag, hash|
+          hash[tag[0]] = tag[1]
+          hash
+        end
       end
 
       # @return [JSON] Formatted JSON
       def tags_json
-        JSON.pretty_generate(tags_hash.to_h)
+        tags_hash = filtered_tags
+        if tags_hash.empty?
+          abort 'No tags were found!'
+        else
+          JSON.pretty_generate(tags_hash)
+        end
       end
 
       # Writes the formatted JSON to a file

data/lib/vscripts/util/local_system.rb

@@ -11,6 +11,11 @@ module VScripts
         '/etc/hosts'
       end
 
+      # @return[String] The contents of the hosts file
+      def hosts_file
+        File.read(hosts_path)
+      end
+
       # Hostname file path
       def hostname_path
         '/etc/hostname'
@@ -29,6 +34,8 @@ module VScripts
       # Returns the local domain name
       def local_domain_name
         `dnsdomainname`.strip
+      rescue
+        'local'
       end
 
       # Tries to get the reverse dns

data/spec/vscripts/aws/ec2_spec.rb

@@ -21,6 +21,7 @@ describe VScripts::AWS::EC2 do
     @ec2 = VScripts::AWS::EC2
     @ec2.any_instance.stub(:check_instance) { true }
     @ec2.any_instance.stub(:instance_id) { @inst1.id }
+    @ec2.any_instance.stub(:region) { 'us-east-1' }
   end
 
   describe '#instance' do
@@ -43,6 +44,14 @@ describe VScripts::AWS::EC2 do
     end
   end
 
+  describe '#tag' do
+    it 'returns the tag value' do
+      subject.stub_chain(:instance, :tags) {@tags}
+      expect(subject.tag('Name'))
+        .to eq('test')
+    end
+  end
+
   describe '#tags_without' do
     it 'returns a Hash' do
       expect(subject.tags_without)

data/spec/vscripts/commands/identify_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+require 'vscripts/commands/identify'
+
+describe VScripts::Commands::Identify do
+  before :each do
+    @identify = VScripts::Commands::Identify.new
+    @identify.stub_chain(:ec2, :tag).with('Group') {'TestGroup'}
+    @identify.stub_chain(:ec2, :tag).with('Role') {'TestRole'}
+    @identify.stub_chain(:ec2, :similar_instances) {[
+      'TestGroup-TestRole-1.'
+    ]}
+  end
+
+  describe '#new' do
+    context 'when theme is not passed' do
+      it 'returns the default theme' do
+        expect(@identify.theme).to eq('Group-Role-#')
+      end
+    end
+    context 'when theme is passed' do
+      it 'returns the theme' do
+        @identify = VScripts::Commands::Identify.new(['--ec2-tag-theme=test'])
+        expect(@identify.theme).to eq('test')
+      end
+    end
+    context 'when host is not passed' do
+      it 'host is nil' do
+        expect(@identify.host).to be_nil
+      end
+    end
+    context 'when host is passed' do
+      it 'returns the host' do
+        @identify = VScripts::Commands::Identify.new(['--host=test'])
+        expect(@identify.host).to eq('test')
+      end
+    end
+    context 'when domain is not passed' do
+      it 'domain is nil' do
+        expect(@identify.domain).to be_nil
+      end
+    end
+    context 'when domain is passed' do
+      it 'returns the domain' do
+        @identify = VScripts::Commands::Identify.new(['--domain=test'])
+        expect(@identify.domain).to eq('test')
+      end
+    end
+  end
+
+  describe '#theme_elements' do
+    it 'returns an array' do
+      expect(@identify.theme_elements).to eq(['Group', 'Role', '#'])
+    end
+  end
+
+  describe '#map2tags' do
+    it 'returns an array' do
+      expect(@identify.map2tags).to eq(['TestGroup', 'TestRole', '#'])
+    end
+  end
+
+  describe '#themed_host_name' do
+    it 'returns a string' do
+      expect(@identify.themed_host_name).to eq('TestGroup-TestRole-#')
+    end
+  end
+
+  describe '#incremented_hostname' do
+    it 'returns a string' do
+      expect(@identify.incremented_hostname).to eq('TestGroup-TestRole-2')
+    end
+  end
+
+  describe '#new_hostname' do
+    context 'when host is not passed' do
+      it 'hostname is incremented' do
+        expect(@identify.new_hostname).to eq('TestGroup-TestRole-2')
+      end
+    end
+    context 'when host is passed' do
+      it 'returns a string' do
+        @identify = VScripts::Commands::Identify.new(['--host=test'])
+        expect(@identify.new_hostname).to eq('test')
+      end
+    end
+  end
+
+  describe '#new_domain' do
+    context 'when domain is not passed' do
+      context 'when tag is not present' do
+        it 'returns a String' do
+          @identify.stub_chain(:ec2, :tag).with('Domain') {nil}
+          @identify.stub(:local_domain_name) {'local'}
+          expect(@identify.new_domain).to eq('local')
+        end
+      end
+      context 'when tag is present' do
+        it 'returns a String' do
+          @identify.stub_chain(:ec2, :tag).with('Domain') {'Test'}
+          expect(@identify.new_domain).to eq('Test')
+        end
+      end
+    end
+    context 'when domain is passed' do
+      it 'returns a string' do
+        @identify = VScripts::Commands::Identify.new(['--domain=test'])
+        expect(@identify.new_domain).to eq('test')
+      end
+    end
+  end
+end

data/spec/vscripts/commands/tags2facts_spec.rb

@@ -3,6 +3,7 @@ require 'vscripts/commands/tags2facts'
 describe VScripts::Commands::Tags2facts do
 
   before :each do
+    VScripts::AWS::EC2.any_instance.stub(:region) { 'us-east-1' }
     @tags2facts = VScripts::Commands::Tags2facts.new(['extra_args'])
   end
 
@@ -27,7 +28,7 @@ describe VScripts::Commands::Tags2facts do
 
   describe '#tags_json' do
     it 'returns JSON formatted string' do
-      @tags2facts.stub_chain(:tags_hash, :to_h) {{ key: 'value' }}
+      @tags2facts.stub(:filtered_tags) {{ key: 'value' }}
       expect(@tags2facts.tags_json).to eq("{\n  \"key\": \"value\"\n}")
     end
   end

data/tasks/deploy.rake

@@ -3,9 +3,25 @@ LOG_RANGE      = "master...#{DEV_BRANCH}"
 VERSION_FILE   = 'VERSION'
 CHANGELOG_FILE = 'CHANGELOG.md'
 
-desc 'Automated deployment'
-task :deploy do
-  check_branch
+namespace 'deploy' do
+  desc 'Automated deployment (increment patch)'
+  task :patch do
+    bump_version('patch')
+    deploy
+  end
+  desc 'Automated deployment (increment minor)'
+  task :minor do
+    bump_version('minor')
+    deploy
+  end
+  desc 'Automated deployment (increment major)'
+  task :major do
+    bump_version('major')
+    deploy
+  end
+end
+
+def deploy
   commit_changelog
   merge_changes
   push_release
@@ -21,12 +37,20 @@ def check_branch
   `git fetch`
 end
 
-def bump_version
+def bump_version(type = 'patch')
+  check_branch
   @version = File.read(VERSION_FILE).strip
   @version.gsub(/(\d+)\.(\d+)\.(\d+)/) {
     @major, @minor, @patch = $1.to_i, $2.to_i, $3.to_i
   }
-  @new_version = "#{@major}.#{@minor}.#{@patch + 1}"
+  case type
+  when 'patch'
+    @new_version = "#{@major}.#{@minor}.#{@patch + 1}"
+  when 'minor'
+    @new_version = "#{@major}.#{@minor + 1}.0"
+  when 'major'
+    @new_version = "#{@major + 1}.0.0"
+  end
   File.write('VERSION', @new_version)
 end
 
@@ -43,7 +67,6 @@ def pretty_changes
 end
 
 def update_changelog
-  bump_version
   puts 'Writing new changelog'
   File.write(
     CHANGELOG_FILE,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vscripts
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Vlad Ghinea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -216,6 +216,7 @@ files:
 - lib/vscripts/aws/metadata.rb
 - lib/vscripts/command.rb
 - lib/vscripts/command_line.rb
+- lib/vscripts/commands/identify.rb
 - lib/vscripts/commands/tags2facts.rb
 - lib/vscripts/util/local_system.rb
 - lib/vscripts/version.rb
@@ -225,6 +226,7 @@ files:
 - spec/vscripts/aws_spec.rb
 - spec/vscripts/command_line_spec.rb
 - spec/vscripts/command_spec.rb
+- spec/vscripts/commands/identify_spec.rb
 - spec/vscripts/commands/tags2facts_spec.rb
 - spec/vscripts/util/local_system_spec.rb
 - spec/vscripts/version_spec.rb
@@ -263,6 +265,7 @@ test_files:
 - spec/vscripts/aws_spec.rb
 - spec/vscripts/command_line_spec.rb
 - spec/vscripts/command_spec.rb
+- spec/vscripts/commands/identify_spec.rb
 - spec/vscripts/commands/tags2facts_spec.rb
 - spec/vscripts/util/local_system_spec.rb
 - spec/vscripts/version_spec.rb