foodtaster 0.0.8 → 0.0.9

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -12,14 +12,28 @@ initial 'clean' state which removes any modifications made by
 previously executed specs. It allows you to independently test different
 cookbooks on a single VM.
 
-Of course, you aren't limited by just one VM for your specs, you may
+You aren't limited by just one VM for your specs, you may
 run as many as you need. PostgreSQL replication, load balancing and
 even entire application environments becomes testable (of course, if
-you have enought amount of RAM).
+you have enought amount of RAM for all your VMs).
+
+Check out
+[foodtaster-example repository](http://github.com/mlapshin/foodtaster-example)
+to see Foodtaster in action.
 
 Foodtaster is on early development stage, so feedback is very
 appreciated.
 
+## Documentation
+
+To get more information about FT, read
+[Wiki](https://github.com/mlapshin/foodtaster/wiki) or refer to
+[RDoc](http://rdoc.info/github/mlapshin/foodtaster/master/frames).
+
+If you have any questions or got in trouble, feel free to ask
+community in
+[Foodtaster Google Group](http://groups.google.com/d/forum/foodtaster).
+
 ## Quick Example
 
 ```ruby
@@ -34,11 +48,12 @@ describe "nginx::default" do
   it "should install nginx as a daemon" do
     vm0.should have_package 'nginx'
     vm0.should have_user('www-data').in_group('www-data')
+    vm0.should have_running_process('nginx')
     vm0.should listen_port(80)
-    vm0.should open_page("http://localhost/")
 
-    vm0.should have_file("/etc/init.d/nginx")
-    vm0.should have_file("/etc/nginx/nginx.conf").with_content(/gzip on/).with_mode(0644)
+    vm0.should have_file("/etc/nginx/nginx.conf")
+      .with_content(/gzip on/)
+      .with_mode(0644)
   end
 
   it "should have valid nginx config" do
@@ -52,49 +67,33 @@ end
 
 ## Installation
 
-First, install Vagrant for your system following [official
-instructions](http://docs.vagrantup.com/v2/installation/index.html).
-Then, install two Vagrant plugins:
-[sahara](http://github.com/jedi4ever/sahara) and
-[vagrant-foodtaster-server](http://github.com/mlapshin/vagrant-foodtaster-server):
+First, install [VirtualBox](http://www.virtualbox.org/) and
+[Vagrant](http://docs.vagrantup.com/v2/installation/index.html). Then
+install
+[vagrant-foodtaster-server](http://github.com/mlapshin/vagrant-foodtaster-server)
+plugin:
 
-    vagrant plugin install sahara
     vagrant plugin install vagrant-foodtaster-server
 
-That's all, you are ready to go.
-
 ## Usage
 
-Check out [foodtaster-example
-repository](http://github.com/mlapshin/foodtaster-example) or
-follow this instructions.
-
-In your Chef repository, create a basic Gemfile:
+In your Chef or Cookbook repository, create a basic Gemfile:
 
     source 'https://rubygems.org/'
 
-    gem 'rspec'
     gem 'foodtaster'
 
-Then, create a Vagrantfile describing VMs you need for specs. Here is
-[example
-Vagrantfile](http://raw.github.com/mlapshin/foodtaster-example/master/Vagrantfile).
+Create a Vagrantfile describing VMs you need for specs. [Read
+Wiki](https://github.com/mlapshin/foodtaster/wiki/Vagrantfile-Requirements)
+for detailed explanation and examples.
 
-Create `spec` folder with `spec_helper.rb` file:
+Create `spec` folder with basic `spec_helper.rb` file:
 
 ```ruby
 require 'foodtaster'
-
-RSpec.configure do |config|
-  config.color_enabled = true
-end
-
-Foodtaster.configure do |config|
-  config.log_level = :info
-end
 ```
 
-You are ready to write cookbook specs. Run them as usual with command:
+You are now ready to write cookbook specs. Run them as usual with command:
 
     bundle exec rspec spec
 

data/lib/foodtaster.rb

@@ -20,5 +20,14 @@ module Foodtaster
         end
       end
     end
+
+    def config
+      @config ||= Config.default
+    end
+
+    def configure(&config_block)
+      Foodtaster::RSpec.configure
+      config.configure(&config_block) if config_block
+    end
   end
 end

data/lib/foodtaster/client.rb

@@ -66,7 +66,12 @@ module Foodtaster
        server_version = @v.version
 
        if server_version != Foodtaster::VERSION
-         Foodtaster.logger.warn "Warning: Foodtaster DRb Server version doesn't match Foodtaster Gem version.\n\nDRb Server version: #{server_version}\nFoodtaster Gem version: #{Foodtaster::VERSION}\n"
+         Foodtaster.logger.warn <<-TEXT
+Warning: Foodtaster DRb Server version doesn't match Foodtaster Gem version.
+
+DRb Server version: #{server_version}
+Foodtaster Gem version: #{Foodtaster::VERSION}
+         TEXT
        end
      end
   end

data/lib/foodtaster/config.rb

@@ -1,35 +1,26 @@
 module Foodtaster
   class Config
-    %w(log_level drb_port vagrant_binary shutdown_vms
-       skip_rollback start_server).each do |attr|
-      attr_accessor attr.to_sym
+    attr_accessor :log_level, :drb_port, :vagrant_binary,
+      :shutdown_vms, :skip_rollback, :start_server
+
+    def self.default
+      self.new
     end
 
+    def configure
+      yield(self)
+      self
+    end
+
+    private
+
     def initialize
-      @log_level = :info
+      @log_level = :warn
       @drb_port = 35672
       @vagrant_binary = 'vagrant'
       @shutdown_vms = false
       @skip_rollback = false
       @start_server = true
     end
-
-    def self.default
-      self.new
-    end
-  end
-
-  class << self
-    def config
-      @config ||= Config.default
-    end
-
-    def configure
-      if block_given?
-        yield(self.config)
-      else
-        raise ArgumentError, "No block given"
-      end
-    end
   end
 end

data/lib/foodtaster/rspec.rb

@@ -2,11 +2,24 @@ module Foodtaster
   module RSpec
     autoload :ExampleMethods, "foodtaster/rspec/example_methods"
     autoload :DslMethods, "foodtaster/rspec/dsl_methods"
+
+    def self.configure
+      ::RSpec::configure do |config|
+        config.include Foodtaster::RSpec::ExampleMethods
+        config.extend Foodtaster::RSpec::DslMethods
+
+        config.before(:suite) do
+          Foodtaster::RSpecRun.current.start
+        end
+
+        config.after(:suite) do
+          Foodtaster::RSpecRun.current.stop
+        end
+      end
+    end
   end
 end
 
-require 'foodtaster/rspec/config'
-
 # require all matchers
 Dir[File.dirname(__FILE__) + "/rspec/matchers/*.rb"].each do |f|
   require f

data/lib/foodtaster/rspec/matchers/simple_matchers.rb

@@ -1,10 +1,8 @@
 require 'timeout'
 
-# RSpec::Matchers.send(:include, VagrantHelper::Matchers::MatcherMethods)
-
 RSpec::Matchers.define :have_running_process do |process|
   match do |vm|
-    vm.execute("pgrep #{process}").successful?
+    vm.execute("pgrep -f #{process}").successful?
   end
 
   failure_message_for_should do |vm|
@@ -74,26 +72,6 @@ RSpec::Matchers.define :have_group do |group|
   end
 end
 
-RSpec::Matchers.define :open_page do |address|
-  match do |vm|
-    result = vm.execute("wget #{address} -O /tmp/test-page").successful?
-    vm.execute("rm /tmp/test-page")
-    result
-  end
-
-  failure_message_for_should do |vm|
-    "expected that #{vm.name} should open page '#{address}'"
-  end
-
-  failure_message_for_should_not do |vm|
-    "expected that #{vm.name} should not open page '#{address}'"
-  end
-
-  description do
-    "open page '#{address}'"
-  end
-end
-
 def wait_until(_timeout = 5)
   begin
     timeout _timeout do
@@ -116,4 +94,3 @@ RSpec::Matchers.define :be_successful do |opts = {}|
     end
   end
 end
-

data/lib/foodtaster/rspec_run.rb

@@ -12,15 +12,11 @@ module Foodtaster
       setup_signal_handlers
       start_server_and_connect_client
 
-      if (@server_process.nil? || @server_process.alive?) && @client
-        # prepare_required_vms
-      else
-        if @server_process
-          Foodtaster.logger.fatal "Failed to start Foodtaster DRb Server:\n\n#{@server_process.output}"
-        else
-          Foodtaster.logger.fatal "Failed to connect to Foodtaster DRb Server"
-        end
-
+      if @client && @server_process && !@server_process.alive?
+        Foodtaster.logger.fatal "Failed to start Foodtaster DRb Server:\n\n#{@server_process.output}"
+        exit 1
+      elsif !@client || !@server_process
+        Foodtaster.logger.fatal "Failed to connect to Foodtaster DRb Server"
         exit 1
       end
     end
@@ -65,12 +61,12 @@ module Foodtaster
     def start_server_and_connect_client
       drb_port = Foodtaster.config.drb_port
 
-      start_server(drb_port) if Foodtaster.config.start_server
-      connect_client(drb_port)
+      @server_process = start_server(drb_port) if Foodtaster.config.start_server
+      @client = connect_client(drb_port)
     end
 
     def start_server(drb_port)
-      @server_process = Foodtaster::ServerProcess.new(drb_port)
+      Foodtaster::ServerProcess.new(drb_port)
     end
 
     def terminate_server
@@ -78,7 +74,7 @@ module Foodtaster
     end
 
     def connect_client(drb_port)
-      @client = Foodtaster::Client.connect(drb_port, @server_process)
+      Foodtaster::Client.connect(drb_port, @server_process)
     end
   end
 end

data/lib/foodtaster/version.rb

@@ -1,3 +1,3 @@
 module Foodtaster
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/lib/foodtaster/vm.rb

@@ -8,9 +8,11 @@ module Foodtaster
       attr_reader :exit_status
 
       def initialize(hash)
-        @stderr = hash[:stderr].to_s
-        @stdout = hash[:stdout].to_s
-        @exit_status = hash[:exit_status]
+        if hash
+          @stderr = hash[:stderr].to_s.chomp
+          @stdout = hash[:stdout].to_s.chomp
+          @exit_status = hash[:exit_status]
+        end
       end
 
       def successful?
@@ -38,13 +40,14 @@ module Foodtaster
       end
 
       def get(vm_name)
-        find_by_name(vm_name) || self.new(vm_name)
+        find_by_name(vm_name) ||
+          self.new(vm_name, Foodtaster::RSpecRun.current.client)
       end
     end
 
-    def initialize(name)
+    def initialize(name, client)
       @name = name
-      @client = Foodtaster::RSpecRun.current.client
+      @client = client
 
       unless @client.vm_defined?(name)
         raise ArgumentError, "No machine defined with name #{name}"
@@ -112,10 +115,11 @@ module Foodtaster
     def execute(command)
       Foodtaster.logger.debug "#{name}: Executing #{command}"
       exec_result_hash = @client.execute_command_on_vm(name, command)
+      exec_result = ExecResult.new(exec_result_hash)
 
-      Foodtaster.logger.debug "#{name}: Finished with #{exec_result_hash[:exit_status]}"
-      Foodtaster.logger.debug "#{name}: STDOUT: #{exec_result_hash[:stdout].to_s.chomp}"
-      Foodtaster.logger.debug "#{name}: STDERR: #{exec_result_hash[:stderr].to_s.chomp}"
+      Foodtaster.logger.debug "#{name}: Finished with #{exec_result.exit_status}"
+      Foodtaster.logger.debug "#{name}: STDOUT: #{exec_result.stdout}"
+      Foodtaster.logger.debug "#{name}: STDERR: #{exec_result.stderr}"
 
       ExecResult.new(exec_result_hash)
     end
@@ -126,6 +130,8 @@ module Foodtaster
     end
 
     def run_chef(config)
+      fail ArgumentError, "#{config.inspect} should have :run_list." unless config[:run_list]
+
       Foodtaster.logger.info "#{name}: Running Chef with Run List #{config[:run_list].join(', ')}"
       Foodtaster.logger.debug "#{name}: with JSON: #{config[:json].inspect}"
       @client.run_chef_on_vm(name, config)

data/spec/foodtaster/client_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Foodtaster::Client do
+  before(:each) { TestServer.start }
+  after(:each)  { TestServer.stop }
+
+  it 'should connect to server' do
+    client = described_class.connect(TestServer::PORT)
+    expect(client).not_to be(nil)
+  end
+end

data/spec/foodtaster/config_spec.rb

@@ -0,0 +1,38 @@
+require 'foodtaster/config'
+
+describe Foodtaster::Config do
+  context 'default options' do
+    subject { described_class.new }
+
+    its(:log_level)      { should == :warn }
+    its(:drb_port)       { should == 35672 }
+    its(:vagrant_binary) { should == 'vagrant' }
+    its(:shutdown_vms)   { should == false }
+    its(:skip_rollback)  { should == false }
+    its(:start_server)   { should == true }
+  end
+
+  context 'option overrides' do
+    subject do
+      described_class.new
+    end
+
+    before(:each) do
+      subject.configure do |conf|
+        conf.log_level = :debug
+        conf.drb_port = 31415
+        conf.vagrant_binary = '/some/vagrant'
+        conf.shutdown_vms = true
+        conf.skip_rollback = true
+        conf.start_server = false
+      end
+    end
+
+    its(:log_level)      { should == :debug }
+    its(:drb_port)       { should == 31415 }
+    its(:vagrant_binary) { should == '/some/vagrant' }
+    its(:shutdown_vms)   { should == true }
+    its(:skip_rollback)  { should == true }
+    its(:start_server)   { should == false }
+  end
+end

data/spec/foodtaster/vm_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe Foodtaster::Vm do
+  let(:vm_name) { "vm" }
+  let(:client) { double("client", vm_defined?: true) }
+  subject { described_class.new(vm_name, client) }
+
+  context 'invoking client methods' do
+    it '#running?' do
+      with_mocked(:vm_running?) do
+        subject.running?
+      end
+    end
+
+    it '#initial_snapshot_made?' do
+      with_mocked(:initial_snapshot_made_on_vm?) do
+        subject.initial_snapshot_made?
+      end
+    end
+
+    it '#start!' do
+      with_mocked(:start_vm) do
+        subject.start!
+      end
+    end
+
+    it '#make_initial_snapshot!' do
+      with_mocked(:make_initial_snapshot_on_vm) do
+        subject.make_initial_snapshot!
+      end
+    end
+
+    it 'should start machine and make initial snapshot on prepare' do
+      with_mocked(:vm_running?, :start_vm, :initial_snapshot_made_on_vm?, :make_initial_snapshot_on_vm) do
+        subject.prepare
+      end
+    end
+
+    it 'should check if machine is running and snapshot was made on prepared?' do
+      with_mocked(:initial_snapshot_made_on_vm?) do
+        allow(client).to receive(:vm_running?).and_return(true)
+        subject.prepared?
+        expect(client).to have_received(:vm_running?)
+      end
+    end
+
+    it '#ip' do
+      with_mocked(:vm_ip) do
+        subject.ip
+      end
+    end
+
+    it '#put_file' do
+      with_mocked(:put_file_to_vm) do
+        subject.put_file('/path', '/path')
+      end
+    end
+
+    it '#get_file' do
+      with_mocked(:get_file_from_vm) do
+        subject.get_file('/path', '/path')
+      end
+    end
+
+    it '#shutdown' do
+      with_mocked(:shutdown_vm) do
+        subject.shutdown
+      end
+    end
+
+    it '#rollback' do
+      with_mocked(:rollback_vm) do
+        subject.rollback
+      end
+    end
+
+    it '#execute' do
+      with_mocked(:execute_command_on_vm) do
+        subject.execute('echo 1')
+      end
+    end
+
+    it '#execute_as' do
+      with_mocked(:execute_command_on_vm) do
+        subject.execute_as(:root, 'echo 1')
+      end
+    end
+
+    it '#run_chef' do
+      with_mocked(:run_chef_on_vm) do
+        subject.run_chef({run_list: []})
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'foodtaster'
+require 'support/test_server'
+
+def with_mocked(*method_names)
+  method_names.each do |method_name|
+    allow(client).to receive(method_name)
+  end
+  yield
+  method_names.each do |method_name|
+    expect(client).to have_received(method_name)
+  end
+end

data/spec/support/test_server.rb

@@ -0,0 +1,22 @@
+require 'drb'
+
+class TestServer
+  PORT = 4444
+
+  def self.start
+    DRb.start_service("druby://localhost:#{PORT}", self.new)
+  end
+
+  def self.stop
+    DRb.stop_service
+  end
+
+  def redirect_stdstreams(stdout, stderr)
+  end
+
+  def version
+    Foodtaster::VERSION
+  end
+end
+
+

metadata

@@ -2,7 +2,7 @@
 name: foodtaster
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Mike Lapshin
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-08 00:00:00.000000000 Z
+date: 2013-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   prerelease: false
@@ -36,6 +36,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE
 - README.md
@@ -45,7 +46,6 @@ files:
 - lib/foodtaster/client.rb
 - lib/foodtaster/config.rb
 - lib/foodtaster/rspec.rb
-- lib/foodtaster/rspec/config.rb
 - lib/foodtaster/rspec/dsl_methods.rb
 - lib/foodtaster/rspec/example_methods.rb
 - lib/foodtaster/rspec/matchers/file_matcher.rb
@@ -56,6 +56,11 @@ files:
 - lib/foodtaster/server_process.rb
 - lib/foodtaster/version.rb
 - lib/foodtaster/vm.rb
+- spec/foodtaster/client_spec.rb
+- spec/foodtaster/config_spec.rb
+- spec/foodtaster/vm_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_server.rb
 homepage: http://github.com/mlapshin/foodtaster
 licenses:
 - MIT
@@ -81,5 +86,10 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Foodtaster is a library for testing your Chef code with RSpec.
-test_files: []
+test_files:
+- spec/foodtaster/client_spec.rb
+- spec/foodtaster/config_spec.rb
+- spec/foodtaster/vm_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_server.rb
 has_rdoc: 

data/lib/foodtaster/rspec/config.rb

@@ -1,12 +0,0 @@
-RSpec::configure do |config|
-  config.include Foodtaster::RSpec::ExampleMethods
-  config.extend Foodtaster::RSpec::DslMethods
-
-  config.before(:suite) do
-    Foodtaster::RSpecRun.current.start
-  end
-
-  config.after(:suite) do
-    Foodtaster::RSpecRun.current.stop
-  end
-end