(PUP-11691) Report configured environmentpath when a symlink

Author: justinstoller

lib/puppet/defaults.rb

@@ -421,6 +421,19 @@ def self.initialize_default_settings!(settings)
         <https://puppet.com/docs/puppet/latest/environments_about.html>",
       :type    => :path,
     },
+    :report_configured_environmentpath => {
+      :type     => :boolean,
+      :default  => true,
+      :desc     => <<-'EOT'
+      When versioned_environment_dirs is `true` Puppet will readlink the environmentpath
+      when constructing the environment's modulepath. The full readlinked path is referred
+      to as the "resolved path" and the configured path potentially containing symlinks is
+      the "configured path". When reporting where resources come from users may choose
+      between the configured or resolved path.
+
+      When set to false, the resolved paths are reported instead of the configured paths.
+    EOT
+    },
     :use_last_environment => {
       :type     => :boolean,
       :default  => true,

lib/puppet/environments.rb

@@ -243,6 +243,15 @@ def create_environment(name)
         setting_values.interpolate(:manifest),
         setting_values.interpolate(:config_version)
       )
+
+      configured_path = File.join(@environment_dir, name.to_s)
+      env.configured_path = configured_path
+      if Puppet.settings[:report_configured_environmentpath]
+        env.resolved_path = validated_directory(configured_path)
+      else
+        env.resolved_path = configured_path
+      end
+
       env
     end
 

lib/puppet/node/environment.rb

@@ -166,6 +166,44 @@ def full_modulepath
   # @api private
   attr_reader :lock
 
+  # For use with versioned dirs
+  # our environment path may contain symlinks, while we want to resolve the
+  # path while reading the manifests we may want to report the resources as
+  # coming from the configured path.
+  attr_accessor :configured_path
+
+  # See :configured_path above
+  attr_accessor :resolved_path
+
+  # Ensure the path given is of the format we want in the catalog/report.
+  #
+  # Intended for use with versioned symlinked environments. If this
+  # environment is configured with "/etc/puppetlabs/code/environments/production"
+  # but the resolved path is
+  #
+  # "/opt/puppetlabs/server/puppetserver/filesync/client/puppet-code/production_abcdef1234"
+  #
+  # this changes the filepath
+  #
+  # "/opt/puppetlabs/server/puppetserver/filesync/client/puppet-code/production_abcdef1234/modules/foo/manifests/init.pp"
+  #
+  # to
+  #
+  # "/etc/puppetlabs/code/environments/production/modules/foo/manifests/init.pp"
+  def externalize_path(filepath)
+    paths_set        = configured_path && resolved_path
+    munging_possible = paths_set && configured_path != resolved_path
+    munging_desired  = munging_possible &&
+                         Puppet[:report_configured_environmentpath] &&
+                         filepath.to_s.start_with?(resolved_path)
+
+    if munging_desired
+      File.join(configured_path, filepath.delete_prefix(resolved_path))
+    else
+      filepath
+    end
+  end
+
   # Checks to make sure that this environment did not have a manifest set in
   # its original environment.conf if Puppet is configured with
   # +disable_per_environment_manifest+ set true.  If it did, the environment's

lib/puppet/resource.rb

@@ -323,6 +323,10 @@ def initialize(type, title = nil, attributes = EMPTY_HASH)
         send(attr.to_s + "=", value)
       end
 
+      if environment.is_a?(Puppet::Node::Environment) && environment != Puppet::Node::Environment::NONE
+        self.file = environment.externalize_path(attributes[:file])
+      end
+
       @type, @title = self.class.type_and_title(type, title)
 
       rt = resource_type

spec/unit/environments_spec.rb

@@ -115,6 +115,15 @@ def remove
       end
     end
 
+    it "sets the environment's configured and resolved paths set when symlinked" do
+      loader_from(:filesystem => [directory_tree],
+                  :directory => directory_tree.children.first) do |loader|
+        env = loader.get("symlinked_environment")
+        expect(env.resolved_path).to eq("#{FS.path_string(directory_tree)}/versioned_env")
+        expect(env.configured_path).to eq("#{FS.path_string(directory_tree)}/envdir/symlinked_environment")
+      end
+    end
+
     it "ignores symlinked environments when `:versioned_environment_dirs` is false" do
       Puppet[:versioned_environment_dirs] = false
       loader_from(:filesystem => [directory_tree],

spec/unit/node/environment_spec.rb

@@ -40,6 +40,47 @@
       expect(e.inspect).to match(%r{<Puppet::Node::Environment:\w* @name="test" @manifest="#{File.expand_path('/manifests/path')}" @modulepath="#{File.expand_path('/modules/path')}:#{File.expand_path('/other/modules')}" >})
     end
 
+    describe "externalizing filepaths" do
+      before(:each) do
+        env.resolved_path = "/opt/puppetlabs/envs/prod_123"
+        env.configured_path = "/etc/puppetlabs/envs/prod"
+
+        @vendored_manifest = "/opt/puppetlabs/vendored/modules/foo/manifests/init.pp"
+        @production_manifest = "/opt/puppetlabs/envs/prod_123/modules/foo/manifests/init.pp"
+      end
+
+      it "leaves paths alone if they do not match the resolved path" do
+        expect(env.externalize_path(@vendored_manifest)).to eq(@vendored_manifest)
+      end
+
+      it "leaves paths alone if resolved or configured paths are not set" do
+        env.resolved_path = nil
+        env.configured_path = nil
+        expect(env.externalize_path(@production_manifest)).to eq(@production_manifest)
+      end
+
+      it "replaces resolved paths with configured paths" do
+        externalized_path = env.externalize_path(@production_manifest)
+        expect(externalized_path).to eq("/etc/puppetlabs/envs/prod/modules/foo/manifests/init.pp")
+      end
+
+      it "handles nil" do
+        externalized_path = env.externalize_path(nil)
+        expect(externalized_path).to eq(nil)
+      end
+
+      it "appropriately handles mismatched trailing slashes" do
+        env.resolved_path = "/opt/puppetlabs/envs/prod_123/"
+        externalized_path = env.externalize_path(@production_manifest)
+        expect(externalized_path).to eq("/etc/puppetlabs/envs/prod/modules/foo/manifests/init.pp")
+      end
+
+      it "can be disabled with the `report_configured_environmentpath` setting" do
+        Puppet[:report_configured_environmentpath] = false
+        expect(env.externalize_path(@production_manifest)).to eq(@production_manifest)
+      end
+    end
+
     describe "equality" do
       it "works as a hash key" do
         base = Puppet::Node::Environment.create(:first, ["modules"], "manifests")

spec/unit/parser/resource_spec.rb

@@ -108,6 +108,15 @@ def newnode(name)
       }.to raise_error(ArgumentError, /Resources require a hash as last argument/)
     end
 
+    it "should attempt to externalize filepaths via the environment" do
+      environment = Puppet::Node::Environment.create(:testing, [])
+      expect(environment).to receive(:externalize_path).at_least(:once).and_return("foo")
+      Puppet[:code] = "notify { 'hello': }"
+      catalog = Puppet::Parser::Compiler.compile(Puppet::Node.new 'anyone', environment: environment)
+      notify = catalog.resource('Notify[hello]')
+      expect(notify.file).to eq("foo")
+    end
+
     it "should set the reference correctly" do
       res = Puppet::Parser::Resource.new("resource", "testing", @arguments)
       expect(res.ref).to eq("Resource[testing]")