collins-cli 0.2.10 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 209c04a6091f4804bef7e1a5cbf1ca726579b1c4
-  data.tar.gz: c40f7f6f63a8ea3115d3418396daf0d254d5cdb2
+  metadata.gz: 56d5918ebb4b33429b6e2c77fe3d595b4acc7f99
+  data.tar.gz: 10596f7ab67031db7aef1c00bd837ded1880bd3a
 SHA512:
-  metadata.gz: 182660aa823a21025f765a3557b09f99956861ef694ea61b34f16a2ea444d5de0114a3272749792b38e5e1c43942a4de2a6ed7a9c1c380bffc041b9346bf34ff
-  data.tar.gz: 973bfc0938c23efb85f88013ccf488c913a9271f32a8aa8ba58cccf02bb510273994cc92c16c22144389229538535bdd641ca37cabde54577aa5de0a55c28f82
+  metadata.gz: d0a907787655318e1e5c1258eb6c3a8781b0eea602f86dd16589d58116c4afaf8be0728d6e912398a68db76b0d684f8c13c278f503f91f222b9ebc36086d05b6
+  data.tar.gz: 62fa500c7bb7379741f6e099f052418e20b0b8564c30c710598d5d2ed669c15c44261071c99251b31344ae1fd88227a8890ab11949fb4d11460388a98f436321

data/README.md

@@ -229,21 +229,51 @@ Allocate and delete addresses, and show what address pools are configured in Col
 
 List statuses and states. TODO: implement state creation, deleting, modification
 
-Usage: collins state [options]
-    -l, --list                       List states.
-    -h, --help                       Help
+    Usage: collins state [options]
+        -l, --list                       List states.
+        -h, --help                       Help
+    
+    Table formatting:
+        -H, --show-header                Show header fields in output
+        -f, --field-separator SEPARATOR  Separator between columns in output (Default: 	)
+    
+    Extra options:
+            --timeout SECONDS            Timeout in seconds (0 == forever)
+        -C, --config CONFIG              Use specific Collins config yaml for Collins::Client
+    
+    Examples:
+      Show states and statuses:
+        collins state --list
 
-Table formatting:
-    -H, --show-header                Show header fields in output
-    -f, --field-separator SEPARATOR  Separator between columns in output (Default: 	)
+## Datacenter configurations - collins dc
 
-Extra options:
-        --timeout SECONDS            Timeout in seconds (0 == forever)
-    -C, --config CONFIG              Use specific Collins config yaml for Collins::Client
+Create and manage multiple Collins configurations. This utility allows you to keep multiple collins configuration files in your home directory, one for each collins site/datacenter/instance in your organization. This utility lets you easily set up new collins configurations, switch between them, and list all your configured datacenters.
 
-Examples:
-  Show states and statuses:
-    collins state --list
+    Usage: collins dc [options]
+    
+    New Configuration:
+        -n, --new DATACENTER             Create a new configuration file for DATACENTER at ~/.collins.yml.DATACENTER
+        -H, --host URI                   Use URI for host when setting up new datacenter
+        -u, --username USER              Use USER for username when setting up new datacenter
+        -p, --password PASSWORD          Use PASSWORD for password when setting up new datacenter
+    
+    List:
+        -l, --list                       List configured collins instances
+    
+    General:
+        -h, --help                       Help
+    
+    Examples:
+      Show current Collins instance in use
+        collins dc
+      Set current Collins instance to jfk01
+        collins dc jfk01
+      List all Collins instances configured
+        collins dc -l
+      Set up new Collins instance for sfo01
+        collins dc --new sfo01 --host https://collins.sfo01.company.net
+      Iterate over all instances and find assets
+        for dc in $(collins dc -l) ; do collins dc $dc ; collins find -p DEVELOPMENT ; done
 
 ## TODO
 

data/bin/collins

@@ -2,17 +2,19 @@
 require 'collins-cli'
 
 ALLOWED_ACTIONS = {
-  Collins::CLI::Find => ['query','find'],
-  Collins::CLI::Modify => ['modify','set'],
-  Collins::CLI::Log => ['log'],
+  Collins::CLI::Find      => ['query','find'],
+  Collins::CLI::Modify    => ['modify','set'],
+  Collins::CLI::Log       => ['log'],
   Collins::CLI::Provision => ['provision'],
-  Collins::CLI::Power => ['power'],
-  Collins::CLI::IPAM => ['ipam','address','ipaddress'],
-  Collins::CLI::State => ['state','status'],
+  Collins::CLI::Power     => ['power'],
+  Collins::CLI::IPAM      => ['ipam','address','ipaddress'],
+  Collins::CLI::State     => ['state','status'],
+  Collins::CLI::DC        => ['dc','datacenter'],
 }
 
 HELP_MESSAGE = "Usage: #{File.basename(File.realpath($0))} <command> [options]
 Available commands:
+  dc, datacenter:            Manage multiple Collins configurations
   query, find:               Search for assets in Collins
   modify, set:               Add and remove attributes, change statuses, and log to assets
   log:                       Display log messages on assets

data/lib/collins-cli.rb

@@ -6,7 +6,7 @@ require 'json'
 require 'optparse'
 require 'colorize'
 
-['mixins','formatter','log','modify','find','power','provision','ipam','state'].
+['mixins','formatter','log','modify','find','power','provision','ipam','state','dc'].
   each {|r| require File.join('collins/cli',r) }
 
 module Collins ; module CLI ; end ; end

data/lib/collins/cli/dc.rb

@@ -0,0 +1,197 @@
+require 'collins-cli'
+require 'fileutils'
+require 'optparse/uri'
+require 'etc'
+require 'io/console'
+
+module Collins::CLI
+  class DC
+    include Mixins
+    include Formatter
+    PROG_NAME = 'collins dc'
+    DEFAULT_CONFIG_PATH = '~/.collins.yml'
+
+    DEFAULT_OPTIONS = {
+      :show_current => true, # used for :list
+      :mode         => :show,
+      :dc           => nil, # used for :set
+      :timeout      => 120, # used for :new
+      :host         => nil, # used for :new
+      :pw           => nil, # used for :new
+      :user         => nil, # used for :new
+    }
+
+    attr_reader :options, :parser
+
+    def initialize
+      @options = DEFAULT_OPTIONS.clone
+      @parsed, @validated = false, false
+      @parser = nil
+    end
+
+    def parse!(argv = ARGV)
+      @parser = OptionParser.new do |opts|
+        opts.banner = "Usage: #{PROG_NAME} [options]"
+        opts.separator ""
+        opts.separator "New Configuration:"
+        opts.on('-n', '--new DATACENTER', String, "Create a new configuration file for DATACENTER at #{DEFAULT_CONFIG_PATH}.DATACENTER") {|v| @options[:dc] = v ; @options[:mode] = :new}
+        opts.on('-H', '--host URI', URI, 'Use URI for host when setting up new datacenter') {|v| @options[:host] = v}
+        opts.on('-u', '--username USER', String, 'Use USER for username when setting up new datacenter') {|v| @options[:user] = v}
+        opts.on('-p', '--password PASSWORD', String, 'Use PASSWORD for password when setting up new datacenter') {|v| @options[:pw] = v}
+
+        opts.separator ""
+        opts.separator "List:"
+        opts.on('-l', '--list', 'List configured collins instances') {|v| @options[:mode] = :list}
+
+        opts.separator ""
+        opts.separator "General:"
+        opts.on('-h','--help',"Help") {@options[:mode] = :help}
+
+        opts.separator ""
+        opts.separator "Examples:"
+        opts.separator "  Show current Collins instance in use"
+        opts.separator "    #{PROG_NAME}"
+        opts.separator "  Set current Collins instance to jfk01"
+        opts.separator "    #{PROG_NAME} jfk01"
+        opts.separator "  List all Collins instances configured"
+        opts.separator "    #{PROG_NAME} -l"
+        opts.separator "  Set up new Collins instance for sfo01"
+        opts.separator "    #{PROG_NAME} --new sfo01 --host https://collins.sfo01.company.net"
+        opts.separator "  Iterate over all instances and find assets"
+        opts.separator "    for dc in $(#{PROG_NAME} -l) ; do #{PROG_NAME} $dc ; collins find -p DEVELOPMENT ; done"
+      end
+      @parser.parse!(argv)
+      #TODO(gabe): if user not specified, read from env or something
+
+      # if mode is :show (default), and an argument was provided in argv, set mode to :set
+      if @options[:mode] == :show && argv.length > 0
+        @options[:mode] = :set
+        @options[:dc] = argv.first
+      end
+
+      @parsed = true
+      self
+    end
+
+    def validate!
+      raise "You need to tell me to do something!" if @options[:mode].nil?
+      raise "No asset tags found via ARGF" if [:allocate,:delete].include?(options[:mode]) && (options[:tags].nil? or options[:tags].empty?)
+      @validated = true
+      self
+    end
+
+    def run!
+      raise "Options not yet parsed with #parse!" unless @parsed
+      raise "Options not yet validated with #validate!" unless @validated
+      success = true
+      case options[:mode]
+      when :help
+        puts parser
+      when :show
+        puts default_datacenter
+      when :set
+        dc = @options[:dc]
+        if !configured_datacenters.include?(dc)
+          raise "No Collins configuration for datacenter #{dc.inspect} found. Perhaps you want to create it with '#{PROG_NAME} --new #{dc}'?"
+        end
+        set_default_datacenter(dc)
+      when :list
+        dcs = configured_datacenters
+        default = default_datacenter
+        dcs.each do |dc|
+          if dc == default && @options[:show_current]
+            puts "#{dc} *"
+          else
+            puts dc
+          end
+        end
+      when :new
+        # check if dc already exists
+        dc = @options[:dc]
+        if configured_datacenters.include? dc
+          raise "Unable to create new configuration for #{dc}: Configuration already exists at #{DEFAULT_CONFIG_PATH}.#{@options[:dc]}"
+        end
+
+        uri = @options[:host]
+        if uri.nil?
+          print "Enter Collins URI for #{dc} (i.e. https://collins.#{dc}.company.net): "
+          x = gets
+          uri = URI.parse(x.strip)
+        end
+
+        user = @options[:user]
+        if user.nil?
+          default = Etc.getlogin
+          print "Enter username (default: #{default}): "
+          x = gets.strip
+          if x.empty?
+            user = default
+          else
+            user = x
+          end
+        end
+
+        pw = @options[:pw]
+        if pw.nil?
+          print "Enter password: "
+          pw = STDIN.noecho(&:gets).chomp
+          print "\n"
+        end
+        create_new_datacenter(dc, uri, user, pw, @options[:timeout])
+
+        # if this is the only DC, use it
+        has_default_dc = File.symlink?(File.expand_path(DEFAULT_CONFIG_PATH)) rescue false
+        if !has_default_dc
+          set_default_datacenter(dc)
+          puts "Automatically selected #{dc.inspect} as the current datacenter with '#{PROG_NAME} #{dc}'"
+        else
+          puts "Now, select the Collins instance #{dc.inspect} with '#{PROG_NAME} #{dc}' to access Collins"
+        end
+      end
+      success
+    end
+
+    def configured_datacenters
+      # return list of dc names, followed by an asterisk if default?
+      files = Dir.glob(File.expand_path(DEFAULT_CONFIG_PATH + ".*"))
+      files.map do |f|
+        File.basename(f).split('.').last
+      end.sort
+    end
+
+    def set_default_datacenter dc
+      ln = File.expand_path(DEFAULT_CONFIG_PATH)
+      if File.exist?(ln) && !File.symlink?(ln)
+        raise "Unable to set config to use #{dc}: #{ln} is not a symlink, which means #{PROG_NAME.inspect} is not managing this configuration"
+      end
+      FileUtils.ln_sf(File.expand_path("~/.collins.yml.#{dc}"), File.expand_path(DEFAULT_CONFIG_PATH))
+    end
+
+    def default_datacenter
+      def_cfg = File.expand_path(DEFAULT_CONFIG_PATH)
+      if !File.symlink?(def_cfg)
+        raise "Unable to determine default Collins datacenter: #{def_cfg} is not a symlink, which means #{PROG_NAME.inspect} is not managing this configuration"
+      end
+      target = File.basename(File.readlink(def_cfg))
+      if target =~ /^\.collins\.yml\.([A-Za-z0-9\-_]+)$/
+        return $1
+      else
+        raise "Unable to determine datacenter from target config #{target}; does not match .collins.yml.$DATACENTER"
+      end
+    end
+
+    def create_new_datacenter dc, uri, user, pw, t
+      o = {
+        host: uri.to_s,
+        username: user,
+        timeout: t
+      }
+      o[:password] = pw unless pw.nil? || pw.empty?
+      File.open(File.expand_path("#{DEFAULT_CONFIG_PATH}.#{dc}"), 'w', 0600) do |f|
+        f.puts o.to_yaml
+      end
+    end
+
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collins-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.11
 platform: ruby
 authors:
 - Gabe Conradi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-17 00:00:00.000000000 Z
+date: 2017-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -92,6 +92,7 @@ files:
 - README.md
 - bin/collins
 - lib/collins-cli.rb
+- lib/collins/cli/dc.rb
 - lib/collins/cli/find.rb
 - lib/collins/cli/formatter.rb
 - lib/collins/cli/ipam.rb
@@ -127,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: CLI utilities to interact with the Collins API