Fixes #33852 - Content - Errata - Add REX actions #9766

parthaa · 2021-11-05T04:14:15Z

What are the changes introduced in this pull request?

On the new host errata page

Added support for installing both individual and multiple errata (including select all) via Katello Agent or Rex
Updated the errata install template with new added fields to support Select All and excludes
For applicable errata you will be able to go to the appropriate Apply Erratum page when you click on the kebab.

What are the testing steps for this pull request?

On the dev env

Go to Hosts -> Job Templates
Unlock the Install Errata - Katello SSH Default template using the Actions Dropdown
Run this from the rails console

    JobTemplate.without_auditing do
      template_files = Dir[File.join("#{Katello::Engine.root}/app/views/foreman/job_templates/**/*.erb")]
      template_files.reject! { |file| file.end_with?('_ansible_default.erb') } unless Katello.with_ansible?
      template_files.each do |template|
        sync = !Rails.env.test? && Setting[:remote_execution_sync_templates]
        # import! was renamed to import_raw! around 1.3.1
        if JobTemplate.respond_to?('import_raw!')
          template = JobTemplate.import_raw!(File.read(template), :default => true, :lock => true, :update => sync)
        else
          template = JobTemplate.import!(File.read(template), :default => true, :lock => true, :update => sync)
        end

        template.organizations << Organization.unscoped.all if template&.organizations&.empty?
        template.locations << Location.unscoped.all if template&.locations&.empty?
      end
    end

This should update the install errata erb template.
In the UI Go to Hosts -> Job Templates
Click on Install Errata - Katello SSH Default template
Click on the Inputs tab. You should see 3 inputs with name Filte Errata, Inclusion Type, and errata

Set up the host

These steps will give you both Applicable and Installable errata on the host.

Create and Sync this repo -> https://partha.fedorapeople.org/test-repos/multi-errata/
Create another repo in the same product. Leave the feed empty
Create a Dev lifecycle environment
Create a content view with the repos created in steps 1 and 2
Publish and Promote it to dev
Create an activation that points dev/cv. Make sure the subscriptions are turned on
Register a rhel7/centos7 with that activation key
On client yum install armadillo-0.1-1.noarch
Also rpm -ivh https://jlsherrill.fedorapeople.org/fake-repos/needed-errata/walrus-0.71-1.noarch.rpm https://jlsherrill.fedorapeople.org/fake-repos/needed-errata/whale-0.2-1.noarch.rpm https://jlsherrill.fedorapeople.org/fake-repos/needed-errata/shark-0.1-1.noarch.rpm https://jlsherrill.fedorapeople.org/fake-repos/needed-errata/stork-0.12-2.noarch.rpm
Now edit the repo in step 2 and add the feed url -> https://jlsherrill.fedorapeople.org/fake-repos/needed-errata/
Sync this repo
Now you should have 38 Applicable Errata and 37 installable errata
Go to Hosts -> New Host Details -> Content -> Errata tab

Now there are 4 bulk apply operations available on this page

Apply by Katello Agent
Apply by Remote Execution
Apply by Customized Remote Execution
Apply button - if remote_execution_by default is enabled then it will use rex. Else it 'll use katello-agent to install the errata.

There are also 3 apply operations available on each installable errata

Apply by Katello Agent
Apply by Remote Execution
Apply by Customized Remote Execution

On Applicable errata we should see an Apply Erratum link that should take you to Errata - Apply to Content Hosts page.

Select All Errata
Select Apply by Customized Remote Execution
You should be redirected to the Job Invocations errata install page, where you shoud be able to see elements of the new template
Notice the Inclusion Type entry saying Include all errata EXCEPT below . The select all resolves to this
On same page Filter Errata will get populated if you have search query set and done a Select All
Try out different errata operations and make sure they get applied correctly on the host.

Guidelines for Code Review

Backend Changes

Moved Bulk operations to a BulkItemsHelper class so that Errata/Traces can make use of the select all.
Updated the install_errata.erb template. Added inputs to handle bulk selection operations.
Added an advisory_helpers method in host managed extensions to aid with the new template.

Front End Changes

In ErrataTab mainly added functionality for errata Apply operations.

theforeman-bot · 2021-11-05T04:14:18Z

Issues: #33852

parthaa · 2021-11-08T20:41:35Z

app/views/foreman/job_templates/install_errata.erb

jturel · 2021-11-10T21:45:57Z

app/views/katello/api/v2/content_facet/show.json.rabl

@@ -25,6 +25,14 @@ child :content_facet => :content_facet_attributes do
  node :katello_tracer_installed do |content_facet|
    content_facet.tracer_installed?
  end
+
+  node :katello_agent_enabled do


I know as a dev it's easy to add these here our sake but it feels a bit weird. Random idea: could the /katello/api/v2 (or similar endpoint) expose some amount of configuration? Multiple places may need this info and a content facet may not be in scope at that point (I don't have an example off the top of my head)?

Or maybe Foreman or other plugin has established something we can use?

This was discussed also. I could get the configuration separately but having that information embedded in the host details made best sense for me. Given we already have katello_tracer_installed and katello_agent_installed there. I dont see why adding katello_agent_enabled and remote_execution_by_default attributes should be a red flag. Considering these are details pertinent to this host?

The examples you gave are reflective of the state of the content host - whether tracer or agent is installed. The fields you've added are related to the configuration of Katello which I guess is pertinent but also has nothing to do with the content facet itself. If you and Jeremy are good then let's go with it

I think ForemanContext would be the ideal place to have something like this. It already contains other global app settings. The problem is that adding values there requires Foreman code changes, and also we'd be adding Katello-specific data. Until we can come up with a way to address both of those issues, I think adding it here is... okay but not great. Adding to the / API endpoint is an interesting idea too, but then we'd have to make an additional API call.

I think going with what we have is fine for now, because at least it's an API call that we're already making. Unless someone can think of another brilliant idea :)

First time I've seen ForemanContext and it really does seem like the right place. I'm surprised that component wasn't designed with plugin extensibility in mind. That is something we should look into in the future!

parthaa · 2021-11-12T04:16:28Z

@jturel @jeremylenz Updated this PR and tests to use the Errata Search Query. Check the latest commit.

jeremylenz

looking great!

webpack/components/Table/TableHooks.js

webpack/components/extensions/HostDetails/Tabs/__tests__/errataTab.test.js

Refs #33852 - Addressing bad Template Refs #33852 - Adding tests

jeremylenz

Haven't been able to test select all yet but I tested the REX actions and they work as expected.

a few comments below :)

jeremylenz · 2021-11-15T15:12:36Z

app/views/foreman/job_templates/install_errata.erb

@@ -6,10 +6,10 @@ description_format: 'Install errata %{errata}'
 feature: katello_errata_install
 provider_type: SSH
 template_inputs:
- name: errata
-  description: A comma separated list of errata to install
+- name: Errata Search Query


Suggested change

- name: Errata Search Query

- name: Errata search query

On all the new pages we've been instructed to use this style of capitalization.

I think this broke the display of the job name. All my tasks now say

Install errata ''

but they should say the errata ID:

Install errata '2021-blahblah-30148u'

I think if you change line 5 above to

description_format: 'Install errata %{Errata search query}'

it will maybe hopefully fix it.

jeremylenz · 2021-11-15T15:13:42Z

app/views/foreman/job_templates/install_errata.erb

@@ -19,6 +19,8 @@ foreign_input_sets:
    <% advisories = input(:errata).split(',').join(' ') %>
    <%= render_template('Package Action - SSH Default', :action => 'install -n -t patch', :package => advisories) %>
 <% else %>
-    <% advisories = input(:errata).split(',').map { |e| "--advisory=#{e}" }.join(' ') %>
+    <% advisory_ids = @host.advisory_ids(search: input("Errata Search Query")) %>


Suggested change

<% advisory_ids = @host.advisory_ids(search: input("Errata Search Query")) %>

<% advisory_ids = @host.advisory_ids(search: input("Errata search query")) %>

webpack/components/Table/TableHooks.js

jeremylenz · 2021-11-15T15:18:07Z

webpack/components/extensions/HostDetails/Tabs/ErrataTab.js

+              if (isInstallable) {
+                rowActions = [


For non-installable errata, I think these items should still be there, just disabled.

Its a different list for non installable but applicable.

not sure what you mean here?

For applicable errata you want to show Apply Erratum which takes em to errata page.
For installable you want to show Apply vi Katello agent etc.

Ahhh gotcha.

Update webpack/components/extensions/HostDetails/Tabs/__tests__/errataTab.test.js Co-authored-by: Jeremy Lenz <jlenz@redhat.com> Refs #33852 - Addressed comments

jturel

ACK from code perspective. Looks great and the updates appear to map to the meeting we had last week all while maintaining backward compatibility with the existing REX template. That's awesome!

jeremylenz

Thanks for your patience @parthaa

everything seems to work great! Just a couple Katello agent comments

jeremylenz · 2021-11-17T18:09:47Z

webpack/components/extensions/HostDetails/Tabs/ErrataTab.js

+    { errata_ids: [id] },
+  ));
+
+  const apply = () => (contentFacet.remoteExecutionByDefault ? applyViaRemoteExecution() :


The Apply button uses different logic to decide whether to use Katello agent, compared to the dropdown items. This uses

contentFacet.remoteExecutionByDefault

whereas the dropdowns use

contentFacet.katelloAgentInstalled && contentFacet.katelloAgentEnabled

Was this intended? In my environment, the Apply button tries to use Katello agent, but I don't have any Katello agent actions in the dropdowns. This could be confusing.

Changed this condition a little. (contentFacet.remoteExecutionByDefault || !katelloAgentAvailable)
So if the thing cant be installed via katello agent it will still try rex (even if you have rexByDefault false).

webpack/components/extensions/HostDetails/Tabs/ErrataTab.js

app/views/foreman/job_templates/install_errata.erb

Co-authored-by: Jeremy Lenz <jlenz@redhat.com> Update webpack/components/extensions/HostDetails/Tabs/ErrataTab.js Co-authored-by: Jeremy Lenz <jlenz@redhat.com> Update app/views/foreman/job_templates/install_errata.erb Co-authored-by: Jeremy Lenz <jlenz@redhat.com> more

jeremylenz

Changes LGTM

APJ 👍

parthaa · 2021-11-17T23:26:45Z

[test katello]

parthaa · 2021-11-18T00:14:04Z

[test katello]

* Fixes #33852 - Content - Errata - Add REX actions (cherry picked from commit 0e7f14c)

parthaa added the Work In Progress label Nov 5, 2021

theforeman-bot added Needs testing Not yet reviewed labels Nov 5, 2021

parthaa force-pushed the rex4 branch 3 times, most recently from eec9f30 to 1e3b13b Compare November 5, 2021 20:44

parthaa removed the Work In Progress label Nov 8, 2021

parthaa changed the title ~~[WIP] Fixes #33852 - Content - Errata - Add REX actions~~ Fixes #33852 - Content - Errata - Add REX actions Nov 8, 2021

parthaa force-pushed the rex4 branch from 1e3b13b to 1c57382 Compare November 8, 2021 18:44

parthaa closed this Nov 8, 2021

parthaa reopened this Nov 8, 2021

parthaa force-pushed the rex4 branch 3 times, most recently from c41b944 to 12c589a Compare November 10, 2021 21:30

jturel reviewed Nov 10, 2021

View reviewed changes

parthaa force-pushed the rex4 branch from 12c589a to 6791f4b Compare November 10, 2021 21:51

jeremylenz reviewed Nov 12, 2021

View reviewed changes

webpack/components/Table/TableHooks.js Outdated Show resolved Hide resolved

webpack/components/extensions/HostDetails/Tabs/__tests__/errataTab.test.js Outdated Show resolved Hide resolved

theforeman-bot added the Waiting on contributor label Nov 12, 2021

parthaa force-pushed the rex4 branch from 855e8f7 to afcfc17 Compare November 12, 2021 21:01

theforeman-bot added Waiting on contributor and removed Waiting on contributor labels Nov 12, 2021

parthaa force-pushed the rex4 branch from afcfc17 to d776353 Compare November 12, 2021 21:03

theforeman-bot added Waiting on contributor and removed Waiting on contributor labels Nov 12, 2021

parthaa added 2 commits November 12, 2021 20:13

Fixes #33852 - Content - Errata - Add REX actions

b44822c

Refs #33852 - Addressing bad Template Refs #33852 - Adding tests

Refs #33852 - Fetch Bulk Params Query Version

e64a257

jeremylenz reviewed Nov 15, 2021

View reviewed changes

Refs #33852 - Fetch Bulk Params Query - By Default

87e4131

Update webpack/components/extensions/HostDetails/Tabs/__tests__/errataTab.test.js Co-authored-by: Jeremy Lenz <jlenz@redhat.com> Refs #33852 - Addressed comments

parthaa force-pushed the rex4 branch from d776353 to 87e4131 Compare November 15, 2021 20:01

theforeman-bot added Waiting on contributor and removed Waiting on contributor labels Nov 15, 2021

jturel approved these changes Nov 15, 2021

View reviewed changes

jeremylenz reviewed Nov 17, 2021

View reviewed changes

theforeman-bot added Waiting on contributor and removed Waiting on contributor labels Nov 17, 2021

parthaa force-pushed the rex4 branch from f0d79ca to 49b870f Compare November 17, 2021 18:54

theforeman-bot removed the Waiting on contributor label Nov 17, 2021

parthaa force-pushed the rex4 branch from b3fc6ab to 94da1b3 Compare November 17, 2021 19:12

jeremylenz approved these changes Nov 17, 2021

View reviewed changes

Refs #33852 - Fixed apply

5f59e85

parthaa force-pushed the rex4 branch from 94da1b3 to 5f59e85 Compare November 17, 2021 20:36

parthaa merged commit 0e7f14c into Katello:master Nov 18, 2021

parthaa deleted the rex4 branch November 18, 2021 01:17

chris1984 pushed a commit that referenced this pull request Nov 29, 2021

Fixes #33852 - Content - Errata - Add REX actions (#9766)

58e9c6b

* Fixes #33852 - Content - Errata - Add REX actions (cherry picked from commit 0e7f14c)

chris1984 pushed a commit that referenced this pull request Nov 29, 2021

Fixes #33852 - Content - Errata - Add REX actions (#9766)

05ba43e

* Fixes #33852 - Content - Errata - Add REX actions (cherry picked from commit 0e7f14c)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes #33852 - Content - Errata - Add REX actions #9766

Fixes #33852 - Content - Errata - Add REX actions #9766

parthaa commented Nov 5, 2021 •

edited

Loading

theforeman-bot commented Nov 5, 2021

parthaa commented Nov 8, 2021

jturel Nov 10, 2021

parthaa Nov 10, 2021 •

edited

Loading

jturel Nov 10, 2021

jeremylenz Nov 11, 2021

jturel Nov 11, 2021

parthaa commented Nov 12, 2021

jeremylenz left a comment

jeremylenz left a comment

jeremylenz Nov 15, 2021

jeremylenz Nov 15, 2021

parthaa Nov 15, 2021

jeremylenz Nov 15, 2021

jeremylenz Nov 15, 2021

parthaa Nov 15, 2021

jeremylenz Nov 15, 2021

parthaa Nov 15, 2021

jeremylenz Nov 15, 2021

jturel left a comment

jeremylenz left a comment

jeremylenz Nov 17, 2021

parthaa Nov 17, 2021

jeremylenz left a comment

parthaa commented Nov 17, 2021

parthaa commented Nov 18, 2021

	<% advisory_ids = @host.advisory_ids(search: input("Errata Search Query")) %>
	<% advisory_ids = @host.advisory_ids(search: input("Errata search query")) %>

Fixes #33852 - Content - Errata - Add REX actions #9766

Fixes #33852 - Content - Errata - Add REX actions #9766

Conversation

parthaa commented Nov 5, 2021 • edited Loading

What are the changes introduced in this pull request?

What are the testing steps for this pull request?

On the dev env

Set up the host

Guidelines for Code Review

Backend Changes

Front End Changes

theforeman-bot commented Nov 5, 2021

parthaa commented Nov 8, 2021

Choose a reason for hiding this comment

parthaa Nov 10, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

parthaa commented Nov 12, 2021

jeremylenz left a comment

Choose a reason for hiding this comment

jeremylenz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jturel left a comment

Choose a reason for hiding this comment

jeremylenz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeremylenz left a comment

Choose a reason for hiding this comment

parthaa commented Nov 17, 2021

parthaa commented Nov 18, 2021

parthaa commented Nov 5, 2021 •

edited

Loading

parthaa Nov 10, 2021 •

edited

Loading