chef-cli 1.0.3

data/lib/chef-cli/commands_map.rb

@@ -0,0 +1,113 @@
+#
+# Copyright:: Copyright (c) 2016 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.
+#
+
+module ChefCLI
+
+  # CommandsMap maintains a mapping of subcommand names to the files where
+  # those commands are defined and the classes that implement the commands.
+  #
+  # In ruby it's more typical to handle this sort of thing using conventions
+  # and metaprogramming. We've implemented this approach in the past and
+  # decided against it here:
+  # 1. Performance. As the CLI suite grows, you have to load more and more
+  # code, including dependencies that are installed by rubygems, etc. This gets
+  # slow, and CLI apps need to be fast.
+  # 2. You can workaround the above by having a convention mapping filename to
+  # command name, but then you have to do a lot of work to list all of the
+  # commands, which is actually a common thing to do.
+  # 3. Other ways to mitigate the performance issue (loading deps lazily) have
+  # their own complications and tradeoffs and don't fully solve the problem.
+  # 4. It's not actually that much work to maintain the mapping.
+  #
+  # ## Adding new commands globally:
+  #
+  # A "singleton-ish" instance of this class is stored as ChefCLI.commands_map.
+  # You can configure a multiple commands at once in a block using
+  # ChefCLI.commands, like so:
+  #
+  #   ChefCLI.commands do |c|
+  #     # assigns `chef my-command` to the class ChefCLI::Command::MyCommand.
+  #     # The "require path" is inferred to be "chef-cli/command/my_command"
+  #     c.builtin("my-command", :MyCommand)
+  #
+  #     # Set the require path explicitly:
+  #     c.builtin("weird-command", :WeirdoClass, require_path: "chef-cli/command/this_is_cray")
+  #
+  #     # You can add a description that will show up in `chef -h` output (recommended):
+  #     c.builtin("documented-cmd", :DocumentedCmd, desc: "A short description")
+  #   end
+  #
+  class CommandsMap
+    NULL_ARG = Object.new
+
+    CommandSpec = Struct.new(:name, :constant_name, :require_path, :description, :hidden)
+
+    class CommandSpec
+
+      def instantiate
+        require require_path
+        command_class = ChefCLI::Command.const_get(constant_name)
+        command_class.new
+      end
+
+    end
+
+    attr_reader :command_specs
+
+    def initialize
+      @command_specs = {}
+    end
+
+    def builtin(name, constant_name, require_path: NULL_ARG, desc: "", hidden: false)
+      if null?(require_path)
+        snake_case_path = name.tr("-", "_")
+        require_path = "chef-cli/command/#{snake_case_path}"
+      end
+      command_specs[name] = CommandSpec.new(name, constant_name, require_path, desc, hidden)
+    end
+
+    def instantiate(name)
+      spec_for(name).instantiate
+    end
+
+    def have_command?(name)
+      command_specs.key?(name)
+    end
+
+    def command_names
+      command_specs.keys
+    end
+
+    def spec_for(name)
+      command_specs[name]
+    end
+
+    private
+
+    def null?(argument)
+      argument.equal?(NULL_ARG)
+    end
+  end
+
+  def self.commands_map
+    @commands_map ||= CommandsMap.new
+  end
+
+  def self.commands
+    yield commands_map
+  end
+end

data/lib/chef-cli/completions/bash.sh.erb

@@ -0,0 +1,5 @@
+_chef_comp() {
+    local COMMANDS="<%= commands.keys.join(' ')-%>"
+    COMPREPLY=($(compgen -W "$COMMANDS" -- ${COMP_WORDS[COMP_CWORD]} ))
+}
+complete -F _chef_comp chef

data/lib/chef-cli/completions/chef.fish.erb

@@ -0,0 +1,10 @@
+# Fish Shell command-line completions for <%=ChefCLI::Dist::PRODUCT %>
+
+function __fish_chef_no_command --description 'Test if chef has yet to be given the main command'
+  set -l cmd (commandline -opc)
+  test (count $cmd) -eq 1
+end
+
+<% commands.each do |command, desc| -%>
+complete -c chef -f -n '__fish_chef_no_command' -a <%= command %> -d "<%= desc %>"
+<% end -%>

data/lib/chef-cli/completions/zsh.zsh.erb

@@ -0,0 +1,21 @@
+function _chef() {
+
+  local -a _1st_arguments
+  _1st_arguments=(
+  <% commands.each do |command, desc| -%>
+    '<%=command%>:<%=desc%>'
+  <% end -%>
+  )
+
+  _arguments \
+    '(-v --version)'{-v,--version}'[version information]' \
+    '*:: :->subcmds' && return 0
+
+  if (( CURRENT == 1 )); then
+    _describe -t commands "chef subcommand" _1st_arguments
+    return
+  fi
+}
+
+compdef _chef chef
+

data/lib/chef-cli/component_test.rb

@@ -0,0 +1,226 @@
+#
+# 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 "exceptions"
+require_relative "helpers"
+
+# https://github.com/bundler/bundler/issues/4368
+# As of rubygems 2.6.2, Rubygems will call Bundler::SpecSet#size, which does
+# not exist as of Bundler 1.11.2.
+#
+# `#size` and `#length` should be synonyms in idiomatic ruby so we alias to
+# make bundler and rubygems play nicely.
+if Object.const_defined?(:Bundler) &&
+    Bundler.const_defined?(:SpecSet) &&
+    Bundler::SpecSet.instance_methods.include?(:length) &&
+    !Bundler::SpecSet.instance_methods.include?(:size)
+
+  module Bundler
+    class SpecSet
+
+      alias_method :size, :length
+
+    end
+  end
+
+end
+
+module ChefCLI
+  class ComponentTest
+
+    class NullTestResult
+      def exitstatus
+        0
+      end
+
+      def stdout
+        ""
+      end
+
+      def stderr
+        ""
+      end
+    end
+
+    DEFAULT_TEST = lambda { |context| NullTestResult.new }
+
+    include Helpers
+
+    attr_accessor :base_dir
+
+    attr_writer :omnibus_root
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+      @unit_test = DEFAULT_TEST
+      @integration_test = DEFAULT_TEST
+      @smoke_test = DEFAULT_TEST
+      @base_dir = nil
+      @gem_name_for_base_dir = nil
+    end
+
+    def unit_test(&test_block)
+      @unit_test = test_block
+    end
+
+    def run_unit_test
+      instance_eval(&@unit_test)
+    end
+
+    def integration_test(&test_block)
+      @integration_test = test_block
+    end
+
+    def run_integration_test
+      instance_eval(&@integration_test)
+    end
+
+    def smoke_test(&test_block)
+      @smoke_test = test_block
+    end
+
+    def run_smoke_test
+      instance_eval(&@smoke_test)
+    end
+
+    def bin(binary)
+      File.join(omnibus_bin_dir, binary)
+    end
+
+    def embedded_bin(binary)
+      File.join(omnibus_embedded_bin_dir, binary)
+    end
+
+    def sh(command, options = {})
+      combined_opts = default_command_options.merge(options)
+
+      # Env is a hash, so it needs to be merged separately
+      if options.key?(:env)
+        combined_opts[:env] = default_command_options[:env].merge(options[:env])
+      end
+      system_command(command, combined_opts)
+    end
+
+    # Just like #sh but raises an error if the the command returns an
+    # unexpected exit code.
+    #
+    # Most verification steps just run a single command, then
+    # ChefCLI::Command::Verify#invoke_tests handles the results by inspecting
+    # the return value of the test block. For tests that run a lot of commands,
+    # this is inconvenient so you can use #sh! instead.
+    def sh!(*args)
+      sh(*args).tap { |result| result.error! }
+    end
+
+    # Run a command, if the command returns zero, raise an error,
+    # otherwise, if it returns non-zero or doesn't exist,
+    # return a passing command so that the test parser doesn't
+    # crash.
+    def fail_if_exit_zero(cmd_string, failure_string = "")
+      result = sh(cmd_string)
+      if result.status.exitstatus == 0
+        raise failure_string
+      else
+        sh("true")
+      end
+    rescue Errno::ENOENT
+      sh("true")
+    end
+
+    def nix_platform_native_bin_dir
+      if /darwin/ =~ RUBY_PLATFORM
+        "/usr/local/bin"
+      else
+        "/usr/bin"
+      end
+    end
+
+    def run_in_tmpdir(command, options = {})
+      tmpdir do |dir|
+        options[:cwd] = dir
+        sh(command, options)
+      end
+    end
+
+    def tmpdir
+      Dir.mktmpdir do |tmpdir|
+        yield tmpdir
+      end
+    end
+
+    def assert_present!
+      unless File.exist?( component_path )
+        raise MissingComponentError.new(name, "Could not find #{component_path}")
+      end
+    rescue Gem::LoadError => e
+      raise MissingComponentError.new(name, e)
+    end
+
+    def default_command_options
+      {
+        cwd: component_path,
+        env: {
+          # Add the embedded/bin to the PATH so that bundle executable can
+          # be found while running the tests.
+          path_variable_key => omnibus_path,
+          "CHEF_LICENSE" => "accept-no-persist",
+        },
+        timeout: 3600,
+      }
+    end
+
+    def component_path
+      if base_dir
+        File.join(omnibus_root, base_dir)
+      elsif gem_base_dir
+        gem_base_dir
+      else
+        raise "`base_dir` or `gem_base_dir` must be defined for component `#{name}`"
+      end
+    end
+
+    def gem_base_dir
+      return nil if @gem_name_for_base_dir.nil?
+      # There is no way to say "give me the latest prerelease OR normal version of this gem.
+      # So we first ask if there is a normal version, and if there is not, we ask if there
+      # is a prerelease version.  ">= 0.a" is how we ask for a prerelease version, because a
+      # prerelease version is defined as "any version with a letter in it."
+      gem = Gem::Specification.find_by_name(@gem_name_for_base_dir)
+      gem ||= Gem::Specification.find_by_name(@gem_name_for_base_dir, ">= 0.a")
+      gem.gem_dir
+    end
+
+    def gem_base_dir=(gem_name)
+      @gem_name_for_base_dir = gem_name
+    end
+
+    def omnibus_root
+      @omnibus_root || raise("`omnibus_root` must be set before running tests")
+    end
+
+    def omnibus_path
+      [omnibus_bin_dir, omnibus_embedded_bin_dir, ENV["PATH"]].join(File::PATH_SEPARATOR)
+    end
+
+    def path_variable_key
+      ENV.keys.grep(/\Apath\Z/i).first
+    end
+
+  end
+end

data/lib/chef-cli/configurable.rb

@@ -0,0 +1,88 @@
+#
+# 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 "chef/config"
+require "chef/workstation_config_loader"
+
+require_relative "cookbook_omnifetch"
+require_relative "chef_server_api_multi"
+
+# Define a config context for ChefCLI
+class Chef::Config
+
+  default(:policy_document_native_api, true)
+
+  config_context(:chefcli) do
+
+    # Error when we encounter unknown keys. This makes it clear to the user if
+    # they get the name of the config key wrong (e.g., `chefcli.generator`
+    # instead of `chefcli.generator_cookbook`).
+    config_strict_mode(true)
+
+    default(:generator_cookbook, File.expand_path("../skeletons/code_generator", __FILE__))
+
+    config_context(:generator) do
+      config_strict_mode(true)
+      configurable :copyright_holder
+      configurable :email
+      configurable :license
+    end
+  end
+end
+
+module ChefCLI
+  module Configurable
+
+    def chef_config
+      return @chef_config if @chef_config
+      config_loader.load
+      @chef_config = Chef::Config
+      CookbookOmnifetch.integration.default_chef_server_http_client = default_chef_server_http_client
+      @chef_config
+    end
+
+    def chefcli_config
+      chef_config.chefcli
+    end
+
+    def config_loader
+      @config_loader ||= Chef::WorkstationConfigLoader.new(config[:config_file])
+    end
+
+    def generator_config
+      chefcli_config.generator
+    end
+
+    def knife_config
+      chef_config.knife
+    end
+
+    def reset_config!
+      @chef_config = nil
+      @config_loader = nil
+    end
+
+    def default_chef_server_http_client
+      lambda do
+        ChefServerAPIMulti.new(@chef_config.chef_server_url,
+                               signing_key_filename: @chef_config.client_key,
+                               client_name: @chef_config.node_name)
+      end
+    end
+
+  end
+end