-
Notifications
You must be signed in to change notification settings - Fork 369
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 5ffa987
Showing
18 changed files
with
313 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
*.gem | ||
*.rbc | ||
.bundle | ||
.config | ||
.yardoc | ||
Gemfile.lock | ||
InstalledFiles | ||
_yardoc | ||
coverage | ||
doc/ | ||
lib/bundler/man | ||
pkg | ||
rdoc | ||
spec/reports | ||
test/tmp | ||
test/version_tmp | ||
tmp |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
source 'https://rubygems.org' | ||
|
||
# Specify your gem's dependencies in serverspec.gemspec | ||
gemspec |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
Copyright (c) 2013 Gosuke Miyashita | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# Serverspec | ||
|
||
RSpec tests for your provisioned servers | ||
|
||
---- | ||
|
||
## Installation | ||
|
||
Add this line to your application's Gemfile: | ||
|
||
gem 'serverspec' | ||
|
||
And then execute: | ||
|
||
$ bundle | ||
|
||
Or install it yourself as: | ||
|
||
$ gem install serverspec | ||
|
||
---- | ||
|
||
## Usage | ||
|
||
``` | ||
$ serverspec-init | ||
+ spec/ | ||
+ spec/www.example.jp/ | ||
+ spec/spec_helper.rb | ||
+ Rakefile | ||
+ spec/www.example.jp/httpd_spec.rb | ||
``` | ||
spec/www.example.jp/httpd_spec.rb is a sample spec file and its content is 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 | ||
``` | ||
|
||
You can write spec for testing provisioned servers like this. | ||
|
||
You should create ~/.ssh/config like this before running tests. | ||
|
||
``` | ||
Host *.example.jp | ||
User root | ||
IdentityFile ~/.ssh/id_rsa | ||
``` | ||
|
||
---- | ||
|
||
## Contributing | ||
|
||
1. Fork it | ||
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 new Pull Request |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
require "bundler/gem_tasks" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
#!/usr/bin/env ruby | ||
|
||
$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib]) | ||
|
||
require 'serverspec' | ||
|
||
Serverspec::Setup.run |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
require 'rubygems' | ||
require 'rspec' | ||
require 'serverspec/version' | ||
require 'serverspec/matchers' | ||
require 'serverspec/helper' | ||
require 'serverspec/setup' | ||
|
||
RSpec.configure do |c| | ||
c.include(Serverspec::Helper) | ||
c.add_setting :host, :default => nil | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
module Serverspec | ||
module Helper | ||
def ssh_exec(host, cmd, opt={}) | ||
`ssh root@#{host} -o'StrictHostKeyChecking no' -o'UserKnownHostsFile /dev/null' #{cmd}` | ||
end | ||
end | ||
end | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
require 'serverspec/matchers/be_enabled' | ||
require 'serverspec/matchers/be_file' | ||
require 'serverspec/matchers/be_installed' | ||
require 'serverspec/matchers/be_listening' | ||
require 'serverspec/matchers/be_running' | ||
require 'serverspec/matchers/contain' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +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") | ||
$? == 0 | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
RSpec::Matchers.define :be_file do | ||
match do |actual| | ||
ssh_exec(RSpec.configuration.host, "test -f #{actual} 2> /dev/null") | ||
$? == 0 | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
RSpec::Matchers.define :be_installed do | ||
match do |actual| | ||
ssh_exec(RSpec.configuration.host, "rpm -q #{actual} 2> /dev/null") | ||
$? == 0 | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +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} '") | ||
$? == 0 | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
RSpec::Matchers.define :be_running do | ||
match do |actual| | ||
ssh_exec(RSpec.configuration.host, "service #{actual} status 2> /dev/null") | ||
$? == 0 | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
RSpec::Matchers.define :contain do |expected| | ||
match do |actual| | ||
ssh_exec(RSpec.configuration.host, "\"grep -q '#{expected}' #{actual} \" 2> /dev/null") | ||
$? == 0 | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
require 'fileutils' | ||
|
||
module Serverspec | ||
class Setup | ||
def self.run | ||
%w( spec spec/www.example.jp ).each { |dir| safe_mkdir(dir) } | ||
safe_create_spec_helper | ||
safe_create_rakefile | ||
safe_create_spec | ||
end | ||
|
||
def self.safe_create_spec | ||
content = <<-EOF | ||
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 | ||
EOF | ||
|
||
if File.exists? 'spec/www.example.jp/httpd_spec.rb' | ||
old_content = File.read('spec/www.example.jp/httpd_spec.rb') | ||
if old_content != content | ||
$stderr.puts "!! spec/www.example.jp/httpd_spec.rb already exists and differs from template" | ||
end | ||
else | ||
File.open('spec/www.example.jp/httpd_spec.rb', 'w') do |f| | ||
f.puts content | ||
end | ||
puts ' + spec/www.example.jp/httpd_spec.rb' | ||
end | ||
end | ||
|
||
def self.safe_mkdir(dir) | ||
if File.exists? dir | ||
unless File.directory? dir | ||
$stderr.puts "!! #{dir} already exists and is not a directory" | ||
end | ||
else | ||
FileUtils.mkdir dir | ||
puts " + #{dir}/" | ||
end | ||
end | ||
|
||
def self.safe_create_spec_helper | ||
content = <<-EOF | ||
require 'serverspec' | ||
require 'pathname' | ||
RSpec.configure do |c| | ||
c.before do | ||
c.host = File.basename(Pathname.new(example.metadata[:location]).dirname) | ||
end | ||
end | ||
EOF | ||
if File.exists? 'spec/spec_helper.rb' | ||
old_content = File.read('spec/spec_helper.rb') | ||
if old_content != content | ||
$stderr.puts "!! spec/spec_helper.rb already exists and differs from template" | ||
end | ||
else | ||
File.open('spec/spec_helper.rb', 'w') do |f| | ||
f.puts content | ||
end | ||
puts ' + spec/spec_helper.rb' | ||
end | ||
end | ||
|
||
def self.safe_create_rakefile | ||
content = <<-'EOF' | ||
require 'rake' | ||
require 'rspec/core/rake_task' | ||
RSpec::Core::RakeTask.new(:spec) do |t| | ||
t.pattern = 'spec/*/*_spec.rb' | ||
end | ||
EOF | ||
if File.exists? 'Rakefile' | ||
old_content = File.read('Rakefile') | ||
if old_content != content | ||
$stderr.puts "!! Rakefile already exists and differs from template" | ||
end | ||
else | ||
File.open('Rakefile', 'w') do |f| | ||
f.puts content | ||
end | ||
puts ' + Rakefile' | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
module Serverspec | ||
VERSION = "0.0.1" | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# coding: utf-8 | ||
lib = File.expand_path('../lib', __FILE__) | ||
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) | ||
require 'serverspec/version' | ||
|
||
Gem::Specification.new do |spec| | ||
spec.name = "serverspec" | ||
spec.version = Serverspec::VERSION | ||
spec.authors = ["Gosuke Miyashita"] | ||
spec.email = ["[email protected]"] | ||
spec.description = %q{RSpec tests for your provisioned servers} | ||
spec.summary = %q{RSpec tests for your provisioned servers} | ||
spec.homepage = "https://github.com/mizzy/serverspec" | ||
spec.license = "MIT" | ||
|
||
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_development_dependency "bundler", "~> 1.3" | ||
spec.add_development_dependency "rake" | ||
end |