derelict 0.0.1 → 0.1.0

data/spec/derelict/virtual_machine_spec.rb

@@ -0,0 +1,295 @@
+require "spec_helper"
+
+describe Derelict::VirtualMachine do
+  let(:connection) { double("connection", :description => "test") }
+  let(:name) { double("name", :inspect => "testvm") }
+
+  let(:vm) { Derelict::VirtualMachine.new connection, name }
+  subject { vm }
+
+  describe "#initialize" do
+    it "should succeed" do
+      expect { subject }.to_not raise_error
+    end
+
+    include_context "logged messages"
+    let(:expected_logs) {[
+      "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+    ]}
+  end
+
+  describe "#validate!" do
+    before { expect(vm).to receive(:exists?).and_return(exists?) }
+    subject { vm.validate! }
+
+    context "when exists? is false" do
+      let(:exists?) { false }
+      it "should raise NotFound" do
+        expect { subject }.to raise_error Derelict::VirtualMachine::NotFound
+      end
+
+      include_context "logged messages"
+      let(:expected_logs) {[
+        "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+        "DEBUG virtualmachine: Starting validation for Derelict::VirtualMachine 'testvm' from test\n",
+      ]}
+    end
+
+    context "when exists? is true" do
+      let(:exists?) { true }
+      it "shouldn't raise any errors" do
+        expect { subject }.to_not raise_error
+      end
+
+      it "should be chainable" do
+        expect(subject).to be subject
+      end
+
+      include_context "logged messages"
+      let(:expected_logs) {[
+        "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+        "DEBUG virtualmachine: Starting validation for Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO virtualmachine: Successfully validated Derelict::VirtualMachine 'testvm' from test\n",
+      ]}
+    end
+  end
+
+  describe "#exists?" do
+    let(:status) { double("status", :exists? => exists?) }
+    let(:exists?) { double("exists") }
+
+    before { expect(vm).to receive(:status).and_return(status) }
+    subject { vm.exists? }
+
+    it "should delegate to the status parser" do
+      expect(subject).to be exists?
+    end
+
+    include_context "logged messages"
+    let(:expected_logs) {[
+      "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+    ]}
+  end
+
+  describe "#state" do
+    let(:status) { double("status", :state => state) }
+    let(:state) { double("state") }
+
+    before { expect(vm).to receive(:status).and_return(status) }
+    subject { vm.state }
+
+    it "should delegate to the status parser" do
+      expect(subject).to be state
+    end
+  end
+
+  describe "#running?" do
+    before { expect(vm).to receive(:state).and_return(state) }
+    subject { vm.running? }
+
+    context "when state is :running" do
+      let(:state) { :running }
+      it { should be true }
+    end
+
+    context "when state is :foo" do
+      let(:state) { :foo }
+      it { should be false }
+    end
+  end
+
+  describe "#up!" do
+    let(:options) { Hash.new }
+    let(:result) { double("result") }
+    subject { vm.up! options }
+
+    before do
+      expect(connection).to receive(:execute!).with(:up, name).and_yield("foo").and_return result
+    end
+
+    context "with external logging disabled" do
+      include_context "logged messages"
+      let(:expected_logs) {[
+        "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO virtualmachine: Bringing up Derelict::VirtualMachine 'testvm' from test\n",
+      ]}
+    end
+
+    context "with external logging enabled" do
+      let(:options) { {:log => true} }
+
+      include_context "logged messages"
+      let(:expected_logs) {[
+        "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO virtualmachine: Bringing up Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO external: foo\n",
+      ]}
+    end
+  end
+
+  describe "#halt!" do
+    let(:options) { Hash.new }
+    let(:result) { double("result") }
+    subject { vm.halt! options }
+
+    before do
+      expect(connection).to receive(:execute!).with(:halt, name).and_yield("foo").and_return result
+    end
+
+    context "with external logging disabled" do
+      include_context "logged messages"
+      let(:expected_logs) {[
+        "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO virtualmachine: Halting Derelict::VirtualMachine 'testvm' from test\n",
+      ]}
+    end
+
+    context "with external logging enabled" do
+      let(:options) { {:log => true} }
+
+      include_context "logged messages"
+      let(:expected_logs) {[
+        "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO virtualmachine: Halting Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO external: foo\n",
+      ]}
+    end
+  end
+
+  describe "#destroy!" do
+    let(:options) { Hash.new }
+    let(:result) { double("result") }
+    subject { vm.destroy! options }
+
+    before do
+      expect(connection).to receive(:execute!).with(:destroy, name, '--force').and_yield("foo").and_return result
+    end
+
+    context "with external logging disabled" do
+      include_context "logged messages"
+      let(:expected_logs) {[
+        "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO virtualmachine: Destroying Derelict::VirtualMachine 'testvm' from test\n",
+      ]}
+    end
+
+    context "with external logging enabled" do
+      let(:options) { {:log => true} }
+
+      include_context "logged messages"
+      let(:expected_logs) {[
+        "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO virtualmachine: Destroying Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO external: foo\n",
+      ]}
+    end
+  end
+
+  describe "#reload!" do
+    let(:options) { Hash.new }
+    let(:result) { double("result") }
+    subject { vm.reload! options }
+
+    before do
+      expect(connection).to receive(:execute!).with(:reload, name).and_yield("foo").and_return result
+    end
+
+    context "with external logging disabled" do
+      include_context "logged messages"
+      let(:expected_logs) {[
+        "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO virtualmachine: Reloading Derelict::VirtualMachine 'testvm' from test\n",
+      ]}
+    end
+
+    context "with external logging enabled" do
+      let(:options) { {:log => true} }
+
+      include_context "logged messages"
+      let(:expected_logs) {[
+        "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO virtualmachine: Reloading Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO external: foo\n",
+      ]}
+    end
+  end
+
+  describe "#suspend!" do
+    let(:options) { Hash.new }
+    let(:result) { double("result") }
+    subject { vm.suspend! options }
+
+    before do
+      expect(connection).to receive(:execute!).with(:suspend, name).and_yield("foo").and_return result
+    end
+
+    context "with external logging disabled" do
+      include_context "logged messages"
+      let(:expected_logs) {[
+        "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO virtualmachine: Suspending Derelict::VirtualMachine 'testvm' from test\n",
+      ]}
+    end
+
+    context "with external logging enabled" do
+      let(:options) { {:log => true} }
+
+      include_context "logged messages"
+      let(:expected_logs) {[
+        "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO virtualmachine: Suspending Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO external: foo\n",
+      ]}
+    end
+  end
+
+  describe "#resume!" do
+    let(:options) { Hash.new }
+    let(:result) { double("result") }
+    subject { vm.resume! options }
+
+    before do
+      expect(connection).to receive(:execute!).with(:resume, name).and_yield("foo").and_return result
+    end
+
+    context "with external logging disabled" do
+      include_context "logged messages"
+      let(:expected_logs) {[
+        "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO virtualmachine: Resuming Derelict::VirtualMachine 'testvm' from test\n",
+      ]}
+    end
+
+    context "with external logging enabled" do
+      let(:options) { {:log => true} }
+
+      include_context "logged messages"
+      let(:expected_logs) {[
+        "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO virtualmachine: Resuming Derelict::VirtualMachine 'testvm' from test\n",
+        " INFO external: foo\n",
+      ]}
+    end
+  end
+
+  describe "#status" do
+    let(:result) { double("result", :stdout => stdout) }
+    let(:stdout) { double("stdout") }
+    subject { vm.status }
+
+    before do
+      expect(connection).to receive(:execute!).with(:status).and_return(result)
+      expect(Derelict::Parser::Status).to receive(:new).with(stdout).and_return(:return_value)
+    end
+
+    it "should parse status data from the connection" do
+      expect(subject).to be :return_value
+    end
+
+    include_context "logged messages"
+    let(:expected_logs) {[
+      "DEBUG virtualmachine: Successfully initialized Derelict::VirtualMachine 'testvm' from test\n",
+      " INFO virtualmachine: Retrieving Vagrant status for Derelict::VirtualMachine 'testvm' from test\n",
+    ]}
+  end
+end

data/spec/derelict_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe Derelict do
+  describe "#instance" do
+    let(:instance) { double("instance") }
+    before {
+      expect(Derelict::Instance).to receive(:new).and_return(instance)
+      expect(instance).to receive(:validate!).and_return(instance)
+    }
+
+    subject { Derelict.instance }
+    it { should be instance }
+
+    include_context "logged messages"
+    let(:expected_logs) {[
+      " INFO derelict: Creating and validating new instance for '/Applications/Vagrant'\n"
+    ]}
+  end
+
+  describe "#debug!" do
+    let(:enabled) { double("enabled") }
+    let(:level) { double("level") }
+    let(:logger) { Derelict.logger }
+    let(:stderr) { Log4r::Outputter.stderr }
+
+    subject { Derelict.debug! :enabled => enabled, :level => level }
+
+    context "when enabling debug mode" do
+      before do
+        expect(logger).to receive(:level=).with(level).and_return(nil)
+        expect(logger).to receive(:outputters).and_return(Array.new)
+        expect(logger).to receive(:add).with(stderr).and_return(logger)
+      end
+
+      let(:enabled) { true }
+      it { should be Derelict }
+    end
+
+    context "when disabling debug mode" do
+      before do
+        expect(logger).to receive(:level=).with(Log4r::OFF).and_return(nil)
+        expect(logger).to receive(:remove).with("stderr").and_return(logger)
+      end
+
+      let(:real_level) { Log4r::OFF }
+      let(:enabled) { false }
+      it { should be Derelict }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,32 @@
-require 'derelict'
-require 'bundler/setup'
+require "coverage_helper"
+require "derelict"
+require File.join(File.dirname(__FILE__), "support", "log_context")
 
+derelict_logger = Derelict.logger
+external_logger = Derelict.logger :type => :external
+array_outputter = Derelict::Utils::Logger::ArrayOutputter.new "rspec"
 
 RSpec.configure do |config|
-  # some (optional) config here
+  config.before :each do
+    # Start each spec with an empty ArrayOutputter
+    array_outputter.flush
+
+    # Remove any outputters set on other loggers
+    Log4r::Logger.each {|fullname, logger| logger.outputters = [] }
+
+    # Add the ArrayOutputter to the base Derelict logger
+    derelict_logger.outputters = [array_outputter]
+    external_logger.outputters = [array_outputter]
+  end
+
+  # Forbid .should syntax
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
 end

data/spec/support/log_context.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+# Provides set-up and examples to assert logged messages
+#
+# Usage:
+#
+#   * Ensure that the "subject" from the parent context will perform
+#     the action which is expected to produce the log messages
+#   * Provide a "let(:expected_logs)" block, defining which logs are
+#     expected to result from the action performed in the "before"
+#     block (otherwise, it defaults to expecting no log messages)
+shared_context "logged messages" do
+  let(:outputter) { Log4r::Outputter["rspec"] }
+  let(:messages) { outputter.messages }
+
+  # Override this let block when including this shared context
+  let(:expected_logs) { [] }
+
+  # Add an additional context for readability in the output
+  describe "logged messages" do
+    before do
+      begin
+        subject
+      rescue Exception
+      end
+    end
+
+    it "should be an Array" do
+      expect(messages).to be_an Array
+    end
+
+    it "should contain the expected log messages" do
+      expect(messages).to eq expected_logs
+    end
+  end
+end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: derelict
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Brad Feehan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-07 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shell-executer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,66 +66,152 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'Provides a Ruby API to control Vagrant where Vagrant is installed
-  via the Installer package on Mac OS X.
-
-
-  Vagrant was historically available as a gem, naturally providing a Ruby API to control
-  Vagrant in other Ruby libraries and applications. However, since version 1.1.0,
-  Vagrant is distributed exclusively using an Installer package. To control Vagrant
-  when it''s installed this way, other Ruby libraries and applications typically need
-  to invoke the Vagrant binary, which requires forking a new process and parsing its
-  output using string manipulation.'
+description: '["Provides a Ruby API to control Vagrant where Vagrant is installed
+  via the Installer package on Mac OS X.\n\nVagrant was historically available as
+  a gem, naturally providing a Ruby API to control Vagrant in other Ruby libraries
+  and applications. However, since version 1.1.0, Vagrant is distributed exclusively
+  using an Installer package. To control Vagrant when it''s installed this way, other
+  Ruby libraries and applications typically need to invoke the Vagrant binary, which
+  requires forking a new process and parsing its output using string manipulation.",
+  "Ruby API for Vagrant installed via Installer package on Mac OS X."]'
 email:
 - git@bradfeehan.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .cane
+- .coveralls.yml
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - derelict.gemspec
 - lib/derelict.rb
+- lib/derelict/connection.rb
+- lib/derelict/connection/invalid.rb
+- lib/derelict/connection/not_found.rb
 - lib/derelict/exception.rb
+- lib/derelict/exception/optional_reason.rb
 - lib/derelict/instance.rb
-- lib/derelict/instance/already_active.rb
+- lib/derelict/instance/command_failed.rb
 - lib/derelict/instance/invalid.rb
+- lib/derelict/instance/missing_binary.rb
 - lib/derelict/instance/non_directory.rb
 - lib/derelict/instance/not_found.rb
+- lib/derelict/parser.rb
+- lib/derelict/parser/status.rb
+- lib/derelict/parser/status/invalid_format.rb
+- lib/derelict/parser/version.rb
+- lib/derelict/parser/version/invalid_format.rb
+- lib/derelict/utils.rb
+- lib/derelict/utils/logger.rb
+- lib/derelict/utils/logger/array_outputter.rb
+- lib/derelict/utils/logger/invalid_type.rb
+- lib/derelict/utils/logger/raw_formatter.rb
 - lib/derelict/version.rb
+- lib/derelict/virtual_machine.rb
+- lib/derelict/virtual_machine/invalid.rb
+- lib/derelict/virtual_machine/not_found.rb
+- spec/coverage_helper.rb
+- spec/derelict/connection/invalid_spec.rb
+- spec/derelict/connection/not_found_spec.rb
+- spec/derelict/connection_spec.rb
+- spec/derelict/exception/optional_reason_spec.rb
+- spec/derelict/exception_spec.rb
+- spec/derelict/instance/command_failed_spec.rb
+- spec/derelict/instance/invalid_spec.rb
+- spec/derelict/instance/missing_binary_spec.rb
+- spec/derelict/instance/non_directory_spec.rb
+- spec/derelict/instance/not_found_spec.rb
+- spec/derelict/instance_spec.rb
+- spec/derelict/parser/status/invalid_format_spec.rb
+- spec/derelict/parser/status_spec.rb
+- spec/derelict/parser/version/invalid_format_spec.rb
+- spec/derelict/parser/version_spec.rb
+- spec/derelict/parser_spec.rb
+- spec/derelict/utils/logger/array_outputter_spec.rb
+- spec/derelict/utils/logger/invalid_type_spec.rb
+- spec/derelict/utils/logger/raw_formatter_spec.rb
+- spec/derelict/utils/logger_spec.rb
+- spec/derelict/virtual_machine/invalid_spec.rb
+- spec/derelict/virtual_machine/not_found_spec.rb
+- spec/derelict/virtual_machine_spec.rb
+- spec/derelict_spec.rb
 - spec/spec_helper.rb
-- spec/system_spec.spec
+- spec/support/log_context.rb
 homepage: https://github.com/bradfeehan/derelict
 licenses:
 - MIT
@@ -94,20 +222,45 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby API for Vagrant installed via Installer package on Mac OS X.
 test_files:
+- spec/coverage_helper.rb
+- spec/derelict/connection/invalid_spec.rb
+- spec/derelict/connection/not_found_spec.rb
+- spec/derelict/connection_spec.rb
+- spec/derelict/exception/optional_reason_spec.rb
+- spec/derelict/exception_spec.rb
+- spec/derelict/instance/command_failed_spec.rb
+- spec/derelict/instance/invalid_spec.rb
+- spec/derelict/instance/missing_binary_spec.rb
+- spec/derelict/instance/non_directory_spec.rb
+- spec/derelict/instance/not_found_spec.rb
+- spec/derelict/instance_spec.rb
+- spec/derelict/parser/status/invalid_format_spec.rb
+- spec/derelict/parser/status_spec.rb
+- spec/derelict/parser/version/invalid_format_spec.rb
+- spec/derelict/parser/version_spec.rb
+- spec/derelict/parser_spec.rb
+- spec/derelict/utils/logger/array_outputter_spec.rb
+- spec/derelict/utils/logger/invalid_type_spec.rb
+- spec/derelict/utils/logger/raw_formatter_spec.rb
+- spec/derelict/utils/logger_spec.rb
+- spec/derelict/virtual_machine/invalid_spec.rb
+- spec/derelict/virtual_machine/not_found_spec.rb
+- spec/derelict/virtual_machine_spec.rb
+- spec/derelict_spec.rb
 - spec/spec_helper.rb
-- spec/system_spec.spec
+- spec/support/log_context.rb