puppet 6.29.0 → 7.0.0

data/spec/unit/environments_spec.rb

@@ -1,17 +1,14 @@
 require 'spec_helper'
 require 'puppet/environments'
 require 'puppet/file_system'
+require 'matchers/include'
+require 'matchers/include_in_order'
 
+module PuppetEnvironments
 describe Puppet::Environments do
-  FS = Puppet::FileSystem
+  include Matchers::Include
 
-  module FsRemove
-    def remove
-      @properties[:directory?] = false
-      @properties[:exist?] = false
-      @properties[:executable?] = false
-    end
-  end
+  FS = Puppet::FileSystem
 
   before(:each) do
     Puppet.settings.initialize_global_settings
@@ -52,7 +49,7 @@ describe Puppet::Environments do
       loader_from(:filesystem => [directory_tree, global_path_1, global_path_2],
                   :directory => directory_tree.children.first,
                   :modulepath => [global_path_1_location, global_path_2_location]) do |loader|
-        expect(loader.list).to contain_exactly(
+        expect(loader.list).to include_in_any_order(
           environment(:an_environment).
             with_manifest("#{FS.path_string(directory_tree)}/envdir/an_environment/manifests").
             with_modulepath(["#{FS.path_string(directory_tree)}/envdir/an_environment/modules",
@@ -90,7 +87,7 @@ describe Puppet::Environments do
 
       loader_from(:filesystem => [envdir],
                   :directory => envdir) do |loader|
-        expect(loader.list).to contain_exactly(environment(:env1), environment(:env2))
+        expect(loader.list).to include_in_any_order(environment(:env1), environment(:env2))
       end
     end
 
@@ -139,14 +136,6 @@ describe Puppet::Environments do
       end
     end
 
-    it "implements guard and unguard" do
-      loader_from(:filesystem => [directory_tree],
-                  :directory => directory_tree.children.first) do |loader|
-        expect(loader.guard('env1')).to be_nil
-        expect(loader.unguard('env1')).to be_nil
-      end
-    end
-
     context "with an environment.conf" do
       let(:envdir) do
         FS::MemoryFile.a_directory(File.expand_path("envdir"), [
@@ -417,29 +406,33 @@ config_version=$vardir/random/scripts
           ]),
         ])
 
-        cached_loader_from(:filesystem => [original_envdir], :directory => original_envdir) do |loader|
-          original_env = loader.get("env3") # force the environment.conf to be read
-
-          changed_envdir = FS::MemoryFile.a_directory(base_dir, [
-            FS::MemoryFile.a_directory("env3", [
-              FS::MemoryFile.a_regular_file_containing("environment.conf", <<-EOF)
-                manifest=/manifest_changed
-                modulepath=/modules_changed
-                environment_timeout=0
-              EOF
-            ]),
-          ])
+        FS.overlay(original_envdir) do
+          dir_loader = Puppet::Environments::Directories.new(original_envdir, [])
+          loader = Puppet::Environments::Cached.new(dir_loader)
+          Puppet.override(:environments => loader) do
+            original_env = loader.get("env3") # force the environment.conf to be read
+
+            changed_envdir = FS::MemoryFile.a_directory(base_dir, [
+              FS::MemoryFile.a_directory("env3", [
+                FS::MemoryFile.a_regular_file_containing("environment.conf", <<-EOF)
+                  manifest=/manifest_changed
+                  modulepath=/modules_changed
+                  environment_timeout=0
+                EOF
+              ]),
+            ])
 
-          FS.overlay(changed_envdir) do
-            changed_env = loader.get("env3")
+            FS.overlay(changed_envdir) do
+              changed_env = loader.get("env3")
 
-            expect(original_env).to environment(:env3).
-              with_manifest(File.expand_path("/manifest_orig")).
-              with_full_modulepath([File.expand_path("/modules_orig")])
+              expect(original_env).to environment(:env3).
+                with_manifest(File.expand_path("/manifest_orig")).
+                with_full_modulepath([File.expand_path("/modules_orig")])
 
-            expect(changed_env).to environment(:env3).
-              with_manifest(File.expand_path("/manifest_changed")).
-              with_full_modulepath([File.expand_path("/modules_changed")])
+              expect(changed_env).to environment(:env3).
+                with_manifest(File.expand_path("/manifest_changed")).
+                with_full_modulepath([File.expand_path("/modules_changed")])
+            end
           end
         end
       end
@@ -565,49 +558,24 @@ config_version=$vardir/random/scripts
 
   describe "cached loaders" do
     it "lists environments" do
-      cached_loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
-        expect(loader.list).to contain_exactly(
+      loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
+        expect(Puppet::Environments::Cached.new(loader).list).to include_in_any_order(
           environment(:an_environment),
           environment(:another_environment),
           environment(:symlinked_environment))
       end
     end
 
-    it "returns the same cached environment object for list and get methods" do
-      cached_loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
-        env = loader.list.find { |e| e.name == :an_environment }
-
-        expect(env).to equal(loader.get(:an_environment)) # same object
-      end
-    end
-
-    it "returns the same cached environment object for multiple list calls" do
-      cached_loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
-        expect(loader.list.first).to equal(loader.list.first) # same object
-      end
-    end
-
-    it "expires environments and returns a new environment object with the same value" do
-      Puppet[:environment_timeout] = "0"
-
-      cached_loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
-        a = loader.list.first
-        b = loader.list.first
-        expect(a).to eq(b)        # same value
-        expect(a).to_not equal(b) # not same object
-      end
-    end
-
     it "has search_paths" do
-      cached_loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
-        expect(loader.search_paths).to eq(["file://#{directory_tree.children.first}"])
+      loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
+        expect(Puppet::Environments::Cached.new(loader).search_paths).to eq(["file://#{directory_tree.children.first}"])
       end
     end
 
     context "#get" do
       it "gets an environment" do
-        cached_loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
-          expect(loader.get(:an_environment)).to environment(:an_environment)
+        loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
+          expect(Puppet::Environments::Cached.new(loader).get(:an_environment)).to environment(:an_environment)
         end
       end
 
@@ -623,89 +591,17 @@ config_version=$vardir/random/scripts
         cached.get(:cached)
       end
 
-      it "does not list deleted environments" do
-        env3 = FS::MemoryFile.a_directory("env3", [
-          FS::MemoryFile.a_regular_file_containing("environment.conf", '')
-        ])
-
-        envdir = FS::MemoryFile.a_directory(File.expand_path("envdir"), [
-          FS::MemoryFile.a_directory("env1", [
-            FS::MemoryFile.a_regular_file_containing("environment.conf", '')
-          ]),
-          FS::MemoryFile.a_directory("env2", [
-            FS::MemoryFile.a_regular_file_containing("environment.conf", '')
-          ]),
-          env3
-        ])
-
-        loader_from(:filesystem => [envdir], :directory => envdir) do |loader|
-          cached = Puppet::Environments::Cached.new(loader)
-          cached.get(:env1)
-          cached.get(:env2)
-          cached.get(:env3)
-          env3.extend(FsRemove).remove
-
-          expect(cached.list).to contain_exactly(environment(:env1),environment(:env2))
-          expect(cached.get(:env3)).to be_nil
-        end
-      end
-
-      it "normalizes environment name to symbol" do
-        env = Puppet::Node::Environment.create(:cached, [])
-        mocked_loader = double('loader')
-
-        expect(mocked_loader).not_to receive(:get).with('cached')
-        expect(mocked_loader).to receive(:get).with(:cached).and_return(env).once
-        expect(mocked_loader).to receive(:get_conf).with(:cached).and_return(Puppet::Settings::EnvironmentConf.static_for(env, 20)).once
-
-        cached = Puppet::Environments::Cached.new(mocked_loader)
-        cached.get('cached')
-        cached.get(:cached)
-      end
-
-      it "caches environment name as symbol and only once" do
-        mocked_loader = double('loader')
-
-        env = Puppet::Node::Environment.create(:cached, [])
-        allow(mocked_loader).to receive(:get).with(:cached).and_return(env)
-        allow(mocked_loader).to receive(:get_conf).with(:cached).and_return(Puppet::Settings::EnvironmentConf.static_for(env, 20))
-
-        cached = Puppet::Environments::Cached.new(mocked_loader)
-        cached.get(:cached)
-        cached.get('cached')
-
-        expect(cached.instance_variable_get(:@cache).keys).to eq([:cached])
-      end
-
-      it "is able to cache multiple environments" do
-        mocked_loader = double('loader')
-
-        env1 = Puppet::Node::Environment.create(:env1, [])
-        allow(mocked_loader).to receive(:get).with(:env1).and_return(env1)
-        allow(mocked_loader).to receive(:get_conf).with(:env1).and_return(Puppet::Settings::EnvironmentConf.static_for(env1, 20))
-
-        env2 = Puppet::Node::Environment.create(:env2, [])
-        allow(mocked_loader).to receive(:get).with(:env2).and_return(env2)
-        allow(mocked_loader).to receive(:get_conf).with(:env2).and_return(Puppet::Settings::EnvironmentConf.static_for(env2, 20))
-
-        cached = Puppet::Environments::Cached.new(mocked_loader)
-        cached.get('env1')
-        cached.get('env2')
-
-        expect(cached.instance_variable_get(:@cache).keys).to eq([:env1, :env2])
-      end
-
       it "returns nil if env not found" do
-        cached_loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
-          expect(loader.get(:doesnotexist)).to be_nil
+        loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
+          expect(Puppet::Environments::Cached.new(loader).get(:doesnotexist)).to be_nil
         end
       end
     end
 
     context "#get!" do
       it "gets an environment" do
-        cached_loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
-          expect(loader.get!(:an_environment)).to environment(:an_environment)
+        loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
+          expect(Puppet::Environments::Cached.new(loader).get!(:an_environment)).to environment(:an_environment)
         end
       end
 
@@ -722,54 +618,29 @@ config_version=$vardir/random/scripts
       end
 
       it "raises error if environment is not found" do
-        cached_loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
+        loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
           expect do
-            loader.get!(:doesnotexist)
+            Puppet::Environments::Cached.new(loader).get!(:doesnotexist)
           end.to raise_error(Puppet::Environments::EnvironmentNotFound)
         end
       end
     end
 
-    context "#get_conf" do
-      it "loads environment.conf" do
-        cached_loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
-          expect(loader.get_conf(:an_environment)).to match_environment_conf(:an_environment).
-            with_env_path(directory_tree.children.first).
-            with_global_module_path([])
-        end
-      end
-
-      it "always reloads environment.conf" do
-        env = Puppet::Node::Environment.create(:cached, [])
-        mocked_loader = double('loader')
-        expect(mocked_loader).to receive(:get_conf).with(:cached).and_return(Puppet::Settings::EnvironmentConf.static_for(env, 20)).twice
-
-        cached = Puppet::Environments::Cached.new(mocked_loader)
-
-        cached.get_conf(:cached)
-        cached.get_conf(:cached)
-      end
-
-      it "normalizes environment name to symbol" do
-        env = Puppet::Node::Environment.create(:cached, [])
-        mocked_loader = double('loader')
-        expect(mocked_loader).to receive(:get_conf).with(:cached).and_return(Puppet::Settings::EnvironmentConf.static_for(env, 20)).twice
-
-        cached = Puppet::Environments::Cached.new(mocked_loader)
+    context "expiration policies" do
+      let(:service) { ReplayExpirationService.new }
 
-        cached.get_conf('cached')
-        cached.get_conf(:cached)
-      end
+      # The environment named `:an_environment` will already be loaded when the
+      # block is yielded to
+      def with_environment_loaded(service, &block)
+        loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
+          using_expiration_service(service) do
+            cached = Puppet::Environments::Cached.new(loader)
+            cached.get!(:an_environment)
 
-      it "returns nil if environment is not found" do
-        cached_loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
-          expect(loader.get_conf(:doesnotexist)).to be_nil
+            yield cached if block_given?
+          end
         end
       end
-    end
-
-    context "expiration policies" do
-      let(:service) { ReplayExpirationService.new }
 
       it "notifies when the environment is first created" do
         with_environment_loaded(service)
@@ -789,7 +660,12 @@ config_version=$vardir/random/scripts
       end
 
       it "evicts an expired environment" do
-        expect(service).to receive(:expired?).and_return(true)
+        service = ReplayExpirationService.new
+
+        # The `Cached#clear_all_expired` method tries to optimize the case where
+        # no entries are expired. But if `Time.now < @next_expiration` and there is
+        # an expired entry, then the `service#expired?` method is called twice.
+        expect(service).to receive(:expired?).twice.and_return(true)
 
         with_environment_loaded(service) do |cached|
           cached.get!(:an_environment)
@@ -801,7 +677,6 @@ config_version=$vardir/random/scripts
 
       it "evicts an environment that hasn't been recently touched" do
         Puppet[:environment_timeout] = 1
-        Puppet[:environment_timeout_mode] = :from_last_used
 
         with_environment_loaded(service) do |cached|
           future = Time.now + 60
@@ -818,7 +693,6 @@ config_version=$vardir/random/scripts
 
       it "reuses an environment that was recently touched" do
         Puppet[:environment_timeout] = 60
-        Puppet[:environment_timeout_mode] = :from_last_used
 
         with_environment_loaded(service) do |cached|
           # reuse the already cached environment
@@ -831,9 +705,9 @@ config_version=$vardir/random/scripts
 
       it "evicts a recently touched environment" do
         Puppet[:environment_timeout] = 60
-        Puppet[:environment_timeout_mode] = :from_last_used
 
-        expect(service).to receive(:expired?).and_return(true)
+        # see note above about "twice"
+        expect(service).to receive(:expired?).twice.and_return(true)
 
         with_environment_loaded(service) do |cached|
           # even though the environment was recently touched, it's been expired
@@ -843,201 +717,13 @@ config_version=$vardir/random/scripts
         expect(service.created_envs).to eq([:an_environment, :an_environment])
         expect(service.evicted_envs).to eq([:an_environment])
       end
-
-      it "evicts expired environments when listing" do
-        expect(service).to receive(:expired?).with(:an_environment).and_return(true)
-
-        with_environment_loaded(service) do |cached|
-          cached.list
-        end
-
-        expect(service.evicted_envs).to eq([:an_environment])
-      end
-
-      context "when guarding an environment" do
-        before :each do
-          Puppet[:environment_timeout] = 0
-        end
-
-        let(:name) { :an_environment }
-
-        def with_guard(cached, name, &block)
-          cached.guard(name)
-          begin
-            yield
-          ensure
-            cached.unguard(name)
-          end
-        end
-
-        it "evicts an expired and unguarded environment" do
-          with_environment_loaded(service) do |cached|
-            cached.get!(name)
-          end
-
-          expect(service.created_envs).to eq([name, name])
-          expect(service.evicted_envs).to eq([name])
-        end
-
-        it "does not evict an expired, but guarded environment" do
-          with_environment_loaded(service) do |cached|
-            with_guard(cached, name) do
-              cached.get!(name) # these shouldn't reload
-              cached.get!(name)
-            end
-          end
-
-          expect(service.created_envs).to eq([name])
-          expect(service.evicted_envs).to eq([])
-        end
-
-        it "does not evict an environment marked for expiration, but is guarded" do
-          Puppet[:environment_timeout] = 'unlimited'
-
-          expect(service).to receive(:expired?).never
-
-          with_environment_loaded(service) do |cached|
-            with_guard(cached, name) do
-              cached.get!(name)
-            end
-          end
-
-          expect(service.created_envs).to eq([name])
-          expect(service.evicted_envs).to eq([])
-        end
-
-        it "evicts an environment that is no longer guarded" do
-          with_environment_loaded(service) do |cached|
-            with_guard(cached, name) {}
-
-            cached.get!(name) # this reloads
-          end
-
-          expect(service.created_envs).to eq([name, name])
-          expect(service.evicted_envs).to eq([name])
-        end
-
-        it "can nest guards" do
-          with_environment_loaded(service) do |cached|
-            with_guard(cached, name) do
-              with_guard(cached, name) do
-                cached.get!(name) # doesn't reload
-              end
-            end
-          end
-
-          expect(service.created_envs).to eq([name])
-          expect(service.evicted_envs).to eq([])
-        end
-      end
-    end
-
-    context '#clear' do
-      let(:service) { ReplayExpirationService.new }
-
-      it "evicts an environment" do
-        with_environment_loaded(service) do |cached|
-          cached.clear(:an_environment)
-        end
-
-        expect(service.evicted_envs).to eq([:an_environment])
-      end
-
-      it "normalizes environment name to symbol" do
-        with_environment_loaded(service) do |cached|
-          cached.clear('an_environment')
-        end
-
-        expect(service.evicted_envs).to eq([:an_environment])
-      end
     end
 
-    context '#clear_all' do
-      let(:service) { ReplayExpirationService.new }
-      let(:envdir) { File.expand_path("envdir") }
-      let(:default_dir) { File.join(envdir, "cached_env", "modules") }
-      let(:expected_dir) { File.join(envdir, "cached_env", "site") }
-
-      let(:base_dir) do
-        FS::MemoryFile.a_directory(envdir, [
-          FS::MemoryFile.a_directory("cached_env", [
-            FS::MemoryFile.a_missing_file("environment.conf")
-          ])
-        ])
-      end
-
-      let(:updated_dir) do
-        FS::MemoryFile.a_directory(envdir, [
-          FS::MemoryFile.a_directory("cached_env", [
-            FS::MemoryFile.a_directory("site"),
-            FS::MemoryFile.a_missing_directory("modules"),
-            FS::MemoryFile.a_regular_file_containing("environment.conf", <<-EOF)
-              modulepath=site
-              environment_timeout=unlimited
-            EOF
-          ])
-        ])
-      end
-
-      it 'evicts all environments' do
-        with_environment_loaded(service) do |cached|
-          cached.get(:an_environment)
-          cached.get(:another_environment)
-          cached.clear_all
-
-          expect(service.evicted_envs).to match([:an_environment, :another_environment])
-        end
-      end
-
-      it "recomputes modulepath if 'get' is called before 'clear_all'" do
-        cached_loader_from(:filesystem => [base_dir], :directory => base_dir) do |loader|
-          loader.get(:cached_env)
-
-          expect(Puppet.settings.value(:modulepath, :cached_env)).to eq(default_dir)
-
-          FS.overlay(updated_dir) do
-            loader.clear_all
-
-            expect(loader.get(:cached_env).modulepath).to contain_exactly(expected_dir)
-          end
-        end
-      end
-
-      it "recomputes modulepath if 'list' is called before 'clear_all'"  do
-        cached_loader_from(:filesystem => [base_dir], :directory => base_dir) do |loader|
-          loader.list
-
-          expect(Puppet.settings.value(:modulepath, :cached_env)).to eq(default_dir)
-
-          FS.overlay(updated_dir) do
-            loader.clear_all
-
-            expect(loader.get(:cached_env).modulepath).to contain_exactly(expected_dir)
-          end
-        end
-      end
-
-      it "recomputes modulepath if 'get_conf' is called before 'clear_all'" do
-        cached_loader_from(:filesystem => [base_dir], :directory => base_dir) do |loader|
-          loader.get_conf(:cached_env)
-
-          expect(Puppet.settings.value(:modulepath, :cached_env)).to eq(default_dir)
-
-          FS.overlay(updated_dir) do
-            loader.clear_all
-
-            expect(loader.get(:cached_env).modulepath).to contain_exactly(expected_dir)
-          end
-        end
-      end
-
-      it 'deletes environment text domains' do
-        with_environment_loaded(service) do |cached|
-          cached.get(:an_environment)
-          cached.clear_all
-
-          expect(FastGettext.text_domain).to eq(Puppet::GettextConfig::DEFAULT_TEXT_DOMAIN)
-        end
+    it "gets an environment.conf" do
+      loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
+        expect(Puppet::Environments::Cached.new(loader).get_conf(:an_environment)).to match_environment_conf(:an_environment).
+          with_env_path(directory_tree.children.first).
+          with_global_module_path([])
       end
     end
   end
@@ -1112,20 +798,6 @@ config_version=$vardir/random/scripts
     end
   end
 
-  def cached_loader_from(options, &block)
-    FS.overlay(*options[:filesystem]) do
-      environments = Puppet::Environments::Cached.new(
-        Puppet::Environments::Directories.new(
-          options[:directory],
-          options[:modulepath] || []
-        )
-      )
-      Puppet.override(:environments => environments) do
-        yield environments
-      end
-    end
-  end
-
   def loader_from(options, &block)
     FS.overlay(*options[:filesystem]) do
       environments = Puppet::Environments::Directories.new(
@@ -1148,19 +820,6 @@ config_version=$vardir/random/scripts
     end
   end
 
-  # The environment named `:an_environment` will already be loaded when the
-  # block is yielded to
-  def with_environment_loaded(service, &block)
-    loader_from(:filesystem => [directory_tree], :directory => directory_tree.children.first) do |loader|
-      using_expiration_service(service) do
-        cached = Puppet::Environments::Cached.new(loader)
-        cached.get!(:an_environment)
-
-        yield cached if block_given?
-      end
-    end
-  end
-
   class ReplayExpirationService < Puppet::Environments::Cached::DefaultCacheExpirationService
     attr_reader :created_envs, :evicted_envs
 
@@ -1178,3 +837,4 @@ config_version=$vardir/random/scripts
     end
   end
 end
+end

data/spec/unit/face/generate_spec.rb

@@ -221,70 +221,6 @@ describe Puppet::Face[:generate, :current] do
       end
 
     end
-
-    context "in an environment with a faulty type" do
-      let(:dir) do
-        dir_containing('environments', { 'testing_generate2' => {
-          'environment.conf' => "modulepath = modules",
-          'manifests' => { 'site.pp' => "" },
-          'modules' => {
-            'm3' => {
-              'lib' => { 'puppet' => { 'type' => {
-                'test3.rb' => <<-EOF
-                module Puppet
-                Type.newtype(:test3) do
-                  @doc = "Docs for resource"
-                  def self.title_patterns
-                    identity = lambda {|x| x}
-                    [
-                      [
-                      /^(.*)_(.*)$/,
-                        [
-                          [:name, identity ]
-                        ]
-                      ]
-                    ]
-                  end
-                  newproperty(:message) do
-                    desc "Docs for 'message' property"
-                  end
-                  newparam(:name) do
-                    desc "Docs for 'name' parameter"
-                    isnamevar
-                  end
-                end; end
-                EOF
-               } }
-            }
-          }
-        }}})
-      end
-
-      let(:modulepath) do
-        File.join(dir, 'testing_generate2', 'modules')
-      end
-
-      let(:m3) do
-        File.join(modulepath, 'm3')
-      end
-
-      around(:each) do |example|
-        Puppet.settings.initialize_global_settings
-        Puppet[:manifest] = ''
-        loader = Puppet::Environments::Directories.new(dir, [])
-        Puppet.override(:environments => loader) do
-          Puppet.override(:current_environment => loader.get('testing_generate2')) do
-            example.run
-          end
-        end
-      end
-
-      it 'fails when using procs for title patterns' do
-        expect {
-          genface.types(:format => 'pcore')
-        }.to exit_with(1)
-      end
-    end
   end
 
   def from_an_interactive_terminal