RubyGems - puppet-herald - Versions diffs - 0.1.1 → 0.2.0 - Mend

puppet-herald 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (65) hide show

checksums.yaml +15 -7
data/.rubocop.yml +31 -0
data/.rubocop_todo.yml +6 -0
data/.travis.yml +7 -7
data/Gemfile +5 -9
data/README.md +152 -16
data/Rakefile +67 -6
data/bin/puppet-herald +1 -1
data/config.ru +2 -2
data/db/migrate/20141211165540_create_nodes.rb +5 -3
data/db/migrate/20141211171305_create_reports.rb +12 -10
data/db/migrate/20141211171326_create_log_entries.rb +9 -7
data/db/schema.rb +24 -26
data/lib/puppet-herald.rb +59 -21
data/lib/puppet-herald/app/api.rb +111 -0
data/lib/puppet-herald/app/configuration.rb +70 -0
data/lib/puppet-herald/app/frontend.rb +61 -0
data/lib/puppet-herald/{views → app/views}/app.erb +5 -8
data/lib/puppet-herald/{views → app/views}/err500.erb +1 -4
data/lib/puppet-herald/application.rb +27 -0
data/lib/puppet-herald/cli.rb +66 -45
data/lib/puppet-herald/client.rb +33 -0
data/lib/puppet-herald/database.rb +84 -40
data/lib/puppet-herald/javascript.rb +23 -17
data/lib/puppet-herald/models/log-entry.rb +10 -3
data/lib/puppet-herald/models/node.rb +15 -5
data/lib/puppet-herald/models/report.rb +70 -63
data/lib/puppet-herald/public/app.js +9 -8
data/lib/puppet-herald/public/components/directives/status-button.html +1 -1
data/lib/puppet-herald/public/components/directives/status-button.js +5 -3
data/lib/puppet-herald/public/components/filters/filters.js +9 -4
data/lib/puppet-herald/public/components/page.js +34 -0
data/lib/puppet-herald/public/node/node.html +3 -1
data/lib/puppet-herald/public/node/node.js +7 -4
data/lib/puppet-herald/public/nodes/nodes.js +3 -2
data/lib/puppet-herald/public/report/report.html +4 -1
data/lib/puppet-herald/public/report/report.js +5 -3
data/lib/puppet-herald/stubs/puppet.rb +20 -9
data/lib/puppet-herald/version.rb +17 -7
data/package.json +8 -3
data/puppet-herald.gemspec +3 -6
data/spec/integration/application_spec.rb +175 -0
data/spec/integration/models/node_spec.rb +4 -4
data/spec/integration/models/report_spec.rb +7 -7
data/spec/spec_helper.rb +12 -7
data/spec/support/active_record.rb +6 -10
data/spec/support/reconnectdb.rb +13 -0
data/spec/unit/puppet-herald/cli_spec.rb +45 -13
data/spec/unit/puppet-herald/client_spec.rb +23 -0
data/spec/unit/puppet-herald/database_spec.rb +8 -9
data/spec/unit/puppet-herald/javascript_spec.rb +8 -13
data/spec/unit/puppet-herald_spec.rb +4 -4
data/test/javascript/karma.conf.js +43 -5
data/test/javascript/src/app_test.js +90 -0
data/test/javascript/src/components/artifact/artifact-directive_test.js +36 -0
data/test/javascript/src/components/artifact/artifact_test.js +64 -0
data/test/javascript/src/components/directives/status-button_test.js +159 -0
data/test/javascript/src/components/filters/filters_test.js +35 -0
data/test/javascript/src/node/node_test.js +87 -0
data/test/javascript/src/nodes/nodes_test.js +56 -0
data/test/javascript/src/report/report_test.js +94 -0
metadata +98 -68
data/lib/puppet-herald/app.rb +0 -103
data/lib/puppet-herald/public/components/artifact/artifact-directive_test.js +0 -17
data/spec/integration/app_spec.rb +0 -21

data/lib/puppet-herald/{views → app/views}/err500.erb RENAMED Viewed

@@ -1,8 +1,5 @@
 <!DOCTYPE html>
-<!--[if lt IE 7]>      <html lang="en" class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
-<!--[if IE 7]>         <html lang="en" class="no-js lt-ie9 lt-ie8"> <![endif]-->
-<!--[if IE 8]>         <html lang="en" class="no-js lt-ie9"> <![endif]-->
-<!--[if gt IE 8]><!--> <html lang="en" class="no-js"> <!--<![endif]-->
+<html lang="en">
   <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">

data/lib/puppet-herald/application.rb ADDED Viewed

@@ -0,0 +1,27 @@
+require 'sinatra/base'
+require 'puppet-herald/app/configuration'
+require 'puppet-herald/app/api'
+require 'puppet-herald/app/frontend'
+# A module for Herald
+module PuppetHerald
+  # Class for an Herald sinatra application
+  class Application < Sinatra::Application
+    use PuppetHerald::App::Configuration
+    use PuppetHerald::App::Frontend
+    use PuppetHerald::App::Api
+    class << self
+      # Executes the Herald application
+      #
+      # @param options [Hash] an extra options for Rack server
+      # @param block [block] an extra configuration block
+      # @return [Sinatra::Application] an Herald application
+      def run!(options = {}, &block)
+        PuppetHerald::App::Configuration.dbmigrate!
+        super options, *block
+      end
+    end
+  end
+end

data/lib/puppet-herald/cli.rb CHANGED Viewed

@@ -4,77 +4,98 @@ require 'puppet-herald'
 require 'puppet-herald/version'
 require 'puppet-herald/database'
+# A module for Herald
 module PuppetHerald
+  # A CLI class
   class CLI
+    # Initialize CLI
+    # @return [CLI] an CLI object
+    def initialize
+      @logger = Logger.new STDOUT
+      @errlogger = Logger.new STDERR
+      self
+    end
+    # Logger for CLI interface (error and std)
+    # @return [Logger] logger for CLI
+    attr_reader :logger, :errlogger
-    @@logger = Logger.new STDOUT
-    @@errlogger = Logger.new STDERR
-    @@retcode = 0
+    # Executes an Herald app from CLI
+    #
+    # @param argv [Array] an argv from CLI
+    # @return [Integer] a status code for program
+    def run!(argv = ARGV)
+      PuppetHerald.environment
-    def self.retcode= val
-      @@retcode = val if @@retcode == 0
+      options = parse_or_kill argv, 2
+      run_or_kill options, 1
+      Kernel.exit 0
     end
-    def self.logger
-      @@logger
+    protected
+    # Parse an ARGV command line arguments
+    # @param argv [Array] an argv from CLI
+    # @return [Hash] options to use by application
+    def parse(argv)
+      options = parser.process!(argv)
+      logger.info "Starting #{PuppetHerald::NAME} v#{PuppetHerald::VERSION} in #{PuppetHerald.environment}..."
+      PuppetHerald.database.dbconn   = options[:dbconn]
+      PuppetHerald.database.passfile = options[:passfile]
+      PuppetHerald.database.spec(true)
+      options
     end
-    def self.errlogger
-      @@errlogger
+    private
+    def run_or_kill(options, retcode)
+      require 'puppet-herald/application'
+      PuppetHerald::Application.run! options
+    rescue StandardError => ex
+      bug = PuppetHerald.bug(ex)
+      errlogger.fatal "Unexpected error occured, mayby a bug?\n\n#{bug[:message]}\n\n#{bug[:help]}"
+      Kernel.exit retcode
     end
-    def self.run! argv=ARGV
-      @@retcode = 0
-      begin
-        options = parse_options argv
-        require 'puppet-herald/app'
-        PuppetHerald::App.run! options
-      rescue Exception => ex
-        bug = PuppetHerald.bug(ex)
-        errlogger.fatal "Unexpected error occured, mayby a bug?\n\n#{bug[:message]}\n\n#{bug[:help]}"
-        self.retcode = 1
-      end
-      Kernel::exit @@retcode
+    def parse_or_kill(argv, retcode)
+      return parse argv
+    rescue StandardError => ex
+      errlogger.fatal "Database configuration is invalid!\n\n#{ex.message}"
+      Kernel.exit retcode
     end
-    def self.parse_options argv
-      usage = ""
-      banner = <<-eos
+    def banner
+      txt = <<-eos
 #{PuppetHerald::NAME} v#{PuppetHerald::VERSION} - #{PuppetHerald::SUMMARY}
 #{PuppetHerald::DESCRIPTION}
-Usage: #{$0} [options]
+Usage: #{$PROGRAM_NAME} [options]
 For --dbconn option you can use both PostgreSQL and SQLite3 (postgresql://host/db, sqlite://file/path).
 CAUTION! For security reasons, don't pass password in connection string, use --passfile option!
       eos
+      txt
+    end
+    def parser
       home = File.expand_path('~')
       defaultdb     = "sqlite://#{home}/pherald.db"
       defaultdbpass = "#{home}/.pherald.pass"
-      parser = Parser.new do |p|
+      Parser.new do |p|
         p.banner = banner
         p.version = PuppetHerald::VERSION
-        p.option :bind, "Hostname to bind to", :default => 'localhost'
-        p.option :port, "Port to use", :default => 11303, :value_satisfies => lambda {|x| x >= 100 && x <= 65000}
-        p.option :dbconn, "Connection string to database, see info above", :default => defaultdb
-        p.option :passfile, "If using postgresql, this file will be read for password to database", :default => defaultdbpass
-      end
-      options = parser.process!(argv)
-      logger.info "Starting #{PuppetHerald::NAME} v#{PuppetHerald::VERSION} in #{PuppetHerald::environment}..."
-      PuppetHerald::Database.dbconn   = options[:dbconn]
-      PuppetHerald::Database.passfile = options[:passfile]
-      begin
-        PuppetHerald::Database.spec :echo => true
-      rescue Exception => ex
-        errlogger.fatal "Database configuration is invalid!\n\n#{ex.message}"
-        self.retcode = 2
-        raise ex
+        p.option :bind, 'Hostname to bind to', default: 'localhost'
+        p.option :port, 'Port to use', default: 11_303, value_satisfies: ->(x) { x >= 1 && x <= 65_535 }
+        p.option :dbconn, 'Connection string to database, see info above', default: defaultdb
+        p.option(
+          :passfile,
+          'If using postgresql, this file will be read for password to database',
+          default: defaultdbpass
+        )
       end
-      return options
     end
   end
-end
+end

data/lib/puppet-herald/client.rb ADDED Viewed

@@ -0,0 +1,33 @@
+require 'net/http'
+# A module for Herald
+module PuppetHerald
+  # A client class for Herald
+  class Client
+    # Constructs a client
+    #
+    # @param host [String] a host to connect to, default to +'localhost'+
+    # @param port [Integer] a port to connect to, default to +11303+
+    # @return [PuppetHerald::Client] a client instance
+    def initialize(host = 'localhost', port = 11_303)
+      @host = host
+      @port = port
+      self
+    end
+    # Process a puppet report and sends it to Herald
+    #
+    # @param report [Puppet::Transaction::Report] a puppet report
+    # @param block [Proc] a optional block that can modify request before sending
+    # @return [Boolean] true if everything is ok
+    def process(report, &block)
+      path = '/api/v1/reports'
+      header = { 'Content-Type' => 'application/yaml' }
+      req = Net::HTTP::Post.new(path, initheader = header) # rubocop:disable all
+      req.body = report.to_yaml
+      block.call(req) if block
+      Net::HTTP.new(@host, @port).start { |http| http.request(req) }
+      true
+    end
+  end
+end

data/lib/puppet-herald/database.rb CHANGED Viewed

@@ -1,57 +1,101 @@
 require 'fileutils'
 require 'logger'
+# A module for Herald
 module PuppetHerald
+  # A class for a database configuration
   class Database
+    def initialize
+      @dbconn   = nil
+      @passfile = nil
+      @logger = Logger.new STDOUT
+    end
+    # Gets a logger for database
+    # @return [Logger] a logger
+    attr_reader :logger
+    # Sets a database connection
+    # @return [String] a dbconnection string
+    attr_writer :dbconn
-    @@dbconn   = nil
-    @@passfile = nil
-    @@logger = Logger.new STDOUT
+    # Sets a passfile
+    # @return [String] a password file
+    attr_writer :passfile
-    def self.logger
-      @@logger
+    # Compiles a spec for database creation
+    #
+    # @param log [Boolean] should log on screen?
+    # @return [Hash] a database configuration
+    def spec(log = false)
+      connection = process_spec
+      print_config(connection, log)
+      connection
     end
-    def self.dbconn= dbconn
-      @@dbconn = dbconn
+    private
+    def process_spec
+      match = validate_conn(@dbconn)
+      if %w(sqlite sqlite3).include? match[1]
+        connection = sqlite(match)
+      else
+        connection = postgresql(@dbconn, @passfile)
+      end
+      connection
     end
-    def self.passfile= passfile
-      @@passfile = passfile
+    def validate_conn(dbconn)
+      fail 'Connection is not set, can not validate database connection' if dbconn.nil?
+      match = dbconn.match(%r{^(sqlite3?|postgres(?:ql)?)://(.+)$})
+      fail "Invalid database connection string given: #{dbconn}" if match.nil?
+      match
+    end
+    def print_config(connection, log)
+      return unless log
+      copy = connection.dup
+      copy[:password] = '***' unless copy[:password].nil?
+      logger.info "Using #{copy.inspect} for database."
     end
-    def self.spec echo=false
-      return nil if @@dbconn.nil?
+    def sqlite(match)
       connection = {}
-      match = @@dbconn.match(/^(sqlite3?|postgres(?:ql)?):\/\/(.+)$/)
-      unless match
-        raise "Invalid database connection string given: #{@@dbconn}"
-      end
-      if ['sqlite', 'sqlite3'].include? match[1]
-        dbname = match[2]
-        unless dbname.match /^(?:file:)?:mem/
-          dbname = File.expand_path(dbname)
-          FileUtils.touch dbname
-        end
-        connection[:adapter]  = 'sqlite3'
-        connection[:database] = dbname
-      else
-        db = URI.parse @@dbconn
-        dbname = db.path[1..-1]
-        connection[:adapter]  = db.scheme == 'postgres' ? 'postgresql' : db.scheme
-        connection[:host]     = db.host
-        connection[:port]     = db.port unless db.port.nil?
-        connection[:username] = db.user.nil? ? dbname : db.user
-        connection[:password] = File.read(@@passfile).strip
-        connection[:database] = dbname
-        connection[:encoding] = 'utf8'
+      dbname = match[2]
+      unless dbname.match(/^(?:file:)?:mem/)
+        dbname = File.expand_path(dbname)
+        FileUtils.touch dbname
       end
-      if echo
-        copy = connection.dup
-        copy[:password] = '***' unless copy[:password].nil?
-        logger.info "Using #{copy.inspect} for database."
-      end
-      return connection
+      connection[:adapter]  = 'sqlite3'
+      connection[:database] = dbname
+      connection
+    end
+    def postgresql(conn, passfile)
+      connection = {}
+      db = URI.parse conn
+      dbname = db.path[1..-1]
+      connection[:adapter]  = pgscheme(db.scheme)
+      connection[:host]     = db.host
+      connection[:username] = pguser(db.user, dbname)
+      connection[:password] = File.read(passfile).strip
+      connection[:database] = dbname
+      connection[:encoding] = 'utf8'
+      pgport(connection, db.port)
+      connection
+    end
+    def pgport(connection, port)
+      connection[:port] = port unless port.nil?
+    end
+    def pgscheme(scheme)
+      scheme == 'postgres' ? 'postgresql' : scheme
+    end
+    def pguser(user, dbname)
+      user.nil? ? dbname : user
     end
   end
-end
+end

data/lib/puppet-herald/javascript.rb CHANGED Viewed

@@ -1,34 +1,40 @@
 require 'puppet-herald'
 require 'uglifier'
+# A module for Herald
 module PuppetHerald
+  # A javascript processing class
   class Javascript
+    # Initialize JS class
+    def initialize
+      @files = nil
+      @base = 'lib/puppet-herald/public'
+    end
-    @@files = nil
-    @@base = 'lib/puppet-herald/public'
-    def self.files
-      if PuppetHerald::is_in_dev?
-        @@files = nil
-      end
-      if @@files.nil?
-        public_dir = PuppetHerald::relative_dir(@@base)
+    # Returns a list of JS files to be inserted into main HTML
+    # @return [Array] list of JS's
+    def files
+      @files = nil if PuppetHerald.in_dev?
+      if @files.nil?
+        public_dir = PuppetHerald.relative_dir(@base)
         all = Dir.chdir(public_dir) { Dir.glob('**/*.js') }
-        @@files = all.reverse.reject { |file| file.match(/_test\.js$/) }
+        @files = all.reverse.reject { |file| file.match(/_test\.js$/) }
       end
-      return @@files
+      @files
     end
-    def self.uglify mapname
-      sources = files.collect { |file| File.read("#{@@base}/#{file}") }
+    # Uglify an application JS's into one minified JS file
+    # @param mapname [String] name of source map to be put into uglified JS
+    # @return [Hash] a hash with uglified JS and source map
+    def uglify(mapname)
+      sources = files.collect { |file| File.read("#{@base}/#{file}") }
       source = sources.join "\n"
-      uglifier = Uglifier.new(:source_map_url => mapname)
+      uglifier = Uglifier.new(source_map_url: mapname)
       uglified, source_map = uglifier.compile_with_map(source)
-      return {
+      {
         'js'     => uglified,
         'js.map' => source_map
       }
     end
   end
-end
+end

data/lib/puppet-herald/models/log-entry.rb CHANGED Viewed

@@ -1,3 +1,10 @@
-class LogEntry < ActiveRecord::Base
-  belongs_to :report
-end
+# A module for Herald
+module PuppetHerald
+  # module for models
+  module Models
+    # A log entry model
+    class LogEntry < ActiveRecord::Base
+      belongs_to :report
+    end
+  end
+end

data/lib/puppet-herald/models/node.rb CHANGED Viewed

@@ -1,7 +1,17 @@
-class Node < ActiveRecord::Base
-  has_many   :reports, dependent: :delete_all
+# A module for Herald
+module PuppetHerald
+  # module for models
+  module Models
+    # A node model
+    class Node < ActiveRecord::Base
+      has_many :reports, dependent: :delete_all
-  def self.get_with_reports id
-    Node.where("id = ?", id).includes(:reports).first
+      # Gets a node with prefetched reports
+      # @param id [Integer] a in of node to get
+      # @return [Node, nil] fetched node or nil
+      def self.get_with_reports(id)
+        Node.joins(:reports).includes(:reports).find_by_id(id)
+      end
+    end
   end
-end
+end