lib/chef-cli/command/update.rb



#
# Copyright:: Chef Software Inc.
# License:: Apache License, Version 2.0
#
# 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_relative "base"
require_relative "../ui"
require_relative "../policyfile_services/install"
require_relative "../policyfile_services/update_attributes"
require_relative "../configurable"
require_relative "../dist"

module ChefCLI
  module Command

    class Update < Base

      include Configurable

      banner(<<~BANNER)
        Usage: #{ChefCLI::Dist::EXEC} update [ POLICY_FILE ] [options] [cookbook_1] [...]

        `#{ChefCLI::Dist::EXEC} update` reads your `Policyfile.rb`, applies any changes, re-solves the
        dependencies and emits an updated `Policyfile.lock.json`. The new locked policy
        will reflect any changes to the `run_list` and pull in any cookbook updates
        that are compatible with the version constraints stated in your `Policyfile.rb`.

        Individual dependent cookbooks (and their dependencies) may be updated by
        passing their names after the POLICY_FILE. The POLICY_FILE parameter is
        mandatory if you want to update individual cookbooks.

        See our detailed README for more information:

        https://docs.chef.io/policyfile/

        Options:

      BANNER

      option :config_file,
        short:       "-c CONFIG_FILE",
        long:        "--config CONFIG_FILE",
        description: "Path to configuration file"

      option :debug,
        short:        "-D",
        long:         "--debug",
        description:  "Enable stacktraces and other debug output",
        default:      false,
        boolean:      true

      option :update_attributes_only,
        short:        "-a",
        long:         "--attributes",
        description:  "Only update attributes (not cookbooks)",
        default:      false,
        boolean:      true

      option :exclude_deps,
        long:         "--exclude-deps",
        description:  "Only update cookbooks explicitly mentioned on the command line",
        boolean:      true,
        default:      false

      attr_reader :policyfile_relative_path

      attr_accessor :ui

      def initialize(*args)
        super
        @ui = UI.new

        @policyfile_relative_path = nil
        @installer = nil
        @attributes_updater = nil
        @cookbooks_to_update = []
      end

      def run(params = [])
        return 1 unless apply_params!(params)

        attributes_updater.run if update_attributes_only?
        installer.run(@cookbooks_to_update, config[:exclude_deps]) unless update_attributes_only?
        0
      rescue PolicyfileServiceError => e
        handle_error(e)
        1
      end

      def installer
        @installer ||= PolicyfileServices::Install.new(policyfile: policyfile_relative_path, ui:, root_dir: Dir.pwd, config: chef_config, overwrite: true)
      end

      def attributes_updater
        @attributes_updater ||=
          PolicyfileServices::UpdateAttributes.new(policyfile: policyfile_relative_path, ui:, root_dir: Dir.pwd, chef_config:)
      end

      def debug?
        !!config[:debug]
      end

      def config_path
        config[:config_file]
      end

      def update_attributes_only?
        !!config[:update_attributes_only]
      end

      def handle_error(error)
        ui.err("Error: #{error.message}")
        if error.respond_to?(:reason)
          ui.err("Reason: #{error.reason}")
          ui.err("")
          ui.err(error.extended_error_info) if debug?
          ui.err(error.cause.backtrace.join("\n")) if debug?
        end
      end

      def apply_params!(params)
        remaining_args = parse_options(params)
        @policyfile_relative_path = remaining_args.shift
        @cookbooks_to_update += remaining_args
        true
      end
    end
  end
end