cf_script 0.0.1.beta.1

data/lib/cf_script/command/cf/general/auth.rb

@@ -0,0 +1,28 @@
+module CfScript::Command::General
+  class AuthCommand < CfScript::Command::Base
+    def initialize
+      super(:general, :auth)
+    end
+
+    def run(username, password, &block)
+      run_cf self, username, password do |output|
+        unless can_run?(output, check_failed: false)
+          if output.credentials_rejected?
+            error 'Credentials were rejected'
+          else
+            output.dump
+          end
+
+          return false
+        else
+          if logged_in = output.authenticated?
+            block_given? ? yield(logged_in) : logged_in
+          else
+            error 'Not logged in'
+            return false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cf_script/command/cf/general/login.rb

@@ -0,0 +1,42 @@
+module CfScript::Command::General
+  class LoginCommand < CfScript::Command::Base
+    def initialize
+      super(:general, :login)
+    end
+
+    def run(username, password, options = {}, &block)
+      args = [{ u: username, p: password }]
+
+      if options[:api]
+        args.last[:a] = options[:api]
+      end
+
+      if options[:org]
+        args.last[:o] = options[:org]
+      end
+
+      if options[:space]
+        args.last[:s] = options[:space]
+      end
+
+      run_cf self, *args do |output|
+        unless can_run?(output, check_failed: false)
+          if output.credentials_rejected?
+            error 'Credentials were rejected'
+          else
+            output.dump
+          end
+
+          return false
+        else
+          if logged_in = output.authenticated?
+            block_given? ? yield(logged_in) : logged_in
+          else
+            error 'Not logged in'
+            return false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cf_script/command/cf/general/logout.rb

@@ -0,0 +1,15 @@
+module CfScript::Command::General
+  class LogoutCommand < CfScript::Command::Base
+    def initialize
+      super(:general, :logout)
+    end
+
+    def run(*args, &block)
+      run_cf self, *args do |output|
+        return false unless can_run?(output)
+
+        block_given? ? yield(output.ok?) : output.ok?
+      end
+    end
+  end
+end

data/lib/cf_script/command/cf/general/target.rb

@@ -0,0 +1,64 @@
+module CfScript::Command
+  class General::TargetCommand < CfScript::Command::Base
+    NOT_LOGGED_IN = 'Not logged in'
+
+    def initialize
+      super(:general, :target)
+    end
+
+    def run(space_name_or_target = nil, &block)
+      args  = build_args(space_name_or_target)
+      space = args.first && args.first.key?(:s) ? args.first[:s] : ''
+
+      run_cf self, *args do |output|
+        return nil unless can_run?(output, check_failed: false)
+
+        # TODO: check org not found too
+
+        if output.not_found?('Space', space)
+          error "Space #{space} not found"
+          return
+        end
+
+        if target = build_target(output)
+          block ? yield(target) : target
+        else
+          error 'object is nil'
+        end
+      end
+    end
+
+    private
+
+    def build_args(name_or_target)
+      case name_or_target
+      when String, Symbol
+        # TODO: add org if present
+        [{ s: name_or_target }]
+      when CfScript::Target
+        [name_or_target.to_options]
+      else
+        []
+      end
+    end
+
+    def build_target(output)
+      attrs = output.attributes
+
+      unless attrs.empty?
+        target = CfScript::Target.new(
+          attrs[:api_endpoint].value,
+          attrs[:org].value,
+          attrs[:space].value,
+          attrs[:user].value
+        )
+
+        if target.space =~ /No space targeted/
+          target.space = ''
+        end
+
+        target
+      end
+    end
+  end
+end

data/lib/cf_script/command/cf/general.rb

@@ -0,0 +1,15 @@
+CfScript::Command.const_set(:General, Module.new)
+
+require 'cf_script/command/cf/general/api'
+require 'cf_script/command/cf/general/auth'
+require 'cf_script/command/cf/general/login'
+require 'cf_script/command/cf/general/logout'
+require 'cf_script/command/cf/general/target'
+
+module CfScript::Command::General
+  CfScript::Command.register ApiCommand
+  CfScript::Command.register AuthCommand
+  CfScript::Command.register LoginCommand
+  CfScript::Command.register LogoutCommand
+  CfScript::Command.register TargetCommand
+end

data/lib/cf_script/command/cf/routes/check_route.rb

@@ -0,0 +1,17 @@
+module CfScript::Command
+  class Routes::CheckRouteCommand < CfScript::Command::Base
+    def initialize
+      super(:routes, :check_route)
+    end
+
+    def run(host, domain, &block)
+      run_cf self, host, domain do |output|
+        return false unless can_run?(output)
+
+        exists = output.matches? /^Route #{host}.#{domain} does exist/
+
+        block_given? ? yield(exists) : exists
+      end
+    end
+  end
+end

data/lib/cf_script/command/cf/routes/create_route.rb

@@ -0,0 +1,19 @@
+module CfScript::Command
+  class Routes::CreateRouteCommand < CfScript::Command::Base
+    def initialize
+      super(:routes, :create_route)
+    end
+
+    def run(space, domain, host = nil, &block)
+      options = host ? { n: host } : {}
+
+      run_cf self, space, domain, options do |output|
+        return false unless can_run?(output)
+
+        if exists = output.contains?(/^OK$/)
+          block_given? ? yield(exists) : exists
+        end
+      end
+    end
+  end
+end

data/lib/cf_script/command/cf/routes/delete_route.rb

@@ -0,0 +1,19 @@
+module CfScript::Command
+  class Routes::DeleteRouteCommand < CfScript::Command::Base
+    def initialize
+      super(:routes, :delete_route)
+    end
+
+    def run(domain, host = nil, force = true, &block)
+      options = host ? { n: host, flags: [:f] } : { flags: [:f] }
+
+      run_cf self, domain, options do |output|
+        return false unless can_run?(output)
+
+        if deleted = output.ok?
+          block_given? ? yield(deleted) : deleted
+        end
+      end
+    end
+  end
+end

data/lib/cf_script/command/cf/routes/map_route.rb

@@ -0,0 +1,30 @@
+module CfScript::Command
+  class Routes::MapRouteCommand < CfScript::Command::Base
+    def initialize
+      super(:routes, :map_route)
+    end
+
+    def run(app_name, domain, host = nil, &block)
+      options = host ? { n: host } : {}
+
+      run_cf self, app_name, domain, options do |output|
+        return false unless can_run?(output,
+          check_status: false,
+          check_failed: false,
+        )
+
+        if output.good? and mapped = output.ok?
+          block_given? ? yield(mapped) : mapped
+        else
+          if output.failed?
+            error output.last_line
+          else
+            error 'failed to map route'
+          end
+
+          return false
+        end
+      end
+    end
+  end
+end

data/lib/cf_script/command/cf/routes/routes.rb

@@ -0,0 +1,40 @@
+module CfScript::Command
+  class Routes::RoutesCommand < CfScript::Command::Base
+    ROUTES_TABLE = ['space', 'host', 'domain', 'apps']
+
+    def initialize
+      super(:routes, :routes)
+    end
+
+    def run(*args, &block)
+      run_cf self do |output|
+        return unless can_run?(output)
+
+        if rows = output.table(ROUTES_TABLE)
+          routes = build_route_info(rows)
+
+          block_given? ? yield(routes) : routes
+        else
+          error "Routes table was not found"
+        end
+      end
+    end
+
+    private
+
+    def build_route_info(rows)
+      routes = []
+
+      rows.each do |row|
+        routes << CfScript::RouteInfo.new(
+          row[:space].value,
+          row[:host].value,
+          row[:domain].value,
+          row[:apps].to_a
+        )
+      end
+
+      routes
+    end
+  end
+end

data/lib/cf_script/command/cf/routes/unmap_route.rb

@@ -0,0 +1,30 @@
+module CfScript::Command
+  class Routes::UnmapRouteCommand < CfScript::Command::Base
+    def initialize
+      super(:routes, :unmap_route)
+    end
+
+    def run(app_name, domain, host = nil, &block)
+      options = host ? { n: host } : {}
+
+      run_cf self, app_name, domain, options do |output|
+        return false unless can_run?(output,
+          check_status: false,
+          check_failed: false,
+        )
+
+        if output.good? and unmapped = output.ok?
+          block_given? ? yield(unmapped) : unmapped
+        else
+          if output.failed?
+            error output.last_line
+          else
+            error 'failed to unmap route'
+          end
+
+          return false
+        end
+      end
+    end
+  end
+end

data/lib/cf_script/command/cf/routes.rb

@@ -0,0 +1,17 @@
+CfScript::Command.const_set(:Routes, Module.new)
+
+require 'cf_script/command/cf/routes/routes'
+require 'cf_script/command/cf/routes/check_route'
+require 'cf_script/command/cf/routes/create_route'
+require 'cf_script/command/cf/routes/delete_route'
+require 'cf_script/command/cf/routes/map_route'
+require 'cf_script/command/cf/routes/unmap_route'
+
+module CfScript::Command::Routes
+  CfScript::Command.register RoutesCommand
+  CfScript::Command.register CheckRouteCommand
+  CfScript::Command.register CreateRouteCommand
+  CfScript::Command.register DeleteRouteCommand
+  CfScript::Command.register MapRouteCommand
+  CfScript::Command.register UnmapRouteCommand
+end

data/lib/cf_script/command/cf/spaces/space.rb

@@ -0,0 +1,36 @@
+module CfScript::Command
+  class Spaces::SpaceCommand < CfScript::Command::Base
+    def initialize
+      super(:spaces, :space)
+    end
+
+    def run(space_name, &block)
+      run_cf self, space_name do |output|
+        return unless can_run?(output)
+
+        if space = build_space(space_name, output)
+          block_given? ? yield(space) : space
+        else
+          error 'object is nil'
+        end
+      end
+    end
+
+    private
+
+    def build_space(space_name, output)
+      attrs = output.attributes
+
+      unless attrs.empty?
+        space = CfScript::Space.new(
+          space_name,
+          attrs[:org].value,
+          attrs[:apps].to_a,
+          attrs[:domains].to_a,
+          attrs[:services].to_a,
+          attrs[:security_groups].to_a
+        )
+      end
+    end
+  end
+end

data/lib/cf_script/command/cf/spaces/spaces.rb

@@ -0,0 +1,23 @@
+module CfScript::Command
+  class Spaces::SpacesCommand < CfScript::Command::Base
+    SPACES_TABLE = ['name']
+
+    def initialize
+      super(:spaces, :spaces)
+    end
+
+    def run(*args, &block)
+      run_cf self, *args do |output|
+        return unless can_run?(output)
+
+        if rows = output.table(SPACES_TABLE)
+          spaces = rows.map { |row| row[:name].value }
+
+          block_given? ? yield(spaces) : spaces
+        else
+          error "Spaces table was not found"
+        end
+      end
+    end
+  end
+end

data/lib/cf_script/command/cf/spaces.rb

@@ -0,0 +1,9 @@
+CfScript::Command.const_set(:Spaces, Module.new)
+
+require 'cf_script/command/cf/spaces/spaces'
+require 'cf_script/command/cf/spaces/space'
+
+module CfScript::Command::Spaces
+  CfScript::Command.register SpacesCommand
+  CfScript::Command.register SpaceCommand
+end

data/lib/cf_script/command/error.rb

@@ -0,0 +1,5 @@
+class CfScript::Command::Error < StandardError
+  def initialize(command_line, output)
+    super("running '#{command}' [pid: #{output.status.pid}, exit: #{output.status.exitstatus}]")
+  end
+end

data/lib/cf_script/command/line.rb

@@ -0,0 +1,105 @@
+require 'shellwords'
+
+class CfScript::Command::Line
+  attr_reader :env
+  attr_reader :bin
+  attr_reader :type
+  attr_reader :name
+  attr_reader :args
+  attr_reader :options
+  attr_reader :flags
+
+  def initialize(env, bin, type, name, args = [])
+    @env     = env
+    @bin     = bin
+
+    @type    = type
+    @name    = name
+    @options = args.last.is_a?(Hash) ? args.pop : {}
+    @flags   = options.delete(:flags) || []
+    @args    = args
+  end
+
+  def line
+    @line ||= format
+  end
+  alias :to_s :line
+
+  def hide_sensitive
+    case name
+    when :auth
+      hide_parts(-1, 'PASSWORD HIDDEN')
+    when :login
+      hide_option('-p', 'PASSWORD HIDDEN')
+    else
+      line
+    end
+  end
+
+  private
+
+  def format
+    list = [bin]
+
+    list << format_name
+    list << format_args
+    list << format_options
+    list << format_flags
+
+    list.compact.reject(&:empty?).join(' ').gsub(/\s+/, ' ')
+  end
+
+  def format_name
+    name.to_s.gsub(/_/, '-')
+  end
+
+  def format_args
+    list = []
+
+    args.compact.each do |arg|
+      list << arg.to_s.shellescape
+    end
+
+    list.join(' ')
+  end
+
+  def format_options
+    list = []
+
+    options.each do |name, value|
+      list << "-#{name} #{value.to_s.shellescape}" unless value.nil?
+    end
+
+    list.join(' ')
+  end
+
+  def format_flags
+    list = []
+
+    flags.each do |name|
+      flag = name.to_s.gsub('_', '-')
+
+      list << unless flag =~ /\A(--|-[[:alnum:]])/
+        if flag.length == 1
+          "-#{flag}"
+        else
+          "--#{flag}"
+        end
+      else
+        flag
+      end
+    end
+
+    list.join(' ')
+  end
+
+  def hide_parts(parts, with = 'HIDDEN')
+    bits = line.split(/\s+(?=(?:[^"']|"[^"]*"|'[^']*')*$)/)
+    bits[parts] = "[#{with}]"
+    bits.join(' ')
+  end
+
+  def hide_option(option, with = 'HIDDEN')
+    line.gsub(/#{option}\s+(['"][^'"]+['"]|[\S]+)/, "#{option} [#{with}]")
+  end
+end

data/lib/cf_script/command/registry.rb

@@ -0,0 +1,50 @@
+module CfScript::Command
+  class Registry
+    attr_reader :commands
+
+    DuplicateCommand     = Class.new(StandardError)
+    UnimplementedCommand = Class.new(StandardError)
+
+    def initialize
+      @commands = {}
+    end
+
+    def catalog
+      catalog = Hash.new{ |types, type| types[type] = [] }
+
+      commands.each do |name, command|
+        catalog[command.type] << name
+      end
+
+      catalog
+    end
+
+    def add!(command_class)
+      instance = command_class.instance
+
+      if known?(instance.name)
+        raise DuplicateCommand.new(
+          "The '#{instance.name}' command is already registered"
+        )
+      end
+
+      commands[instance.name] = instance
+    end
+
+    def known?(command_name)
+      commands.key?(command_name)
+    end
+
+    def check!(command_name)
+      unless known?(command_name)
+        raise UnimplementedCommand.new(
+          "The #{command_name} command is not implemented, yet"
+        )
+      end
+    end
+
+    def [](command_name)
+      commands[command_name]
+    end
+  end
+end

data/lib/cf_script/command/runner.rb

@@ -0,0 +1,97 @@
+module CfScript::Command
+  module Runner
+    module_function
+
+    def run_cf(command, *args, &block)
+      run_command(command, *args, &block)
+    rescue CfScript::Command::Error => exception
+      error command.name, exception.message
+    end
+
+    def cf_id
+      "#{cf_version} (path: #{cf_path})"
+    end
+
+    def cf_version
+      `#{cf_bin} --version`.chomp.split(' ')[1..-1].join(': ')
+    end
+
+    def cf_bin
+      @cf_bin  ||= cf_in_path? && !cf_in_env? ? 'cf' : cf_path
+    end
+
+    def which_cf
+      `which cf`.chomp
+    end
+
+    def cf_in_path?
+      !which_cf.empty?
+    end
+
+    def cf_in_env?
+      !ENV['CF_BINARY'].nil?
+    end
+
+    def cf_path
+      unless @cf_path
+        @cf_path = ENV['CF_BINARY'] || which_cf
+
+        if @cf_path.nil? || @cf_path.empty?
+          puts "Could not find the cf binary".colorize(:red)
+          puts
+          puts "If it isn't installed you need to install it first. You can find"
+          puts "the latest release at:"
+          puts
+          puts "  https://github.com/cloudfoundry/cli/releases".colorize(:cyan)
+          puts
+          puts "If cf is already installed, make sure its location is included "
+          puts "in $PATH."
+
+          raise "Could not find the cf binary"
+        end
+      end
+
+      @cf_path
+    end
+
+    def cf_env
+      # When things go wrong dump the output of cf to the terminal, and the
+      # colors make it easier to read.
+      ENV['CF_COLOR'] ||= CfScript.config.runtime.color ? 'true' : 'false'
+      ENV['CF_TRACE'] ||= ENV['DEBUG'] ? 'true' : 'false'
+      ENV
+    end
+
+    private
+
+    def cf_executor
+      CfScript.config.runtime.executor
+    end
+
+    def run_command(command, *args, &block)
+      command_line = command.line(cf_env, cf_bin, args)
+
+      trace(:running, command_line.hide_sensitive, true)
+
+      stdout, stderr, status = cf_executor.execute(cf_env, command_line)
+
+      output = CfScript::Output.new(command_line, stdout, stderr, status)
+
+      unless output.good?
+        run_error!(command_line, output)
+      end
+
+      block_given? ? yield(output) : output
+    end
+
+    def run_error!(command_line, output)
+      unless CfScript.stdout.is_a?(StringIO)
+        CfScript.stdout.puts output.stdout unless output.stdout.empty?
+      end
+
+      unless CfScript.stderr.is_a?(StringIO)
+        CfScript.stderr.puts output.stderr unless output.stderr.empty?
+      end
+    end
+  end
+end