hostlist 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99786e75f67e7ee45170151e74536aff51cf468c
+  data.tar.gz: 451b40aa2f6eab1bf4d82ba1b4e29baea2a33fa6
+SHA512:
+  metadata.gz: 65af6d55ceb088b9f4e9b7b73cdf038dee6aac0c7ff099aacd3b84951c79bb87fb849da2a095a555ebc5eb8fcaa3dafa1ade743c053922d823903051fd821726
+  data.tar.gz: aa3bb6bbdf9b441d3f83cf1938aa6b62b0933796e433952370f18f33c7a7b6ca8fdc7e0daa895c4b1c773c47af3861dde2c6815771931ac57dc1771e271a82e6

data/README.md

@@ -0,0 +1,33 @@
+## Description
+
+hostlist is a small script that keeps a text list of hosts with tags and allows you to search that list. The purpose of this script is to facilitate other scripts. For example, if you have a script that needs the hostnames of only production weblogic servers, you would query hostlist first and then loop through the output.
+
+## Configuration
+
+All FQDNs are entered into the configuration file. This file is in YAML format and uses brace expansion very similar to how BASH does brace expansion. A list of values would be comma separated (eg: proxy{1,2} expands to proxy1, proxy2). A range is represented with two periods (eg: proxy{1..3} expands to proxy1, proxy2, proxy3).
+
+The default location for the configuration file is /etc/hostlist.yaml
+
+```yaml
+'extpxy00{1..4}.example.com':
+  tags: [ 'prd', 'pxy', 'extpxy']
+'extpxy00{1,2}.pre.example.com':
+  tags: [ 'pre', 'pxy', 'extpxy']
+'intpxy00{1,2}.example.com':
+  tags: [ 'prd', 'pxy', 'intpxy']
+```
+
+## Listing Hosts
+
+You can list hosts by running hostlist with a list of tags you want to filter with. You can use any number of tags separated by a space. Using the above sample configuration, running "hostlist prd extpxy" would yield:
+
+```
+extpxy001.example.com
+extpxy002.example.com
+extpxy003.example.com
+extpxy004.example.com
+```
+
+## Showing Tags
+
+If you want to see a list of all the tags in the cached database, you can run "hostlist show". This list is not sorted in any way.

data/Rakefile

@@ -0,0 +1,24 @@
+task :default => [:build]
+task :test => [:build, :install]
+
+task :build do
+  system("gem build ./hostlist.gemspec")
+end
+
+task :install do
+  gem = Dir['*.gem'].last
+  system("sudo gem install #{gem}")
+end
+
+task :push do
+  gem = Dir['*.gem'].last
+  system("gem push #{gem}")
+end
+
+task :console do
+  exec "irb -I ./lib"
+end
+
+task :run do
+  ruby "-Ilib", 'bin/hostlist'
+end

data/bin/hostlist

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'hostlist/thor'
+
+HostListThor.start(ARGV)

data/hostlist.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |gem|
+  gem.name        = 'hostlist'
+  gem.version     = '1.0.0'
+  gem.licenses    = ['MIT']
+  gem.date        = '2015-06-27'
+  gem.summary     = 'Host List Generator'
+  gem.description = 'Generates list of hosts based on tags.'
+  gem.authors     = ['Zan Loy']
+  gem.email       = ['zan.loy@gmail.com']
+  gem.homepage    = 'https://github.com/zanloy/hostlist'
+  gem.files       = `git ls-files`.split("\n") - %w[.gitignore]
+  gem.executables = ['hostlist']
+
+  gem.add_runtime_dependency 'bracecomp', '~> 0.1', '>= 0.1.2'
+  gem.add_runtime_dependency 'daybreak', '~> 0.3', '>= 0.3.0'
+  gem.add_runtime_dependency 'thor', '~> 0.19', '>= 0.19.1'
+end

data/hostlist.yaml.sample

@@ -0,0 +1,24 @@
+'extpxy001.prd.vbms.vba.va.gov':
+  tags: [ 'prd', 'pxy', 'extpxy']
+'extpxy002.prd.vbms.vba.va.gov':
+  tags: [ 'prd', 'pxy', 'extpxy']
+'extpxy003.prd.vbms.vba.va.gov':
+  tags: [ 'prd', 'pxy', 'extpxy']
+'extpxy004.prd.vbms.vba.va.gov':
+  tags: [ 'prd', 'pxy', 'extpxy']
+'vbms000.prd.vbms.vba.va.gov':
+  tags: [ 'prd', 'weblogic', 'vbms' ]
+'vbms001.prd.vbms.vba.va.gov':
+  tags: [ 'prd', 'weblogic', 'vbms' ]
+'extpxy001.pre.vbms.vba.va.gov':
+  tags: [ 'pre', 'pxy', 'extpxy']
+'extpxy002.pre.vbms.vba.va.gov':
+  tags: [ 'pre', 'pxy', 'extpxy']
+'extpxy001.prdtst.vbms.vba.va.gov':
+  tags: [ 'prdtst', 'pxy', 'extpxy']
+'extpxy002.prdtst.vbms.vba.va.gov':
+  tags: [ 'prdtst', 'pxy', 'extpxy']
+'extpxy001.perf.vbms.vba.va.gov':
+  tags: [ 'perf', 'pxy', 'extpxy']
+'extpxy002.perf.vbms.vba.va.gov':
+  tags: [ 'perf', 'pxy', 'extpxy']

data/lib/hostlist/thor.rb

@@ -0,0 +1,34 @@
+require 'hostlist'
+require 'thor'
+
+class HostListThor < Thor
+
+  default_task :list
+
+  class_option :yaml, type: :string, default: '/etc/hostlist.yaml'
+  class_option :db, type: :string, default: '~/.hostlist.db'
+
+  def method_missing(method, *args)
+    args = ['list', method.to_s] + args
+    HostListThor.start(args)
+  end
+
+  desc 'list', 'List hosts based on a tag.'
+  def list(*tags)
+    hostlist = HostList.new(yaml: options[:yaml], cache: options[:db])
+    hostlist.list(tags).each { |host| puts host }
+  end
+
+  desc 'Show tags', 'Show all the tags in the cache database.'
+  def show
+    hostlist = HostList.new(yaml: options[:yaml], cache: options[:db])
+    hostlist.keys.each { |key| puts key }
+  end
+
+  desc 'print_db', 'Print the contents of the database for debugging purposes'
+  def print_db
+    hostlist = HostList.new(yaml: options[:yaml], cache: options[:db])
+    hostlist.print_db
+  end
+
+end

data/lib/hostlist.rb

@@ -0,0 +1,93 @@
+require 'bracecomp'
+require 'daybreak'
+require 'digest'
+require 'yaml'
+
+class HostList
+
+  def initialize(yaml: '/etc/hostlist.yaml', cache: '~/.hostlist.db')
+    @yaml = yaml
+    @db_filename = cache
+  end
+
+  def list(tags)
+    tags = [tags] if tags.is_a? String
+    # Verify we have the most recent data in our daybreak cache.
+    db = open_db
+    begin
+      if db.has_key? :md5
+        file_md5 = Digest::MD5.file @yaml
+        generate_db(db) unless file_md5 == db[:md5]
+      else
+        generate_db(db)
+      end
+      db.load
+      # Collect all the tags from the database
+      hosts = []
+      if tags.empty?
+        hosts = db[:all]
+      else
+        tags.each do |tag|
+          if db.has_key? tag
+            if hosts == []
+              hosts = db[tag]
+            else
+              hosts = hosts & db[tag]
+            end
+          end
+        end
+      end
+    ensure
+      db.close
+    end
+    return hosts
+  end
+
+  # Return all the keys in the database.
+  def keys
+    db = open_db
+    begin
+      keys = db.keys
+    ensure
+      db.close
+    end
+    return keys
+  end
+
+  # Print the contents of the database for debugging purposes
+  def print_db
+    db = open_db
+    begin
+      db.keys.each do |key|
+        puts "db[#{key}] = #{db[key]}"
+      end
+    ensure
+      db.close
+    end
+  end
+
+  def open_db
+    Daybreak::DB.new File.expand_path(@db_filename)
+  end
+
+  def generate_db(db)
+    db.clear
+    db[:all] = []
+    hosts = YAML.load_file(@yaml)
+    hosts.each do |key, value|
+      value['tags'].each do |tag|
+        if db.has_key? tag
+          db[tag] += key.expand
+        else
+          db[tag] = key.expand
+        end
+      end
+      # Add servers to :all
+      # TODO: Figure out why this isn't working. db[:all] is always an empty array.
+      key.expand.each { |host| db[:all] += [host] unless db[:all].include?(host) }
+    end
+    db[:md5] = Digest::MD5.file(@yaml).to_s
+    db.flush
+  end
+
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: hostlist
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Zan Loy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bracecomp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: daybreak
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+description: Generates list of hosts based on tags.
+email:
+- zan.loy@gmail.com
+executables:
+- hostlist
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/hostlist
+- hostlist.gemspec
+- hostlist.yaml.sample
+- lib/hostlist.rb
+- lib/hostlist/thor.rb
+homepage: https://github.com/zanloy/hostlist
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Host List Generator
+test_files: []