applicationsonline/librarian-chef

View on GitHub
lib/librarian/chef/source/site.rb

Summary

Maintainability
C
1 day
Test Coverage
require 'fileutils'
require 'pathname'
require 'uri'
require 'net/http'
require 'json'
require 'digest'
require 'zlib'
require 'securerandom'
require 'archive/tar/minitar'

require 'librarian/source/basic_api'
require 'librarian/chef/manifest_reader'

module Librarian
  module Chef
    module Source
      class Site

        class Line

          attr_accessor :source, :name
          private :source=, :name=

          def initialize(source, name)
            self.source = source
            self.name = name
          end

          def install_version!(version, install_path)
            cache_version_unpacked! version

            if install_path.exist?
              debug { "Deleting #{relative_path_to(install_path)}" }
              install_path.rmtree
            end

            unpacked_path = version_unpacked_cache_path(version)

            debug { "Copying #{relative_path_to(unpacked_path)} to #{relative_path_to(install_path)}" }
            FileUtils.cp_r(unpacked_path, install_path)
          end

          def manifests
            version_uris.map do |version_uri|
              Manifest.new(source, name, version_uri)
            end
          end

          def to_version(version_uri)
            version_uri_metadata(version_uri)["version"]
          end

          def version_dependencies(version)
            version_manifest(version)["dependencies"]
          end

        private

          attr_accessor :metadata_cached
          alias metadata_cached? metadata_cached

          def environment
            source.environment
          end

          def uri
            @uri ||= URI.parse("#{source.uri}/cookbooks/#{name}")
          end

          def version_uris
            metadata["versions"]
          end

          def version_metadata(version)
            version_uri = to_version_uri(version)
            version_uri_metadata(version_uri)
          end

          def version_uri_metadata(version_uri)
            memo(__method__, version_uri.to_s) do
              cache_version_uri_metadata! version_uri
              parse_local_json(version_uri_metadata_cache_path(version_uri))
            end
          end

          def version_manifest(version)
            version_uri = to_version_uri(version)
            version_uri_manifest(version_uri)
          end

          def version_uri_manifest(version_uri)
            memo(__method__, version_uri.to_s) do
              cache_version_uri_unpacked! version_uri
              unpacked_path = version_uri_unpacked_cache_path(version_uri)
              manifest_path = ManifestReader.manifest_path(unpacked_path)
              ManifestReader.read_manifest(name, manifest_path)
            end
          end

          def metadata
            @metadata ||= begin
              cache_metadata!
              parse_local_json(metadata_cache_path)
            end
          end

          def to_version_uri(version)
            memo(__method__, version.to_s) do
              cache_version! version
              version_cache_path(version).read
            end
          end

          def metadata_cached!
            self.metadata_cached = true
          end

          def cache_path
            @cache_path ||= source.cache_path.join(name)
          end

          def metadata_cache_path
            @metadata_cache_path ||= cache_path.join("metadata.json")
          end

          def version_cache_path(version)
            memo(__method__, version.to_s) do
              cache_path.join("version").join(version.to_s)
            end
          end

          def version_uri_cache_path(version_uri)
            memo(__method__, version_uri.to_s) do
              cache_path.join("version-uri").join(hexdigest(version_uri))
            end
          end

          def version_metadata_cache_path(version)
            version_uri = to_version_uri(version)
            version_uri_metadata_cache_path(version_uri)
          end

          def version_uri_metadata_cache_path(version_uri)
            memo(__method__, version_uri.to_s) do
              version_uri_cache_path(version_uri).join("metadata.json")
            end
          end

          def version_package_cache_path(version)
            version_uri = to_version_uri(version)
            version_uri_package_cache_path(version_uri)
          end

          def version_uri_package_cache_path(version_uri)
            memo(__method__, version_uri.to_s) do
              version_uri_cache_path(version_uri).join("package.tar.gz")
            end
          end

          def version_unpacked_cache_path(version)
            version_uri = to_version_uri(version)
            version_uri_unpacked_cache_path(version_uri)
          end

          def version_uri_unpacked_cache_path(version_uri)
            memo(__method__, version_uri.to_s) do
              version_uri_cache_path(version_uri).join("package")
            end
          end

          def cache_metadata!
            metadata_cached? and return or metadata_cached!
            cache_remote_json! metadata_cache_path, uri
          end

          def cache_version_uri_metadata!(version_uri)
            path = version_uri_metadata_cache_path(version_uri)
            path.file? and return

            cache_remote_json! path, version_uri
          end

          def cache_version!(version)
            path = version_cache_path(version)
            path.file? and return

            version_uris.each do |version_uri|
              m = version_uri_metadata(version_uri)
              v = m["version"]
              if version.to_s == v
                write! path, version_uri.to_s
                break
              end
            end
          end

          def cache_version_package!(version)
            version_uri = to_version_uri(version)
            cache_version_uri_package! version_uri
          end

          def cache_version_uri_package!(version_uri)
            path = version_uri_package_cache_path(version_uri)
            path.file? and return

            file_uri = version_uri_metadata(version_uri)["file"]
            cache_remote_object! path, file_uri
          end

          def cache_version_unpacked!(version)
            version_uri = to_version_uri(version)
            cache_version_uri_unpacked! version_uri
          end

          def cache_version_uri_unpacked!(version_uri)
            cache_version_uri_package!(version_uri)

            path = version_uri_unpacked_cache_path(version_uri)
            path.directory? and return

            package_path = version_uri_package_cache_path(version_uri)
            unpacked_path = version_uri_unpacked_cache_path(version_uri)

            unpack_package! unpacked_path, package_path
          end

          def cache_remote_json!(path, uri)
            cache_remote_object!(path, uri, :type => :json)
          end

          def cache_remote_object!(path, uri, options = { })
            path = Pathname(path)
            uri = to_uri(uri)
            type = options[:type]

            debug { "Caching #{uri} to #{path}" }

            response = http_get(uri)

            object = response.body
            case type
            when :json
              JSON.parse(object) # verify that it's really JSON.
            end
            write! path, object
          end

          def write!(path, bytes)
            path.dirname.mkpath
            path.open("wb"){|f| f.write(bytes)}
          end

          def path_detect_gzip?(path)
            Zlib::GzipReader.open(path) { true }
          rescue Zlib::GzipFile::Error
            false
          end

          def path_detect_tar?(path)
            path_read_bytes_at(path, 257, 8) == "ustar\x0000"
          end

          def path_read_bytes_at(path, pos, len)
            path = Pathname(path)
            path.stat.size >= pos + len or return
            path.open "rb" do |f|
              f.seek pos ; f.pos == pos or return
              f.read(len)
            end
          end

          def extract_archive!(source, destination)
            source = Pathname(source)
            destination = Pathname(destination)

            return extract_archive_targz! source, destination if path_detect_gzip?(source)
            return extract_archive_tar! source, destination if path_detect_tar?(source)
            raise "Unrecognized archive format!"
          end

          def extract_archive_targz!(source, destination)
            Zlib::GzipReader.open(source) do |input|
              Archive::Tar::Minitar.unpack(input, destination.to_s)
            end
          end

          def extract_archive_tar!(source, destination)
            source.open "rb" do |input|
              Archive::Tar::Minitar.unpack(input, destination.to_s)
            end
          end

          def unpack_package!(path, source)
            path = Pathname(path)
            source = Pathname(source)

            temp = environment.scratch_path.join(SecureRandom.hex(16))
            temp.mkpath

            debug { "Unpacking #{relative_path_to(source)} to #{relative_path_to(temp)}" }
            extract_archive! source, temp

            # Cookbook files, as pulled from Opscode Community Site API, are
            # embedded in a subdirectory of the tarball. If created by git archive they
            # can include the subfolder `pax_global_header`, which is ignored.
            subtemps = temp.children
            subtemps.empty? and raise "The package archive was empty!"
            subtemps.delete_if{|pth| pth.to_s[/pax_global_header/]}
            subtemps.size > 1 and raise "The package archive has too many children!"
            subtemp = subtemps.first
            debug { "Moving #{relative_path_to(subtemp)} to #{relative_path_to(path)}" }
            FileUtils.mv(subtemp, path)
          ensure
            temp.rmtree if temp && temp.exist?
          end

          def parse_local_json(path)
            JSON.parse(path.read)
          end

          def hexdigest(bytes)
            Digest::MD5.hexdigest(bytes)[0..15]
          end

          def to_uri(uri)
            uri = URI(uri) unless URI === uri
            uri
          end

          def debug(*args, &block)
            environment.logger.debug(*args, &block)
          end

          def relative_path_to(path)
            environment.logger.relative_path_to(path)
          end

          def http(uri)
            net_http = environment.net_http_class(uri.host).new(uri.host, uri.port)
            net_http.use_ssl = true if uri.scheme == 'https'
            net_http
          end

          def http_get(uri)
            max_redirects = 10
            redirects = []

            loop do
              debug { "Performing http-get for #{uri}" }
              http = http(uri)
              http.use_ssl = uri.scheme == 'https'
              request = Net::HTTP::Get.new(uri.path)
              response = http.start{|http| http.request(request)}

              case response
              when Net::HTTPSuccess
                debug { "Responded with success" }
                return response
              when Net::HTTPRedirection
                location = response["Location"]
                debug { "Responded with redirect to #{uri}" }
                redirects.size > max_redirects and raise Error,
                  "Could not get #{uri} because too many redirects!"
                redirects.include?(location) and raise Error,
                  "Could not get #{uri} because redirect cycle!"
                redirects << location
                uri = URI.parse(location)
                # continue the loop
              else
                raise Error, "Could not get #{uri} because #{response.code} #{response.message}!"
              end
            end
          end

          def memo(method, *path)
            ivar = "@#{method}".to_sym
            unless memo = instance_variable_get(ivar)
              memo = instance_variable_set(ivar, { })
            end

            memo.key?(path) or memo[path] = yield
            memo[path]
          end

        end

        include Librarian::Source::BasicApi

        lock_name 'SITE'
        spec_options []

        attr_accessor :environment, :uri
        private :environment=, :uri=

        def initialize(environment, uri, options = {})
          self.environment = environment
          self.uri = uri
        end

        def to_s
          uri
        end

        def ==(other)
          other &&
          self.class  == other.class &&
          self.uri    == other.uri
        end

        def to_spec_args
          [uri, {}]
        end

        def to_lock_options
          {:remote => uri}
        end

        def pinned?
          false
        end

        def unpin!
        end

        def install!(manifest)
          manifest.source == self or raise ArgumentError

          name = manifest.name
          version = manifest.version
          install_path = install_path(name)
          line = line(name)

          info { "Installing #{manifest.name} (#{manifest.version})" }

          debug { "Installing #{manifest}" }

          line.install_version! version, install_path
        end

        # NOTE:
        #   Assumes the Opscode Site API responds with versions in reverse sorted order
        def manifests(name)
          line(name).manifests
        end

        def cache_path
          @cache_path ||= begin
            dir = Digest::MD5.hexdigest(uri)[0..15]
            environment.cache_path.join("source/chef/site/#{dir}")
          end
        end

        def install_path(name)
          environment.install_path.join(name)
        end

        def fetch_version(name, version_uri)
          line(name).to_version(version_uri)
        end

        def fetch_dependencies(name, version, version_uri)
          line(name).version_dependencies(version).map{|k, v| Dependency.new(k, v, nil)}
        end

      private

        def line(name)
          @line ||= { }
          @line[name] ||= Line.new(self, name)
        end

        def info(*args, &block)
          environment.logger.info(*args, &block)
        end

        def debug(*args, &block)
          environment.logger.debug(*args, &block)
        end

      end
    end
  end
end