mspectator 0.1.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,66 @@
+mspectator
+==========
+
+Use RSpec and MCollective to test your fleet
+
+# Goal
+
+This project provides a way to test your fleet of servers using RSpec and MCollective.
+
+It is similar to the [serverspec](http://serverspec.org) project, but it uses MCollective instead of SSH as a network facility, and it allows to test more than a host at a time.
+
+## Example
+
+The matchers allow to test hosts based on filters, using classes and facts. Below is an example:
+
+    require 'mspectator'
+    
+    describe "apache::server" do
+      it { should find_nodes(10).or_less.with_agent('spec') }
+      it { should have_certificate.signed }
+      it { should pass_puppet_spec }
+
+      context "when on Debian", :facts => [:operatingsystem => "Debian"] do
+        it { should find_nodes(5).or_more }
+        it { should have_service('apache2').with(
+          :ensure => 'running',
+          :enable => 'true'
+          )
+        }
+        it { should have_package('apache2') }
+        it { should have_user('www-data') }
+      end
+    end
+
+# Architecture
+
+## Network architecture and libraries
+
+The general architecture of the solution is the following:
+
+     +-------------------------------------+           +-------------------------------------+
+     |      Client                         |           |        Server                       |
+     |-------------------------------------|           |-------------------------------------|
+     |                                     |           |                                     |
+     |     rspec                           |           |                                     |
+     |       +                             |           |                                     |
+     |       | (check_action, *args)       |           |                                     |
+     |       v                             |           |                                     |
+     |  MCollective::RPC#rpcclient         |           |      Serverspec::Backend::Puppet    |
+     |       |                             |           |           ^                         |
+     |       +                             |           |           | (check_action, *args)   |
+     |       |                             |           |           +                         |
+     |       +------------------------------------------->  MCollective::RPC::Agent          |
+     |                action, *args        |           |                                     |
+     |                                     |           |                                     |
+     +-------------------------------------+           +-------------------------------------+
+
+
+The components required for this architecture are:
+
+* [RSpec](http://rspec.info), on the client side;
+* The [serverspec](http://serverspec.org) backends and matchers, on the server side;
+* The [spec MCollective agent](https://github.com/camptocamp/puppet-spec/tree/master/files/mcollective/agent) on the server side;
+* A series of matchers on the client side to describe the hosts being tested.
+
+

data/examples/apache_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe 'apache' do
+  it { should find_nodes(100).or_less }
+  it { should pass_puppet_spec }
+  it { should have_certificate.signed }
+
+  context 'when on Debian',
+    :facts => { :operatingsystem => 'Debian' } do
+
+    it { should find_nodes(5).with_agent('spec') }
+    it { should have_package('apache2.2-common') }
+    it { should_not have_package('httpd') }
+    it { should have_service('apache2').with(
+      :ensure => 'running'
+    ) }
+    it { should have_file('/etc/apache2/apache2.conf') }
+    it { should have_directory('/etc/apache2/conf.d') }
+    it { should have_user('www-data') }
+  end
+
+  context 'when using SSL', :classes => ['apache::ssl'] do
+    it { should find_nodes(50).or_more }
+    it { should have_package('ca-certificates') }
+  end
+end

data/lib/mspectator.rb

@@ -0,0 +1,6 @@
+require 'mspectator/matchers'
+require 'mspectator/example'
+
+RSpec.configure do |c|
+  c.include(MSpectator::ExampleGroup)
+end

data/lib/mspectator/example.rb

@@ -0,0 +1,79 @@
+require 'mcollective'
+
+module MSpectator
+  module ExampleGroup
+    include MCollective::RPC
+
+    def subject
+      @subject ||= self.class.top_level_description
+    end
+
+    def self.included(group)
+      group.before(:all) do
+        @mc_clients ||= {}
+      end
+    end
+
+    def mc_clients
+      @mc_clients ||= {}
+    end
+
+    def mc_client(agent)
+      unless mc_clients.has_key? agent
+        # Can't pass :progress_bar to rpcclient()?
+        new = rpcclient(agent)
+        new.progress = false
+        mc_clients[agent] = new
+      end
+      mc_clients[agent]
+    end
+
+    def filtered_mc(agent, example)
+      mc = mc_client(agent)
+      # There is no need to reset only before :group currently
+      # so we need to reset before applying filters
+      mc.reset
+      apply_filters(mc, example)
+    end
+
+    def apply_filters (mc, example)
+      classes = example.metadata[:classes] || []
+      facts = example.metadata[:facts] || {}
+      mc.compound_filter example.example_group.top_level_description
+      unless classes.empty? and facts.empty?
+        classes.each do |c|
+          mc.class_filter c
+        end
+        facts.each do |f, v|
+          mc.fact_filter f, v
+        end
+      end
+      mc
+    end
+    
+    def check_spec (example, action, values)
+      spec_mc = filtered_mc('spec', example)
+      passed = []
+      failed = []
+      spec_mc.check(:action => action, :values => values).each do |resp|
+        if resp[:data][:passed]
+          passed << resp[:sender]
+        else
+          failed << resp[:sender]
+        end
+      end
+      return passed, failed
+    end
+    
+    def get_fqdn (example)
+      util_mc = self.mc_client('rpcutil')
+      util_mc.progress = false
+      util_mc = apply_filters util_mc, example
+      fqdn = []
+      util_mc.get_fact(:fact => 'fqdn').each do |resp|
+        fqdn << resp[:data][:value]
+      end
+      fqdn
+    end
+  end
+end

data/lib/mspectator/matchers.rb

@@ -0,0 +1,8 @@
+require 'mspectator/matchers/find_nodes'
+require 'mspectator/matchers/have_certificate'
+require 'mspectator/matchers/have_directory'
+require 'mspectator/matchers/have_file'
+require 'mspectator/matchers/have_package'
+require 'mspectator/matchers/have_service'
+require 'mspectator/matchers/have_user'
+require 'mspectator/matchers/pass_puppet_spec'

data/lib/mspectator/matchers/find_nodes.rb

@@ -0,0 +1,36 @@
+RSpec::Matchers.define :find_nodes do |number|
+  match do
+    @agent ||= 'rpcutil'
+    mc = filtered_mc(@agent, example)
+    @size = mc.discover.size
+    if @compare == :or_less
+      @size <= number
+    elsif @compare == :or_more
+      @size >= number
+    else
+      @size == number
+    end
+  end
+
+  chain :or_less do
+    @compare = :or_less
+    @compare_msg = ' or less'
+  end
+
+  chain :or_more do
+    @compare = :or_more
+    @compare_msg = ' or more'
+  end
+
+  chain :with_agent do |agent|
+    @agent = agent
+  end
+
+  failure_message_for_should do |actual|
+    "expected to find #{expected} nodes#{@compare_msg} using agent '#{@agent}', but found #{@size} instead."
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected not to find #{expected} nodes#{@compare_msg} using agent '#{@agent}', but found #{@size} instead."
+  end
+end

data/lib/mspectator/matchers/have_certificate.rb

@@ -0,0 +1,41 @@
+RSpec::Matchers.define :have_certificate do
+  match do
+    discovered = get_fqdn(example)
+    puppetca_mc = mc_client('puppetca')
+    # TODO: use hash for requests and signed
+    # so we can tell where a certificate was found
+    requests = []
+    signed = []
+    puppetca_mc.list.each do |resp|
+      requests << resp[:data][:requests]
+      signed << resp[:data][:signed]
+    end
+    requests.flatten!
+    signed.flatten!
+    @passed = []
+    @failed = []
+    discovered.each do |c|
+      if !@signed and requests.include? c
+        @passed << c
+      elsif signed.include? c
+        @passed << c
+      else
+        @failed << c
+      end
+    end
+    @failed.empty?
+  end
+
+  failure_message_for_should do |actual|
+    "expected that all hosts would have a valid #{@signed_msg}certificate, but found hosts without one: #{@failed.join(', ')}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that no hosts would have a valid #{@signed_msg}certificate, but found hosts with one: #{@passed.join(', ')}"
+  end
+
+  chain :signed do
+    @signed = true
+    @signed_msg = 'signed '
+  end
+end

data/lib/mspectator/matchers/have_directory.rb

@@ -0,0 +1,14 @@
+RSpec::Matchers.define :have_directory do |directory|
+  match do
+    @passed, @failed = check_spec(example, 'directory', directory)
+    @failed.empty?
+  end
+
+  failure_message_for_should do |actual|
+    "expected that all hosts would have the #{expected} directory, but found hosts without it: #{@failed.join(', ')}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that no hosts would have the #{expected} directory, but found hosts with it: #{@passed.join(', ')}"
+  end
+end

data/lib/mspectator/matchers/have_file.rb

@@ -0,0 +1,14 @@
+RSpec::Matchers.define :have_file do |file|
+  match do
+    @passed, @failed = check_spec(example, 'file', file)
+    @failed.empty?
+  end
+
+  failure_message_for_should do |actual|
+    "expected that all hosts would have the #{expected} file, but found hosts without it: #{@failed.join(', ')}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that no hosts would have the #{expected} file, but found hosts with it: #{@passed.join(', ')}"
+  end
+end

data/lib/mspectator/matchers/have_package.rb

@@ -0,0 +1,14 @@
+RSpec::Matchers.define :have_package do |package|
+  match do
+    @passed, @failed = check_spec(example, 'installed', package)
+    @failed.empty?
+  end
+
+  failure_message_for_should do |actual|
+    "expected that all hosts would have the #{expected} package, but found hosts without it: #{@failed.join(', ')}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that no hosts would have the #{expected} package, but found hosts with it: #{@passed.join(', ')}"
+  end
+end

data/lib/mspectator/matchers/have_service.rb

@@ -0,0 +1,30 @@
+RSpec::Matchers.define :have_service do |service|
+  match do
+    @filters ||= {}
+    # Eventually, stop using serverspec
+    # and use a dedicated Puppet library on the server side
+    # which will allow to pass @filters simply
+    if @filters.fetch(:enable, false) == true
+      @action = 'enabled'
+    elsif @filters.fetch(:ensure, false) == 'running'
+      @action = 'running'
+    else
+      @action = 'running'
+    end
+    @passed, @failed = check_spec(example, @action, service)
+    @failed.empty?
+  end
+
+  failure_message_for_should do |actual|
+    "expected that all hosts would have the #{expected} service #{@action}, but found hosts without it: #{@failed.join(', ')}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that no hosts would have the #{expected} service #{@action}, but found hosts with it: #{@passed.join(', ')}"
+  end
+
+  chain :with do |filters|
+    @filters = filters
+  end
+end
+

data/lib/mspectator/matchers/have_user.rb

@@ -0,0 +1,15 @@
+RSpec::Matchers.define :have_user do |user|
+  match do
+    @passed, @failed = check_spec(example, 'user', user)
+    @failed.empty?
+  end
+
+  failure_message_for_should do |actual|
+    "expected that all hosts would have the #{expected} user, but found hosts without it: #{@failed.join(', ')}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that no hosts would have the #{expected} user, but found hosts with it: #{@passed.join(', ')}"
+  end
+end
+

data/lib/mspectator/matchers/pass_puppet_spec.rb

@@ -0,0 +1,27 @@
+RSpec::Matchers.define :pass_puppet_spec do
+  match do
+    spec_mc = filtered_mc('spec', example)
+    @passed = []
+    @failed = {}
+    spec_mc.run.each do |resp|
+      if resp[:data][:passed]
+        @passed << resp[:sender]
+      else
+        @failed[resp[:sender]] = resp[:data][:output]
+      end
+    end
+    @failed.empty?
+  end
+
+  failure_message_for_should do |actual|
+    text = "expected that all hosts would pass tests, the following didn't:\n"
+    @failed.each do |h, o|
+      text += "#{h}:\n #{o}"
+    end
+    text
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that no hosts would pass tests, the following did: #{@passed.join(', ')}"
+  end
+end

data/lib/mspectator/version.rb

@@ -0,0 +1,3 @@
+module MSpectator
+  VERSION = "0.1.0"
+end

data/mspectator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mspectator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mspectator"
+  spec.version       = MSpectator::VERSION
+  spec.authors       = ["Raphaël Pinson"]
+  spec.email         = ["raphink@gmail.com"]
+  spec.description   = %q{Use RSpec and MCollective to test your fleet}
+  spec.summary       = %q{Use RSpec and MCollective to test your fleet}
+  spec.homepage      = "https://github.com/raphink/mspectator"
+  spec.license       = "GPLv3"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "mcollective"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: mspectator
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Rapha\xC3\xABl Pinson"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-04-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mcollective
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Use RSpec and MCollective to test your fleet
+email: 
+- raphink@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- README.md
+- examples/apache_spec.rb
+- lib/mspectator.rb
+- lib/mspectator/example.rb
+- lib/mspectator/matchers.rb
+- lib/mspectator/matchers/find_nodes.rb
+- lib/mspectator/matchers/have_certificate.rb
+- lib/mspectator/matchers/have_directory.rb
+- lib/mspectator/matchers/have_file.rb
+- lib/mspectator/matchers/have_package.rb
+- lib/mspectator/matchers/have_service.rb
+- lib/mspectator/matchers/have_user.rb
+- lib/mspectator/matchers/pass_puppet_spec.rb
+- lib/mspectator/version.rb
+- mspectator.gemspec
+homepage: https://github.com/raphink/mspectator
+licenses: 
+- GPLv3
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Use RSpec and MCollective to test your fleet
+test_files: []
+