chef-cli 1.0.3

data/lib/chef-cli/command/exec.rb

@@ -0,0 +1,45 @@
+#
+# Copyright:: Copyright (c) 2014-2019 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 "../dist"
+require "mixlib/shellout" unless defined?(Mixlib::ShellOut)
+
+module ChefCLI
+  module Command
+    class Exec < ChefCLI::Command::Base
+      banner "Usage: #{ChefCLI::Dist::EXEC} exec SYSTEM_COMMAND"
+
+      def run(params)
+        # Set ENV directly on the "parent" process (us) before running #exec to
+        # ensure the custom PATH is honored when finding the command to exec
+        omnibus_env.each { |var, value| ENV[var] = value }
+        exec(*params)
+        raise "Exec failed without an exception, your ruby is buggy" # should never get here
+      end
+
+      def needs_version?(params)
+        # Force version to get passed down to command
+        false
+      end
+
+      def needs_help?(params)
+        ["-h", "--help"].include? params[0]
+      end
+    end
+  end
+end

data/lib/chef-cli/command/export.rb

@@ -0,0 +1,156 @@
+#
+# Copyright:: Copyright (c) 2014-2019 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/export_repo"
+require_relative "../configurable"
+require_relative "../dist"
+
+module ChefCLI
+  module Command
+
+    class Export < Base
+
+      include Configurable
+
+      banner(<<~E)
+        Usage: #{ChefCLI::Dist::EXEC} export [ POLICY_FILE ] DESTINATION_DIRECTORY [options]
+
+        `#{ChefCLI::Dist::EXEC} export` creates a #{ChefCLI::Dist::ZERO_PRODUCT} compatible #{ChefCLI::Dist::INFRA_PRODUCT} repository containing the
+        cookbooks described in a Policyfile.lock.json. The exported repository also contains
+        a .chef/config.rb which configures #{ChefCLI::Dist::INFRA_CLIENT_PRODUCT} to apply your policy. Once the
+        exported repo is copied to the target machine, you can apply the policy to the
+        machine with:
+
+        `#{ChefCLI::Dist::INFRA_CLIENT_CLI} -z`.
+
+        See our detailed README for more information:
+
+        https://docs.chef.io/policyfile.html
+
+        Options:
+
+      E
+
+      option :archive,
+        short:       "-a",
+        long:        "--archive",
+        description: "Export as a tarball archive rather than a directory",
+        default:     false,
+        boolean:     true
+
+      option :force,
+        short:       "-f",
+        long:        "--force",
+        description: "If the DESTINATION_DIRECTORY is not empty, remove its content.",
+        default:     false,
+        boolean:     true
+
+      option :debug,
+        short:       "-D",
+        long:        "--debug",
+        description: "Enable stacktraces and other debug output",
+        default:     false
+
+      attr_reader :policyfile_relative_path
+      attr_reader :export_dir
+
+      attr_accessor :ui
+
+      def initialize(*args)
+        super
+        @push = nil
+        @ui = nil
+        @policyfile_relative_path = nil
+        @export_dir = nil
+        @chef_config = nil
+        @ui = UI.new
+      end
+
+      def run(params = [])
+        return 1 unless apply_params!(params)
+        export_service.run
+        ui.msg("Exported policy '#{export_service.policyfile_lock.name}' to #{export_target}")
+        unless archive?
+          ui.msg("")
+          ui.msg("To converge this system with the exported policy, run:")
+          ui.msg("  cd #{export_dir}")
+          ui.msg("  #{ChefCLI::Dist::INFRA_CLIENT_CLI} -z")
+        end
+        0
+      rescue ExportDirNotEmpty => e
+        ui.err("ERROR: " + e.message)
+        ui.err("Use --force to force export")
+        1
+      rescue PolicyfileServiceError => e
+        handle_error(e)
+        1
+      end
+
+      def export_target
+        if archive?
+          export_service.archive_file_location
+        else
+          export_dir
+        end
+      end
+
+      def debug?
+        !!config[:debug]
+      end
+
+      def archive?
+        !!config[:archive]
+      end
+
+      def export_service
+        @export_service ||= PolicyfileServices::ExportRepo.new(policyfile: policyfile_relative_path,
+                                                               export_dir: export_dir,
+                                                               root_dir: Dir.pwd,
+                                                               archive: archive?,
+                                                               force: config[:force])
+      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)
+        case remaining_args.size
+        when 1
+          @export_dir = remaining_args[0]
+        when 2
+          @policyfile_relative_path, @export_dir = remaining_args
+        else
+          ui.err(opt_parser)
+          ui.err("\n")
+          return false
+        end
+        true
+      end
+
+    end
+  end
+end

data/lib/chef-cli/command/gem.rb

@@ -0,0 +1,48 @@
+#
+# Copyright:: Copyright (c) 2014-2019 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 "../dist"
+require "rubygems" unless defined?(Gem)
+require "rubygems/gem_runner"
+require "rubygems/exceptions"
+require "pp" unless defined?(PP)
+
+module ChefCLI
+  module Command
+
+    # Forwards all commands to rubygems.
+    class GemForwarder < ChefCLI::Command::Base
+      banner "Usage: #{ChefCLI::Dist::EXEC} gem GEM_COMMANDS_AND_OPTIONS"
+
+      def run(params)
+        retval = Gem::GemRunner.new.run( params.clone )
+        retval.nil? ? true : retval
+      rescue Gem::SystemExitException => e
+        exit( e.exit_code )
+      end
+
+      # Lazy solution: By automatically returning false, we force ChefCLI::Base to
+      # call this class' run method, so that Gem::GemRunner can handle the -v flag
+      # appropriately (showing the gem version, or installing a specific version
+      # of a gem).
+      def needs_version?(params)
+        false
+      end
+    end
+  end
+end

data/lib/chef-cli/command/generate.rb

@@ -0,0 +1,123 @@
+#
+# Copyright:: Copyright (c) 2014-2019, 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 "generator_commands"
+require_relative "generator_commands/base"
+require_relative "generator_commands/cookbook_code_file"
+require_relative "generator_commands/cookbook"
+require_relative "generator_commands/attribute"
+require_relative "generator_commands/cookbook_file"
+require_relative "generator_commands/helpers"
+require_relative "generator_commands/resource"
+require_relative "generator_commands/recipe"
+require_relative "generator_commands/template"
+require_relative "generator_commands/repo"
+require_relative "generator_commands/policyfile"
+require_relative "generator_commands/generator_generator"
+require_relative "generator_commands/build_cookbook"
+require_relative "../dist"
+
+module ChefCLI
+  module Command
+    class Generate < Base
+
+      GeneratorCommand = Struct.new(:name, :class_name, :description)
+
+      def self.generators
+        @generators ||= []
+      end
+
+      def self.generator(name, class_name, description)
+        generators << GeneratorCommand.new(name, class_name, description)
+      end
+
+      generator(:cookbook, :Cookbook, "Generate a single cookbook")
+      generator(:recipe, :Recipe, "Generate a new recipe")
+      generator(:attribute, :Attribute, "Generate an attributes file")
+      generator(:template, :Template, "Generate a file template")
+      generator(:file, :CookbookFile, "Generate a cookbook file")
+      generator(:helpers, :Helpers, "Generate a cookbook helper file in libraries")
+      generator(:resource, :Resource, "Generate a custom resource")
+      generator(:repo, :Repo, "Generate a #{ChefCLI::Dist::INFRA_PRODUCT} code repository")
+      generator(:policyfile, :Policyfile, "Generate a Policyfile for use with the install/push commands")
+      generator(:generator, :GeneratorGenerator, "Copy #{ChefCLI::Dist::PRODUCT}'s generator cookbook so you can customize it")
+      generator(:'build-cookbook', :BuildCookbook, "Generate a build cookbook for use with #{ChefCLI::Dist::WORKFLOW}")
+
+      def self.banner_headline
+        <<~E
+          Usage: #{ChefCLI::Dist::EXEC} generate GENERATOR [options]
+
+          Available generators:
+        E
+      end
+
+      def self.generator_list
+        justify_size = generators.map { |g| g.name.size }.max + 2
+        generators.map { |g| "  #{g.name.to_s.ljust(justify_size)}#{g.description}" }.join("\n")
+      end
+
+      def self.banner
+        banner_headline + generator_list + "\n"
+      end
+
+      # chef generate app path/to/basename --skel=path/to/skeleton --example
+      # chef generate file name [path/to/cookbook_root] (inferred from cwd) --from=source_file
+
+      def initialize(*args)
+        super
+      end
+
+      def run(params)
+        if ( generator_spec = generator_for(params[0]) )
+          params.shift
+          generator = GeneratorCommands.build(generator_spec.class_name, params)
+          generator.run
+        else
+          msg(banner)
+          1
+        end
+      rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+        # ChefCLI::Command::Base also handles this error in the same way, but it
+        # does not have access to the correct option parser, so it cannot print
+        # the usage correctly. Therefore, invalid CLI usage needs to be handled
+        # here.
+        err("ERROR: #{e.message}\n")
+        msg(generator.opt_parser)
+        1
+      end
+
+      def generator_for(arg)
+        self.class.generators.find { |g| g.name.to_s == arg }
+      end
+
+      # In the Base class, this is defined to be true if any args match "-h" or
+      # "--help". Here we override that behavior such that if the first
+      # argument is a valid generator name, like `chef generate cookbook -h`,
+      # we delegate the request to the specified generator.
+      def needs_help?(params)
+        return false if have_generator?(params[0])
+        super
+      end
+
+      def have_generator?(name)
+        self.class.generators.map { |g| g.name.to_s }.include?(name)
+      end
+
+    end
+  end
+end

data/lib/chef-cli/command/generator_commands.rb

@@ -0,0 +1,83 @@
+#
+# Copyright:: Copyright (c) 2014-2018 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 "mixlib/cli" unless defined?(Mixlib::CLI)
+require "rbconfig"
+require "pathname" unless defined?(Pathname)
+require_relative "base"
+require_relative "../chef_runner"
+require_relative "../generator"
+
+module ChefCLI
+  module Command
+
+    # ## SharedGeneratorOptions
+    #
+    # These CLI options are shared amongst the generator commands
+    module SharedGeneratorOptions
+      include Mixlib::CLI
+
+      # You really want these to have default values, as
+      # they will likely be used all over the place.
+      option :license,
+        short: "-I LICENSE",
+        long: "--license LICENSE",
+        description: "all_rights, apachev2, mit, gplv2, gplv3 - defaults to all_rights",
+        proc: Proc.new { |l|
+          l =~ /apache2/ ? "apachev2" : l
+        },
+        default: nil
+
+      option :copyright_holder,
+        short: "-C COPYRIGHT",
+        long: "--copyright COPYRIGHT",
+        description: "Name of the copyright holder - defaults to 'The Authors'",
+        default: nil
+
+      option :email,
+        short: "-m EMAIL",
+        long: "--email EMAIL",
+        description: "Email address of the author - defaults to 'you@example.com'",
+        default: nil
+
+      option :generator_cookbook,
+        short: "-g GENERATOR_COOKBOOK_PATH",
+        long: "--generator-cookbook GENERATOR_COOKBOOK_PATH",
+        description: "Use GENERATOR_COOKBOOK_PATH for the code_generator cookbook",
+        default: nil,
+        proc: Proc.new { |s| File.expand_path(s) },
+        on: :tail
+
+      generator_args = [] # accumulator variable
+      option :generator_arg,
+        short: "-a KEY=VALUE",
+        long: "--generator-arg KEY=VALUE",
+        description: "Use to set arbitrary attribute KEY to VALUE in the code_generator cookbook",
+        default: [],
+        proc: Proc.new { |s| generator_args << s.split("=").map(&:strip) }
+    end
+
+    # ## GeneratorCommands
+    #
+    # This module is the namespace for all subcommands of `chef generate`
+    module GeneratorCommands
+      def self.build(class_name, params)
+        const_get(class_name).new(params)
+      end
+    end
+  end
+end