hammer_cli_foreman 2.1.1 → 2.3.1

data/lib/hammer_cli_foreman/version.rb

@@ -1,5 +1,5 @@
 module HammerCLIForeman
   def self.version
-    @version ||= Gem::Version.new "2.1.1"
+    @version ||= Gem::Version.new "2.3.1"
   end
 end

data/lib/minitest/coverage_reporter.rb

@@ -0,0 +1,94 @@
+require "json"
+
+module Minitest
+  class CoverageRunner
+
+    RESOURCE_BLACK_LIST = ['tasks','home','config_groups','statistics','table_preferences','autosign','puppet_hosts']
+    attr_reader :raw_data, :api_endpoints, :covered_resources, :uncovered_resources, :partially_covered_resources
+    def initialize(file_path)
+      @raw_data = JSON.load(File.open(file_path))
+      @api_endpoints = {}
+      @covered_resources = []
+      @uncovered_resources = []
+      @partially_covered_resources = {}
+    end
+
+    def filtered_endpoints(covered)
+      api_endpoints.select { |_k, v| v == covered }.keys
+    end
+
+    def get_endpoints_by_resource(endpoints)
+      endpoints_by_resource = {}
+      endpoints.each do |url|
+        resource,action = url.split("/")
+        endpoints_by_resource[resource] ||= []
+        endpoints_by_resource[resource] << action
+      end
+      endpoints_by_resource
+    end
+
+    def uncovered_endpoints_by_resource
+      get_endpoints_by_resource(filtered_endpoints(false))
+    end
+
+    def covered_endpoints_by_resource
+      get_endpoints_by_resource(filtered_endpoints(true))
+    end
+
+    def get_coverage
+      get_endpoints_by_resource(api_endpoints.keys).each do |resource, actions|
+        if covered_endpoints_by_resource[resource] == actions
+          @covered_resources << resource
+        elsif uncovered_endpoints_by_resource[resource] == actions
+          @uncovered_resources << resource
+        else
+          @partially_covered_resources[resource] = uncovered_endpoints_by_resource[resource]
+        end
+      end
+    end
+
+    def endpoints_percentage(endpoints)
+      "#{(endpoints.count / api_endpoints.count.to_f * 100 ).to_i}%"
+    end
+
+    def uncovered_endpoints_percentage
+      endpoints_percentage(filtered_endpoints(false))
+    end
+
+    def covered_endpoints_percentage
+      endpoints_percentage(filtered_endpoints(true))
+    end
+
+    def run_tests
+      raw_data["docs"]["resources"].each do |resource|
+        resource[1]["methods"].each do | method |
+          @api_endpoints[method["doc_url"].delete_prefix!("../apidoc/v2/")] = false
+        end unless RESOURCE_BLACK_LIST.include? resource[0]
+      end
+      HammerCLIForeman::Testing::APIExpectations.api_calls.each do |api_call|
+        resource, action = api_call
+          url = "#{resource}/#{action}"
+          @api_endpoints[url] =  true
+      end
+      get_coverage
+      output_coverage
+    end
+
+    def color(str, code)
+      puts "\e[#{code}m#{str}\e[0m"
+    end
+
+    def output_coverage
+      covered_resources
+      color("COVERED RESOURCES" , 32)
+      puts covered_resources
+      color("NOT COVERED AT ALL", 31)
+      puts uncovered_resources
+      color("PARTIALLY COVERED RESOURCES", 33)
+      partially_covered_resources.each do |resource, endpoints|
+        puts "#{resource}: #{endpoints.join(' ')}"
+      end
+      color("covered endpoints #{covered_endpoints_percentage} uncovered endpoints #{uncovered_endpoints_percentage}", 35)
+    end
+  end
+end

data/lib/minitest/hammer_coverage_plugin.rb

@@ -0,0 +1,19 @@
+require 'coverage_reporter'
+require "json"
+
+module Minitest
+  def self.plugin_hammer_coverage_options(opts, options)
+    opts.on "-c", "--coverage", "Generate coverage reports for API endpoints" do
+      options[:coverage] = true
+    end
+  end
+
+  def self.plugin_hammer_coverage_init(options)
+    if options[:coverage]
+      Minitest.reporter.reporters.clear
+      Minitest.after_run do
+          Minitest::CoverageRunner.new("test/data/#{ FOREMAN_VERSION }/foreman_api.json").run_tests
+      end
+    end
+  end
+end

data/test/functional/audit_test.rb

@@ -1,28 +1,28 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
 describe 'audit' do
-  describe 'audit-list' do
+  before do
+    @audit_changed = {
+      'id' => 83,
+      'created_at' => "2017-10-31 11:25:44 UTC",
+      'remote_address' => '::1',
+      'user_name' => "foreman_api_admin",
+      'user_id' => 11,
+      'action' => "update",
+      'auditable_type' => "ProvisioningTemplate",
+      'auditable_name' => "default_location_subscribed_hosts",
+      'auditable_id' => 32,
+      'audited_changes' => {
+        'value' => [
+          nil,
+          "--- false\n..."
+        ]
+      }
+    }
+  end
+  describe 'audit-info' do
     let (:cmd) { ['audit', 'info'] }
     let(:params) { ['--id=83'] }
-    let(:audit_changed) do
-      {
-        'id' => 83,
-        'created_at' => "2017-10-31 11:25:44 UTC",
-        'remote_address' => '::1',
-        'user_name' => "foreman_api_admin",
-        'user_id' => 11,
-        'action' => "update",
-        'auditable_type' => "ProvisioningTemplate",
-        'auditable_name' => "default_location_subscribed_hosts",
-        'auditable_id' => 32,
-        'audited_changes' => {
-          'value' => [
-            nil,
-            "--- false\n..."
-          ]
-        }
-      }
-    end
     let(:audit_new) do
       {
         "user_id" => 1,
@@ -62,24 +62,26 @@ describe 'audit' do
     it 'shows audit information for changed records' do
       api_expects(:audits, :show, 'info')
         .with_params('id' => '83')
-        .returns(audit_changed)
+        .returns(@audit_changed)
 
-      output = OutputMatcher.new([
-        'Id:              83',
-        'At:              2017/10/31 11:25:44',
-        'IP:              ::1',
-        'User:            foreman_api_admin',
-        'Action:          update',
-        'Audit type:      ProvisioningTemplate',
-        'Audit record:    default_location_subscribed_hosts',
-        'Audited changes:',
-        ' 1) Attribute: value',
-        '    Old:',
-        '',
-        '    New:',
-        '      --- false',
-        '      ...',
-      ])
+      output = OutputMatcher.new(
+        [
+          'Id:              83',
+          'At:              2017/10/31 11:25:44',
+          'IP:              ::1',
+          'User:            foreman_api_admin',
+          'Action:          update',
+          'Audit type:      ProvisioningTemplate',
+          'Audit record:    default_location_subscribed_hosts',
+          'Audited changes:',
+          ' 1) Attribute: value',
+          '    Old:',
+          '',
+          '    New:',
+          '      --- false',
+          '      ...',
+        ]
+      )
       expected_result = success_result(output)
 
       result = run_cmd(cmd + params)
@@ -91,36 +93,57 @@ describe 'audit' do
         .with_params('id' => '83')
         .returns(audit_new)
 
-      output = OutputMatcher.new([
-        'Id:              63',
-        'At:              2017/10/09 23:42:44',
-        'IP:              ::1',
-        'User:            foreman_admin',
-        'Action:          create',
-        'Audit type:      User',
-        'Audit record:    John Doe',
-        'Audited changes:',
-        ' 1) Attribute: login',
-        '    Value:     john',
-        ' 2) Attribute: firstname',
-        '    Value:     John',
-        ' 3) Attribute: lastname',
-        '    Value:     Doe',
-        ' 4) Attribute: mail',
-        '    Value:     john@ipa.test',
-        ' 5) Attribute: admin',
-        '    Value:     false',
-        ' 6) Attribute: auth_source_id',
-        '    Value:     3',
-        ' 7) Attribute: lower_login',
-        '    Value:     john',
-        ' 8) Attribute: mail_enabled',
-        '    Value:     true',
-      ])
+      output = OutputMatcher.new(
+        [
+          'Id:              63',
+          'At:              2017/10/09 23:42:44',
+          'IP:              ::1',
+          'User:            foreman_admin',
+          'Action:          create',
+          'Audit type:      User',
+          'Audit record:    John Doe',
+          'Audited changes:',
+          ' 1) Attribute: login',
+          '    Value:     john',
+          ' 2) Attribute: firstname',
+          '    Value:     John',
+          ' 3) Attribute: lastname',
+          '    Value:     Doe',
+          ' 4) Attribute: mail',
+          '    Value:     john@ipa.test',
+          ' 5) Attribute: admin',
+          '    Value:     false',
+          ' 6) Attribute: auth_source_id',
+          '    Value:     3',
+          ' 7) Attribute: lower_login',
+          '    Value:     john',
+          ' 8) Attribute: mail_enabled',
+          '    Value:     true',
+        ]
+      )
       expected_result = success_result(output)
 
       result = run_cmd(cmd + params)
       assert_cmd(expected_result, result)
     end
   end
+
+  describe 'audit-list' do
+    let(:cmd) { ['audit', 'list'] }
+    let(:audits) do
+      [@audit_changed]
+    end
+
+    it "should show index list" do
+      api_expects(:audits, :index).returns(audits)
+
+      output = IndexMatcher.new([
+                                  ['ID', 'AT', 'IP', 'USER', 'ACTION', 'AUDIT TYPE', 'AUDIT RECORD'],
+                                  ['83', '2017/10/31 11:25:44', '::1', 'foreman_api_admin', 'update', 'ProvisioningTemplate', 'default_location_subscribed_hosts']
+                                ])
+
+      result = run_cmd(cmd)
+      assert_cmd(success_result(output), result)
+    end
+  end
 end

data/test/functional/commands/list_test.rb

@@ -39,12 +39,12 @@ describe HammerCLIForeman::ListCommand do
 
     it 'shows search fields in help' do
       result = run_cmd(cmd + params)
-      result.out.must_match(/.*Search \/ Order fields:\s+(\S+\s+\S+)*\s+name\s+string/)
+      _(result.out).must_match(/.*Search \/ Order fields:\s+(\S+\s+\S+)*\s+name\s+string/)
     end
 
     it 'formats enum values' do
       result = run_cmd(cmd + params)
-      result.out.must_match(/.*Search \/ Order fields:\s+(\S+\s+\S+)*\s+managed\s+Values: true, false/)
+      _(result.out).must_match(/.*Search \/ Order fields:\s+(\S+\s+\S+)*\s+managed\s+Values: true, false/)
     end
   end
 
@@ -53,7 +53,7 @@ describe HammerCLIForeman::ListCommand do
       it "fetches only first page when there's not enough records" do
         expect_paged_call(1, 1000, 10)
         result = run_cmd([], {}, TestList)
-        result.exit_code.must_equal HammerCLI::EX_OK
+        _(result.exit_code).must_equal HammerCLI::EX_OK
       end
 
       it "fetches all records" do
@@ -62,27 +62,27 @@ describe HammerCLIForeman::ListCommand do
         expect_paged_call(3, per_page_all, 10)
 
         result = run_cmd([], {}, TestList)
-        result.exit_code.must_equal HammerCLI::EX_OK
+        _(result.exit_code).must_equal HammerCLI::EX_OK
       end
 
       it "uses --per-page value" do
         per_page = 10
         expect_paged_call(1, per_page, 10)
         result = run_cmd(["--per-page=#{per_page}"], {}, TestList)
-        result.exit_code.must_equal HammerCLI::EX_OK
+        _(result.exit_code).must_equal HammerCLI::EX_OK
       end
 
       it "uses both --per-page and --page value" do
         per_page = 10
         expect_paged_call(2, per_page, 10)
         result = run_cmd(["--per-page=#{per_page}", '--page=2'], {}, TestList)
-        result.exit_code.must_equal HammerCLI::EX_OK
+        _(result.exit_code).must_equal HammerCLI::EX_OK
       end
 
       it "sets per_page to 20 when only --page is used" do
         expect_paged_call(2, 20, 10)
         result = run_cmd(['--page=2'], {}, TestList)
-        result.exit_code.must_equal HammerCLI::EX_OK
+        _(result.exit_code).must_equal HammerCLI::EX_OK
       end
     end
 
@@ -96,20 +96,20 @@ describe HammerCLIForeman::ListCommand do
         per_page = 10
         expect_paged_call(1, per_page, 10)
         result = run_cmd(["--per-page=#{per_page}"], {}, TestList)
-        result.exit_code.must_equal HammerCLI::EX_OK
+        _(result.exit_code).must_equal HammerCLI::EX_OK
       end
 
       it "respects per_page setting when the adapter allows pagination by default" do
         expect_paged_call(1, per_page_in_settings, 30)
         result = run_cmd([], { :adapter => :base, :interactive => false }, TestList)
-        result.exit_code.must_equal HammerCLI::EX_OK
+        _(result.exit_code).must_equal HammerCLI::EX_OK
       end
 
       it "fetches all records when the adapter doesn't allow pagination by default" do
         expect_paged_call(1, per_page_all, 1000)
         expect_paged_call(2, per_page_all, 10)
         result = run_cmd([], { :adapter => :csv, :interactive => false }, TestList)
-        result.exit_code.must_equal HammerCLI::EX_OK
+        _(result.exit_code).must_equal HammerCLI::EX_OK
       end
     end
   end
@@ -128,7 +128,7 @@ describe HammerCLIForeman::ListCommand do
 
       result = run_cmd([], {}, TestListWithOutput)
       assert_cmd(expected_result, result)
-      result.out.wont_match pagination_line_re
+      _(result.out).wont_match pagination_line_re
     end
 
     it 'prints one page when --per-page is used' do

data/test/functional/compute_profile_test.rb

@@ -33,8 +33,10 @@ describe "parameters" do
           }
     end
     it 'update compute profile name' do
-      params = ['--id=1' ,'--new-name=profile2']
-      api_expects(:compute_profiles, :update, 'Update the compute profile').with_params({"name" =>"profile2"}).returns(@compute_profile)
+      params = ['--id=1', '--new-name=profile2']
+      api_expects(:compute_profiles, :update, 'Update the compute profile').with_params(
+        { 'compute_profile' => { 'name' => 'profile2' } }
+      ).returns(@compute_profile)
       result = run_cmd(@cmd + params)
       assert_cmd(success_result("Compute profile updated.\n"), result)
     end

data/test/functional/host_test.rb

@@ -315,6 +315,26 @@ describe 'host update' do
     }
   end
 
+  it 'updates with passed options only' do
+    params = ['--new-name=new-name']
+    expected_result = success_result("Host updated.\n")
+
+    api_expects(:hosts, :update, 'Update host name only').with_params(
+      'id' => '1', 'organization_id' => 1, 'location_id' => 1,
+      'host' => { 'name' => 'new-name' }
+    ).returns(
+      {
+        'id' => '1',
+        'name' => 'new-name',
+        'organization_id' => '1',
+        'location_id' => '1'
+      }
+    )
+
+    result = run_cmd(cmd + minimal_params + params)
+    assert_cmd(expected_result, result)
+  end
+
   it 'ensures helper methods are invoked' do
     params = ['--image-id=1']
     expected_result = success_result("Host updated.\n")
@@ -350,12 +370,9 @@ describe 'host update' do
     )
     api_expects(:hosts, :update, 'Update host with new org').with_params(
       'id' => '1', 'location_id' => 1, 'organization_id' => 1, 'host' => {
-        'organization_id' => '5', 'compute_attributes' => {}
-      }
+        'organization_id' => '5' }
     ) do |par|
-      par['id'] == '1' &&
-        par['host']['organization_id'] == '5' &&
-        par['host']['compute_attributes'] == {}
+      par['id'] == '1' && par['host']['organization_id'] == '5'
     end.returns(updated_host)
 
     expected_result = success_result("Host updated.\n")
@@ -373,12 +390,9 @@ describe 'host update' do
     )
     api_expects(:hosts, :update, 'Update host with new loc').with_params(
       'id' => '1', 'location_id' => 1, 'organization_id' => 1, 'host' => {
-        'location_id' => '5', 'compute_attributes' => {}
-      }
+        'location_id' => '5' }
     ) do |par|
-      par['id'] == '1' &&
-        par['host']['location_id'] == '5' &&
-        par['host']['compute_attributes'] == {}
+      par['id'] == '1' && par['host']['location_id'] == '5'
     end.returns(updated_host)
 
     expected_result = success_result("Host updated.\n")
@@ -396,12 +410,9 @@ describe 'host update' do
     )
     api_expects(:hosts, :update, 'Update host with new owner').with_params(
         'id' => '1', 'location_id' => 1, 'organization_id' => 1, 'host' => {
-        'owner_id' => '1', 'compute_attributes' => {}
-    }
+        'owner_id' => '1' }
     ) do |par|
-      par['id'] == '1' &&
-          par['host']['owner_id'] == '1' &&
-          par['host']['compute_attributes'] == {}
+      par['id'] == '1' && par['host']['owner_id'] == '1'
     end.returns(updated_host)
 
     expected_result = success_result("Host updated.\n")
@@ -428,7 +439,7 @@ describe 'host config reports' do
     end.returns(index_response([report15]))
 
     result = run_cmd(['host', 'config-reports', '--id=1'])
-    result.exit_code.must_equal HammerCLI::EX_OK
+    _(result.exit_code).must_equal HammerCLI::EX_OK
   end
 
   it 'filters reports by --name' do
@@ -437,7 +448,7 @@ describe 'host config reports' do
     end.returns(index_response([report15]))
 
     result = run_cmd(['host', 'config-reports', '--name=host.example.com'])
-    result.exit_code.must_equal HammerCLI::EX_OK
+    _(result.exit_code).must_equal HammerCLI::EX_OK
   end
 
   it 'prints error or missing --id and --name' do
@@ -462,7 +473,7 @@ describe 'host config reports' do
     end.returns(index_response([report15]))
 
     result = run_cmd(['host', 'config-reports', '--name=host.example.com', '--search=reported > "2 hour ago"'])
-    result.exit_code.must_equal HammerCLI::EX_OK
+    _(result.exit_code).must_equal HammerCLI::EX_OK
   end
 end
 describe 'disassociate host from vm' do
@@ -491,3 +502,17 @@ describe 'disassociate host from vm' do
     assert_cmd(expected_result, result)
   end
 end
+
+describe 'run puppetrun for host' do
+  let(:cmd) { ['host', 'puppetrun'] }
+  let(:params) { ['--id=1'] }
+
+  it "does nothing for puppetrun" do
+    expected_result = CommandExpectation.new
+    expected_result.expected_err = "The puppetrun feature has been removed, however you can use the Remote Execution Plugin to run Puppet commands\n"
+    expected_result.expected_exit_code = HammerCLI::EX_SOFTWARE
+
+    result = run_cmd(cmd)
+    assert_cmd(expected_result, result)
+  end
+end