hammer_cli_foreman 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67582a7a91083bfc42e83382188653feb0f869c311eb99d0471562c2e528c0d4
-  data.tar.gz: aaecc05bc2d6100a135f02fad79d76f89da7ba3520f87ba90566382165abc97b
+  metadata.gz: c478d3535da7a22a10907ad8838baedd0dd1ad9cd3f5168cadab57ef5cc61e53
+  data.tar.gz: d362b8e3e44db4ec092ea2451363be8875cbd1576aaa14e4f8b3652b19ae483f
 SHA512:
-  metadata.gz: 95d9f3c0ad3bf6109f3b7b3abf6879c844db0b6d94991cea9a033400b86aad077b682893b6f1b92227f3470ba926cc6093ee9701d17d527a125c9c23c08597da
-  data.tar.gz: 0d27c46e8c93ca33c3e0c5228a8a9255dea918d5ca49c99bfeedb448394bbc5eac850a77913a8e6a4a161d9470c7946620dc5d6c8521c3607a23925c6f2861fb
+  metadata.gz: 1bebff2d84aacc7ed3053a64920ff86b1420f10d98fc2cfba91a627d69722d5d9866afbf31131c25868ecdf705161ec0401aeaa338f26a5f2f97476664fd1704
+  data.tar.gz: 5dd93dbc8bfff2308ee1768c80ed545dd452278fa0753d2b7016d80ba659741b4c39c1f1b99aa27149e546bc2628b08bcc84419ab5f85cb8ab2ef673952c2581

data/doc/release_notes.md

@@ -1,18 +1,19 @@
 Release notes
 =============
-### 2.1.3 (2020-09-04)
-* Use underscores in `login oauth` option values ([PR #536](https://github.com/theforeman/hammer-cli-foreman/pull/536)) ([PR #538](https://github.com/theforeman/hammer-cli-foreman/pull/538)), [#30720](http://projects.theforeman.org/issues/30720)
-
-### 2.1.2 (2020-07-14)
+### 2.2.0 (2020-08-11)
 * Change config templates to provisioning templates ([PR #531](https://github.com/theforeman/hammer-cli-foreman/pull/531)), [#29971](http://projects.theforeman.org/issues/29971)
+* Fix minitest deprecation ([PR #523](https://github.com/theforeman/hammer-cli-foreman/pull/523))
+* Add a coverage test ([PR #522](https://github.com/theforeman/hammer-cli-foreman/pull/522))
 * Return 'set current context for request' to help ([PR #530](https://github.com/theforeman/hammer-cli-foreman/pull/530)), [#30182](http://projects.theforeman.org/issues/30182)
-* Display request uuid for audit ([PR #528](https://github.com/theforeman/hammer-cli-foreman/pull/528)) ([PR #529](https://github.com/theforeman/hammer-cli-foreman/pull/529)), [#30130](http://projects.theforeman.org/issues/30130)
-
-### 2.1.1 (2020-05-29)
+* Display request uuid for audit ([PR #528](https://github.com/theforeman/hammer-cli-foreman/pull/528)), [#30130](http://projects.theforeman.org/issues/30130)
+* Use parent resource instead of hardcoded one ([PR #527](https://github.com/theforeman/hammer-cli-foreman/pull/527)), [#30125](http://projects.theforeman.org/issues/30125)
+* Added missing tests to realm command ([PR #526](https://github.com/theforeman/hammer-cli-foreman/pull/526)), [#30096](http://projects.theforeman.org/issues/30096)
+* Added missing tests to trend test ([PR #525](https://github.com/theforeman/hammer-cli-foreman/pull/525)), [#30070](http://projects.theforeman.org/issues/30070)
 * Revert "skip one test on ruby 2.7" ([PR #520](https://github.com/theforeman/hammer-cli-foreman/pull/520)), [#28601](http://projects.theforeman.org/issues/28601)
 * Eliminate auth_type from sessions file ([PR #521](https://github.com/theforeman/hammer-cli-foreman/pull/521)), [#29876](http://projects.theforeman.org/issues/29876)
 * Add disable option for user ([PR #497](https://github.com/theforeman/hammer-cli-foreman/pull/497)), [#28973](http://projects.theforeman.org/issues/28973)
 * Added manage command to user mail notifications ([PR #513](https://github.com/theforeman/hammer-cli-foreman/pull/513)), [#7665](http://projects.theforeman.org/issues/7665)
+* Bump to 2.2.0-develop
 
 ### 2.1.0 (2020-05-14)
 * Bump hammer_cli to 2.1.0 ([PR #519](https://github.com/theforeman/hammer-cli-foreman/pull/519))

data/doc/testing.md

@@ -131,3 +131,16 @@ connection = api_connection
 api = APIExpectationsDecorator.new(connection.api)
 api.expects_search(:users, 'login=admin')
 ```
+## Checking the coverage against the API
+You can check how many API endpoints are covered by Hammer, this test runs all hammer tests,
+and check which API actions run, therefore there could be two reasons for an endpoint to not be covered:
+1. there is no test for this action
+2. there is no hammer command for the API endpoint.
+### running the coverage test
+```bash
+
+rake test TESTOPTS="-c"
+
+TEST_API_VERSION=2.0 rake test TESTOPTS="-c"
+
+```

data/lib/hammer_cli_foreman/associating_commands.rb

@@ -244,8 +244,7 @@ module HammerCLIForeman
 
         def request_params
           params = super
-
-          template_ids = params['operatingsystem']['provisioning_template_ids']
+          template_ids = params[resource.singular_name]['provisioning_template_ids']
           if options['option_provisioning_template_search']
             templates = HammerCLIForeman.collection_to_common_format(
               associated_resource.call(
@@ -259,7 +258,7 @@ module HammerCLIForeman
               template_ids << template_id.to_s
             end
           end
-          params['operatingsystem']['provisioning_template_ids'] = template_ids.uniq
+          params[resource.singular_name]['provisioning_template_ids'] = template_ids.uniq
           params
         end
 

data/lib/hammer_cli_foreman/auth.rb

@@ -36,11 +36,11 @@ module HammerCLIForeman
 
         option ["-u", "--username"], "USERNAME", _("Username to access the remote system")
         option ["-p", "--password"], "PASSWORD", _("Password to access the remote system")
-        option ["-t", "--oidc-token-endpoint"], "OPENIDC_TOKEN_ENDPOINT", _("Openidc provider URL which issues access token")
-        option ["-a", "--oidc-authorization-endpoint"], "OPENIDC_AUTHORIZATION_ENDPOINT", _("Openidc provider URL which issues authentication code (two factor only)")
-        option ["-c", "--oidc-client-id"], "OPENIDC_CLIENT_ID", _("Client id used in the Openidc provider")
+        option ["-t", "--oidc-token-endpoint"], "OPENIDC-TOKEN-ENDPOINT", _("Openidc provider URL which issues access token")
+        option ["-a", "--oidc-authorization-endpoint"], "OPENIDC-AUTHORIZATION-ENDPOINT", _("Openidc provider URL which issues authentication code (two factor only)")
+        option ["-c", "--oidc-client-id"], "OPENIDC-CLIENT-ID", _("Client id used in the Openidc provider")
         option ["-f", "--two-factor"], :flag, _("Authenticate with two factor")
-        option ["-r", "--oidc-redirect-uri"], "OPENIDC_REDIRECT_URI", _("Redirect URI for the authentication code grant flow")
+        option ["-r", "--oidc-redirect-uri"], "OPENIDC-REDIRECT-URI", _("Redirect URI for the authentication code grant flow")
 
         def execute
           if option_two_factor?

data/lib/hammer_cli_foreman/output/fields.rb

@@ -19,7 +19,7 @@ module Fields
 
     def id_detail
       {
-        :label => _('id'),
+        :label => {:target => _('id')},
         :structured_label => _('Id'),
         :key => @options[:id_key] || :id,
         :id => true

data/lib/hammer_cli_foreman/output/formatters.rb

@@ -35,7 +35,7 @@ module HammerCLIForeman::Output
           if detail.is_a?(Hash)
             next if detail[:id] && !show_ids
             if detail[:label]
-              "#{detail[:label]}: #{get_value(data, detail[:key])}"
+              "#{detail[:label][:target]}: #{get_value(data, detail[:key])}"
             else
               get_value(data, detail[:key])
             end

data/lib/hammer_cli_foreman/testing/api_expectations.rb

@@ -1,6 +1,11 @@
 module HammerCLIForeman
   module Testing
     module APIExpectations
+
+      def self.api_calls
+        @api_calls ||= []
+      end
+
       class APICallMatcher < Mocha::ParameterMatchers::Base
         attr_accessor :expected_params, :expected_resource, :expected_action, :block
 
@@ -160,7 +165,12 @@ module HammerCLIForeman
         }.merge(options))
       end
 
+      def api_calls
+        HammerCLIForeman::Testing::APIExpectations.api_calls
+      end
+
       def api_expects(resource=nil, action=nil, note=nil, &block)
+        api_calls << [resource, action]
         APIExpectationsDecorator.new.expects_call(resource, action, note, &block)
       end
 

data/lib/hammer_cli_foreman/version.rb

@@ -1,5 +1,5 @@
 module HammerCLIForeman
   def self.version
-    @version ||= Gem::Version.new "2.1.3"
+    @version ||= Gem::Version.new "2.2.0"
   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/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/host_test.rb

@@ -428,7 +428,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 +437,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 +462,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

data/test/functional/realm_test.rb

@@ -0,0 +1,104 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe 'realm' do
+  describe 'list' do
+    before do
+      @cmd = %w[realm list]
+      @realms =
+        [{
+           id: 1,
+           name: 'test-realm' }]
+    end
+
+    it 'should return a list of realms' do
+      api_expects(:realms, :index, 'List realms').returns(@realms)
+
+      result = run_cmd(@cmd)
+      _(result.exit_code).must_equal HammerCLI::EX_OK
+    end
+  end
+
+  describe 'info' do
+    before do
+      @cmd = %w[realm info]
+      @realm = {
+          id: 1,
+          name: 'test-realm'
+      }
+    end
+
+    it 'should return a realm' do
+      params = ['--id=1']
+      api_expects(:realms, :show, 'Show realm').returns(@realm)
+
+      result = run_cmd(@cmd + params)
+      _(result.exit_code).must_equal HammerCLI::EX_OK
+    end
+  end
+
+  describe 'create' do
+    before do
+      @cmd = %w[realm create]
+    end
+
+    it 'should print error on missing --name, --realm-proxy-id, --realm-type' do
+      expected_result = "Could not create the realm:\n  Missing arguments for '--name', '--realm-proxy-id', '--realm-type'.\n"
+
+      api_expects_no_call
+      result = run_cmd(@cmd)
+      assert_match(expected_result, result.err)
+    end
+
+    it 'should create a realm' do
+      params = %w[--name=test-realm --realm-proxy-id=12345 --realm-type=FreeIPA]
+
+      api_expects(:realms, :create, 'Create a realm') do |params|
+        (params['realm']['name'] == 'test-realm' &&
+         params['realm']['realm_proxy_id'] == 12345 &&
+         params['realm']['realm_type'] == 'FreeIPA')
+      end
+
+      result = run_cmd(@cmd + params)
+
+      assert_cmd(success_result("Realm [%{name}] created.\n"), result)
+    end
+  end
+
+  describe 'delete' do
+    before do
+      @cmd = %w[realm delete]
+    end
+
+    it 'should delete a realm' do
+      params = ['--id=1']
+
+      api_expects(:realms, :destroy, 'Delete realm').with_params(id: '1')
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(success_result("Realm [%{name}] deleted.\n"), result)
+    end
+  end
+
+  describe 'update' do
+    before do
+      @cmd = %w[realm update]
+      @realm = {
+        id: 1,
+        name: 'test-realm-update'
+      }
+    end
+
+    it 'should update a realm' do
+      params = %w[--id=1 --new-name=test-realm-update]
+
+      api_expects(:realms, :update, 'Update a realm') do |params|
+        (params['id'] == '1' &&
+         params['name'] == 'test-realm-update')
+      end
+
+      result = run_cmd(@cmd + params)
+      assert_cmd(success_result("Realm [%{name}] updated.\n"), result)
+    end
+  end
+end
+