hammer_cli_foreman 0.4.0 → 0.5.0

data/test/functional/api_expectations.rb

@@ -0,0 +1,65 @@
+module APIExpectations
+
+  class BlockMatcher < Mocha::ParameterMatchers::Base
+    def initialize(resource=nil, action=nil, &block)
+      @expected_resource = resource
+      @expected_action = action
+      @block = block if block_given?
+    end
+
+    def matches?(actual_parameters)
+      resource, action, params, headers, options = actual_parameters.shift(5)
+
+      result = true
+      result &&= (resource.to_s == @expected_resource.to_s) unless @expected_resource.nil?
+      result &&= (action.to_s == @expected_action.to_s) unless @expected_action.nil?
+      result &&= @block.call(params) if @block
+      result
+    end
+
+    def mocha_inspect
+      res = @expected_resource.nil? ? 'any_resource' : ":#{@expected_resource}"
+      act = @expected_action.nil? ? 'any_action' : ":#{@expected_action}"
+      blk = @block ? '&block' : '*any_argument'
+      "#{res}, #{act}, #{blk}"
+    end
+  end
+
+  module ExpectationExtensions
+    def method_signature
+      "#{@note}\n  #{super}"
+    end
+
+    def set_note(note)
+      @note = note
+    end
+  end
+
+  def api_expects(resource=nil, action=nil, note=nil, &block)
+    ex = ApipieBindings::API.any_instance.expects(:call)
+    ex.extend(ExpectationExtensions)
+    ex.with(BlockMatcher.new(resource, action, &block))
+    ex.set_note(note)
+    ex
+  end
+
+  def api_expects_no_call
+    ApipieBindings::API.any_instance.expects(:call).never
+  end
+
+  def index_response(items)
+    cnt = items.length
+    {
+      "total" => cnt,
+      "subtotal" => cnt,
+      "page" => 1,
+      "per_page" => cnt,
+      "search" => "",
+      "sort" => {
+        "by" => nil,
+        "order" => nil
+      },
+      "results" => items
+    }
+  end
+end

data/test/functional/command_assertions.rb

@@ -0,0 +1,76 @@
+module CommandAssertions
+
+  class CommandRunResult
+    def initialize(out="", err="", exit_code=0)
+      @out = out
+      @err = err
+      @exit_code = exit_code
+    end
+    attr_accessor :out, :err, :exit_code
+  end
+
+  def run_cmd(options, context={}, cmd_class=HammerCLI::MainCommand)
+    result = CommandRunResult.new
+    result.out, result.err = capture_io do
+      result.exit_code = cmd_class.run('hammer', options, context)
+    end
+    result
+  end
+
+  def exit_code_map
+    return @exit_code_map unless @exit_code_map.nil?
+
+    hammer_exit_codes = HammerCLI.constants.select{|c| c.to_s.start_with?('EX_')}
+    @exit_code_map = hammer_exit_codes.inject({}) do |code_map, code|
+      code_map.update(HammerCLI.const_get(code) => code)
+    end
+  end
+
+  def assert_exit_code_equal(expected_code, actual_code)
+    expected_info = "#{exit_code_map[expected_code]} (#{expected_code})"
+    actual_info = "#{exit_code_map[actual_code]} (#{actual_code})"
+
+    msg = "The exit code was expected to be #{expected_info}, but it was #{actual_info}"
+    assert(expected_code == actual_code, msg)
+  end
+
+  def assert_cmd(expected_result, actual_result)
+    assert_equal expected_result.err, actual_result.err
+    assert_equal expected_result.out, actual_result.out
+    assert_exit_code_equal expected_result.exit_code, actual_result.exit_code
+  end
+
+  def usage_error(command, heading, message)
+    command = (['hammer'] + command).join(' ')
+    ["#{heading}:",
+     "  Error: #{message}",
+     "  ",
+     "  See: '#{command} --help'",
+     ""].join("\n")
+  end
+
+  def common_error(command, heading, message)
+    command = (['hammer'] + command).join(' ')
+    ["#{heading}:",
+     "  Error: #{message}",
+     ""].join("\n")
+  end
+
+  def usage_error_result(command, heading, message)
+    expected_result = CommandRunResult.new
+    expected_result.err = usage_error(command, heading, message)
+    expected_result.exit_code = HammerCLI::EX_USAGE
+    expected_result
+  end
+
+  def common_error_result(command, heading, message)
+    expected_result = CommandRunResult.new
+    expected_result.err = common_error(command, heading, message)
+    expected_result.exit_code = HammerCLI::EX_SOFTWARE
+    expected_result
+  end
+
+  def success_result(message)
+    CommandRunResult.new(message)
+  end
+end

data/test/functional/location_test.rb

@@ -0,0 +1,140 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+
+describe "parameters" do
+
+  let(:param) do
+    {
+      "priority" => nil,
+      "created_at" => "2015-12-03T01:57:55Z",
+      "updated_at" => "2015-12-03T01:57:55Z",
+      "id" => 15,
+      "name" => "B",
+      "value" => "2"
+    }
+  end
+
+  describe "set" do
+
+    before do
+      @cmd = ["location", "set-parameter"]
+    end
+
+    it "should print error on missing --name" do
+      params = ['--value=1']
+
+      expected_result = usage_error_result(
+        @cmd,
+        "Could not set location parameter",
+        "option '--name' is required"
+      )
+
+      api_expects_no_call
+      result = run_cmd(@cmd + params)
+      assert_cmd(expected_result, result)
+    end
+
+    it "should print error on missing --value" do
+      params = ['--name=A']
+
+      expected_result = usage_error_result(
+        @cmd,
+        "Could not set location parameter",
+        "option '--value' is required"
+      )
+
+      api_expects_no_call
+      result = run_cmd(@cmd + params)
+      assert_cmd(expected_result, result)
+    end
+
+
+    it "should create new parameter" do
+      params = ['--name=A', '--value=1', '--location-id=3']
+
+      api_expects(:parameters, :index, 'Attempt find parameters') do |par|
+        par['location_id'].to_i == 3
+      end.returns(index_response([]))
+      api_expects(:parameters, :create, 'Create parameter') do |par|
+        par['parameter']['name'] == 'A' &&
+        par['parameter']['value'] == '1'
+      end.returns({:name => 'A', :value => '1'})
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(success_result("Parameter [A] created with value [1]\n"), result)
+    end
+
+
+    it "should update existing parameter" do
+      params = ['--name=A', '--value=1', '--location-id=3']
+
+      api_expects(:parameters, :index, 'Find parameter') do |par|
+        par['location_id'].to_i == 3
+      end.returns(index_response([param]))
+      api_expects(:parameters, :update, 'Update parameter') do |par|
+        par['id'].to_i == 15 &&
+        par['location_id'].to_i == 3 &&
+        par['parameter']['value'] == '1'
+      end.returns({:name => 'A', :value => '1'})
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(success_result("Parameter [A] updated to value [1]\n"), result)
+    end
+  end
+
+
+  describe "delete" do
+    before do
+      @cmd = ["location", "delete-parameter"]
+    end
+
+    it "should print error on missing --name" do
+      params = []
+
+      expected_result = usage_error_result(
+        @cmd,
+        "Could not delete location parameter",
+        "option '--name' is required"
+      )
+
+      api_expects_no_call
+      result = run_cmd(@cmd + params)
+      assert_cmd(expected_result, result)
+    end
+
+    it "should print error when the parameter doesn't exist" do
+      params = ['--name=A', '--location-id=3']
+
+      api_expects(:parameters, :index, 'Find parameter') do |par|
+        par['location_id'].to_i == 3
+      end.returns(index_response([]))
+
+      expected_result = common_error_result(
+        @cmd,
+        "Could not delete location parameter",
+        "parameter not found"
+      )
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(expected_result, result)
+    end
+
+    it "should delete the parameter" do
+      params = ['--name=A', '--location-id=3']
+
+      api_expects(:parameters, :index, 'Find parameter') do |par|
+        par['location_id'].to_i == 3
+      end.returns(index_response([param]))
+      api_expects(:parameters, :destroy, 'Delete parameter') do |par|
+        par['id'] == param['id']
+      end.returns({:name => 'A', :value => '1'})
+
+      expected_result = success_result(
+        "Parameter [A] deleted\n"
+      )
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(expected_result, result)
+    end
+  end
+end

data/test/functional/organization_test.rb

@@ -0,0 +1,140 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+
+describe "parameters" do
+
+  let(:param) do
+    {
+      "priority" => nil,
+      "created_at" => "2015-12-03T01:57:55Z",
+      "updated_at" => "2015-12-03T01:57:55Z",
+      "id" => 15,
+      "name" => "B",
+      "value" => "2"
+    }
+  end
+
+  describe "set" do
+
+    before do
+      @cmd = ["organization", "set-parameter"]
+    end
+
+    it "should print error on missing --name" do
+      params = ['--value=1']
+
+      expected_result = usage_error_result(
+        @cmd,
+        "Could not set organization parameter",
+        "option '--name' is required"
+      )
+
+      api_expects_no_call
+      result = run_cmd(@cmd + params)
+      assert_cmd(expected_result, result)
+    end
+
+    it "should print error on missing --value" do
+      params = ['--name=A']
+
+      expected_result = usage_error_result(
+        @cmd,
+        "Could not set organization parameter",
+        "option '--value' is required"
+      )
+
+      api_expects_no_call
+      result = run_cmd(@cmd + params)
+      assert_cmd(expected_result, result)
+    end
+
+
+    it "should create new parameter" do
+      params = ['--name=A', '--value=1', '--organization-id=3']
+
+      api_expects(:parameters, :index, 'Attempt find parameters') do |par|
+        par['organization_id'].to_i == 3
+      end.returns(index_response([]))
+      api_expects(:parameters, :create, 'Create parameter') do |par|
+        par['parameter']['name'] == 'A' &&
+        par['parameter']['value'] == '1'
+      end.returns({:name => 'A', :value => '1'})
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(success_result("Parameter [A] created with value [1]\n"), result)
+    end
+
+
+    it "should update existing parameter" do
+      params = ['--name=A', '--value=1', '--organization-id=3']
+
+      api_expects(:parameters, :index, 'Find parameter') do |par|
+        par['organization_id'].to_i == 3
+      end.returns(index_response([param]))
+      api_expects(:parameters, :update, 'Update parameter') do |par|
+        par['id'].to_i == 15 &&
+        par['organization_id'].to_i == 3 &&
+        par['parameter']['value'] == '1'
+      end.returns({:name => 'A', :value => '1'})
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(success_result("Parameter [A] updated to value [1]\n"), result)
+    end
+  end
+
+
+  describe "delete" do
+    before do
+      @cmd = ["organization", "delete-parameter"]
+    end
+
+    it "should print error on missing --name" do
+      params = []
+
+      expected_result = usage_error_result(
+        @cmd,
+        "Could not delete organization parameter",
+        "option '--name' is required"
+      )
+
+      api_expects_no_call
+      result = run_cmd(@cmd + params)
+      assert_cmd(expected_result, result)
+    end
+
+    it "should print error when the parameter doesn't exist" do
+      params = ['--name=A', '--organization-id=3']
+
+      api_expects(:parameters, :index, 'Find parameter') do |par|
+        par['organization_id'].to_i == 3
+      end.returns(index_response([]))
+
+      expected_result = common_error_result(
+        @cmd,
+        "Could not delete organization parameter",
+        "parameter not found"
+      )
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(expected_result, result)
+    end
+
+    it "should delete the parameter" do
+      params = ['--name=A', '--organization-id=3']
+
+      api_expects(:parameters, :index, 'Find parameter') do |par|
+        par['organization_id'].to_i == 3
+      end.returns(index_response([param]))
+      api_expects(:parameters, :destroy, 'Delete parameter') do |par|
+        par['id'] == param['id']
+      end.returns({:name => 'A', :value => '1'})
+
+      expected_result = success_result(
+        "Parameter [A] deleted\n"
+      )
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(expected_result, result)
+    end
+  end
+end

data/test/functional/test_helper.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+require File.join(File.dirname(__FILE__), 'command_assertions')
+require File.join(File.dirname(__FILE__), 'api_expectations')
+
+include CommandAssertions
+include APIExpectations

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+require 'simplecov'
+require 'pathname'
+
+SimpleCov.use_merging true
+SimpleCov.start do
+  command_name 'MiniTest'
+  add_filter 'test'
+end
+SimpleCov.root Pathname.new(File.dirname(__FILE__) + "../../../")
+
+
+require 'minitest/autorun'
+require 'minitest/spec'
+require "minitest-spec-context"
+require "mocha/setup"
+
+require 'hammer_cli'
+require 'hammer_cli_foreman/commands'
+
+FOREMAN_VERSION = Gem::Version.new(ENV['TEST_API_VERSION'] || '1.10')
+
+HammerCLIForeman.stubs(:resource_config).returns({
+  :apidoc_cache_dir => 'test/unit/data/' + FOREMAN_VERSION.to_s,
+  :apidoc_cache_name => 'foreman_api',
+  :dry_run => true})
+
+require 'hammer_cli_foreman'