foreman_ansible 6.4.1 → 7.0.0

data/lib/foreman_ansible/engine.rb

@@ -19,12 +19,6 @@ module ForemanAnsible
     config.autoload_paths += Dir["#{config.root}/app/views"]
     config.autoload_paths += Dir["#{config.root}/app/lib"]
 
-    initializer 'foreman_ansible.load_default_settings',
-                :before => :load_config_initializers do
-      require_dependency(File.join(ForemanAnsible::Engine.root,
-                                   'app/models/setting/ansible.rb'))
-    end
-
     initializer 'foreman_ansible.register_gettext',
                 :after => :load_config_initializers do
       locale_dir = File.join(File.expand_path('../..', __dir__), 'locale')
@@ -71,17 +65,6 @@ module ForemanAnsible
     end
 
     config.to_prepare do
-      foreman_version = ::Foreman::Version.new
-      if Rails.env.test? ||
-         foreman_version.major.to_i == 1 && foreman_version.minor.to_i < 13
-        ::Foreman::Plugin.fact_importer_registry.register(:ansible, ForemanAnsible::FactImporter)
-      else
-        ::Foreman::Plugin.fact_importer_registry.register(
-          :ansible,
-          ForemanAnsible::StructuredFactImporter
-        )
-      end
-      ::FactParser.register_fact_parser(:ansible, ForemanAnsible::FactParser)
       ::Host::Managed.prepend ForemanAnsible::HostManagedExtensions
       ::Hostgroup.include ForemanAnsible::HostgroupExtensions
       ::HostsHelper.include ForemanAnsible::HostsHelperExtensions

data/lib/foreman_ansible/register.rb

@@ -1,7 +1,89 @@
 # frozen_string_literal: true
 
 Foreman::Plugin.register :foreman_ansible do
-  requires_foreman '>= 2.2'
+  requires_foreman '>= 3.0'
+
+  settings do
+    category :ansible, N_('Ansible') do
+      setting 'ansible_ssh_private_key_file',
+              type: :string,
+              description: N_('Use this to supply a path to an SSH Private Key '\
+                               'that Ansible will use in lieu of a password '\
+                               'Override with "ansible_ssh_private_key_file" '\
+                               'host parameter'),
+              default: '',
+              full_name: N_('Private Key Path')
+      setting 'ansible_connection',
+              type: :string,
+              description: N_('Use this connection type by default when running '\
+                               'Ansible playbooks. You can override this on hosts by '\
+                               'adding a parameter "ansible_connection"'),
+              default: 'ssh',
+              full_name: N_('Connection type')
+      setting 'ansible_winrm_server_cert_validation',
+              type: :string,
+              description: N_('Enable/disable WinRM server certificate '\
+                               'validation when running Ansible playbooks. You can override '\
+                               'this on hosts by adding a parameter '\
+                               '"ansible_winrm_server_cert_validation"'),
+              default: 'validate',
+              full_name: N_('WinRM cert Validation')
+      setting 'ansible_verbosity',
+              type: :integer,
+              description: N_('Foreman will add this level of verbosity for '\
+                               'additional debugging output when running Ansible playbooks.'),
+              default: '0',
+              full_name: N_('Default verbosity level'),
+              value: nil,
+              collection: proc {
+                { '0' => N_('Disabled'),
+                  '1' => N_('Level 1 (-v)'),
+                  '2' => N_('Level 2 (-vv)'),
+                  '3' => N_('Level 3 (-vvv)'),
+                  '4' => N_('Level 4 (-vvvv)') }
+              }
+      setting 'ansible_post_provision_timeout',
+              type: :integer,
+              description: N_('Timeout (in seconds) to set when Foreman will trigger a '\
+                               'play Ansible roles task after a host is fully provisioned. '\
+                               'Set this to the maximum time you expect a host to take '\
+                               'until it is ready after a reboot.'),
+              default: '360',
+              full_name: N_('Post-provision timeout')
+      setting 'ansible_interval',
+              type: :integer,
+              description: N_('Timeout (in minutes) when hosts should have reported.'),
+              default: '30',
+              full_name: N_('Ansible report timeout')
+      setting 'ansible_out_of_sync_disabled',
+              type: :boolean,
+              description: format(N_('Disable host configuration status turning to out of'\
+                               ' sync for %{cfgmgmt} after report does not arrive within'\
+                               ' configured interval'), :cfgmgmt => 'Ansible'),
+              default: false,
+              full_name: format(N_('%{cfgmgmt} out of sync disabled'), :cfgmgmt => 'Ansible')
+      setting  'ansible_inventory_template',
+               type: :string,
+               description: N_('Foreman will use this template to schedule the report '\
+                                 'with Ansible inventory'),
+               default: 'Ansible - Ansible Inventory',
+               full_name: N_('Default Ansible inventory report template')
+      setting 'ansible_roles_to_ignore',
+              type: :array,
+              description: N_('Those roles will be excluded when importing roles from smart proxy, '\
+                'The expected input is comma separated values and you can use * wildcard metacharacters'\
+                'For example: foo*, *b*,*bar'),
+              default: [],
+              full_name: N_('Ansible roles to ignore')
+      setting 'foreman_ansible_proxy_batch_size',
+              type: :integer,
+              description: N_('Number of tasks which should be sent to the smart proxy in one request, '\
+                              'if foreman_tasks_proxy_batch_trigger is enabled. '\
+                              'If set, overrides foreman_tasks_proxy_batch_size setting for Ansible jobs.'),
+              default: nil,
+              full_name: N_('Proxy tasks batch size for Ansible')
+    end
+  end
 
   security_block :foreman_ansible do
     permission :play_roles_on_host,
@@ -29,23 +111,27 @@ Foreman::Plugin.register :foreman_ansible do
                :resource_type => 'AnsibleRole'
     permission :view_ansible_variables,
                {
+                 :lookup_values => [:index],
                  :ansible_variables => [:index, :auto_complete_search],
                  :'api/v2/ansible_variables' => [:index, :show]
                },
                :resource_type => 'AnsibleVariable'
     permission :edit_ansible_variables,
-               { :ansible_variables => [:edit, :update],
+               { :lookup_values => [:update],
+                 :ansible_variables => [:edit, :update],
                  :'api/v2/ansible_variables' => [:update],
                  :'api/v2/ansible_override_values' => [:create, :destroy] },
                :resource_type => 'AnsibleVariable'
     permission :destroy_ansible_variables,
                {
+                 :lookup_values => [:destroy],
                  :ansible_variables => [:destroy],
                  :'api/v2/ansible_variables' => [:destroy, :obsolete]
                },
                :resource_type => 'AnsibleVariable'
     permission :create_ansible_variables,
                {
+                 :lookup_values => [:create],
                  :ansible_variables => [:new, :create],
                  :'api/v2/ansible_variables' => [:create]
                },
@@ -76,9 +162,10 @@ Foreman::Plugin.register :foreman_ansible do
 
   role 'Ansible Roles Manager',
        [:play_roles_on_host, :play_roles_on_hostgroup,
+        :create_job_invocations, :view_job_templates,      # to allow the play_roles
+        :create_template_invocations, :view_smart_proxies, # ...
         :view_ansible_roles, :destroy_ansible_roles,
-        :import_ansible_roles,
-        :view_ansible_variables,
+        :import_ansible_roles, :view_ansible_variables,
         :create_ansible_variables, :import_ansible_variables,
         :edit_ansible_variables, :destroy_ansible_variables]
 
@@ -98,6 +185,30 @@ Foreman::Plugin.register :foreman_ansible do
 
   register_global_js_file 'global'
 
+  extend_graphql_type :type => ::Types::Host do
+    field :all_ansible_roles, ::Types::InheritedAnsibleRole.connection_type, :null => true, :method => :present_all_ansible_roles
+    field :own_ansible_roles, ::Types::AnsibleRole.connection_type, :null => true
+    field :available_ansible_roles, ::Types::AnsibleRole.connection_type, :null => true
+    field :ansible_variables_with_overrides, Types::OverridenAnsibleVariable.connection_type, :null => false
+
+    def present_all_ansible_roles
+      inherited_ansible_roles = object.inherited_ansible_roles.map { |role| ::Presenters::AnsibleRolePresenter.new(role, true) }
+      ansible_roles = object.ansible_roles.map { |role| ::Presenters::AnsibleRolePresenter.new(role, false) }
+      (inherited_ansible_roles + ansible_roles).uniq
+    end
+
+    def ansible_variables_with_overrides
+      resolver = ::ForemanAnsible::OverrideResolver.new(object)
+      AnsibleVariable.where(:ansible_role_id => object.all_ansible_roles.pluck(:id), :override => true).map { |variable| ::Presenters::OverridenAnsibleVariablePresenter.new variable, resolver }
+    end
+  end
+
+  register_graphql_query_field :ansible_roles, '::Types::AnsibleRole', :collection_field
+  register_graphql_mutation_field :assign_ansible_roles, '::Mutations::Hosts::AssignAnsibleRoles'
+  register_graphql_mutation_field :delete_ansible_variable_override, ::Mutations::AnsibleVariableOverrides::Delete
+  register_graphql_mutation_field :update_ansible_variable_override, ::Mutations::AnsibleVariableOverrides::Update
+  register_graphql_mutation_field :create_ansible_variable_override, ::Mutations::AnsibleVariableOverrides::Create
+
   divider :top_menu, :caption => N_('Ansible'), :parent => :configure_menu
   menu :top_menu, :ansible_roles,
        :caption => N_('Roles'),

data/lib/foreman_ansible/version.rb

@@ -4,5 +4,5 @@
 # This way other parts of Foreman can just call ForemanAnsible::VERSION
 # and detect what version the plugin is running.
 module ForemanAnsible
-  VERSION = '6.4.1'
+  VERSION = '7.0.0'
 end

data/package.json

@@ -7,19 +7,21 @@
     "test": "test"
   },
   "peerDependencies": {
-    "@theforeman/vendor": ">= 6.0.0"
+    "@theforeman/vendor": ">= 8.16.0"
   },
   "dependencies": {
     "react-json-tree": "^0.11.0"
   },
   "devDependencies": {
     "@babel/core": "^7.7.0",
+    "@testing-library/user-event": "^13.2.1",
     "@theforeman/builder": "^8.4.1",
     "@theforeman/eslint-plugin-foreman": "^8.4.1",
     "@theforeman/find-foreman": "^8.4.1",
     "@theforeman/stories": "^8.4.1",
-    "@theforeman/test": "^8.4.1",
+    "@theforeman/test": "^8.9.0",
     "@theforeman/vendor-dev": "^8.4.1",
+    "@testing-library/user-event": "^13.2.1",
     "babel-eslint": "^10.0.3",
     "eslint": "^6.7.2",
     "prettier": "^1.13.5"

data/test/functional/api/v2/ansible_inventories_controller_test.rb

@@ -34,8 +34,7 @@ module Api
 
       test 'schedule inventory by user' do
         report = FactoryBot.create(:report_template)
-        Setting::Ansible.create! :name => 'ansible_inventory_template', :value => report.name,
-                                 :default => report.name, :description => 'inventory'
+        Setting['ansible_inventory_template'] = report.name
         user = FactoryBot.create(:user)
         user.roles << Role.find_by(:name => 'Ansible Tower Inventory Reader')
         post :schedule, { :session => set_session_user(user) }

data/test/graphql/mutations/hosts/assign_ansible_roles_mutation_test.rb

@@ -0,0 +1,96 @@
+require 'test_plugin_helper'
+
+module Mutations
+  module Hosts
+    class CreateMutationTest < GraphQLQueryTestCase
+      let(:tax_location) { FactoryBot.create(:location) }
+      let(:location_id) { Foreman::GlobalId.for(tax_location) }
+      let(:organization) { FactoryBot.create(:organization) }
+      let(:organization_id) { Foreman::GlobalId.for(organization) }
+
+      let(:role1) { FactoryBot.create(:ansible_role) }
+      let(:role2) { FactoryBot.create(:ansible_role) }
+      let(:role3) { FactoryBot.create(:ansible_role) }
+      let(:host) { FactoryBot.create(:host, :ansible_roles => [role1, role2, role3], :organization => organization, :location => tax_location) }
+
+      let(:variables) { { id: Foreman::GlobalId.for(host), ansibleRoleIds: [role3.id, role2.id, role1.id] } }
+      let(:query) do
+        <<-GRAPHQL
+          mutation AssignAnsibleRoles($id: ID!, $ansibleRoleIds: [Int!]!) {
+            assignAnsibleRoles(input: { id: $id, ansibleRoleIds: $ansibleRoleIds }) {
+              host {
+                id
+                ownAnsibleRoles {
+                  nodes {
+                    id
+                    name
+                  }
+                }
+              }
+              errors {
+                path
+                message
+              }
+            }
+          }
+        GRAPHQL
+      end
+
+      context 'with admin permissions' do
+        let(:context_user) { FactoryBot.create(:user, :admin) }
+        let(:data) { result['data']['assignAnsibleRoles']['host'] }
+
+        it 'reorderes ansible roles' do
+          assert_empty result['errors']
+          assert_not_nil data
+          assert_empty result['data']['assignAnsibleRoles']['errors']
+
+          assert_equal([role3, role2, role1].map { |role| Foreman::GlobalId.for role }, data['ownAnsibleRoles']['nodes'].map { |node| node['id'] })
+        end
+      end
+
+      context 'with edit permission' do
+        let(:context_user) do
+          setup_user('edit', 'hosts') do |user|
+            user.roles << Role.find_by(name: 'Viewer')
+          end
+        end
+        let(:data) { result['data']['assignAnsibleRoles']['host'] }
+        let(:variables) { { id: Foreman::GlobalId.for(host), ansibleRoleIds: [role3.id, role2.id] } }
+
+        before do
+          Location.current = tax_location
+          Organization.current = organization
+        end
+
+        it 'reorderes ansible roles' do
+          assert_empty result['errors']
+          assert_not_nil data
+          assert_empty result['data']['assignAnsibleRoles']['errors']
+
+          assert_equal([role3, role2].map { |role| Foreman::GlobalId.for role }, data['ownAnsibleRoles']['nodes'].map { |node| node['id'] })
+        end
+      end
+
+      context 'with view only permissions' do
+        let(:context_user) do
+          setup_user('show', 'hosts') do |user|
+            user.roles << Role.find_by(name: 'Viewer')
+          end
+        end
+
+        before do
+          Location.current = tax_location
+          Organization.current = organization
+        end
+
+        test 'cannot create a host' do
+          expected_error = 'Unauthorized. You do not have the required permission edit_hosts.'
+
+          assert_not_empty result['errors']
+          assert_includes result['errors'].map { |e| e['message'] }, expected_error
+        end
+      end
+    end
+  end
+end

data/test/graphql/queries/ansible_roles_query_test.rb

@@ -0,0 +1,35 @@
+require 'test_plugin_helper'
+
+module Queries
+  class AnsibleRolesQueryTest < GraphQLQueryTestCase
+    let(:query) do
+      <<-GRAPHQL
+      query {
+        ansibleRoles {
+          totalCount
+          nodes {
+            id
+            name
+          }
+        }
+      }
+      GRAPHQL
+    end
+
+    let(:data) { result['data']['ansibleRoles'] }
+
+    setup do
+      FactoryBot.create_list(:ansible_role, 2)
+    end
+
+    test 'should fetch Ansible roles' do
+      assert_empty result['errors']
+
+      expected_count = AnsibleRole.count
+
+      assert_not_equal 0, expected_count
+      assert_equal expected_count, data['totalCount']
+      assert_equal expected_count, data['nodes'].count
+    end
+  end
+end

data/test/unit/ansible_provider_test.rb

@@ -30,14 +30,11 @@ class AnsibleProviderTest < ActiveSupport::TestCase
     end
 
     context 'when using secrets' do
-      let(:host) { FactoryBot.build(:host) }
+      let(:host) { FactoryBot.create(:host) }
 
       it 'generates secrets properly' do
-        params = {
-          'remote_execution_ssh_password' => 'password',
-          'remote_execution_effective_user_password' => 'letmein'
-        }
-        host.expects(:params).twice.returns(params)
+        host.parameters << HostParameter.new(name: 'remote_execution_ssh_password', value: 'password')
+        host.parameters << HostParameter.new(name: 'remote_execution_effective_user_password', value: 'letmein')
         secrets = ForemanAnsible::AnsibleProvider.secrets(host)
         host_secrets = secrets['per-host'][host.name]
         assert_equal host_secrets['ansible_password'], 'password'

data/test/unit/concerns/host_managed_extensions_test.rb

@@ -62,4 +62,12 @@ class HostManagedExtensionsTest < ActiveSupport::TestCase
     FactoryBot.create(:host_ansible_role, :ansible_role_id => @role1.id, :position => 0, :host_id => host.id)
     host.all_ansible_roles.must_equal [@role2, @role1]
   end
+
+  test 'should find hosts with role2' do
+    host1 = FactoryBot.create(:host, :ansible_roles => [@role2])
+    host2 = FactoryBot.create(:host, :hostgroup => @hostgroup)
+    result = Host::Managed.search_for("ansible_role= #{@role2.name}").pluck(:id)
+    assert_include result, host1.id
+    assert_include result, host2.id
+  end
 end

data/test/unit/concerns/hostgroup_extensions_test.rb

@@ -55,4 +55,10 @@ class HostgroupExtensionsTest < ActiveSupport::TestCase
     @hostgroup.parent = @hostgroup_parent
     @hostgroup.inherited_and_own_ansible_roles.must_equal [@role2, @role1]
   end
+
+  describe '#cloned_ansibe_roles' do
+    test 'clone ansible roles from hostgroup parent' do
+      @hostgroup_parent.clone.all_ansible_roles.must_equal @hostgroup_parent.all_ansible_roles
+    end
+  end
 end

data/test/unit/hostgroup_ansible_role_test.rb

@@ -19,4 +19,17 @@ class HostgroupAnsibleRoleTest < ActiveSupport::TestCase
     end
     should validate_uniqueness_of(:ansible_role_id).scoped_to(:hostgroup_id)
   end
+
+  describe 'ordering' do
+    test 'should list roles in correct order' do
+      hg = FactoryBot.create(:hostgroup)
+      5.times do |idx|
+        HostgroupAnsibleRole.create(:hostgroup => hg, :ansible_role => FactoryBot.create(:ansible_role), :position => idx)
+      end
+
+      hg.hostgroup_ansible_roles.each_with_index do |item, idx|
+        assert_equal(item.position, idx + 1)
+      end
+    end
+  end
 end

data/test/unit/services/override_resolver_test.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module ForemanAnsible
+  class OverrideResolverTest < ActiveSupport::TestCase
+    test 'should return no overrides when no roles assigned to host' do
+      assert_empty OverrideResolver.new(FactoryBot.build(:host)).overrides
+    end
+
+    test 'should return overrides for host' do
+      first_role = FactoryBot.create(:ansible_role)
+      first_var = FactoryBot.create(:ansible_variable, :override => true, :ansible_role => first_role)
+      second_role = FactoryBot.create(:ansible_role)
+      second_var = FactoryBot.create(:ansible_variable, :override => true, :ansible_role => second_role)
+      host = FactoryBot.create(:host, :ansible_roles => [first_role])
+      another_host = FactoryBot.create(:host)
+
+      FactoryBot.create(:lookup_value, :match => "fqdn=#{host.name}", :lookup_key_id => first_var.id)
+      FactoryBot.create(:lookup_value, :match => "fqdn=#{another_host.name}", :lookup_key_id => first_var.id)
+      FactoryBot.create(:lookup_value, :match => "fqdn=#{host.name}", :lookup_key_id => second_var.id)
+
+      assert_not_nil OverrideResolver.new(host).resolve(first_var)
+      assert_nil OverrideResolver.new(another_host).resolve(first_var)
+      assert_nil OverrideResolver.new(host).resolve(second_var)
+    end
+
+    test 'should raise when no host specified' do
+      assert_raises Foreman::Exception do
+        OverrideResolver.new(nil)
+      end
+    end
+  end
+end

data/webpack/components/AnsibleHostDetail/AnsibleHostDetail.js

@@ -1,35 +1,59 @@
-import React, { useState } from 'react';
-import { Tabs, Tab, TabTitleText, Label } from '@patternfly/react-core';
-import { InfoCircleIcon } from '@patternfly/react-icons';
-
-import { translate as __ } from 'foremanReact/common/I18n';
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Tabs, Tab, TabTitleText } from '@patternfly/react-core';
+import { useHistory } from 'react-router-dom';
+import SkeletonLoader from 'foremanReact/components/common/SkeletonLoader';
 
+import SecondaryTabRoutes from './components/SecondaryTabRoutes';
+import { SECONDARY_TABS } from './constants';
 import './AnsibleHostDetail.scss';
 
-const AnsibleHostDetail = props => {
-  // https://projects.theforeman.org/issues/32398
-  const [activeTab] = useState('variables');
-
+const AnsibleHostDetail = ({
+  response,
+  status,
+  router,
+  location: { pathname },
+  history,
+}) => {
+  const hashHistory = useHistory();
   return (
-    <Tabs activeKey={activeTab} isSecondary>
-      <Tab
-        eventKey="variables"
-        title={<TabTitleText>{__('Variables')}</TabTitleText>}
-      >
-        <div className="host-details-tab-item">
-          <div className="ansible-host-detail">
-            <Label
-              color="blue"
-              icon={<InfoCircleIcon />}
-              style={{ marginTop: '1.5rem' }}
-            >
-              Ansible Variables coming soon!
-            </Label>
-          </div>
-        </div>
-      </Tab>
-    </Tabs>
+    <SkeletonLoader status={status} skeletonProps={{ count: 5 }}>
+      {response?.id && (
+        <>
+          <Tabs
+            onSelect={(evt, subTab) => hashHistory.push(subTab)}
+            activeKey={pathname?.split('/')[2]}
+            isSecondary
+          >
+            {SECONDARY_TABS.map(({ key, title }) => (
+              <Tab
+                key={key}
+                eventKey={key}
+                title={<TabTitleText>{title}</TabTitleText>}
+              />
+            ))}
+          </Tabs>
+          <SecondaryTabRoutes
+            response={response}
+            router={router}
+            history={history}
+          />
+        </>
+      )}
+    </SkeletonLoader>
   );
 };
 
+AnsibleHostDetail.propTypes = {
+  response: PropTypes.object.isRequired,
+  status: PropTypes.string.isRequired,
+  location: PropTypes.object,
+  router: PropTypes.object.isRequired,
+  history: PropTypes.object.isRequired,
+};
+
+AnsibleHostDetail.defaultProps = {
+  location: { pathname: '' },
+};
+
 export default AnsibleHostDetail;

data/webpack/components/AnsibleHostDetail/AnsibleHostDetail.test.js

@@ -1,14 +1,20 @@
 import React from 'react';
-import { render, screen } from '@testing-library/react';
+import { render } from '@testing-library/react';
 import '@testing-library/jest-dom';
-
 import AnsibleHostDetail from './';
 
 describe('AnsibleHostDetail', () => {
-  it('should show content', () => {
-    render(<AnsibleHostDetail />);
+  it('should show skeleton when loading', () => {
+    const { container } = render(
+      <AnsibleHostDetail
+        status="PENDING"
+        response={{ id: 5, name: 'test.example.com' }}
+        router={{}}
+        history={{}}
+      />
+    );
     expect(
-      screen.getByText('Ansible Variables coming soon!')
-    ).toBeInTheDocument();
+      container.getElementsByClassName('react-loading-skeleton')
+    ).toHaveLength(5);
   });
 });

data/webpack/components/AnsibleHostDetail/components/AnsibleHostInventory/AnsibleHostInventory.js

@@ -0,0 +1,22 @@
+import React from 'react';
+import Immutable from 'seamless-immutable';
+import PropTypes from 'prop-types';
+import './AnsibleHostInventory.scss';
+import ReportJsonViewer from '../../../ReportJsonViewer';
+
+const AnsibleHostInventory = ({ inventoryData }) => {
+  const mutableInventory =
+    inventoryData && Immutable.asMutable(inventoryData, { deep: true });
+
+  return (
+    <div className="ansible-host-inventory">
+      <ReportJsonViewer data={mutableInventory} />
+    </div>
+  );
+};
+
+AnsibleHostInventory.propTypes = {
+  inventoryData: PropTypes.object.isRequired,
+};
+
+export default AnsibleHostInventory;

data/webpack/components/AnsibleHostDetail/components/AnsibleHostInventory/AnsibleHostInventory.scss

@@ -0,0 +1,4 @@
+
+.ansible-host-inventory {
+  padding: 1.8rem;
+}