poise-archive 1.0.0

data/lib/poise_archive/archive_providers/tar.rb

@@ -0,0 +1,121 @@
+#
+# Copyright 2016, 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 'fileutils'
+require 'tmpdir'
+
+require 'poise_archive/archive_providers/base'
+
+
+module PoiseArchive
+  module ArchiveProviders
+    # The `tar` provider class for `poise_archive` to install from TAR archives.
+    #
+    # @see PoiseArchive::Resources::PoiseArchive::Resource
+    # @provides poise_archive
+    class Tar < Base
+      provides_extension(/\.t(ar|gz|bz|xz)/)
+
+      private
+
+      def unpack_archive
+        notifying_block do
+          install_prereqs
+        end
+        unpack_tar
+      end
+
+      # Install any needed prereqs.
+      #
+      # @return [void]
+      def install_prereqs
+        # Various platforms that either already come with tar or that we don't
+        # want to try installing it on yet (read: Windows). This is mostly here
+        # for minimalist Linux container images, most normal Linux servers have
+        # all of these already.
+        return if node.platform_family?('windows', 'mac_os_x', 'aix', 'solaris2')
+        utils = ['tar']
+        utils << 'bzip2' if new_resource.path =~ /\.t?bz/
+        utils << 'xz-utils' if new_resource.path =~ /\.t?xz/
+        package utils
+      end
+
+      # Unpack the archive and process `strip_components`.
+      #
+      # @return [void]
+      def unpack_tar
+        # Build the tar command. -J for xz isn't going to work on non-GNU tar,
+        # cry me a river.
+        cmd = %w{tar}
+        cmd << if new_resource.path =~ /\.t?gz/
+          '-xzvf'
+        elsif new_resource.path =~ /\.t?bz/
+          '-xjvf'
+        elsif new_resource.path =~ /\.t?xz/
+          '-xJvf'
+        else
+          '-xvf'
+        end
+        cmd << new_resource.path
+
+        # Create a temp directory to unpack in to. Do I want to try and force
+        # this to be on the same filesystem as the target?
+        self.class.mktmpdir do |dir|
+          # Change the temp dir to be owned by the unpack user if needed.
+          FileUtils.chown(new_resource.user, new_resource.group, dir) if new_resource.user || new_resource.group
+
+          # Run the unpack into the temp dir.
+          poise_shell_out!(cmd, cwd: dir, group: new_resource.group, user: new_resource.user)
+
+          # Re-implementation of the logic for tar --strip-components because
+          # that option isn't part of non-GNU tar (read: Solaris and AIX).
+          entries_at_depth(dir, new_resource.strip_components).each do |source|
+            # At some point this might need to fall back to a real copy.
+            ::File.rename(source, ::File.join(new_resource.absolute_destination, ::File.basename(source)))
+          end
+        end
+      end
+
+      # Find the absolute paths for entries under a path at a depth.
+      #
+      # @param path [String] Base path to search under.
+      # @param depth [Integer] Number of intermediary directories to skip.
+      # @return [Array<String>]
+      def entries_at_depth(path, depth)
+        entries = [path]
+        current_depth = 0
+        while current_depth <= depth
+          entries.map! do |ent|
+            if ::File.directory?(ent)
+              Dir.entries(ent).select {|e| e != '.' && e != '..' }.map {|e| ::File.join(ent, e) }
+            else
+              []
+            end
+          end
+          entries.flatten!
+          current_depth += 1
+        end
+        entries
+      end
+
+      # Indirection so I can stub this for testing without breaking RSpec.
+      def self.mktmpdir(*args, &block)
+        Dir.mktmpdir(*args, &block)
+      end
+
+    end
+  end
+end

data/lib/poise_archive/archive_providers/zip.rb

@@ -0,0 +1,30 @@
+#
+# Copyright 2016, 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_archive/archive_providers/base'
+
+
+module PoiseArchive
+  module ArchiveProviders
+    # The `zip` provider class for `poise_archive` to install from ZIP archives.
+    #
+    # @see PoiseArchive::Resources::PoiseArchive::Resource
+    # @provides poise_archive
+    class Zip < Base
+      provides_extension(/\.zip$/)
+    end
+  end
+end

data/lib/poise_archive/archive_providers.rb

@@ -0,0 +1,34 @@
+#
+# Copyright 2016, 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_archive/archive_providers/tar'
+require 'poise_archive/archive_providers/zip'
+
+
+module PoiseArchive
+  # Providers for the poise_archive resource.
+  #
+  # @since 1.0.0
+  module ArchiveProviders
+    # Set up priority maps
+    Chef::Platform::ProviderPriorityMap.instance.priority(:poise_archive, [
+      PoiseArchive::ArchiveProviders::Tar,
+      PoiseArchive::ArchiveProviders::Zip,
+    ])
+  end
+end

data/lib/poise_archive/cheftie.rb

@@ -0,0 +1,18 @@
+#
+# Copyright 2016, 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_archive/resources'
+require 'poise_archive/archive_providers'

data/lib/poise_archive/resources/poise_archive.rb

@@ -0,0 +1,80 @@
+#
+# Copyright 2016, 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/resource'
+require 'poise'
+
+
+module PoiseArchive
+  module Resources
+    # (see PoiseArchive::Resource)
+    # @since 1.0.0
+    module PoiseArchive
+      # A `poise_archive` resource to unpack archives.
+      #
+      # @provides poise_archive
+      # @action unpack
+      # @example
+      #   poise_archive '/opt/myapp.tgz'
+      class Resource < Chef::Resource
+        include Poise
+        provides(:poise_archive)
+        actions(:unpack)
+
+        # @!attribute path
+        #   Path to the archive. If relative, it is taken as a file inside
+        #   `Chef::Config[:file_cache_path]`.
+        #   @return [String]
+        attribute(:path, kind_of: String, name_attribute: true)
+        # @!attribute destination
+        #   Path to unpack the archive to. If not specified, the path of the
+        #   archive without the file extension is used.
+        #   @return [String, nil, false]
+        attribute(:destination, kind_of: [String, NilClass, FalseClass])
+        # @!attribute group
+        #   Group to run the unpack as.
+        #   @return [String, Integer, nil, false]
+        attribute(:group, kind_of: [String, Integer, NilClass, FalseClass])
+        # @!attribute keep_existing
+        #   Keep existing files in the destination directory when unpacking.
+        #   @return [Boolean]
+        attribute(:keep_existing, equal_to: [true, false], default: false)
+        # @!attribute strip_components
+        #   Number of intermediary directories to skip when unpacking. Works
+        #   like GNU tar's --strip-components.
+        #   @return [Integer]
+        attribute(:strip_components, kind_of: Integer, default: 1)
+        # @!attribute group
+        #   User to run the unpack as.
+        #   @return [String, Integer, nil, false]
+        attribute(:user, kind_of: [String, Integer, NilClass, FalseClass])
+
+        def absolute_path
+          ::File.expand_path(path, Chef::Config[:file_cache_path])
+        end
+
+        def absolute_destination
+          destination || begin
+            basename = ::File.basename(path)
+            ::File.join(::File.dirname(absolute_path), basename.split(/\./).find {|part| !part.empty? } || basename)
+          end
+        end
+      end
+
+      # Providers can be found in archive_providers/.
+    end
+  end
+end

data/lib/poise_archive/resources.rb

@@ -0,0 +1,26 @@
+#
+# Copyright 2016, 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_archive/resources/poise_archive'
+
+
+module PoiseArchive
+  # Chef resources and providers for poise-archive.
+  #
+  # @since 1.0.0
+  module Resources
+  end
+end

data/lib/poise_archive/version.rb

@@ -0,0 +1,20 @@
+#
+# Copyright 2016, 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 PoiseArchive
+  VERSION = '1.0.0'
+end

data/lib/poise_archive.rb

@@ -0,0 +1,21 @@
+#
+# Copyright 2016, 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 PoiseArchive
+  autoload :Resources, 'poise_archive/resources'
+  autoload :VERSION, 'poise_archive/version'
+end

data/poise-archive.gemspec

@@ -0,0 +1,40 @@
+#
+# Copyright 2016, 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.
+#
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'poise_archive/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'poise-archive'
+  spec.version = PoiseArchive::VERSION
+  spec.authors = ['Noah Kantrowitz']
+  spec.email = %w{noah@coderanger.net}
+  spec.description = 'A Chef cookbook for unpacking file archives like tar and zip.'
+  spec.summary = spec.description
+  spec.homepage = 'https://github.com/poise/poise-archive'
+  spec.license = 'Apache 2.0'
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w{lib}
+
+  spec.add_dependency 'halite', '~> 1.2'
+  spec.add_dependency 'poise', '~> 2.6'
+
+  spec.add_development_dependency 'poise-boiler', '~> 1.7'
+end

data/test/cookbook/metadata.rb

@@ -0,0 +1,18 @@
+#
+# Copyright 2016, 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.
+#
+
+name 'poise-archive_test'
+depends 'poise-archive'

data/test/cookbook/recipes/default.rb

@@ -0,0 +1,84 @@
+#
+# Copyright 2016, 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.
+#
+
+# Holding directory for fixtures.
+directory '/test' do
+  mode '777'
+end
+
+# Tests for each fixture file.
+%w{tar tar.gz tar.bz2}.each do |ext|
+  cookbook_file "/test/myapp-1.0.0.#{ext}" do
+    source "myapp-1.0.0.#{ext}"
+  end
+
+  poise_archive "/test/myapp-1.0.0.#{ext}" do
+    destination "/test/#{ext}"
+  end
+
+  poise_archive "/test/myapp-1.0.0.#{ext}_0" do
+    path "/test/myapp-1.0.0.#{ext}"
+    destination "/test/#{ext}_0"
+    strip_components 0
+  end
+
+  poise_archive "/test/myapp-1.0.0.#{ext}_2" do
+    path "/test/myapp-1.0.0.#{ext}"
+    destination "/test/#{ext}_2"
+    strip_components 2
+  end
+end
+
+# Some general tests for core features.
+# Test user-specific unpacking.
+group 'poise' do
+  system true
+end
+
+user 'poise' do
+  group 'poise'
+  system true
+end
+
+directory '/test/user' do
+  group 'poise'
+  mode '700'
+  owner 'poise'
+end
+
+poise_archive '/test/myapp-1.0.0.tar' do
+  destination '/test/user'
+  user 'poise'
+end
+
+# Test keep_existing true.
+directory '/test/keep'
+
+file '/test/keep/EXISTING'
+
+poise_archive '/test/myapp-1.0.0.tar' do
+  destination '/test/keep'
+  keep_existing true
+end
+
+# Test keep_existing false.
+directory '/test/existing'
+
+file '/test/existing/EXISTING'
+
+poise_archive '/test/myapp-1.0.0.tar' do
+  destination '/test/existing'
+end