summaryrefslogtreecommitdiff
path: root/lib/chef/knife/core/hashed_command_loader.rb
blob: b88cededc0075789bb1f6de57e845c47457aefae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# Author:: Steven Danna (<steve@chef.io>)
# Copyright:: Copyright (c) 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 "../../version"
class Chef
  class Knife
    class SubcommandLoader
      #
      # Load a subcommand from a pre-computed path
      # for the given command.
      #
      class HashedCommandLoader < Chef::Knife::SubcommandLoader
        KEY = "_autogenerated_command_paths".freeze

        attr_accessor :manifest

        def initialize(chef_config_dir, plugin_manifest)
          super(chef_config_dir)
          @manifest = plugin_manifest
        end

        def guess_category(args)
          category_words = positional_arguments(args)
          category_words.map! { |w| w.split("-") }.flatten!
          find_longest_key(manifest[KEY]["plugins_by_category"], category_words, " ")
        end

        def list_commands(pref_category = nil)
          if pref_category || manifest[KEY]["plugins_by_category"].key?(pref_category)
            commands = { pref_category => manifest[KEY]["plugins_by_category"][pref_category] }
          else
            commands = manifest[KEY]["plugins_by_category"]
          end
          # If any of the specified plugins in the manifest don't have a valid path we will
          # eventually get an error and the user will need to rehash - instead, lets just
          # print out 1 error here telling them to rehash
          errors = {}
          commands.collect { |k, v| v }.flatten.each do |command|
            paths = manifest[KEY]["plugins_paths"][command]
            if paths && paths.is_a?(Array)
              # It is only an error if all the paths don't exist
              if paths.all? { |sc| !File.exists?(sc) }
                errors[command] = paths
              end
            end
          end
          if errors.empty?
            commands
          else
            Chef::Log.error "There are plugin files specified in the knife cache that cannot be found. Please run knife rehash to update the subcommands cache. If you see this error after rehashing delete the cache at #{Chef::Knife::SubcommandLoader.plugin_manifest_path}"
            Chef::Log.error "Missing files:\n\t#{errors.values.flatten.join("\n\t")}"
            {}
          end
        end

        def subcommand_files
          manifest[KEY]["plugins_paths"].values.flatten
        end

        def load_command(args)
          paths = manifest[KEY]["plugins_paths"][subcommand_for_args(args)]
          if paths.nil? || paths.empty? || (! paths.is_a? Array)
            false
          else
            paths.each do |sc|
              if File.exists?(sc)
                Kernel.load sc
              else
                return false
              end
            end
            true
          end
        end

        def subcommand_for_args(args)
          if manifest[KEY]["plugins_paths"].key?(args)
            args
          else
            find_longest_key(manifest[KEY]["plugins_paths"], args, "_")
          end
        end
      end
    end
  end
end