hammer_cli_foreman_host_reports 0.1.0

data/test/data/README.md

@@ -0,0 +1,26 @@
+# Data for tests
+
+## How to include API tests for new Foreman release
+ 1. on the **Foreman instance** run the tests with recording of examples turned on
+
+    ```bash
+    $ APIPIE_RECORD=examples bundle exec rake test:functionals
+    ```
+ 1. on the **Foreman instance** generate API documentation cache. It will land in `/usr/share/foreman/public/apipie-cache/apidoc/v2.en.json`
+
+    ```bash
+    $ FOREMAN_APIPIE_LANGS=en foreman-rake apipie:cache
+    ```
+ 1. when running from **git**, run a similar command and it will land in `$FOREMAN_CHECKOUT/public/apipie-cache/apidoc/v2.en.json`
+
+    ```bash
+    $ FOREMAN_APIPIE_LANGS=en bundle exec rake apipie:cache
+    ```
+ 1. in **hammer-cli-foreman** in `test/data/` Create directory with name matching the Foreman version in `test/data/` (e.g. `test/data/3.2`)
+ 1. copy the API cache from the Foreman instance into the newly created directory and name it as `foreman_api.json`
+ 1. update the following line in `test/test_helper.rb` to match the new default Foreman version
+
+    ```ruby
+    FOREMAN_VERSION = Gem::Version.new(ENV['TEST_API_VERSION'] || '3.2')
+    ```
+ 1. make sure the tests are green

data/test/functional/apipie_resource_mock.rb

@@ -0,0 +1,309 @@
+module ResourceMocks
+
+  def self.mock_action_call(resource, action, value, params=:default)
+    response = ApipieBindings::Example.new('GET', '/', '', 200, JSON.dump(value))
+    @mocks ||= {}
+    @mocks[[resource, action]] ||= {}
+    @mocks[[resource, action]][params] = response
+    ApipieBindings::API.any_instance.stubs(:fake_responses).returns(@mocks)
+  end
+
+  def self.clear_mocks
+    @mocks = {}
+    ApipieBindings::API.any_instance.stubs(:fake_responses).returns(@mocks)
+  end
+
+  def self.mock_action_calls(*calls)
+    calls.each do |(resource, action, value, params)|
+      mock_action_call(resource, action, value, (params || :default))
+    end
+  end
+
+  def self.smart_variables_index
+    ResourceMocks.mock_action_call(:smart_variables, :index,
+      { "results" => [ { 'variable' => 'var', 'id' => '1'} ] })
+  end
+
+  def self.smart_variables_show
+    ResourceMocks.mock_action_call(:smart_variables, :show, { "id" => 1, "override_value_order" => "fqdn" })
+  end
+
+  def self.compute_resources_available_images
+    ResourceMocks.mock_action_call(:compute_resources, :available_images, [])
+  end
+
+  def self.compute_resources_available_networks
+    ResourceMocks.mock_action_call(:compute_resources, :available_networks, [])
+  end
+
+  def self.compute_resources_available_clusters
+    ResourceMocks.mock_action_call(:compute_resources, :available_clusters, [])
+  end
+
+  def self.organizations_index
+    ResourceMocks.mock_action_call(:organizations, :index, {
+     "results" => [
+        {
+                 "label" => "Default_Organization",
+                    "id" => 1,
+                  "name" => "Default_Organization",
+                 "title" => "Default_Organization"
+        }
+      ]})
+  end
+
+  def self.users_show
+    ResourceMocks.mock_action_call(:users, :show, {
+      "firstname" => "Admin",
+      "lastname" => "User",
+      "mail" => "root@example.com",
+      "admin" => true,
+      "auth_source_id" => 1,
+      "auth_source_name" => "Internal",
+      "timezone" => nil,
+      "locale" => nil,
+      "last_login_on" => "2016-12-20 17:30:13 UTC",
+      "created_at" => "2016-10-24 08:11:24 UTC",
+      "updated_at" => "2016-10-24 08:11:38 UTC",
+      "id" => 3,
+      "login" => "admin",
+      "description" => nil,
+      "default_location" => nil,
+      "locations" => [],
+      "default_organization" => {
+        "id" => 1,
+        "name" => "Default Organization",
+        "title" => "Default Organization",
+        "description" => nil
+      },
+      "organizations" => [],
+      "effective_admin" => true,
+      "cached_usergroups" => [],
+      "auth_source_internal" => {
+        "id" => 1,
+        "type" => "AuthSourceInternal",
+        "name" => "Internal"
+      },
+      "mail_notifications" => [],
+      "roles" => [{
+        "name" => "Default role",
+        "id" => 9,
+        "description" => nil
+      }],
+      "usergroups" => []
+    })
+  end
+
+  def self.hosts_show
+    ResourceMocks.mock_action_call(:hosts, :show, {
+      "ip" => "192.168.122.51",
+      "ip6" => nil,
+      "last_report" => "2016-10-24 12:06:31 UTC",
+      "mac" => "52:54:00:ce:b2:b9",
+      "realm_id" => nil,
+      "realm_name" => nil,
+      "sp_mac" => nil,
+      "sp_ip" => nil,
+      "sp_name" => nil,
+      "domain_id" => 1,
+      "domain_name" => "tstrachota.usersys.redhat.com",
+      "architecture_id" => 1,
+      "architecture_name" => "x86_64",
+      "operatingsystem_id" => 1,
+      "operatingsystem_name" => "CentOS 7.2.1511",
+      "build" => false,
+      "model_id" => 1,
+      "hostgroup_id" => nil,
+      "owner_id" => nil,
+      "owner_type" => nil,
+      "enabled" => true,
+      "managed" => false,
+      "use_image" => nil,
+      "image_file" => "",
+      "uuid" => nil,
+      "compute_resource_id" => nil,
+      "compute_resource_name" => nil,
+      "compute_profile_id" => nil,
+      "compute_profile_name" => nil,
+      "capabilities" => ["build"],
+      "provision_method" => "build",
+      "certname" => "foreman.example.com",
+      "image_id" => nil,
+      "image_name" => nil,
+      "created_at" => "2016-10-24 08:36:43 UTC",
+      "updated_at" => "2016-10-24 12:06:46 UTC",
+      "last_compile" => "2016-10-24 12:06:41 UTC",
+      "global_status" => 0,
+      "global_status_label" => "Warning",
+      "organization_id" => nil,
+      "organization_name" => nil,
+      "location_id" => nil,
+      "location_name" => nil,
+      "model_name" => "KVM",
+      "configuration_status" => 0,
+      "configuration_status_label" => "No reports",
+      "name" => "foreman.example.com",
+      "id" => 1,
+      "hostgroup_name" => nil,
+      "hostgroup_title" => nil,
+      "parameters" => [],
+      "all_parameters" => [],
+      "interfaces" => [{
+        "id" => 1,
+        "name" => "foreman.example.com",
+        "ip" => "192.168.122.51",
+        "mac" => "52:54:00:ce:b2:b9",
+        "identifier" => "eth0",
+        "primary" => true,
+        "provision" => true,
+        "type" => "interface"
+      },
+      {
+        "id" => 2,
+        "name" => nil,
+        "ip" => "10.34.130.105",
+        "mac" => "52:54:00:f5:1b:57",
+        "identifier" => "eth1",
+        "primary" => false,
+        "provision" => false,
+        "type" => "interface"
+      }]
+    })
+  end
+
+
+  def self.organizations_show
+    ResourceMocks.mock_action_calls(
+      [:organizations, :index, [{ "id" => 2, "name" => "ACME" }]],
+      [:organizations, :show, { "id" => 2, "name" => "ACME" }]
+      )
+  end
+
+  def self.locations_index
+    ResourceMocks.mock_action_call(:locations, :index, {
+      "results" => [
+        {
+              "ancestry" => nil,
+            "created_at" => "2014-07-17T17:21:49+02:00",
+            "updated_at" => "2015-06-17T13:18:10+02:00",
+                    "id" => 2,
+                  "name" => "Default_Location",
+                 "title" => "Default_Location"
+        }
+      ]})
+  end
+
+  def self.locations_show
+    ResourceMocks.mock_action_calls(
+      [:locations, :index, [{ "id" => 2, "name" => "Rack" }]],
+      [:locations, :show, { "id" => 2, "name" => "Rack" }]
+      )
+  end
+
+  def self.operatingsystems
+    ResourceMocks.mock_action_calls(
+      [:parameters, :index, []],
+      [:operatingsystems, :index, []],
+      [:operatingsystems, :show, {}]
+      )
+  end
+
+  def self.bookmarks
+    ResourceMocks.mock_action_calls(
+      [:bookmarks, :index, []],
+      [:bookmarks, :show, {}]
+    )
+  end
+
+  def self.mail_notifications
+    ResourceMocks.mock_action_calls(
+      [:mail_notifications, :index, []],
+      [:mail_notifications, :show, {}]
+    )
+  end
+
+  def self.compute_profiles
+    ResourceMocks.mock_action_calls(
+      [:compute_profiles, :index, []],
+      [:compute_profiles, :show, {}]
+    )
+  end
+
+  def self.parameters_index
+    ResourceMocks.mock_action_call(:parameters, :index, [])
+  end
+
+  def self.facts_index
+    ResourceMocks.mock_action_call(:fact_values, :index, {
+      "total"=>5604,
+      "subtotal"=>0,
+      "page"=>1,
+      "per_page"=>20,
+      "search"=>"",
+      "sort" => {
+        "by" => nil,
+        "order" => nil
+      },
+      "results"=>[{
+        "some.host.com" => {
+          "network_br180"=>"10.32.83.0",
+          "mtu_usb0"=>"1500",
+          "physicalprocessorcount"=>"1",
+          "rubyversion"=>"1.8.7"
+        }
+      }]
+    })
+  end
+
+  def self.auth_source_ldap_index
+    ResourceMocks.mock_action_call(:auth_source_ldaps, :index, {
+      'results' => [{
+        'name' => 'my LDAP',
+        'id' => 1,
+        'tls' => false,
+        'port' => 389,
+        'server_type' => 'POSIX'
+      }]
+    })
+  end
+
+  def self.auth_source_external_index
+    ResourceMocks.mock_action_call(:auth_source_externals, :index, {
+      'results' => [{
+        'id' => 11,
+        'name' => 'External',
+        'locations' => [{
+          'id' => 2,
+          'name' => 'Default Location',
+          'title' => 'Default Location',
+          'description' => nil
+        }],
+        'organizations' => [{
+          'id' => 1,
+          'name' => 'Default Organization',
+          'title' => 'Default Organization',
+          'description' => nil
+        }]
+      }]
+    })
+  end
+
+  def self.compute_resource_show
+    cr = {
+      "name" => "My compute resource",
+      "id" => 42,
+      "provider" => "Libvirt"
+    }
+    ResourceMocks.mock_action_calls(
+      [:compute_resources, :index, [ "results" => cr ]],
+      [:compute_resources, :show, cr]
+    )
+  end
+
+  def self.common_parameter_list
+    ResourceMocks.mock_action_call(:common_parameters, :index, [{
+      "name" => "my param",
+      "value" => "random value",
+    }])
+  end
+end

data/test/functional/host_report_test.rb

@@ -0,0 +1,211 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe 'host report' do
+  describe 'list' do
+    let(:cmd) { %w[host-report list] }
+    let(:params) { ['--host=host.example.com'] }
+    let(:host1_report_ansible) do
+      {
+        id: 1,
+        host_name: 'host.example.com',
+        format: 'ansible',
+        reported_at: '01/12/2021',
+        change: 1,
+        nochange: 2,
+        failure: 1
+      }
+    end
+    let(:host1_report_puppet) do
+      {
+        id: 2,
+        host_name: 'host.example.com',
+        format: 'puppet',
+        reported_at: '01/12/2021',
+        change: 1,
+        nochange: 2,
+        failure: 1
+      }
+    end
+    let(:host2_report_puppet) do
+      {
+        id: 3,
+        host_name: 'host2.example.com',
+        format: 'puppet',
+        reported_at: '01/12/2021',
+        change: 5,
+        nochange: 2,
+        failure: 1
+      }
+    end
+
+    it 'lists all host reports' do
+      api_expects(:host_reports, :index, 'Host report list').with_params(
+        'page' => 1, 'per_page' => 1000
+      ).returns(index_response([host1_report_puppet, host1_report_ansible, host2_report_puppet]))
+
+      output = IndexMatcher.new(
+        [
+          ['ID', 'HOST', 'REPORTED AT', 'FORMAT', 'CHANGE', 'NO CHANGE', 'FAILURE'],
+          ['1', 'host.example.com', '2021/12/01 00:00:00', 'ansible', '1', '2', '1'],
+          ['2', 'host.example.com', '2021/12/01 00:00:00', 'puppet', '1', '2', '1'],
+          ['3', 'host2.example.com', '2021/12/01 00:00:00', 'puppet', '5', '2', '1']
+        ]
+      )
+      expected_result = success_result(output)
+
+      result = run_cmd(cmd)
+      assert_cmd(expected_result, result)
+    end
+
+    it 'lists all host reports for a given host' do
+      api_expects(:hosts, :index, 'Host list').with_params(
+        'search' => 'name = "host.example.com"'
+      ).returns(index_response([{ 'id' => 1 }]))
+      api_expects(:host_reports, :index, 'Host report list').with_params(
+        'host_id' => 1, 'page' => 1, 'per_page' => 1000
+      ).returns(index_response([host1_report_puppet, host1_report_ansible]))
+
+      output = IndexMatcher.new(
+        [
+          ['ID', 'HOST', 'REPORTED AT', 'FORMAT', 'CHANGE', 'NO CHANGE', 'FAILURE'],
+          ['1', 'host.example.com', '2021/12/01 00:00:00', 'ansible', '1', '2', '1'],
+          ['2', 'host.example.com', '2021/12/01 00:00:00', 'puppet', '1', '2', '1']
+        ]
+      )
+      expected_result = success_result(output)
+
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+    end
+  end
+
+  describe 'create' do
+    let(:cmd) { %w[host-report create] }
+    let(:params) do
+      [
+        '--host=new.example.com', '--reported-at=01/12/2021', '--body=""',
+        '--format=ansible', '--change=5', '--nochange=2', '--failure=1'
+      ]
+    end
+    let(:new_host_report) do
+      {
+        id: 1,
+        host_id: 1,
+        format: 'ansible',
+        host_name: 'new.example.com',
+        reported_at: '01/12/2021',
+        body: nil,
+        change: 5,
+        failure: 1,
+        nochange: 2
+      }
+    end
+
+    it 'requires minimal parameters' do
+      api_expects_no_call
+
+      expected_result = "Could not create the host report:\n" \
+        "  Missing arguments for '--host', '--reported-at', '--body'.\n"
+
+      result = run_cmd(cmd)
+      assert_match(expected_result, result.err)
+    end
+
+    it 'creates a new host report' do
+      api_expects(:host_reports, :create).with_params(
+        'host_report' => {
+          'reported_at' => '01/12/2021', 'host' => 'new.example.com',
+          'body' => '""', 'change' => 5, 'format' => 'ansible', 'nochange' => 2,
+          'failure' => 1
+        }
+      ).returns(new_host_report)
+
+      expected_result = success_result("Host report created.\n")
+
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+    end
+  end
+
+  describe 'info' do
+    let(:cmd) { %w[host-report info] }
+    let(:params) { ['--id=1'] }
+    let(:body) do
+      {
+        'environment' => 'Development',
+        'format' => 'puppet',
+        'logs' => [
+          %w[notice resource message],
+          %w[err resource message]
+        ]
+      }
+    end
+    let(:full_host_report) do
+      {
+        id: 1,
+        host_id: 1,
+        host_name: 'full.example.com',
+        proxy_id: 1,
+        proxy_name: 'proxy.example.com',
+        format: 'puppet',
+        reported_at: '01/12/2021',
+        body: body.to_json,
+        change: 5,
+        failure: 1,
+        nochange: 2,
+        keywords: %w[HasChange PuppetHasChange]
+      }
+    end
+
+    it 'shows the host report' do
+      api_expects(:host_reports, :show, 'Show host report').with_params(
+        'id' => '1'
+      ).returns(full_host_report.transform_keys(&:to_s))
+
+      output = OutputMatcher.new(
+        [
+          'Id:                 1',
+          'Host:               full.example.com',
+          'Host id:            1',
+          'Proxy:              proxy.example.com',
+          'Proxy id:           1',
+          'Keywords:           HasChange, PuppetHasChange',
+          'Reported at:        2021/12/01 00:00:00',
+          'Format:             Puppet',
+          'Puppet environment: Development',
+          'Summary:',
+          '    Change:    5',
+          '    No change: 2',
+          '    Failure:   1',
+          'Logs:',
+          ' 1) Level:    notice',
+          '    Resource: resource',
+          '    Message:  message',
+          ' 2) Level:    err',
+          '    Resource: resource',
+          '    Message:  message'
+        ]
+      )
+
+      expected_result = success_result(output)
+
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+    end
+  end
+
+  describe 'delete' do
+    let(:cmd) { %w[host-report delete] }
+    let(:params) { ['--id=1'] }
+    it 'deletes the host report' do
+      api_expects(:host_reports, :destroy, 'Delete host report').with_params(
+        'id' => '1'
+      )
+
+      expected_result = success_result("Host report deleted.\n")
+
+      result = run_cmd(cmd + params)
+      assert_cmd(expected_result, result)
+    end
+  end
+end

data/test/functional/test_helper.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+require 'hammer_cli/testing/output_matchers'
+require 'hammer_cli/testing/command_assertions'
+require 'hammer_cli/testing/data_helpers'
+require 'hammer_cli_foreman/testing/api_expectations'
+
+include HammerCLI::Testing::OutputMatchers
+include HammerCLI::Testing::CommandAssertions
+include HammerCLI::Testing::DataHelpers
+include HammerCLIForeman::Testing::APIExpectations

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+ENV['TEST_API_VERSION'] = ENV['TEST_API_VERSION'] || '3.2'
+FOREMAN_HOST_REPORTS_VERSION = Gem::Version.new(ENV['TEST_API_VERSION']).to_s
+
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest-spec-context'
+require 'mocha/minitest'
+require 'hammer_cli'
+
+HammerCLI.context[:api_connection].create('foreman') do
+  HammerCLI::Apipie::ApiConnection.new(
+    apidoc_cache_dir: 'test/data/' + FOREMAN_HOST_REPORTS_VERSION,
+    apidoc_cache_name: 'foreman_api',
+    dry_run: true
+  )
+end
+
+require 'hammer_cli_foreman_host_reports'

data/test/unit/host_report_test.rb

@@ -0,0 +1,47 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe HammerCLIForemanHostReports::HostReport do
+  include ::CommandTestHelper
+
+  context 'ListCommand' do
+    before do
+      ResourceMocks.mock_action_call(:host_reports, :index, [])
+    end
+
+    let(:cmd) { HammerCLIForemanHostReports::HostReport::ListCommand.new('', ctx) }
+
+    context 'parameters' do
+      it_should_accept 'no arguments'
+      it_should_accept_search_params
+    end
+
+    context 'output' do
+      let(:expected_record_count) { count_records(cmd.resource.call(:index)) }
+
+      it_should_print_n_records
+      it_should_print_column 'Id'
+      it_should_print_column 'Host'
+      it_should_print_column 'Format'
+      it_should_print_column 'Reported at'
+      it_should_print_column 'Change'
+      it_should_print_column 'No change'
+      it_should_print_column 'Failure'
+    end
+  end
+
+  context 'InfoCommand' do
+    let(:cmd) { HammerCLIForemanHostReports::HostReport::InfoCommand.new('', ctx) }
+
+    context 'parameters' do
+      it_should_accept 'id', ['--id=1']
+    end
+  end
+
+  context 'DeleteCommand' do
+    let(:cmd) { HammerCLIForemanHostReports::HostReport::DeleteCommand.new('', ctx) }
+
+    context 'parameters' do
+      it_should_accept 'id', ['--id=1']
+    end
+  end
+end

data/test/unit/test_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+require File.join(Gem.loaded_specs['hammer_cli_foreman'].full_gem_path, 'test/unit/test_helper')