poise-git 1.0.0

data/test/gemfiles/master.gemfile

@@ -0,0 +1,25 @@
+#
+# Copyright 2015-2017, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+eval_gemfile File.expand_path('../../../Gemfile', __FILE__)
+
+gem 'chef', github: 'chef/chef'
+gem 'halite', github: 'poise/halite'
+gem 'ohai', github: 'chef/ohai'
+gem 'poise', github: 'poise/poise'
+gem 'poise-boiler', github: 'poise/poise-boiler'
+gem 'poise-languages', github: 'poise/poise-languages'
+gem 'poise-profiler', github: 'poise/poise-profiler'

data/test/integration/default/serverspec/default_spec.rb

@@ -0,0 +1,49 @@
+#
+# Copyright 2017, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'serverspec'
+set :backend, :exec
+
+describe file('/test1/README.md') do
+  it { is_expected.to be_a_file }
+  its(:content) { is_expected.to include('repo=test_repo') }
+  its(:content) { is_expected.to include('branch=master') }
+end
+
+describe file('/test2/README.md') do
+  it { is_expected.to be_a_file }
+  its(:content) { is_expected.to include('repo=test_repo') }
+  its(:content) { is_expected.to include('branch=release') }
+end
+
+describe file('/test3/README.md') do
+  it { is_expected.to be_a_file }
+  its(:content) { is_expected.to include('repo=private_test_repo') }
+  its(:content) { is_expected.to include('branch=master') }
+end
+
+describe file('/test4/README.md') do
+  it { is_expected.to be_a_file }
+  its(:content) { is_expected.to include('repo=private_test_repo') }
+  its(:content) { is_expected.to include('branch=release') }
+end
+
+describe file('/test5/README.md') do
+  it { is_expected.to be_a_file }
+  it { is_expected.to be_owned_by('poise') }
+  its(:content) { is_expected.to include('repo=private_test_repo') }
+  its(:content) { is_expected.to include('branch=master') }
+end

data/test/spec/git_client_providers/dummy_spec.rb

@@ -0,0 +1,76 @@
+#
+# Copyright 2017, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe PoiseGit::GitClientProviders::Dummy do
+  let(:git_client_resource) { chef_run.poise_git_client('test') }
+  step_into(:poise_git_client)
+  recipe do
+    poise_git_client 'test' do
+      provider :dummy
+    end
+  end
+
+  describe '#git_binary' do
+    subject { git_client_resource.git_binary }
+
+    it { is_expected.to eq '/git' }
+
+    context 'with an option override' do
+      before do
+        override_attributes['poise-git'] ||= {}
+        override_attributes['poise-git']['test'] ||= {}
+        override_attributes['poise-git']['test']['git_binary'] = '/other'
+      end
+
+      it { is_expected.to eq '/other' }
+    end # /context with an option override
+  end # /describe #git_binary
+
+  describe '#git_environment' do
+    subject { git_client_resource.git_environment }
+
+    it { is_expected.to eq({}) }
+
+    context 'with an option override' do
+      before do
+        override_attributes['poise-git'] ||= {}
+        override_attributes['poise-git']['test'] ||= {}
+        override_attributes['poise-git']['test']['git_environment'] = {'FOO' => 'BAR'}
+      end
+
+      it { is_expected.to eq({'FOO' => 'BAR'}) }
+    end # /context with an option override
+  end # /describe #git_environment
+
+  describe 'action :install' do
+    # Just make sure it doesn't error.
+    it { run_chef }
+  end # /describe action :install
+
+  describe 'action :uninstall' do
+    recipe do
+      poise_git_client 'test' do
+        action :uninstall
+        provider :dummy
+      end
+    end
+
+    # Just make sure it doesn't error.
+    it { run_chef }
+  end # /describe action :uninstall
+end

data/test/spec/git_client_providers/system_spec.rb

@@ -0,0 +1,64 @@
+#
+# Copyright 2017, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe PoiseGit::GitClientProviders::System do
+  let(:git_client_resource) { chef_run.poise_git_client('git') }
+  step_into(:poise_git_client)
+  recipe do
+    poise_git_client 'git' do
+      provider :system
+    end
+  end
+
+  shared_examples_for 'system provider' do |pkg='git'|
+    it { expect(git_client_resource.provider_for_action(:install)).to be_a described_class }
+    it { is_expected.to install_poise_languages_system(pkg).with(dev_package: false) }
+  end
+
+  context 'on Ubuntu' do
+    let(:chefspec_options) { {platform: 'ubuntu', version: '16.04'} }
+    it_behaves_like 'system provider'
+  end # /context on Ubuntu
+
+  context 'on CentOS' do
+    let(:chefspec_options) { {platform: 'centos', version: '7.0'} }
+    it_behaves_like 'system provider'
+  end # /context on CentOS
+
+  context 'on OmniOS' do
+    let(:chefspec_options) { {platform: 'omnios', version: '151018'} }
+    it_behaves_like 'system provider', 'developer/versioning/git'
+  end # /context on OmniOS
+
+  context 'on SmartOS' do
+    let(:chefspec_options) { {platform: 'smartos', version: '5.11'} }
+    it_behaves_like 'system provider', 'scmgit'
+  end # /context on SmartOS
+
+  context 'action :uninstall' do
+    recipe do
+      poise_git_client 'git' do
+        action :uninstall
+        provider :system
+      end
+    end
+
+    it { expect(git_client_resource.provider_for_action(:uninstall)).to be_a described_class }
+    it { is_expected.to uninstall_poise_languages_system('git').with(dev_package: false) }
+  end # /context action :uninstall
+end

data/test/spec/recipe_spec.rb

@@ -0,0 +1,35 @@
+#
+# Copyright 2017, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe 'poise-git::default' do
+  recipe { include_recipe 'poise-git' }
+
+  context 'with defaults' do
+    it { is_expected.to install_poise_git_client('git').with(version: '') }
+  end # /context with defaults
+
+  context 'with attributes' do
+    before do
+      override_attributes['poise-git'] = {}
+      override_attributes['poise-git']['recipe'] = {}
+      override_attributes['poise-git']['recipe']['version'] = '1.2.3'
+    end
+
+    it { is_expected.to install_poise_git_client('git').with(version: '1.2.3') }
+  end # /context with attributes
+end

data/test/spec/resources/poise_git_client.rb

@@ -0,0 +1,64 @@
+#
+# Copyright 2017, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe PoiseGit::Resources::PoiseGitClient do
+  before do
+    override_attributes['poise-git'] ||= {}
+    override_attributes['poise-git']['provider'] = 'dummy'
+  end
+
+  context 'with an empty name' do
+    recipe do
+      poise_git_client ''
+    end
+
+    it { is_expected.to install_poise_git_client('').with(version: '') }
+  end # /context with an empty name
+
+  context 'with name git' do
+    recipe do
+      poise_git_client 'git'
+    end
+
+    it { is_expected.to install_poise_git_client('git').with(version: '') }
+  end # /context with name git
+
+  context 'with name 1.2.3' do
+    recipe do
+      poise_git_client '1.2.3'
+    end
+
+    it { is_expected.to install_poise_git_client('1.2.3').with(version: '1.2.3') }
+  end # /context with name 1.2.3
+
+  context 'with name git-1.2.3' do
+    recipe do
+      poise_git_client 'git-1.2.3'
+    end
+
+    it { is_expected.to install_poise_git_client('git-1.2.3').with(version: '1.2.3') }
+  end # /context with name git-1.2.3
+
+  context 'with name git1.2.3' do
+    recipe do
+      poise_git_client 'git1.2.3'
+    end
+
+    it { is_expected.to install_poise_git_client('git1.2.3').with(version: '1.2.3') }
+  end # /context with name git1.2.3
+end

data/test/spec/resources/poise_git_spec.rb

@@ -0,0 +1,153 @@
+#
+# Copyright 2017, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe PoiseGit::Resources::PoiseGit do
+  step_into(:poise_git)
+  before do
+    override_attributes['poise-git'] ||= {}
+    override_attributes['poise-git']['provider'] = 'dummy'
+  end
+
+  before do
+    # Don't actually run the real thing
+    allow_any_instance_of(described_class::Provider).to receive(:action_sync).and_return(nil)
+  end
+
+  def cache_path(path)
+    "#{Chef::Config[:file_cache_path]}/#{path}"
+  end
+
+  context 'with defaults' do
+    recipe do
+      poise_git_client 'git'
+      poise_git '/test' do
+        repository 'https://example.com/test.git'
+        revision 'd44ec06d0b2a87732e91c005ed2048c824fd63ed'
+      end
+    end
+
+    it { is_expected.to_not render_file(cache_path('poise_git_deploy_2089348824')) }
+    it { is_expected.to_not render_file(cache_path('poise_git_wrapper_2089348824')) }
+  end # /context with defaults
+
+  context 'with in-line deploy key' do
+    recipe do
+      poise_git_client 'git'
+      poise_git '/test' do
+        repository 'https://example.com/test.git'
+        revision 'd44ec06d0b2a87732e91c005ed2048c824fd63ed'
+        deploy_key 'secretkey'
+      end
+    end
+
+    it { is_expected.to render_file(cache_path('poise_git_deploy_2089348824')).with_content('secretkey') }
+    it { is_expected.to render_file(cache_path('poise_git_wrapper_2089348824')).with_content(%Q{#!/bin/sh\n/usr/bin/env ssh -o "StrictHostKeyChecking=no" -i "#{cache_path('poise_git_deploy_2089348824')}" $@\n}) }
+    it { expect(chef_run.poise_git('/test').to_text).to include 'deploy_key "suppressed sensitive value"' }
+  end # /context with in-line deploy key
+
+  context 'with in-line deploy key with embedded newlines' do
+    # Reversion test for a weird bug that only triggers on SSH keys that have a
+    # line starting with /.
+    recipe do
+      poise_git_client 'git'
+      poise_git '/test' do
+        repository 'https://example.com/test.git'
+        revision 'd44ec06d0b2a87732e91c005ed2048c824fd63ed'
+        deploy_key "secretkey\n/foo"
+      end
+    end
+
+    it { is_expected.to render_file(cache_path('poise_git_deploy_2089348824')).with_content("secretkey\n/foo") }
+    it { is_expected.to render_file(cache_path('poise_git_wrapper_2089348824')).with_content(%Q{#!/bin/sh\n/usr/bin/env ssh -o "StrictHostKeyChecking=no" -i "#{cache_path('poise_git_deploy_2089348824')}" $@\n}) }
+    it { expect(chef_run.poise_git('/test').to_text).to include 'deploy_key "suppressed sensitive value"' }
+  end # /context with in-line deploy key with embedded newlines
+
+  context 'with path deploy key' do
+    recipe do
+      poise_git_client 'git'
+      poise_git '/test' do
+        repository 'https://example.com/test.git'
+        revision 'd44ec06d0b2a87732e91c005ed2048c824fd63ed'
+        deploy_key '/mykey'
+      end
+    end
+
+    it { is_expected.to_not render_file(cache_path('poise_git_deploy_2089348824')) }
+    it { is_expected.to render_file(cache_path('poise_git_wrapper_2089348824')).with_content(%Q{#!/bin/sh\n/usr/bin/env ssh -o "StrictHostKeyChecking=no" -i "/mykey" $@\n}) }
+    it { expect(chef_run.poise_git('/test').to_text).to include 'deploy_key "/mykey"' }
+  end # /context with path deploy key
+
+  context 'with path deploy key on Windows' do
+    recipe do
+      poise_git_client 'git'
+      poise_git '/test' do
+        repository 'https://example.com/test.git'
+        revision 'd44ec06d0b2a87732e91c005ed2048c824fd63ed'
+        deploy_key 'C:\\mykey'
+      end
+    end
+
+    it { is_expected.to_not render_file(cache_path('poise_git_deploy_2089348824')) }
+    it { is_expected.to render_file(cache_path('poise_git_wrapper_2089348824')).with_content(%Q{#!/bin/sh\n/usr/bin/env ssh -o "StrictHostKeyChecking=no" -i "C:\\mykey" $@\n}) }
+    it { expect(chef_run.poise_git('/test').to_text).to include 'deploy_key "C:\\\\mykey"' }
+  end # /context with path deploy key on Windows
+
+  context 'with strict SSH' do
+    recipe do
+      poise_git_client 'git'
+      poise_git '/test' do
+        repository 'https://example.com/test.git'
+        revision 'd44ec06d0b2a87732e91c005ed2048c824fd63ed'
+        deploy_key 'secretkey'
+        strict_ssh true
+      end
+    end
+
+    it { is_expected.to render_file(cache_path('poise_git_deploy_2089348824')).with_content('secretkey') }
+    it { is_expected.to render_file(cache_path('poise_git_wrapper_2089348824')).with_content(%Q{#!/bin/sh\n/usr/bin/env ssh -i "#{cache_path('poise_git_deploy_2089348824')}" $@\n}) }
+    it { expect(chef_run.poise_git('/test').to_text).to include 'deploy_key "suppressed sensitive value"' }
+  end # /context with strict SSH
+
+  context 'with no parent' do
+    recipe do
+      poise_git '/test' do
+        repository 'https://example.com/test.git'
+        revision 'd44ec06d0b2a87732e91c005ed2048c824fd63ed'
+      end
+    end
+
+    it { is_expected.to install_poise_git_client('git') }
+  end # /context with no parent
+
+  context 'without an explicit revision' do
+    # This test confirms the execution plumbing is working because
+    # load_current_resource will try to ls-remote.
+    recipe do
+      poise_git_client 'git'
+      poise_git '/test' do
+        repository 'https://example.com/test.git'
+      end
+    end
+
+    it do
+      fake_cmd = double(error!: nil, stdout: "d44ec06d0b2a87732e91c005ed2048c824fd63ed\tHEAD\n")
+      expect_any_instance_of(described_class::Provider).to receive(:poise_shell_out).with(%w{/git ls-remote https://example.com/test.git HEAD}, kind_of(Hash)).and_return(fake_cmd)
+      run_chef
+    end
+  end # /context without an explicit revision
+end