Fixes #37772 - Add controller guardrails for multi-CV params on hosts and activation keys #11139
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jeremylenz
force-pushed
the
37772-host-update-guardrails
branch
3 times, most recently
from
755d9b2 to
5a34691
Compare
|
ugh I really should do the same for activation keys too.. 🤔 |
jeremylenz
force-pushed
the
37772-host-update-guardrails
branch
from
5a34691 to
ffbebf3
Compare
jeremylenz
commented
Sep 13, 2024
| @@ -63,8 +57,7 @@ def default_environment? | |||
| end | |||
|
|
|||
| def candlepin_name | |||
| return environment.label if default_environment? | |||
| "#{environment.label}/#{content_view.label}" | |||
| label | |||
There was a problem hiding this comment.
The generate_info method already enforces this same logic when updating the CVE. So this enabled candlepin_name to get a lot simpler.
There was a problem hiding this comment.
how about
alias_method :candlepin_name, :label
There was a problem hiding this comment.
rake aborted!
NameError: undefined method `label' for class `#<Class:0x0000563816dc4e80>'
/home/runner/work/katello/katello/katello/app/models/katello/content_view_environment.rb:59:in `alias_method'
There was a problem hiding this comment.
I tried alias_method :candlepin_name, :label and alias_method :label, :candlepin_name and neither worked. I changed it back.
jeremylenz
commented
Sep 13, 2024
| # Must do maps here to ensure CVEs remain in the same order. | ||
| # Using ActiveRecord .where will return them in a different order. | ||
| if ids.present? | ||
| ids.map! do |id| | ||
| cves = ids.map do |id| |
There was a problem hiding this comment.
The ! here was mutating params[:content_view_environment_ids] and causing the error message to be incorrect with uncompacted arrays like No content view environments found with ids: [nil].
jeremylenz
changed the title
jeremylenz
force-pushed
the
37772-host-update-guardrails
branch
from
ffbebf3 to
d4ca55d
Compare
jeremylenz
force-pushed
the
37772-host-update-guardrails
branch
from
46ecff2 to
534e69d
Compare
jeremylenz
force-pushed
the
37772-host-update-guardrails
branch
from
534e69d to
8f3df28
Compare
parthaa
reviewed
Sep 26, 2024
parthaa
reviewed
Sep 26, 2024
parthaa
reviewed
Sep 26, 2024
|
Nice work!. Overall LGTM. Just a couple of suggestions. |
jeremylenz
force-pushed
the
37772-host-update-guardrails
branch
2 times, most recently
from
678abff to
4950a76
Compare
|
🍏 |
|
Looks good suggested patch. Basically added a diff --git a/app/controllers/katello/api/v2/activation_keys_controller.rb b/app/controllers/katello/api/v2/activation_keys_controller.rb
index fd0ae762d1..0d15610b92 100644
--- a/app/controllers/katello/api/v2/activation_keys_controller.rb
+++ b/app/controllers/katello/api/v2/activation_keys_controller.rb
@@ -81,7 +81,7 @@ module Katello
param :id, :number, :desc => N_("ID of the activation key"), :required => true
def update
if @content_view_environments.present? || update_cves?
- if @content_view_environments.length == 1
+ if single_assignment? && @content_view_environments.length == 1
@activation_key.assign_single_environment(
content_view: @content_view_environments.first.content_view,
lifecycle_environment: @content_view_environments.first.lifecycle_environment
@@ -332,9 +332,13 @@ module Katello
end
end
- def update_cves?
+ def single_assignment?
(params.key?(:environment_id) && params.key?(:content_view_id)) || # single
- (params.key?(:environment) && params.key?(:content_view)) ||
+ (params.key?(:environment) && params.key?(:content_view))
+ end
+
+ def update_cves?
+ single_assignment? ||
params.key?(:content_view_environments) || # multi
params.key?(:content_view_environment_ids)
end |
|
Tested hammer updates/ Activation key page UI updates with the patch. Seems to work well :) |
also some light refactoring around candlepin names and content view environments Refs #37772 - allow for clearing of CVEs on AK Refs #37772 - don't clear CVEs on AngularJS update
jeremylenz
force-pushed
the
37772-host-update-guardrails
branch
from
4a7b979 to
6940cf5
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What are the changes introduced in this pull request?
Previously, the API hosts and activation keys controllers would allow invalid inputs for
content_view_environmentsandcontent_view_environment_ids. This would result in failing silently and reassigning your host to have no content view environments. Bad.Now we don't do that anymore. Also, I added quite a few tests.
Considerations taken when implementing this change?
Ended up doing some refactoring that made sense here, of the
with_candlepin_namesmethod. Turns out ContentViewEnvironment has alabelfield that we should have been using all along.What are the testing steps for this pull request?
See https://community.theforeman.org/t/foreman-3-12-release-candidate-feedback/39258/5?u=jeremylenz
do stuff like that and make sure it errors correctly.