stingray-exec 0.1.0

data/lib/stingray/control_api/pool_methods.rb

@@ -0,0 +1,156 @@
+require 'stingray/control_api'
+require 'stingray/control_api/soap_helper_methods'
+
+module Stingray::ControlApi::PoolMethods
+  include Stingray::ControlApi::SoapHelperMethods
+
+  %w(
+    add_pool
+    get_nodes_priority_value
+    get_nodes_weightings
+  ).map(&:to_sym).each do |op|
+    define_method(:"_custom_#{op}") do |node_configs|
+      body = _build_many_keyed_string_arrays(node_configs, :names, :nodes)
+      _make_soap_request('Pool', op, body)
+    end
+  end
+
+  %w(
+    delete_pool
+    get_autoscale_cloudcredentials
+    get_autoscale_cluster
+    get_autoscale_datacenter
+    get_autoscale_datastore
+    get_autoscale_enabled
+    get_autoscale_external
+    get_autoscale_hysteresis
+    get_autoscale_imageid
+    get_autoscale_ipstouse
+    get_autoscale_lastnode_idletime
+    get_autoscale_max_nodes
+    get_autoscale_min_nodes
+    get_autoscale_names
+    get_autoscale_port
+    get_autoscale_refractory
+    get_autoscale_response_time
+    get_autoscale_scaledown_level
+    get_autoscale_scaleup_level
+    get_autoscale_sizeid
+    get_bandwidth_class
+    get_disabled_nodes
+    get_draining_nodes
+    get_ftp_support_rfc2428
+    get_failpool
+    get_keepalive
+    get_keepalive_non_idempotent
+    get_load_balancing_algorithm
+    get_max_connect_time
+    get_max_connections_pernode
+    get_max_idle_connections_per_node
+    get_max_keepalives_per_node
+    get_max_queue_size
+    get_max_reply_time
+    get_monitors
+    get_node_conn_close
+    get_node_connection_attempts
+    get_node_fail_time
+    get_node_use_nagle
+    get_nodes
+    get_nodes_connection_counts
+    get_nodes_last_used
+    get_note
+    get_passive_monitoring
+    get_persistence
+    get_priority_enabled
+    get_priority_nodes
+    get_priority_values
+    get_queue_timeout
+    get_smtp_send_start_tls
+    get_ssl_client_auth
+    get_ssl_encrypt
+    get_ssl_enhance
+    get_ssl_send_close_alerts
+    get_ssl_server_name_extension
+    get_ssl_strict_verify
+    get_transparent
+    get_udp_accept_from
+    get_udp_accept_from_ip_mask
+    get_weightings
+  ).map(&:to_sym).each do |op|
+    define_method(:"_custom_#{op}") do |*names|
+      _make_names_soap_request(names, 'Pool', op)
+    end
+  end
+
+  %w(
+    add_draining_nodes
+    add_monitors
+    add_nodes
+    disable_nodes
+    enable_nodes
+    remove_draining_nodes
+    remove_monitors
+    remove_nodes
+    set_autoscale_cloudcredentials
+    set_autoscale_cluster
+    set_autoscale_datacenter
+    set_autoscale_datastore
+    set_autoscale_enabled
+    set_autoscale_external
+    set_autoscale_hysteresis
+    set_autoscale_imageid
+    set_autoscale_ipstouse
+    set_autoscale_lastnode_idletime
+    set_autoscale_max_nodes
+    set_autoscale_min_nodes
+    set_autoscale_name
+    set_autoscale_port
+    set_autoscale_refractory
+    set_autoscale_response_time
+    set_autoscale_scaledown_level
+    set_autoscale_scaleup_level
+    set_autoscale_sizeid
+    set_bandwidth_class
+    set_disabled_nodes
+    set_draining_nodes
+    set_ftp_support_rfc2428
+    set_failpool
+    set_keepalive
+    set_keepalive_non_idempotent
+    set_load_balancing_algorithm
+    set_max_connect_time
+    set_max_connections_pernode
+    set_max_idle_connections_pernode
+    set_max_keepalives_pernode
+    set_max_queue_size
+    set_max_reply_time
+    set_monitors
+    set_node_conn_close
+    set_node_connection_attempts
+    set_node_fail_time
+    set_node_use_nagle
+    set_nodes
+    set_nodes_priority_value
+    set_nodes_weightings
+    set_note
+    set_passive_monitoring
+    set_persistence
+    set_priority_enabled
+    set_priority_nodes
+    set_queue_timeout
+    set_smtp_send_start_tls
+    set_ssl_client_auth
+    set_ssl_encrypt
+    set_ssl_enhance
+    set_ssl_send_close_alerts
+    set_ssl_server_name_extension
+    set_ssl_strict_verify
+    set_transparent
+    set_udp_accept_from
+    set_udp_accept_from_ip_mask
+  ).map(&:to_sym).each do |op|
+    define_method(:"_custom_#{op}") do |names_values|
+      _make_names_values_soap_request(names_values, 'Pool', op)
+    end
+  end
+end

data/lib/stingray/control_api/soap_helper_methods.rb

@@ -0,0 +1,69 @@
+require 'stingray/control_api'
+
+module Stingray::ControlApi::SoapHelperMethods
+  def _make_soap_request(ns, method, soap_body)
+    self.client.request(ns, method) do
+      soap.namespaces['xmlns:soapenc'] = 'http://schemas.xmlsoap.org/soap/encoding/'
+      soap.body = soap_body
+    end
+  end
+
+  def _make_names_values_soap_request(names_values_hash, ns, operation)
+    raise ArgumentError.new('No names -> values given!') if names_values_hash.empty?
+    body = _build_many_keyed_string_arrays(names_values_hash, :names, :values)
+    _make_soap_request(ns, operation, body)
+  end
+
+  def _make_names_soap_request(names_array, ns, operation)
+    raise ArgumentError.new('No names given!') if names_array.empty?
+    body = _build_string_array(names_array, :names)
+    _make_soap_request(ns, operation, body)
+  end
+
+  def _build_string_array(strings, key_name)
+    body = {
+      key_name => {},
+      :attributes! => {
+        key_name => {'soapenc:arrayType' => "xsd:string[#{strings.length}]"}
+      }
+    }
+
+    strings.each_with_index do |s,i|
+      body[key_name][:"s#{i}"] = s
+    end
+
+    body
+  end
+
+  def _build_many_keyed_string_arrays(key_array_hash, keys_name, arrays_name)
+    body = {
+      keys_name => {},
+      arrays_name => {
+        :attributes! => {},
+      },
+      :attributes! => {
+        keys_name => {'soapenc:arrayType' => "xsd:string[#{key_array_hash.length}]"},
+        arrays_name => {'soapenc:arrayType' => "xsd:list[#{key_array_hash.length}]"},
+      },
+    }
+
+    i = 0
+    key_array_hash.each do |k,arr|
+      body[keys_name][:"k#{i}"] = k
+
+      k_arr = {:attributes! => {}}
+      arr.each_with_index do |node,j|
+        k_arr[:"node#{j}"] = node
+      end
+
+      body[arrays_name][:attributes!][:"k#{i}"] = {
+        'soapenc:arrayType' => "xsd:string[#{arr.length}]"
+      }
+
+      body[arrays_name][:"k#{i}"] = k_arr
+      i += 1
+    end
+
+    body
+  end
+end

data/lib/stingray/exec.rb

@@ -0,0 +1,16 @@
+require 'savon'
+
+module Stingray
+  module Exec
+    def self.configure
+      Savon.configure do |config|
+        unless ENV['DEBUG']
+          config.log = false
+          HTTPI.log = false
+        end
+
+        yield config if block_given?
+      end
+    end
+  end
+end

data/lib/stingray/exec/cli.rb

@@ -0,0 +1,134 @@
+require 'optparse'
+require 'stingray/exec'
+
+class Stingray::Exec::Cli
+  BANNER = <<-EOB.gsub(/^  /, '')
+  Usage: stingray-exec [options] <script>
+
+  Executes scripts in the context of Stingray Traffic Manager configuration
+  models, allowing for access to all methods documented in the Control API.  The
+  <script> argument may be a string expression or a filename (or "-" for stdin),
+  and if ommitted will cause stingray-exec to drop into a fancy DSL-tastic pry
+  console.
+
+  All of the command-line configuration flags may also be given as
+  environmental variables, as noted in the help text for each flag.  The
+  "endpoint" flag/var deserves special attention as the expected value is buried
+  in the Stingray docs.
+  e.g.: STINGRAY_ENDPOINT='https://stingray-pool-master.example.com:9090/soap'
+
+  See the 'examples' directory in the stingray-exec gem tree for some
+  (surprise!) examples of how to do stuff.
+
+  ------- FAIR WARNING: -------
+  The vast majority of Control API methods have been wrapped in very dumb
+  generated code.  Read-only methods work fine, but methods that take arguments
+  invariably require custom implementations -- the kind of thing that's typically
+  generated from a WSDL, which we can't legally redistribute.  The Control API
+  makes things even more fun by requiring the use of soapenc arrays and lists of
+  arrays.  If you want or need to implement such code, the "soap_helper_methods.rb"
+  file in the stingray-exec source may be of help. YMMV.
+
+
+  EOB
+
+  def self.main(argv = ARGV)
+    new(argv).run!
+  end
+
+  attr_reader :argv, :script, :filename
+
+  def initialize(argv)
+    @argv = argv
+  end
+
+  def run!
+    parse_options
+    prepare_script
+    configure
+    evaluate_script
+  end
+
+  private
+  def parse_options
+    OptionParser.new do |opts|
+      opts.banner = BANNER
+      opts.on('-v', '--verbose', 'Yelling. (DEBUG=1)') do
+        ENV['DEBUG'] = '1'
+      end
+      opts.on('-k', '--insecure', 'Allow "insecure" SSL connections ' <<
+          '(STINGRAY_SSL_VERIFY_NONE=1)') do
+        ENV['STINGRAY_SSL_VERIFY_NONE'] = '1'
+      end
+      opts.on('-u=', '--user-password=',
+          'Stingray username:password (STINGRAY_AUTH=<user>:<pass>)') do |u|
+        ENV['STINGRAY_AUTH'] = u
+      end
+      opts.on('-C=', '--credentials=', 'Credentials file containing ' <<
+          'username:password (STINGRAY_AUTH=<user>:<pass>)') do |c|
+        ENV['STINGRAY_AUTH'] = read_credentials_file(c)
+      end
+      opts.on('-E=', '--endpoint=',
+          'Stingray server SOAP endpoint (STINGRAY_ENDPOINT=<uri>)') do |endpoint|
+        ENV['STINGRAY_ENDPOINT'] = endpoint
+      end
+      opts.on('-V=', '--stingray-version=', 'Stingray server version, ' <<
+          'e.g. "9.0" or "9.1" (STINGRAY_VERSION="9.1")') do |ver|
+        ENV['STINGRAY_VERSION'] = ver
+      end
+    end.parse!(argv)
+  end
+
+  def read_credentials_file(filename)
+    File.read(filename).split($/).reject do |l|
+      l.strip =~ /^#/ || l.strip.empty?
+    end.first
+  end
+
+  def prepare_script
+    @script = argv.first || ''
+    @filename = ''
+    if File.exists?(@script)
+      @filename = @script
+      @script = File.read(@script)
+    elsif @script == '-'
+      @script = $stdin.read
+    end
+  end
+
+  def configure
+    Stingray::Exec.configure
+  end
+
+  def evaluate_script
+    require_relative 'dsl'
+
+    # reassign so that scoping is happy once we're inside the new class block
+    script_string = script
+    script_filename = filename
+    shebang_offset = script_string =~ /^#!/ ? 1 : 0
+
+    unless script_string.empty?
+      Class.new(Object) do
+        extend Stingray::Exec::DSL
+        begin
+          stingray_exec(script_string, script_filename, shebang_offset)
+        rescue => e
+          $stderr.puts e.message
+          $stderr.puts e.backtrace.join("\n") if ENV['DEBUG']
+        end
+      end
+    else
+      require 'pry'
+      Pry.config.prompt_name = 'stingray-exec'
+      TOPLEVEL_BINDING.eval('self').extend Stingray::Exec::DSL
+      Pry.start
+    end
+
+    return 0
+  end
+end
+
+if $0 == __FILE__
+  exit Stingray::Exec::Cli.main
+end

data/lib/stingray/exec/dsl.rb

@@ -0,0 +1,48 @@
+require 'stingray/exec'
+require 'stingray/control_api'
+
+module Stingray::Exec::DSL
+  def stingray_exec(string = '', filename = '', lineno = 0, &block)
+    unless string.empty?
+      instance_eval(string, filename, lineno)
+    else
+      instance_eval(&block)
+    end
+  end
+
+  Stingray::ControlApi::CONFIGURATIONS.each do |cfg_ns,variations|
+    define_method(variations[:snaked]) do
+      ivar = :"@#{variations[:snaked].to_s}"
+
+      if inst = instance_variable_get(ivar)
+        return inst
+      end
+
+      inst = Stingray::ControlApi::const_get(variations[:consted]).new
+      inst.client.http.auth.ssl.verify_mode = ssl_verify_mode
+      instance_variable_set(ivar, inst)
+      inst
+    end
+  end
+
+  # Set the SSL verification mode for all SOAP communication.  Valid values are
+  # really up to the HTTP backend, but some known good ones are ":none" and
+  # ":peer".  Setting the STINGRAY_SSL_VERIFY_NONE environmental variable will
+  # result in this method defaulting to ":none".  Once a configuration model
+  # has been initialized, its verify mode cannot be modified through this
+  # function.  Instead, set the model's deeply-nested attribute of
+  # `.client.http.auth.ssl.verify_mode`.
+  def ssl_verify_mode(mode = nil)
+    unless mode.nil?
+      @ssl_verify_mode = mode
+    end
+    @ssl_verify_mode || ENV['STINGRAY_SSL_VERIFY_NONE'] ? :none : :peer
+  end
+
+  # A little helper that allows for iteration over SOAP results that may be
+  # singular or plural (or just plain missing.)  A block must always be given.
+  def foreach(anything, &block)
+    raise SyntaxError.new('Block needed!') unless block_given?
+    [*(anything || [])].each(&block)
+  end
+end

data/lib/stingray/exec/version.rb

@@ -0,0 +1,5 @@
+module Stingray
+  module Exec
+    VERSION = '0.1.0'
+  end
+end

data/lib/stingray/junk.rb

@@ -0,0 +1,16 @@
+module Stingray
+  class Junk
+    def self.snakify(str)
+      str.gsub(/::/, '/').
+        gsub(/\./, '_').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+    end
+
+    def self.constify(str)
+      str.gsub(/\./, '').gsub(/_/, '')
+    end
+  end
+end