bosh-workspace 0.8.5 → 0.9.0.rc1

data/spec/release_spec.rb

@@ -1,123 +1,251 @@
 describe Bosh::Workspace::Release do
-  let(:name) { "foo"}
+  include Bosh::Workspace::GitCredenialsHelper
+  let(:name) { "foo" }
+  let(:release) { load_release(release_data) }
   let(:version) { 3 }
-  let(:repo) { extracted_asset_dir("foo", "foo-boshrelease-repo.zip") }
   let(:release_data) { { "name" => name, "version" => version, "git" => repo } }
   let(:releases_dir) { File.join(asset_dir("manifests-repo"), ".releases") }
-  let(:release) { Bosh::Workspace::Release.new release_data, releases_dir }
   let(:templates) { Dir[File.join(releases_dir, name, "templates/*.yml")].to_s }
 
-  describe "#update_repo" do
-    subject { Dir[File.join(releases_dir, name, "releases/foo*.yml")].to_s }
-
-    context "latest version" do
-      before {  release.update_repo }
+  def load_release(release_data)
+    Bosh::Workspace::Release.new(release_data, releases_dir).tap do |r|
+      fetch_or_clone_repo(r.repo_dir, repo)
+    end
+  end
 
-      let(:version) { "latest" }
+  context "given a release with new structure within 'releases' folder" do
+    let(:repo) { extracted_asset_dir("foo", "foo-boshrelease-repo-new-structure.zip") }
 
-      it "checks out repo" do
-        expect(subject).to match(/foo-11.yml/)
+    describe "#update_repo" do
+      subject do
+        Dir[File.join(releases_dir, name, "releases/#{name}/foo*.yml")].to_s
       end
 
-      it "does not include templates from master" do
-        expect(templates).to_not match(/deployment.yml/)
+      context "latest version" do
+        before { release.update_repo }
+
+        let(:version) { "latest" }
+
+        it "checks out repo" do
+          expect(subject).to match(/foo-11.yml/)
+        end
+
+        it "does not include templates from master" do
+          expect(templates).to_not match(/deployment.yml/)
+        end
       end
     end
 
-    context "specific version" do
-      let(:version) { "11" }
-      before {  release.update_repo }
+    describe "attributes" do
+      subject { release }
+      its(:name) { should eq name }
+      its(:git_url) { should eq repo }
+      its(:repo_dir) { should match(/\/#{name}$/) }
+      its(:manifest_file) { should match(/\/#{name}-#{version}.yml$/) }
+      its(:manifest) { should match "releases/#{name}/#{name}-#{version}.yml$" }
+      its(:name_version) { should eq "#{name}/#{version}" }
+      its(:version) { should eq version }
+    end
+  end
+
+  context "given a release with deprecated structure within 'releases' folder" do
+    let(:repo) { extracted_asset_dir("foo", "foo-boshrelease-repo.zip") }
+
+    describe "#update_repo" do
+      subject { Dir[File.join(releases_dir, name, "releases/foo*.yml")].to_s }
+
+      context "latest version" do
+        before { release.update_repo }
+
+        let(:version) { "latest" }
+
+        it "checks out repo" do
+          expect(subject).to match(/foo-11.yml/)
+        end
 
-      it "checks out repo" do
-        expect(subject).to match(/foo-11.yml/)
+        it "does not include templates from master" do
+          expect(templates).to_not match(/deployment.yml/)
+        end
       end
 
-      it "does not include templates from master" do
-        expect(templates).to_not match(/deployment.yml/)
+      context "specific version" do
+        let(:version) { "11" }
+        before { release.update_repo }
+
+        it "checks out repo" do
+          expect(subject).to match(/foo-11.yml/)
+        end
+
+        it "does not include templates from master" do
+          expect(templates).to_not match(/deployment.yml/)
+        end
       end
-    end
 
-    context "specific version" do
-      let(:version) { "2" }
+      context "specific version" do
+        let(:version) { "2" }
 
-      it "checks out repo" do
-        release.update_repo
-        expect(subject).to match(/foo-2.yml/)
+        it "checks out repo" do
+          release.update_repo
+          expect(subject).to match(/foo-2.yml/)
+        end
       end
-    end
 
-    context "specific ref with latest release" do
-      let(:release_data) do 
-        { "name" => name, "version" => "latest", "ref" => "66658", "git" => repo }
+      context "specific ref with latest release" do
+        let(:release_data) do
+          {"name" => name, "version" => "latest", "ref" => "66658", "git" => repo}
+        end
+
+        it "checks out repo" do
+          release.update_repo
+          expect(subject).to match(/foo-2.yml/)
+          expect(subject).to_not match(/foo-3.yml/)
+        end
       end
 
-      it "checks out repo" do
-        release.update_repo
-        expect(subject).to match(/foo-2.yml/)
-        expect(subject).to_not match(/foo-3.yml/)
+      context "updated version " do
+        let(:version) { "11" }
+
+        it "checks out file with multiple commits" do
+          release.update_repo
+          expect(subject).to match(/foo-11.yml/)
+        end
       end
-    end
 
-    context "updated version " do
-      let(:version) { "11" }
+      context "non existing version " do
+        let(:version) { "12" }
 
-      it "checks out file with multiple commits" do
-        release.update_repo
-        expect(subject).to match(/foo-11.yml/)
+        it "raises an error" do
+          expect { release.update_repo }.
+            to raise_error(/Could not find version/)
+        end
       end
-    end
 
-    context "non existing version " do
-      let(:version) { "12" }
+      context "already cloned repo" do
+        before do
+          load_release("name" => name, "version" => 1, "git" => repo).update_repo
+        end
 
-      it "raises an error" do
-        expect { release.update_repo }.
-          to raise_error(/Could not find version/)
+        it "version 3" do
+          release.update_repo
+          expect(subject).to match(/foo-3.yml/)
+        end
       end
-    end
 
-    context "already cloned repo" do
-      before do
-        data = { "name" => name, "version" => 1, "git" => repo }
-        cloned_release = Bosh::Workspace::Release.new(data, releases_dir)
-        cloned_release.update_repo
+      context "multiple releases" do
+        let(:version) { "11" }
+
+        before do
+          load_release("name" => "bar", "version" => 2, "git" => repo).update_repo
+        end
+
+        it "version 11" do
+          release.update_repo
+          expect(subject).to match(/foo-11.yml/)
+          expect(templates).to_not match(/deployment.yml/)
+        end
       end
 
-      it "version 3" do
-        release.update_repo
-        expect(subject).to match(/foo-3.yml/)
+      context "specific version" do
+        let(:version) { "11" }
+        before { release.update_repo }
+
+        it "checks out repo" do
+          expect(subject).to match(/foo-11.yml/)
+        end
+
+        it "does not include templates from master" do
+          expect(templates).to_not match(/deployment.yml/)
+        end
       end
-    end
 
-    context "multiple releases" do
-      let(:version) { "11" }
+      context "specific version" do
+        let(:version) { "2" }
 
-      before do
-        data = { "name" => "bar", "version" => 2, "git" => repo }
-        other_release = Bosh::Workspace::Release.new(data, releases_dir)
-        other_release.update_repo
+        it "checks out repo" do
+          release.update_repo
+          expect(subject).to match(/foo-2.yml/)
+        end
       end
 
-      it "version 3" do
-        release.update_repo
-        expect(subject).to match(/foo-11.yml/)
-        expect(templates).to_not match(/deployment.yml/)
+      context "specific ref with latest release" do
+        let(:release_data) do
+          {"name" => name, "version" => "latest", "ref" => "66658", "git" => repo}
+        end
+
+        it "checks out repo" do
+          release.update_repo
+          expect(subject).to match(/foo-2.yml/)
+          expect(subject).to_not match(/foo-3.yml/)
+        end
       end
-    end
-  end
 
-  describe "attributes" do
-    subject { release }
-    its(:name){ should eq name }
-    its(:git_uri){ should eq repo }
-    its(:repo_dir){ should match(/\/#{name}$/) }
-    its(:manifest_file){ should match(/\/#{name}-#{version}.yml$/) }
-    its(:manifest){ should match "releases/#{name}-#{version}.yml$" }
-    its(:name_version){ should eq "#{name}/#{version}" }
-    its(:version){ should eq version }
-  end
+      context "updated version " do
+        let(:version) { "11" }
+
+        it "checks out file with multiple commits" do
+          release.update_repo
+          expect(subject).to match(/foo-11.yml/)
+        end
+      end
+
+      context "non existing version " do
+        let(:version) { "12" }
+
+        it "raises an error" do
+          expect { release.version }.
+            to raise_error(/Could not find version/)
+        end
+      end
+
+      context "already cloned repo" do
+        before do
+          load_release("name" => name, "version" => 1, "git" => repo).update_repo
+        end
 
-  after do
-    FileUtils.rm_r releases_dir
+        it "version 3" do
+          release.update_repo
+          expect(subject).to match(/foo-3.yml/)
+        end
+      end
+
+      context "multiple releases" do
+        let(:version) { "11" }
+
+        before do
+          load_release("name" => "bar", "version" => 2, "git" => repo).update_repo
+        end
+
+        it "version 11" do
+          release.update_repo
+          expect(subject).to match(/foo-11.yml/)
+          expect(templates).to_not match(/deployment.yml/)
+        end
+      end
+
+      context "new release in already cloned repo" do
+        let(:version) { "12" }
+
+        before do
+          load_release("name" => name, "version" => 1, "git" => repo).update_repo
+          extracted_asset_dir("foo", "foo-boshrelease-repo-updated.zip")
+        end
+
+        it "version 12" do
+          release.update_repo
+          expect(subject).to match(/foo-12.yml/)
+        end
+      end
+    end
+
+    describe "attributes" do
+      subject { release }
+      its(:name) { should eq name }
+      its(:git_url) { should eq repo }
+      its(:repo_dir) { should match(/\/#{name}$/) }
+      its(:manifest_file) { should match(/\/#{name}-#{version}.yml$/) }
+      its(:manifest) { should match "releases/#{name}-#{version}.yml$" }
+      its(:name_version) { should eq "#{name}/#{version}" }
+      its(:version) { should eq version }
+    end
   end
 end

data/spec/schemas/credentials_spec.rb

@@ -0,0 +1,28 @@
+module Bosh::Workspace::Schemas
+  describe Credentials do
+    let(:username_password) do
+      { "url" => "foo", "username" => "bar", "password" => "baz" }
+    end
+    let(:ssh_key) do
+      { "url" => "bar", "private_key" => "foobarkey" }
+    end
+
+    subject { Credentials.new.validate(credentials) }
+
+    context "valid credentials" do
+      let(:credentials) { [username_password, ssh_key] }
+      it { expect { subject }.to_not raise_error }
+    end
+
+    %w(url username password private_key).each do |field_name|
+      context "missing #{field_name}" do
+        let(:credentials) do
+          [username_password, ssh_key].map do |c|
+            c.delete_if { |k| k == field_name }
+          end
+        end
+        it { expect { subject }.to raise_error(/doesn't validate/i) }
+      end
+    end
+  end
+end

data/spec/schemas/deployment_patch_spec.rb

@@ -0,0 +1,30 @@
+module Bosh::Workspace::Schemas
+  describe DeploymentPatch do
+    before do
+      allow_any_instance_of(Releases).to receive(:validate).with(:releases)
+      allow_any_instance_of(Stemcells).to receive(:validate).with(:stemcells)
+    end
+
+    let(:deployment_patch) do
+      {
+        "stemcells" => :stemcells,
+        "releases" => :releases,
+        "templates_ref" => "477d1228a9f27815d6df3ab977235ab26eecbba6"
+      }
+    end
+
+    subject { DeploymentPatch.new.validate(deployment_patch) }
+
+    %w(stemcells releases).each do |field|
+      context "missing #{field}" do
+        before { deployment_patch.delete field }
+        it { expect { subject }.to raise_error(/#{field}.*missing/i) }
+      end
+    end
+
+    context "optional templates_ref" do
+      before { deployment_patch.delete "templates_ref" }
+      it { expect { subject }.to_not raise_error }
+    end
+  end
+end

data/spec/schemas/project_deployment_spec.rb

@@ -0,0 +1,45 @@
+module Bosh::Workspace::Schemas
+  describe ProjectDeployment do
+    before do
+      allow_any_instance_of(Releases).to receive(:validate).with(:releases)
+      allow_any_instance_of(Stemcells).to receive(:validate).with(:stemcells)
+    end
+
+    let(:project_deployment) do
+      {
+        "name" => "foo",
+        "director_uuid" => "e55134c3-0a63-47be-8409-c9e53e965d5c",
+        "stemcells" => :stemcells,
+        "releases" => :releases,
+        "templates" => [ "foo/bar.yml" ],
+        "meta" => { "foo" => "bar" }
+      }
+    end
+
+    subject { ProjectDeployment.new.validate(project_deployment) }
+
+    %w(name director_uuid releases templates meta stemcells).each do |field|
+      context "missing #{field}" do
+        before { project_deployment.delete field }
+        it { expect { subject }.to raise_error(/#{field}.*missing/i) }
+      end
+    end
+
+    context "optional domain_name" do
+      before { project_deployment["domain_name"] = "example.com" }
+      it { expect { subject }.to_not raise_error }
+    end
+
+    context "director_uuid" do
+      context "invalid" do
+        before { project_deployment["director_uuid"] = "invalid_uuid" }
+        it { expect { subject }.to raise_error(/director_uuid.*doesn't validate/) }
+      end
+
+      context "current" do
+        before { project_deployment["director_uuid"] = "current" }
+        it { expect { subject }.to_not raise_error }
+      end
+    end
+  end
+end

data/spec/schemas/releases_spec.rb

@@ -0,0 +1,31 @@
+module Bosh::Workspace::Schemas
+  describe Releases do
+    let(:release) do
+      {"name" => "foo", "version" => 1, "ref" => "cec3ec1", "git" => "example.com/git.git"}
+    end
+
+    subject { Releases.new.validate(releases) }
+
+    %w(name version git).each do |field_name|
+      context "missing #{field_name}" do
+        let(:releases) { [release.delete_if { |k| k == field_name }] }
+        it { expect { subject }.to raise_error(/#{field_name}.*missing/i) }
+      end
+    end
+
+    context "latest version" do
+      let(:releases) { release["version"] = "latest"; [release] }
+      it { expect { subject }.to_not raise_error }
+    end
+
+    context "invalid version" do
+      let(:releases) { release["version"] = "foo"; [release] }
+      it { expect { subject }.to raise_error(/version.*doesn't validate/i) }
+    end
+
+    context "optional ref" do
+      let(:releases) { [release.delete_if { |k| k == "ref" }] }
+      it { expect { subject }.to_not raise_error }
+    end
+  end
+end

data/spec/schemas/stemcells_spec.rb

@@ -0,0 +1,37 @@
+module Bosh::Workspace::Schemas
+  describe Stemcells do
+    let(:stemcell) do
+      {"name" => "foo", "version" => 1}
+    end
+
+    subject { Stemcells.new.validate(stemcells) }
+
+    %w(name version).each do |field_name|
+      context "missing #{field_name}" do
+        let(:stemcells) { [stemcell.delete_if { |k| k == field_name }] }
+        it { expect { subject }.to raise_error(/#{field_name}.*missing/i) }
+      end
+    end
+
+    context "latest version" do
+      let(:stemcells) { stemcell["version"] = "latest"; [stemcell] }
+      it { expect { subject }.to_not raise_error }
+    end
+
+    context "patch version string" do
+      let(:stemcells) { stemcell["version"] = "2719.1"; [stemcell] }
+      it { expect { subject }.to_not raise_error }
+    end
+
+    context "patch version float" do
+      let(:stemcells) { stemcell["version"] = 2719.1; [stemcell] }
+      it { expect { subject }.to_not raise_error }
+    end
+
+    context "invalid version" do
+      let(:stemcells) { stemcell["version"] = "foo"; [stemcell] }
+      it { expect { subject }.to raise_error(/version.*should match/i) }
+    end
+  end
+end
+

data/spec/shell_spec.rb

@@ -0,0 +1,70 @@
+module Bosh::Workspace
+  describe Shell do
+    subject { Shell.new(stdout) }
+    let(:stdout) { StringIO.new }
+
+    describe '#run' do
+      it 'shells out, prints and returns the output of the command' do
+        expect(subject.run('echo hello; echo world')).to eq("hello\nworld")
+        expect(stdout.string).to eq("hello\nworld\n")
+      end
+
+      it 'shells out with specified additional env variables' do
+        stub_const('ENV', 'SHELL' => '/bin/bash')
+        expect(subject.run('env env', env: { 'VAR' => '123' })).to include('VAR=123')
+        expect(stdout.string).to include('VAR=123')
+      end
+
+      it 'shells out with specified additional env variables even when SHELL env variable is not available' do
+        stub_const('ENV', {})
+        expect(subject.run('env env', env: { 'VAR' => '123' })).to include('VAR=123')
+        expect(stdout.string).to include('VAR=123')
+      end
+
+      context 'when "output_command" is specified' do
+        it 'outputs the command' do
+          subject.run('echo 1;echo 2;echo 3;echo 4;echo 5', output_command: true)
+          expect(stdout.string).to include('echo 1;echo 2;echo 3;echo 4;echo 5')
+        end
+      end
+
+      context 'when "last_number" is specified' do
+        it 'tails "last_number" lines of output' do
+          cmd = 'echo 1;echo 2;echo 3;echo 4;echo 5'
+          expect(subject.run(cmd, last_number: 3)).to eq("3\n4\n5")
+          expect(stdout.string).to eq("1\n2\n3\n4\n5\n")
+        end
+
+        it 'outputs the entire output if more lines are requested than generated' do
+          cmd = 'echo 1;echo 2;echo 3;echo 4;echo 5'
+          expect(subject.run(cmd, last_number: 6)).to eq("1\n2\n3\n4\n5")
+          expect(stdout.string).to eq("1\n2\n3\n4\n5\n")
+        end
+      end
+
+      context 'when the command fails' do
+        it 'raises an error' do
+          expect {
+            subject.run('false')
+          }.to raise_error /Failed: 'false' from /
+        end
+
+        context 'because the working directory has gone missing' do
+          it 'fails gracefully with a slightly helpful error message' do
+            allow(Dir).to receive(:pwd).and_raise(Errno::ENOENT, 'No such file or directory - getcwd')
+            expect {
+              subject.run('false')
+            }.to raise_error /from a deleted directory/
+          end
+        end
+
+        context 'and ignoring failures' do
+          it 'raises an error' do
+            subject.run('false', ignore_failures: true)
+            expect(stdout.string).to match(/continuing anyway/)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -19,8 +19,11 @@ require "archive/zip"
 require "cli"
 
 require "bosh/workspace"
+require "bosh/workspace/tasks"
 
 RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
   config.raise_errors_for_deprecations!
   config.expect_with :rspec do |c|
     c.syntax = :expect
@@ -28,7 +31,7 @@ RSpec.configure do |config|
 end
 
 # load all files in spec/support/* (but not lower down)
-Dir[File.dirname(__FILE__) + '/support/*'].each do |path|
+Dir[File.dirname(__FILE__) + '/support/*/*.rb'].each do |path|
   require path unless File.directory?(path)
 end
 
@@ -81,9 +84,12 @@ end
 def extracted_asset_dir(name, *path)
   zipped_file = asset_dir(*path)
   target_dir = File.expand_path("../../tmp/#{name}", __FILE__)
-  unless File.directory?(target_dir)
-    FileUtils.mkdir_p(target_dir)
-    Archive::Zip.extract(zipped_file, target_dir)
-  end
+  FileUtils.rm_rf(target_dir) if File.exist?(target_dir)
+  FileUtils.mkdir_p(target_dir)
+  Archive::Zip.extract(zipped_file, target_dir)
   target_dir
 end
+
+def project_root
+  File.expand_path('../../', __FILE__)
+end

data/spec/support/shared_contexts/rake.rb

@@ -0,0 +1,37 @@
+require "rake"
+
+shared_context "rake" do
+  let(:rake)      { Rake::Application.new }
+  let(:task_name) { self.class.top_level_description }
+  let(:task_path) { "lib/bosh/workspace/tasks/#{task_name.split(":").first}" }
+
+  def loaded_files_excluding_current_rake_file
+    $".reject { |file| file == File.join(project_root, "#{task_path}.rake") }
+  end
+
+  def clear_main_instance_vars
+    TOPLEVEL_BINDING.eval('self').instance_variables.each do |var|
+      TOPLEVEL_BINDING.eval('self').remove_instance_variable(var)
+    end
+  end
+
+  def setup_already_invoked_tasks
+    if defined? already_invoked_tasks
+      rake.instance_variable_get(:@tasks).each do |name, task|
+        if already_invoked_tasks.include? name
+          task.instance_variable_set(:@already_invoked, true)
+        end
+      end
+    end
+  end
+
+  before do
+    Rake.application = rake
+    Rake.application.rake_require(task_path, [project_root], loaded_files_excluding_current_rake_file)
+    setup_already_invoked_tasks
+  end
+
+  after do
+    clear_main_instance_vars
+  end
+end