summaryrefslogtreecommitdiff
path: root/lib/chef/provider/env.rb
blob: 5b252dd34415be40d97c08411e8cec1489f64d0d (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:: Doug MacEachern (<dougm@vmware.com>)
# Copyright:: Copyright 2010-2016, VMware, 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/provider"
require "chef/mixin/command"
require "chef/resource/env"

class Chef
  class Provider
    class Env < Chef::Provider
      include Chef::Mixin::Command
      attr_accessor :key_exists

      provides :env, os: "!windows"

      def initialize(new_resource, run_context)
        super
        @key_exists = true
      end

      def load_current_resource
        @current_resource = Chef::Resource::Env.new(@new_resource.name)
        @current_resource.key_name(@new_resource.key_name)

        if env_key_exists(@new_resource.key_name)
          @current_resource.value(env_value(@new_resource.key_name))
        else
          @key_exists = false
          Chef::Log.debug("#{@new_resource} key does not exist")
        end

        @current_resource
      end

      def env_value(key_name)
        raise Chef::Exceptions::Env, "#{self} provider does not implement env_value!"
      end

      def env_key_exists(key_name)
        env_value(key_name) ? true : false
      end

      # Check to see if value needs any changes
      #
      # ==== Returns
      # <true>:: If a change is required
      # <false>:: If a change is not required
      def requires_modify_or_create?
        if @new_resource.delim
          #e.g. check for existing value within PATH
          new_values.inject(0) do |index, val|
            next_index = current_values.find_index val
            return true if next_index.nil? || next_index < index
            next_index
          end
          false
        else
          @new_resource.value != @current_resource.value
        end
      end

      alias_method :compare_value, :requires_modify_or_create?

      def action_create
        if @key_exists
          if requires_modify_or_create?
            modify_env
            Chef::Log.info("#{@new_resource} altered")
            @new_resource.updated_by_last_action(true)
          end
        else
          create_env
          Chef::Log.info("#{@new_resource} created")
          @new_resource.updated_by_last_action(true)
        end
      end

      #e.g. delete a PATH element
      #
      # ==== Returns
      # <true>:: If we handled the element case and caller should not delete the key
      # <false>:: Caller should delete the key, either no :delim was specific or value was empty
      #           after we removed the element.
      def delete_element
        return false unless @new_resource.delim #no delim: delete the key
        needs_delete = new_values.any? { |v| current_values.include?(v) }
        if !needs_delete
          Chef::Log.debug("#{@new_resource} element '#{@new_resource.value}' does not exist")
          return true #do not delete the key
        else
          new_value =
            current_values.select do |item|
              not new_values.include?(item)
            end.join(@new_resource.delim)

          if new_value.empty?
            return false #nothing left here, delete the key
          else
            old_value = @new_resource.value(new_value)
            create_env
            Chef::Log.debug("#{@new_resource} deleted #{old_value} element")
            @new_resource.updated_by_last_action(true)
            return true #we removed the element and updated; do not delete the key
          end
        end
      end

      def action_delete
        if @key_exists && !delete_element
          delete_env
          Chef::Log.info("#{@new_resource} deleted")
          @new_resource.updated_by_last_action(true)
        end
      end

      def action_modify
        if @key_exists
          if requires_modify_or_create?
            modify_env
            Chef::Log.info("#{@new_resource} modified")
            @new_resource.updated_by_last_action(true)
          end
        else
          raise Chef::Exceptions::Env, "Cannot modify #{@new_resource} - key does not exist!"
        end
      end

      def create_env
        raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :#{@new_resource.action}"
      end

      def delete_env
        raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :delete"
      end

      def modify_env
        if @new_resource.delim
          @new_resource.value((new_values + current_values).uniq.join(@new_resource.delim))
        end
        create_env
      end

      # Returns the current values to split by delimiter
      def current_values
        @current_values ||= @current_resource.value.split(@new_resource.delim)
      end

      # Returns the new values to split by delimiter
      def new_values
        @new_values ||= @new_resource.value.split(@new_resource.delim)
      end
    end
  end
end