add create_catalog_item class method to ServiceTemplate #13589

jntullo · 2017-01-19T19:35:59Z

This is a class method on ServiceTemplate to create_catalog_item.
The format for the options passed in are as follows:

      {
        :name         => 'Atomic Service Template',
        :service_type => 'atomic',
        :prov_type    => 'amazon',
        :display      => 'false',
        :description  => 'a description',
        :config_info  => {
          :miq_request_dialog_name => request_dialog.name,
          :placement_auto          => [true, 1],
          :number_of_vms           => [1, '1'],
          :src_vm_id               => [vm.id, vm.name],
          :vm_name                 => vm.name,
          :schedule_type           => ['immediately', 'Immediately on Approval'],
          :instance_type           => [flavor.id, flavor.name],
          :src_ems_id              => [ems.id, ems.name],
          :provision               => {
            :fqname            => ra1.fqname,
            :service_dialog_id => service_dialog.id
          },
          :retirement              => {
            :fqname            => ra2.fqname,
            :service_dialog_id => service_dialog.id
          }
        }
      }

Much of this is based off of #12594. By creating these class methods, it will simplify the process of creating catalog items. Once these class methods are completed, #12594 will be updated to account for these changes with a much simpler API

@miq-bot assign @bzwei
@miq-bot add_label enhancement, euwe/no, services
cc: @h-kataria

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

bzwei · 2017-01-19T20:38:39Z

app/models/service_template.rb

@@ -45,6 +45,19 @@ class ServiceTemplate < ApplicationRecord
  virtual_has_one :custom_actions, :class_name => "Hash"
  virtual_has_one :custom_action_buttons, :class_name => "Array"

+  # This method creates
+  def self.create_catalog_item(options, auth_user)


Do you want to add get_catalog_item in this PR?

bzwei · 2017-01-19T20:40:18Z

app/models/service_template.rb

+    create(options.except(:config_info)).tap do |service_template|
+      config_info = options[:config_info].except(:ae_endpoints)
+      workflow_class = MiqProvisionWorkflow.class_for_source(config_info[:src_vm_id])
+      raise 'Could not find Provision Workflow class for source VM' unless workflow_class


Should allow to create a generic service template without workflow but possibly a subtype

bzwei · 2017-01-19T20:41:09Z

app/models/service_template.rb

@@ -45,6 +45,19 @@ class ServiceTemplate < ApplicationRecord
  virtual_has_one :custom_actions, :class_name => "Hash"
  virtual_has_one :custom_action_buttons, :class_name => "Array"

+  # This method creates
+  def self.create_catalog_item(options, auth_user)


Can you add blank lines to improve the readability?

bzwei · 2017-01-19T20:42:30Z

app/models/service_template.rb

@@ -45,6 +45,19 @@ class ServiceTemplate < ApplicationRecord
  virtual_has_one :custom_actions, :class_name => "Hash"
  virtual_has_one :custom_action_buttons, :class_name => "Array"

+  # This method creates
+  def self.create_catalog_item(options, auth_user)
+    create(options.except(:config_info)).tap do |service_template|


I assume before the create method you wanted to invalidate options and add default values where applicable

bzwei · 2017-01-19T20:45:37Z

app/models/service_template.rb

@@ -45,6 +45,19 @@ class ServiceTemplate < ApplicationRecord
  virtual_has_one :custom_actions, :class_name => "Hash"
  virtual_has_one :custom_action_buttons, :class_name => "Array"

+  # This method creates
+  def self.create_catalog_item(options, auth_user)
+    create(options.except(:config_info)).tap do |service_template|


I would include the whole create process in a transaction block because multiple db records are created in this method and they should be rollback back if any error occurs.

bzwei · 2017-01-20T14:04:40Z

spec/models/service_template_spec.rb

+          :schedule_type           => ['immediately', 'Immediately on Approval'],
+          :instance_type           => [flavor.id, flavor.name],
+          :src_ems_id              => [ems.id, ems.name],
+          :provisioning            => {


Let's change to :provision

bzwei · 2017-01-20T14:06:34Z

spec/models/service_template_spec.rb

+      expect(service_template.service_resources.count).to eq(1)
+      expect(service_template.service_resources.first.resource_type).to eq('MiqRequest')
+      expect(service_template.dialogs.first).to eq(service_dialog)
+      expect(service_template.resource_actions.pluck(:action)).to include('Provision', 'Reconfigure', 'Retirement')


Not always include the three resource actions. Only create as requested.

bzwei · 2017-01-20T14:07:00Z

app/models/service_template.rb

+    ae_endpoints ||= {}
+    [
+      {:name      => 'Provision',
+       :param_key => :provisioning,


:provision

bzwei · 2017-01-20T14:07:51Z

app/models/service_template.rb

+       :method    => 'default_retirement_entry_point',
+       :args      => []}
+    ].each do |action|
+      ae_endpoint = ae_endpoints[action[:param_key]] || {}


skip if ae_endpoint is nil
If user wants to define an action without dialog and use default entry point, an empty hash should be used like

:config_info => { :retirement => {} }

bzwei · 2017-01-20T19:05:02Z

app/models/service_template.rb

+    options[:config_info].assert_valid_keys(CATALOG_ITEM_ATTRS)
+    transaction do
+      create(options.except(:config_info)).tap do |service_template|
+        config_info = options[:config_info].except(:provisioning, :retirement, :reconfigure)


:provision

bzwei · 2017-01-20T19:15:09Z

app/models/service_template.rb

@@ -45,6 +60,22 @@ class ServiceTemplate < ApplicationRecord
  virtual_has_one :custom_actions, :class_name => "Hash"
  virtual_has_one :custom_action_buttons, :class_name => "Array"

+  def self.create_catalog_item(options, auth_user)
+    options[:config_info].assert_valid_keys(CATALOG_ITEM_ATTRS)


I am not convinced we want to validate keys this way which makes maintaining the list difficult. I suggest we not limit keys here and leave the backend further down to raise error if invalid keys are encountered.

I like your way to create a template create(options.except(:config_info)). This way we can accept for example either options[:service_template_catalog_id] = 1 or options[:service_template_catalog]=catalog_obj.

bzwei · 2017-01-20T20:30:34Z

spec/models/service_template_spec.rb

+        :description  => 'a description',
+        :config_info  => {
+          :miq_request_dialog_name => request_dialog.name,
+          :service_dialog_id       => service_dialog.id,


no need of this line

bzwei · 2017-01-20T20:42:41Z

@miq-bot assign @gmcculloug

bzwei · 2017-01-20T20:45:31Z

@jntullo can you update the final format in the description section of this PR?

jntullo · 2017-01-20T20:49:31Z

@bzwei done 👍

provisioning to provision removing validation update create_resource_actions

miq-bot · 2017-01-25T18:14:16Z

Checked commits jntullo/manageiq@ef6758a~...1564ad8 with ruby 2.2.6, rubocop 0.47.1, and haml-lint 0.20.0
2 files checked, 0 offenses detected
Everything looks good. 👍

bzwei · 2017-01-25T18:47:22Z

LGTM @gmcculloug Can you take a final look?

add create_catalog_item class method to ServiceTemplate

ef6758a

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

miq-bot assigned bzwei Jan 19, 2017

miq-bot added enhancement euwe/no lifecycle/services labels Jan 19, 2017

bzwei reviewed Jan 19, 2017

View reviewed changes

bzwei reviewed Jan 20, 2017

View reviewed changes

bzwei approved these changes Jan 20, 2017

View reviewed changes

miq-bot assigned gmcculloug and unassigned bzwei Jan 20, 2017

This was referenced Jan 23, 2017

add create_catalog_item to ServiceTemplateOrchestration #13628

Merged

add create_catalog_item to ServiceTemplateAnsibleTower #13646

Merged

adds a transaction and validation

1564ad8

provisioning to provision removing validation update create_resource_actions

gmcculloug merged commit 6f9e87b into ManageIQ:master Jan 26, 2017

gmcculloug added this to the Sprint 53 Ending Jan 30, 2017 milestone Jan 26, 2017

jntullo deleted the enhancement/create_service_resources branch November 28, 2017 19:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add create_catalog_item class method to ServiceTemplate #13589

add create_catalog_item class method to ServiceTemplate #13589

jntullo commented Jan 19, 2017 •

edited

Loading

bzwei Jan 19, 2017

bzwei Jan 19, 2017

bzwei Jan 19, 2017

bzwei Jan 19, 2017

bzwei Jan 19, 2017

bzwei Jan 20, 2017

bzwei Jan 20, 2017

bzwei Jan 20, 2017

bzwei Jan 20, 2017

bzwei Jan 20, 2017

bzwei Jan 20, 2017

bzwei Jan 20, 2017

bzwei commented Jan 20, 2017

bzwei commented Jan 20, 2017

jntullo commented Jan 20, 2017

miq-bot commented Jan 25, 2017

bzwei commented Jan 25, 2017

add create_catalog_item class method to ServiceTemplate #13589

add create_catalog_item class method to ServiceTemplate #13589

Conversation

jntullo commented Jan 19, 2017 • 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

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

bzwei commented Jan 20, 2017

bzwei commented Jan 20, 2017

jntullo commented Jan 20, 2017

miq-bot commented Jan 25, 2017

bzwei commented Jan 25, 2017

jntullo commented Jan 19, 2017 •

edited

Loading