netscaler-cli 0.3.3 → 0.4.0

data/lib/netscaler/extensions.rb

@@ -0,0 +1,47 @@
+
+# Alter the standard Array class
+class Array
+  def to_s
+    base = ""
+    each do |e|
+      base << e.to_s
+      base << "\n"
+    end
+    base
+  end
+
+  def to_json(prefix=nil)
+    value = if prefix
+              prefix.dup
+            else
+              ""
+            end
+    if empty?
+      return value << "[]"
+    end
+
+    indent = if prefix
+               "  " << prefix
+             else
+               "  "
+             end
+
+    value << "[\n"
+    
+    each_with_index do |e, i|
+      value << indent
+      value << e.to_json(indent)
+      value << ",\n" unless i == length - 1
+    end
+
+    value << "\n"
+    value << prefix if prefix
+    value << "]\n"
+  end
+end
+
+class String
+  def to_json(prefix=nil)
+    "\"#{self}\""
+  end
+end

data/lib/netscaler/server/request.rb

@@ -0,0 +1,35 @@
+require 'netscaler/base_request'
+require 'netscaler/server/response'
+
+module Netscaler::Server
+  class Request < Netscaler::BaseRequest
+    def enable(server, options)
+      send_request('enableserver', {:name => server})
+    end
+
+    def disable(server, options)
+      send_request('disableserver', {:name => server})
+    end
+
+    def list(server, options)
+      responses = []
+      send_request('getserver', {:empty => :ok}) do |response|
+        response_part(response).each_with_index do |server, i|
+          responses << Response.new(server)
+        end
+      end      
+      yield responses if block_given?
+    end
+
+    def status(server, options)
+      send_request('getserver', {:name => server }) do |response|
+        yield Response.new(response_part(response)) if block_given?
+      end
+    end
+
+    private
+    def response_part(response)
+      response[:return][:list][:item]
+    end
+  end
+end

data/lib/netscaler/server/response.rb

@@ -0,0 +1,67 @@
+module Netscaler::Server
+  class Response
+    FORMAT = "%-30s %15s %10s"
+
+    attr_reader :info
+
+    def initialize(raw_response)
+      @info = raw_response
+    end
+
+    def name
+      info[:name]
+    end
+
+    def ip_address
+      info[:ipaddress]
+    end
+
+    def state
+      info[:state]
+    end
+
+    def header
+      line = sprintf FORMAT, 'Name', 'IP Address', 'State'
+      eqls = '=' * line.length
+      line + "\n" + eqls
+    end
+
+    def services
+      if info[:servicename]
+        res = info[:servicename][:item]
+        if !res.is_a?(Array)
+          [res]
+        else
+          res
+        end
+      else
+        []
+      end
+    end
+
+    def to_s
+      base = sprintf FORMAT, name, ip_address, state
+      if !services.empty?
+        base << "\n"
+        services.each do |s|
+          base << "| service:  #{s}\n"
+        end
+      end
+      base
+    end
+
+    def to_json(prefix=nil)
+      indent = if prefix
+                 prefix + "  "
+               else
+                 "  "
+               end
+      base = "{\n#{indent}'name': '#{name}',\n#{indent}'ip_address': '#{ip_address}',\n#{indent}'state': '#{state}'"
+      if !services.empty?
+        base << ",\n#{indent}'services':\n#{services.to_json(indent)}"
+      end
+      base.chomp!
+      base << "\n#{prefix}}"
+    end
+  end
+end

data/lib/netscaler/service/request.rb

@@ -0,0 +1,42 @@
+require 'netscaler/base_request'
+require 'netscaler/service/response'
+
+module Netscaler::Service
+  class Request < Netscaler::BaseRequest
+    def enable(service, options)
+      params = { :name => service }
+      send_request('enableservice', params)
+    end
+
+    def disable(service, options)
+      params = { 
+        :name => service, 
+        :delay => 0 
+      }
+      send_request('disableservice', params)
+    end
+
+    def bind(service, options)
+      params = {
+        :name => options[:vserver],
+        :servicename => service
+      }
+      send_request('bindlbvserver_service', params)
+    end
+
+    def unbind(service, options)
+      params = {
+        :name => options[:vserver],
+        :servicename => service
+      }
+      send_request('unbindlbvserver_service', params)
+    end
+
+    def status(service, options)
+      params = { :name => service }
+      send_request('getservice', params) do |response|
+        yield Response.new(response) if block_given?
+      end
+    end
+  end
+end

data/lib/netscaler/service/response.rb

@@ -0,0 +1,44 @@
+module Netscaler::Service
+  class Response
+    FORMAT = "%-30s %15s %10s %10s"
+
+    def initialize(raw_response)
+      @info = raw_response[:return][:list][:item]
+    end
+
+    def name
+      @info[:name]
+    end
+
+    def ip_address
+      @info[:ipaddress]
+    end
+
+    def state
+      @info[:svrstate]
+    end
+
+    def port
+      @info[:port]
+    end
+
+    def header
+      line = sprintf FORMAT, 'Name', 'IP Address', 'State', 'Port'
+      eqls = '=' * line.length
+      line + "\n" + eqls
+    end
+    
+    def to_s
+      sprintf FORMAT, name, ip_address, state, port
+    end
+
+    def to_json(prefix=nil)
+      indent = if prefix
+                 '  ' + prefix
+               else
+                 '  '
+               end
+      "{\n#{indent}'name': '#{name}',\n#{indent}'ip_address': '#{ip_address}',\n#{indent}'state': '#{state}',\n#{indent}'port': #{port}\n#{prefix}}"
+    end
+  end
+end

data/lib/netscaler/vserver/request.rb

@@ -0,0 +1,67 @@
+require 'netscaler/logging'
+require 'netscaler/base_request'
+require 'netscaler/vserver/response'
+
+module Netscaler::VServer
+  class Request < Netscaler::BaseRequest
+    include Netscaler::Logging
+
+    def enable(vserver, options)
+      params = { :name => vserver }
+      send_request('enablelbvserver', params)
+    end
+
+    def disable(vserver, options)
+      params = { :name => vserver }
+      send_request('disablelbvserver', params)
+    end
+
+    def list(vserver, options)
+      vservers = []
+      send_request('getlbvserver', {:empty => :ok}) do |response|
+        response[:return][:list][:item].each do |vserver|
+          vservers << Response.new(vserver)
+        end
+      end
+      yield vservers if block_given?
+    end
+
+    def status(vserver, options)
+      params = { :name => vserver }
+      send_request('getlbvserver', params) do |response|
+        yield Response.new(response) if block_given?
+      end
+    end
+
+    def bind(vserver, options)
+      params = { 
+        :name => vserver,
+        :policyname => options[:policy],
+        :priority => options[:Priority],
+        :gotopriorityexpression => 'END' 
+      }
+
+      method = if options[:netscaler].version == "9.2"
+                 'bindlbvserver'
+               else
+                 'bindlbvserver_policy'
+               end
+      send_request(method, params)
+    end
+
+    def unbind(vserver, options)
+      params = {
+        :name => vserver,
+        :policyname => options[:policy], 
+        :type => 'REQUEST'
+      }
+
+      method = if options[:netscaler].version == "9.2"
+                 'unbindlbvserver'
+               else
+                 'unbindlbvserver_policy'
+               end
+      send_request(method, params)
+    end
+  end
+end

data/lib/netscaler/vserver/response.rb

@@ -0,0 +1,125 @@
+
+module Netscaler::VServer
+  class Response
+    FORMAT = "%-47s %15s %15s %10s %10s"
+
+    attr_reader :info
+
+    def initialize(raw_response)
+      @info = if raw_response[:return]
+                raw_response[:return][:list][:item]
+              else
+                raw_response
+              end
+    end
+
+    def name
+      info[:name]
+    end
+
+    def ip_address
+      if info[:ipaddress] =~ /0\.0\.0\.0/
+        info[:ipaddress2]
+      else
+        info[:ipaddress]
+      end
+    end
+
+    def type
+      info[:servicetype]
+    end
+
+    def port
+      info[:port]
+    end
+
+    def state
+      info[:state]
+    end
+
+    def header
+      line = sprintf FORMAT, 'Name', 'IP Address', 'State', 'Port', 'Type'
+      eqls = '=' * line.length
+      line + "\n" + eqls
+    end
+
+    def servers
+      @parsed_servers ||= []
+      if !@parsed_servers.empty? || info[:servicename].nil?
+        return @parsed_servers
+      end
+
+      if info[:servicename][:item].is_a?(String)
+        @parsed_servers << ServerInfo.new(info, nil)
+      else
+        info[:servicename][:item].each_with_index do |name, i|
+          @parsed_servers << ServerInfo.new(info, i)
+        end
+      end
+
+      @parsed_servers
+    end
+
+    def to_s
+      base = sprintf FORMAT, name, ip_address, state, port, type
+
+      if !servers.empty?
+        base << "\n"
+        servers.each do |server|
+          base << "|> server: #{server}\n"
+        end
+      end
+
+      base
+    end
+
+    def to_json(prefix=nil)
+      indent = if prefix
+                 '  ' + prefix
+               else
+                 '  '
+               end
+      base = "{\n#{indent}'name': '#{name}',\n#{indent}'ip_address': '#{ip_address}',\n#{indent}'state': '#{state}',\n#{indent}'port': #{port},\n#{indent}'type': '#{type}'"
+
+      if !servers.empty?
+        base << ",\n#{indent}'servers':\n#{servers.to_json(indent)}"
+      end
+
+      base << "\n#{prefix}}"
+      base
+    end
+  end
+
+  class ServerInfo
+    attr_accessor :name, :ip_address, :state, :port, :type
+
+    def initialize(raw_response, index)
+      @name = raw_response[:servicename][:item]
+      @ip_address = raw_response[:svcipaddress][:item]
+      @state = raw_response[:svcstate][:item]
+      @port = raw_response[:svcport][:item]
+      @type = raw_response[:svctype][:item]
+
+      if !index.nil?
+        @name = @name[i]
+        @ip_address = @ip_address[i]
+        @state = @state[i]
+        @port = @port[i]
+        @type = @type[i]
+      end
+    end
+
+    def to_s
+      sprintf "%-26s  %15s %18s %10s %10s", name, ip_address, state, port, type
+    end
+
+    def to_json(prefix=nil)
+      indent = if prefix
+                 '  ' + prefix
+               else
+                 '  '
+               end
+      "{\n#{indent}'name': '#{'here' + name}',\n#{indent}'ip_address': '#{ip_address}',\n#{indent}'state': '#{state}',\n#{indent}'port': #{port},\n#{indent}'type': '#{type}'\n#{prefix}}"
+    end
+  end
+end

data/spec/netscaler/cli_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helpers'
+require 'netscaler/cli'
+
+module Netscaler
+  
+  module CLIHelper
+    def parse(*args)
+      args << '-c'
+      args << File.join(File.dirname(__FILE__), 'configs', 'simple-config.yml')
+      cli = CLI.new(args)
+      cli.parse!(true)
+    end
+  end
+
+  describe CLI do
+    include CLIHelper
+
+    it "should fail when the netscaler alias doesn't exist" do
+      attempting {
+        parse('-n', 'asdf', 'server', '--action', 'list')
+      }.should raise_error(Netscaler::ConfigurationError, /host was not found/)
+    end
+
+    it "should be able to set the netscaler configuration correctly" do
+      res = parse('-n', 'else', 'server', '--action', 'list')
+      res.options[:netscaler].password.should eql('blah')
+    end
+
+    it "should set the json flag correctly" do
+      res = parse('-n', 'else', 'server', '--action', 'list', '--json')
+      res.options[:json].should be(true)
+    end
+
+    it "should set the debug flag correctly" do
+      res = parse('-n', 'else', 'server', '-a', 'list', '--debug')
+      res.options[:debug].should be(true)
+    end
+
+    describe "for servers" do
+      it "should fail when the server is not given to a non-list action" do
+        attempting {
+          parse('-n', 'else', 'server', '-a', 'status')
+        }.should raise_error(Choosy::ValidationError, /no server given/)
+      end
+
+      it "should succeed when given the list action with no arguments" do
+        res = parse('-n', 'else', 'server', '-a', 'list')
+        res.subresults[0][:action].should eql(:list)
+      end
+
+      it "should have the server argument on a non-list action" do
+        res = parse('-n', 'else', 'server', '-a', 'status', 'blarg')
+        res.subresults[0].args[0].should eql('blarg')
+        res.subresults[0][:action].should eql(:status)
+      end
+    end
+
+    describe "for services" do
+      it "should fail when the service is given to a non-list action" do
+        attempting {
+          parse('-n', 'else', 'service', '-a', 'disable')
+        }.should raise_error(Choosy::ValidationError, /no services given to act/)
+      end
+      
+      it "should fail when --vserver flag is used with a non-bind/unbind action" do
+        attempting {
+          parse('-n', 'else', 'service', '-a', 'disable', '-v', 'blarg', 'a-service')
+        }.should raise_error(Choosy::ValidationError, /only used with bind/)
+      end
+
+      it "should fail when the --vserver flag is not present with the bind/unbind action" do
+        attempting {
+          parse('-n', 'else', 'service', '-a', 'bind', 'a-service')
+        }.should raise_error(Choosy::ValidationError, /requires the -v\/--vserver flag/)
+      end
+
+      it "should succeed in setting the service name as an argument" do
+        res = parse('-n', 'else', 'service', '-a', 'bind', '-v', 'blah', 'a-service')
+        res.subresults[0].args[0].should eql('a-service')
+      end
+
+      it "should succed in setting the vserver name" do
+        res = parse('-n', 'else', 'service', '-a', 'bind', '-v', 'blah', 'a-service')
+        res.subresults[0][:vserver].should eql('blah')
+      end
+
+      it "should succeed in setting the action" do
+        res = parse('-n', 'else', 'service', '-a', 'bind', '-v', 'blah', 'a-service')
+        res.subresults[0][:action].should eql(:bind)
+      end
+
+      it "should set the default action to status" do
+        res = parse('-n', 'else', 'service', 'a-service')
+        res.subresults[0][:action].should eql(:status)
+      end
+    end
+
+    describe "for vserver" do
+      it "should fail when the vserver is given to a non-list option" do
+        attempting {
+          parse('-n', 'else', 'vserver', '-a', 'disable')
+        }.should raise_error(Choosy::ValidationError, /no virtual server/)
+      end
+
+      it "should fail when the --policy flag is unset on a bind/unbind" do
+        attempting {
+          parse('-n', 'else', 'vserver', '-a', 'bind', 'vserv')
+        }.should raise_error(Choosy::ValidationError, /required by the 'bind\/unbind' actions/)
+      end
+
+      it "should fail when the --policy flag is used on anything other than bind/unbind" do
+        attempting {
+          parse('-n', 'else', 'vserver', '-a', 'disable', '-p', 'pol', 'vserv')
+        }.should raise_error(Choosy::ValidationError, /only used with bind/)
+      end
+
+      it "should fail when priority flag is used on anything other than a bind" do
+        attempting {
+          parse('-n', 'else', 'vserver', '-a', 'disable', '-P', '20', 'vserv')
+        }.should raise_error(Choosy::ValidationError, /only used with the bind action/)
+      end
+
+      it "should set the default value for the priority to 100" do
+        res = parse('-n', 'else', 'vserver', '-a', 'bind', '-p', 'pol', 'vserv')
+        res.subresults[0][:Priority].should eql(100)
+      end
+
+      it "should set the policy name" do
+        res = parse('-n', 'else', 'vserver', '-a', 'bind', '-p', 'pol', 'vserv')
+        res.subresults[0][:policy].should eql('pol')
+      end
+
+      it "should fail on a bad action" do
+        attempting {
+          parse('-n', 'else', 'vserver', '-a', 'asdf', 'vserv')
+        }.should raise_error(Choosy::ValidationError, /unrecognized value/)
+      end
+    end
+  end
+end