kriterion 0.0.1

data/lib/kriterion/cli.rb

@@ -0,0 +1,28 @@
+require 'cri'
+
+class Kriterion
+  class CLI
+    def self.command
+      @cmd ||= Cri::Command.define do
+        name        'kriterion'
+        usage       'kriterion <subcommand>'
+        summary     'Exposes Puppet\'s compliance information in a REST API'
+
+        flag   :h,  :help,  'show help for this command' do |value, cmd|
+          puts cmd.help
+          exit 0
+        end
+
+        flag :d,  :debug, 'Enable debug logging'
+        flag nil, :trace, 'Print stacktraces'
+
+        run do |opts, args, cmd|
+          puts cmd.help
+          exit 0
+        end
+      end
+    end
+  end
+end
+
+require 'kriterion/cli/worker'

data/lib/kriterion/cli/api.rb

@@ -0,0 +1,35 @@
+require 'cri'
+
+class Kriterion
+  class CLI
+    class API
+      def self.command
+        @cmd ||= Cri::Command.define do
+          name        'api'
+          usage       'api --standards_dir <uri>'
+          summary     'Runs a kriterion API server'
+
+          flag   :h,  :help,  'show help for this command' do |value, cmd|
+            puts cmd.help
+            exit 0
+          end
+
+          option   :u, :standards_dir,            'URI of the RestMQ server', argument: :required
+          optional :h, :mongo_hostname, 'Hostname of the MongoDB server to use', default: 'localhost'
+          optional :d, :mongo_database, 'Name of the MongoDB database to use', default: 'kriterion'
+          optional :p, :mongo_port,     'Port for MongoDB', default: 27017
+
+
+          run do |opts, args, cmd|
+            # TODO: Get log levels working properly
+            require 'kriterion/api'
+            worker = Kriterion::API.new(opts)
+            worker.run
+          end
+        end
+      end
+    end
+  end
+end
+
+Kriterion::CLI.command.add_command(Kriterion::CLI::API.command)

data/lib/kriterion/cli/worker.rb

@@ -0,0 +1,35 @@
+require 'cri'
+
+class Kriterion
+  class CLI
+    class Worker
+      def self.command
+        @cmd ||= Cri::Command.define do
+          name        'worker'
+          usage       'worker --uri <uri>'
+          summary     'Runs a kriterion worker'
+
+          flag   :h,  :help,  'show help for this command' do |value, cmd|
+            puts cmd.help
+            exit 0
+          end
+
+          optional :u, :uri           , 'URI of the RestMQ server'             , default: ENV['uri'] || 'http://localhost:8888'
+          optional :q, :queue         , 'Queue to subscribe to'                , default: ENV['queue']|| 'reports'
+          optional :h, :mongo_hostname, 'Hostname of the MongoDB server to use', default: ENV['mongo_hostname']|| 'localhost'
+          optional :d, :mongo_database, 'Name of the MongoDB database to use'  , default: ENV['mongo_database']|| 'kriterion'
+          optional :p, :mongo_port    , 'Port for MongoDB'                     , default: ENV['mongo_port']|| 27017
+
+
+          run do |opts, args, cmd|
+            require 'kriterion/worker'
+            worker = Kriterion::Worker.new(opts)
+            worker.run
+          end
+        end
+      end
+    end
+  end
+end
+
+Kriterion::CLI.command.add_command(Kriterion::CLI::Worker.command)

data/lib/kriterion/event.rb

@@ -0,0 +1,36 @@
+require 'kriterion/object'
+
+class Kriterion
+  class Event < Kriterion::Object
+    attr_reader :audited
+    attr_reader :property
+    attr_reader :previous_value
+    attr_reader :desired_value
+    attr_reader :historical_value
+    attr_reader :message
+    attr_reader :name
+    attr_reader :status
+    attr_reader :time
+    attr_reader :redacted
+    attr_reader :corrective_change
+
+    attr_accessor :certname
+    attr_accessor :resource
+
+    def initialize(data)
+      @audited           = data['audited']
+      @property          = data['property']
+      @previous_value    = data['previous_value']
+      @desired_value     = data['desired_value']
+      @historical_value  = data['historical_value']
+      @message           = data['message']
+      @name              = data['name']
+      @status            = data['status']
+      @time              = data['time']
+      @redacted          = data['redacted']
+      @corrective_change = data['corrective_change']
+      @certname          = data['certname']
+      @resource          = data['resource']
+    end
+  end
+end

data/lib/kriterion/item.rb

@@ -0,0 +1,42 @@
+require 'kriterion/object'
+
+class Kriterion
+  class Item < Kriterion::Object
+    attr_reader :uuid
+    attr_reader :id
+    attr_reader :title
+    attr_reader :description
+    attr_reader :severity
+    attr_reader :parent_uuid
+    attr_reader :section_path
+
+    attr_accessor :resources
+
+    def initialize(data)
+      @uuid         = data['uuid'] || SecureRandom.uuid
+      @id           = data['id']
+      @title        = data['title']
+      @description  = data['description']
+      @severity     = data['severity']
+      @section_path = data['section_path']
+      @parent_type  = data['parent_type']
+      @parent_uuid  = data['parent_uuid']
+      @resources    = data['resources'] || []
+    end
+
+    def compliance
+      super(resources)
+    end
+
+    def parent_names(separator)
+      parents = []
+
+      section_path.each_index do |index|
+        parents << section_path[0..index].join(separator)
+      end
+
+      parents.delete(id)
+      parents.reverse
+    end
+  end
+end

data/lib/kriterion/logs.rb

@@ -0,0 +1,14 @@
+require 'logger'
+
+module Kriterion::Logs
+  DEBUG = ::Logger::DEBUG
+  INFO  = ::Logger::INFO
+
+  def logger
+    unless $logger
+      $logger       = ::Logger.new(STDOUT)
+      $logger.level = ::Logger::INFO
+    end
+    $logger
+  end
+end

data/lib/kriterion/metrics.rb

@@ -0,0 +1,22 @@
+class Kriterion
+  class Metrics
+    def initialize
+      @metrics = {}
+    end
+
+    def [](symbol)
+      @metrics[symbol] || 0
+    end
+
+    def []=(symbol, value)
+      @metrics[symbol] = value
+    end
+
+    def print
+      logger.info 'Metrics:'
+      @metrics.each do |name, value|
+        logger.info "  #{name} #{value.round(2)}s"
+      end
+    end
+  end
+end

data/lib/kriterion/object.rb

@@ -0,0 +1,50 @@
+class Kriterion
+  class Object
+    def to_h(mode = :basic)
+      raise 'Mode must be :basic or :full' unless %i[basic full].include? mode
+      hash = {}
+
+      instance_variables.each do |v|
+        hash[v.to_s.gsub(/^@/, '')] = instance_variable_get(v.to_s)
+      end
+
+      if mode == :basic
+        hash.reject do |k, _v|
+          %w[
+            sections
+            items
+            resources
+            events
+          ].include? k
+        end
+      elsif mode == :full
+        hash
+      end
+    end
+
+    def find_section(name)
+      sections ? sections.select { |s| s.name == name }[0] : nil
+    end
+
+    def compliance(objects)
+      total         = objects.count
+      compliant     = objects.count { |o| o.compliance['compliant'] }
+      non_compliant = total - compliant
+      percentage    = if total.zero?
+                        0
+                      else
+                        compliant / total
+                      end
+
+      {
+        'compliant' => percentage == 1,
+        'events'    => {
+          'percentage'    => percentage,
+          'compliant'     => compliant,
+          'non_compliant' => non_compliant,
+          'total'         => total
+        }
+      }
+    end
+  end
+end

data/lib/kriterion/report.rb

@@ -0,0 +1,69 @@
+require 'json'
+require 'kriterion/resource'
+
+class Kriterion
+  class Report
+    attr_reader :host
+    attr_reader :time
+    attr_reader :configuration_version
+    attr_reader :transaction_uuid
+    attr_reader :report_format
+    attr_reader :puppet_version
+    attr_reader :status
+    attr_reader :transaction_completed
+    attr_reader :noop
+    attr_reader :noop_pending
+    attr_reader :environment
+    attr_reader :logs
+    attr_reader :metrics
+    attr_reader :corrective_change
+    attr_reader :catalog_uuid
+    attr_reader :code_id
+    attr_reader :cached_catalog_status
+
+    def initialize(data)
+      @host                  = data['host']
+      @time                  = data['time']
+      @configuration_version = data['configuration_version']
+      @transaction_uuid      = data['transaction_uuid']
+      @report_format         = data['report_format']
+      @puppet_version        = data['puppet_version']
+      @status                = data['status']
+      @transaction_completed = data['transaction_completed']
+      @noop                  = data['noop']
+      @noop_pending          = data['noop_pending']
+      @environment           = data['environment']
+      @logs                  = data['logs']
+      @metrics               = data['metrics']
+      @resource_statuses     = data['resource_statuses']
+      @corrective_change     = data['corrective_change']
+      @catalog_uuid          = data['catalog_uuid']
+      @code_id               = data['code_id']
+      @cached_catalog_status = data['cached_catalog_status']
+    end
+
+    def resource_statuses
+      # If this is a hash then the objects haven't been initialised
+      # We should initialise them now
+      if @resource_statuses.is_a? Hash
+        @resource_statuses = @resource_statuses.map do |_ref, params|
+          Kriterion::Resource.new(params)
+        end
+      end
+      @resource_statuses
+    end
+
+    def certname
+      host
+    end
+
+    # Returns resources that have given tags, expects an array of tags
+    def resources_with_tags(tags)
+      resource_statuses.select do |resource|
+        tags.any? do |tag|
+          resource.tags.include? tag
+        end
+      end
+    end
+  end
+end

data/lib/kriterion/resource.rb

@@ -0,0 +1,60 @@
+require 'kriterion/object'
+require 'json'
+
+class Kriterion
+  class Resource < Kriterion::Object
+    attr_reader :uuid
+    attr_reader :title
+    attr_reader :file
+    attr_reader :line
+    attr_reader :resource
+    attr_reader :resource_type
+    attr_reader :provider_used
+    attr_reader :containment_path
+    attr_reader :tags
+
+    attr_accessor :events
+    attr_accessor :parent_uuid
+    attr_accessor :unchanged_nodes
+
+    def initialize(hash)
+      @uuid             = hash['uuid'] || SecureRandom.uuid
+      @title            = hash['title']
+      @file             = hash['file']
+      @line             = hash['line']
+      @resource         = hash['resource']
+      @resource_type    = hash['resource_type']
+      @provider_used    = hash['provider_used']
+      @containment_path = hash['containment_path']
+      @tags             = hash['tags']
+      @events           = hash['events'] || []
+      @parent_uuid      = hash['parent_uuid']
+      @unchanged_nodes  = hash['unchanged_nodes'] || []
+    end
+
+    def ==(other)
+      other.resource == resource
+    end
+
+    def compliance
+      compliant     = unchanged_nodes.count
+      non_compliant = events.group_by(&:certname).count
+      total         = compliant + non_compliant
+      percentage    = if total.zero?
+                        0
+                      else
+                        compliant / total
+                      end
+
+      {
+        'compliant' => events.empty?,
+        'events'    => {
+          'percentage'    => percentage,
+          'compliant'     => compliant,
+          'non_compliant' => non_compliant,
+          'total'         => total
+        }
+      }
+    end
+  end
+end

data/lib/kriterion/section.rb

@@ -0,0 +1,32 @@
+require 'securerandom'
+require 'kriterion/object'
+
+class Kriterion
+  class Section < Kriterion::Object
+    attr_accessor :uuid
+    attr_accessor :name
+    attr_accessor :standard
+    attr_accessor :description
+    attr_accessor :items
+    attr_accessor :sections
+
+    def initialize(data)
+      @uuid        = data['uuid'] || SecureRandom.uuid
+      @name        = data['name']
+      @standard    = data['standard']
+      @description = data['description']
+      @items       = data['items'] || []
+      @sections    = data['sections'] || []
+      @parent_type = data['parent_type']
+      @parent_uuid = data['parent_uuid']
+    end
+
+    def type
+      :section
+    end
+
+    def compliance
+      super([items, sections].flatten)
+    end
+  end
+end

data/lib/kriterion/standard.rb

@@ -0,0 +1,65 @@
+
+require 'kriterion/object'
+
+class Kriterion
+  class Standard < Kriterion::Object
+    @@standards = []
+
+    attr_accessor :uuid
+    attr_accessor :name
+    attr_accessor :date
+    attr_accessor :description
+    attr_accessor :title
+    attr_accessor :version
+    attr_accessor :item_syntax
+    attr_accessor :section_separator
+    attr_accessor :sections
+    attr_accessor :items
+
+    def initialize(data)
+      @uuid              = data['uuid'] || SecureRandom.uuid
+      @name              = data['name']
+      @date              = data['date']
+      @description       = data['description']
+      @title             = data['title']
+      @version           = data['version']
+      @item_syntax       = if data['item_syntax'].is_a? Regexp
+                             data['item_syntax']
+                           else
+                             Regexp.new(data['item_syntax'])
+                           end
+      @section_separator = data['section_separator']
+      @sections          = data['sections'] || []
+      @items             = data['items'] || []
+    end
+
+    def self.get(name)
+      # Reload all standards
+      Kriterion::Standard.reload_all!
+
+      results = @@standards.select { |s| s.name == name }
+
+      case results.length
+      when 0
+        raise "No standards found with name: #{name}"
+      when 1
+        results.first
+      else
+        raise "Multiple standards found with #{name}"
+      end
+    end
+
+    def self.reload_all!
+      backend = Kriterion::Backend.get
+      @@standards = backend.standards
+    end
+
+    def type
+      :standard
+    end
+
+    def compliance
+      super([items, sections].flatten)
+    end
+  end
+end