cf_script 0.0.1.beta.1

data/test/lib/cf_script/command/line_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+describe CfScript::Command::Line do
+  subject { CfScript::Command::Line }
+
+  it "initializes bin, name, args, options, and flags" do
+    line = subject.new({ foo: :bar}, 'bin', :test, :dummy, [:arg1, :arg2, { i: 1, o: 2, flags: [:s] }])
+
+    assert_equal 'bin',          line.bin
+    assert_equal :dummy,         line.name
+    assert_equal [:arg1, :arg2], line.args
+    assert_equal({ i: 1, o: 2 }, line.options)
+    assert_equal [:s],           line.flags
+  end
+
+  describe "line" do
+    it "returns a formatted command line" do
+      line = subject.new({}, 'cf', :test, :dummy, [:arg1, :arg2, { i: 1, o: 2, flags: [:s] }])
+
+      assert_equal 'cf dummy arg1 arg2 -i 1 -o 2 -s', line.line
+    end
+
+    it "formats long flag names" do
+      line = subject.new({}, 'cf', :test, :dummy, [:arg1, { i: 1, flags: [:some_thing] }])
+
+      assert_equal 'cf dummy arg1 -i 1 --some-thing', line.line
+    end
+
+    it "pass preformatted flags as is" do
+      line = subject.new({}, 'cf', :test, :dummy, [:arg1, { i: 1, flags: ['--one', '--foo-bar'] }])
+
+      assert_equal 'cf dummy arg1 -i 1 --one --foo-bar', line.line
+    end
+  end
+
+  it "hides password for auth command" do
+    line = subject.new({}, 'cf', :test, :auth, ['username', 'password'])
+
+    assert_equal 'cf auth username [PASSWORD HIDDEN]', line.hide_sensitive
+  end
+
+  it "hides password for login command" do
+    options = [
+      { p: 'word', u: 'name', a: 'work' },
+      { u: 'name', p: 'word', a: 'work' },
+      { u: 'name', a: 'work', p: 'word' },
+    ]
+
+    options.each do |test|
+      line = subject.new({}, 'cf', :test, :login, [test])
+      text = line.hide_sensitive
+
+      assert_match /cf login /, text
+      assert_match /-p \[PASSWORD HIDDEN\]/, text
+      assert_match /-u name/, text
+      assert_match /-a work/, text
+    end
+  end
+end

data/test/lib/cf_script/object/api_endpoint_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+describe CfScript::ApiEndpoint do
+  subject { CfScript::ApiEndpoint }
+
+  it "initializes all attributes to sensible defaults" do
+    api_endpoint = subject.new
+
+    assert_equal nil, api_endpoint.url
+    assert_equal nil, api_endpoint.version
+  end
+
+  it "sets all given attributes" do
+    api_endpoint = subject.new('URL', '123')
+
+    assert_equal 'URL', api_endpoint.url
+    assert_equal '123', api_endpoint.version
+  end
+end

data/test/lib/cf_script/object/app_info_test.rb

@@ -0,0 +1,127 @@
+require 'test_helper'
+
+describe CfScript::AppInfo do
+  include ObjectHelpers
+
+  attr_reader   :urls
+  attr_reader   :last_uploaded
+  attr_reader   :buildpack
+
+  attr_accessor :empty_attrs
+  attr_accessor :apps_attrs
+  attr_accessor :app_attrs
+  attr_accessor :instance_attrs
+
+  def setup
+    @urls          = 'projects.example.com, projects.example.io'
+    @last_uploaded = 'Fri Dec 25 00:00:00 UTC 2015'
+    @buildpack     = 'https://github.com/cloudfoundry/binary-buildpack.git'
+
+    @empty_attrs = CfScript::AttributeList.new
+
+    @apps_attrs = build_attribute_list(
+      requested_state:  'started',
+      instances:        '1/2',
+      memory:           '1G',
+      disk:             '2G',
+      urls:             @urls,
+    )
+
+    @app_attrs = build_attribute_list(
+      requested_state:  'started',
+      instances:        '1/2',
+      usage:            '1G x 1 instances',
+      urls:             @urls,
+      last_uploaded:    @last_uploaded,
+      stack:            'cflinuxfs2',
+      buildpack:        @buildpack,
+    )
+  end
+
+  it "initializes missing attributes to sensible defaults" do
+    info = CfScript::AppInfo.new('name', empty_attrs)
+
+    assert_equal 'name',  info.name
+    assert_equal nil,     info.requested_state
+    assert_equal nil,     info.instances
+    assert_equal [],      info.urls
+    assert_equal nil,     info.usage
+    assert_equal nil,     info.last_uploaded
+    assert_equal nil,     info.stack
+    assert_equal nil,     info.buildpack
+    assert_equal nil,     info.memory
+    assert_equal nil,     info.disk
+  end
+
+  it "sets apps command attributes when given" do
+    info = CfScript::AppInfo.new('projects', apps_attrs)
+
+    assert_equal 'projects',              info.name
+    assert_equal 'started',               info.requested_state
+    assert_equal '1/2',                   info.instances
+    assert_equal 2,                       info.urls.length
+    assert_equal 'projects.example.com',  info.urls.first
+    assert_equal 'projects.example.io',   info.urls.last
+    assert_equal nil,                     info.usage
+    assert_equal nil,                     info.last_uploaded
+    assert_equal nil,                     info.stack
+    assert_equal nil,                     info.buildpack
+    assert_equal '1G',                    info.memory
+    assert_equal '2G',                    info.disk
+  end
+
+  it "sets app command attributes when given" do
+    info = CfScript::AppInfo.new('projects', app_attrs)
+
+    assert_equal 'projects',              info.name
+    assert_equal 'started',               info.requested_state
+    assert_equal '1/2',                   info.instances
+    assert_equal 2,                       info.urls.length
+    assert_equal 'projects.example.com',  info.urls.first
+    assert_equal 'projects.example.io',   info.urls.last
+    assert_equal '1G x 1 instances',      info.usage
+    assert_equal last_uploaded,           info.last_uploaded
+    assert_equal 'cflinuxfs2',            info.stack
+    assert_equal buildpack,               info.buildpack
+    assert_equal '1G',                    info.memory # Extracted from usage
+    assert_equal nil,                     info.disk
+  end
+
+  it "defines state method that return value of requested_state" do
+    info = CfScript::AppInfo.new('projects', app_attrs)
+
+    assert_respond_to info, :state
+    assert_equal 'started', info.state
+  end
+
+  it "defines started? and stopped? methods and hot?, cold? aliases" do
+    info = CfScript::AppInfo.new('projects', app_attrs)
+
+    assert_respond_to info, :started?
+    assert_respond_to info, :hot?
+
+    assert_respond_to info, :stopped?
+    assert_respond_to info, :cold?
+
+    assert info.started?
+    assert info.hot?
+
+    refute info.stopped?
+    refute info.cold?
+  end
+
+  it "defines set_intance_status method that takes attribute lists and builds InstanceStatus objects" do
+    info = CfScript::AppInfo.new('projects', app_attrs)
+
+    info.set_instance_status [
+      build_instance_status_attrs(index: '0'),
+      build_instance_status_attrs(index: '1'),
+      build_instance_status_attrs(index: '2'),
+    ]
+
+    assert_equal 3,   info.instance_status.length
+    assert_equal '0', info.instance_status[0].index
+    assert_equal '1', info.instance_status[1].index
+    assert_equal '2', info.instance_status[2].index
+  end
+end

data/test/lib/cf_script/object/app_list_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+describe CfScript::AppList do
+  include ObjectHelpers
+
+  attr_accessor :list
+
+  def setup
+    one_attrs = build_attribute_list(
+      requested_state: 'started',
+      urls:            'example.com',
+    )
+
+    two_attrs = build_attribute_list(
+      requested_state: 'stopped',
+      urls:            'example.com',
+    )
+
+    @list = CfScript::AppList.new([
+      CfScript::AppInfo.new('one-worker', one_attrs),
+      CfScript::AppInfo.new('two-engine', two_attrs),
+    ])
+  end
+
+  it "initializes list to an empty Array" do
+    app_list = CfScript::AppList.new
+
+    assert_equal 0, app_list.length
+  end
+
+  it "selects by prefix" do
+    list.select!(ending_with: 'worker')
+
+    assert_equal 1, list.length
+    assert_equal 'one-worker', list.first.name
+  end
+
+  it "selects by suffix" do
+    list.select!(starting_with: 'two')
+
+    assert_equal 1, list.length
+    assert_equal 'two-engine', list.first.name
+  end
+
+  it "selects by state" do
+    list.select!(state: 'stopped')
+
+    assert_equal 1, list.length
+    assert_equal 'two-engine', list.first.name
+  end
+end

data/test/lib/cf_script/object/attribute_list_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+describe CfScript::AttributeList do
+  subject {
+    CfScript::AttributeList.new([
+      CfScript::Attribute.new('one', 'UNO'),
+      CfScript::Attribute.new('two', 'DUE'),
+    ])
+  }
+
+  it "defines << method that adds attributes to the list" do
+    subject << CfScript::Attribute.new('six', 'SEI')
+
+    assert_equal 3, subject.length
+  end
+
+  it "raises an exception when duplicate attributes are added" do
+    e = assert_raises(RuntimeError) {
+      subject << CfScript::Attribute.new('one', 'DUPLICATE')
+    }
+
+    assert_equal "Duplicate attribute 'one'", e.message
+  end
+
+  it "delegates [] method to the underlying Hash" do
+    assert_equal 'UNO', subject['one'].value
+  end
+
+  it "defines a names method that returns an Array of attribute names" do
+    assert_equal ['one', 'two'], subject.names
+  end
+
+  it "defines a values method that returns an Array of attribute values" do
+    assert_equal ['UNO', 'DUE'], subject.values
+  end
+
+  it "defines a to_h method that returns a Hash representation of the attributes" do
+    expected = { 'one' => 'UNO', 'two' => 'DUE' }
+
+    assert_equal expected, subject.to_h
+  end
+end

data/test/lib/cf_script/object/attribute_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+describe CfScript::Attribute do
+  subject { CfScript::Attribute }
+
+  it "preserves the name and value as given" do
+    { :foo  => :bar,
+      'foo' => 'bar'
+    }.each do |name, value|
+      var = subject.new(name, value)
+
+      assert_equal name, var.name
+      assert_equal value, var.value
+    end
+  end
+
+  it "defines to_a methods that splits the value on commas + zero or more space" do
+    var = subject.new('list', 'a, b,  c,d')
+
+    assert_equal ['a', 'b', 'c', 'd'], var.to_a
+  end
+
+  it "defines a to_s that returns a formatted string representation" do
+    var = subject.new(:foo, :bar)
+
+    assert_equal "foo: bar", var.to_s
+    assert_equal "foo: bar", var.inspect
+  end
+end

data/test/lib/cf_script/object/instance_status_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+describe CfScript::InstanceStatus do
+  include ObjectHelpers
+
+  attr_accessor :instance_status
+
+  def setup
+    @instance_status = build_instance_status
+  end
+
+  it "initializes all attributes to sensible defaults" do
+    status = CfScript::InstanceStatus.new
+
+    assert_equal nil, status.index
+    assert_equal nil, status.state
+    assert_equal nil, status.since
+    assert_equal nil, status.cpu
+    assert_equal nil, status.memory
+    assert_equal nil, status.disk
+    assert_equal nil, status.details
+  end
+
+  it "initializes given attributes" do
+    assert_equal '0', @instance_status.index
+    assert_equal '1', @instance_status.state
+    assert_equal '2', @instance_status.since
+    assert_equal '3', @instance_status.cpu
+    assert_equal '4', @instance_status.memory
+    assert_equal '5', @instance_status.disk
+    assert_equal '6', @instance_status.details
+  end
+
+  it "shows requested attributes" do
+    assert_equal 'since: 2, memory: 4', @instance_status.show(:since, :memory)
+  end
+end

data/test/lib/cf_script/object/space_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+describe CfScript::Space do
+  subject { CfScript::Space }
+
+  it "initializes all attributes to sensible defaults" do
+    space = subject.new('outer-space')
+
+    assert_equal 'outer-space', space.name
+
+    assert_equal nil, space.org
+
+    assert_equal [], space.apps
+    assert_equal [], space.domains
+    assert_equal [], space.services
+    assert_equal [], space.security_groups
+  end
+
+  it "sets all given attributes" do
+    space = subject.new('space', 'ORG', [:app], [:domain], [:service], [:security])
+
+    assert_equal 'space', space.name
+
+    assert_equal 'ORG', space.org
+
+    assert_equal [:app], space.apps
+    assert_equal [:domain], space.domains
+    assert_equal [:service], space.services
+    assert_equal [:security], space.security_groups
+  end
+end

data/test/lib/cf_script/object/target_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+describe CfScript::Target do
+  subject { CfScript::Target }
+
+  it "initializes all attributes to sensible defaults" do
+    target = subject.new
+
+    assert_equal '', target.api_endpoint
+    assert_equal '', target.org
+    assert_equal '', target.space
+    assert_equal nil, target.user
+  end
+
+  describe "to_options" do
+    it "returns an empty Hash when org and space are not set" do
+      options = subject.new.to_options
+
+      assert_instance_of Hash, options
+      assert_equal({}, options)
+    end
+
+    it "returns a Hash with org and space when set" do
+      options = subject.new('api', 'ORG', 'SPACE', 'user@example.com').to_options
+
+      assert_equal({ o: 'ORG', s: 'SPACE' }, options)
+    end
+
+    it "returns a Hash with org when set" do
+      options = subject.new('api', 'ORG').to_options
+
+      assert_equal({ o: 'ORG' }, options)
+    end
+
+    it "returns a Hash with the space when set" do
+      options = subject.new('api', '', 'SPACE').to_options
+
+      assert_equal({ s: 'SPACE' }, options)
+    end
+  end
+end

data/test/lib/cf_script/output/buffer_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+
+describe CfScript::Output::Buffer do
+  attr_accessor :buffer
+  attr_accessor :raw_text
+
+  def setup
+    @raw_text = "\e[4;31;42mline 1\e[0m\n" +
+                "\e[4;32;44mline 2\e[0m\n" +
+                "\e[4;34;41mline 3\e[0m\n"
+
+    @buffer = CfScript::Output::Buffer.new(@raw_text)
+  end
+
+  it "responds to raw and returns a original text" do
+    assert buffer.respond_to?(:raw)
+    assert_equal raw_text, buffer.raw
+  end
+
+  it "responds to content and returns a sanitized copy" do
+    assert buffer.respond_to?(:content)
+    assert_equal "line 1\nline 2\nline 3\n", buffer.content
+  end
+
+  it "responds to lines and returns sanitized lines" do
+    assert buffer.respond_to?(:lines)
+    assert_equal ['line 1', 'line 2', 'line 3'], buffer.lines
+  end
+
+  it "responds to last_line and returns last line content" do
+    assert_equal 'line 3', buffer.last_line
+  end
+
+  it "responds to subscript and returns matching range" do
+    assert_equal '1',      buffer[5]
+    assert_equal 'line 2', buffer[7..12]
+    assert_equal 'line 3', buffer[14..-2]
+  end
+
+  it "responds to each_line and yields each line" do
+    buffer.each_line.with_index do |line, index|
+      assert_equal buffer.lines[index], line.strip
+    end
+  end
+
+  it "responds to from and returns text from matching line" do
+    assert_equal "line 2\nline 3", buffer.from('2')
+  end
+
+  it "responds to lines_from and returns lines from matching line" do
+    assert_equal ['line 2','line 3'], buffer.lines_from('2')
+  end
+
+  it "responds to match and returns MatchData object" do
+    assert_instance_of MatchData, buffer.match(/2/)
+    assert_equal nil, buffer.match(/4/)
+  end
+
+  it "responds to matches? and returns true or false" do
+    assert buffer.matches?(/2/)
+    refute buffer.matches?(/4/)
+  end
+
+  it "responds to contains? and returns true or false" do
+    assert buffer.contains?('2')
+    refute buffer.contains?('4')
+  end
+
+  it "responds to last_line_matches? and returns true or false" do
+    assert buffer.last_line_matches?(/3/)
+    refute buffer.last_line_matches?(/4/)
+  end
+end

data/test/lib/cf_script/output/parser/attributes_test.rb

@@ -0,0 +1,102 @@
+require 'test_helper'
+
+describe CfScript::Output::Parser::Attributes do
+  attr_accessor :parser
+
+  attr_accessor :text_buffer
+  attr_accessor :line_buffer
+  attr_accessor :line_regexp
+
+  class AttributesParserTest
+    include CfScript::Utils
+    include CfScript::Output::Parser::Attributes
+    include CfScript::Output::Parser::Section
+  end
+
+  def setup
+    @parser = AttributesParserTest.new
+
+    @text_buffer = "" +
+      "one: first  \n" +
+      "  two: second \n" +
+      "tre  : last\n"
+
+    @line_buffer = "one: first , two: second, tre: last   "
+    @line_regexp = /one: (?<one>[^,]+), two: (?<two>[^,]+), tre: (?<tre>.+)/
+  end
+
+  describe "parse_attribute" do
+    it "returns an Attribute object" do
+      attr = parser.parse_attribute(text_buffer.lines[0])
+
+      assert_instance_of CfScript::Attribute, attr
+      assert_equal 'one', attr.name
+      assert_equal 'first', attr.value
+    end
+
+    it "symbolizes attribute names when specified" do
+      attr = parser.parse_attribute(text_buffer.lines[0], true)
+
+      assert_equal :one, attr.name
+    end
+
+    it "strips preceeding/following whitespace" do
+      tests = [
+        ['one', 'first'],
+        ['two', 'second'],
+        ['tre', 'last'],
+      ]
+
+      tests.each_with_index do |pair, index|
+        attr = parser.parse_attribute(text_buffer.lines[index])
+
+        assert_equal pair.first, attr.name
+        assert_equal pair.last,  attr.value
+      end
+    end
+  end
+
+  describe "parse_attribute_list" do
+    it "returns an AttributeList object" do
+      list = parser.parse_attribute_list(text_buffer)
+
+      assert_instance_of CfScript::AttributeList, list
+      assert_equal 3, list.length
+    end
+
+    it "symbolizes attribute names when specified" do
+      list = parser.parse_attribute_list(text_buffer, true)
+
+      assert_equal [:one, :two, :tre], list.names
+    end
+  end
+
+  describe "parse_line_attributes" do
+    it "returns an AttributeList object" do
+      list  = parser.parse_line_attributes(line_buffer, line_regexp)
+
+      assert_instance_of CfScript::AttributeList, list
+      assert_equal 3, list.length
+    end
+
+    it "symbolizes attribute names" do
+      list = parser.parse_line_attributes(line_buffer, line_regexp)
+
+      assert_equal [:one, :two, :tre], list.names
+    end
+
+    it "strips preceeding/following whitespace" do
+      tests = [
+        [:one, 'first'],
+        [:two, 'second'],
+        [:tre, 'last'],
+      ]
+
+      list = parser.parse_line_attributes(line_buffer, line_regexp)
+      tests.each_with_index do |pair, index|
+        assert_equal pair.first, list[list.names[index]].name
+        assert_equal pair.last,  list[list.names[index]].value
+      end
+    end
+  end
+end

data/test/lib/cf_script/output/parser/section_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+describe CfScript::Output::Parser::Section do
+  attr_accessor :parser
+
+  attr_accessor :text_buffer
+
+  class SectionParserTest
+    include CfScript::Utils
+    include CfScript::Output::Parser::Attributes
+    include CfScript::Output::Parser::Section
+  end
+
+  def setup
+    @parser = SectionParserTest.new
+
+    @text_buffer = "\n" +
+      "Something else going on here\n" +
+      "Section Title:\n" +
+      " one: 1\n" +
+      " two: 2\n" +
+      " tre: 3\n" +
+      "\nSomething else"
+  end
+
+  describe "extract_section" do
+    it "returns extracted text" do
+      section = parser.extract_section(text_buffer, 'Section Title')
+
+      assert_equal " one: 1\n two: 2\n tre: 3", section
+    end
+  end
+
+  describe "parse_section_attributes" do
+    it "calls parse_attribute_list" do
+      parser.stub :parse_attribute_list, 'called' do
+        assert_equal 'called', parser.parse_section_attributes(text_buffer, 'Section Title')
+      end
+    end
+
+    it "returns an AttributeList object" do
+      list = parser.parse_section_attributes(text_buffer, 'Section Title')
+
+      assert_instance_of CfScript::AttributeList, list
+      assert_equal 3, list.length
+    end
+
+    it "doesn't symbolize attribute names" do
+      list = parser.parse_section_attributes(text_buffer, 'Section Title')
+
+      assert_equal ['one', 'two', 'tre'], list.names
+    end
+
+    it "returns nil if the section title is not found" do
+      list = parser.parse_section_attributes(text_buffer, 'NOPE')
+
+      assert_equal nil, list
+    end
+  end
+end