octofacts-updater 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 05efcd40e8410c43eb2fd197165de57b754d0e28
-  data.tar.gz: ad65e6ce8d288593e0b2b03075fcda6f52fbd4cb
+SHA256:
+  metadata.gz: 378e8881afb698fafb804327ef23d85614d8b2d556c7c4945d82fe4f7fbc6cb2
+  data.tar.gz: 9c45ac588e4115cde24c2bb2a9d4028f514cec0bd0caf1c59673f0dad53f9662
 SHA512:
-  metadata.gz: 507c0eecd6dd8c7c281e6734f1dbdde0731ee2e8cfcedd2bc5f9d7fc68fc7805207d5032d3ffc1d20df0e75154afb3786e0ff6f93d03af9e271592d9d45996ec
-  data.tar.gz: e017a38aa6681a768d06cc085f4dc4480e4ef736d6782fd6f05a9d2b24b391bc5911b9e0d47791f080ea3321c96b3117f44cd864e60ba2108f95c22c675e60f7
+  metadata.gz: 3c64cad8078c0e1efd1198dbb556de9733c89f954afc287925365f65b0913f446c5ff823e435e0af347561913cb72a09f68102f9a794c07a646e3997a1e0ea06
+  data.tar.gz: ba83a060abd2fc746d99a1214b7f5e0bb285b4e5c2bfb4e93150a584c84ccdc67bfac163dd7c8a76bc84edcca1e98872551e25489695d2e8d878b842b7b11a3f

data/.version

@@ -1 +1 @@
-0.5.0
+0.6.0

data/bin/octofacts-updater

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
-
+# frozen_string_literal: true
+#
 require "bundler/setup"
 require "octofacts_updater"
 cli = OctofactsUpdater::CLI.new(ARGV)

data/lib/octofacts_updater/cli.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # :nocov:
 require "optparse"
 
@@ -16,8 +17,8 @@ module OctofactsUpdater
         end
 
         opts.on("-c", "--config <config_file>", String, "Path to configuration file") do |f|
-          raise "Invalid configuration file" unless File.file?(f)
-          @opts[:config] = f
+          @opts[:config] = File.expand_path(f)
+          raise "Invalid configuration file #{@opts[:config].inspect}" unless File.file?(@opts[:config])
         end
 
         opts.on("-H", "--hostname <hostname>", String, "FQDN of the host whose facts are to be gathered") do |h|
@@ -67,11 +68,12 @@ module OctofactsUpdater
     end
 
     def usage
-      puts "Usage: octofacts-updater --action <action> [--config-file /path/to/config.yaml] [other options]"
+      puts "Usage: octofacts-updater --action <action> [--config /path/to/config.yaml] [other options]"
       puts ""
       puts "Available actions:"
-      puts "  bulk:  Update fixtures and index in bulk"
-      puts "  facts: Obtain facts for one node (requires --hostname <hostname>)"
+      puts "  bulk:    Update fixtures and index in bulk"
+      puts "  facts:   Obtain facts for one node (requires --hostname <hostname>)"
+      puts "  reindex: Build a new index from the existing fact fixtures"
       puts ""
     end
 
@@ -106,6 +108,7 @@ module OctofactsUpdater
 
       return handle_action_bulk if opts[:action] == "bulk"
       return handle_action_facts if opts[:action] == "facts"
+      return handle_action_bulk if opts[:action] == "reindex"
 
       usage
       exit 255
@@ -126,19 +129,39 @@ module OctofactsUpdater
       end
     end
 
-    def handle_action_bulk
-      facts_to_index = @config.fetch("index", {})["indexed_facts"]
-      unless facts_to_index.is_a?(Array)
-        raise ArgumentError, "Must declare index:indexed_facts in configuration to use bulk update"
-      end
+    def nodes_for_bulk
+      if opts[:action] == "reindex"
+        @opts[:quick] = true
+
+        path = if opts[:path]
+                 File.expand_path(opts[:path])
+               elsif @config.fetch("index", {})["node_path"]
+                 File.expand_path(@config.fetch("index", {})["node_path"], File.dirname(opts[:config]))
+               else
+                 raise ArgumentError, "Must set --path, or define index:node_path to a valid directory in configuration"
+               end
+
+        unless File.directory?(path)
+          raise Errno::ENOENT, "--path must be a directory (#{path.inspect} is not)"
+        end
 
-      nodes = if opts[:host_list]
+        Dir.glob("#{path}/*.yaml").map { |f| File.basename(f, ".yaml") }
+      elsif opts[:host_list]
         opts[:host_list]
       elsif opts[:hostname]
         [opts[:hostname]]
       else
         OctofactsUpdater::FactIndex.load_file(index_file).nodes(true)
       end
+    end
+
+    def handle_action_bulk
+      facts_to_index = @config.fetch("index", {})["indexed_facts"]
+      unless facts_to_index.is_a?(Array)
+        raise ArgumentError, "Must declare index:indexed_facts in configuration to use bulk update"
+      end
+
+      nodes = nodes_for_bulk
       if nodes.empty?
         raise ArgumentError, "Cannot run bulk update with no nodes to check"
       end

data/lib/octofacts_updater/fact.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This class represents a fact, either structured or unstructured.
 # The fact has a name and a value. The name is a string, and the value
 # can either be a string/integer/boolean (unstructured) or a hash (structured).
@@ -65,20 +66,20 @@ module OctofactsUpdater
       end
 
       parts = if name_in.is_a?(String)
-        name_in.split("::")
-      elsif name_in.is_a?(Array)
-        name_in.map do |item|
-          if item.is_a?(String)
-            item
-          elsif item.is_a?(Hash) && item.key?("regexp")
-            Regexp.new(item["regexp"])
-          else
-            raise ArgumentError, "Unable to interpret structure item: #{item.inspect}"
-          end
-        end
-      else
-        raise ArgumentError, "Unable to interpret structure: #{name_in.inspect}"
-      end
+                name_in.split("::")
+              elsif name_in.is_a?(Array)
+                name_in.map do |item|
+                  if item.is_a?(String)
+                    item
+                  elsif item.is_a?(Hash) && item.key?("regexp")
+                    Regexp.new(item["regexp"])
+                  else
+                    raise ArgumentError, "Unable to interpret structure item: #{item.inspect}"
+                  end
+                end
+              else
+                raise ArgumentError, "Unable to interpret structure: #{name_in.inspect}"
+              end
 
       set_structured_value(@value, parts, new_value)
     end

data/lib/octofacts_updater/fact_index.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This class represents a fact index, which is ultimately represented by a YAML file of
 # each index fact, the values seen, and the node(s) containing each value.
 #

data/lib/octofacts_updater/fixture.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This class represents a fact fixture, which is a set of facts along with a node name.
 # Facts are OctofactsUpdater::Fact objects, and internally are stored as a hash table
 # with the key being the fact name and the value being the OctofactsUpdater::Fact object.

data/lib/octofacts_updater/plugin.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This class provides the base methods for fact manipulation plugins.
 
 require "digest"
@@ -61,7 +62,8 @@ module OctofactsUpdater
     #
     # Returns a String with the same length as string_in.
     def self.randomize_long_string(string_in)
-      seed = Digest::MD5.hexdigest(string_in).to_i(36)
+      seed = Digest::SHA512.hexdigest(string_in).to_i(36)
+
       prng = Random.new(seed)
       chars = [("a".."z"), ("A".."Z"), ("0".."9")].flat_map(&:to_a)
       (1..(string_in.length)).map { chars[prng.rand(chars.length)] }.join

data/lib/octofacts_updater/plugins/ip.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file is part of the octofacts updater fact manipulation plugins. This plugin provides
 # methods to update facts that are IP addresses in order to anonymize or randomize them.
 

data/lib/octofacts_updater/plugins/ssh.rb

@@ -1,4 +1,5 @@
 # This file is part of the octofacts updater fact manipulation plugins. This plugin provides
+# frozen_string_literal: true
 # methods to update facts that are SSH keys, since we do not desire to commit SSH keys from
 # actual hosts into the source code repository.
 

data/lib/octofacts_updater/plugins/static.rb

@@ -1,4 +1,5 @@
 # This file is part of the octofacts updater fact manipulation plugins. This plugin provides
+# frozen_string_literal: true
 # methods to do static operations on facts -- delete, add, or set to a known value.
 
 # Delete. This method deletes the fact or the identified portion. Setting the value to nil

data/lib/octofacts_updater/service/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This contains handy utility methods that might be used in any of the other classes.
 
 require "yaml"

data/lib/octofacts_updater/service/enc.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This class contains methods to interact with an external node classifier.
 
 require "open3"

data/lib/octofacts_updater/service/local_file.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This class reads a YAML file from the local file system so that it can be used as a source
 # in octofacts-updater. This was originally intended for a quickstart tutorial, since it requires
 # no real configuration. However it could also be used in production, if the user wants to create

data/lib/octofacts_updater/service/puppetdb.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This class interacts with puppetdb to pull the facts from the recent
 # run of Puppet on a given node. This uses octocatalog-diff on the back end to
 # pull the facts from puppetdb.

data/lib/octofacts_updater/service/ssh.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This class interacts with a puppetserver to obtain facts from that server's YAML cache.
 # This is achieved by SSH-ing to the server and obtaining the fact file directly from the
 # puppetserver's cache. This can also be used to SSH to an actual node and run a command,

data/lib/octofacts_updater/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module OctofactsUpdater
   VERSION = File.read(File.expand_path("../../.version", File.dirname(__FILE__))).strip
 end

data/lib/octofacts_updater.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "octofacts_updater/cli"
 require "octofacts_updater/fact"
 require "octofacts_updater/fact_index"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octofacts-updater
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - GitHub, Inc.
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-06 00:00:00.000000000 Z
+date: 2024-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -68,8 +68,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.9'
-description: |
-  Octofacts-updater is a series of scripts to construct the fact fixture files and index files consumed by octofacts.
+description: 'Octofacts-updater is a series of scripts to construct the fact fixture
+  files and index files consumed by octofacts.
+
+  '
 email: opensource+octofacts@github.com
 executables:
 - octofacts-updater
@@ -106,15 +108,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Scripts to update octofacts fixtures from recent Puppet runs