poise-git 1.0.0

data/Rakefile

@@ -0,0 +1,17 @@
+#
+# 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.
+#
+
+require 'poise_boiler/rakefile'

data/chef/attributes/default.rb

@@ -0,0 +1,26 @@
+#
+# 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.
+#
+
+# Default recipe to use to install git.
+default['poise-git']['default_recipe'] = 'poise-git'
+
+# Default inversion options.
+default['poise-git']['provider'] = 'auto'
+default['poise-git']['options'] = {}
+
+# Attributes for recipe[poise-git]. All values are nil because the actual
+# defaults live in the resource.
+default['poise-git']['recipe']['version'] = nil

data/chef/recipes/default.rb

@@ -0,0 +1,22 @@
+#
+# 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.
+#
+
+poise_git_client 'git' do
+  node['poise-git']['recipe'].each do |key, value|
+    # Skip nils, use false if you want to disable something.
+    send(key, value) unless value.nil?
+  end
+end

data/lib/poise_git.rb

@@ -0,0 +1,24 @@
+#
+# 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.
+#
+
+
+module PoiseGit
+  autoload :GitClientProviders, 'poise_git/git_client_providers'
+  autoload :GitCommandMixin, 'poise_git/git_command_mixin'
+  autoload :Resources, 'poise_git/resources'
+  autoload :SafeString, 'poise_git/safe_string'
+  autoload :VERSION, 'poise_git/version'
+end

data/lib/poise_git/cheftie.rb

@@ -0,0 +1,18 @@
+#
+# 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 'poise_git/resources'
+require 'poise_git/git_client_providers'

data/lib/poise_git/git_client_providers.rb

@@ -0,0 +1,36 @@
+#
+# 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 'chef/platform/provider_priority_map'
+
+require 'poise_git/git_client_providers/dummy'
+require 'poise_git/git_client_providers/system'
+
+
+module PoiseGit
+  # Inversion providers for the poise_git resource.
+  #
+  # @since 1.0.0
+  module GitClientProviders
+    autoload :Base, 'poise_git/git_client_providers/base'
+
+    # Set up priority maps
+    Chef::Platform::ProviderPriorityMap.instance.priority(:poise_git_client, [
+      PoiseGit::GitClientProviders::Dummy,
+      PoiseGit::GitClientProviders::System,
+    ])
+  end
+end

data/lib/poise_git/git_client_providers/base.rb

@@ -0,0 +1,93 @@
+#
+# 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 'chef/provider'
+require 'poise'
+
+
+module PoiseGit
+  module GitClientProviders
+    # The provider base class for `poise_git_client`.
+    #
+    # @see PoiseGit::Resources::PoiseGitClient::Resource
+    # @provides poise_git_client
+    class Base < Chef::Provider
+      include Poise(inversion: :poise_git_client)
+      provides(:poise_git_client)
+
+      # Set default inversion options.
+      #
+      # @api private
+      def self.default_inversion_options(node, new_resource)
+        super.merge({
+          version: new_resource.version,
+        })
+      end
+
+      # The `install` action for the `poise_git_client` resource.
+      #
+      # @return [void]
+      def action_install
+        notifying_block do
+          install_git
+        end
+      end
+
+      # The `uninstall` action for the `poise_git_client` resource.
+      #
+      # @return [void]
+      def action_uninstall
+        notifying_block do
+          uninstall_git
+        end
+      end
+
+      # The path to the `git` binary. This is an output property.
+      #
+      # @abstract
+      # @return [String]
+      def git_binary
+        raise NotImplementedError
+      end
+
+      # The environment variables for this Git. This is an output property.
+      #
+      # @return [Hash<String, String>]
+      def git_environment
+        {}
+      end
+
+      private
+
+      # Install git.
+      #
+      # @abstract
+      # @return [void]
+      def install_git
+        raise NotImplementedError
+      end
+
+      # Uninstall git.
+      #
+      # @abstract
+      # @return [void]
+      def uninstall_git
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/poise_git/git_client_providers/dummy.rb

@@ -0,0 +1,79 @@
+#
+# 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 'poise_git/git_client_providers/base'
+
+
+module PoiseGit
+  module GitClientProviders
+    # Inversion provider for the `poise_git_client` resource to use a fake Git,
+    # for use in unit tests.
+    #
+    # @since 1.0.0
+    # @see PoiseGit::Resources::PoiseGitClient::Resource
+    # @provides poise_git_client
+    class Dummy < Base
+      provides(:dummy)
+
+      # Enable by default on ChefSpec.
+      #
+      # @api private
+      def self.provides_auto?(node, _resource)
+        node.platform?('chefspec')
+      end
+
+      # Manual overrides for dummy data.
+      #
+      # @api private
+      def self.default_inversion_options(node, resource)
+        super.merge({
+          git_binary: '/git',
+          git_environment: nil,
+        })
+      end
+
+      # The `install` action for the `poise_git_client` resource.
+      #
+      # @return [void]
+      def action_install
+        # This space left intentionally blank.
+      end
+
+      # The `uninstall` action for the `poise_git_client` resource.
+      #
+      # @return [void]
+      def action_uninstall
+        # This space left intentionally blank.
+      end
+
+      # Path to the non-existent Git.
+      #
+      # @return [String]
+      def git_binary
+        options['git_binary']
+      end
+
+      # Environment for the non-existent Git.
+      #
+      # @return [String]
+      def git_environment
+        options['git_environment'] || super
+      end
+
+    end
+  end
+end
+

data/lib/poise_git/git_client_providers/system.rb

@@ -0,0 +1,73 @@
+#
+# 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 'poise_languages'
+
+require 'poise_git/git_client_providers/base'
+
+
+module PoiseGit
+  module GitClientProviders
+    # A provider for `poise_git_client` to install from distro packages.
+    #
+    # @since 1.0.0
+    # @see PoiseGit::Resources::PoiseGitClient::Resource
+    # @provides poise_git_client
+    class System < Base
+      include PoiseLanguages::System::Mixin
+      provides(:system)
+      packages('git', {
+        omnios: {default: %w{developer/versioning/git}},
+        smartos: {default: %w{scmgit}},
+      })
+
+      # Output value for the Git binary we are installing.
+      def git_binary
+        # What should this be for OmniOS and SmartOS?
+        "/usr/bin/git"
+      end
+
+      private
+
+      # Install git from system packages.
+      #
+      # @return [void]
+      def install_git
+        install_system_packages do
+          # Unlike language-ish packages, we don't need a headers package.
+          dev_package false
+        end
+      end
+
+      # Remove git from system packages.
+      #
+      # @return [void]
+      def uninstall_git
+        uninstall_system_packages do
+          # Unlike language-ish packages, we don't need a headers package.
+          dev_package false
+        end
+      end
+
+      def system_package_candidates(version)
+        # This is kind of silly, could use a refactor in the mixin but just
+        # moving on for right now.
+        node.value_for_platform(self.class.packages) || %w{git}
+      end
+
+    end
+  end
+end

data/lib/poise_git/git_command_mixin.rb

@@ -0,0 +1,37 @@
+#
+# 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 'poise/utils'
+require 'poise_languages'
+
+
+module PoiseGit
+  # Mixin for resources and providers which run Git commands.
+  #
+  # @since 1.0.0
+  module GitCommandMixin
+    include Poise::Utils::ResourceProviderMixin
+
+    # Mixin for resources which run Git commands.
+    module Resource
+      include PoiseLanguages::Command::Mixin::Resource(:git, runtime: :poise_git_client)
+    end
+
+    module Provider
+      include PoiseLanguages::Command::Mixin::Provider(:git)
+    end
+  end
+end

data/lib/poise_git/resources.rb

@@ -0,0 +1,27 @@
+#
+# 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 'poise_git/resources/poise_git_client'
+require 'poise_git/resources/poise_git'
+
+
+module PoiseGit
+  # Chef resources and providers for poise-git.
+  #
+  # @since 1.0.0
+  module Resources
+  end
+end