bosh-workspace 0.9.0.rc3 → 0.9.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51bf8a5f27e3c24ee4ef726151e656ddd79a15e6
-  data.tar.gz: 1b12be1ab651f544abe8ed1ec01346425ecd8c8d
+  metadata.gz: 7a974316196c63756eb13d118715adee4cb23a54
+  data.tar.gz: f683bafb845d0d1f6fe837f0c99d3d9508c9d445
 SHA512:
-  metadata.gz: f6a551fbb230b60f22a2fe19bbe304faca18751e7934591de500d0f1c092e2d83f05f300c456d3107acff5e2a69096c52cca95d778fc9f0bc2d1393a12b31015
-  data.tar.gz: f7a83e2266fcbbac54d2794ad391ddc66fa478a20cba79b0e047086cd52cb8c582896d1e36e2e4fa1789bf9fd6aca1c6f3286ad72317c31d1781f48476ac48cf
+  metadata.gz: 94646d03fe1942ca890a41f1e43487d6f7fedcecb6fb16605f48d6fd34abbc78d3771bf6d5cc9750066ca5a4cbd6804d25d9bb736a7b7e4d111a47c7a2168df9
+  data.tar.gz: d88d409fdc34da7cc2b8bcf3112f89fd9e0a7871512e33a7f6f8f85f512b678a263dcd51051032bc2bdac9c437b835483d54fae58d3c703c942bc5ab8eeb2c6d

data/README.md

@@ -1,5 +1,5 @@
 # Bosh workspace
-[![Build Status](https://img.shields.io/travis/cloudfoundry-incubator/bosh-workspace/master.svg?style=flat-square)](https://travis-ci.org/cloudfoundry-incubator/bosh-workspace) [![Test Coverage](https://img.shields.io/codeclimate/coverage/github/rkoster/bosh-workspace.svg?style=flat-square)](https://codeclimate.com/github/rkoster/bosh-workspace) [![Code Climate](https://img.shields.io/codeclimate/github/rkoster/bosh-workspace.svg?style=flat-square)](https://codeclimate.com/github/rkoster/bosh-workspace) [![Dependency Status](https://img.shields.io/gemnasium/cloudfoundry-incubator/bosh-workspace.svg?style=flat-square)](https://gemnasium.com/cloudfoundry-incubator/bosh-workspace)
+[![Build Status](https://img.shields.io/travis/cloudfoundry-incubator/bosh-workspace/master.svg?style=flat-square)](https://travis-ci.org/cloudfoundry-incubator/bosh-workspace) [![Test Coverage](https://img.shields.io/codeclimate/coverage/github/rkoster/bosh-workspace.svg?style=flat-square)](https://codeclimate.com/github/rkoster/bosh-workspace) [![Code Climate](https://img.shields.io/codeclimate/github/rkoster/bosh-workspace.svg?style=flat-square)](https://codeclimate.com/github/rkoster/bosh-workspace) [![Dependency Status](https://img.shields.io/gemnasium/cloudfoundry-incubator/bosh-workspace.svg?style=flat-square)](https://gemnasium.com/cloudfoundry-incubator/bosh-workspace) [![Stories in Ready](https://img.shields.io/badge/tracker-waffle.io-blue.svg?style=flat-square)](https://waffle.io/cloudfoundry-incubator/bosh-workspace)
 
 
 This is a `bosh` cli plugin for creating reproducible and upgradable deployments.
@@ -95,6 +95,35 @@ git add . && git commit -m "Added cf-warden deployment"
 Congratulations you should now have a running Cloud Foundry.
 For further reference on how to start using it go to the [bosh-lite documentation](https://github.com/cloudfoundry/bosh-lite#try-your-cloud-foundry-deployment).
 
+### Using private boshreleases
+When using a boshrelease from a location which requires authentication
+a `.credentials.yml` file is required, located at the root of your boshworkspace.
+Two types of authentication are supported: `username/password` and `sshkey`.
+
+Example `.credentials.yml` file:
+```yaml
+- url: https://github.com/example/top-secret-boshrelease.git
+  username: foo
+  password: bar
+- url: ssh://git@github.com/example/super-secret-boshrelease.git
+  private_key: |
+    -----BEGIN RSA PRIVATE KEY-----
+    MIICXAIBAAKBgQDHFr+KICms+tuT1OXJwhCUmR2dKVy7psa8xzElSyzqx7oJyfJ1
+    JZyOzToj9T5SfTIq396agbHJWVfYphNahvZ/7uMXqHxf+ZH9BL1gk9Y6kCnbM5R6
+    0gfwjyW1/dQPjOzn9N394zd2FJoFHwdq9Qs0wBugspULZVNRxq7veq/fzwIDAQAB
+    AoGBAJ8dRTQFhIllbHx4GLbpTQsWXJ6w4hZvskJKCLM/o8R4n+0W45pQ1xEiYKdA
+    Z/DRcnjltylRImBD8XuLL8iYOQSZXNMb1h3g5/UGbUXLmCgQLOUUlnYt34QOQm+0
+    KvUqfMSFBbKMsYBAoQmNdTHBaz3dZa8ON9hh/f5TT8u0OWNRAkEA5opzsIXv+52J
+    duc1VGyX3SwlxiE2dStW8wZqGiuLH142n6MKnkLU4ctNLiclw6BZePXFZYIK+AkE
+    xQ+k16je5QJBAN0TIKMPWIbbHVr5rkdUqOyezlFFWYOwnMmw/BKa1d3zp54VP/P8
+    +5aQ2d4sMoKEOfdWH7UqMe3FszfYFvSu5KMCQFMYeFaaEEP7Jn8rGzfQ5HQd44ek
+    lQJqmq6CE2BXbY/i34FuvPcKU70HEEygY6Y9d8J3o6zQ0K9SYNu+pcXt4lkCQA3h
+    jJQQe5uEGJTExqed7jllQ0khFJzLMx0K6tj0NeeIzAaGCQz13oo2sCdeGRHO4aDh
+    HH6Qlq/6UOV5wP8+GAcCQFgRCcB+hrje8hfEEefHcFpyKH+5g1Eu1k0mLrxK2zd+
+    4SlotYRHgPCEubokb2S1zfZDWIXW3HmggnGgM949TlY=
+    -----END RSA PRIVATE KEY-----
+```
+
 ## Experimental
 ### dns support
 Dns support can be enabled by adding a `domain_name` property to your deployment.

data/Rakefile

@@ -1,5 +1,56 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "archive/zip"
+require "rugged"
 
 task :default => :spec
 RSpec::Core::RakeTask.new
+
+namespace :git_assets do
+  desc "Extract git assets used in specs to tmp/git_assets"
+  task :extract do
+    FileUtils.rm_rf(tmp_workdir) if File.exist?(tmp_workdir)
+    git_spec_assets.each do |name, file|
+      target = File.join(tmp_workdir, name)
+      Dir.mktmpdir(name) do |tmp_dir|
+        Archive::Zip.extract(file, tmp_dir)
+        Rugged::Repository.clone_at(tmp_dir, target)
+      end
+      puts "Extracted #{name}.zip"
+    end
+    puts "All git assets have been extracted into: #{tmp_workdir}"
+  end
+
+  desc "Update git assets with changes made in tmp/git_assets"
+  task :update do
+    tmp_workdirs.each do |name, dir|
+      archive = File.join(git_spec_assets_dir, "#{name}.zip")
+      Archive::Zip.archive(archive, dir)
+      puts "Updated #{name}.zip"
+    end
+  end
+
+  def tmp_workdir
+    File.join(project_root, "tmp/git_assets")
+  end
+
+  def tmp_workdirs
+    Dir["#{tmp_workdir}/*"].map do |file|
+      [ File.basename(file, ".*"), File.join(file, ".git") ]
+    end.to_h
+  end
+
+  def git_spec_assets_dir
+    File.join(project_root, "spec/assets")
+  end
+
+  def git_spec_assets
+    Dir[File.join(git_spec_assets_dir, "/*repo*.zip")].map do |file|
+      [ File.basename(file, ".*"), file ]
+    end.to_h
+  end
+
+  def project_root
+    File.dirname(__FILE__)
+  end
+end

data/lib/bosh/workspace.rb

@@ -28,4 +28,5 @@ require "bosh/workspace/project_deployment"
 require "bosh/workspace/stub_file"
 require "bosh/workspace/deployment_patch"
 require "bosh/workspace/credentials"
+require "bosh/workspace/git_remote_url"
 require "bosh/workspace/version"

data/lib/bosh/workspace/git_remote_url.rb

@@ -0,0 +1,22 @@
+module Bosh::Workspace
+  class GitRemoteUrl
+    def initialize(url)
+      @url = url
+    end
+
+    def protocol()
+      case @url
+      when /^git:/
+        return :git
+      when /^https:/
+        return :https
+      when /^http:/
+        return :http
+      when /(@.+:|^ssh:)/
+        return :ssh
+      else
+        raise "Unsupported protocol for remote git url: #{@url}"
+      end
+    end
+  end
+end

data/lib/bosh/workspace/helpers/git_credentials_helper.rb

@@ -16,11 +16,13 @@ module Bosh::Workspace
     def fetch_and_checkout(repo)
       url = repo.remotes['origin'].url
       repo.fetch('origin', REFSPEC, connection_options_for(repo, url))
-      repo.checkout 'refs/remotes/origin/HEAD', strategy: :force
+      commit = repo.references['refs/remotes/origin/HEAD'].resolve.target_id
+      repo.checkout commit, strategy: :force
     end
 
     def connection_options_for(repo, url)
       return {} if check_connection(repo, url)
+      validate_url_protocol_support!(url)
 
       options = { credentials: require_credetials_for(url) }
       unless check_connection(repo, url, options)
@@ -67,6 +69,19 @@ module Bosh::Workspace
       end
     end
 
+    def validate_url_protocol_support!(url)
+      protocol = GitRemoteUrl.new(url).protocol
+      case protocol
+      when :git
+        err("Somthing is wrong, the git protocol does not support authentication")
+      when :https, :ssh
+        unless Rugged.features.include? protocol
+          say("Please reinstall Rugged gem with #{protocol} support: http://git.io/veiyJ")
+          err("Rugged requires #{protocol} support for: #{url}")
+        end
+      end
+    end
+
     def git_credentials_file
       File.join work_dir, '.credentials.yml'
     end

data/lib/bosh/workspace/release.rb

@@ -5,6 +5,7 @@ module Bosh::Workspace
     def initialize(release, releases_dir)
       @name = release["name"]
       @ref = release["ref"]
+      @path = release["path"]
       @spec_version = release["version"].to_s
       @git_url = release["git"]
       @repo_dir = File.join(releases_dir, @name)
@@ -46,7 +47,8 @@ module Bosh::Workspace
     end
 
     def releases_dir
-      new_style_repo ? "releases/#{@name}" : "releases"
+      dir = new_style_repo ? "releases/#{@name}" : "releases"
+      @path ? File.join(@path, dir) : dir
     end
 
     def releases_tree

data/lib/bosh/workspace/schemas/releases.rb

@@ -4,10 +4,11 @@ module Bosh::Workspace
       def validate(object)
         Membrane::SchemaParser.parse do
           [{
-            "name"          => String,
-            "version"       => ReleaseVersion.new,
-            optional("ref") => enum(String),
-            optional("git") => String,
+            "name"           => String,
+            "version"        => ReleaseVersion.new,
+            optional("path") => enum(String),
+            optional("ref")  => enum(String),
+            optional("git")  => String,
           }]
         end.validate object
       end

data/lib/bosh/workspace/version.rb

@@ -1,5 +1,5 @@
 module Bosh
   module Manifests
-    VERSION = "0.9.0.rc3"
+    VERSION = "0.9.0.rc4"
   end
 end

data/spec/git_remote_url_spec.rb

@@ -0,0 +1,39 @@
+module Bosh::Workspace
+  describe GitRemoteUrl do
+    describe '.protocol' do
+      subject { GitRemoteUrl.new(url) }
+
+      context 'git protocol' do
+        let(:url) { "git://example.com/foo" }
+        its(:protocol) { is_expected.to eq(:git) }
+      end
+
+      context 'https protocol' do
+        let(:url) { "https://example.com/foo" }
+        its(:protocol) { is_expected.to eq(:https) }
+      end
+
+      context 'http protocol' do
+        let(:url) { "http://example.com/foo" }
+        its(:protocol) { is_expected.to eq(:http) }
+      end
+
+      context 'ssh protocol style 1' do
+        let(:url) { "foo@example.com:foo" }
+        its(:protocol) { is_expected.to eq(:ssh) }
+      end
+
+      context 'ssh protocol style 2' do
+        let(:url) { "ssh://foo@example.com/foo" }
+        its(:protocol) { is_expected.to eq(:ssh) }
+      end
+
+      context 'unsupported protocol' do
+        let(:url) { "foo://foo@example.com/foo" }
+        it 'raises' do
+          expect { subject.protocol() }.to raise_error /unsupported protocol/i
+        end
+      end
+    end
+  end
+end

data/spec/helpers/git_credentials_helper_spec.rb

@@ -15,6 +15,8 @@ module Bosh::Workspace
     let(:dir) { File.join(work_dir, '.releases', 'foo') }
     let(:repo) { instance_double 'Rugged::Repository' }
     let(:remote) { instance_double 'Rugged::Remote', url: url }
+    let(:protocol) { :http }
+    let(:git_url) { instance_double 'GitRemoteURL', protocol: protocol }
 
     before do
       allow(Rugged::Repository).to receive(:new).with(dir).and_return(repo)
@@ -22,9 +24,12 @@ module Bosh::Workspace
       allow(repo).to receive_message_chain("remotes.[]").and_return(remote)
       allow(repo).to receive_message_chain("remotes.create_anonymous")
         .with(url).and_return(remote)
+      allow(repo).to receive_message_chain("references.[].resolve.target_id")
+        .and_return(:commit_id)
       allow(remote).to receive(:check_connection).with(:fetch, Hash)
         .and_return(!auth_required, credentials_auth_valid)
-      allow(repo).to receive(:checkout).with(/origin\/HEAD/, strategy: :force)
+      allow(repo).to receive(:checkout).with(:commit_id, strategy: :force)
+      allow(GitRemoteUrl).to receive(:new).and_return(git_url)
     end
 
     def expect_no_credentials
@@ -95,6 +100,26 @@ module Bosh::Workspace
             .with(url).and_return(creds_hash)
         end
 
+        context "without supported protocol" do
+          before do
+            expect(Rugged).to receive(:features).and_return([])
+          end
+
+          let(:protocol) { :https }
+
+          it "raises" do
+            expect { subject }.to raise_error /rugged requires https/i
+          end
+        end
+
+        context "with git protocol" do
+          let(:protocol) { :git }
+
+          it "raises" do
+            expect { subject }.to raise_error /not support authentication/i
+          end
+        end
+
         context "with sshkey" do
           let(:creds_hash) { { private_key: "foobarkey" } }
 

data/spec/release_spec.rb

@@ -18,7 +18,6 @@ describe Bosh::Workspace::Release do
 
     describe "#update_repo" do
       subject do
-        # puts `cd #{File.join(releases_dir, name)} && git checkout origin/HEAD && git log`
         Dir[File.join(releases_dir, name, "releases/**/foo*.yml")].to_s
       end
 
@@ -258,4 +257,41 @@ describe Bosh::Workspace::Release do
       its(:version) { should eq version.to_s }
     end
   end
+
+  context "given a release which is located in a subfolder" do
+    let(:repo) { extracted_asset_dir("foo", "foo-boshrelease-repo-subdir.zip") }
+    let(:release_data) do
+      { "name" => name, "version" => version, "git" => repo, "path" => "release"  }
+    end
+
+    describe "#update_repo" do
+      subject do
+        Dir[File.join(releases_dir, name, "release/releases/**/*.yml")].to_s
+      end
+
+      context "latest version" do
+        before { release.update_repo }
+
+        let(:version) { "latest" }
+
+        it "checks out repo" do
+          expect(subject).to match(/release\/releases\/foo-12.yml/)
+        end
+      end
+    end
+
+    describe "attributes" do
+      let(:version) { "12" }
+      subject { release }
+      its(:name) { should eq name }
+      its(:git_url) { should eq repo }
+      its(:repo_dir) { should match(/\/#{name}$/) }
+      its(:manifest) { should match "release/releases/#{name}-#{version}.yml$" }
+      its(:name_version) { should eq "#{name}/#{version}" }
+      its(:version) { should eq version }
+      its(:manifest_file) do
+        should match(/\/release\/releases\/#{name}-#{version}.yml$/)
+      end
+    end
+  end
 end

data/spec/schemas/releases_spec.rb

@@ -1,7 +1,13 @@
 module Bosh::Workspace::Schemas
   describe Releases do
     let(:release) do
-      {"name" => "foo", "version" => 1, "ref" => "cec3ec1", "git" => "example.com/git.git"}
+      {
+        "name" => "foo",
+        "version" => 1,
+        "path" => "release",
+        "ref" => "cec3ec1",
+        "git" => "example.com/git.git"
+      }
     end
 
     subject { Releases.new.validate(releases) }
@@ -32,5 +38,10 @@ module Bosh::Workspace::Schemas
       let(:releases) { [release.delete_if { |k| k == "git" }] }
       it { expect { subject }.to_not raise_error }
     end
+
+    context "optional git" do
+      let(:releases) { [release.delete_if { |k| k == "path" }] }
+      it { expect { subject }.to_not raise_error }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bosh-workspace
 version: !ruby/object:Gem::Version
-  version: 0.9.0.rc3
+  version: 0.9.0.rc4
 platform: ruby
 authors:
 - Ruben Koster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-01 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bosh_cli
@@ -188,6 +188,7 @@ files:
 - lib/bosh/workspace.rb
 - lib/bosh/workspace/credentials.rb
 - lib/bosh/workspace/deployment_patch.rb
+- lib/bosh/workspace/git_remote_url.rb
 - lib/bosh/workspace/helpers/dns_helper.rb
 - lib/bosh/workspace/helpers/git_credentials_helper.rb
 - lib/bosh/workspace/helpers/project_deployment_helper.rb
@@ -218,6 +219,7 @@ files:
 - spec/assets/dns/properties.yml
 - spec/assets/empty-manifests-repo/.keep
 - spec/assets/foo-boshrelease-repo-new-structure.zip
+- spec/assets/foo-boshrelease-repo-subdir.zip
 - spec/assets/foo-boshrelease-repo-updated.zip
 - spec/assets/foo-boshrelease-repo.zip
 - spec/assets/foo-boshworkspace.zip
@@ -230,6 +232,7 @@ files:
 - spec/commands/project_deployment_spec.rb
 - spec/credentials_spec.rb
 - spec/deployment_patch_spec.rb
+- spec/git_remote_url_spec.rb
 - spec/helpers/dns_helper_spec.rb
 - spec/helpers/git_credentials_helper_spec.rb
 - spec/helpers/project_deployment_helper_spec.rb
@@ -285,6 +288,7 @@ test_files:
 - spec/assets/dns/properties.yml
 - spec/assets/empty-manifests-repo/.keep
 - spec/assets/foo-boshrelease-repo-new-structure.zip
+- spec/assets/foo-boshrelease-repo-subdir.zip
 - spec/assets/foo-boshrelease-repo-updated.zip
 - spec/assets/foo-boshrelease-repo.zip
 - spec/assets/foo-boshworkspace.zip
@@ -297,6 +301,7 @@ test_files:
 - spec/commands/project_deployment_spec.rb
 - spec/credentials_spec.rb
 - spec/deployment_patch_spec.rb
+- spec/git_remote_url_spec.rb
 - spec/helpers/dns_helper_spec.rb
 - spec/helpers/git_credentials_helper_spec.rb
 - spec/helpers/project_deployment_helper_spec.rb