foreman_discovery 16.3.5 → 17.0.2

data/test/integration/discovered_hosts_test.rb

@@ -3,6 +3,7 @@ require 'integration_test_helper'
 
 class DiscoveredHostsTest < IntegrationTestWithJavascript
   let(:discovered_host) { FactoryBot.create(:discovered_host, :with_facts) }
+  let(:subnet) { FactoryBot.create(:subnet_ipv4, :network => "192.168.100.0") }
   let(:discovered_hosts) { Host::Discovered.all }
 
   setup do
@@ -17,8 +18,9 @@ class DiscoveredHostsTest < IntegrationTestWithJavascript
     Host::Discovered.destroy_all
   end
 
-  describe 'Multiple host Reboot' do
-    test 'triggers reboot on all discovered_hosts' do
+  describe 'Perform host Reboot' do
+    test 'triggers reboot on a single discovered_host' do
+      Host::Discovered.any_instance.stubs(:subnet).returns(subnet)
       Host::Discovered.any_instance
                       .expects(:reboot)
                       .at_least(discovered_hosts.count)
@@ -29,24 +31,70 @@ class DiscoveredHostsTest < IntegrationTestWithJavascript
       assert page.has_text?('The following hosts are about to be changed')
       page.find_button('Submit').click
     end
+
+    test 'triggers reboot on all discovered_hosts' do
+      Host::Discovered.any_instance.stubs(:subnet).returns(subnet)
+      Host::Discovered.any_instance
+                      .expects(:reboot)
+                      .at_least(discovered_hosts.count)
+      select_all_hosts
+      page.find_link('Select Action').click
+      page.find_link('Reboot').click
+      wait_for_ajax
+      assert page.has_text?('The following hosts are about to be changed')
+      page.find_button('Submit').click
+    end
+
+    test 'shows warning for all hosts with missing subnet' do
+      select_all_hosts
+      page.find_link('Select Action').click
+      page.find_link('Auto Provision').click
+      wait_for_ajax
+      assert page.has_text?('The following hosts are about to be changed')
+      page.find_button('Submit').click
+      wait_for_ajax
+      assert page.has_text?("Discovered hosts reported from unknown subnet")
+    end
   end
 
-  describe 'Multiple host Autoprovision' do
-    test 'converts all discovered to managed hosts' do
+  describe 'Perform host Autoprovision' do
+    test 'converts single discovered to managed host' do
+      Host::Discovered.any_instance.stubs(:subnet).returns(subnet)
       select_host_checkbox(discovered_host.id)
       page.find_link('Select Action').click
       page.find_link('Auto Provision').click
       wait_for_ajax
       assert page.has_text?('The following hosts are about to be changed')
       page.find_button('Submit').click
+    end
+
+    test 'converts all discovered to managed hosts' do
+      Host::Discovered.any_instance.stubs(:subnet).returns(subnet)
+      select_all_hosts
+      page.find_link('Select Action').click
+      page.find_link('Auto Provision').click
+      wait_for_ajax
+      assert page.has_text?('The following hosts are about to be changed')
+      page.find_button('Submit').click
       wait_for_ajax
       assert page.has_text?('Discovered hosts are provisioning now')
     end
+
+    test 'shows warning for all hosts with missing subnet' do
+      select_all_hosts
+      page.find_link('Select Action').click
+      page.find_link('Auto Provision').click
+      wait_for_ajax
+      assert page.has_text?('The following hosts are about to be changed')
+      page.find_button('Submit').click
+      wait_for_ajax
+      assert page.has_text?("Discovered hosts reported from unknown subnet")
+    end
   end
 
   describe 'Delete hosts' do
     test 'it removes all hosts' do
-      select_host_checkbox(discovered_host.id)
+      select_all_hosts
       page.find_link('Select Action').click
       page.find_link('Delete').click
       wait_for_ajax

data/test/test_helper_discovery.rb

@@ -172,6 +172,11 @@ def discovered_notification_blueprint
                                    name: 'new_discovered_host')
 end
 
+def failed_discovery_blueprint
+  @blueprint ||= FactoryBot.create(:notification_blueprint,
+                                   name: 'failed_discovery')
+end
+
 def parse_json_fixture(filename, remove_root_element = false)
   raw = JSON.parse(File.read(File.expand_path(File.dirname(__FILE__) + "/facts/#{filename}.json")))
   remove_root_element ? raw['facts'] : raw

data/test/unit/discovery_rule_test.rb

@@ -155,7 +155,7 @@ class DiscoveryRuleTest < ActiveSupport::TestCase
       :search => "cpu_count > 1",
       :hostgroup_id => @hostgroup.id
     refute_valid rule
-    assert_equal "Host group organization #{organization_one.name} must also be associated to the discovery rule", rule.errors[:organizations].first
+    assert_equal "Host group organization #{organization_one.name} must also be associated to the discovery rule", rule.errors[:base].first
   end
 
   test "should enforce hostgroup organizations and locations" do
@@ -168,7 +168,7 @@ class DiscoveryRuleTest < ActiveSupport::TestCase
       :organization_ids => [organization_one.id],
       :location_ids => [location_one.id]
     refute_valid rule
-    assert_equal "Host group location #{loc.name} must also be associated to the discovery rule", rule.errors[:locations].first
+    assert_equal "Host group location #{loc.name} must also be associated to the discovery rule", rule.errors[:base].first
   end
 
   context 'auditing related to discovery rule' do
@@ -218,4 +218,26 @@ class DiscoveryRuleTest < ActiveSupport::TestCase
       assert_equal DiscoveryRule::STEP, second_new.priority - first_new.priority
     end
   end
+
+  context 'suggest next priority' do
+    setup do
+      @organization = FactoryBot.create(:organization)
+      @location = FactoryBot.create(:location)
+    end
+
+    test 'when there exists a discovery_rule of the given organization' do
+      hostgroup = FactoryBot.create(:hostgroup, organizations: [@organization], locations: [@location] )
+      discovery_rule = FactoryBot.create(:discovery_rule,
+        priority: rand(100),
+        hostgroup: hostgroup,
+        organizations: [@organization],
+        locations: [@location])
+
+      assert_equal DiscoveryRule.suggest_priority(@organization), (discovery_rule.priority + DiscoveryRule::STEP)
+    end
+
+    test 'when there is no discovery_rule of the given organization' do
+      assert_equal DiscoveryRule.suggest_priority(@organization), DiscoveryRule::STEP
+    end
+  end
 end

data/test/unit/fact_to_category_resolver_test.rb

@@ -0,0 +1,41 @@
+require_relative '../test_plugin_helper'
+
+class FactToCategoryResolverTest < ActiveSupport::TestCase
+  class FakePrimaryInterface < OpenStruct
+    def subnet
+      nil
+    end
+  end
+
+  setup do
+    interfaces = [{
+      identifier: 'eth0',
+      mac: 'aa:bb:cc:dd:ee:f1',
+      ip: '192.168.1.1',
+    }.with_indifferent_access]
+    facts = {
+      :macaddress_eth0 => 'aa:bb:cc:dd:ee:f1',
+      :ipaddress_eth0 => '192.168.1.1',
+      manufacturer: 'TEST-Creator',
+      hardwaremodel: 'TEST_X64',
+      bios_vendor: 'TEST_BIOS',
+    }.with_indifferent_access
+
+    @host = Host::Discovered.new(name: 'dummy')
+    @host.stubs(:facts_hash).returns(facts)
+    @host.stubs(:interfaces).returns(interfaces)
+    @host.stubs(:primary_interface).returns(FakePrimaryInterface.new)
+    @resolver = ForemanDiscovery::FactToCategoryResolver.new(@host)
+  end
+
+  test 'resolve facts to right category' do
+    categories = @resolver.categories
+    hardware_category = categories[2]
+    network_category = categories[3]
+    software_category = categories[4]
+
+    assert_equal hardware_category['hardwaremodel'], 'TEST_X64'
+    assert_equal network_category['ipaddress_eth0'], '192.168.1.1'
+    assert_equal software_category['bios_vendor'], 'TEST_BIOS'
+  end
+end

data/test/unit/ui_notifications/destroy_host_test.rb

@@ -21,13 +21,6 @@ class DestroyHostNotificationTest < ActiveSupport::TestCase
       ForemanDiscovery::UINotifications::NewHost.deliver!(host)
     end
     assert_equal 1, blueprint.notifications.count
-    assert_no_difference('blueprint.notifications.count') do
-      host = FactoryBot.create(:discovered_host)
-      ForemanDiscovery::UINotifications::NewHost.deliver!(host)
-    end
-    assert_no_difference('blueprint.notifications.count') do
-      Host::Discovered.all.last.destroy
-    end
     Host::Discovered.destroy_all
     assert_equal 0, blueprint.notifications.count
   end
@@ -55,9 +48,9 @@ class DestroyHostNotificationTest < ActiveSupport::TestCase
     ForemanDiscovery::UINotifications::NewHost.deliver!(host1)
     host2 = FactoryBot.create(:discovered_host)
     ForemanDiscovery::UINotifications::NewHost.deliver!(host2)
-    assert_equal 1, blueprint.notifications.count
+    assert_equal 2, blueprint.notifications.count
     new_host = ::ForemanDiscovery::HostConverter.to_managed(host1, false, false)
     assert new_host.save!
-    assert_equal 1, blueprint.notifications.count
+    assert_equal 2, blueprint.notifications.count
   end
 end

data/test/unit/ui_notifications/new_host_test.rb

@@ -16,14 +16,14 @@ class NewHostNotificationTest < ActiveSupport::TestCase
     end
   end
 
-  test 'multiple discovered hosts should generate only one notification' do
+  test 'multiple discovered hosts should generate multiple notifications' do
     host1 = FactoryBot.create :discovered_host
     ForemanDiscovery::UINotifications::NewHost.deliver!(host1)
     expired_at = blueprint.notifications.first.expired_at
     Time.any_instance.stubs(:utc).returns(expired_at + 1.hour)
     host2 = FactoryBot.create :discovered_host
     ForemanDiscovery::UINotifications::NewHost.deliver!(host2)
-    assert_equal 1, blueprint.notifications.count
-    assert_not_equal expired_at, blueprint.notifications.first.expired_at
+    assert_equal 2, blueprint.notifications.count
+    assert_not_equal expired_at, blueprint.notifications.last.expired_at
   end
 end

data/webpack/__mocks__/foremanReact/common/I18n.js

@@ -0,0 +1,3 @@
+export const translate = s => s;
+
+export const ngettext = s => s;

data/webpack/__mocks__/foremanReact/common/helpers.js

@@ -0,0 +1 @@
+export const foremanUrl = path => `${window.URL_PREFIX}${path}`;

data/webpack/__mocks__/foremanReact/common/index.js

@@ -0,0 +1,5 @@
+import EmptyStatePattern from '../components/common/EmptyState/EmptyStatePattern';
+import DefaultEmptyState from '../components/common/EmptyState/DefaultEmptyState';
+
+export default DefaultEmptyState;
+export { EmptyStatePattern };

data/webpack/__mocks__/foremanReact/components/common/EmptyState/DefaultEmptyState.js

@@ -0,0 +1,69 @@
+import React from 'react';
+import { useDispatch } from 'react-redux';
+import { push } from 'connected-react-router';
+import { Button } from '@patternfly/react-core';
+import EmptyStatePattern from './EmptyStatePattern';
+import { defaultEmptyStatePropTypes } from './EmptyStatePropTypes';
+
+const DefaultEmptyState = props => {
+  const {
+    icon,
+    iconType,
+    header,
+    description,
+    documentation,
+    action,
+    secondaryActions,
+  } = props;
+
+  const dispatch = useDispatch();
+  const actionButtonClickHandler = ({ url, onClick }) => {
+    if (onClick) onClick();
+    else if (url) dispatch(push(url));
+  };
+
+  const ActionButton = action ? (
+    <Button
+      component="a"
+      onClick={() => actionButtonClickHandler(action)}
+      variant="primary"
+    >
+      {action.title}
+    </Button>
+  ) : null;
+
+  const SecondaryButton = secondaryActions
+    ? secondaryActions.map(({ title, url, onClick }) => (
+        <Button
+          component="a"
+          key={`sec-button-${title}`}
+          onClick={() => actionButtonClickHandler({ url, onClick })}
+          variant="secondary"
+        >
+          {title}
+        </Button>
+      ))
+    : null;
+
+  return (
+    <EmptyStatePattern
+      icon={icon}
+      iconType={iconType}
+      header={header}
+      description={description}
+      documentation={documentation}
+      action={ActionButton}
+      secondaryActions={SecondaryButton}
+    />
+  );
+};
+
+DefaultEmptyState.propTypes = defaultEmptyStatePropTypes;
+
+DefaultEmptyState.defaultProps = {
+  icon: 'add-circle-o',
+  secondaryActions: [],
+  iconType: 'pf',
+};
+
+export default DefaultEmptyState;

data/webpack/__mocks__/foremanReact/components/common/EmptyState/EmptyStatePattern.js

@@ -0,0 +1,77 @@
+import React from 'react';
+import { Icon } from 'patternfly-react';
+import {
+  Title,
+  EmptyState,
+  EmptyStateVariant,
+  EmptyStateBody,
+  EmptyStateSecondaryActions,
+} from '@patternfly/react-core';
+import { emptyStatePatternPropTypes } from './EmptyStatePropTypes';
+import { translate as __ } from '../../../common/I18n';
+
+const EmptyStatePattern = props => {
+  const {
+    documentation,
+    action,
+    secondaryActions,
+    iconType,
+    icon,
+    header,
+    description,
+  } = props;
+
+  const DocumentationBlock = () => {
+    if (!documentation) {
+      return null;
+    }
+    // The documentation prop can also be a customized node
+    if (React.isValidElement(documentation)) {
+      return documentation;
+    }
+    const {
+      label = __('For more information please see '), // eslint-disable-line react/prop-types
+      buttonLabel = __('documentation'), // eslint-disable-line react/prop-types
+      url, // eslint-disable-line react/prop-types
+    } = documentation;
+    return (
+      <span>
+        {label}
+        <a href={url}>{buttonLabel}</a>
+      </span>
+    );
+  };
+
+  return (
+    <EmptyState variant={EmptyStateVariant.xl}>
+      <span className="empty-state-icon">
+        {/* TODO: Add pf4 icons, Redmine issue: #30865 */}
+        <Icon name={icon} type={iconType} size="2x" />
+      </span>
+      <Title headingLevel="h5" size="4xl">
+        {header}
+      </Title>
+      <EmptyStateBody>
+        <div className="empty-state-description">{description}</div>
+        <DocumentationBlock />
+      </EmptyStateBody>
+      {action}
+      <EmptyStateSecondaryActions>
+        {secondaryActions}
+      </EmptyStateSecondaryActions>
+    </EmptyState>
+  );
+};
+
+EmptyStatePattern.propTypes = emptyStatePatternPropTypes;
+
+EmptyStatePattern.defaultProps = {
+  icon: 'add-circle-o',
+  secondaryActions: [],
+  documentation: {
+    url: '#',
+  },
+  iconType: 'pf',
+};
+
+export default EmptyStatePattern;

data/webpack/__mocks__/foremanReact/components/common/EmptyState/EmptyStatePropTypes.js

@@ -0,0 +1,29 @@
+import PropTypes from 'prop-types';
+
+export const actionButtonPropTypes = {
+  title: PropTypes.node.isRequired,
+  url: PropTypes.string,
+  onChange: PropTypes.func,
+};
+
+export const emptyStatePatternPropTypes = {
+  icon: PropTypes.string.isRequired,
+  header: PropTypes.string.isRequired,
+  documentation: PropTypes.oneOfType([
+    PropTypes.shape({
+      label: PropTypes.string,
+      buttonLabel: PropTypes.string,
+      url: PropTypes.string.isRequired,
+    }),
+    PropTypes.node,
+  ]),
+  description: PropTypes.string.isRequired,
+  action: PropTypes.node,
+  secondaryActions: PropTypes.node,
+};
+
+export const defaultEmptyStatePropTypes = {
+  ...emptyStatePatternPropTypes,
+  action: PropTypes.shape(actionButtonPropTypes),
+  secondaryActions: PropTypes.arrayOf(PropTypes.shape(actionButtonPropTypes)),
+};

data/webpack/__mocks__/foremanReact/components/common/EmptyState/index.js

@@ -0,0 +1,5 @@
+import EmptyStatePattern from './EmptyStatePattern';
+import DefaultEmptyState from './DefaultEmptyState';
+
+export default DefaultEmptyState;
+export { EmptyStatePattern };

data/webpack/index.js

@@ -1,10 +1,11 @@
 /* eslint import/no-unresolved: [2, { ignore: [foremanReact/*] }] */
 /* eslint-disable import/no-extraneous-dependencies */
 /* eslint-disable import/extensions */
-import componentRegistry from "foremanReact/components/componentRegistry";
-import { registerReducer } from "foremanReact/common/MountingService";
-import reducers from "./src/reducers";
-import DiscoveredHosts from "./src/ForemanDiscovery/DiscoveredHosts";
+import componentRegistry from 'foremanReact/components/componentRegistry';
+import { registerReducer } from 'foremanReact/common/MountingService';
+import reducers from './src/reducers';
+import DiscoveredHosts from './src/ForemanDiscovery/DiscoveredHosts';
+import DiscoveryRules from './src/ForemanDiscovery/DiscoveryRules';
 
 // register reducers
 Object.entries(reducers).forEach(([key, reducer]) =>
@@ -12,7 +13,7 @@ Object.entries(reducers).forEach(([key, reducer]) =>
 );
 
 // register components for erb mounting
-componentRegistry.register({
-  name: "DiscoveredHosts",
-  type: DiscoveredHosts,
-});
+componentRegistry.registerMultiple([
+  { name: 'DiscoveredHosts', type: DiscoveredHosts },
+  { name: 'DiscoveryRules', type: DiscoveryRules },
+]);

data/webpack/src/ForemanDiscovery/DiscoveredHosts/Components/EmptyState/EmptyState.js

@@ -1,11 +1,11 @@
-import React from "react";
-import PropTypes from "prop-types";
-import { translate as __ } from "foremanReact/common/I18n";
-import ForemanEmptyState from "foremanReact/components/common/EmptyState";
+import React from 'react';
+import PropTypes from 'prop-types';
+import { translate as __ } from 'foremanReact/common/I18n';
+import ForemanEmptyState from 'foremanReact/components/common/EmptyState';
 
-const EmptyState = (props) => {
+const EmptyState = props => {
   const description = __(
-    "No discovered hosts found in this context. This page shows discovered bare-metal or virtual nodes waiting to be provisioned."
+    'No discovered hosts found in this context. This page shows discovered bare-metal or virtual nodes waiting to be provisioned.'
   );
   const documentation = {
     url: props.docUrl,
@@ -22,7 +22,7 @@ const EmptyState = (props) => {
 };
 
 EmptyState.propTypes = {
-  docUrl: PropTypes.string,
+  docUrl: PropTypes.string.isRequired,
 };
 
 export default EmptyState;

data/webpack/src/ForemanDiscovery/DiscoveredHosts/Components/EmptyState/__test__/EmptyState.test.js

@@ -0,0 +1,12 @@
+import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
+
+import ForemanEmptyState from '../EmptyState';
+
+const fixtures = {
+  'render with Props': { docUrl: 'https://foreman.example.com' },
+};
+
+describe('ForemanEmptyState', () => {
+  describe('rendering', () =>
+    testComponentSnapshotsWithFixtures(ForemanEmptyState, fixtures));
+});

data/webpack/src/ForemanDiscovery/DiscoveredHosts/Components/EmptyState/__test__/__snapshots__/EmptyState.test.js.snap

@@ -0,0 +1,16 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`ForemanEmptyState rendering render with Props 1`] = `
+<DefaultEmptyState
+  description="No discovered hosts found in this context. This page shows discovered bare-metal or virtual nodes waiting to be provisioned."
+  documentation={
+    Object {
+      "url": "https://foreman.example.com",
+    }
+  }
+  header="Foreman Discovery"
+  icon="gears"
+  iconType="fa"
+  secondaryActions={Array []}
+/>
+`;

data/webpack/src/ForemanDiscovery/DiscoveredHosts/Components/EmptyState/index.js

@@ -1 +1 @@
-export { default } from "./EmptyState";
+export { default } from './EmptyState';

data/webpack/src/ForemanDiscovery/DiscoveredHosts/index.js

@@ -1,6 +1,6 @@
-import React from "react";
-import EmptyState from "./Components/EmptyState";
+import React from 'react';
+import EmptyState from './Components/EmptyState';
 
-const DiscoveredHosts = ({ docUrl }) => <EmptyState docUrl={docUrl} />;
+const DiscoveredHosts = props => <EmptyState {...props} />;
 
 export default DiscoveredHosts;

data/webpack/src/ForemanDiscovery/DiscoveryRules/Components/EmptyState/EmptyState.js

@@ -0,0 +1,34 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { translate as __ } from 'foremanReact/common/I18n';
+import ForemanEmptyState from 'foremanReact/components/common/EmptyState';
+import { foremanUrl } from 'foremanReact/common/helpers';
+
+const EmptyState = props => {
+  const action = {
+    title: __('Create Rule'),
+    url: foremanUrl('/discovery_rules/new'),
+  };
+  const description = __(
+    'No Discovery Rules found in this context. Create Discovery Rules to perform automated provisioning on Discovered Hosts'
+  );
+  const documentation = {
+    url: props.docUrl,
+  };
+  return (
+    <ForemanEmptyState
+      header="Discovery Rules"
+      description={description}
+      icon="gavel"
+      iconType="fa"
+      documentation={documentation}
+      action={action}
+    />
+  );
+};
+
+EmptyState.propTypes = {
+  docUrl: PropTypes.string.isRequired,
+};
+
+export default EmptyState;

data/webpack/src/ForemanDiscovery/DiscoveryRules/Components/EmptyState/index.js

@@ -0,0 +1 @@
+export { default } from './EmptyState';

data/webpack/src/ForemanDiscovery/DiscoveryRules/Components/__test__/EmptyState.test.js

@@ -0,0 +1,19 @@
+import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
+import ForemanEmptyState from '../EmptyState';
+
+const action = {
+  title: 'action-title',
+  url: `action-url`,
+};
+
+const fixtures = {
+  'render with Props': {
+    docUrl: 'https://foreman.example.com',
+    action,
+  },
+};
+
+describe('ForemanEmptyState', () => {
+  describe('rendering', () =>
+    testComponentSnapshotsWithFixtures(ForemanEmptyState, fixtures));
+});

data/webpack/src/ForemanDiscovery/DiscoveryRules/Components/__test__/__snapshots__/EmptyState.test.js.snap

@@ -0,0 +1,22 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`ForemanEmptyState rendering render with Props 1`] = `
+<DefaultEmptyState
+  action={
+    Object {
+      "title": "Create Rule",
+      "url": "/discovery_rules/new",
+    }
+  }
+  description="No Discovery Rules found in this context. Create Discovery Rules to perform automated provisioning on Discovered Hosts"
+  documentation={
+    Object {
+      "url": "https://foreman.example.com",
+    }
+  }
+  header="Discovery Rules"
+  icon="gavel"
+  iconType="fa"
+  secondaryActions={Array []}
+/>
+`;

data/webpack/src/ForemanDiscovery/DiscoveryRules/index.js

@@ -0,0 +1,6 @@
+import React from 'react';
+import EmptyState from './Components/EmptyState';
+
+const DiscoveryRules = props => <EmptyState {...props} />;
+
+export default DiscoveryRules;

data/webpack/src/reducers.js

@@ -1,5 +1,3 @@
-import { combineReducers } from "redux";
-
 const reducers = {
   foremanDiscovery: {},
 };