opensecret 0.0.913 → 0.0.941

data/lib/opensecret/plugins.io/facts/fact.tree.rb

@@ -1,661 +0,0 @@
-#!/usr/bin/ruby
-
-# --
-# -- -----------------
-# -- Fact Production
-# -- -----------------
-# --
-# -- The fact tree is tasked with fact production
-# -- (population). Fact production is done by [consuming]
-# --
-# --   [1] - simple string, number of boolean facts
-# --   [2] - facts already produced
-# --   [3] - identity facts from command line and environment
-# --   [4] - software (behaviour) that derives facts
-# --   [5] - inherited (extended) facts from (OO) parents
-# --
-# --
-# --
-# -- -----------------------------------------
-# -- The 4 Universal (DevOps) Creation Facts
-# -- -----------------------------------------
-# --
-# -- No matter the (DevOps) eco-system being fabricated, these four
-# -- facts prevail and stand out.
-# --
-# -- Every time a DevOps [eco-system] is created, cloned, or recovered,
-# -- a small cluster of core facts endure to define the instance and act
-# -- as the identification basis of all new eco-system resources.
-# --
-# -- The 4 facts underpinning eco-system creation are
-# --
-# --   [1] - [what] is being built
-# --   [2] - [when] did the building begin
-# --   [3] - [who] instigated it (and from)
-# --   [4] - [which] workstation.
-# --
-# -- ---------------------------------------
-# -- DevOps 4 Creational [Instance] Facts
-# -- ---------------------------------------
-# --
-# -- The core instance identities used and reused time and again relate to
-# --
-# --   [1] - plugin      (eg) wordpress.hub or jenkins.hub
-# --   [2] - time        (eg) 18036.0952.065
-# --   [3] - user        (eg) peterpan
-# --   [4] - workstation (eg) laptop_susie or hp_desktop
-# --
-# --
-class FactTree
-  include Singleton
-
-  @@eval_prefix = "e>>"
-  attr_reader :i, :f
-
-  # --
-  # -- Initialize the internal fact database
-  # -- which is exposed for fact consumption
-  # -- via
-  # --
-  # --  @i => [identity] facts (1D)
-  # --  @n => (reserved perhaps 4 nested facts)
-  # --  @f => [file facts] database (2D)
-  # --  @a => (reserved)
-  # --  @c => coded consumtion (in software)
-  # --  @t => template placeholders (2D)
-  # --  @s => sibling (same category) facts (1D)
-  # --
-  def instantiate plugin_id, plugin_folder
-
-    @i = { :plugin  => plugin_id,
-           :time    => Stamp.yyjjj_hhmm_sst,
-           :user    => Home.usr,
-           :src_dir => plugin_folder,
-           :station => nil
-         }
-
-    @f = {}
-
-    @s = {}
-
-    @f.store symbol(plugin_id), {}
-    @p = @f[symbol(plugin_id)]
-
-
-  end
-
-
-
-  #--
-  #-- Set the main directory path.
-  #-- This method adds the parameter path to
-  #-- the identity map. After this method
-  #-- executes you will be able to access the
-  #-- directory with @i[:dir]
-  #--
-  def add_dir_to_identity key_directory
-    @i[:dir] = key_directory
-  end
-
-
-
-  # --
-  # --
-  # --
-  def assimilate_plugin_facts
-
-    plugin_fact_filepath = File.join @i[:src_dir], "#{@i[:plugin]}.ini"
-    log.info(ere) { "Plugin Factfile => #{plugin_fact_filepath}" }
-    assimilate_ini_file plugin_fact_filepath
-
-  end
-
-
-  # --
-  # --
-  # --
-  def assimilate_general_facts
-
-    facts_folder = fact_path("published.facts")
-
-    factfiles_map = Files.in_folders( Array.new.push(facts_folder) )
-    factfiles_map.each do |file_name, folder_name|
-
-      log.info(ere) {"Assimilating facts from => [#{file_name}]"}
-      factfile_path = File.join factfiles_map[file_name], file_name
-      log.info(ere) {"Factfile location => [#{nickname factfile_path}]"}
-      assimilate_ini_file factfile_path
-
-    end
-
-  end
-
-
-  # --
-  # -- Assimilate [[ hub-runtime.ini ]]
-  # -- This factfile builds upon the (fundamental) handful of
-  # -- identity facts. It derives the facts for
-  # --
-  # --   - the plugin instance folder
-  # --   - the instance stamp id keys
-  # --
-  # -- The instance fact file is not allowed to harbour any
-  # -- external dependencies.
-  # --
-  def assimilate_instance_facts
-
-    instance_facts_file = fact_path("hub-runtime.ini")
-    log.info(ere) { "Path to instance facts file => #{instance_facts_file}" }
-    assimilate_ini_file instance_facts_file
-
-  end
-
-
-  # --
-  # -- -----------------------------------
-  # -- Finding the Workstation (Category)
-  # -- -----------------------------------
-  # --
-  # -- The known hosts facts file is parsed with each
-  # -- section [examined] by asking two (2) questions.
-  # --
-  # --   [1] - is [username] this workstation's username?
-  # --   [2] - does [hostnames] include this hostname?
-  # --
-  # -- The 1st section to answer [YES] to both questions
-  # -- is deemed as our workstation. Its symbol header is
-  # -- then used for assimilation - how?
-  # --
-  # -- ----------------------------------------
-  # -- Assimilating Workstation Specific Facts
-  # -- ----------------------------------------
-  # --
-  # -- We do NOT assimilate the whole file.
-  # -- We simply assimilate the [SECTION] of the file
-  # -- that is deemed to be OUR (this) workstation.
-  # --
-  # -- -------------------------------------------
-  # -- Dependency Constraints | Workstation Facts
-  # -- -------------------------------------------
-  # --
-  # -- (work)station facts can [only] depend on facts that
-  # -- have been declared in [[ hub-runtime.ini ]]. No
-  # -- other external fact dependencies are permitted.
-  # --
-  def identify_my_workstation
-
-    workstation_factfile_name = "known-hosts.ini"
-    log_begin_workstation_identification workstation_factfile_name
-    stations_factfile = fact_path workstation_factfile_name
-    log.info(ere) { "Workstations Facts File (Path) => #{nickname stations_factfile}" }
-
-    our_user = Home.usr
-    our_host = NetDns.instance.host_name
-    log.info(ere){ "Station Search For => #{our_user}@#{our_host}" }
-
-    workstations = IniFile.load stations_factfile
-    workstations.each_section do |station|
-
-      no_user = "Workstation [#{station}] has no [username] fact."
-      raise RuntimeError.new no_user unless workstations[station].has_key? "username"
-
-      has_hostnames = workstations[station].has_key? "hostnames"
-      no_hostnames = "[#{station}] not a workstation as no [hostnames] fact - Skip!"
-      log.warn(ere) { no_hostnames } unless has_hostnames
-      next unless has_hostnames
-
-      this_user = evaluate(workstations[station]["username"])
-      these_hosts = evaluate(workstations[station]["hostnames"])
-      match = this_user.eql?(our_user) && these_hosts.include?(our_host)
-
-      log.info(ere){ "[#{station}] with #{this_user}@#{these_hosts} - No!" } unless match
-      next unless match
-
-      log.info(ere){ "[#{station}] with #{this_user}@#{these_hosts} - Matched!" }
-      dup_msg = "Duplicate or repeat match disallowed! #{@i[:station]} and #{station}"
-      raise RuntimeError.new dup_msg unless @i[:station].nil?
-
-      @i[:station] = station
-      @i[:workstation] = station.gsub(".", "_").to_sym
-
-    end
-
-    no_match_msg = "No workstation match made for [#{our_user}@#{our_host}]."
-    raise RuntimeError.new no_match_msg if @i[:station].nil?
-    log_end_workstation_identification workstation_factfile_name
-    LogObject.map @i
-
-  end
-
-
-  #--
-  #-- Knowing and setting @i[:workstation] to our workstation is key.
-  #-- This means that the other workstations can reference files in
-  #-- each others drives without knowing which workstation is being
-  #-- used (see ssh.keyfile for a ghost reference example).
-  #--
-  #-- Now we can proceed to assimilate the entire station facts file.
-  #--
-  def assimilate_station_facts
-
-    stations_factfile = fact_path "known-hosts.ini"
-    assimilate_ini_file stations_factfile
-
-  end
-
-
-  # --
-  # -- Get the path to a fact file or folder within the
-  # -- reusable facts source tree.
-  # --
-  # -- The base directory is acquired by dropping down
-  # -- three (3) directory levels from where this module
-  # -- is and then going into reusable.facts and finally
-  # -- appending the parameter path (file or folder).
-  # --
-  def fact_path fact_filename
-    fact_basedir = File.dirname( File.dirname( File.dirname( __FILE__ ) ) )
-    return File.join( File.join(fact_basedir,"reusable.facts"), fact_filename )
-  end
-
-
-  # --
-  # -- Call instantiate() before calling populate().
-  # --
-  # -- This method assimilates any and all fact files
-  # -- (recursively) found in two subdirectories
-  # --
-  # --   [1] - "reusable facts" and
-  # --   [2] - the [plugin] folder
-  # --
-  def self.populate
-
-  end
-
-
-  # -- -------------------------------------------------------------- -- #
-  # -- Eval and return result of parameter string if it is ruby code. -- #
-  # -- -------------------------------------------------------------- -- #
-  def evaluate string
-
-    # -----> @todo raise a FactError here
-
-    raise RuntimeError.new "Fact to Evaluate is Nil." if string.nil?
-    return string unless string.start_with? @@eval_prefix
-    return eval( string.gsub @@eval_prefix, "" )
-
-  end
-
-
-# ----> -------------------------------------------------->
-# ----> How to Write a Custom Error
-# ----> -------------------------------------------------->
-# ----> Add a custom data attributes to your exception
-# ----> You can add custom data to your exception just like you'd do it in any other class. Let's add an attribute reader to our class and update the constructor.
-# ----> class MyError < StandardError
-# ---->   attr_reader :thing
-# ---->   def initialize(msg="My default message", thing="apple")
-# ---->     @thing = thing
-# ---->     super(msg)
-# ---->   end
-# ----> end
-# ----> -------------------------------------------------->
-# ----> Using the Custom Error Class
-# ----> -------------------------------------------------->
-# ----> begin
-# ---->   raise MyError.new("my message", "my thing")
-# ----> rescue => e
-# ---->   puts e.thing # "my thing"
-# ----> end
-# ----> -------------------------------------------------->
-
-
-  # -- ---------------------------------------- -- #
-  # -- Add a fact to the main 2D fact database. -- #
-  # -- ---------------------------------------- -- #
-  def add_fact group_symbol, key_symbol, key_value
-
-    nil_error_text = "Neither fact coordinates nor value can be nil. [group]=> #{group_symbol} [key]=> #{key_symbol} [value]=> #{key_value}"
-    raise ArgumentError.new nil_error_text if group_symbol.nil? || key_symbol.nil? || key_value.nil?
-
-    if @f.has_key? group_symbol then
-
-      # --
-      # -- This isn't the first fact within this group
-      # -- so store the new fact key/value pair within
-      # -- the group's namespace.
-      # --
-      @f[group_symbol][key_symbol] = key_value
-
-    else
-
-      # --
-      # -- Create a new umbrella grouping against which
-      # -- the new key-value pairing will be inserted.
-      # --
-      @f.store group_symbol, { key_symbol => key_value }
-
-    end
-
-    # --
-    # -- The @s sibling hash is updated to reflect the
-    # -- key-value pairs within the current group. This
-    # -- allows @s to be used as shorthand within INI
-    # -- file fact definition statements.
-    # --
-    @s = @f[group_symbol]
-
-  end
-
-
-  # -- ------------------------------------------- -- #
-  # --                                             -- #
-  # --  Template                                   -- #
-  # --                                             -- #
-  # --   The longest river in africa is without    -- #
-  # --   doubt the @[africa|longest.river]. Now    -- #
-  # --   @[south.america|most.spoken] is the       -- #
-  # --   most common language in south america.    -- #
-  # --                                             -- #
-  # --   The population of the americas            -- #
-  # --   is @[americas|population] according to
-  # --   the Harvard 2015 census.
-  # --                                             -- #
-  # -- ------------------------------------------- -- #
-  # --                                             -- #
-  # --  Ruby Code                                  -- #
-  # --                                             -- #
-  # --   double_north_america_pop = @f[:north_america][:population] * 2
-  # --                                             -- #
-  # -- ------------------------------------------- -- #
-  # -- Parameters                                  -- #
-  # --   factory_facts : instantiated 2D hash      -- #
-  # --   ini_filepath : path to factfile to read   -- #
-  # --                                             -- #
-  # -- Dependencies and Assumptions                -- #
-  # --   the [inifile] gem is installed            -- #
-  # --   file exists at the ini_filepath           -- #
-  # --   factory_facts are instantiated            -- #
-  # --   identity facts like @i[:plugin] exist     -- #
-  # -- ------------------------------------------- -- #
-  def assimilate_ini_file ini_filepath
-
-    fact_filename = File.basename ini_filepath
-    log_begin fact_filename
-
-    no_file = "No (ini) factfile found here => #{ini_filepath}"
-    raise ArgumentError.new no_file unless File.exists? ini_filepath
-
-    # --
-    # -- Use the inifile gem to parse and read the fact
-    # -- file contents into Ruby's map structures.
-    # --
-    begin
-
-      map_facts = IniFile.load ini_filepath
-
-    rescue Exception => e
-
-      log.fatal(ere) { "## ############################ #################################" }
-      log.fatal(ere) { "## Fact File Assimilation Error #################################" }
-      log.fatal(ere) { "## ############################ #################################" }
-      log.fatal(ere) { "## File  => #{ini_filepath}"                                       }
-      log.fatal(ere) { "## ############################ #################################" }
-
-      log.fatal(ere) { e.message }
-      log.fatal(ere) { e.backtrace.inspect }
-
-      exit
-
-    end
-
-    # -- ------------------------------------------------------------ -- #
-    # -- Copy all ini file facts to the global eco dictionary using a -- #
-    # -- format of ==]  group_id.key_id = value                       -- #
-    # -- ------------------------------------------------------------ -- #
-    map_facts.each do | group_str, key_str, input_value |
-
-      assimilate_fact group_str, key_str, input_value
-
-    end
-
-    log_end fact_filename
-
-  end
-
-
-
-  def assimilate_fact group_str, key_str, input_value
-
-    grp_symbol = group_str.gsub(".", "_").to_sym
-    key_symbol = key_str.gsub(".", "_").to_sym
-
-    Throw.if_nil input_value
-    fact_val = input_value.strip
-
-    begin
-
-      unless discard_fact?( group_str, key_str, fact_val )
-        eval_value = evaluate(get_fact_value(fact_val))
-        add_fact grp_symbol, get_key_symbol(key_str), eval_value
-      end
-
-    rescue Exception => e
-
-      log.fatal(ere) { "## ##################### #################################" }
-      log.fatal(ere) { "## Fact Evaluation Error #################################" }
-      log.fatal(ere) { "## ##################### #################################" }
-      log.fatal(ere) { "## Fact Family => #{group_str}"                             }
-      log.fatal(ere) { "## Fact Key    => #{key_str}"                               }
-      log.fatal(ere) { "## Fact Stmt   => #{fact_val}"                              }
-      log.fatal(ere) { "## ##################### #################################" }
-
-      log.fatal(ere) { e.message }
-      log.fatal(ere) { e.backtrace.inspect }
-
-      raise e
-
-    end
-
-    unless @f.has_key? grp_symbol then
-
-      log.debug(ere){ "# -- ---------------------------------------------------------- #" }
-      log.debug(ere){ "# -- the [#{group_str}] silo facts." }
-      log.debug(ere){ "# -- ---------------------------------------------------------- #" }
-
-    end
-
-    id_keystring = "#{grp_symbol}#{key_symbol}".downcase
-    sensitive = id_keystring.includes_any? [ "secret", "password", "credential", "creds" ]
-    print_value = "****************"
-    print_value = eval_value unless sensitive
-
-    # -- -------------------------------------------------------- -- #
-    # -- Log the human readable (fixed-width) key and value pair. -- #
-    # -- -------------------------------------------------------- -- #
-    fw_key = sprintf '%-33s', "@f[:#{grp_symbol}][:#{key_symbol}]"
-    log.debug(ere){ "#{fw_key} => #{print_value}" }
-
-  end
-
-
-  def discard_fact? group_str, key_str, input_value
-
-    is_if = key_str.strip.end_with? "(if)"
-    is_unless = key_str.strip.end_with?("(un)") || key_str.strip.end_with?("(unless)")
-    return false unless is_if || is_unless
-
-    two_parts = input_value.split( @@eval_prefix )
-    no_prefix = "Conditional must be followed by eval prefix => #{two_parts}"
-    raise RuntimeError.new no_pefix unless two_parts.length == 2
-
-    conditional_part = two_parts.first.strip
-    no_curlies_msg = "Wrap conditional in curly braces => #{conditional_part}"
-    is_wrapped = conditional_part.start_with?("{") && conditional_part.end_with?("}")
-    raise RuntimeError.new no_curlies_msg unless is_wrapped
-
-    conditional_stmt = conditional_part[1..-2].strip
-    log.info(ere){ "Conditional Stmt => #{conditional_stmt}" }
-    conditional_val = evaluate( @@eval_prefix + conditional_stmt )
-    is_boolean = [true, false].include? conditional_val
-
-    boolean_msg = "=> #{conditional_stmt} <= evaluated to [#{conditional_val}] not boolean."
-    raise RuntimeError.new boolean_msg unless is_boolean
-
-    return false if is_if && conditional_val
-    return true if is_if && !conditional_val
-
-    return true if is_unless && conditional_val
-    return false if is_unless && !conditional_val
-
-    raise RuntimeError.new "Unreachable if[#{is_if}] unless[#{is_unless}] => #{conditional_val}"
-
-  end
-
-
-  #--
-  #-- Return the symbolic representation of the
-  #-- parameter key. Periods are replaced with
-  #-- underscores (as per the fact convention)
-  #-- before conversion to a symbol.
-  #--
-  #-- Nil is not handled.
-  #-- String is stripped beforehand just in case.
-  #--
-  def symbol from_string
-
-    return from_string.strip.gsub(".", "_").to_sym
-
-  end
-
-
-  #--
-  #-- Return the (key access) symbol that represents the
-  #-- plugin id plus a string given in the parameter.
-  #--
-  #-- ---------
-  #-- Example
-  #-- ---------
-  #--
-  #--  Plugin Id  => ide.hub
-  #--  Append Str => host
-  #--
-  #--  equals
-  #--
-  #--  Key String => ide.hub.host
-  #--  Key Symbol => ide_hub_host
-  #--
-  #--
-  #-- So the symbol :ide_hub_host is returned.
-  #--
-  def plugin_symbol append_string
-
-    key_string = @i[:plugin] + "." + append_string.strip
-    return key_string.gsub(".", "_").to_sym
-
-  end
-
-
-  def get_key_symbol dirty_key_string
-
-    key_string = dirty_key_string.strip
-    split_string = "(unless)"
-    split_string = "(if)" if key_string.end_with? "(if)"
-    split_string = "(un)" if key_string.end_with? "(un)"
-
-    return key_string.split(split_string).first.gsub(".", "_").to_sym
-
-  end
-
-
-  def get_fact_value fact_value_string
-
-    is_conditional = fact_value_string.start_with?("{") && fact_value_string.include?( @@eval_prefix )
-    return fact_value_string unless is_conditional
-
-    return fact_value_string.rpartition( @@eval_prefix )[1..-1].join
-
-  end
-
-
-  def exists? fact_reference
-
-    log.info(ere) { "Does Fact Exist? => #{fact_reference}" }
-    return false if fact_reference.nil?
-    return false if fact_reference.strip.length == 0
-    return true if fact_reference.strip.length > 0
-
-  end
-
-
-  # --
-  # -- dot => period (full stop)
-  # -- Deliver a "." period character
-  # --
-  def dot
-    return "."
-  end
-
-
-  # --
-  # -- colon => full colon character
-  # -- Delivers a ":" colon character
-  # --
-  def colon
-    return ":"
-  end
-
-
-  def log_begin_workstation_identification the_filename
-
-    log.info(ere) { "-                                                         -" }
-    log.info(ere) { "# @@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@ #" }
-    log.info(ere) { "# -- ------------------------------------------------- -- #" }
-    log.info(ere) { "# -- [= BEGIN WORKSTATION IDENTIFICATION =] #{the_filename}" }
-    log.info(ere) { "# -- ------------------------------------------------- -- #" }
-    log.info(ere) { "# @@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@ #" }
-
-  end
-
-
-  def log_end_workstation_identification the_filename
-
-    log.info(ere) { "# @@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@ #" }
-    log.info(ere) { "# -- ------------------------------------------------- -- #" }
-    log.info(ere) { "# -- [= END WORKSTATION IDENTIFICATION =] #{the_filename}"   }
-    log.info(ere) { "# -- ------------------------------------------------- -- #" }
-    log.info(ere) { "# @@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@ #" }
-    log.info(ere) { "-                                                         -" }
-    log.info(ere) { "-                                                         -" }
-    log.info(ere) { "-                                                         -" }
-
-  end
-
-
-  def log_begin the_filename
-
-    log.info(ere) { "-                                                         -" }
-    log.info(ere) { "# @@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@ #" }
-    log.info(ere) { "# -- ------------------------------------------------- -- #" }
-    log.info(ere) { "# -- [= BEGIN THE ASSIMILATION =] #{the_filename}"          }
-    log.info(ere) { "# -- ------------------------------------------------- -- #" }
-    log.info(ere) { "# @@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@ #" }
-
-  end
-
-
-  def log_end the_filename
-
-    log.info(ere) { "# @@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@ #" }
-    log.info(ere) { "# -- ------------------------------------------------- -- #" }
-    log.info(ere) { "# -- [= END ASSIMILATION =] #{the_filename}"                }
-    log.info(ere) { "# -- ------------------------------------------------- -- #" }
-    log.info(ere) { "# @@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@ #" }
-    log.info(ere) { "-                                                         -" }
-    log.info(ere) { "-                                                         -" }
-    log.info(ere) { "-                                                         -" }
-
-  end
-
-
-end