puppet-herald 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,15 @@
---- 
-SHA512: 
-  metadata.gz: 78f9a25bcd05308702a4aaab34357dcd95359e1c418d7795fbf46ebea7b2c327a752107952292f121d0ba627feb9c5828a29ca64d22b480097705a1b5b99275c
-  data.tar.gz: e3a4545a971d3c56f7062b98594351899e907828f1ce983386489e340e705a4ed73ae6a8af82b78918926cca3dfc29c78b6407545e545f32cdcf705f31d8594c
-SHA1: 
-  metadata.gz: 0cf69983b2dca3d4c86d2bcb33178563c0d2f1db
-  data.tar.gz: e1a41cbe6c56cce31b299b7002880da7559ddf9d
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWQxYTc4MjVkZGQ2NzM5MTk4ZTUxNDUzY2I5MzYzMjMwNDA0ZTk0Ng==
+  data.tar.gz: !binary |-
+    ZTdkYTA0MDU0OWM1ZGRhZTZmZTg0NzUzOTkzOWE3MTE4NjA0Y2IyNw==
+SHA512:
+  metadata.gz: !binary |-
+    NDhjYTZiNDkyN2M0YzFlZWNkMzkwOGU4NTUzYjc1MDA0MDFjNjY5MzI0M2Q2
+    ZjhhYWVhMmMxOTNkM2Q1MzM0OWU5YWYyYzIyMGVkYmNjM2NiNGFiMDFlMTQ2
+    MGMxMjVjODY0N2JjZDU4ZGRlNzliNDk3MmFjNTVkYjg3NWJkYzQ=
+  data.tar.gz: !binary |-
+    MDRjOGZkMGFmZmU2ZWUyMWFiYzJkZGNjMWI1YmNhNGI0ODVmYzgzNDQ3M2Vj
+    YjUxNWM2YWQzYzY1ZjIwMWYxOTBmYWVkOWFhMzcwMWM4Mzk5NDE4MzJmYWMw
+    NjBhZTRiMjliNzE4ODg5NzU2NjhkMWUyMGZiYzExNTQxMDdjMmU=

data/.rubocop.yml

@@ -0,0 +1,31 @@
+# This is the configuration used to check the rubocop source code.
+
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Include:
+    - 'lib/**/*.rb'
+    - 'db/**/*.rb'
+    - 'bin/*'
+    - 'Rakefile'
+    - 'Gemfile'
+    - 'puppet-herald.gemspec'
+    - 'config.ru'
+  Exclude:
+    - '.**/*'
+    - 'test/**/*'
+    - 'spec/**/*'
+    - 'node_modules/**/*'
+    - 'coverage/**/*'
+    - '.vendor/**/*'
+    - 'vendor/**/*'
+    - '.bundle/**/*'
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/AbcSize:
+  Max: 20

data/.rubocop_todo.yml

@@ -0,0 +1,6 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-12-17 02:10:52 +0100 using RuboCop version 0.28.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.travis.yml

@@ -3,15 +3,15 @@ language: ruby
 bundler_args: --without development
 script:
   - bundle exec rake test
-  # - ./node_modules/karma/bin/karma start --single-run --browsers PhantomJS test/javascript/karma.conf.js
 before_install: rm -f Gemfile.lock
 before_script:
   - npm install
-matrix:
-  fast_finish: true
-  include:
-  - rvm: 1.9.3
-  - rvm: 2.0.0
-  - rvm: 2.1.0
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+env:
+  - PUPPET_HERALD_ENV=production
+  - PUPPET_HERALD_ENV=development
 notifications:
   email: false

data/Gemfile

@@ -1,30 +1,26 @@
-source ENV['GEM_SOURCE'] || "https://rubygems.org"
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 
 gemspec
 
 group :test do
-
   gem 'rake',             '~> 10.4'
   gem 'rspec',            '~> 3.1'
   gem 'rspec-its',        '~> 1.1'
+  gem 'webmock',          '~> 1.20'
   gem 'coveralls',        '~> 0.7'
   gem 'simplecov',        '~> 0.9'
   gem 'sqlite3',          '~> 1.3'
-
+  gem 'rubocop',          '~> 0.28'
 end
 
 group :development do
-
   gem 'inch',             '~> 0.5'
   gem 'travis',           '~> 1.6'
   gem 'pry-byebug',       '~> 2.0'   if RUBY_VERSION >= '2.0.0'
   gem 'pry-debugger',     '~> 0.2'   if RUBY_VERSION < '2.0.0'
-
 end
 
-local_gemfile = File.join(File.dirname(__FILE__), "Gemfile.local")
-if File.exists?(local_gemfile)
-  eval_gemfile local_gemfile
-end
+local_gemfile = File.join(File.dirname(__FILE__), 'Gemfile.local')
+eval_gemfile local_gemfile if File.exist?(local_gemfile)
 
 # vim:ft=ruby

data/README.md

@@ -22,23 +22,18 @@ Herald is a puppet report processor. He provides a gateway for consuming puppet
 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
+There is/will be a puppet module that handle installation and configuration of Herald and prerequisites. Installing configuring and running with puppet is recommended. If you decided to take that approch check out: https://github.com/wavesoftware/puppet-herald
 
-Prerequisites
------
-
- * `libpq-dev`
+Installation, configuration and usage point seen below does not apply to installing with puppet!
 
-On Ubuntu/Debian system install them with:
-
-```shell
-sudo apt-get install libpq-dev
-```
 
 Installation
 -----
 
-Install Herald and all dependencies from http://rubygems.org:
+Herald typically should be installed on the same node or in management network of your puppet master. It will listen by default to localhost (this can be changed by `--bind` option). You should take care to properlly secure Herald if its publicly avialable (SSL, Authorization, Access List, Firewalls etc.). This could be easily done with Apache web server. Is approch is taken in puppet module (see above).
+
+If you decided to install Herald by yourself, issue just:
+
 ```shell
 sudo gem install puppet-herald
 ```
@@ -46,13 +41,30 @@ 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.
+###PostgreSQL
+
+PostgreSQL is recommended database backend for Herald. 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.
+
+###Prerequisites for PostgreSQL
+
+ * `libpq-dev` system package
+ * `pg` gem package
+
+On Ubuntu/Debian system install them with:
+
+```shell
+sudo apt-get install libpq-dev
+sudo gem install pg
+```
 
 ###Create a database
 
-Just create a database for Herald (this is just a sample):
+Just create a database for Herald (this is just a sample for PostgreSQL):
+
 ```sql
-CREATE ROLE pherald LOGIN PASSWORD '<YOUR PASSWORD>' NOSUPERUSER INHERIT NOCREATEDB NOCREATEROLE NOREPLICATION;
+CREATE ROLE pherald LOGIN PASSWORD '<YOUR PASSWORD>'
+  NOSUPERUSER INHERIT NOCREATEDB
+  NOCREATEROLE NOREPLICATION;
 CREATE DATABASE "pherald" WITH OWNER = pherald
   ENCODING = 'UTF8'
   TABLESPACE = pg_default;
@@ -65,10 +77,134 @@ Usage
 $ puppet-herald --help
 ```
 
-Example of running a server with using sqlite and binding to other host and port:
+Example usage of Herald with defaults:
+
+```shell
+puppet-herald # Navigate to http://localhost:11303/
+```
+
+Example usage of Herald with PostgreSQL and binding 127.0.1.1:
+
+```shell
+puppet-herald \
+  --dbconn postgresql://pherald@master.cluster.vm:5432/pherald \
+  --passfile /etc/pherald/passfile \
+  --bind 127.0.1.1 # Navigate to http://127.0.1.1:11303/
+```
+
+Example usage of Herald with SQLite3 and binding to other host and port:
+
+```shell
+puppet-herald \
+  --dbconn sqlite:///var/lib/puppet/reports/pherald.db \
+  --bind master.cluster.vm \
+  --port 8081 # Navigate to http://master.cluster.vm:8081/
+```
+
+Configuring puppet master
+-------------------------
+
+To send reports to Herald, you need to configure your puppet master to use custom report proccessor. This processor is also automatically configured if you choose to use a puppet module installation version. If not you must configure it by yourself.
+
+First install a puppet-herald gem if you didn't do it already on puppet master:
+
+```shell
+sudo gem install puppet-herald
+```
+
+If you are running PE, run instead:
+
+```shell
+sudo /opt/puppet/bin/gem install puppet-herald
+```
+
+Then create a file in your puppet module directory (you can get modulepath with command: `puppet config print modulepath`). For example: `<puppet modules>/herald/lib/puppet/reports/herald.rb` with contents:
+
+```ruby
+require 'puppet'
+require 'puppet-herald/client'
+
+Puppet::Reports.register_report(:herald) do
+  desc "Process reports via the Herald API."
+  def process
+    PuppetHerald::Client.new.process(self)
+  end
+end
+```
+
+If you need to post to other host or port use (defaults are: `localhost` and `11303`):
+
+```ruby
+require 'puppet'
+require 'puppet-herald/client'
+
+Puppet::Reports.register_report(:herald) do
+  desc "Process reports via the Herald API."
+  def process
+    PuppetHerald::Client.new('master.secure.vm', 8082).process(self)
+  end
+end
+```
+
+Then edit your `puppet.conf` file and set `herald` as your report processor in section `main`:
+
+```ini
+[main]
+   reports = puppetdb,herald
+```
+
+###Testing a ruby code
+
+There are two types of tests distributed with the module. Unit tests and integration tests that uses sqlite as database backend in memory.
+
+For unit testing, make sure you have:
+
+ * rake
+ * bundler
+
+Install the necessary gems (gems will be downloaded to private .vendor directory):
+
+```shell
+bundle install --path .vendor
+```
+
+And then run the unit tests (for integration tests simply swap `unit` to `integration`):
+
+```shell
+bundle exec rake spec:unit
+```
+
+You can run single test with:
+
+```shell
+bundle exec rspec spec/unit/puppet-herald/version_spec.rb
+```
+
+You can also run all test with `test` target
+
+###Testing a javascript code
+
+To test javascript code, make sure you have:
+
+ * nodejs
+
+If so, issue this command to bootstart testing environment:
+
+```shell
+npm install
+```
+
+And then test Javascript code with:
+
+```shell
+bundle exec rake js
+```
+
+Check your code for quality with:
 
 ```shell
-puppet-herald --dbconn sqlite:///var/lib/puppet/reports/pherald.db --bind master.cluster.vm --port 8081
+bundle exec rake rucocop
+bundle exec rake inch
 ```
 
 ###Contributing

data/Rakefile

@@ -1,13 +1,74 @@
 
 require 'sinatra/activerecord/rake'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'rubocop'
+require 'fileutils'
 
-desc "Run spec tests."
-RSpec::Core::RakeTask.new(:spec)
+namespace :spec do
+  desc 'Run all spec tests at once.'
+  RSpec::Core::RakeTask.new(:all)
 
-desc "Run lint, and spec tests."
-task :test => [
-  :spec
+  desc 'Run unit spec tests.'
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = [
+      'spec/unit'
+    ]
+  end
+
+  desc 'Run integration spec tests.'
+  RSpec::Core::RakeTask.new(:integration) do |t|
+    t.pattern = [
+      'spec/zzz_integration'
+    ]
+  end
+end
+
+desc 'Run javascript Jasmine/Karma tests on PhantomJS.'
+task :js do
+  FileUtils.rm_rf 'coverage/javascript'
+  sh 'node_modules/karma/bin/karma start --browsers PhantomJS test/javascript/karma.conf.js'
+  path = Pathname.glob('coverage/javascript/PhantomJS*/text.txt').first
+  puts 'Coverage for Javascript:'
+  puts File.read(path)
+end
+
+tests = [
+  :'spec:all',
+  :js,
+  :rubocop
 ]
 
-task :default => :test
+begin
+  require 'inch/rake'
+  Inch::Rake::Suggest.new :inch, '--pedantic'
+  tests << :inch
+rescue LoadError # rubocop:disable all
+  # nothing here
+end
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  # don't abort rake on failure
+  task.fail_on_error = true
+end
+
+namespace :rubocop do
+  namespace :todo do
+    desc 'Cleans a rubocop TODO list'
+    task :clean do
+      File.write('.rubocop_todo.yml', '')
+      Rake::Task[:rubocop].execute
+    end
+
+    desc 'Saves actual rubocop state into TODO list'
+    task :save do
+      rcli = RuboCop::CLI.new
+      rcli.run ['--auto-gen-config']
+    end
+  end
+end
+
+desc 'Run lint, and all spec tests.'
+task test: tests
+
+task default: :test

data/bin/puppet-herald

@@ -10,4 +10,4 @@ rescue LoadError
 end
 
 # Process command line options and run Puppet Herald
-PuppetHerald::CLI.run!
+PuppetHerald::CLI.new.run!

data/config.ru

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

data/db/migrate/20141211165540_create_nodes.rb

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

data/db/migrate/20141211171305_create_reports.rb

@@ -1,16 +1,18 @@
+# Migration
 class CreateReports < ActiveRecord::Migration
+  # 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
+      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