puppet-herald 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWNhZTUzMzk1M2ExNzcwNGFiZDVkNTNmNDBkZGYxNmQxNzUyYjg2MQ==
+  data.tar.gz: !binary |-
+    ZjBjNjQyMjYzMjc2ZGU0Y2Y4MTA3NWQyMTI1NzIxNGIxMDMwNGQzOA==
+SHA512:
+  metadata.gz: !binary |-
+    ZjVhZjY1ZGYwOGE1ODc1YjcxYzNjMDhjYzFlNTIwY2E1M2VkYjgzNWZkYWQ0
+    NTY4N2M2ZmUxNmVlZDMzN2U0MTZjMDg2MDMzZWI4MjNmY2FhYzNmOTZhMTJl
+    YjZmMTA4MjVlZDk1OTFmNzM2YzM0Yjk0ZWZhMzEyOWIyZjAyMzU=
+  data.tar.gz: !binary |-
+    NzhhZGI2ZDhmYzFiY2I4MzYzMmY3YzMwMDM1ZTRlM2YwYzU4NWEzNDFhNWE3
+    ZDEzOWU1YmFiNjZhNjE3NDQyNzY0ZmIwYTY0OGExNTc4OTUzZWNlZmE1ZTI0
+    YzFlNDI4NDk4YjExODViYjUzYjZkMDJjZjg0YWMxMTUwODM1YWM=

data/.gitignore

@@ -0,0 +1,22 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore bundle .vendor dir
+/.vendor
+/coverage
+
+/Gemfile.lock
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,5 @@
+source ENV['GEM_SOURCE'] || "https://rubygems.org"
+
+gemspec
+
+# vim:ft=ruby

data/README.md

@@ -0,0 +1,73 @@
+puppet-herald gem
+========
+
+Overview
+--------
+
+Herald is a puppet report processor. He provides a gateway for consuming puppet reports, a REST API and a simple Web app to display reports.
+
+Puppet module
+-----
+
+There is/will be a puppet module that handle installation and configuration of Herald and prerequisites. Check that out: https://github.com/wavesoftware/puppet-herald
+
+Prerequisites
+-----
+
+ * `libpq-dev`
+
+On Ubuntu/Debian system install them with:
+
+```shell
+sudo apt-get install libpq-dev
+```
+
+Installation
+-----
+
+Install Herald and all dependencies from http://rubygems.org:
+```shell
+sudo gem install puppet-herald
+```
+
+Configuration
+-----
+
+If you like to use PostgreSQL database to hold reports, you will need to configure it. By default, Herald will use a sqlite file that he tries to create in your home directory. Check out `puppet-herald --help` for description.
+
+###Create a database
+
+Just create a database for Herald (this is just a sample):
+```sql
+CREATE ROLE pherald LOGIN PASSWORD '<YOUR PASSWORD>' NOSUPERUSER INHERIT NOCREATEDB NOCREATEROLE NOREPLICATION;
+CREATE DATABASE "pherald" WITH OWNER = pherald
+  ENCODING = 'UTF8'
+  TABLESPACE = pg_default;
+```
+
+Usage
+-----
+
+```shell
+$ puppet-herald --help
+```
+
+Example of running a server with using sqlite and binding to other host and port:
+
+```shell
+puppet-herald --dbconn sqlite:///var/lib/puppet/reports/pherald.db --bind master.cluster.vm --port 8081
+```
+
+###Contributing
+
+Contributions are welcome!
+
+To contribute, follow the standard [git flow](http://danielkummer.github.io/git-flow-cheatsheet/) of:
+
+1. Fork it
+1. Create your feature branch (`git checkout -b feature/my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin feature/my-new-feature`)
+1. Create new Pull Request
+
+Even if you can't contribute code, if you have an idea for an improvement please open an [issue](https://github.com/wavesoftware/gem-puppet-herald/issues).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'puppet-herald/app'
+require 'sinatra/activerecord/rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/puppet-herald

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+$0 = 'puppet-herald'
+
+begin
+  require 'puppet-herald/cli'
+rescue LoadError
+  require 'rubygems'
+  require 'puppet-herald/cli'
+end
+
+# Process command line options and run Puppet Herald
+PuppetHerald::CLI.parse_options

data/config.ru

@@ -0,0 +1,2 @@
+require 'puppet-herald/app'
+run PuppetHerald::App

data/db/migrate/20141211165540_create_nodes.rb

@@ -0,0 +1,10 @@
+class CreateNodes < ActiveRecord::Migration
+  def change
+    create_table :nodes do |t|
+      t.string   :name
+      t.string   :status
+      t.integer  :no_of_reports
+      t.datetime :last_run
+    end
+  end
+end

data/db/migrate/20141211171305_create_reports.rb

@@ -0,0 +1,16 @@
+class CreateReports < ActiveRecord::Migration
+  def change
+    create_table :reports do |t|
+      t.string      :status
+      t.string      :environment
+      t.string      :transaction_uuid
+      t.string      :configuration_version
+      t.string      :puppet_version
+      t.string      :kind
+      t.string      :host
+      t.datetime    :time
+      
+      t.references  :node
+    end
+  end
+end

data/db/migrate/20141211171326_create_log_entries.rb

@@ -0,0 +1,13 @@
+class CreateLogEntries < ActiveRecord::Migration
+  def change
+    create_table :log_entries do |t|
+      t.datetime    :time
+      t.string      :level
+      t.string      :source
+      t.integer     :line
+      t.text        :message
+      
+      t.references  :report
+    end
+  end
+end

data/db/schema.rb

@@ -0,0 +1,47 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20141211171326) do
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "log_entries", force: true do |t|
+    t.datetime "time"
+    t.string   "level"
+    t.string   "source"
+    t.integer  "line"
+    t.text     "message"
+    t.integer  "report_id"
+  end
+
+  create_table "nodes", force: true do |t|
+    t.string   "name"
+    t.string   "status"
+    t.integer  "no_of_reports"
+    t.datetime "last_run"
+  end
+
+  create_table "reports", force: true do |t|
+    t.string   "status"
+    t.string   "environment"
+    t.string   "transaction_uuid"
+    t.string   "configuration_version"
+    t.string   "puppet_version"
+    t.string   "kind"
+    t.string   "host"
+    t.datetime "time"
+    t.integer  "node_id"
+  end
+
+end

data/lib/puppet-herald.rb

@@ -0,0 +1,37 @@
+begin
+  require 'pry'
+rescue LoadError
+  # Do nothing here
+end
+
+module PuppetHerald
+
+  @@root = File.dirname(File.dirname(File.realpath(__FILE__)))
+
+  def self.relative_dir dir
+    File.join @@root, dir
+  end
+
+  def self.port
+    @@port
+  end
+
+  def self.environment
+    env = :production
+    unless ENV['PUPPET_HERALD_ENV'].nil?
+      env = ENV['PUPPET_HERALD_ENV'].to_sym
+    end
+    return env
+  end
+
+  def self.is_in_dev?
+    return [:development, :dev, :test, :ci].include? environment
+  end
+
+  def self.is_in_prod?
+    return !is_in_dev?
+  end
+end
+
+require 'puppet-herald/database'
+require 'puppet-herald/app'

data/lib/puppet-herald/app.rb

@@ -0,0 +1,112 @@
+require 'sinatra/base'
+require "sinatra/namespace"
+require 'sinatra/activerecord'
+require 'puppet-herald'
+require 'puppet-herald/javascript'
+require 'puppet-herald/models/node'
+require 'puppet-herald/models/report'
+
+module PuppetHerald
+  class App < Sinatra::Base
+    register Sinatra::Namespace
+    register Sinatra::ActiveRecordExtension
+    configure [:production, :development] do
+      enable :logging
+      PuppetHerald::Database.setup self
+    end
+    if PuppetHerald::is_in_dev?
+      set :environment, :development
+    else
+      set :environment, :production
+    end
+
+    def self.bug ex
+      file = Tempfile.new(['puppet-herald-bug', '.log'])
+      filepath = file.path
+      file.close
+      file.unlink
+      message = "v#{PuppetHerald::VERSION}-#{ex.class.to_s}: #{ex.message}"
+      contents = message + "\n\n" + ex.backtrace.join("\n") + "\n"
+      File.write(filepath, contents)
+      bugo = {
+        :message  => message,
+        :homepage => PuppetHerald::HOMEPAGE,
+        :bugfile  => filepath,
+        :help     => "Please report this bug to #{PuppetHerald::HOMEPAGE} by passing contents of bug file: #{filepath}"
+      }
+      return bugo
+    end
+
+    error do
+      @bug = PuppetHerald::App.bug(env['sinatra.error'])
+      erb :err500
+    end
+
+    get %r{/app\.min\.(js\.map|js)} do |ext|
+      content_type 'application/javascript'
+      ugly = PuppetHerald::Javascript::uglify '/app.min.js.map'
+      ugly[ext]
+    end
+    
+    get '/' do
+      redirect "/app.html", 301
+    end
+
+    get '/index.html' do
+      redirect "/app.html", 301
+    end
+
+    get '/app.html' do
+      if PuppetHerald::is_in_prod?
+        @minified = '.min'
+        @files = ['/app.min.js']
+      else
+        @minified = ''
+        @files = PuppetHerald::Javascript::files
+      end
+      erb :app
+    end
+
+    get '/version.json' do
+      content_type 'application/json'
+      ver = {}
+      [:VERSION, :LICENSE, :NAME, :PACKAGE, :SUMMARY, :DESCRIPTION, :HOMEPAGE].each do |const|
+        ver[const.downcase] = PuppetHerald::const_get const
+      end
+      ver.to_json
+    end
+
+    namespace '/api' do
+      namespace '/v1' do
+
+        put '/provide-log' do
+          content_type 'application/json'
+          yaml = request.body.read
+          report = Report.create_from_yaml yaml
+
+          {:status => :ok}.to_json
+        end
+
+        get '/nodes' do
+          content_type 'application/json'
+          nodes = Node.all
+          nodes.to_json
+        end
+
+        get '/node/:id' do
+          content_type 'application/json'
+          id = params[:id]
+          Node.get_with_reports(id).
+            to_json(:include => :reports)
+        end
+
+        get '/report/:id' do
+          content_type 'application/json'
+          id = params[:id]
+          Report.get_with_log_entries(id).
+            to_json(:include => :log_entries)
+        end
+      end
+    end
+  end
+end

data/lib/puppet-herald/cli.rb

@@ -0,0 +1,53 @@
+require 'micro-optparse'
+require 'puppet-herald'
+require 'puppet-herald/version'
+require 'puppet-herald/database'
+
+module PuppetHerald
+  class CLI
+
+    def self.parse_options
+      usage = ""
+      banner = <<-eos
+#{PuppetHerald::NAME} v#{PuppetHerald::VERSION} - #{PuppetHerald::SUMMARY}
+
+#{PuppetHerald::DESCRIPTION}
+
+Usage: #{$0} [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
+      home = File.expand_path('~')
+      defaultdb     = "sqlite://#{home}/pherald.db"
+      defaultdbpass = "#{home}/.pherald.pass"
+      parser = 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!
+
+      puts "Starting #{PuppetHerald::NAME} v#{PuppetHerald::VERSION}..."
+      PuppetHerald::Database.dbconn   = options[:dbconn]
+      PuppetHerald::Database.passfile = options[:passfile]
+      begin
+        PuppetHerald::Database.validate! :echo => true
+      rescue Exception => ex
+        STDERR.puts "FATAL ERROR - Database configuration is invalid!\n\n#{ex.message}"
+        exit 2
+      end
+      begin
+        PuppetHerald::App.run! options
+      rescue Exception => ex
+        bug = PuppetHerald::App.bug(ex)
+        STDERR.puts "FATAL ERROR - Unexpected error occured, mayby a bug?\n\n#{bug[:message]}\n\n#{bug[:help]}"
+        exit 1
+      end
+    end
+  end
+end