foreman_ansible 7.0.4 → 8.0.1

data/test/fixtures/sample_playbooks.json

@@ -0,0 +1,10 @@
+[
+  {
+    "name": "xprazak2.forklift_collection.foreman_provisioning.yml",
+    "playbooks_content": "- hosts: all\n  become: true\n  vars:\n    libvirt_tftp: true\n  roles:\n    - foreman\n    - libvirt\n    - foreman_provisioning\n"
+  },
+  {
+    "name": "xprazak2.forklift_collection.collect_debug_draft.yml",
+    "playbooks_content": "---\n- hosts: all\n  become: true\n  vars:\n    bats_output_dir: '/root/bats_results'\n    remote_dir: \"/tmp/debug-{{ pipeline_type | default('foreman') }}-{{ pipeline_version | default('nightly') }}-{{ pipeline_os | default('el7') }}\"\n  roles:\n    - sos_report\n  tasks:\n    - name: \"Find bats files\"\n      find:\n        paths: \"{{ bats_output_dir }}\"\n        patterns: \"*.tap\"\n      register: bats_results\n\n    - name: \"Copy bats results\"\n      fetch:\n        src: \"{{ item.path }}\"\n        dest: \"{{ remote_dir }}\"\n      with_items: \"{{ bats_results.files }}\"\n\n    - name: \"Find smoker files\"\n      find:\n        paths: \"{{ smoker_output_dir }}\"\n        patterns: \"*.xml\"\n      register: smoker_results\n\n    - name: \"Copy smoker results\"\n      fetch:\n        src: \"{{ item.path }}\"\n        dest: \"{{ remote_dir }}\"\n      with_items: \"{{ smoker_results.files }}\"\n"
+  }
+]

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module Api
+  module V2
+    # Tests for the ansible playbooks controller
+    class AnsiblePlaybooksControllerTest < ActionController::TestCase
+      let(:ansible_proxy) { FactoryBot.create(:smart_proxy, :with_ansible) }
+      let(:proxy_api) { ::ProxyAPI::Ansible.new(url: ansible_proxy.url) }
+      let(:playbooks_names) { %w[xprazak2.forklift_collection.foreman_provisioning.yml xprazak2.forklift_collection.collect_debug_draft.yml] }
+      let(:importer_test) { mock('PlaybooksImporter') }
+
+      test 'should fetch with nil' do
+        AnsiblePlaybooksController.any_instance.stubs(:fetch_playbooks_names).returns(nil)
+
+        get :fetch, :params => {
+          :proxy_id => ansible_proxy.id
+        }, :session => set_session_user
+        response = JSON.parse(@response.body)
+        assert_empty response['results']['playbooks_names']
+        assert_response :success
+      end
+
+      test 'should fetch playbooks names' do
+        AnsiblePlaybooksController.any_instance.stubs(:fetch_playbooks_names).returns(playbooks_names)
+
+        get :fetch, :params => {
+          :proxy_id => ansible_proxy.id
+        }, :session => set_session_user
+        response = JSON.parse(@response.body)
+        assert_not_empty response['results']
+        assert_equal response['results']['playbooks_names'], playbooks_names
+      end
+
+      test 'should use correct proxy' do
+        AnsiblePlaybooksController.any_instance.expects(:find_proxy_api).with(ansible_proxy).returns(proxy_api)
+        proxy_api.expects(:playbooks_names).returns(playbooks_names)
+
+        get :fetch, :params => {
+          :proxy_id => ansible_proxy.id
+        }, :session => set_session_user
+        response = JSON.parse(@response.body)
+        assert_not_empty response['results']
+        assert_not_empty playbooks_names = response['results']['playbooks_names']
+        assert_equal 2, playbooks_names.count
+      end
+
+      test 'check plan and sync' do
+        task = mock('Foreman Task')
+        AnsiblePlaybooksController.any_instance.expects(:plan_ansible_sync).with(ansible_proxy.id, playbooks_names).returns(task)
+        task.stubs(:id).returns('123')
+        task.stubs(:action).returns('Import Playbooks')
+
+        put :sync, :params => {
+          :proxy_id => ansible_proxy.id,
+          :playbooks_names => playbooks_names
+        }, :session => set_session_user
+        response = JSON.parse(@response.body)
+        assert_equal '123', response['id']
+        assert_equal 'Import Playbooks', response['action']
+      end
+    end
+  end
+end

data/test/functional/hosts_controller_test.rb

@@ -20,7 +20,7 @@ class HostsControllerExtensionsTest < ActionController::TestCase
                  0 => { :ansible_role_id => @role.id, :position => 0 }
                } }
       post :create, :params => { :host => host }, :session => set_session_user
-      assert_redirected_to host_url(assigns('host'))
+      assert_redirected_to host_details_page_url(assigns('host'))
       assert assigns('host').ansible_roles, [@role]
     end
 
@@ -34,7 +34,7 @@ class HostsControllerExtensionsTest < ActionController::TestCase
              } }
            },
            :session => set_session_user
-      assert_redirected_to host_url(assigns('host'))
+      assert_redirected_to host_details_page_url(assigns('host'))
       assert_equal assigns('host').ansible_roles, [@role]
     end
 

data/test/graphql/queries/host_ansible_roles_query_test.rb

@@ -0,0 +1,61 @@
+require 'test_plugin_helper'
+
+module Queries
+  class HostAnsibleRolesQueryTest < GraphQLQueryTestCase
+    let(:role1) { FactoryBot.create(:ansible_role) }
+    let(:role2) { FactoryBot.create(:ansible_role) }
+    let(:hostgroup) { FactoryBot.create(:hostgroup, ansible_roles: [role1]) }
+    let(:host) { FactoryBot.create(:host, hostgroup: hostgroup, ansible_roles: [role2]) }
+    let(:variables) { { id: Foreman::GlobalId.for(host) } }
+    let(:query) do
+      <<-GRAPHQL
+      query ($id: String!) {
+        host(id: $id) {
+          id
+          allAnsibleRoles {
+            totalCount
+            nodes {
+              id
+              name
+              inherited
+              ansibleVariables {
+                totalCount
+                nodes {
+                  key
+                  override
+                }
+              }
+            }
+          }
+        }
+      }
+      GRAPHQL
+    end
+
+    context 'with admin permissions' do
+      let(:context_user) { FactoryBot.create(:user, :admin) }
+      let(:data) { result['data']['host']['allAnsibleRoles'] }
+
+      it 'allows to fetch inherited roles' do
+        value(data['totalCount']).must_equal(2)
+        r1_data = data['nodes'].first
+        r2_data = data['nodes'].second
+        value(r1_data['name']).must_equal(role1.name)
+        value(r1_data['inherited']).must_equal(true)
+        value(r2_data['name']).must_equal(role2.name)
+        value(r2_data['inherited']).must_equal(false)
+      end
+
+      it 'allow fetching variables' do
+        var1 = FactoryBot.create(:ansible_variable, ansible_role: role1, override: true)
+        FactoryBot.create(:ansible_variable, ansible_role: role1)
+        FactoryBot.create(:ansible_variable, ansible_role: role2, override: true)
+        r1_vars = data['nodes'].first['ansibleVariables']
+        r2_vars = data['nodes'].second['ansibleVariables']
+        value(r1_vars['totalCount']).must_equal(2)
+        value(r2_vars['totalCount']).must_equal(1)
+        value(r1_vars['nodes'].first['key']).must_equal(var1.key)
+      end
+    end
+  end
+end

data/test/unit/import_playbooks_test.rb

@@ -0,0 +1,51 @@
+require 'test_plugin_helper'
+
+class ImportPlaybooksTest < ActiveSupport::TestCase
+  let(:ansible_proxy) { FactoryBot.create(:smart_proxy, :with_ansible) }
+  let(:proxy_api) { ::ProxyAPI::Ansible.new(url: ansible_proxy.url) }
+  subject { ::ForemanAnsible::PlaybooksImporter.new(ansible_proxy) }
+  let(:sample_playbooks) { JSON.parse(File.read(ansible_fixture_file('sample_playbooks.json'))) }
+  let(:playbook1_output) { sample_playbooks.first }
+  let(:playbook2_output) { sample_playbooks.last }
+  let(:first_playbook) { ['xprazak2.forklift_collection.foreman_provisioning.yml'] }
+  let(:second_playbook) { ['xprazak2.forklift_collection.collect_debug_draft.yml'] }
+  let(:playbook1_template) { JSON.parse(File.read(ansible_fixture_file('playbooks_example_output.json')))['template'] }
+
+  setup do
+    subject.stubs(:proxy_api).returns(proxy_api)
+  end
+
+  describe 'check the job templates that were created due to the import' do
+    test 'should just create job templates from playbooks' do
+      subject.expects(:playbooks).with(second_playbook).returns([playbook2_output])
+      actual = subject.import_playbooks(second_playbook)
+      assert_not_nil actual_created = actual[:created]
+      assert_equal 1, actual_created.count
+      job_template = JobTemplate.where(id: actual_created.keys.first).first
+      assert_equal job_template.name, actual_created.values.first
+    end
+  end
+
+  describe 'check the updated job templated due to import playbooks' do
+    test ' should not update an identical job template' do
+      FactoryBot.create(:job_template, id: 111, name: playbook1_output['name'],
+                                       template: playbook1_template)
+      subject.expects(:playbooks).with(first_playbook).returns([playbook1_output])
+      actual = subject.import_playbooks(first_playbook)
+      assert_not_nil actual_updated =  actual[:updated]
+      assert_not_nil actual_created =  actual[:created]
+      assert_equal 0, actual_updated.count
+      assert_equal 0, actual_created.count
+    end
+
+    test ' should just update a job template from playbooks' do
+      job_template = FactoryBot.create(:job_template, id: 112, name: playbook2_output['name'], template: 'check')
+      subject.expects(:playbooks).with(second_playbook).returns([playbook2_output])
+      actual = subject.import_playbooks(second_playbook)
+      assert_not_nil actual_updated = actual[:updated]
+      assert_equal 1, actual_updated.count
+      assert_equal actual_updated.keys.first, job_template.id
+      assert_not_nil job_template.template
+    end
+  end
+end

data/test/unit/lib/proxy_api/ansible_test.rb

@@ -14,6 +14,12 @@ class AnsibleTest < ActiveSupport::TestCase
     assert_equal roles, @proxy_api.roles
   end
 
+  test 'should get ansible playbooks from proxy' do
+    playbooks = ['some_playbook.some_author', 'test_playbook.test_author']
+    @proxy_api.expects(:get).returns(fake_rest_client_response(playbooks))
+    assert_equal playbooks, @proxy_api.playbooks
+  end
+
   test 'should raise error with appropriate message' do
     message = 'Connection refused'
     @proxy_api.expects(:get).raises(Errno::ECONNREFUSED, message)

data/webpack/components/AnsibleHostDetail/components/AnsibleVariableOverrides/AnsibleVariableOverridesTable.js

@@ -4,7 +4,6 @@ import { useDispatch } from 'react-redux';
 import { useMutation } from '@apollo/client';
 
 import { sprintf, translate as __ } from 'foremanReact/common/I18n';
-import { usePaginationOptions } from 'foremanReact/components/Pagination/PaginationHooks';
 import { openConfirmModal } from 'foremanReact/components/ConfirmModal';
 import {
   TableComposable,
@@ -14,8 +13,9 @@ import {
   Th,
   Td,
 } from '@patternfly/react-table';
-import { Flex, FlexItem, Pagination } from '@patternfly/react-core';
+import { Flex, FlexItem } from '@patternfly/react-core';
 
+import Pagination from 'foremanReact/components/Pagination';
 import deleteAnsibleVariableOverride from '../../../../graphql/mutations/deleteAnsibleVariableOverride.gql';
 import EditableAction from './EditableAction';
 import EditableValue from './EditableValue';
@@ -29,10 +29,6 @@ import {
 } from './AnsibleVariableOverridesTableHelper';
 
 import withLoading from '../../../withLoading';
-import {
-  preparePerPageOptions,
-  refreshPage,
-} from '../../../../helpers/paginationHelper';
 
 const reducer = (state, action) =>
   state.map((item, index) => {
@@ -58,8 +54,6 @@ const AnsibleVariableOverridesTable = ({
   hostId,
   hostGlobalId,
   totalCount,
-  pagination,
-  history,
 }) => {
   const columns = [
     __('Name'),
@@ -69,16 +63,6 @@ const AnsibleVariableOverridesTable = ({
     __('Source attribute'),
   ];
 
-  const handlePerPageSelected = (event, perPage) => {
-    refreshPage(history, { page: 1, perPage });
-  };
-
-  const handlePageSelected = (event, page) => {
-    refreshPage(history, { ...pagination, page });
-  };
-
-  const perPageOptions = preparePerPageOptions(usePaginationOptions());
-
   const [editableState, innerDispatch] = useReducer(
     reducer,
     variables,
@@ -162,67 +146,68 @@ const AnsibleVariableOverridesTable = ({
 
   return (
     <React.Fragment>
-      <Flex>
+      <Flex direction={{ default: 'column' }}>
+        <FlexItem align={{ default: 'alignRight' }}>
+          <Pagination updateParamsByUrl itemCount={totalCount} variant="top" />
+        </FlexItem>
+        <FlexItem>
+          <TableComposable variant="compact">
+            <Thead>
+              <Tr>
+                {columns.map(col => (
+                  <Th key={col}>{col}</Th>
+                ))}
+                <Th />
+              </Tr>
+            </Thead>
+            <Tbody>
+              {variables.map((variable, idx) => (
+                <Tr key={idx}>
+                  <Td>
+                    <a href={variable.path}>{variable.key}</a>
+                  </Td>
+                  <Td>{variable.ansibleRoleName}</Td>
+                  <Td>{variable.parameterType}</Td>
+                  <Td>
+                    <EditableValue
+                      variable={variable}
+                      editing={editableState[idx].open}
+                      onChange={onValueChange(idx, variable)}
+                      value={editableState[idx].value}
+                      validation={editableState[idx].validation}
+                      working={editableState[idx].working}
+                    />
+                  </Td>
+                  <Td>{formatSourceAttr(variable)}</Td>
+                  <Td>
+                    <EditableAction
+                      open={editableState[idx].open}
+                      onClose={setEditable(idx, false)}
+                      onOpen={setEditable(idx, true)}
+                      toggleWorking={toggleWorking(idx)}
+                      variable={variable}
+                      state={editableState[idx]}
+                      hostId={hostId}
+                      hostName={hostAttrs.name}
+                      hostGlobalId={hostGlobalId}
+                      onSubmitSuccess={onSubmitSuccess(idx, variable)}
+                      onValidationError={onValidationError(idx)}
+                    />
+                  </Td>
+                  <Td actions={{ items: actionsResolver(variable, idx) }} />
+                </Tr>
+              ))}
+            </Tbody>
+          </TableComposable>
+        </FlexItem>
         <FlexItem align={{ default: 'alignRight' }}>
           <Pagination
+            updateParamsByUrl
             itemCount={totalCount}
-            page={pagination.page}
-            perPage={pagination.perPage}
-            onSetPage={handlePageSelected}
-            onPerPageSelect={handlePerPageSelected}
-            perPageOptions={perPageOptions}
-            variant="top"
+            variant="bottom"
           />
         </FlexItem>
       </Flex>
-      <TableComposable variant="compact">
-        <Thead>
-          <Tr>
-            {columns.map(col => (
-              <Th key={col}>{col}</Th>
-            ))}
-            <Th />
-          </Tr>
-        </Thead>
-        <Tbody>
-          {variables.map((variable, idx) => (
-            <Tr key={idx}>
-              <Td>
-                <a href={variable.path}>{variable.key}</a>
-              </Td>
-              <Td>{variable.ansibleRoleName}</Td>
-              <Td>{variable.parameterType}</Td>
-              <Td>
-                <EditableValue
-                  variable={variable}
-                  editing={editableState[idx].open}
-                  onChange={onValueChange(idx, variable)}
-                  value={editableState[idx].value}
-                  validation={editableState[idx].validation}
-                  working={editableState[idx].working}
-                />
-              </Td>
-              <Td>{formatSourceAttr(variable)}</Td>
-              <Td>
-                <EditableAction
-                  open={editableState[idx].open}
-                  onClose={setEditable(idx, false)}
-                  onOpen={setEditable(idx, true)}
-                  toggleWorking={toggleWorking(idx)}
-                  variable={variable}
-                  state={editableState[idx]}
-                  hostId={hostId}
-                  hostName={hostAttrs.name}
-                  hostGlobalId={hostGlobalId}
-                  onSubmitSuccess={onSubmitSuccess(idx, variable)}
-                  onValidationError={onValidationError(idx)}
-                />
-              </Td>
-              <Td actions={{ items: actionsResolver(variable, idx) }} />
-            </Tr>
-          ))}
-        </Tbody>
-      </TableComposable>
     </React.Fragment>
   );
 };
@@ -233,8 +218,6 @@ AnsibleVariableOverridesTable.propTypes = {
   hostId: PropTypes.number.isRequired,
   hostGlobalId: PropTypes.string.isRequired,
   totalCount: PropTypes.number.isRequired,
-  pagination: PropTypes.object.isRequired,
-  history: PropTypes.object.isRequired,
 };
 
 export default withLoading(AnsibleVariableOverridesTable);

data/webpack/components/AnsibleHostDetail/components/JobsTab/PreviousJobsTable.js

@@ -1,8 +1,6 @@
 import React from 'react';
 import PropTypes from 'prop-types';
 import { translate as __ } from 'foremanReact/common/I18n';
-import { usePaginationOptions } from 'foremanReact/components/Pagination/PaginationHooks';
-
 import RelativeDateTime from 'foremanReact/components/common/dates/RelativeDateTime';
 
 import {
@@ -13,15 +11,12 @@ import {
   Th,
   Td,
 } from '@patternfly/react-table';
-import { Flex, FlexItem, Pagination } from '@patternfly/react-core';
+import { Flex, FlexItem } from '@patternfly/react-core';
+import Pagination from 'foremanReact/components/Pagination';
 
 import { decodeId } from '../../../../globalIdHelper';
 import withLoading from '../../../withLoading';
 import { readableCron, readablePurpose } from './JobsTabHelper';
-import {
-  preparePerPageOptions,
-  refreshPage,
-} from '../../../../helpers/paginationHelper';
 
 const PreviousJobsTable = ({ history, totalCount, jobs, pagination }) => {
   const columns = [
@@ -32,66 +27,57 @@ const PreviousJobsTable = ({ history, totalCount, jobs, pagination }) => {
     __('Schedule'),
   ];
 
-  const handlePerPageSelected = (event, perPage) => {
-    refreshPage(history, { page: 1, perPage });
-  };
-
-  const handlePageSelected = (event, page) => {
-    refreshPage(history, { ...pagination, page });
-  };
-
-  const perPageOptions = preparePerPageOptions(usePaginationOptions());
-
   return (
     <React.Fragment>
       <h3>{__('Previously executed jobs')}</h3>
-      <Flex className="pf-u-pt-md">
+      <Flex direction={{ default: 'column' }} className="pf-u-pt-md">
+        <FlexItem align={{ default: 'alignRight' }}>
+          <Pagination updateParamsByUrl itemCount={totalCount} variant="top" />
+        </FlexItem>
+        <FlexItem>
+          <TableComposable variant="compact">
+            <Thead>
+              <Tr>
+                {columns.map(col => (
+                  <Th key={col}>{col}</Th>
+                ))}
+              </Tr>
+            </Thead>
+            <Tbody>
+              {jobs.map(job => (
+                <Tr key={job.id}>
+                  <Td>
+                    <a
+                      onClick={() =>
+                        window.tfm.nav.pushUrl(
+                          `/job_invocations/${decodeId(job.id)}`
+                        )
+                      }
+                    >
+                      {job.description}
+                    </a>
+                    &nbsp;
+                    {readablePurpose(job.recurringLogic.purpose)}
+                  </Td>
+                  <Td>{job.task.result}</Td>
+                  <Td>{job.task.state}</Td>
+                  <Td>
+                    <RelativeDateTime date={job.startAt} />
+                  </Td>
+                  <Td>{readableCron(job.recurringLogic.cronLine)}</Td>
+                </Tr>
+              ))}
+            </Tbody>
+          </TableComposable>
+        </FlexItem>
         <FlexItem align={{ default: 'alignRight' }}>
           <Pagination
+            updateParamsByUrl
             itemCount={totalCount}
-            page={pagination.page}
-            perPage={pagination.perPage}
-            onSetPage={handlePageSelected}
-            onPerPageSelect={handlePerPageSelected}
-            perPageOptions={perPageOptions}
-            variant="top"
+            variant="bottom"
           />
         </FlexItem>
       </Flex>
-      <TableComposable variant="compact">
-        <Thead>
-          <Tr>
-            {columns.map(col => (
-              <Th key={col}>{col}</Th>
-            ))}
-          </Tr>
-        </Thead>
-        <Tbody>
-          {jobs.map(job => (
-            <Tr key={job.id}>
-              <Td>
-                <a
-                  onClick={() =>
-                    window.tfm.nav.pushUrl(
-                      `/job_invocations/${decodeId(job.id)}`
-                    )
-                  }
-                >
-                  {job.description}
-                </a>
-                &nbsp;
-                {readablePurpose(job.recurringLogic.purpose)}
-              </Td>
-              <Td>{job.task.result}</Td>
-              <Td>{job.task.state}</Td>
-              <Td>
-                <RelativeDateTime date={job.startAt} />
-              </Td>
-              <Td>{readableCron(job.recurringLogic.cronLine)}</Td>
-            </Tr>
-          ))}
-        </Tbody>
-      </TableComposable>
     </React.Fragment>
   );
 };