configspec 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d51d99b53d90945b732ab98ff1bdc76601db7346
-  data.tar.gz: c40dc4f8d3ee83ae404852176f111704b8726b0e
+  metadata.gz: d13870de5d7dfb1c6b8591b05945391a5867d2e0
+  data.tar.gz: 3244feb1ec286103cd4a6a3b4a3bb266bdfa8f27
 SHA512:
-  metadata.gz: bec1e4e9fa172bfe40641e0681f7a4d3cb66714b0486c14895abbc8ee0a1ec2e169c34bf8dc9b856fdd532322038bd6f7466a7a6c57d4dc70f24bb8b770882b5
-  data.tar.gz: 4554a6cf1271de53e05eb1bf31b210f07d35c58d8668b690149a0aec0106cddfc7fe264b7d552815b65e878a3fcc9cb32a655933e3eb46a7fe97b8ff879641e9
+  metadata.gz: 8f33aceb898dbe5383dbbe6da629a6012ee6f16b953504d97ff67c8c8a4c7fd56516fd7a7f6e9a7de5b5a6c9108c532d9aae59b033b9998b9979c517049ac314
+  data.tar.gz: 52374c4bdcab023cb3d0db699cdb8b483ad09689347788cf326a8e8c45c901b1ca0042c707c225dcdbeffb5fb3f1751a8734b513cedce2ad1353337f03a85bf9

data/README.md

@@ -1,6 +1,6 @@
 # Configspec
 
-TODO: Write a gem description
+A simple configuration management tool powered by RSpec.
 
 ## Installation
 
@@ -18,7 +18,80 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+$ configspec-init
+Select a backend type:
+
+  1) SSH
+  2) Exec (local)
+
+Select number: 1
+
+Vagrant instance y/n: y
+Auto-configure Vagrant from Vagrantfile? y/n: n
+Input vagrant instance name: www
+ + spec/
+ + spec/www/
+ + spec/www/001_httpd_spec.rb
+ + spec/spec_helper.rb
+ + Rakefile
+
+$ rake spec
+/opt/boxen/rbenv/versions/2.0.0-p247/bin/ruby -S rspec spec/www/001_httpd_spec.rb
+
+Package "httpd"
+  should be installed
+
+Finished in 3.44 seconds
+1 example, 0 failures
+```
+
+The content of ``001_httpd_spec.rb`` is like this.
+
+```ruby
+require 'spec_helper'
+
+describe package('httpd') do
+  it { should be_installed }
+end
+```
+
+This spec file runs the command ``yum -y install httpd``.
+
+Now configspec supports only RedHat based OS and package installing.
+
+## Other features
+
+Configspec supports Dockerfile backend.
+
+```
+$ configspec-init
+Select a backend type:
+
+  1) SSH
+  2) Exec (local)
+  3) Dockerfile
+
+Select number: 3
+
+ + spec/
+ + spec/001_httpd_spec.rb
+ + spec/spec_helper.rb
+ + Rakefile
+
+$ rake spec
+/opt/boxen/rbenv/versions/2.0.0-p247/bin/ruby -S rspec
+
+Package "httpd"
+  should be installed
+
+Finished in 0.00229 seconds
+1 example, 0 failures
+
+$ cat Dockerfile
+RUN yum -y install httpd
+```
+
 
 ## Contributing
 

data/configspec.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "net-ssh"
   spec.add_runtime_dependency "rspec", ">= 2.13.0"
+  spec.add_runtime_dependency "specinfra", ">= 0.0.2"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

data/lib/configspec/backend/dockerfile.rb

@@ -2,7 +2,7 @@ require 'singleton'
 
 module Configspec
   module Backend
-    class Dockerfile < Base
+    class Dockerfile < SpecInfra::Backend::Base
       def initialize
         @lines = []
         ObjectSpace.define_finalizer(self) {

data/lib/configspec/backend.rb

@@ -1,4 +1 @@
-require 'configspec/backend/base'
-require 'configspec/backend/ssh'
-require 'configspec/backend/exec'
 require 'configspec/backend/dockerfile'

data/lib/configspec/helper.rb

@@ -1,14 +1,5 @@
-require 'configspec/helper/exec'
-require 'configspec/helper/ssh'
 require 'configspec/helper/dockerfile'
-require 'configspec/helper/detect_os'
-require 'configspec/helper/redhat'
 
 require 'configspec/helper/type'
 include Configspec::Helper::Type
 
-require 'configspec/helper/properties'
-include Configspec::Helper::Properties
-
-require 'configspec/helper/configuration'
-

data/lib/configspec/setup.rb

@@ -212,11 +212,15 @@ require 'net/ssh'
 require 'winrm'
 <% end -%>
 
+<% if @backend_type == 'Dockerfile' -%>
 include Configspec::Helper::<%= @backend_type %>
+<% else -%>
+include SpecInfra::Helper::<%= @backend_type %>
+<% end -%>
 <% if @os_type == 'UN*X' && @backend_type != 'Dockerfile' -%>
-include Configspec::Helper::DetectOS
+include SpecInfra::Helper::DetectOS
 <% else  -%>
-include Configspec::Helper::RedHat
+include SpecInfra::Helper::RedHat
 <% end -%>
 
 <% if @os_type == 'UN*X' && @backend_type != 'Dockerfile' -%>

data/lib/configspec/version.rb

@@ -1,3 +1,3 @@
 module Configspec
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/configspec.rb

@@ -1,5 +1,6 @@
 require "rubygems"
 require "rspec"
+require "specinfra"
 require "configspec/version"
 require "configspec/setup"
 require "configspec/helper"
@@ -9,29 +10,4 @@ require "configspec/commands/base"
 require "configspec/commands/linux"
 require "configspec/commands/redhat"
 
-require "configspec/configuration"
-
-include Configspec
-
-module Configspec
-  class << self
-    def configuration
-      Configspec::Configuration
-    end
-  end
-end
-
-RSpec.configure do |c|
-  c.include(Configspec::Helper::Configuration)
-
-  c.add_setting :ssh,           :default => nil
-  c.add_setting :host,          :default => nil
-  c.add_setting :os,            :default => nil
-  c.add_setting :sudo_password, :default => nil
-
-  Configspec.configuration.defaults.each { |k, v| c.add_setting k, :default => v }
-
-  c.before :each do
-    backend.set_example(example)
-  end
-end
+SPEC_TYPE = 'Configspec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: configspec
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Gosuke Miyashita
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-26 00:00:00.000000000 Z
+date: 2013-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: specinfra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -83,24 +97,13 @@ files:
 - configspec.gemspec
 - lib/configspec.rb
 - lib/configspec/backend.rb
-- lib/configspec/backend/base.rb
 - lib/configspec/backend/dockerfile.rb
-- lib/configspec/backend/exec.rb
-- lib/configspec/backend/ssh.rb
 - lib/configspec/commands/base.rb
 - lib/configspec/commands/linux.rb
 - lib/configspec/commands/redhat.rb
-- lib/configspec/configuration.rb
 - lib/configspec/helper.rb
-- lib/configspec/helper/configuration.rb
-- lib/configspec/helper/detect_os.rb
 - lib/configspec/helper/dockerfile.rb
-- lib/configspec/helper/exec.rb
-- lib/configspec/helper/properties.rb
-- lib/configspec/helper/redhat.rb
-- lib/configspec/helper/ssh.rb
 - lib/configspec/helper/type.rb
-- lib/configspec/properties.rb
 - lib/configspec/setup.rb
 - lib/configspec/type/base.rb
 - lib/configspec/type/package.rb

data/lib/configspec/backend/base.rb

@@ -1,31 +0,0 @@
-require 'singleton'
-
-module Configspec
-  module Backend
-    class Base
-      include Singleton
-
-      def set_commands(c)
-        @commands = c
-      end
-
-      def set_example(e)
-        @example = e
-      end
-
-      def commands
-        @commands
-      end
-      
-      def check_zero(cmd, *args)
-        ret = run_command(commands.send(cmd, *args))
-        ret[:exit_status] == 0
-      end
-
-      # Default action is to call check_zero with args
-      def method_missing(meth, *args, &block)
-        check_zero(meth, *args)
-      end
-    end
-  end
-end

data/lib/configspec/backend/exec.rb

@@ -1,206 +0,0 @@
-require 'singleton'
-
-module Configspec
-  module Backend
-    class Exec < Base
-
-      def run_command(cmd, opts={})
-        cmd = build_command(cmd)
-        cmd = add_pre_command(cmd)
-        stdout = `#{build_command(cmd)} 2>&1`
-        # In ruby 1.9, it is possible to use Open3.capture3, but not in 1.8
-        #stdout, stderr, status = Open3.capture3(cmd)
-
-        if @example
-          @example.metadata[:command] = cmd
-          @example.metadata[:stdout]  = stdout
-        end
-
-        { :stdout => stdout, :stderr => nil,
-          :exit_status => $?.exitstatus, :exit_signal => nil }
-      end
-
-      def build_command(cmd)
-        path = Configspec.configuration.path || RSpec.configuration.path
-        if path
-          cmd = "env PATH=#{path}:$PATH #{cmd}"
-          cmd.gsub!(/(\&\&\s*!?\(?\s*)/, "\\1env PATH=#{path}:$PATH ")
-          cmd.gsub!(/(\|\|\s*!?\(?\s*)/, "\\1env PATH=#{path}:$PATH ")
-        end
-        cmd
-      end
-
-      def add_pre_command(cmd)
-        path = Configspec.configuration.path || RSpec.configuration.path
-        if Configspec.configuration.pre_command
-          cmd = "#{Configspec.configuration.pre_command} && #{cmd}"
-          cmd = "env PATH=#{path}:$PATH #{cmd}" if path
-        end
-        cmd
-      end
-
-      def check_running(process)
-        ret = run_command(commands.check_running(process))
-        
-        # In Ubuntu, some services are under upstart and "service foo status" returns
-        # exit status 0 even though they are stopped.
-        # So return false if stdout contains "stopped/waiting".
-        return false if ret[:stdout] =~ /stopped\/waiting/
-
-        # If the service is not registered, check by ps command
-        if ret[:exit_status] == 1
-          ret = run_command(commands.check_process(process))
-        end
-
-        ret[:exit_status] == 0
-      end
-
-      def check_monitored_by_monit(process)
-        ret = run_command(commands.check_monitored_by_monit(process))
-        return false unless ret[:stdout] != nil && ret[:exit_status] == 0
-
-        retlines = ret[:stdout].split(/[\r\n]+/).map(&:strip)
-        proc_index = retlines.index("Process '#{process}'")
-        return false unless proc_index
-        
-        retlines[proc_index+2].match(/\Amonitoring status\s+monitored\Z/i) != nil
-      end
-
-      def check_readable(file, by_whom)
-        mode = sprintf('%04s',run_command(commands.get_mode(file))[:stdout].strip)
-        mode = mode.split('')
-        mode_octal = mode[0].to_i * 512 + mode[1].to_i * 64 + mode[2].to_i * 8 + mode[3].to_i * 1
-        case by_whom
-        when nil
-          mode_octal & 0444 != 0
-        when 'owner'
-          mode_octal & 0400 != 0
-        when 'group'
-          mode_octal & 0040 != 0
-        when 'others'
-          mode_octal & 0004 != 0
-        end
-      end
-
-      def check_writable(file, by_whom)
-        mode = sprintf('%04s',run_command(commands.get_mode(file))[:stdout].strip)
-        mode = mode.split('')
-        mode_octal = mode[0].to_i * 512 + mode[1].to_i * 64 + mode[2].to_i * 8 + mode[3].to_i * 1
-        case by_whom
-        when nil
-          mode_octal & 0222 != 0
-        when 'owner'
-          mode_octal & 0200 != 0
-        when 'group'
-          mode_octal & 0020 != 0
-        when 'others'
-          mode_octal & 0002 != 0
-        end
-      end
-
-      def check_executable(file, by_whom)
-        mode = sprintf('%04s',run_command(commands.get_mode(file))[:stdout].strip)
-        mode = mode.split('')
-        mode_octal = mode[0].to_i * 512 + mode[1].to_i * 64 + mode[2].to_i * 8 + mode[3].to_i * 1
-        case by_whom
-        when nil
-          mode_octal & 0111 != 0
-        when 'owner'
-          mode_octal & 0100 != 0
-        when 'group'
-          mode_octal & 0010 != 0
-        when 'others'
-          mode_octal & 0001 != 0
-        end
-      end
-
-      def check_mounted(path, expected_attr, only_with)
-        ret = run_command(commands.check_mounted(path))
-        if expected_attr.nil? || ret[:exit_status] != 0
-          return ret[:exit_status] == 0
-        end
-
-        mount = ret[:stdout].scan(/\S+/)
-        actual_attr    = { :device => mount[0], :type => mount[4] }
-        mount[5].gsub(/\(|\)/, '').split(',').each do |option|
-          name, val = option.split('=')
-          if val.nil?
-            actual_attr[name.to_sym] = true
-          else
-            val = val.to_i if val.match(/^\d+$/)
-            actual_attr[name.to_sym] = val
-          end
-        end
-
-        if ! expected_attr[:options].nil?
-          expected_attr.merge!(expected_attr[:options])
-          expected_attr.delete(:options)
-        end
-
-        if only_with
-          actual_attr == expected_attr
-        else
-          expected_attr.each do |key, val|
-            return false if actual_attr[key] != val
-          end
-          true
-        end
-      end
-
-      def check_routing_table(expected_attr)
-        return false if ! expected_attr[:destination]
-        ret = run_command(commands.check_routing_table(expected_attr[:destination]))
-        return false if ret[:exit_status] != 0
-
-        ret[:stdout] =~ /^(\S+)(?: via (\S+))? dev (\S+).+\r\n(?:default via (\S+))?/
-        actual_attr = {
-          :destination => $1,
-          :gateway     => $2 ? $2 : $4,
-          :interface   => expected_attr[:interface] ? $3 : nil
-        }
-
-        expected_attr.each do |key, val|
-          return false if actual_attr[key] != val
-        end
-        true
-      end
-
-      def check_os
-        return RSpec.configuration.os if RSpec.configuration.os
-        if run_command('ls /etc/redhat-release')[:exit_status] == 0
-          line = run_command('cat /etc/redhat-release')[:stdout]
-          if line =~ /release (\d[\d.]*)/
-            release = $1
-          end
-          { :family => 'RedHat', :release => release }
-        elsif run_command('ls /etc/system-release')[:exit_status] == 0
-          { :family => 'RedHat', :release => nil } # Amazon Linux
-        elsif run_command('ls /etc/debian_version')[:exit_status] == 0
-          { :family => 'Debian', :release => nil }
-        elsif run_command('ls /etc/gentoo-release')[:exit_status] == 0
-          { :family => 'Gentoo', :release => nil }
-        elsif run_command('ls /usr/lib/setup/Plamo-*')[:exit_status] == 0
-          { :family => 'Plamo', :release => nil }
-        elsif run_command('uname -s')[:stdout] =~ /AIX/i
-          { :family => 'AIX', :release => nil }
-        elsif (os = run_command('uname -sr')[:stdout]) && os =~ /SunOS/i
-          if os =~ /5.10/
-            { :family => 'Solaris10', :release => nil }
-          elsif run_command('grep -q "Oracle Solaris 11" /etc/release')[:exit_status] == 0
-            { :family => 'Solaris11', :release => nil }
-          elsif run_command('grep -q SmartOS /etc/release')[:exit_status] == 0
-            { :family => 'SmartOS', :release => nil }
-          else
-            { :family => 'Solaris', :release => nil }
-          end
-        elsif run_command('uname -s')[:stdout] =~ /Darwin/i
-          { :family => 'Darwin', :release => nil }
-        elsif run_command('uname -s')[:stdout] =~ /FreeBSD/i
-          { :family => 'FreeBSD', :release => nil }
-        else
-          { :family => 'Base', :release => nil }
-        end
-      end
-    end
-  end
-end

data/lib/configspec/backend/ssh.rb

@@ -1,93 +0,0 @@
-require 'configspec/backend/exec'
-
-module Configspec
-  module Backend
-    class Ssh < Exec
-      def run_command(cmd, opt={})
-        cmd = build_command(cmd)
-        cmd = add_pre_command(cmd)
-        ret = ssh_exec!(cmd)
-
-        ret[:stdout].gsub!(/\r\n/, "\n")
-
-        if @example
-          @example.metadata[:command] = cmd
-          @example.metadata[:stdout]  = ret[:stdout]
-        end
-
-        ret
-      end
-
-      def build_command(cmd)
-        cmd = super(cmd)
-        if RSpec.configuration.ssh.options[:user] != 'root'
-          cmd = "#{sudo} #{cmd}"
-          cmd.gsub!(/(\&\&\s*!?\(?\s*)/, "\\1#{sudo} ")
-          cmd.gsub!(/(\|\|\s*!?\(?\s*)/, "\\1#{sudo} ")
-        end
-        cmd
-      end
-
-      def add_pre_command(cmd)
-        cmd = super(cmd)
-        user = RSpec.configuration.ssh.options[:user]
-        pre_command = Configspec.configuration.pre_command
-        if pre_command && user != 'root'
-          cmd = "#{sudo} #{cmd}"
-        end
-        cmd
-      end
-
-      private
-      def ssh_exec!(command)
-        stdout_data = ''
-        stderr_data = ''
-        exit_status = nil
-        exit_signal = nil
-        pass_prompt = RSpec.configuration.pass_prompt || /^\[sudo\] password for/
-
-        ssh = RSpec.configuration.ssh
-        ssh.open_channel do |channel|
-          channel.request_pty do |ch, success|
-            abort "Could not obtain pty " if !success
-          end
-          channel.exec("#{command}") do |ch, success|
-            abort "FAILED: couldn't execute command (ssh.channel.exec)" if !success
-            channel.on_data do |ch, data|
-              if data.match pass_prompt
-                abort "Please set sudo password by using SUDO_PASSWORD or ASK_SUDO_PASSWORD environment variable" if RSpec.configuration.sudo_password.nil?
-                channel.send_data "#{RSpec.configuration.sudo_password}\n"
-              else
-                stdout_data += data
-              end
-            end
-
-            channel.on_extended_data do |ch, type, data|
-              stderr_data += data
-            end
-
-            channel.on_request("exit-status") do |ch, data|
-              exit_status = data.read_long
-            end
-
-            channel.on_request("exit-signal") do |ch, data|
-              exit_signal = data.read_long
-            end
-          end
-        end
-        ssh.loop
-        { :stdout => stdout_data, :stderr => stderr_data, :exit_status => exit_status, :exit_signal => exit_signal }
-      end
-
-      def sudo
-        sudo_path = Configspec.configuration.sudo_path || RSpec.configuration.sudo_path
-        if sudo_path
-          "#{sudo_path}/sudo"
-        else
-          'sudo'
-        end
-      end
-
-    end
-  end
-end

data/lib/configspec/configuration.rb

@@ -1,12 +0,0 @@
-module Configspec
-  module Configuration
-    class << self
-      VALID_OPTIONS_KEYS = [:path, :pre_command, :stdout, :stderr, :sudo_path, :pass_prompt].freeze
-      attr_accessor(*VALID_OPTIONS_KEYS)
-    
-      def defaults
-        VALID_OPTIONS_KEYS.inject({}) { |o, k| o.merge!(k => send(k)) }
-      end
-    end
-  end
-end

data/lib/configspec/helper/configuration.rb

@@ -1,37 +0,0 @@
-module Configspec
-  module Helper
-    module Configuration
-      def subject
-        example.metadata[:subject] = described_class
-        build_configurations
-        super
-      end
-
-      # You can create a set of configurations provided to all specs in your spec_helper:
-      #
-      #   RSpec.configure { |c| c.pre_command = "source ~/.zshrc" }
-      #
-      # Any configurations you provide with `let(:option_name)` in a spec will
-      # automatically be merged on top of the configurations.
-      #
-      # @example
-      #
-      #   describe 'Gem' do
-      #     let(:pre_command) { "source ~/.zshrc" }
-      #
-      #     %w(pry awesome_print bundler).each do |p|
-      #       describe package(p) do
-      #         it { should be_installed.by('gem') }
-      #       end
-      #     end
-      #   end
-      def build_configurations
-        Configspec::Configuration.defaults.keys.each do |c|
-          value = self.respond_to?(c.to_sym) ?
-          self.send(c) : RSpec.configuration.send(c)
-          Configspec::Configuration.send(:"#{c}=", value)
-        end
-      end
-    end
-  end
-end

data/lib/configspec/helper/detect_os.rb

@@ -1,19 +0,0 @@
-module Configspec
-  module Helper
-    module DetectOS
-      def commands
-        property[:os_by_host] = {} if ! property[:os_by_host]
-        host = RSpec.configuration.ssh ? RSpec.configuration.ssh.host : 'localhost'
-
-        if property[:os_by_host][host]
-          os = property[:os_by_host][host]
-        else
-          os = backend(Configspec::Commands::Base).check_os
-          property[:os_by_host][host] = os
-        end
-
-        self.class.const_get('Configspec').const_get('Commands').const_get(os[:family]).new
-      end
-    end
-  end
-end

data/lib/configspec/helper/exec.rb

@@ -1,14 +0,0 @@
-module Configspec
-  module Helper
-    module Exec
-      def backend(commands_object=nil)
-        if commands_object.nil? && ! respond_to?(:commands)
-          commands_object = Configspec::Commands::Base.new
-        end
-        instance = Configspec::Backend::Exec.instance
-        instance.set_commands(commands_object || commands)
-        instance
-      end
-    end
-  end
-end

data/lib/configspec/helper/properties.rb

@@ -1,14 +0,0 @@
-require 'configspec/properties'
-
-module Configspec
-  module Helper
-    module Properties
-      def property
-        Configspec::Properties.instance.properties
-      end
-      def set_property(prop)
-        Configspec::Properties.instance.properties(prop)
-      end
-    end
-  end
-end

data/lib/configspec/helper/redhat.rb

@@ -1,9 +0,0 @@
-module Configspec
-  module Helper
-    module RedHat
-      def commands
-        Configspec::Commands::RedHat.new
-      end
-    end
-  end
-end

data/lib/configspec/helper/ssh.rb

@@ -1,15 +0,0 @@
-module Configspec
-  module Helper
-    module Ssh
-      def backend(commands_object=nil)
-        if ! respond_to?(:commands)
-          commands_object = Configspec::Commands::Base.new
-        end
-        instance = Configspec::Backend::Ssh.instance
-        instance.set_commands(commands_object || commands)
-        instance
-      end
-    end
-  end
-end
-

data/lib/configspec/properties.rb

@@ -1,17 +0,0 @@
-require 'singleton'
-
-module Configspec
-  class Properties
-    include Singleton
-    def initialize
-      @prop = {}
-    end
-    def properties(prop=nil)
-      if ! prop.nil?
-        @prop = prop
-      end
-      @prop
-    end
-  end
-end
-