bmc-daemon-lib 0.12.2 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 14fde8ed0a71f9ab7c1e91d25bc1c79c7b2ed0bc
-  data.tar.gz: 1367640e1bcbbdbf83bfec6c36e5117dfa644994
+SHA256:
+  metadata.gz: c82b143ff8a357de485934538617e19a176535ed160cf608ccd652ded70abaee
+  data.tar.gz: 46f2b9db709b3197195eadfbd68378407cd1212c8ad61e63ef0c3856d7059814
 SHA512:
-  metadata.gz: 62de2bca2d7fc442618e2c21f0fb6cbfc3f00c659729ae90ada05b7df48eb12fec98ba085b50b770339b09789204da2f85ca45eaa231da9a89a06d99f2aaa68a
-  data.tar.gz: d227a660a0b54e3e0abe0f3c025b3d26c973b31b84e4a2b33a94e3b01b9c4da7554e090a8c3eb107cf121ec92f85f0981bd4633487a7697fc1f7857b42796608
+  metadata.gz: 396b40feb073d614a22ffc7b3999981bb2539d28fe44494aa790b8c0428183fc3d73cb1d2c545553ad88bbf6d86cfa1cc13654c974d55b3eb61736c40d793772
+  data.tar.gz: b5f46871abf578101a6bf51078811a9c432276b382c02e7fd623c0b5d674b4635622552be6c466172435d79bdd389d94067b6cf3b646f9d8d97a445eb68c34ba

data/bmc-daemon-lib.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   # Project version
-  spec.version                      = "0.12.2"
+  spec.version                      = "0.13.2"
 
   # Project description
   spec.name                         = "bmc-daemon-lib"
@@ -24,12 +24,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency   "rake"
   spec.add_development_dependency   "rspec"
   spec.add_development_dependency   "rubocop"
-  #spec.add_development_dependency   "pry"
-
+  
   # Runtime dependencies
   # spec.add_runtime_dependency       "hashie" , "~> 3.4.6"   # upgrading to 3.5.4 breaks things !
   # spec.add_runtime_dependency       "chamber" , "~> 2.9.1"
 
-  spec.add_runtime_dependency       "hashie" , "~> 3.4.6"   # upgrading to 3.5.4 breaks things !
+  # spec.add_runtime_dependency       "hashie" , "~> 3.4.6"   # upgrading to 3.5.4 breaks things !
+  spec.add_runtime_dependency       "hashie" , "~> 3"   # upgrading to 3.5.4 breaks things !
   spec.add_runtime_dependency       "chamber"
 end

data/lib/bmc-daemon-lib/conf.rb

@@ -14,99 +14,67 @@ module BmcDaemonLib
     extend Chamber
     PIDFILE_DIR = "/tmp/"
 
+    # Set up encodings
+    Encoding.default_internal = "utf-8"
+    Encoding.default_external = "utf-8"
+
+    # Some global init
+    @app_started  = Time.now
+    @app_name     = ""
+    @app_env      = "production"
+    @app_host     = `hostname`.to_s.chomp.split(".").first
+
+    # By default, Newrelic is disabled
+    ENV["NEWRELIC_AGENT_ENABLED"] = "false"
+
     class << self
-      attr_accessor :app_env
       attr_reader   :app_root
-      attr_reader   :app_libs
+      attr_reader   :app_started
       attr_reader   :app_name
+      attr_reader   :app_env
+      attr_reader   :app_host
       attr_reader   :app_ver
-      attr_reader   :app_started
       attr_reader   :app_spec
-      attr_reader   :files
-      attr_reader   :host
-    end
-
-    def self.init app_root
-      # Permanent flags
-      @initialized  = true
-      @app_started  = Time.now
-
-      # Default values
-      @files        ||= []
-      @app_name     ||= "app_name"
-      @app_env      ||= "production"
-      @host         ||= `hostname`.to_s.chomp.split(".").first
-
-      # Store and clean app_root
-      @app_root = File.expand_path(app_root)
-      gemspec_path = "#{@app_root}/*.gemspec"
-
-      # Try to find any gemspec file
-      matches   = Dir[gemspec_path]
-      fail ConfigGemspecMissing, "gemspec file not found: #{gemspec_path}" if matches.size < 1
-      fail ConfigGemspecNotUnique, "gemspec file not found: #{gemspec_path}" if matches.size > 1
-
-      # Load Gemspec (just the only match)
-      @spec     = Gem::Specification::load(matches.first)
-      fail ConfigGemspecInvalid, "gemspec not readable: #{gemspec_path}" unless @spec
-
-      # Extract useful information from gemspec
-      @app_name = @spec.name.to_s
-      @app_ver  = @spec.version.to_s
-      fail ConfigMissingParameter, "gemspec: missing name" unless @app_name
-      fail ConfigMissingParameter, "gemspec: missing version" unless @app_ver
+      attr_reader   :app_config
 
-      # Now we know app_name, initalize app_libs
-      @app_libs = File.expand_path("lib/#{@app_name}/", @app_root)
-
-      # By default, Newrelic is disabled
-      ENV["NEWRELIC_AGENT_ENABLED"] = "false"
-
-      # Add other config files
-      add_config generate_config_defaults
-      add_config generate_config_etc
-
-      # Return something
-      return @app_name
-    end
+      def app_env= value
+        @app_env = value
+        ENV["RACK_ENV"] = value.to_s
+      end
 
-    def self.prepare args = {}
-      ensure_init
+      def app_config= path
+        @app_config= path
+      end
 
-      # Add extra config file and load them all
-      add_config args[:config]
-      reload!
+      def cmd_config= path
+        @app_config= path
+      end
 
-      # Set Rack env
-      ENV["RACK_ENV"] = @app_env.to_s
+      # def self.init app_root = nil
+      def app_root= path
+        self.init_from path
+      end
 
-      # Set up encodings
-      Encoding.default_internal = "utf-8"
-      Encoding.default_external = "utf-8"
+      def init_from path
+        # Store it
+        @app_root = ::File.expand_path(path)
+        return unless @app_root
 
-      # Try to access any key to force parsing of the files
-      self[:test35547647654856865436346453754746588586799078079876543245678654324567865432]
+        # Read the gemspec
+        gemspec = init_from_gemspec
 
-    rescue Psych::SyntaxError => e
-      fail ConfigParseError, e.message
-    rescue StandardError => e
-      fail ConfigOtherError, "#{e.message} \n #{e.backtrace.to_yaml}"
-    end
-
-    # Reload files
-    def self.reload!
-      ensure_init
-      load_files
-    end
+        #return gemspec
+        return @app_root
+      end
 
-    def self.dump
-      ensure_init
-      to_hash.to_yaml(indent: 4, useheader: true, useversion: false )
+      def dump
+        to_hash.to_yaml(indent: 4, useheader: true, useversion: false )
+      end
+    
     end
 
     # Direct access to any depth
     def self.at *path
-      ensure_init
       path.reduce(Conf) { |m, key| m && m[key.to_s] }
     end
 
@@ -140,17 +108,13 @@ module BmcDaemonLib
     def self.gem_installed? gemname
       Gem::Specification.collect(&:name).include? gemname
     end
-
-
     def self.feature_newrelic?
-      ensure_init
       return false unless gem_installed?('newrelic_rpm')
       return false if self.at(:newrelic, :enabled) == false
       return false if self.at(:newrelic, :disabled) == true
       return self.at(:newrelic, :license) || false
     end
     def self.feature_rollbar?
-      ensure_init
       return false unless gem_installed?('rollbar')
       return false if self.at(:rollbar, :enabled) == false
       return false if self.at(:rollbar, :disabled) == true
@@ -168,36 +132,46 @@ module BmcDaemonLib
     end
 
     # Generators
-    def self.generate_user_agent
-      ensure_init
-      "#{@app_name}/#{@app_ver}" if @app_name && @app_ver
-    end
-    def self.generate_config_defaults
-      ensure_init
-      "#{@app_root}/defaults.yml" if @app_root
+    def self.app_libs
+      check_presence_of @app_name, @app_root
+
+      ::File.expand_path("lib/#{@app_name}/", @app_root)
     end
-    def self.generate_config_etc
-      ensure_init
-      "/etc/#{@app_name}.yml" if @app_name
+
+    def self.generate_user_agent
+      check_presence_of @app_name, @app_ver
+
+      "#{@app_name}/#{@app_ver}"
     end
+
     def self.generate_process_name
-      ensure_init
+      check_presence_of @app_name, @app_env
+
       parts = [@app_name, @app_env]
       parts << self[:port] if self[:port]
       parts.join('-')
     end
+
+    def self.generate_config_defaults
+      check_presence_of @app_root
+      "#{@app_root}/defaults.yml"
+    end
+
+    def self.generate_config_etc
+      check_presence_of @app_name
+      "/etc/#{@app_name}.yml"
+    end
+
     def self.generate_pidfile
-      ensure_init
-      process_name = self.generate_process_name
-      File.expand_path "#{process_name}.pid", PIDFILE_DIR
+      ::File.expand_path "#{self.generate_process_name}.pid", PIDFILE_DIR
     end
+
     def self.generate_config_message
-      ensure_init
-        config_defaults = self.generate_config_defaults
-        config_etc = self.generate(:config_etc)
-        "A default configuration is available (#{config_defaults}) and can be copied to the default location (#{config_etc}): \n sudo cp #{config_defaults} #{config_etc}"
+      return unless self.generate_config_defaults && self.generate_config_etc
+      "A default configuration is available (#{self.generate_config_defaults}) and can be copied to the default location (#{self.generate_config_etc}): \n sudo cp #{self.generate_config_defaults} #{self.generate_config_etc}"
     end
 
+    # Plugins
     def self.prepare_newrelic
       # Disable if no config present
       return unless self.feature?(:newrelic)
@@ -217,17 +191,6 @@ module BmcDaemonLib
       ENV["NEW_RELIC_LOG"] = logfile_path(:newrelic)
       ENV["NEW_RELIC_LICENSE_KEY"] = conf[:license].to_s
       ENV["NEW_RELIC_APP_NAME"] = conf[:app_name].to_s
-
-      # logger_newrelic = Logger.new('/tmp/newrelic.log')
-      # logger_newrelic.debug Time.now()
-      # Start the agent
-      # NewRelic::Agent.manual_start({
-      #   agent_enabled: true,
-      #   log: logger_newrelic,
-      #   env: @app_env,
-      #   license_key: conf[:license].to_s,
-      #   app_name: conf[:app_name].to_s,
-      # })
     end
 
     def self.prepare_rollbar
@@ -254,7 +217,7 @@ module BmcDaemonLib
       end
 
       # Notify startup
-      Rollbar.info("[#{@app_ver}] #{@host}")
+      Rollbar.info("[#{@app_ver}] #{@app_host}")
     end
 
     def self.log origin, message
@@ -268,9 +231,37 @@ module BmcDaemonLib
 
   protected
 
+    def self.init_from_gemspec
+      # Check conditions
+      check_presence_of @app_root
+
+      # puts "Conf.init_from_gemspec"
+      gemspec_path = "#{@app_root}/*.gemspec"
+
+      # Try to find any gemspec file
+      matches   = Dir[gemspec_path]
+      fail ConfigGemspecMissing, "gemspec file not found: #{gemspec_path}" if matches.size < 1
+      fail ConfigGemspecNotUnique, "gemspec file not found: #{gemspec_path}" if matches.size > 1
+
+      # Load Gemspec (just the only match)
+      @spec     = Gem::Specification::load(matches.first)
+      fail ConfigGemspecInvalid, "gemspec not readable: #{gemspec_path}" unless @spec
+
+      # Extract useful information from gemspec
+      @app_name = @spec.name.to_s
+      @app_ver  = @spec.version.to_s
+      fail ConfigMissingParameter, "gemspec: missing name" unless @app_name
+      fail ConfigMissingParameter, "gemspec: missing version" unless @app_ver
+
+      return @spec
+    end
+
     def self.newrelic_init_app_name conf
       # Ignore if already set
-      return if conf[:app_name]
+      return if @app_name
+
+      # Check conditions
+      check_presence_of @app_env
 
       # Stack all those parts
       stack = []
@@ -280,25 +271,53 @@ module BmcDaemonLib
       text = stack.join('-')
 
       # Return a composite appname
-      conf[:app_name] = "#{text}; #{text}-#{@host}"
+      conf[:app_name] = "#{text}; #{text}-#{@app_host}"
     end
 
-    def self.load_files
-      load files: @files, namespaces: { environment: @app_env }
+    def self.reload
+      files=[]
+
+      # Load defaults
+      add_config(files, self.generate_config_defaults)
+
+      # Load etc config
+      add_config(files, self.generate_config_etc)
+
+      # Load app config
+      add_config(files, @app_config)
+
+      # Reload config
+      # puts "Conf.reload: loading files: #{files.inspect}"
+      log :conf, "reloading from files: #{files.inspect}"
+      load files: files, namespaces: { environment: @app_env }
+
+      # Try to access any key to force parsing of the files
+      self[:test35547647654856865436346453754746588586799078079876543245678654324567865432]
+
+    rescue Psych::SyntaxError => e
+      fail ConfigParseError, e.message
+    rescue StandardError => e
+      fail ConfigOtherError, "#{e.message} \n #{e.backtrace.to_yaml}"
+
+    else
+      return to_hash
     end
 
-    def self.add_config path
-      # Skip if path is not readable
-      return unless path && File.readable?(path)
+    def self.add_config files, path
+      # Should be not empty/nil
+      return unless path
+
+      # Should be readable
+      return unless File.readable?(path)
 
       # Check if Chamber's behaviour may cause problems with hyphens
       basename = File.basename(path)
-      if File.basename(path).include?'-'
+      if basename.include?'-'
         log :conf, "WARNING: files with dashes may cause unexpected behaviour with Chamber (#{basename})"
       end
 
-      # Store the files
-      @files << File.expand_path(path) 
+      # Add it
+      files << File.expand_path(path) 
     end
 
     def self.logfile_path pipe
@@ -320,9 +339,17 @@ module BmcDaemonLib
 
   private
 
-    def self.ensure_init
-      unless @initialized
-        fail ConfigInitiRequired, "ensure_init: Conf.init(app_root) should be invoked beforehand"
+    # Check every argument for value presence
+    def self.check_presence_of *args
+      # puts "check_presence_of #{args.inspect}"
+      args.each do |arg|
+        # OK if it's not empty
+        # puts "- [#{arg}]"
+        next unless arg.to_s.empty?
+
+        # Otherise, we just exit
+        log :conf, "FAILED: object Conf has not been initialized correctly yet"
+        exit 200
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bmc-daemon-lib
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.2
 platform: ruby
 authors:
 - Bruno MEDICI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2018-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.6
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.6
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: chamber
   requirement: !ruby/object:Gem::Requirement
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: 'Shared utilities to build a daemon: logger, configuration, helpers'