New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create or delete a catalog item on update #14830

Merged

gmcculloug merged 7 commits into ManageIQ:master from syncrou:deux_1438839_create_or_delete_catalog_item_on_update

Apr 25, 2017

Contributor

syncrou commented Apr 20, 2017 •

edited

Loading

When updating an existing AnsiblePlaybook catalog item - add the ability to add a new retirement playbook if one didn't previously exist before: Case A

Also, allow deleting of an existing job_template if the update does not pass in a :playbook_id:
Case B

Further more: If you create a new catalog item, delete it, and then create a new one with the same name as the old one you will no longer receive an error: Case C

Testing notes:

Case A

Create new Ansible Playbook Catalog item without a retirement playbook
Edit the above Catalog Item and add a retirement playbook.

Case B

Create new Ansible Playbook Catalog item without a retirement playbook
Edit the above Catalog Item and add a retirement playbook.
Edit the above Catalog Item again and delete the retirement playbook.

Case C

Create a new catalog item
Delete that catalog item
Create a new catalog item with the same name as in part 1.

https://www.pivotaltracker.com/story/show/141868401

https://www.pivotaltracker.com/story/show/141265431

https://bugzilla.redhat.com/show_bug.cgi?id=1438839

https://bugzilla.redhat.com/show_bug.cgi?id=1442006

syncrou added 3 commits

April 17, 2017 15:53


          Update a catalog item with a new retirement template

4bcb4bd

When updating an existing AnsiblePlaybook catalog item - add the ability to add a new retirement playbook if one didn't previously exist before

Testing notes:

Create new Ansible Playbook Catalog item without a retirement playbook
Edit the above Catalog Item and add a retirement playbook.

https://www.pivotaltracker.com/story/show/141868401

https://bugzilla.redhat.com/show_bug.cgi?id=1438839


          Allow updating a catalog item to change/add job_templates

b979f07

When updating an existing AnsiblePlaybook catalog item - add the ability to add a new retirement playbook if one didn't previously exist before

Also, allow deleting of an existing job_template if the update does not pass in a playbok id

https://www.pivotaltracker.com/story/show/141868401

https://www.pivotaltracker.com/story/show/141265431

https://bugzilla.redhat.com/show_bug.cgi?id=1438839


          Add specs around the new update behavior

d9dfb78

Contributor Author

syncrou commented Apr 20, 2017

@miq-bot assign @bzwei

@miq-bot add_label bug, providers/ansible_tower, services

cc - @gmcculloug

miq-bot assigned bzwei

miq-bot added bug providers/ansible_tower lifecycle/services labels


          Remove unused CONFIG_BASIC_HASH

693af1a

syncrou force-pushed the deux_1438839_create_or_delete_catalog_item_on_update branch from 2c79ac1 to 693af1a Compare

April 20, 2017 20:07

bzwei suggested changes

View reviewed changes

app/models/service_template_ansible_playbook.rb Outdated

+                    end
+                  end
+                end
                 def update_catalog_item(options, auth_user = nil)
                   config_info = validate_update_config_info(options)
                   name = options[:name]

Contributor

bzwei Apr 20, 2017

name = options[:name] || name
same for description

app/models/service_template_ansible_playbook.rb Outdated

-                    new_dialog = create_new_dialog(info[:new_dialog_name], job_template(action), info[:hosts]) if info[:new_dialog_name]
-                    config_info[action][:dialog_id] = new_dialog.id if new_dialog
+                  new_dialogs(config_info)

Contributor

bzwei Apr 20, 2017

Method names: I prefer to use verbs for method names, except nouns for getters.
Adjust the order: update_job_templates, create_job_templates, create_dialogs
Let's reuse the class method create_job_templates, like self.class.create_job_templates(name, description, config_info, auth_user, self)

app/models/service_template_ansible_playbook.rb Outdated

+                def create_job_template(service_name, description, config_info, auth_user)
+                  [:provision, :retirement, :reconfigure].each_with_object({}) do |action, hash|
+                    next unless new_job_template_required(config_info[action], action)
+                    hash[action] = { :configuration_template => self.class.send(:create_job_template, "miq_#{service_name}_#{action}", description, config_info[action], auth_user),

Contributor

bzwei Apr 20, 2017

extract "miq_#{service_name}_#{action}" into a method

app/models/service_template_ansible_playbook.rb Outdated

+                  info && job_template(action).nil? && info.key?(:playbook_id)
+                end
+                def create_job_template(service_name, description, config_info, auth_user)

Contributor

bzwei Apr 20, 2017

no need

app/models/service_template_ansible_playbook.rb Outdated

@@ @@ -71,12 +71,17 @@ def create_new_dialog(dialog_name, job_template, hosts) @@
                 def self.create_job_templates(service_name, description, config_info, auth_user)
                   [:provision, :retirement, :reconfigure].each_with_object({}) do |action, hash|
-                    next unless config_info[action] && config_info[action].key?(:playbook_id)
+                    next unless new_job_template_required(config_info[action])

Contributor

bzwei Apr 21, 2017

next unless new_job_template_required?(config_info[action], action, service_template)

app/models/service_template_ansible_playbook.rb Outdated

+                def job_template_modifications(name, description, config_info, auth_user)
+                  [:provision, :retirement, :reconfigure].each do |action|
+                    info = config_info[action]
+                    if info && info.key?(:playbook_id) && !info.key?(:create_only)

Contributor

bzwei Apr 21, 2017

if job_template(action)

no need to add :create_only, but this method needs to be called before creating new job templates.

app/models/service_template_ansible_playbook.rb Outdated

                     hash[action] = { :configuration_template => create_job_template("miq_#{service_name}_#{action}", description, config_info[action], auth_user) }
                   end
                 end
                 private_class_method :create_job_templates
+                def self.new_job_template_required(info)

Contributor

bzwei Apr 21, 2017

def self.new_job_template_required?(info, action, service_template)
  info && info.key?(:playbook_id) && service_template.job_template(action).nil?
end

app/models/service_template_ansible_playbook.rb Outdated

		@@ -71,12 +71,17 @@ def create_new_dialog(dialog_name, job_template, hosts)

		def self.create_job_templates(service_name, description, config_info, auth_user)

Contributor

bzwei Apr 21, 2017

def self.create_job_templates(service_name, description, config_info, auth_user, service_template = nil)

app/models/service_template_ansible_playbook.rb Outdated

@@ @@ -190,4 +217,20 @@ def delete_job_templates(job_templates) @@
                       .delete_in_provider_queue(job_template.manager.id, { :manager_ref => job_template.manager_ref }, auth_user)
                   end
                 end
+                def new_dialog_required(info)

Contributor

bzwei Apr 21, 2017

add ? to the method name

app/models/service_template_ansible_playbook.rb Outdated

+                  info && info.key?(:new_dialog_name)
+                end
+                def new_job_template_required(info, action)

Contributor

bzwei Apr 21, 2017

no need.

Contributor Author

syncrou commented Apr 24, 2017

@bzwei - I believe I have addressed your feedback.

cc - @gmcculloug

bzwei reviewed

View reviewed changes

app/models/service_template_ansible_playbook.rb Outdated

    
                  name = options[:name]

                  description = options[:description]

                def job_template(action)

                  resource = resource_actions.find_by(:action => action.to_s.capitalize)

Contributor

bzwei Apr 25, 2017

can we do

resource_actions.find_by(:action => action.to_s.capitalize).try(:configuration_template)

?

app/models/service_template_ansible_playbook.rb Outdated

    
                def update_job_templates(name, description, config_info, auth_user)

                  [:provision, :retirement, :reconfigure].each do |action|

                    info = config_info[action]

                    next unless info

Contributor

bzwei Apr 25, 2017

Since job_template may not exist, we should never call job_template!. We do not need to update a job template if it does not exist. Therefore the logic should be like this

  next unless info   # no intention to change anything for this action
  
  job_template = job_template(action)
  next unless job_template   # job_template does not exist
  
  if info.key?(:playbook_id) # job_template exists, and playbook is given, try an update
    # update
  else                       # job_template exists but no more playbook, try a delete
    # delete
  end

app/models/service_template_ansible_playbook.rb Outdated

    
            @@ -134,26 +144,55 @@ def validate_update_config_info(options)
          
                  self.class.send(:validate_config_info, opts)

                end

                def job_template(action)

                def job_template!(action)

Contributor

bzwei Apr 25, 2017

Can you double check existing code where job_template was called? Do they need to change to job_template!?

app/models/service_template_ansible_playbook.rb Outdated

    
                  end

                end

                private_class_method :create_job_templates

                def self.new_job_template_required(info, action, service_template)

Contributor

bzwei Apr 25, 2017

self.new_job_template_required?

Can you move this method down next to instance method new_dialog_required?

syncrou force-pushed the deux_1438839_create_or_delete_catalog_item_on_update branch 5 times, most recently from f1ccb7b to bb63d49 Compare

April 25, 2017 17:26

bzwei reviewed

View reviewed changes

app/models/service_template_ansible_playbook.rb Outdated

    
                  end

                end

                private_class_method :create_job_templates

                def self.new_job_template_required(info, action, service_template)

Contributor

bzwei Apr 25, 2017

this method is no longer needed.

bzwei reviewed

View reviewed changes

app/models/service_template_ansible_playbook.rb Outdated

    
                    new_dialog = create_new_dialog(info[:new_dialog_name], job_template(action), info[:hosts]) if info[:new_dialog_name]

                    config_info[action][:dialog_id] = new_dialog.id if new_dialog

                def new_job_templates(config_info, name, description, auth_user)

Contributor

bzwei Apr 25, 2017

new_job_templates is no longer needed

syncrou added 2 commits

April 25, 2017 14:33


          Addressing feedback

e391b26


          Add prepend true to around_destroy

f44a845

Allow the around destroy callback to also prepend to the front of the callback chain

syncrou force-pushed the deux_1438839_create_or_delete_catalog_item_on_update branch from bb63d49 to f44a845 Compare

April 25, 2017 18:35

bzwei approved these changes

View reviewed changes


          Privatize and reorder

f7e80bf

Change all methods not specifically needed by the UI into private methods
Alphabetize all methods under private

syncrou force-pushed the deux_1438839_create_or_delete_catalog_item_on_update branch from 58bdd07 to f7e80bf Compare

April 25, 2017 19:00

Member

miq-bot commented Apr 25, 2017

Checked commits syncrou/manageiq@4bcb4bd~...f7e80bf with ruby 2.2.6, rubocop 0.47.1, and haml-lint 0.20.0
2 files checked, 0 offenses detected
Everything looks good. ⭐

gmcculloug added the fine/yes label

Contributor Author

syncrou commented Apr 25, 2017

@miq-bot add_label blocker

miq-bot added the blocker label

gmcculloug merged commit 258dd18 into ManageIQ:master

gmcculloug added this to the Sprint 60 Ending May 8, 2017 milestone

simaishi pushed a commit that referenced this pull request


          Merge pull request #14830 from syncrou/deux_1438839_create_or_delete_…

b82c87a

…catalog_item_on_update

Create or delete a catalog item on update
(cherry picked from commit 258dd18)

https://bugzilla.redhat.com/show_bug.cgi?id=1445894
https://bugzilla.redhat.com/show_bug.cgi?id=1445942

Contributor

simaishi commented Apr 26, 2017

Fine backport details:

$ git log -1
commit b82c87a1f49f94afcc94570eb8db5f11c651b924
Author: Greg McCullough <gmccullo@redhat.com>
Date:   Tue Apr 25 17:30:30 2017 -0400

    Merge pull request #14830 from syncrou/deux_1438839_create_or_delete_catalog_item_on_update
    
    Create or delete a catalog item on update
    (cherry picked from commit 258dd189206418143b9f948bbc93aefac972ee66)
    
    https://bugzilla.redhat.com/show_bug.cgi?id=1445894
    https://bugzilla.redhat.com/show_bug.cgi?id=1445942

simaishi added fine/backported and removed fine/yes labels

Fryguy added the providers/automation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blocker bug fine/backported lifecycle/services providers/automation