serverspec 0.0.1 → 0.0.2

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.rspec
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -15,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+Vagrantfile

data/README.md

@@ -35,17 +35,17 @@ spec/www.example.jp/httpd_spec.rb is a sample spec file and its content is like
 ```ruby
 require 'spec_helper'
 
-describe 'httpd' do
+describe 'httpd', :os => :redhat do
   it { should be_installed }
   it { should be_enabled   }
   it { should be_running   }
 end
 
-describe 'port 80' do
+describe 'port 80', :os => :redhat do
   it { should be_listening }
 end
 
-describe '/etc/httpd/conf/httpd.conf' do
+describe '/etc/httpd/conf/httpd.conf', :os => :redhat do
   it { should be_file }
   it { should contain "ServerName www.example.jp" }
 end
@@ -61,6 +61,109 @@ Host *.example.jp
    IdentityFile ~/.ssh/id_rsa
 ```
 
+Run tests.
+
+```
+$ rake spec
+```
+----
+## Multi OS support
+
+Serverspec is supporting Red Hat (and its clone) and Debian (and its clone) now.
+
+If your target host's OS is Debian, you can write the spec like this.
+
+```ruby
+require 'spec_helper'
+
+describe 'httpd', :os => :debian do
+  it { should be_installed }
+  it { should be_enabled   }
+  it { should be_running   }
+end
+
+describe 'port 80', :os => :debian do
+  it { should be_listening }
+end
+
+describe '/etc/httpd/conf/httpd.conf', :os => :debian do
+  it { should be_file }
+  it { should contain "ServerName www.example.jp" }
+end
+```
+
+Or like this.
+
+```ruby
+require 'spec_helper'
+
+describe 'www.example.jp', :os => :debian do
+  it do
+    'httpd'.should be_installed
+  end
+
+  it do
+    'httpd'.should be_enabled
+  end
+
+  it do
+    'httpd'.should be_running
+  end
+
+  it do
+    'port 80'.should be_listening
+  end
+
+  conf = '/etc/httpd/conf/httpd.conf'
+
+  it do
+    conf.should be_file
+  end
+
+  it do
+    conf.should contain "ServerName www.example.jp"
+  end
+end
+```
+
+Or modify generated spec/spec_helper.rb like this
+
+```
+require 'serverspec'
+require 'pathname'
+
+RSpec.configure do |c|
+  c.include(Serverspec::DebianHelper)
+  c.before do
+    c.host = File.basename(Pathname.new(example.metadata[:location]).dirname)
+  end
+end
+```
+
+And write the spec like this.
+
+```ruby
+require 'spec_helper'
+
+describe 'httpd' do
+  it { should be_installed }
+  it { should be_enabled   }
+  it { should be_running   }
+end
+
+describe 'port 80' do
+  it { should be_listening }
+end
+
+describe '/etc/httpd/conf/httpd.conf' do
+  it { should be_file }
+  it { should contain "ServerName www.example.jp" }
+end
+```
+
+Choose any style you like.
+
+
 ----
 
 ## Contributing

data/Rakefile

@@ -1 +1,4 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/serverspec.rb

@@ -4,8 +4,13 @@ require 'serverspec/version'
 require 'serverspec/matchers'
 require 'serverspec/helper'
 require 'serverspec/setup'
+require 'serverspec/commands/base'
+require 'serverspec/commands/redhat'
+require 'serverspec/commands/debian'
 
 RSpec.configure do |c|
   c.include(Serverspec::Helper)
+  c.include(Serverspec::RedHatHelper, :os => :redhat)
+  c.include(Serverspec::DebianHelper, :os => :debian)
   c.add_setting :host, :default => nil
 end

data/lib/serverspec/commands/base.rb

@@ -0,0 +1,31 @@
+module Serverspec
+  module Commands
+    class Base
+      class NotImplementedError < Exception; end
+
+      def check_enabled service
+        raise NotImplementedError.new
+      end
+
+      def check_file file
+        "test -f #{file} 2> /dev/null"
+      end
+
+      def check_installed package
+        raise NotImplementedError.new
+      end
+
+      def check_listening port
+        "netstat -tnl 2> /dev/null | grep ':#{port} '"
+      end
+
+      def check_running service
+        "service #{service} status 2> /dev/null"
+      end
+
+      def check_file_contain file, expected_pattern
+        "\"grep -q '#{expected_pattern}' #{file} \" 2> /dev/null"
+      end
+    end
+  end
+end

data/lib/serverspec/commands/debian.rb

@@ -0,0 +1,13 @@
+module Serverspec
+  module Commands
+    class Debian < Base
+      def check_enabled service
+        "ls /etc/rc3.d/ 2> /dev/null | grep #{service}"
+      end
+
+      def check_installed package
+        "dpkg -s #{package} 2> /dev/null"
+      end
+    end
+  end
+end

data/lib/serverspec/commands/redhat.rb

@@ -0,0 +1,13 @@
+module Serverspec
+  module Commands
+    class RedHat < Base
+      def check_enabled service
+        "chkconfig --list #{service} 2> /dev/null | grep 3:on"
+      end
+
+      def check_installed package
+        "rpm -q #{package} 2> /dev/null"
+      end
+    end
+  end
+end

data/lib/serverspec/helper.rb

@@ -4,5 +4,16 @@ module Serverspec
       `ssh root@#{host} -o'StrictHostKeyChecking no' -o'UserKnownHostsFile /dev/null' #{cmd}`
     end
   end
-end
 
+  module RedHatHelper
+    def commands
+      Serverspec::Commands::RedHat.new
+    end
+  end
+
+  module DebianHelper
+    def commands
+      Serverspec::Commands::Debian.new
+    end
+  end
+end

data/lib/serverspec/matchers/be_enabled.rb

@@ -1,6 +1,6 @@
 RSpec::Matchers.define :be_enabled do
   match do |actual|
-    ssh_exec(RSpec.configuration.host, "chkconfig --list #{actual} 2> /dev/null | grep 3:on")
+    ssh_exec(RSpec.configuration.host, commands.check_enabled(actual))
     $? == 0
   end
 end

data/lib/serverspec/matchers/be_file.rb

@@ -1,6 +1,6 @@
 RSpec::Matchers.define :be_file do
   match do |actual|
-    ssh_exec(RSpec.configuration.host, "test -f #{actual} 2> /dev/null")
+    ssh_exec(RSpec.configuration.host, commands.check_file(actual))
     $? == 0
   end
 end

data/lib/serverspec/matchers/be_installed.rb

@@ -1,6 +1,6 @@
 RSpec::Matchers.define :be_installed do
   match do |actual|
-    ssh_exec(RSpec.configuration.host, "rpm -q #{actual} 2> /dev/null")
+    ssh_exec(RSpec.configuration.host, commands.check_installed(actual))
     $? == 0
   end
 end

data/lib/serverspec/matchers/be_listening.rb

@@ -1,7 +1,7 @@
 RSpec::Matchers.define :be_listening do
   match do |actual|
     port = actual.gsub(/port\s+/, '')
-    ssh_exec(RSpec.configuration.host, "netstat -tnl 2> /dev/null | grep ':#{port} '")
+    ssh_exec(RSpec.configuration.host, commands.check_listening(port))
     $? == 0
   end
 end

data/lib/serverspec/matchers/be_running.rb

@@ -1,6 +1,6 @@
 RSpec::Matchers.define :be_running do
   match do |actual|
-    ssh_exec(RSpec.configuration.host, "service #{actual} status 2> /dev/null")
+    ssh_exec(RSpec.configuration.host, commands.check_running(actual))
     $? == 0
   end
 end

data/lib/serverspec/matchers/contain.rb

@@ -1,6 +1,6 @@
 RSpec::Matchers.define :contain do |expected|
   match do |actual|
-    ssh_exec(RSpec.configuration.host, "\"grep -q '#{expected}' #{actual} \" 2> /dev/null")
+    ssh_exec(RSpec.configuration.host, commands.check_file_contain(actual, expected))
     $? == 0
   end
 end

data/lib/serverspec/setup.rb

@@ -4,26 +4,26 @@ module Serverspec
   class Setup
     def self.run
       %w( spec spec/www.example.jp ).each { |dir| safe_mkdir(dir) }
+      safe_create_spec
       safe_create_spec_helper
       safe_create_rakefile
-      safe_create_spec
     end
 
     def self.safe_create_spec
             content = <<-EOF
 require 'spec_helper'
 
-describe 'httpd' do
+describe 'httpd', :os => :redhat do
   it { should be_installed }
   it { should be_enabled   }
   it { should be_running   }
 end
 
-describe 'port 80' do
+describe 'port 80', :os => :redhat do
   it { should be_listening }
 end
 
-describe '/etc/httpd/conf/httpd.conf' do
+describe '/etc/httpd/conf/httpd.conf', :os => :redhat do
   it { should be_file }
   it { should contain "ServerName www.example.jp" }
 end

data/lib/serverspec/version.rb

@@ -1,3 +1,3 @@
 module Serverspec
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/debian/matchers_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'Serverspec matchers of Debian family', :os => :debian do
+  let(:test_server_host) { 'serverspec-debian-host' }
+
+  it_behaves_like 'support be_enabled matcher', 'rc.local'
+  it_behaves_like 'support be_installed matcher', 'openssh-server'
+  it_behaves_like 'support be_running matcher', 'ssh'
+  it_behaves_like 'support be_listening matcher', 22
+  it_behaves_like 'support be_file matcher', '/etc/ssh/sshd_config'
+  it_behaves_like 'support contain matcher', '/etc/ssh/sshd_config', 'See the sshd_config(5) manpage'
+end

data/spec/redhat/matchers_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'Serverspec matchers of Red Hat family', :os => :redhat do
+  let(:test_server_host) { 'serverspec-redhat-host' }
+
+  it_behaves_like 'support be_enabled matcher', 'sshd'
+  it_behaves_like 'support be_installed matcher', 'openssh'
+  it_behaves_like 'support be_running matcher', 'sshd'
+  it_behaves_like 'support be_listening matcher', 22
+  it_behaves_like 'support be_file matcher', '/etc/ssh/sshd_config'
+  it_behaves_like 'support contain matcher', '/etc/ssh/sshd_config', 'This is the sshd server system-wide configuration file'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'serverspec'
+require 'pathname'
+
+PROJECT_ROOT = (Pathname.new(File.dirname(__FILE__)) + '..').expand_path
+
+Dir[PROJECT_ROOT.join("spec/support/**/*.rb")].each { |file| require(file) }
+
+RSpec.configure do |c|
+  c.before do
+    c.host = test_server_host
+  end
+end

data/spec/support/shared_matcher_examples.rb

@@ -0,0 +1,72 @@
+
+shared_examples_for 'support be_enabled matcher' do |valid_service|
+  describe 'be_enabled' do
+    describe valid_service do
+      it { should be_enabled }
+    end
+
+    describe 'this-is-dummy-service' do
+      it { should_not be_enabled }
+    end
+  end
+end
+
+shared_examples_for 'support be_installed matcher' do |valid_package|
+  describe 'be_installed' do
+    describe valid_package do
+      it { should be_installed }
+    end
+
+    describe 'this-is-dummy-package' do
+      it { should_not be_installed }
+    end
+  end
+end
+
+shared_examples_for 'support be_running matcher' do |valid_service|
+  describe 'be_running' do
+    describe valid_service do
+      it { should be_running }
+    end
+
+    describe 'this-is-dummy-daemon' do
+      it { should_not be_running }
+    end
+  end
+end
+
+shared_examples_for 'support be_listening matcher' do |valid_port|
+  describe 'be_listening' do
+    describe "port #{ valid_port }" do
+      it { should be_listening }
+    end
+
+    describe 'port 9999' do
+      it { should_not be_listening }
+    end
+  end
+end
+
+shared_examples_for 'support be_file matcher' do |valid_file|
+  describe 'be_file' do
+    describe valid_file do
+      it { should be_file }
+    end
+
+    describe '/etc/thid_is_dummy_file' do
+      it { should_not be_file }
+    end
+  end
+end
+
+shared_examples_for 'support contain matcher' do |valid_file, pattern|
+  describe 'contain' do
+    describe valid_file do
+      it { should contain pattern }
+    end
+
+    describe '/etc/ssh/sshd_config' do
+      it { should_not contain 'This is duymmy text!!' }
+    end
+  end
+end

metadata

@@ -1,62 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: serverspec
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Gosuke Miyashita
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-03-24 00:00:00 +09:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: RSpec tests for your provisioned servers
-email: 
+email:
 - gosukenator@gmail.com
-executables: 
+executables:
 - serverspec-init
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE.txt
@@ -64,6 +58,9 @@ files:
 - Rakefile
 - bin/serverspec-init
 - lib/serverspec.rb
+- lib/serverspec/commands/base.rb
+- lib/serverspec/commands/debian.rb
+- lib/serverspec/commands/redhat.rb
 - lib/serverspec/helper.rb
 - lib/serverspec/matchers.rb
 - lib/serverspec/matchers/be_enabled.rb
@@ -75,39 +72,37 @@ files:
 - lib/serverspec/setup.rb
 - lib/serverspec/version.rb
 - serverspec.gemspec
-has_rdoc: true
+- spec/debian/matchers_spec.rb
+- spec/redhat/matchers_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_matcher_examples.rb
 homepage: https://github.com/mizzy/serverspec
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: RSpec tests for your provisioned servers
-test_files: []
-
+test_files:
+- spec/debian/matchers_spec.rb
+- spec/redhat/matchers_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_matcher_examples.rb