summaryrefslogtreecommitdiff
path: root/lib/chef/chef_fs/knife.rb
blob: b70d5341ae85617df38d314c81dc157e8bb567a0 (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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
#
# Author:: John Keiser (<jkeiser@opscode.com>)
# Copyright:: Copyright (c) 2012 Opscode, 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/chef_fs/file_system/chef_server_root_dir'
require 'chef/chef_fs/file_system/chef_repository_file_system_root_dir'
require 'chef/chef_fs/file_pattern'
require 'chef/chef_fs/path_utils'
require 'chef/config'

class Chef
  module ChefFS
    class Knife < Chef::Knife
      def self.common_options
        option :repo_mode,
          :long => '--repo-mode MODE',
          :default => "default",
          :description => "Specifies the local repository layout.  Values: default or full"
      end

      def chef_fs
        @chef_fs ||= Chef::ChefFS::FileSystem::ChefServerRootDir.new("remote", Chef::Config, config[:repo_mode])
      end

      def chef_repo_path
        @chef_repo_path ||= begin
          if Chef::Config.chef_repo_path
            File.expand_path(Chef::Config.chef_repo_path)
          elsif Chef::Config.cookbook_path
            File.expand_path('..', Array(Chef::Config.cookbook_path).flatten.first)
          else
            nil
          end
        end
      end

      # Smooth out some inappropriate (for now) variable defaults in Chef.
      def config_var(name)
        case name
        when :data_bag_path
          Chef::Config[name] == Chef::Config.platform_specific_path('/var/chef/data_bags') ? nil : Chef::Config[name]
        when :node_path
          Chef::Config[name] == '/var/chef/node' ? nil : Chef::Config[name]
        when :role_path
          Chef::Config[name] == Chef::Config.platform_specific_path('/var/chef/roles') ? nil : Chef::Config[name]
        when :chef_repo_path
          chef_repo_path
        else
          Chef::Config[name]
        end
      end

      def object_paths
        @object_paths ||= begin
          result = {}
          %w(clients cookbooks data_bags environments nodes roles users).each do |object_name|
            variable_name = "#{object_name[0..-2]}_path" # cookbooks -> cookbook_path
            paths = config_var(variable_name.to_sym)
            if !paths
              if !chef_repo_path
                # TODO if chef_repo is not specified and repo_mode does not require
                # clients/users/nodes, don't require them to be specified.
                Chef::Log.error("Must specify either chef_repo_path or #{variable_name} in Chef config file")
                exit(1)
              end
              paths = File.join(chef_repo_path, object_name)
            end
            paths = Array(paths).flatten.map { |path| File.expand_path(path) }
            result[object_name] = paths
          end
          result
        end
      end

      # Returns the given real path's location relative to the server root.
      #
      # If chef_repo is /home/jkeiser/chef_repo,
      # and pwd is /home/jkeiser/chef_repo/cookbooks,
      # server_path('blah') == '/cookbooks/blah'
      # server_path('../roles/blah.json') == '/roles/blah'
      # server_path('../../readme.txt') == nil
      # server_path('*/*ab*') == '/cookbooks/*/*ab*'
      # server_path('/home/jkeiser/chef_repo/cookbooks/blah') == '/cookbooks/blah'
      # server_path('/home/*/chef_repo/cookbooks/blah') == nil
      #
      # If there are multiple paths (cookbooks, roles, data bags, etc. can all
      # have separate paths), and cwd+the path reaches into one of them, we will
      # return a path relative to that.  Otherwise we will return a path to
      # chef_repo.
      #
      # Globs are allowed as well, but globs outside server paths are NOT
      # (presently) supported.  See above examples.  TODO support that.
      #
      # If the path does not reach into ANY specified directory, nil is returned.
      def server_path(file_path)
        pwd = File.expand_path(Dir.pwd)
        absolute_path = File.expand_path(file_path, pwd)

        # Check all object paths (cookbooks_dir, data_bags_dir, etc.)
        object_paths.each_pair do |name, paths|
          paths.each do |path|
            if absolute_path[0,path.length] == path
              relative_path = Chef::ChefFS::PathUtils::relative_to(path, absolute_path)
              return relative_path == '.' ? "/#{name}" : "/#{name}/#{relative_path}"
            end
          end
        end

        # Check chef_repo_path
        if chef_repo_path[0,absolute_path.length] == absolute_path
          relative_path = Chef::ChefFS::PathUtils::relative_to(chef_repo_path, absolute_path)
          return relative_path == '.' ? '/' : "/#{relative_path}"
        end

        nil
      end

      # The current directory, relative to server root
      def base_path
        @base_path ||= server_path(File.expand_path(Dir.pwd))
      end

      # Print the given server path, relative to the current directory
      def format_path(server_path)
        if base_path && server_path[0,base_path.length] == base_path
          if server_path == base_path
            return "."
          elsif server_path[base_path.length] == "/"
            return server_path[base_path.length + 1, server_path.length - base_path.length - 1]
          elsif base_path == "/" && server_path[0] == "/"
            return server_path[1, server_path.length - 1]
          end
        end
        server_path
      end

      def local_fs
        @local_fs ||= Chef::ChefFS::FileSystem::ChefRepositoryFileSystemRootDir.new(object_paths)
      end

      def pattern_args
        @pattern_args ||= pattern_args_from(name_args)
      end

      def pattern_args_from(args)
        # TODO support absolute file paths and not just patterns?  Too much?
        # Could be super useful in a world with multiple repo paths
        args.map do |arg|
          Chef::ChefFS::FilePattern::relative_to(base_path, arg)
        end
      end

    end
  end
end