foreman_ansible 10.0.1 → 10.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98a2c9aa6bcc8e2feb5b8eee62d111926d0dab191561f808399587d7462debbc
-  data.tar.gz: 2fc48fc5f59725cd8000229bdf08e68f5e8e53a1158271ce2d6db3766ab5826b
+  metadata.gz: f66c95bc367d1265d1be106e25a63a8fcfae2b95fd8d209f683c260c8d0d3647
+  data.tar.gz: cfad57982a9e2cf39324caf14f656df50148cd451dba92e963cbd54dd22a8875
 SHA512:
-  metadata.gz: a8be9228e0b1532cdbef43e88b0f7ba84f9bd8edc5a9d9e21e1ee6d601f63bbccf16eff5e146f33d18ea06d7cdd5adc528d310d7ddb723ff3a6b91ce3a6774c6
-  data.tar.gz: 35b55ca402a155fae45abd89c6fecde949d133e50b855473a25dba13df9452a13a5b9342b93e49fefd553902909a565dd59f9d57afb07d4f8efec6f0311057a9
+  metadata.gz: 340ab3cb55ecc5c54eb76f483e5e6b24e677831488dad250fd4c4b58ac33f37c7cdd27445246a95594d5f17db091e2df3445f3266c97dbd26dba34ecc88879ab
+  data.tar.gz: f50cb95108f5809cc30b8fdb6627b041d3261949c98fe15e149cef799e5e98ddea3955b39d642de6f1625817ce5e2e1e7e3314b3e59c6e6cb7788e8c59ad0fe3

data/app/helpers/foreman_ansible/smart_proxies_helper.rb

@@ -0,0 +1,38 @@
+module ForemanAnsible
+  module SmartProxiesHelper
+    def can_update_proxy?(proxy)
+      hosts = proxy.smart_proxy_hosts
+
+      return if !can_schedule_jobs? ||
+                hosts.empty? ||
+                !hosts.all? { |host| can_execute_on_host?(host) }
+
+      begin
+        version = proxy.statuses[:version].version
+      rescue Foreman::Exception
+        return false
+      end
+
+      foreman_version = Foreman::Version.new
+      proxy_version = Foreman::Version.new(version['version'])
+
+      foreman_major = foreman_version.major.to_i
+      foreman_minor = foreman_version.minor.to_i
+
+      proxy_major = proxy_version.major.to_i
+      proxy_minor = proxy_version.minor.to_i
+
+      foreman_major > proxy_major ||
+        (foreman_major == proxy_major && foreman_minor > proxy_minor)
+    end
+
+    def proxy_update_button(proxy)
+      feature = RemoteExecutionFeature.feature(:ansible_run_capsule_upgrade)
+      return if feature.nil?
+
+      path = new_job_invocation_path(:host_ids => proxy.infrastructure_host_facets.pluck(:host_id),
+                                     :feature => feature.label)
+      link_to(_('Upgrade'), path)
+    end
+  end
+end

data/app/views/foreman/smart_proxies/_update_smart_proxy.html.erb

@@ -0,0 +1 @@
+<%= proxy_update_button(subject) %>

data/app/views/foreman_ansible/job_templates/capsule_upgrade_-_ansible_default.erb

@@ -1,9 +1,9 @@
 <%#
-name: Capsule Upgrade Playbook
+name: Smart Proxy Upgrade Playbook
 snippet: false
 template_inputs:
 - name: target_version
-  required: true
+  required: false
   input_type: user
   advanced: false
   value_type: plain
@@ -24,6 +24,9 @@ feature: ansible_run_capsule_upgrade
 
 ---
 - hosts: all
+  vars:
+    target_version: "<%= input('target_version').present? ? input('target_version') : product_short_version %>"
+<% if plugin_present?('foreman_theme_satellite') -%>
   tasks:
     - name: Gather the rpm package facts
       package_facts:
@@ -44,7 +47,7 @@ feature: ansible_run_capsule_upgrade
                                "--whitelist=#{input('whitelist_options')}"
                              end -%>
       - name: Upgrade Capsule server using satellite-maintain
-        shell: satellite-maintain upgrade run --assumeyes --target-version=<%= input('target_version') %> <%= whitelist_option %>
+        shell: satellite-maintain upgrade run --assumeyes --target-version={{ target_version }} <%= whitelist_option %>
         register: result
 
       - name: Re-Gather the rpm package facts after the upgrade
@@ -71,3 +74,36 @@ feature: ansible_run_capsule_upgrade
         - name: satellite-maintain upgrade return code is non-zero
           fail:
             msg: "Failed! Capsule server upgrade failed. See /var/log/foreman-installer/capsule.log in the Capsule server for more information"
+<% else -%>
+  tasks:
+    - name: Gather the rpm package facts
+      package_facts:
+        manager: auto
+
+    - name: Fail if the target server is a Foreman server
+      fail:
+        msg: "This playbook cannot be executed on a Foreman server. Use only on a Smart Proxy server."
+      when: "'foreman' in ansible_facts.packages"
+
+    - name: Install foreman release gpg key
+      rpm_key:
+        state: present
+        key: http://yum.theforeman.org/releases/{{ target_version }}/RPM-GPG-KEY-foreman
+      when: target_version != "nightly"
+
+    - name: Update foreman repositories
+      package:
+        name: https://yum.theforeman.org/releases/{{ target_version }}/el{{ ansible_distribution_major_version }}/{{ ansible_architecture }}/foreman-release.rpm
+        state: installed
+
+    - name: Clean yum metadata
+      command: yum clean all
+
+    - name: Update all packages
+      package:
+        name: '*'
+        state: latest
+
+    - name: Run the installer
+      shell: foreman-installer
+<% end -%>

data/db/migrate/20221031114720_rename_capsule_upgrade_playbook.rb

@@ -0,0 +1,21 @@
+class RenameCapsuleUpgradePlaybook < ActiveRecord::Migration[6.0]
+  MAPPING = {
+    'Capsule Upgrade Playbook' => 'Smart Proxy Upgrade Playbook'
+  }.freeze
+
+  def up
+    rename(MAPPING)
+  end
+
+  def down
+    rename(MAPPING.invert)
+  end
+
+  private
+
+  def rename(mapping)
+    mapping.each do |old, new|
+      Template.where(name: old).update_all(name: new)
+    end
+  end
+end

data/lib/foreman_ansible/register.rb

@@ -244,4 +244,17 @@ Foreman::Plugin.register :foreman_ansible do
   describe_hostgroup do
     hostgroup_actions_provider :ansible_hostgroups_actions
   end
+
+  extend_page('smart_proxies/show') do |context|
+    context.add_pagelet :smart_proxy_title_actions,
+                        :name => _('Update Smart Proxy'),
+                        :partial => 'foreman/smart_proxies/update_smart_proxy',
+                        :onlyif => ->(proxy, view) { view.can_update_proxy?(proxy) }
+  end
+  extend_page('smart_proxies/index') do |context|
+    context.add_pagelet :smart_proxy_title_actions,
+                        :name => _('Update Smart Proxy'),
+                        :partial => 'foreman/smart_proxies/update_smart_proxy',
+                        :onlyif => ->(proxy, view) { view.can_update_proxy?(proxy) }
+  end
 end

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 = '10.0.1'
+  VERSION = '10.1.0'
 end

data/test/graphql/queries/host_ansible_roles_query_test.rb

@@ -37,13 +37,15 @@ module Queries
       let(:data) { result['data']['host']['allAnsibleRoles'] }
 
       it 'allows to fetch inherited roles' do
-        value(data['totalCount']).must_equal(2)
+        assert_equal 2, data['totalCount']
+
         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)
+
+        assert_equal role1.name, r1_data['name']
+        assert r1_data['inherited']
+        assert_equal role2.name, r2_data['name']
+        assert_not r2_data['inherited']
       end
 
       it 'allow fetching variables' do
@@ -52,9 +54,10 @@ module Queries
         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)
+
+        assert_equal 2, r1_vars['totalCount']
+        assert_equal 1, r2_vars['totalCount']
+        assert_equal var1.key, r1_vars['nodes'].first['key']
       end
     end
   end

data/test/unit/ansible_provider_test.rb

@@ -19,11 +19,8 @@ class AnsibleProviderTest < ActiveSupport::TestCase
     end
 
     context 'when it is using the ansible_run_host feature' do
-      let(:rex_feature) do
-        RemoteExecutionFeature.where(:label => 'ansible_run_host').first
-      end
-
       it 'has remote_execution_command false' do
+        rex_feature = RemoteExecutionFeature.where(:label => 'ansible_run_host', :name => 'Run Ansible roles').first_or_create
         template_invocation.template.remote_execution_features << rex_feature
         assert_not command_options[:remote_execution_command]
       end
@@ -51,12 +48,12 @@ class AnsibleProviderTest < ActiveSupport::TestCase
   describe '#proxy_batch_size' do
     it 'returns integer if setting is string' do
       Setting.expects(:[]).with('foreman_ansible_proxy_batch_size').returns('10')
-      _(ForemanAnsible::AnsibleProvider.proxy_batch_size).must_equal(10)
+      assert_equal 10, ForemanAnsible::AnsibleProvider.proxy_batch_size
     end
 
     it 'returns nil if setting is empty' do
       Setting.expects(:[]).with('foreman_ansible_proxy_batch_size').returns('')
-      _(ForemanAnsible::AnsibleProvider.proxy_batch_size).must_equal(nil)
+      assert_nil ForemanAnsible::AnsibleProvider.proxy_batch_size
     end
   end
 end

data/test/unit/concerns/host_managed_extensions_test.rb

@@ -18,23 +18,23 @@ class HostManagedExtensionsTest < ActiveSupport::TestCase
 
   describe '#all_ansible_roles' do
     test 'returns assigned roles for host without a hostgroup' do
-      @host.all_ansible_roles.must_equal [@role1]
+      assert_equal [@role1], @host.all_ansible_roles
     end
 
     test 'returns assigned and inherited roles for host with a hostgroup' do
       @host.hostgroup = @hostgroup
-      @host.all_ansible_roles.must_equal [@role2, @role1]
+      assert_equal [@role2, @role1], @host.all_ansible_roles
     end
   end
 
   describe '#inherited_ansible_roles' do
     test 'returns empty array for host without hostgroup' do
-      @host.inherited_ansible_roles.must_equal []
+      assert_equal [], @host.inherited_ansible_roles
     end
 
     test 'returns roles inherited from a hostgroup' do
       @host.hostgroup = @hostgroup
-      @host.inherited_ansible_roles.must_equal [@role2]
+      assert_equal [@role2], @host.inherited_ansible_roles
     end
   end
 
@@ -54,13 +54,13 @@ class HostManagedExtensionsTest < ActiveSupport::TestCase
     FactoryBot.create(:host_ansible_role, :ansible_role_id => @role1.id, :position => 1, :host_id => host.id)
     FactoryBot.create(:host_ansible_role, :ansible_role_id => @role2.id, :position => 2, :host_id => host.id)
     FactoryBot.create(:host_ansible_role, :ansible_role_id => @role3.id, :position => 0, :host_id => host.id)
-    host.ansible_roles.must_equal [@role3, @role1, @role2]
+    assert_equal [@role3, @role1, @role2], host.ansible_roles
   end
 
   test 'should order hostgroup roles before host roles' do
     host = FactoryBot.create(:host, :hostgroup => @hostgroup)
     FactoryBot.create(:host_ansible_role, :ansible_role_id => @role1.id, :position => 0, :host_id => host.id)
-    host.all_ansible_roles.must_equal [@role2, @role1]
+    assert_equal [@role2, @role1], host.all_ansible_roles
   end
 
   test 'should find hosts with role2' do

data/test/unit/concerns/hostgroup_extensions_test.rb

@@ -20,45 +20,45 @@ class HostgroupExtensionsTest < ActiveSupport::TestCase
   describe '#all_ansible_roles' do
     test 'returns assigned roles without any parent hostgroup' do
       @hostgroup.host_ansible_roles
-      @hostgroup.all_ansible_roles.must_equal [@role1, @role3]
+      assert_equal [@role1, @role3], @hostgroup.all_ansible_roles
     end
 
     test 'returns assigned and inherited roles with from parent hostgroup' do
       @hostgroup.parent = @hostgroup_parent
-      @hostgroup.all_ansible_roles.must_equal [@role2, @role1, @role3]
+      assert_equal [@role2, @role1, @role3], @hostgroup.all_ansible_roles
     end
   end
 
   describe '#inherited_ansible_roles' do
     test 'returns empty array for hostgroup without any parent' do
-      @hostgroup.inherited_ansible_roles.must_equal []
+      assert_equal [], @hostgroup.inherited_ansible_roles
     end
 
     test 'returns roles inherited from a chain of parents' do
       @hostgroup.parent = @hostgroup_parent
-      @hostgroup.inherited_ansible_roles.must_equal [@role2]
+      assert_equal [@role2], @hostgroup.inherited_ansible_roles
     end
   end
 
   describe '#inherited_and_own_ansible_roles' do
     test 'returns only hostgroup roles' do
-      @hostgroup_parent.inherited_and_own_ansible_roles.must_equal [@role2]
+      assert_equal [@role2], @hostgroup_parent.inherited_and_own_ansible_roles
     end
 
     test 'returns only hostgroup roles including inheritance' do
       @hostgroup.parent = @hostgroup_parent
-      @hostgroup.inherited_and_own_ansible_roles.must_equal [@role2, @role1]
+      assert_equal [@role2, @role1], @hostgroup.inherited_and_own_ansible_roles
     end
   end
 
   test 'should return ordered roles for hostgroup' do
     @hostgroup.parent = @hostgroup_parent
-    @hostgroup.inherited_and_own_ansible_roles.must_equal [@role2, @role1]
+    assert_equal [@role2, @role1], @hostgroup.inherited_and_own_ansible_roles
   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
+      assert_equal @hostgroup_parent.all_ansible_roles, @hostgroup_parent.clone.all_ansible_roles
     end
   end
 

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

@@ -19,12 +19,12 @@ export const rangeValidator = date => {
 };
 
 export const createValidationSchema = () => {
-  const cantBeBlank = __("can't be blank");
+  const required = __('Required field');
 
   return Yup.object().shape({
-    repeat: Yup.string().required(cantBeBlank),
-    startTime: Yup.string().required(cantBeBlank),
-    startDate: Yup.string().required(cantBeBlank),
+    repeat: Yup.string().required(required),
+    startTime: Yup.string().required(required),
+    startDate: Yup.string().required(required),
   });
 };
 

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

@@ -1,5 +1,7 @@
 import React from 'react';
 import PropTypes from 'prop-types';
+import { useDispatch } from 'react-redux';
+import { push } from 'connected-react-router';
 import { Formik, Field as FormikField } from 'formik';
 import { useMutation } from '@apollo/client';
 import { translate as __ } from 'foremanReact/common/I18n';
@@ -33,6 +35,7 @@ import jobsQuery from '../../../../graphql/queries/recurringJobs.gql';
 
 const NewRecurringJobModal = props => {
   const { onClose, resourceId, resourceName } = props;
+  const dispatch = useDispatch();
 
   const [callMutation] = useMutation(createJobInvocation, {
     refetchQueries: [
@@ -81,10 +84,31 @@ const NewRecurringJobModal = props => {
           actions.push(<Spinner key="spinner" size="lg" />);
         }
 
+        const modalDescription = (
+          <>
+            {__('This job will run all the assigned Ansible roles.')}
+            <br />
+            {__('For more advanced scheduling options')}{' '}
+            <Button
+              variant="link"
+              isInline
+              onClick={() =>
+                dispatch(
+                  push(`/job_invocations/new?host_ids%5B%5D=${resourceId}`)
+                )
+              }
+              key="schedule-job-action"
+            >
+              {__('view remote execution page.')}
+            </Button>
+          </>
+        );
+
         return (
           <Modal
-            variant={ModalVariant.large}
-            title="Create New Recurring Ansible Run"
+            variant={ModalVariant.small}
+            title={__('Schedule recurring Ansible roles job')}
+            description={modalDescription}
             ouiaId="modal-recurring-ansible-run"
             isOpen={props.isOpen}
             className="foreman-modal modal-high"
@@ -103,14 +127,16 @@ const NewRecurringJobModal = props => {
               <FormikField
                 name="startTime"
                 component={TimePickerField}
-                label="Start Time"
+                label="Start time"
                 isRequired
                 is24Hour
+                width="250px"
+                menuAppendTo={() => document.body}
               />
               <FormikField
                 name="startDate"
                 component={DatePickerField}
-                label="Start Date"
+                label="Start date"
                 isRequired
                 validators={[rangeValidator]}
               />

data/webpack/components/AnsibleHostDetail/components/JobsTab/NewRecurringJobModal.scss

@@ -2,6 +2,13 @@
   z-index: 1040;
 }
 
-.modal-high {
-  height: 70%;
+.foreman-modal.modal-high {
+  height: 50vh;
+  @media only screen and (max-height: 960px) {
+    height: 70vh;
+  }
+
+  .pf-c-form-control, .pf-c-date-picker, .pf-c-date-picker__input {
+    width: 250px
+  }
 }

data/webpack/components/AnsibleHostDetail/components/RolesTab/AllRolesModal/index.js

@@ -24,7 +24,7 @@ const AllRolesModal = ({ hostGlobalId, onClose, history }) => {
     title: __('All assigned Ansible roles'),
     disableFocusTrap: true,
     description: __(
-      'This list consists of host assigned roles and group assigned roles. Group assigned roles will always be executed prior to host assigned roles'
+      'This list consists of host assigned roles and group assigned roles. Group assigned roles will always be executed prior to host assigned roles.'
     ),
   };
 

data/webpack/components/AnsibleHostDetail/components/RolesTab/EditRolesModal/index.js

@@ -28,7 +28,7 @@ const EditRolesModal = ({
     title: __('Edit Ansible Roles'),
     disableFocusTrap: true,
     description: __(
-      'Add, remove or reorder host assigned Ansible roles. This host has also group assigned roles that are not displayed here and will always be executed prior to host assigned roles'
+      'Add, remove or reorder host assigned Ansible roles. This host has also group assigned roles that are not displayed here and will always be executed prior to host assigned roles.'
     ),
   };