sensu-package-metrics 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTcyZmI4YzA0M2JmMmZmMmZlZTYwY2Y0OGFmNmJjYjQyMTlhN2ViMQ==
+  data.tar.gz: !binary |-
+    YWUwYTVkMzhiNjIxZWYzYzNhYTBkYWEyYjI4ZTM2NWQ2MWZiM2I0Yw==
+SHA512:
+  metadata.gz: !binary |-
+    OTI1YjJiODFjODg0OWM0NmJjOGMxMzUyZGZmMmIwMjliMTM1NjQyMzI4ZGJj
+    MjhmNzFhZWJmYTUyYmU3MGFkMTQxN2NlMDYzNTkzNDllYjA5YmQ1NWU1NzRm
+    MzdjNTIyZTllMzkzMmFiZDYxNjg1ZTkyOWY5YWNkOWNlZGUzODU=
+  data.tar.gz: !binary |-
+    MTI4NWM4NzVhY2JjODIyMjM2MDA0MmE0ZTcyNDg2YzkwMGI2YjNjNDFiMjMz
+    NDBjOThlMmEwZTI2OTdjNGI0MWM2ZjI0NWEyNjhmNTM4YjQ5ODBmNWZkMjQw
+    Njc5MGFhMWFjMThlZWU2OTRlNTRlZjdjNjVkMjFkMThhZGZlZDM=

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+- 2.0.0
+deploy:
+  provider: rubygems
+  api_key:
+    secure: NDnz0PbD9cZcwM667A/20I4cV0weVzI91u3u7f5XzufNyylftXm7OMC5kHXWx2uaGdwciOJU5TFJzvOFfQXKl7DUv/7TboAgEqUR8Xc1oR1yUGf40vYFnYApgVfsxv6Jesyt/kYQUiT7DDqcM/Y2TY7jV4Nx+jU1g+4ZX49JStUaQ8EpwuYfcve9u7d22kqtclsg5lQeaMAifWNYO0XHRSRXqbTYg8gSHsZgNX8pgsfxPCL7NBfREV954MPWdQi0sMJ79NCLGAamjDSFWtnlfKasSHH0SeoHy4mCKHL1HmeRL6ROOujofLDwpMBRQwmDBfuDxiZE+oe2VbvPyxFEaUhCsze1KinyStUt5ZlnnWhLMWLxYk9AW/a1Tf+s8gIVviGDn/ezE8iNMD5QFsHSA1DhdIzD+Jcj0e+FIwKFtgy3dGgtkI66YElIJLCJNNpLDLCxEoY6AMz2XOajSQs8+enZAs56zPYnUHozx6iL+M5z+k0GPtGc/dWCeA4IMe8mimyqe5wh0h5LM6tRFuFhaRXaP1cna1QzVL7QMUa/TzOe0Fp2Q5jOdB5ORRfnyA3NHNKgJyPaucMLXjQnqbIg+aTtMJcziF4pm+FJgzqoVQ5IcHd+FxGA2bEIsKnnMv54GyUKREmMfeaaU6LhYfZ24L97NSpJXrMsSL8W46PS1SI=
+  gem: sensu-package-metrics
+  on:
+    tags: true
+    repo: alphagov/sensu-package-metrics

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sensu-package-metrics.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Crown Copyright (Government Digital Service)
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# Sensu Package Metrics [![Build Status](https://travis-ci.org/alphagov/sensu-package-metrics.svg?branch=master)](https://travis-ci.org/alphagov/sensu-package-metrics)
+
+This gem provides a sensu check that can be run to return metric details regarding installed versions of a package. The expected output is a JSON object like so:
+```
+{
+    'package': <expected-package>
+    'status': 'installed'
+    'version': <some-version-number>
+    'installed_at': <some-unix-timestamp-when-package-was-installed'
+    'timestamp': <some-unix-timestamp-when-check-was-run>
+}
+```
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sensu-package-metrics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sensu-package-metrics
+
+## Usage
+
+Once installed, the metric can be run with `report-package-version`. Please use `-h` to see usage:
+```
+Usage: report-package-version (options)
+    -l LOGFILE
+    -p PACKAGE
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sensu-package-metrics/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "features --format pretty --strict"
+end
+
+task :default => [:spec, :features]

data/bin/report-package-version

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'sensu-plugin/metric/cli'
+require 'sensu/package/metrics/package_log_reader'
+require 'date'
+class ReportPackageVersionMetric < Sensu::Plugin::Metric::CLI::JSON
+  option :package, short: "-p PACKAGE", required: true
+  option :log, short: "-l LOGFILE"
+
+  def run
+    logfile = config.fetch(:log, "/var/log/dpkg.log")
+    package =  config.fetch(:package)
+    ok Sensu::Package::Metrics::PackageLogReader.new(logfile).find(package).to_h
+  end
+
+end

data/features/reports_package_version_in_json.feature

@@ -0,0 +1,36 @@
+Feature: Reports package version in json
+
+  Scenario: ask to retrieve version of foobar
+    Given a file named "dpkg.log" with:
+    """
+    2015-11-04 10:31:26 status installed foobar 1485
+    """
+    When I run `report-package-version -p foobar -l dpkg.log`
+    Then the stdout should be JSON with:
+      | package      | foobar    |
+      | status       | installed |
+      | version      | 1485        |
+      | installed_at | 1446633086  |
+
+  Scenario: ask for package not in log
+    Given a file named "dpkg.log" with:
+    """
+    2015-11-04 10:31:26 status installed foobaz 1485
+    """
+    When I run `report-package-version -p foobar -l dpkg.log`
+    Then the stdout should be JSON with:
+      | package | foobar    |
+      | status  | not_found |
+
+  Scenario: ask for package appearing twice in log
+    Given a file named "dpkg.log" with:
+    """
+    2015-11-04 10:31:26 status installed foobar 1483
+    2015-11-04 10:31:26 status installed foobar 1485
+    """
+    When I run `report-package-version -p foobar -l dpkg.log`
+    Then the stdout should be JSON with:
+      | package      | foobar    |
+      | status       | installed |
+      | version      | 1485        |
+      | installed_at | 1446633086  |

data/features/step_definitions/output_steps.rb

@@ -0,0 +1,8 @@
+Then(/^the stdout should be JSON with:$/) do |table|
+  output = all_commands.map { |c| c.output }.join("\n")
+  json = JSON.parse(output)
+  table.raw.each do |row|
+    expected = Integer(row[1]) rescue row[1]
+    expect(json.fetch(row[0])).to eql expected
+  end
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/lib/sensu/package/metrics.rb

@@ -0,0 +1,9 @@
+require "sensu/package/metrics/version"
+
+module Sensu
+  module Package
+    module Metrics
+      # Your code goes here...
+    end
+  end
+end

data/lib/sensu/package/metrics/package_log_reader.rb

@@ -0,0 +1,67 @@
+module Sensu
+  module Package
+    module Metrics
+      class PackageLogReader
+
+        def initialize(logfile)
+          @logfile = logfile
+        end
+
+        def find(package)
+          line = find_line(package)
+          if line.nil?
+            LineNotFound.new(package)
+          else
+            LineFound.new(package, line)
+          end
+        end
+
+        def find_line(package)
+          pattern = "status installed #{package}"
+          File.readlines(@logfile).select {|line| line.include?(pattern) }.last
+        end
+
+
+        class LineNotFound
+          def initialize(package)
+            @package = package
+          end
+
+          def to_h
+            {
+              package: @package,
+              status: 'not_found'
+            }
+          end
+        end
+
+        class LineFound
+          def initialize(package, line)
+            @package = package
+            @line = line
+          end
+
+          def to_h
+            analyse
+          end
+
+          def analyse
+            @line.scan(/(.+) status installed #{@package} (\d+)/) do |timestamp, version| 
+              unix_timestamp = DateTime.strptime(timestamp, "%Y-%m-%d %H:%M:%S").to_time.to_i
+              return {
+                package: @package,
+                status: 'installed',
+                version: version.to_i,
+                installed_at: unix_timestamp
+              }
+            end
+            return {
+                package: @package,
+                status: 'unknown'
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sensu/package/metrics/version.rb

@@ -0,0 +1,7 @@
+module Sensu
+  module Package
+    module Metrics
+      VERSION = "0.0.1"
+    end
+  end
+end

data/sensu-package-metrics.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sensu/package/metrics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sensu-package-metrics"
+  spec.version       = Sensu::Package::Metrics::VERSION
+  spec.authors       = ["Christopher Holmes"]
+  spec.email         = ["christopher.holmes@digital.cabinet-office.gov.uk"]
+  spec.summary       = %q{A sensu plugin for reporting the versions of packages}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sensu-plugin", "~> 1.2"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "cucumber", "~> 2.1"
+  spec.add_development_dependency "aruba", "~> 0.10.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: sensu-package-metrics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christopher Holmes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: A sensu plugin for reporting the versions of packages
+email:
+- christopher.holmes@digital.cabinet-office.gov.uk
+executables:
+- report-package-version
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/report-package-version
+- features/reports_package_version_in_json.feature
+- features/step_definitions/log_steps.rb
+- features/step_definitions/output_steps.rb
+- features/support/env.rb
+- lib/sensu/package/metrics.rb
+- lib/sensu/package/metrics/package_log_reader.rb
+- lib/sensu/package/metrics/version.rb
+- sensu-package-metrics.gemspec
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A sensu plugin for reporting the versions of packages
+test_files:
+- features/reports_package_version_in_json.feature
+- features/step_definitions/log_steps.rb
+- features/step_definitions/output_steps.rb
+- features/support/env.rb
+- spec/spec_helper.rb