summaryrefslogtreecommitdiff
path: root/lib/chef/mixin/which.rb
blob: 8a825f55c9eef29f2ed81bcb6258497d6db27a6d (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
#--
# Author:: Lamont Granquist <lamont@chef.io>
# Copyright:: Copyright 2010-2017, 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.

class Chef
  module Mixin
    module Which
      def which(*cmds, extra_path: nil, &block)
        where(*cmds, extra_path: extra_path, &block).first || false
      end

      def where(*cmds, extra_path: nil, &block)
        # NOTE: unnecessarily duplicates function of path_sanity
        extra_path ||= [ "/bin", "/usr/bin", "/sbin", "/usr/sbin" ]
        paths = env_path.split(File::PATH_SEPARATOR) + Array(extra_path)
        cmds.map do |cmd|
          paths.map do |path|
            filename = Chef.path_to(File.join(path, cmd))
            filename if valid_executable?(filename, &block)
          end.compact
        end.flatten
      end

      private

      # for test stubbing
      def env_path
        ENV["PATH"]
      end

      def valid_executable?(filename, &block)
        return false unless File.executable?(filename) && !File.directory?(filename)
        block ? yield(filename) : true
      end
    end
  end
end