multi_buildpack.rb

# frozen_string_literal: true

# Cloud Foundry Java Buildpack
# Copyright 2013-2020 the original author or authors.
#
# 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 'pathname'
require 'java_buildpack/component/base_component'
require 'java_buildpack/framework'
require 'java_buildpack/logging/logger_factory'
require 'java_buildpack/util/filtering_pathname'
require 'yaml'

module JavaBuildpack
  module Framework

    # Encapsulates the functionality for multi buildpack support.
    class MultiBuildpack < JavaBuildpack::Component::BaseComponent
      include JavaBuildpack::Util

      # (see JavaBuildpack::Component::BaseComponent#initialize)
      def initialize(context)
        super(context)

        @logger = JavaBuildpack::Logging::LoggerFactory.instance.get_logger MultiBuildpack
        @logger.debug { "Dependencies Directory: #{ARGV[3]}" }
      end

      # (see JavaBuildpack::Component::BaseComponent#detect)
      def detect
        dep_directories.empty? ? nil : "multi-buildpack=#{names(dep_directories).join(',')}"
      end

      # (see JavaBuildpack::Component::BaseComponent#compile)
      def compile
        puts "#{'----->'.red.bold} #{'Multiple Buildpacks'.blue.bold} detected"

        dep_directories.each do |dep_directory|
          config = config(config_file(dep_directory))
          name = name(config)

          log_configuration config
          log_dep_contents dep_directory

          contributions = [
            add_bin(dep_directory),
            add_lib(dep_directory),
            add_additional_libraries(config),
            add_environment_variables(config),
            add_extension_directories(config),
            add_java_opts(config),
            add_security_providers(config)
          ]

          puts "       #{name}#{contributions_message(contributions)}"
        end
      end

      # (see JavaBuildpack::Component::BaseComponent#release)
      def release
        dep_directories.each do |dep_directory|
          config = config(config_file(dep_directory))

          add_bin(dep_directory)
          add_lib(dep_directory)
          add_additional_libraries(config)
          add_environment_variables(config)
          add_extension_directories(config)
          add_java_opts(config)
          add_security_providers(config)
        end
      end

      private

      def add_additional_libraries(config)
        additional_libraries = config['config']['additional_libraries']
        return unless additional_libraries

        additional_libraries.each do |additional_library|
          @droplet.additional_libraries << filtering_pathname(additional_library)
        end

        'Additional Libraries'
      end

      def add_agentpaths(java_opts)
        agentpaths = java_opts['agentpaths']
        return unless agentpaths

        agentpaths.each do |agentpath|
          @droplet.java_opts.add_agentpath filtering_pathname(agentpath)
        end

        'Agents'
      end

      def add_agentpaths_with_props(java_opts)
        agentpaths = java_opts['agentpaths_with_props']
        return unless agentpaths

        agentpaths.each do |agentpath, props|
          @droplet.java_opts.add_agentpath_with_props filtering_pathname(agentpath), props
        end

        'Agent with Properties'
      end

      def add_bin(dep_directory)
        bin_directory = dep_directory + 'bin'
        return unless bin_directory.exist?

        @droplet.environment_variables
                .add_environment_variable('PATH', "$PATH:#{qualify_dep(bin_directory)}")

        '$PATH'
      end

      def filtering_pathname(path)
        JavaBuildpack::Util::FilteringPathname.new(Pathname.new(path), ->(_) { true }, false)
      end

      def qualify_dep(dep_dir)
        ret = dep_dir.to_s.gsub(%r{.+(/deps/[0-9]+/\w+)$}, '\1')
        "$PWD/..#{ret}"
      end

      def add_bootclasspath_ps(java_opts)
        bootclasspath_ps = java_opts['bootclasspath_ps']
        return unless bootclasspath_ps

        bootclasspath_ps.each do |bootclasspath_p|
          @droplet.java_opts.add_bootclasspath_p filtering_pathname(bootclasspath_p)
        end

        'Boot Classpaths'
      end

      def add_environment_variables(config)
        environment_variables = config['config']['environment_variables']
        return unless environment_variables

        environment_variables.each do |key, value|
          path = Pathname.new(value)

          if path.exist?
            @droplet.environment_variables.add_environment_variable key, filtering_pathname(value)
          else
            @droplet.environment_variables.add_environment_variable key, value
          end
        end

        'Environment Variables'
      end

      def add_extension_directories(config)
        extension_directories = config['config']['extension_directories']
        return unless extension_directories

        extension_directories.each do |extension_directory|
          @droplet.extension_directories << filtering_pathname(extension_directory)
        end

        'Extension Directories'
      end

      def add_javaagent(java_opts)
        javaagents = java_opts['javaagents']
        return unless javaagents

        javaagents.each do |javaagent|
          @droplet.java_opts.add_javaagent filtering_pathname(javaagent)
        end

        'Java Agents'
      end

      def add_java_opts(config)
        java_opts = config['config']['java_opts']
        return unless java_opts

        [
          add_agentpaths(java_opts),
          add_agentpaths_with_props(java_opts),
          add_bootclasspath_ps(java_opts),
          add_javaagent(java_opts),
          add_options(java_opts),
          add_preformatted_options(java_opts),
          add_system_properties(java_opts)
        ]
      end

      def add_lib(dep_directory)
        lib_directory = dep_directory + 'lib'
        return unless lib_directory.exist?

        @droplet.environment_variables
                .add_environment_variable('LD_LIBRARY_PATH', "$LD_LIBRARY_PATH:#{qualify_dep(lib_directory)}")

        '$LD_LIBRARY_PATH'
      end

      def add_options(java_opts)
        options = java_opts['options']
        return unless options

        options.each do |key, value|
          path = Pathname.new(value)

          if path.exist?
            @droplet.java_opts.add_option key, filtering_pathname(value)
          else
            @droplet.java_opts.add_option key, value
          end
        end

        'Options'
      end

      def add_preformatted_options(java_opts)
        preformatted_options = java_opts['preformatted_options']
        return unless preformatted_options

        preformatted_options.each do |preformatted_option|
          @droplet.java_opts.add_preformatted_options preformatted_option
        end

        'Preformatted Options'
      end

      def add_security_providers(config)
        security_providers = config['config']['security_providers']
        return unless security_providers

        security_providers.each do |security_provider|
          @droplet.security_providers << security_provider
        end

        'Security Providers'
      end

      def add_system_properties(java_opts)
        system_properties = java_opts['system_properties']
        return unless system_properties

        system_properties.each do |key, value|
          path = Pathname.new(value)

          if path.exist?
            @droplet.java_opts.add_system_property key, filtering_pathname(value)
          else
            @droplet.java_opts.add_system_property key, value
          end
        end

        'System Properties'
      end

      def config(config_file)
        YAML.load_file(config_file)
      end

      def config_file(dep_directory)
        dep_directory + 'config.yml'
      end

      def contributions_message(contributions)
        return if contributions.compact.empty?

        " contributed to: #{contributions.flatten.compact.sort.join(', ')}"
      end

      def dep_directories
        deps = Pathname.glob('/tmp/*/deps').map(&:children).flatten
        return [] unless deps

        deps
          .select { |dep_directory| config_file(dep_directory).exist? }
          .sort_by(&:basename)
      end

      def log_configuration(config)
        @logger.debug { "Configuration: #{config}" }
      end

      def log_dep_contents(dep_directory)
        @logger.debug do
          paths = []
          dep_directory.find { |f| paths << f.relative_path_from(dep_directory).to_s }

          "Application Contents (#{dep_directory}): #{paths}"
        end
      end

      def name(config)
        config['name']
      end

      def names(dep_directories)
        dep_directories.map { |dep_directory| name(config(config_file(dep_directory))) }
      end

    end

  end
end