netscaler-cli 0.3.3 → 0.4.0

data/Gemfile

@@ -1,9 +1,13 @@
 source :rubygems
 
 gem 'log4r', '~> 1.1'
-gem 'savon', '~> 0.7'
+gem 'savon', '~> 0.7.0'
 gem 'highline', '>= 1.6'
+gem 'choosy', '~> 0.2'
 
-group :test do
-  gem 'rspec'
+group :development do
+  gem 'rspec', :require => "spec"
+  gem 'autotest'
+  gem 'autotest-notification'
 end
+

data/Gemfile.lock

@@ -1,19 +1,25 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    ZenTest (4.5.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-notification (2.3.1)
+      autotest (~> 4.3)
     builder (3.0.0)
+    choosy (0.2.3)
     crack (0.1.8)
     diff-lcs (1.1.2)
     highline (1.6.1)
     log4r (1.1.9)
-    rspec (2.2.0)
-      rspec-core (~> 2.2)
-      rspec-expectations (~> 2.2)
-      rspec-mocks (~> 2.2)
-    rspec-core (2.2.1)
-    rspec-expectations (2.2.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.2.0)
+    rspec-mocks (2.5.0)
     savon (0.7.9)
       builder (>= 2.1.2)
       crack (>= 0.1.4)
@@ -22,7 +28,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  autotest
+  autotest-notification
+  choosy (~> 0.2)
   highline (>= 1.6)
   log4r (~> 1.1)
   rspec
-  savon (~> 0.7)
+  savon (~> 0.7.0)

data/README.markdown

@@ -12,9 +12,9 @@ The command line tools can be installed with:
 
 The following commands are currently a part of the system:
 
-  * *netscaler-vserver* -- An interface for enabling, disabling, querying, and binding responder policies to a specific virtual server.
-  * *netscaler-service* -- An interface for enabling, disabling, querying, and binding servers to specific services.
-  * *netscaler-server*  -- An interface for enabling, disabling, querying, and binding servers to virtual servers.
+  * *netscaler vserver* -- An interface for enabling, disabling, querying, and binding responder policies to a specific virtual server.
+  * *netscaler service* -- An interface for enabling, disabling, querying, and binding servers to specific services.
+  * *netscaler server*  -- An interface for enabling, disabling, querying, and binding servers to virtual servers.
   
 Each command requires at least the --netscaler flag (which can be the full netscaler host name in the configuration file, or its alias, see below).
 
@@ -30,5 +30,8 @@ Each load balancer requires an entry in the file in the form:
        username: 'some.username'
        password: 'super!duper!secret!'
        alias:  prod
+       version: '9.2'
 
 Multiple entries can be in the file; the password and the alias settings are not required.  An alias can be used as a shortcut name on the command line for a particular netscaler server.  However, if no password is given in the file for a given configuration, the tool will ask you for it.
+
+The version information is optional, but breaking API changes were introduced in version 9.2 of Netscaler software, so some commands may fail if this isn't set for this Netscaler software version.

data/Rakefile

@@ -12,17 +12,14 @@ include FileUtils
 task :default => :spec
 
 desc "Run the RSpec tests"
-RSpec::Core::RakeTask.new do |t|
-  t.rspec_opts = ['-b', '-c', '-f', 'p']
-  t.fail_on_error = false
-end
+RSpec::Core::RakeTask.new :spec
 
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name           = 'netscaler-cli'
     gem.version        = Netscaler::Version.to_s
-    gem.executables    = %W{netscaler-vserver netscaler-service netscaler-server}
+    gem.executables    = %W{netscaler}
     gem.summary        = 'Simple command line utilities for interacting remotely with a Netscaler load balancer.'
     gem.description    = 'This gem installs several simple command line utilities locally.  It uses the NSConfig.wsdl SOAP interface for remote access.'
     gem.email          = ['madeonamac@gmail.com']
@@ -33,8 +30,9 @@ begin
     gem.add_dependency    'log4r',      '>=1.1.9'
     gem.add_dependency    'savon',      '>=0.7.9'
     gem.add_dependency    'highline',   '>=1.6'
+    gem.add_dependency    'choosy',     '>=0.2.3'
     
-    gem.add_development_dependency 'rspec', '>=2.2.0'
+    gem.add_development_dependency 'rspec', '>=2.5.0'
   end
 rescue LoadError
   puts "Jeweler or dependencies are not available.  Install it with: sudo gem install jeweler"

data/bin/{netscaler-server → netscaler}

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
-require 'netscaler/server/cli'
-Netscaler::Server::CLI.new(ARGV).execute!
+require 'netscaler/cli'
+Netscaler::CLI.new(ARGV).execute!

data/etc/Version

@@ -1 +1 @@
-0.3.3
+0.4.0

data/lib/netscaler/{baseexecutor.rb → base_request.rb}

@@ -1,13 +1,12 @@
 require 'netscaler/logging'
 
 module Netscaler
-  class BaseExecutor
+  class BaseRequest
     include Netscaler::Logging
 
-    attr_reader :host, :client, :json
+    attr_reader :client
 
-    def initialize(host, client)
-      @host = host
+    def initialize(client)
       @client = client
     end
 

data/lib/netscaler/cli.rb

@@ -0,0 +1,201 @@
+require 'netscaler/errors'
+require 'netscaler/version'
+require 'netscaler/config'
+require 'netscaler/executor'
+require 'netscaler/server/request'
+require 'netscaler/vserver/request'
+require 'netscaler/service/request'
+require 'choosy'
+
+module Netscaler
+  class CLI
+
+    def initialize(args)
+      @args = args.dup
+    end
+
+    def parse!(propagate=nil)
+      command.parse!(@args, propagate)
+    end
+
+    def execute!
+      begin
+        command.execute!(@args)
+      rescue SystemExit
+        raise
+      rescue Netscaler::ConfigurationError => e
+        print_error(e.message)
+        exit 1
+      rescue Exception => e
+        STDERR.puts e.backtrace
+        print_error(e.message)
+        exit 1
+      end
+    end
+
+    protected
+    def command
+      cmds = [servers, vservers, services]
+      @command ||= Choosy::SuperCommand.new :netscaler do
+        printer :standard, :color => true, :headers => [:bold, :blue], :max_width => 80
+
+        summary "This is a command line tool for interacting with Netscaler load balancer"
+        header 'Description:'
+        para "There are several subcommands to do various things with the load balancer. Try 'netscaler help SUBCOMMAND' for more information about the particular command you want to use."
+        para "Note that you can supply a configuration file, which would normally be found under ~/.netscaler-cli.yml. That file describes the relationship between your Netscaler load balancers and the aliases, usernames, and passwords that you supply for them. The file is in the general format:"
+        para "  netscaler.host.name.com:
+    alias: is_optional
+    usernamd: is_required
+    password: is_optional_but_querried_if_not_found"
+        
+        # COMMANDS
+        header 'Commands:'
+        cmds.each do |cmd|
+          command cmd
+        end
+        para ''
+        help
+
+        # OPTIONS
+        header 'Global Options:'
+        string :netscaler, "The IP Address, hostname, or alias in the config file of the Netscaler load balancer. This is required." do
+          depends_on :config
+          required
+
+          validate do |arg, options|
+            reader = Netscaler::ConfigurationReader.new(options[:config])
+            config = reader[arg]
+            if config.nil?
+              die "the Netscaler address '#{arg}' is not defined in the configuration file"
+            else
+              options[:netscaler] = config
+            end
+          end
+        end
+        yaml :config, "The path to the netscaler configuration file. By default, it is ~/.netscaler-cli.yml" do
+          default File.join(ENV['HOME'], '.netscaler-cli.yml')
+        end
+        
+        header 'Informative:'
+        boolean_ :debug, "Print extra debug information"
+        boolean_ :json, "Prints out JSON instead of textual data"
+        version Netscaler::Version.to_s
+      end
+    end#command
+
+    def servers
+      Choosy::Command.new :server do |s|
+        executor Netscaler::Executor.new(Netscaler::Server::Request)
+        summary "Enables, disbles, or lists servers in the load balancer"
+        header 'Description:'
+        para "This is a tool for enabling and disabling a server in a Netscaler load balancer.  The name of the server is required, as is the address of the Netscaler load balancer."
+        para "By default, this command will tell you what the current status of the server is."
+        para "If you want to list all of the services, use the --list flag."
+          
+        header 'Options:'
+        enum :action, [:enable, :disable, :list, :status], "Either [enable, disable, list]. 'list' will ignore additional arguments. Default action is 'status'" do
+          default :status
+        end
+        arguments do
+          count 0..1 #:at_least => 0, :at_most => 1
+          metaname 'SERVER'
+          validate do |args, options|
+            if args.length == 0
+              die "no server given to act upon" unless options[:action] == :list
+            end
+          end
+        end
+      end
+    end
+
+    def vservers
+      Choosy::Command.new :vserver do
+        executor Netscaler::Executor.new(Netscaler::VServer::Request)
+        summary "Enables, disables, binds or unbinds policies, or lists virtual servers."
+        header 'Description:'
+        para "This is a tool for acting upon virtual servers (VIPs) in a Netscaler load balancer. The name of the virtual server is required."
+        para "By default, this command will tell you what the current status of the server is."
+        para "If you want to list all of the virtual servers, use the --list flag."
+
+        header 'Options:'
+        enum :action, [:enable, :disable, :list, :bind, :unbind, :status], "Either [enable, disable, list, bind, unbind, status]. 'bind' and 'unbind' require the additional '--policy' flag. 'list' will ignore additional arguments. Default action is 'status'." do
+          default :status
+        end
+        string :policy, "The name of the policy to bind/unbind." do
+          depends_on :action
+          default :unset
+          validate do |arg, options|
+            if [:bind, :unbind].include?(options[:action])
+              die "required by the 'bind/unbind' actions" if arg == :unset
+            else
+              die "only used with bind/unbind" unless arg == :unset
+            end
+          end
+        end
+        integer :Priority, "The integer priority of the policy to bind with. Default is 100." do
+          depends_on :action, :policy
+          default -1
+          validate do |arg, options|
+            if options[:action] == :bind
+              if arg == -1
+                options[:Priority] = 100
+              end
+            elsif arg != -1
+              die "only used with the bind action"
+            end
+          end
+        end
+        arguments do
+          count 0..1 #:at_least => 0, :at_most => 1
+          metaname 'SERVER'
+          validate do |args, options|
+            if args.length == 0
+              die "no virtual server given to act upon" unless options[:action] == :list
+            end
+          end
+        end
+      end
+    end
+
+    def services
+      Choosy::Command.new :service do
+        executor Netscaler::Executor.new(Netscaler::Service::Request)
+        summary "Enables, disables, binds or unbinds from a virtual server, a given service."
+        header 'Description:'
+        para "This is a tool for enabling and disabling services in a Netscaler load balancer.  The name of the service is required, as is the address of the Netscaler load balancer."
+        
+        header 'Options:'
+        enum :action, [:enable, :disable, :bind, :unbind, :status], "Either [enable, disable, bind, unbind, status] of a service. 'bind' and 'unbind' require the '--vserver' flag. Default is 'status'." do
+          default :status
+        end
+        string :vserver, "The virtual server to bind/unbind this service to/from." do
+          depends_on :action
+          default :unset
+          validate do |arg, options|
+            if [:bind, :unbind].include?(options[:action])
+              die "requires the -v/--vserver flag" if arg == :unset
+            else
+              die "only used with bind/unbind" unless arg == :unset
+            end
+          end
+        end
+        arguments do
+          count 0..1 #:at_least => 0, :at_most => 1
+          metaname 'SERVICE'
+          validate do |args, options|
+            if args.length == 0
+              die "no services given to act on" unless options[:action] == :list
+            end
+          end
+        end
+      end
+    end
+
+    private
+    def print_error(e)
+      STDERR.puts "#{File.basename($0)}: #{e}"
+      STDERR.puts "Try '#{File.basename($0)} help' for more information"
+      exit 1
+    end
+  end
+end

data/lib/netscaler/config.rb

@@ -6,8 +6,8 @@ require 'highline/import'
 module Netscaler
 
   class ConfigurationReader
-    def initialize(file=nil)
-      @servers = read_config_file(file)
+    def initialize(yaml)
+      @servers = yaml
     end
 
     def [](name)
@@ -32,16 +32,7 @@ module Netscaler
       @servers.keys
     end
 
-    private
-    def create_config(lbname, yaml)
-      if yaml['username'].nil?
-        raise Netscaler::ConfigurationError.new("No username was specified for the given Netscaler host")
-      end
-
-      Configuration.new(lbname, yaml['username'], yaml['password'], yaml['alias'])
-    end
-
-    def read_config_file(file)
+    def self.read_config_file(file)
       if file.nil?
         file = File.expand_path(".netscaler-cli.yml", Etc.getpwuid.dir)
       end
@@ -52,21 +43,35 @@ module Netscaler
 
       begin
         yaml = File.read(file)
-        return YAML::load(yaml)
+        ConfigurationReader.new(YAML::load(yaml))
       rescue Exception => e
         raise Netscaler::ConfigurationError.new("Unable to load the netscaler-cli configuration file")
       end
     end
+
+    private
+    def create_config(lbname, yaml)
+      if yaml['username'].nil?
+        raise Netscaler::ConfigurationError.new("No username was specified for the given Netscaler host")
+      end
+
+      Configuration.new(lbname, yaml['username'], yaml['password'], yaml['alias'], yaml['version'])
+    end
   end
 
   class Configuration
-    attr_reader :host, :username, :password, :alias
+    attr_reader :host, :username, :password, :alias, :version
 
-    def initialize(host, username, password=nil, nalias=nil)
+    def initialize(host, username, password=nil, nalias=nil, version=nil)
       @host = host
       @username = username
       @password = password
       @alias = nalias
+      @version = if version
+                   version.to_s
+                 else
+                   "9.2"
+                 end
 
       query_password
     end

data/lib/netscaler/executor.rb

@@ -0,0 +1,34 @@
+require 'netscaler/errors'
+require 'netscaler/logging'
+require 'netscaler/transaction'
+require 'netscaler/extensions'
+
+module Netscaler
+  class Executor
+    
+    def initialize(request_class)
+      @request_class = request_class
+    end
+
+    def execute!(args, options)
+      Netscaler::Logging.configure(options[:debug])
+
+      Netscaler::Transaction.new options[:netscaler] do |client|
+        @request_class.new(client).send(options[:action], args[0], options) do |response|
+          if options[:json]
+            puts response.to_json
+          else
+            if response.is_a?(Array)
+              if response.length > 0
+                puts response[0].header
+              end
+            else
+              puts response.header
+            end
+            puts response.to_s
+          end
+        end
+      end
+    end
+  end
+end