Option for variable expansion when setting environment variables

README.md

@@ -48,6 +48,15 @@ end
 
 This will export an `EDITOR` environment variable with a value of `vim`.
 
+By default environment variables set using `magic_shell_environment` do not permit variable expansion. You can allow this using the `expand` option:
+
+```ruby
+magic_shell_environment 'PATH' do
+  value '/my/custom.path:$PATH'
+  expand true
+end
+```
+
 You can also remove environment variables:
 
 ```ruby

providers/environment.rb

@@ -2,8 +2,12 @@
   environment_name = new_resource.environment_variable.gsub(/ /,"_")
   if !new_resource.value.nil?
     Chef::Log.info("Adding #{environment_name}.sh to /etc/profile.d/")
+
+    # Variable expansion option
+    quote = !!new_resource.expand ? '"' : "'"
+
     file_contents = "# This file was generated by Chef for #{node["fqdn"]}\n"
-    file_contents += "export #{environment_name}='#{new_resource.value}'"
+    file_contents += "export #{environment_name}=#{quote}#{new_resource.value}#{quote}"
     resource = file "/etc/profile.d/#{environment_name}.sh" do
       owner "root"
       group "root"

resources/environment.rb

@@ -8,6 +8,9 @@
 attribute :value,
   :kind_of => String,
   :default => :add
+attribute :expand,
+  :kind_of => [TrueClass, FalseClass],
+  :default => false
 
 # Default action for Chef <= 10.8
 def initialize(*args)

spec/cookbooks/environment/recipes/add_with_expansion.rb

@@ -0,0 +1,4 @@
+magic_shell_environment 'PATH' do
+  value '/my/custom/path:$PATH'
+  expand true
+end

spec/cookbooks/environment/recipes/add_without_expansion.rb

@@ -0,0 +1,3 @@
+magic_shell_environment 'PATH' do
+  value '/my/custom/path:$PATH'
+end

spec/environment_spec.rb

@@ -18,5 +18,15 @@
       chef_run.converge('environment::add_explicit')
       expect(chef_run).to set_a_magic_shell_environment_variable('RAILS_ENV').with_value('production')
     end
+
+    it 'variable expansion is disabled by default' do
+      chef_run.converge('environment::add_without_expansion')
+      expect(chef_run).to set_a_magic_shell_environment_variable('PATH').with_value('/my/custom/path:$PATH').with_quote("'")
+    end
+
+    it 'variable expansion can be enabled' do
+      chef_run.converge('environment::add_with_expansion')
+      expect(chef_run).to set_a_magic_shell_environment_variable('PATH').with_value('/my/custom/path:$PATH').with_quote('"')
+    end
   end
 end

spec/support/environment.rb

@@ -11,6 +11,10 @@
     @value = value
   end
 
+  chain :with_quote do |quote|
+    @quote = quote
+  end
+
   failure_message_for_should do |chef_run|
     if chef_run.file(filepath)
       "expected `#{filepath}` to have content:\n\n   #{content}\n\nbut got:\n\n   #{chef_run.file(filepath).content.split("\n").join("\n   ")}"
@@ -34,6 +38,7 @@ def filepath
   end
 
   def content
-    @value ? "export #{@variable}='#{@value}'" : "export #{@variable}"
+    q = @quote || "'"
+    @value ? "export #{@variable}=#{q}#{@value}#{q}" : "export #{@variable}"
   end
 end