foreman_teamdynamix 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb9f0ae3f79be59738b81b9733f5ac3c8f5276b5
-  data.tar.gz: 7ec2eb8f477890380ceb45957d91686d81618300
+  metadata.gz: 7ce4c2a7a334ce842ffc0d301d3bb3698eec89e0
+  data.tar.gz: 1e757e66050495e84c00be995dc3a6db5ff78433
 SHA512:
-  metadata.gz: 06ea04572c6513ab8243c485cec4646e6261686d82fd5bc00989c8958a42111dae2822fc6014bfdc71beac1f93717a12551576c68191767009caa2a9a71cd26c
-  data.tar.gz: 00e259b39c62e48baa6a828886992e5cebc30a1c1103102dc46ceb6b03324827f12bd95c7443f426c61481ef55f2eb0cefe87315348d97e71cb0e7e3c38f396d
+  metadata.gz: afc16bd54e8964593702e2dec8f412b1ccf3b031817d77a3ecc0cbb542fdeb05e97656719ab512b6d46d572c493f5e2741e26b0341e6fa24a89ac9fe9ece3b14
+  data.tar.gz: 83e332682132dd98bb7babae29789cccdd10a1144910992c653b64bb768c44e57719a7db8cce2db2b6a3b1ded201e94a6f34f05d6dd03af959e1ba28e3335037

data/README.md

@@ -28,23 +28,23 @@ Example Configuration
     :username: 'xxxxxx'
     :password: 'xxxxxx'
     :create:
-      :StatusID: 641
-      :AcquisitionDate: host.created_at
-      :OwningCustomerName: "'foreman_teamdynamix_plugin_test'"
-      :Attributes:
-      - name: mu.ci.Lifecycle Status
-        id: 11634
-        value: 26190
-      - name: mu.ci.Description
-        id: 11632
-        value: >-
+      StatusID: 641
+      AcquisitionDate: host.created_at
+      OwningCustomerName: "'foreman_teamdynamix_plugin_test'"
+      Attributes:
+      - Name: mu.ci.Lifecycle Status
+        ID: 11634
+        Value: 26190
+      - Name: mu.ci.Description
+        ID: 11632
+        Value: >-
           "created by ForemanTeamdynamix plugin, owner is #{host.owner_id}"
-      - name: Ticket Routing Details
-        id: 11636
-        value: >-
+      - Name: Ticket Routing Details
+        ID: 11636
+        Value: >-
           "Asset for host running on OS #{host.operatingsystem_id}"
     :delete:
-      :StatusId: 642
+      StatusId: 642
   :fields:
     :url: https://miamioh.teamdynamix.com/SBTDNext/Apps
     Asset ID: ID
@@ -58,9 +58,10 @@ Example Configuration
 * All attributes are passed to the TeamDynamix API as is, while creating or deleting a TeamDynamix Asset.
 * An asset gets created or deleted with the Foreman Host create or delete life cycle event.
 
-[:api][:create][:Attributes]
+[:api][:create][Attributes]
 * To configure any [Custom Attributes](https://api.teamdynamix.com/TDWebApi/Home/type/TeamDynamix.Api.CustomAttributes.CustomAttribute) for the asset.
-* It must contain expected value for 'id' and 'value' fields.
+* It must contain expected value for 'Name', 'ID' and 'Value' fields.
+* Notice the case of 'Name', 'ID' and 'Value', this must match for correct merging.
 * rest of the fields are optional, check the Custom Attribute's definition for what other fields are updatable.
 * Code evaluation is supported for custom attribute's value.
 

data/app/helpers/concerns/foreman_teamdynamix/hosts_helper_extensions.rb

@@ -11,9 +11,9 @@ module ForemanTeamdynamix
 
     def teamdynamix_fields
       td_pane_fields = SETTINGS[:teamdynamix][:fields] || DEFAULT_TD_PANE_FIELDS
-      return [[_('Asset'), 'None Associated']] unless @host.teamdynamix_asset_uid
+      return [[_('Asset'), 'None Associated or error from Team Dynamix']] unless @host.teamdynamix_asset
 
-      get_teamdynamix_asset(@host.teamdynamix_asset_uid)
+      @asset = @host.teamdynamix_asset
 
       # display a link to the asset if url set
       fields = asset_uri(td_pane_fields)
@@ -38,12 +38,6 @@ module ForemanTeamdynamix
       end
     end
 
-    def get_teamdynamix_asset(asset_id)
-      @asset = @host.td_api.get_asset(asset_id)
-    rescue StandardError => e
-      raise "Error getting asset Data from Team Dynamix: #{e.message}"
-    end
-
     def get_nested_attrib_val(nested_attrib)
       nested_attrib_tokens = nested_attrib.split('.')
       parent_attrib = nested_attrib_tokens.first
@@ -52,9 +46,9 @@ module ForemanTeamdynamix
       child_attrib.delete!("'")
       parent_attrib_val = @asset[parent_attrib]
       return '' if parent_attrib_val.blank?
-      nested_attrib_val = parent_attrib_val.select { |attrib| attrib['Name'] == child_attrib }
+      nested_attrib_val = parent_attrib_val.find { |attrib| attrib['Name'] == child_attrib }
       return '' if nested_attrib_val.blank?
-      nested_attrib_val[0]['Value']
+      nested_attrib_val['Value']
     end
   end
 end

data/app/models/concerns/foreman_teamdynamix/host_extensions.rb

@@ -2,38 +2,59 @@ module ForemanTeamdynamix
   module HostExtensions
     extend ActiveSupport::Concern
 
+    included do
+      before_create :create_or_update_teamdynamix_asset
+      before_destroy :retire_teamdynamix_asset
+      validates :teamdynamix_asset_uid, uniqueness: { :allow_blank => true }
+    end
+
     def td_api
       @td_api ||= TeamdynamixApi.instance
     end
 
-    included do
-      before_create :create_teamdynamix_asset
-      before_destroy :retire_teamdynamix_asset
-      validates :teamdynamix_asset_uid, uniqueness: { :allow_blank => true }
+    def teamdynamix_asset_status
+      @teamdynamix_asset_status
     end
 
-    private
+    def teamdynamix_asset(search = false)
+      @teamdynamix_asset ||= td_api.get_asset(teamdynamix_asset_uid)
 
-    def create_teamdynamix_asset
-      # when the asset is already in teamdynamix
-      assets = td_api.search_asset(SerialLike: name)
+      if search && !@teamdynamix_asset
+        assets = td_api.search_asset(SerialLike: name)
+        if assets.length == 1
+          @teamdynamix_asset = td_api.get_asset(assets.first['ID'])
+          self.teamdynamix_asset_uid = teamdynamix_asset['ID']
+          @teamdynamix_asset_status = :updated_search
+        elsif assets.length > 1
+          errors.add(:base, _("Search for asset in TeamDynamix failed: Found #{assets.length} matching assets"))
+        end
+      end
 
-      if assets.empty?
-        asset = td_api.create_asset(self)
-        self.teamdynamix_asset_uid = asset['ID']
-      elsif assets.length > 1
-        raise 'Found more than 1 existing asset'
-      else
-        self.teamdynamix_asset_uid = assets.first['ID']
+      @teamdynamix_asset
+    end
+
+    def create_or_update_teamdynamix_asset(save = false)
+      if teamdynamix_asset(true)
         td_api.update_asset(self)
+        @teamdynamix_asset_status ||= :updated_id
+        self.save if save
+      elsif errors.empty?
+        @teamdynamix_asset = td_api.create_asset(self)
+        self.teamdynamix_asset_uid = teamdynamix_asset['ID']
+        @teamdynamix_asset_status = :created
+        self.save if save
+      else
+        false
       end
     rescue StandardError => e
-      errors.add(:base, _("Could not create the asset for the host in TeamDynamix: #{e.message}"))
+      errors.add(:base, _("Could not create or update the asset for the host in TeamDynamix: #{e.message}"))
       false
     end
 
+    private
+
     def retire_teamdynamix_asset
-      td_api.retire_asset(teamdynamix_asset_uid) if teamdynamix_asset_uid
+      td_api.retire_asset(self) if teamdynamix_asset
     rescue StandardError => e
       errors.add(:base, _("Could not retire the asset for the host in TeamDynamix: #{e.message}"))
       false

data/app/services/teamdynamix_api.rb

@@ -20,14 +20,11 @@ class TeamdynamixApi
 
   # returns TeamDynamix.Api.Assets.Asset
   def get_asset(asset_id)
+    return nil unless asset_id
     uri = URI.parse("#{API_URL}/#{APP_ID}/assets/#{asset_id}")
     rest(:get, uri)
-  end
-
-  def asset_exist?(asset_id)
-    get_asset(asset_id).present?
   rescue RuntimeError
-    false
+    nil
   end
 
   def create_asset(host)
@@ -40,9 +37,9 @@ class TeamdynamixApi
     rest(:post, uri, update_asset_payload(host))
   end
 
-  def retire_asset(asset_id)
-    uri = URI.parse("#{API_URL}/#{APP_ID}/assets/#{asset_id}")
-    rest(:post, uri, retire_asset_payload(asset_id))
+  def retire_asset(host)
+    uri = URI.parse("#{API_URL}/#{APP_ID}/assets/#{host.teamdynamix_asset_uid}")
+    rest(:post, uri, retire_asset_payload(host))
   end
 
   # Gets a list of assets matching the specified criteria. (IEnumerable(Of TeamDynamix.Api.Assets.Asset))
@@ -106,26 +103,38 @@ class TeamdynamixApi
     end
   end
 
-  def retire_asset_payload(asset_id)
-    asset = get_asset(asset_id)
-    asset.merge(API_CONFIG[:delete].stringify_keys)
-  end
-
   def create_asset_payload(host)
     ensure_configured_create_params
-    default_attrs = { AppID: APP_ID,
-                      SerialNumber: host.name,
-                      Name: host.fqdn }
-    create_attrs = evaluate_attributes(API_CONFIG[:create], host)
-    default_attrs.merge(create_attrs)
-  end
-
-  def evaluate_attributes(create_attrs, host)
-    create_attrs.symbolize_keys.each_with_object({}) do |(k, v), h|
-      if k.eql?(:Attributes)
-        h[:Attributes] = v.each_with_object([]) do |attribute, a|
-          a << attribute.transform_keys(&:downcase)
-          a.last['value'] = eval_attribute(a.last['value'], host)
+    default_attrs = { 'AppID' => APP_ID,
+                      'SerialNumber' => host.name,
+                      'Name' => host.fqdn }
+    evaluate_attributes(API_CONFIG[:create], host, default_attrs)
+  end
+
+  def update_asset_payload(host)
+    default_attrs = { 'AppID' => APP_ID,
+                      'SerialNumber' => host.name,
+                      'Name' => host.fqdn }
+    evaluate_attributes(API_CONFIG[:create], host, host.teamdynamix_asset.merge(default_attrs))
+  end
+
+  def retire_asset_payload(host)
+    evaluate_attributes(API_CONFIG[:delete], host, host.teamdynamix_asset)
+  end
+
+  def evaluate_attributes(attrs, host, asset = {})
+    attrs.stringify_keys.each_with_object(asset) do |(k, v), h|
+      if k.eql?('Attributes')
+        h['Attributes'] ||= []
+        v.each do |attrib|
+          attrib_c = attrib.stringify_keys
+          match = h['Attributes'].find { |attrib_a| attrib_a['Name'] == attrib_c['Name'] }
+          if match
+            match['Value'] = eval_attribute(attrib_c['Value'], host)
+          else
+            attrib_c['Value'] = eval_attribute(attrib_c['Value'], host)
+            h['Attributes'] << attrib_c
+          end
         end
       else
         h[k] = eval_attribute(v, host)
@@ -140,21 +149,16 @@ class TeamdynamixApi
   end
 
   def must_configure_create_params
-    [:StatusID]
+    ['StatusID']
   end
 
   def valid_auth_token?(token)
     token.match(/^[a-zA-Z0-9\.\-\_]*$/)
   end
 
-  def update_asset_payload(host)
-    asset = get_asset(host.teamdynamix_asset_uid)
-    asset.merge(create_asset_payload(host))
-  end
-
   def ensure_configured_create_params
     must_configure_create_params.each do |must_configure_param|
-      unless API_CONFIG[:create].include?(must_configure_param)
+      unless API_CONFIG[:create].include?(must_configure_param) || API_CONFIG[:create].include?(must_configure_param.to_sym)
         raise("#{must_configure_param} is required. Set it as a configuration item.")
       end
     end

data/lib/foreman_teamdynamix/version.rb

@@ -1,3 +1,3 @@
 module ForemanTeamdynamix
-  VERSION = '0.4.2'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/lib/tasks/teamdynamix.rake

@@ -6,47 +6,41 @@ desc <<-DESC.strip_heredoc.squish
   It could be run for all the hosts as:
     * rake teamydynamix:sync:hosts
 
+  Available options:
+    * where => where string for limiting host query
+    * limit => limit for limiting host query
+
 DESC
 namespace :teamdynamix do
   namespace :sync do
     task :hosts => :environment do
-      td_api = TeamdynamixApi.instance
       errors = []
-      creates = 0
-      updates_from_serial_matching = 0
-      update_from_asset_id = 0
+      created = 0
+      updated_search = 0
+      updated_id = 0
 
       console_user = User.find_by(login: 'foreman_console_admin')
       User.current = console_user
 
-      Host.all.each do |h|
-        # if asset exists, update it
-        if td_api.asset_exist?(h.teamdynamix_asset_uid)
-          td_api.update_asset(h)
-          update_from_asset_id += 1
-        else
-          assets = td_api.search_asset(SerialLike: h.name)
-          if assets.empty?
-            asset = td_api.create_asset(h)
-            h.teamdynamix_asset_uid = asset['ID']
-            errors.push("Could not save host: #{h.name} (#{h.id})") unless h.save
-            creates += 1
-          elsif assets.length > 1
-            errors.push("Could not sync: Found more than 1 asset for #{h.name} (#{h.id})")
-          else
-            h.teamdynamix_asset_uid = assets.first['ID']
-            td_api.update_asset(h)
-            errors.push("Could not save host: #{h.name} (#{h.id})") unless h.save
-            updates_from_serial_matching += 1
+      hosts = Host
+      hosts = hosts.where(ENV['where']) if ENV['where']
+      hosts = hosts.limit(ENV['limit']) if ENV['limit']
+
+      hosts.all.each do |h|
+        if h.create_or_update_teamdynamix_asset(true)
+          case h.teamdynamix_asset_status
+          when :created then created += 1
+          when :updated_search then updated_search += 1
+          when :updated_id then updated_id += 1
           end
+        else
+          errors.push("Could not save host: #{h.name} (#{h.id}):\n  #{h.errors.full_messages.join("\n  ")}")
         end
         sleep(1.5) # TD only allows 60 api calls per minute
       end
-      puts "Assets created: #{creates}" unless creates.eql?(0)
-      unless updates_from_serial_matching.eql?(0)
-        puts "Assets updated from serial search: #{updates_from_serial_matching}"
-      end
-      puts "Assets updated from ID: #{update_from_asset_id}" unless update_from_asset_id.eql?(0)
+      puts "Assets created: #{created}" unless created.eql?(0)
+      puts "Assets updated from serial search: #{updated_search}" unless updated_search.eql?(0)
+      puts "Assets updated from ID: #{updated_id}" unless updated_id.eql?(0)
       puts "Errors:\n#{errors.join("\n")}" unless errors.empty?
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_teamdynamix
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Nipendar Tyagi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2018-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface