inventory_refresh 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 30b8f10804bf9537eb1a46c5940eed0d0f2a92f4
-  data.tar.gz: 7ba5fed5a46fd3efd890193abdd55559a9ab0964
+SHA256:
+  metadata.gz: 00266e0193f5fcd991d5f926e9477ddcec56ef52ba3b8d516d5483b43fb6eb36
+  data.tar.gz: 2d8aeb9ca8186c4b337fbdb3813c8f72e6b331f618bb79a12ccd81f56902be26
 SHA512:
-  metadata.gz: d255f6417f67835acbc5da1ab2749dffee496e530fb7efaf5d08fd89d49b4cc1ff9e38455ffc8bd532159d1e05559bfd7eb0e0e1e5495d30b1810170f54ebc8c
-  data.tar.gz: c8317f62895f3eb8bd39aeb0a6aca86f9bb37f08f8fe915865a3b67c04cdb8a9fca5eb6d9a5d30c4f1fceb15f4a7b1246d6da560815c1a0d6f8fc23a85227133
+  metadata.gz: 0a854c89dcccc990099dbc460b18c2aebb8ed18b93bb07f062d6ab384442d999e9afb10e5f8e03808353d4c140900f594ff09313f4dcccb0569a05639c0b5154
+  data.tar.gz: 5d8c54008b0549e32c95925b01b272056ad95b82241cc7449108f627d6898520d30a033c7adaba31d979e41d2bf3d9c367e9d59f67194b3564bc7851243a05d1

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/.idea/
 /.yardoc
 /_yardoc/
 /coverage/

data/.travis.yml

@@ -5,8 +5,17 @@ cache: bundler
 rvm:
   - 2.4.2
 addons:
-  postgresql: '9.4'
+  postgresql: '9.5'
 before_install:
 - gem install bundler -v 1.16.4
-- source ${TRAVIS_BUILD_DIR}/tools/ci/create_db_user.sh
-before_script: bundle exec rake spec:setup
+- psql -c "CREATE USER root SUPERUSER PASSWORD 'smartvm';" -U postgres
+before_script:
+# Code Climate
+- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+- chmod +x ./cc-test-reporter
+- "./cc-test-reporter before-build"
+# inventory_refresh
+- bundle exec rake spec:setup
+after_script:
+# Code Climate
+- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"

data/README.md

@@ -1,8 +1,14 @@
 # InventoryRefresh
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/inventory_refresh`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/inventory_refresh.svg)](http://badge.fury.io/rb/inventory_refresh)
+[![Build Status](https://travis-ci.org/ManageIQ/inventory_refresh.svg)](https://travis-ci.org/ManageIQ/inventory_refresh)
+[![Code Climate](https://codeclimate.com/github/ManageIQ/inventory_refresh.svg)](https://codeclimate.com/github/ManageIQ/inventory_refresh)
+[![Test Coverage](https://codeclimate.com/github/ManageIQ/inventory_refresh/badges/coverage.svg)](https://codeclimate.com/github/ManageIQ/inventory_refresh/coverage)
+[![Security](https://hakiri.io/github/ManageIQ/inventory_refresh/master.svg)](https://hakiri.io/github/ManageIQ/inventory_refresh/master)
 
-TODO: Delete this and the text above, and describe your gem
+[![Chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ManageIQ/manageiq/providers?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+Topological Inventory Persister
 
 ## Installation
 
@@ -33,3 +39,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/inventory_refresh.
+
+## License
+
+The gem is available as open source under the terms of the [Apache License 2.0](LICENSE).

data/inventory_refresh.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "factory_girl", "~> 4.5.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov"
 end

data/lib/inventory_refresh.rb

@@ -2,10 +2,19 @@ require "inventory_refresh/graph"
 require "inventory_refresh/inventory_collection"
 require "inventory_refresh/inventory_object"
 require "inventory_refresh/inventory_object_lazy"
+require "inventory_refresh/logging"
+require "inventory_refresh/null_logger"
 require "inventory_refresh/save_inventory"
 require "inventory_refresh/target"
 require "inventory_refresh/target_collection"
 require "inventory_refresh/version"
 
 module InventoryRefresh
+  class << self
+    attr_accessor :log
+  end
+
+  def self.log
+    @log ||= NullLogger.new
+  end
 end

data/lib/inventory_refresh/inventory_collection/index/proxy.rb

@@ -1,12 +1,15 @@
 require "inventory_refresh/inventory_collection/index/type/data"
 require "inventory_refresh/inventory_collection/index/type/local_db"
 require "inventory_refresh/inventory_collection/index/type/skeletal"
+require "inventory_refresh/logging"
 require "active_support/core_ext/module/delegation"
 
 module InventoryRefresh
   class InventoryCollection
     module Index
       class Proxy
+        include InventoryRefresh::Logging
+
         attr_reader :skeletal_primary_index
 
         # @param inventory_collection [InventoryRefresh::InventoryCollection] InventoryCollection object owning the proxy

data/lib/inventory_refresh/logging.rb

@@ -0,0 +1,8 @@
+require "forwardable"
+
+module InventoryRefresh
+  module Logging
+    extend Forwardable
+    delegate :log => :InventoryRefresh
+  end
+end

data/lib/inventory_refresh/null_logger.rb

@@ -0,0 +1,15 @@
+require "logger"
+
+module InventoryRefresh
+  class NullLogger < Logger
+    def initialize(*_args)
+    end 
+
+    def add(*_args, &_block)
+    end 
+
+    def debug?
+      false
+    end
+  end
+end

data/lib/inventory_refresh/save_collection/base.rb

@@ -1,3 +1,4 @@
+require "inventory_refresh/logging"
 require "inventory_refresh/save_collection/saver/batch"
 require "inventory_refresh/save_collection/saver/concurrent_safe"
 require "inventory_refresh/save_collection/saver/concurrent_safe_batch"
@@ -6,21 +7,23 @@ require "inventory_refresh/save_collection/saver/default"
 module InventoryRefresh::SaveCollection
   class Base
     class << self
+      include InventoryRefresh::Logging
+
       # Saves one InventoryCollection object into the DB.
       #
       # @param ems [ExtManagementSystem] manger owning the InventoryCollection object
       # @param inventory_collection [InventoryRefresh::InventoryCollection] InventoryCollection object we want to save
       def save_inventory_object_inventory(ems, inventory_collection)
-        #_log.debug("Saving collection #{inventory_collection} of size #{inventory_collection.size} to"\
-        #           " the database, for the manager: '#{ems.name}'...")
+        log.debug("Saving collection #{inventory_collection} of size #{inventory_collection.size} to"\
+                  " the database, for the manager: '#{ems.name}'...")
 
         if inventory_collection.custom_save_block.present?
-          #_log.debug("Saving collection #{inventory_collection} using a custom save block")
+          log.debug("Saving collection #{inventory_collection} using a custom save block")
           inventory_collection.custom_save_block.call(ems, inventory_collection)
         else
           save_inventory(inventory_collection)
         end
-        #_log.debug("Saving collection #{inventory_collection}, for the manager: '#{ems.name}'...Complete")
+        log.debug("Saving collection #{inventory_collection}, for the manager: '#{ems.name}'...Complete")
         inventory_collection.saved = true
       end
 

data/lib/inventory_refresh/save_collection/recursive.rb

@@ -44,7 +44,7 @@ module InventoryRefresh::SaveCollection
           end
         end
 
-        #_log.debug("Saving #{inventory_collection} of size #{inventory_collection.size}")
+        log.debug("Saving #{inventory_collection} of size #{inventory_collection.size}")
         save_inventory_object_inventory(ems, inventory_collection)
       end
     end

data/lib/inventory_refresh/save_collection/saver/base.rb

@@ -1,10 +1,12 @@
 require "inventory_refresh/application_record_iterator"
+require "inventory_refresh/logging"
 require "inventory_refresh/save_collection/saver/sql_helper"
 require "active_support/core_ext/module/delegation"
 
 module InventoryRefresh::SaveCollection
   module Saver
     class Base
+      include InventoryRefresh::Logging
       include InventoryRefresh::SaveCollection::Saver::SqlHelper
 
       # @param inventory_collection [InventoryRefresh::InventoryCollection] InventoryCollection object we will be saving
@@ -138,7 +140,7 @@ module InventoryRefresh::SaveCollection
           inventory_objects_index[index] = inventory_object
         end
 
-        #_log.debug("Processing #{inventory_collection} of size #{inventory_collection.size}...")
+        log.debug("Processing #{inventory_collection} of size #{inventory_collection.size}...")
         # Records that are in the DB, we will be updating or deleting them.
         ActiveRecord::Base.transaction do
           association.find_each do |record|
@@ -175,12 +177,12 @@ module InventoryRefresh::SaveCollection
             end
           end
         end
-        #_log.debug("Processing #{inventory_collection}, "\
-        #           "created=#{inventory_collection.created_records.count}, "\
-        #           "updated=#{inventory_collection.updated_records.count}, "\
-        #           "deleted=#{inventory_collection.deleted_records.count}...Complete")
+        log.debug("Processing #{inventory_collection}, "\
+                  "created=#{inventory_collection.created_records.count}, "\
+                  "updated=#{inventory_collection.updated_records.count}, "\
+                  "deleted=#{inventory_collection.deleted_records.count}...Complete")
       rescue => e
-        #_log.error("Error when saving #{inventory_collection} with #{inventory_collection_details}. Message: #{e.message}")
+        log.error("Error when saving #{inventory_collection} with #{inventory_collection_details}. Message: #{e.message}")
         raise e
       end
 
@@ -202,8 +204,8 @@ module InventoryRefresh::SaveCollection
 
         all_manager_uuids_size = inventory_collection.all_manager_uuids.size
 
-        #_log.debug("Processing :delete_complement of #{inventory_collection} of size "\
-        #           "#{all_manager_uuids_size}...")
+        log.debug("Processing :delete_complement of #{inventory_collection} of size "\
+                  "#{all_manager_uuids_size}...")
         deleted_counter = 0
 
         inventory_collection.db_collection_for_comparison_for_complement_of(
@@ -217,8 +219,8 @@ module InventoryRefresh::SaveCollection
           end
         end
 
-        #_log.debug("Processing :delete_complement of #{inventory_collection} of size "\
-        #           "#{all_manager_uuids_size}, deleted=#{deleted_counter}...Complete")
+        log.debug("Processing :delete_complement of #{inventory_collection} of size "\
+                  "#{all_manager_uuids_size}, deleted=#{deleted_counter}...Complete")
       end
 
       # Deletes/soft-deletes a given record
@@ -246,8 +248,8 @@ module InventoryRefresh::SaveCollection
           # relations can return the same record multiple times. We don't want to do SELECT DISTINCT by default, since
           # it can be very slow.
           if false # TODO: Rails.env.production?
-            #_log.warn("Please update :association or :arel for #{inventory_collection} to return a DISTINCT result. "\
-            #            " The duplicate value is being ignored.")
+            log.warn("Please update :association or :arel for #{inventory_collection} to return a DISTINCT result. "\
+                     " The duplicate value is being ignored.")
             return false
           else
             raise("Please update :association or :arel for #{inventory_collection} to return a DISTINCT result. ")
@@ -272,7 +274,7 @@ module InventoryRefresh::SaveCollection
                     "#{inventory_collection.parent.class.name}:"\
                     "#{inventory_collection.parent.try(:id)}"
           if false # TODO: Rails.env.production?
-            #_log.warn("Referential integrity check violated, ignoring #{subject}")
+            log.warn("Referential integrity check violated, ignoring #{subject}")
             return false
           else
             raise("Referential integrity check violated for #{subject}")

data/lib/inventory_refresh/save_collection/saver/concurrent_safe_batch.rb

@@ -97,7 +97,7 @@ module InventoryRefresh::SaveCollection
         all_attribute_keys << :updated_on if supports_updated_on?
         all_attribute_keys << :type if supports_sti?
 
-        #_log.debug("Processing #{inventory_collection} of size #{inventory_collection.size}...")
+        log.debug("Processing #{inventory_collection} of size #{inventory_collection.size}...")
 
         unless inventory_collection.create_only?
           update_or_destroy_records!(batch_iterator(association), inventory_objects_index, attributes_index, all_attribute_keys)
@@ -123,12 +123,12 @@ module InventoryRefresh::SaveCollection
             create_or_update_partial_records(all_attribute_keys)
           end
         end
-        #_log.debug("Processing #{inventory_collection}, "\
-        #           "created=#{inventory_collection.created_records.count}, "\
-        #           "updated=#{inventory_collection.updated_records.count}, "\
-        #           "deleted=#{inventory_collection.deleted_records.count}...Complete")
+        log.debug("Processing #{inventory_collection}, "\
+                  "created=#{inventory_collection.created_records.count}, "\
+                  "updated=#{inventory_collection.updated_records.count}, "\
+                  "deleted=#{inventory_collection.deleted_records.count}...Complete")
       rescue => e
-        #_log.error("Error when saving #{inventory_collection} with #{inventory_collection_details}. Message: #{e.message}")
+        log.error("Error when saving #{inventory_collection} with #{inventory_collection_details}. Message: #{e.message}")
         raise e
       end
 

data/lib/inventory_refresh/save_collection/saver/default.rb

@@ -43,8 +43,8 @@ module InventoryRefresh::SaveCollection
         if unique_db_indexes.include?(index) # Include on Set is O(1)
           # We have a duplicate in the DB, destroy it. A find_each method does automatically .order(:id => :asc)
           # so we always keep the oldest record in the case of duplicates.
-          #_log.warn("A duplicate record was detected and destroyed, inventory_collection: "\
-          #              "'#{inventory_collection}', record: '#{record}', duplicate_index: '#{index}'")
+          log.warn("A duplicate record was detected and destroyed, inventory_collection: "\
+                   "'#{inventory_collection}', record: '#{record}', duplicate_index: '#{index}'")
           record.destroy
           return false
         else

data/lib/inventory_refresh/save_collection/saver/sql_helper.rb

@@ -1,10 +1,13 @@
 require "inventory_refresh/save_collection/saver/sql_helper_update"
 require "inventory_refresh/save_collection/saver/sql_helper_upsert"
+require "inventory_refresh/logging"
 require "active_support/concern"
 
 module InventoryRefresh::SaveCollection
   module Saver
     module SqlHelper
+      include InventoryRefresh::Logging
+
       # TODO(lsmola) all below methods should be rewritten to arel, but we need to first extend arel to be able to do
       # this
 
@@ -51,7 +54,7 @@ module InventoryRefresh::SaveCollection
           connection.quote(value)
         end
       rescue TypeError => e
-        #_log.error("Can't quote value: #{value}, of :#{name} and #{inventory_collection}")
+        log.error("Can't quote value: #{value}, of :#{name} and #{inventory_collection}")
         raise e
       end
 

data/lib/inventory_refresh/save_collection/saver/sql_helper_update.rb

@@ -1,6 +1,10 @@
+require "inventory_refresh/logging"
+
 module InventoryRefresh::SaveCollection
   module Saver
     module SqlHelperUpdate
+      include InventoryRefresh::Logging
+
       # Builds update clause for one column identified by the passed key
       #
       # @param key [Symbol] key that is column name
@@ -14,7 +18,7 @@ module InventoryRefresh::SaveCollection
       # @param all_attribute_keys [Array<Symbol>] Array of all columns we will be saving into each table row
       # @param hashes [Array<Hash>] data used for building a batch update sql query
       def build_update_query(all_attribute_keys, hashes)
-        #_log.debug("Building update query for #{inventory_collection} of size #{inventory_collection.size}...")
+        log.debug("Building update query for #{inventory_collection} of size #{inventory_collection.size}...")
         # Cache the connection for the batch
         connection = get_connection
 
@@ -35,7 +39,7 @@ module InventoryRefresh::SaveCollection
         update_query += update_query_version_conditions(version_attribute)
         update_query += update_query_returning
 
-        #_log.debug("Building update query for #{inventory_collection} of size #{inventory_collection.size}...Complete")
+        log.debug("Building update query for #{inventory_collection} of size #{inventory_collection.size}...Complete")
 
         update_query
       end

data/lib/inventory_refresh/save_collection/saver/sql_helper_upsert.rb

@@ -1,6 +1,10 @@
+require "inventory_refresh/logging"
+
 module InventoryRefresh::SaveCollection
   module Saver
     module SqlHelperUpsert
+      include InventoryRefresh::Logging
+
       # Builds ON CONFLICT UPDATE updating branch for one column identified by the passed key
       #
       # @param key [Symbol] key that is column name
@@ -16,7 +20,7 @@ module InventoryRefresh::SaveCollection
       # @param on_conflict [Symbol, NilClass] defines behavior on conflict with unique index constraint, allowed values
       #        are :do_update, :do_nothing, nil
       def build_insert_query(all_attribute_keys, hashes, on_conflict: nil, mode:, column_name: nil)
-        #_log.debug("Building insert query for #{inventory_collection} of size #{inventory_collection.size}...")
+        log.debug("Building insert query for #{inventory_collection} of size #{inventory_collection.size}...")
 
         # Cache the connection for the batch
         connection = get_connection
@@ -29,7 +33,7 @@ module InventoryRefresh::SaveCollection
         insert_query += insert_query_on_conflict_behavior(all_attribute_keys, on_conflict, mode, ignore_cols, column_name)
         insert_query += insert_query_returning
 
-        #_log.debug("Building insert query for #{inventory_collection} of size #{inventory_collection.size}...Complete")
+        log.debug("Building insert query for #{inventory_collection} of size #{inventory_collection.size}...Complete")
 
         insert_query
       end

data/lib/inventory_refresh/save_collection/topological_sort.rb

@@ -1,4 +1,4 @@
-require "inventory_refresh/graph"
+require "inventory_refresh/logging"
 require "inventory_refresh/inventory_collection/graph"
 require "inventory_refresh/save_collection/base"
 
@@ -17,21 +17,21 @@ module InventoryRefresh::SaveCollection
 
         layers = InventoryRefresh::Graph::TopologicalSort.new(graph).topological_sort
 
-        #_log.debug("Saving manager #{ems.name}...")
+        log.debug("Saving manager #{ems.name}...")
 
-        #sorted_graph_log = "Topological sorting of manager #{ems.name} resulted in these layers processable in parallel:\n"
-        #sorted_graph_log += graph.to_graphviz(:layers => layers)
-        #_log.debug(sorted_graph_log)
+        sorted_graph_log = "Topological sorting of manager #{ems.name} resulted in these layers processable in parallel:\n"
+        sorted_graph_log += graph.to_graphviz(:layers => layers)
+        log.debug(sorted_graph_log)
 
         layers.each_with_index do |layer, index|
-          #_log.debug("Saving manager #{ems.name} | Layer #{index}")
+          log.debug("Saving manager #{ems.name} | Layer #{index}")
           layer.each do |inventory_collection|
             save_inventory_object_inventory(ems, inventory_collection) unless inventory_collection.saved?
           end
-          #_log.debug("Saved manager #{ems.name} | Layer #{index}")
+          log.debug("Saved manager #{ems.name} | Layer #{index}")
         end
 
-        #_log.debug("Saving manager #{ems.name}...Complete")
+        log.debug("Saving manager #{ems.name}...Complete")
       end
     end
   end

data/lib/inventory_refresh/save_inventory.rb

@@ -4,17 +4,19 @@ require "inventory_refresh/save_collection/topological_sort"
 module InventoryRefresh
   class SaveInventory
     class << self
+      include Logging
+
       # Saves the passed InventoryCollection objects
       #
       # @param ems [ExtManagementSystem] manager owning the inventory_collections
       # @param inventory_collections [Array<InventoryRefresh::InventoryCollection>] array of InventoryCollection objects
       #        for saving
       def save_inventory(ems, inventory_collections, strategy = nil)
-        #_log.debug("#{log_header(ems)} Scanning Inventory Collections...Start")
+        log.debug("#{log_header(ems)} Scanning Inventory Collections...Start")
         InventoryRefresh::InventoryCollection::Scanner.scan!(inventory_collections)
-        #_log.debug("#{log_header(ems)} Scanning Inventory Collections...Complete")
+        log.debug("#{log_header(ems)} Scanning Inventory Collections...Complete")
 
-        #_log.info("#{log_header(ems)} Saving EMS Inventory...")
+        log.info("#{log_header(ems)} Saving EMS Inventory...")
 
         if strategy.try(:to_sym) == :recursive
           InventoryRefresh::SaveCollection::Recursive.save_collections(ems, inventory_collections)
@@ -22,7 +24,7 @@ module InventoryRefresh
           InventoryRefresh::SaveCollection::TopologicalSort.save_collections(ems, inventory_collections)
         end
 
-        #_log.info("#{log_header(ems)} Saving EMS Inventory...Complete")
+        log.info("#{log_header(ems)} Saving EMS Inventory...Complete")
         ems
       end
 

data/lib/inventory_refresh/version.rb

@@ -1,3 +1,3 @@
 module InventoryRefresh
-  VERSION = "0.0.1".freeze
+  VERSION = "0.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inventory_refresh
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - ManageIQ Developers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-07 00:00:00.000000000 Z
+date: 2018-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Topological Inventory Persister
 email: 
 executables: []
@@ -164,6 +178,8 @@ files:
 - lib/inventory_refresh/inventory_collection/serialization.rb
 - lib/inventory_refresh/inventory_object.rb
 - lib/inventory_refresh/inventory_object_lazy.rb
+- lib/inventory_refresh/logging.rb
+- lib/inventory_refresh/null_logger.rb
 - lib/inventory_refresh/save_collection/base.rb
 - lib/inventory_refresh/save_collection/recursive.rb
 - lib/inventory_refresh/save_collection/saver/base.rb
@@ -179,7 +195,6 @@ files:
 - lib/inventory_refresh/target.rb
 - lib/inventory_refresh/target_collection.rb
 - lib/inventory_refresh/version.rb
-- tools/ci/create_db_user.sh
 homepage: https://github.com/ManageIQ/inventory_refresh
 licenses:
 - Apache-2.0
@@ -200,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Topological Inventory Persister

data/tools/ci/create_db_user.sh

@@ -1,3 +0,0 @@
-#!/bin/bash
-
-psql -c "CREATE USER root SUPERUSER PASSWORD 'smartvm';" -U postgres