source_install 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 509f4694c4ffef87fcc75fad945512bbab934a03b28c0323cf45347b6663429c
+  data.tar.gz: 39105c8b6b84325af2291529f7b3958858a12ce84f75ee9bc617573ff94bf17b
+SHA512:
+  metadata.gz: 94093d88f44e85b269f9798ebaa4850fc3ad4c37ea495494497775e691907985f90f60ea3b019cd02e6c4dac4ac4d4d4342a7d04e3d0f0eae146809a9917b48d
+  data.tar.gz: a8efdbde9087a6c6d636e39430a4580aaea916fa9fd05948ab3301ebe062d7865eb3f1da58132f2654ea834099f458e313de390bec2a5ad56db83b5e954cd5c6

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2017-present The University of Alaska
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/source_install.rb

@@ -0,0 +1,342 @@
+# frozen_string_literal: true
+
+# This module implements helpers that are used for resources
+module Source
+  # This module implements helpers that are used for resources
+  module Install
+    VERSION = '0.0.0'
+
+    # Hooks for install
+
+    def base_name(_new_resource)
+      raise NotImplementedError('Client must define base application name e.g. "Python". \
+This is frequently used to build e.g. archive file name and will be used to define default directories.')
+    end
+
+    def default_version(_new_resource)
+      raise NotImplementedError('Client must provide a default version string e.g. "1.1.4".')
+    end
+
+    def archive_file_name(_new_resource)
+      # noinspection RubyExpressionInStringInspection
+      raise NotImplementedError('Client must indicate the filename of the what the archive file \
+that will be downloaded, e.g. "#{base_name(new_resource)}-#{new_resource.version}.tar.gz"')
+    end
+
+    def download_base_url(_new_resource)
+      raise NotImplementedError('Client must indicate the URL at which the archive file is located, \
+e.g. "https://www.oss-project.org/source"')
+    end
+
+    def archive_root_directory(_new_resource)
+      # noinspection RubyExpressionInStringInspection
+      raise NotImplementedError('Client must indicate the directory created by extraction, \
+e.g. "#{base_name(new_resource)}-#{new_resource.version}". This will be used as the build directory.')
+    end
+
+    def extract_creates_file(_new_resource)
+      raise NotImplementedError('Client must indicate a relative path to a file that is created by extraction, \
+e.g. "README.md"')
+    end
+
+    def configuration_command(_new_resource)
+      raise NotImplementedError('Client must define the configuration command to be run before build, \
+e.g. "./config shared --prefix..."')
+    end
+
+    def install_creates_file(_new_resource)
+      raise NotImplementedError('Client must indicate a relative path to a file that is created by installation, \
+e.g. "bin/my_app"')
+    end
+
+    def install_command(_new_resource)
+      raise NotImplementedError('Client must define the command for installation, e.g. "make install"')
+    end
+
+    def post_install_logic(_new_resource)
+      raise NotImplementedError('Client must define logic to run after installation, for example to creating symlinks')
+    end
+
+    # Common install code
+
+    def ensure_version(new_resource)
+      return if new_resource.version
+
+      new_resource.version = default_version(new_resource)
+    end
+
+    def download_url(new_resource)
+      url = download_base_url(new_resource)
+      url += '/' unless url.match?(%r{/$})
+      url += archive_file_name(new_resource)
+      return url
+    end
+
+    def create_default_directories
+      directory '/var/chef' do
+        mode 0o755
+        owner 'root'
+        group 'root'
+      end
+      directory '/var/chef/cache' do
+        mode 0o755
+        owner 'root'
+        group 'root'
+      end
+    end
+
+    def path_to_download_directory(new_resource)
+      return new_resource.download_directory if new_resource.download_directory
+
+      create_default_directories
+      return '/var/chef/cache'
+    end
+
+    def path_to_download_file(new_resource)
+      directory = path_to_download_directory(new_resource)
+      file = File.join(directory, archive_file_name(new_resource))
+      return file
+    end
+
+    def download_archive(new_resource)
+      download_file = path_to_download_file(new_resource)
+      url = download_url(new_resource)
+      remote_file download_file do
+        source url
+        owner new_resource.owner
+        group new_resource.group
+      end
+      return download_file
+    end
+
+    def path_to_build_directory(new_resource)
+      base = archive_root_directory(new_resource)
+      return File.join(new_resource.build_directory, base) if new_resource.build_directory
+
+      create_default_directories
+      return File.join('/var/chef/cache', base)
+    end
+
+    def clear_source_directory(build_directory, new_resource)
+      dir = build_directory
+      bash 'Clear Archive' do
+        code "rm -rf #{dir}\nmkdir #{dir}\nchown #{new_resource.owner}:#{new_resource.group} #{dir}"
+        # Run as root so we blow it away if the owner changes
+        action :nothing
+        subscribes :run, 'checksum_file[Download Checksum]', :immediate
+      end
+    end
+
+    def manage_source_directory(download_file, build_directory, new_resource)
+      checksum_file 'Download Checksum' do
+        source_path download_file
+        target_path "/var/chef/cache/#{base_name(new_resource).downcase}-#{new_resource.version}-dl-checksum"
+      end
+      clear_source_directory(build_directory, new_resource)
+    end
+
+    def extract_command(filename)
+      return 'unzip -q' if filename.match?(/\.zip/)
+
+      return 'tar xzf' if filename.match?(/\.(:?tar\.gz|tgz)/)
+
+      raise "Archive not supported: #{filename}"
+    end
+
+    def code_for_extraction(download_file, build_directory, new_resource)
+      code = <<~CODE
+        #{extract_command(download_file)} #{download_file}
+        chown -R #{new_resource.owner}:#{new_resource.group} #{build_directory}
+      CODE
+      return code
+    end
+
+    def extract_download(download_file, build_directory, new_resource)
+      # Built-in archive_file requires Chef 15 and poise_archive is failing to exhibit idempotence on zip files
+      parent = File.dirname(build_directory)
+      code = code_for_extraction(download_file, build_directory, new_resource)
+      bash 'Extract Archive' do
+        code code
+        cwd parent
+        # Run as root in case it is installing in directory without write access
+        creates File.join(build_directory, extract_creates_file(new_resource))
+      end
+    end
+
+    def extract_archive(build_directory, new_resource)
+      download_file = download_archive(new_resource)
+      manage_source_directory(download_file, build_directory, new_resource)
+      extract_download(download_file, build_directory, new_resource)
+    end
+
+    def default_install_directory(new_resource)
+      return "/opt/#{base_name(new_resource).downcase}/#{new_resource.version}"
+    end
+
+    def create_opt_directories(new_resource)
+      directory "/opt/#{base_name(new_resource).downcase}" do
+        mode 0o755
+        owner 'root'
+        group 'root'
+      end
+      directory default_install_directory(new_resource) do
+        mode 0o755
+        owner 'root'
+        group 'root'
+      end
+    end
+
+    def ensure_install_directory(new_resource)
+      return if new_resource.install_directory
+
+      create_opt_directories(new_resource)
+      new_resource.install_directory = default_install_directory(new_resource)
+    end
+
+    def save_config(code, new_resource)
+      file 'Config File' do
+        path "/var/chef/cache/#{base_name(new_resource).downcase}-#{new_resource.version}-config"
+        content code
+        mode 0o644
+        owner 'root'
+        group 'root'
+      end
+    end
+
+    def manage_make_file(build_directory, code, new_resource)
+      save_config(code, new_resource)
+      makefile = File.join(build_directory, 'Makefile')
+      file makefile do
+        action :nothing
+        subscribes :delete, 'file[Config File]', :immediate
+      end
+      return makefile
+    end
+
+    def configure_build(build_directory, new_resource)
+      code = configuration_command(new_resource)
+      makefile = manage_make_file(build_directory, code, new_resource)
+      bash 'Configure Build' do
+        code code
+        cwd build_directory
+        user new_resource.owner
+        group new_resource.group
+        creates makefile
+      end
+    end
+
+    def check_build_directory(build_directory, new_resource)
+      checksum_file 'Source Checksum' do
+        source_path build_directory
+        target_path "/var/chef/cache/#{base_name(new_resource).downcase}-#{new_resource.version}-src-checksum"
+      end
+    end
+
+    def manage_bin_file(bin_file)
+      file bin_file do
+        action :nothing
+        manage_symlink_source false
+        subscribes :delete, 'checksum_file[Source Checksum]', :immediate
+      end
+    end
+
+    def execute_build(build_directory, bin_file, new_resource)
+      bash 'Compile' do
+        code 'make'
+        cwd build_directory
+        user new_resource.owner
+        group new_resource.group
+        creates bin_file
+      end
+    end
+
+    def execute_install(build_directory, bin_file, new_resource)
+      bash 'Install' do
+        code install_command(new_resource)
+        cwd build_directory
+        # Run as root in case it is installing in directory without write access
+        creates bin_file
+      end
+    end
+
+    def recurse_command(path)
+      return ' -R' if File.directory?(path)
+
+      return ''
+    end
+
+    def command_for_file(filename, new_resource)
+      path = File.join(new_resource.install_directory, filename)
+      recurse = recurse_command(path)
+      return "\nchown#{recurse} #{new_resource.owner}:#{new_resource.group} #{path}"
+    end
+
+    def iterate_install_directory(new_resource)
+      command = ''
+      Dir.foreach(new_resource.install_directory) do |filename|
+        next if ['.', '..'].include?(filename)
+
+        command += command_for_file(filename, new_resource)
+      end
+      return command
+    end
+
+    def build_permission_command(new_resource)
+      ruby_block 'Build Children' do
+        block do
+          files = iterate_install_directory(new_resource)
+          node.run_state['build_permission_command'] = files
+        end
+        action :nothing
+        subscribes :run, 'bash[Install]', :immediate
+      end
+    end
+
+    # Some install scripts create artifacts in the source directory
+    def set_src_permissions(build_directory, new_resource)
+      bash 'Set Config Permissions' do
+        code "chown -R #{new_resource.owner}:#{new_resource.group} #{build_directory}"
+        action :nothing
+        subscribes :run, 'bash[Install]', :immediate
+      end
+    end
+
+    def set_install_permissions(build_directory, new_resource)
+      build_permission_command(new_resource)
+      bash 'Change Install Permissions' do
+        code(lazy { node.run_state['build_permission_command'] })
+        cwd new_resource.install_directory
+        action :nothing
+        subscribes :run, 'bash[Install]', :immediate
+      end
+      set_src_permissions(build_directory, new_resource)
+    end
+
+    def make_build(build_directory, bin_file, new_resource)
+      execute_build(build_directory, bin_file, new_resource)
+      execute_install(build_directory, bin_file, new_resource)
+      set_install_permissions(build_directory, new_resource)
+    end
+
+    def compile_and_install(build_directory, new_resource)
+      check_build_directory(build_directory, new_resource)
+      bin_file = File.join(new_resource.install_directory, install_creates_file(new_resource))
+      manage_bin_file(bin_file)
+      make_build(build_directory, bin_file, new_resource)
+    end
+
+    def build_binary(build_directory, new_resource)
+      ensure_install_directory(new_resource)
+      configure_build(build_directory, new_resource)
+      compile_and_install(build_directory, new_resource)
+      post_install_logic(new_resource)
+    end
+
+    def create_install(new_resource)
+      ensure_version(new_resource)
+      build_directory = path_to_build_directory(new_resource)
+      extract_archive(build_directory, new_resource)
+      build_binary(build_directory, new_resource)
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: source_install
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- UA OIT Systems Engineering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chefspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kitchen-vagrant
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Logic for downloading, configuring, compiling, and installing packages
+  from source
+email:
+- ua-oit-se@alaska.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/source_install.rb
+homepage: https://github.com/ualaska-it/source_install
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A gem for common installer logic
+test_files: []