chef 16.2.73 → 16.4.41

data/spec/integration/knife/config_list_profiles_spec.rb

@@ -22,169 +22,198 @@ describe "knife config list-profiles", :workstation do
   include KnifeSupport
 
   include_context "default config options"
-  include_context "with a chef repo"
-
-  let(:cmd_args) { [] }
-  let(:knife_list_profiles) do
-    knife("config", "list-profiles", *cmd_args, instance_filter: proc {
-      # Clear the stub set up in KnifeSupport.
-      allow(File).to receive(:file?).and_call_original
-    })
-  end
-  subject { knife_list_profiles.stdout }
-
-  around do |ex|
-    # Store and reset the value of some env vars.
-    old_home = ENV["HOME"]
-    old_wd = Dir.pwd
-    # Clear these out because they are cached permanently.
-    ChefConfig::PathHelper.class_exec { remove_class_variable(:@@home_dir) }
-    Chef::Knife::ConfigListProfiles.reset_config_loader!
-    begin
-      ex.run
-    ensure
-      ENV["HOME"] = old_home
-      Dir.chdir(old_wd)
+
+  when_the_repository("has a custom env") do
+    let(:cmd_args) { [] }
+    let(:knife_list_profiles) do
+      knife("config", "list-profiles", *cmd_args, instance_filter: lambda { |instance|
+        # Fake the failsafe check because this command doesn't actually process knife.rb.
+        $__KNIFE_INTEGRATION_FAILSAFE_CHECK << " ole"
+        allow(File).to receive(:file?).and_call_original
+      })
+    end
+    subject { knife_list_profiles.stdout }
+
+    around do |ex|
+      # Store and reset the value of some env vars.
+      old_home = ENV["HOME"]
+      old_wd = Dir.pwd
+      # Clear these out because they are cached permanently.
+      ChefConfig::PathHelper.class_exec { remove_class_variable(:@@home_dir) }
+      Chef::Knife::ConfigListProfiles.reset_config_loader!
+      begin
+        ex.run
+      ensure
+        ENV["HOME"] = old_home
+        Dir.chdir(old_wd)
+        ENV[ChefUtils.windows? ? "CD" : "PWD"] = Dir.pwd
+      end
+    end
+
+    before do
+      # Always run from the temp folder. This can't be in the `around` block above
+      # because it has to run after the before set in the "with a chef repo" shared context.
+      directory("repo")
+      Dir.chdir(path_to("repo"))
       ENV[ChefUtils.windows? ? "CD" : "PWD"] = Dir.pwd
+      ENV["HOME"] = path_to(".")
     end
-  end
 
-  before do
-    # Always run from the temp folder. This can't be in the `around` block above
-    # because it has to run after the before set in the "with a chef repo" shared context.
-    directory("repo")
-    Dir.chdir(path_to("repo"))
-    ENV[ChefUtils.windows? ? "CD" : "PWD"] = Dir.pwd
-    ENV["HOME"] = path_to(".")
-  end
+    # NOTE: The funky formatting with # at the end of the line of some of the
+    # output examples are because of how the format strings are built, there is
+    # substantial trailing whitespace in most cases which many editors "helpfully" remove.
 
-  # NOTE: The funky formatting with # at the end of the line of some of the
-  # output examples are because of how the format strings are built, there is
-  # substantial trailing whitespace in most cases which many editors "helpfully" remove.
+    context "with no credentials file" do
+      subject { knife_list_profiles.stderr }
+      it { is_expected.to eq "FATAL: No profiles found, #{path_to(".chef/credentials")} does not exist or is empty\n" }
+    end
 
-  context "with no credentials file" do
-    subject { knife_list_profiles.stderr }
-    it { is_expected.to eq "FATAL: No profiles found, #{path_to(".chef/credentials")} does not exist or is empty\n" }
-  end
+    context "with an empty credentials file" do
+      before { file(".chef/credentials", "") }
+      subject { knife_list_profiles.stderr }
+      it { is_expected.to eq "FATAL: No profiles found, #{path_to(".chef/credentials")} does not exist or is empty\n" }
+    end
 
-  context "with an empty credentials file" do
-    before { file(".chef/credentials", "") }
-    subject { knife_list_profiles.stderr }
-    it { is_expected.to eq "FATAL: No profiles found, #{path_to(".chef/credentials")} does not exist or is empty\n" }
-  end
+    context "with a simple default profile" do
+      before { file(".chef/credentials", <<~EOH) }
+        [default]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
+      EOH
+      it { is_expected.to eq <<~EOH.delete("#") }
+         Profile  Client    Key                  Server                                   #
+        ----------------------------------------------------------------------------------#
+        *default  testuser  ~/.chef/testkey.pem  https://example.com/organizations/testorg#
+      EOH
+    end
 
-  context "with a simple default profile" do
-    before { file(".chef/credentials", <<~EOH) }
-      [default]
-      client_name = "testuser"
-      client_key = "testkey.pem"
-      chef_server_url = "https://example.com/organizations/testorg"
-    EOH
-    it { is_expected.to eq <<~EOH.delete("#") }
-       Profile  Client    Key                  Server                                   #
-      ----------------------------------------------------------------------------------#
-      *default  testuser  ~/.chef/testkey.pem  https://example.com/organizations/testorg#
-    EOH
-  end
+    context "with multiple profiles" do
+      before { file(".chef/credentials", <<~EOH) }
+        [default]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
+
+        [prod]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/prod"
+
+        [qa]
+        client_name = "qauser"
+        client_key = "~/src/qauser.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
+      EOH
+      it { is_expected.to eq <<~EOH.delete("#") }
+         Profile  Client    Key                  Server                                   #
+        ----------------------------------------------------------------------------------#
+        *default  testuser  ~/.chef/testkey.pem  https://example.com/organizations/testorg#
+         prod     testuser  ~/.chef/testkey.pem  https://example.com/organizations/prod   #
+         qa       qauser    ~/src/qauser.pem     https://example.com/organizations/testorg#
+      EOH
+    end
 
-  context "with multiple profiles" do
-    before { file(".chef/credentials", <<~EOH) }
-      [default]
-      client_name = "testuser"
-      client_key = "testkey.pem"
-      chef_server_url = "https://example.com/organizations/testorg"
-
-      [prod]
-      client_name = "testuser"
-      client_key = "testkey.pem"
-      chef_server_url = "https://example.com/organizations/prod"
-
-      [qa]
-      client_name = "qauser"
-      client_key = "~/src/qauser.pem"
-      chef_server_url = "https://example.com/organizations/testorg"
-    EOH
-    it { is_expected.to eq <<~EOH.delete("#") }
-       Profile  Client    Key                  Server                                   #
-      ----------------------------------------------------------------------------------#
-      *default  testuser  ~/.chef/testkey.pem  https://example.com/organizations/testorg#
-       prod     testuser  ~/.chef/testkey.pem  https://example.com/organizations/prod   #
-       qa       qauser    ~/src/qauser.pem     https://example.com/organizations/testorg#
-    EOH
-  end
+    context "with a non-default active profile" do
+      let(:cmd_args) { %w{--profile prod} }
+      before { file(".chef/credentials", <<~EOH) }
+        [default]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
+
+        [prod]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/prod"
+
+        [qa]
+        client_name = "qauser"
+        client_key = "~/src/qauser.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
+      EOH
+      it { is_expected.to eq <<~EOH.delete("#") }
+         Profile  Client    Key                  Server                                   #
+        ----------------------------------------------------------------------------------#
+         default  testuser  ~/.chef/testkey.pem  https://example.com/organizations/testorg#
+        *prod     testuser  ~/.chef/testkey.pem  https://example.com/organizations/prod   #
+         qa       qauser    ~/src/qauser.pem     https://example.com/organizations/testorg#
+      EOH
+    end
 
-  context "with a non-default active profile" do
-    let(:cmd_args) { %w{--profile prod} }
-    before { file(".chef/credentials", <<~EOH) }
-      [default]
-      client_name = "testuser"
-      client_key = "testkey.pem"
-      chef_server_url = "https://example.com/organizations/testorg"
-
-      [prod]
-      client_name = "testuser"
-      client_key = "testkey.pem"
-      chef_server_url = "https://example.com/organizations/prod"
-
-      [qa]
-      client_name = "qauser"
-      client_key = "~/src/qauser.pem"
-      chef_server_url = "https://example.com/organizations/testorg"
-    EOH
-    it { is_expected.to eq <<~EOH.delete("#") }
-       Profile  Client    Key                  Server                                   #
-      ----------------------------------------------------------------------------------#
-       default  testuser  ~/.chef/testkey.pem  https://example.com/organizations/testorg#
-      *prod     testuser  ~/.chef/testkey.pem  https://example.com/organizations/prod   #
-       qa       qauser    ~/src/qauser.pem     https://example.com/organizations/testorg#
-    EOH
-  end
+    context "with a bad profile as an active profile" do
+      let(:cmd_args) { %w{--profile production} }
+      before { file(".chef/credentials", <<~EOH) }
+        [default]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
+
+        [prod]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/prod"
+
+        [qa]
+        client_name = "qauser"
+        client_key = "~/src/qauser.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
+      EOH
+      it { is_expected.to eq <<~EOH.delete("#") }
+         Profile  Client    Key                  Server                                   #
+         ---------------------------------------------------------------------------------#
+         default  testuser  ~/.chef/testkey.pem  https://example.com/organizations/testorg#
+         prod     testuser  ~/.chef/testkey.pem  https://example.com/organizations/prod   #
+         qa       qauser    ~/src/qauser.pem     https://example.com/organizations/testorg#
+      EOH
+    end
 
-  context "with a minimal profile" do
-    before { file(".chef/credentials", <<~EOH) }
-      [default]
-      chef_server_url = "https://example.com/organizations/testorg"
-    EOH
-    it { is_expected.to match %r{^*default .*? https://example.com/organizations/testorg$} }
-  end
+    context "with a minimal profile" do
+      before { file(".chef/credentials", <<~EOH) }
+        [default]
+        chef_server_url = "https://example.com/organizations/testorg"
+      EOH
+      it { is_expected.to match %r{^*default .*? https://example.com/organizations/testorg$} }
+    end
 
-  context "with -i" do
-    let(:cmd_args) { %w{-i} }
-    before { file(".chef/credentials", <<~EOH) }
-      [default]
-      chef_server_url = "https://example.com/organizations/testorg"
-    EOH
-    it { is_expected.to eq <<~EOH.delete("#") }
-       Profile  Client  Key  Server                                   #
-      ----------------------------------------------------------------#
-      *default               https://example.com/organizations/testorg#
-    EOH
-  end
+    context "with -i" do
+      let(:cmd_args) { %w{-i} }
+      before { file(".chef/credentials", <<~EOH) }
+        [default]
+        chef_server_url = "https://example.com/organizations/testorg"
+      EOH
+      it { is_expected.to eq <<~EOH.delete("#") }
+         Profile  Client  Key  Server                                   #
+        ----------------------------------------------------------------#
+        *default               https://example.com/organizations/testorg#
+      EOH
+    end
 
-  context "with --format=json" do
-    let(:cmd_args) { %w{--format=json node_name} }
-    before { file(".chef/credentials", <<~EOH) }
-      [default]
-      client_name = "testuser"
-      client_key = "testkey.pem"
-      chef_server_url = "https://example.com/organizations/testorg"
-
-      [prod]
-      client_name = "testuser"
-      client_key = "testkey.pem"
-      chef_server_url = "https://example.com/organizations/prod"
-
-      [qa]
-      client_name = "qauser"
-      client_key = "~/src/qauser.pem"
-      chef_server_url = "https://example.com/organizations/testorg"
-    EOH
-    it {
-      expect(JSON.parse(subject)).to eq [
-      { "profile" => "default", "active" => true, "client_name" => "testuser", "client_key" => path_to(".chef/testkey.pem"), "server_url" => "https://example.com/organizations/testorg" },
-      { "profile" => "prod", "active" => false, "client_name" => "testuser", "client_key" => path_to(".chef/testkey.pem"), "server_url" => "https://example.com/organizations/prod" },
-      { "profile" => "qa", "active" => false, "client_name" => "qauser", "client_key" => path_to("src/qauser.pem"), "server_url" => "https://example.com/organizations/testorg" },
-    ]
-    }
+    context "with --format=json" do
+      let(:cmd_args) { %w{--format=json node_name} }
+      before { file(".chef/credentials", <<~EOH) }
+        [default]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
+
+        [prod]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/prod"
+
+        [qa]
+        client_name = "qauser"
+        client_key = "~/src/qauser.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
+      EOH
+      it {
+        expect(JSON.parse(subject)).to eq [
+        { "profile" => "default", "active" => true, "client_name" => "testuser", "client_key" => path_to(".chef/testkey.pem"), "server_url" => "https://example.com/organizations/testorg" },
+        { "profile" => "prod", "active" => false, "client_name" => "testuser", "client_key" => path_to(".chef/testkey.pem"), "server_url" => "https://example.com/organizations/prod" },
+        { "profile" => "qa", "active" => false, "client_name" => "qauser", "client_key" => path_to("src/qauser.pem"), "server_url" => "https://example.com/organizations/testorg" },
+      ]
+      }
+    end
   end
 end

data/spec/integration/knife/config_use_profile_spec.rb

@@ -22,133 +22,134 @@ describe "knife config use-profile", :workstation do
   include KnifeSupport
 
   include_context "default config options"
-  include_context "with a chef repo"
 
   let(:cmd_args) { [] }
 
-  let(:knife_use_profile) do
-    knife("config", "use-profile", *cmd_args, instance_filter: lambda { |instance|
-      # Fake the failsafe check because this command doesn't actually process knife.rb.
-      $__KNIFE_INTEGRATION_FAILSAFE_CHECK << " ole"
-      allow(File).to receive(:file?).and_call_original
-    })
-  end
-
-  subject { knife_use_profile.stdout }
-
-  around do |ex|
-    # Store and reset the value of some env vars.
-    old_chef_home = ENV["CHEF_HOME"]
-    old_knife_home = ENV["KNIFE_HOME"]
-    old_home = ENV["HOME"]
-    old_wd = Dir.pwd
-    ChefConfig::PathHelper.per_tool_home_environment = "KNIFE_HOME"
-    # Clear these out because they are cached permanently.
-    ChefConfig::PathHelper.class_exec { remove_class_variable(:@@home_dir) }
-    Chef::Knife::ConfigUseProfile.reset_config_loader!
-    begin
-      ex.run
-    ensure
-      ENV["CHEF_HOME"] = old_chef_home
-      ENV["KNIFE_HOME"] = old_knife_home
-      ENV["HOME"] = old_home
-      Dir.chdir(old_wd)
-      ENV[ChefUtils.windows? ? "CD" : "PWD"] = Dir.pwd
-      ChefConfig::PathHelper.per_tool_home_environment = nil
+  when_the_repository("has a custom env") do
+    let(:knife_use_profile) do
+      knife("config", "use-profile", *cmd_args, instance_filter: lambda { |instance|
+        # Fake the failsafe check because this command doesn't actually process knife.rb.
+        $__KNIFE_INTEGRATION_FAILSAFE_CHECK << " ole"
+        allow(File).to receive(:file?).and_call_original
+      })
     end
-  end
-
-  before do
-    # Always run from the temp folder. This can't be in the `around` block above
-    # because it has to run after the before set in the "with a chef repo" shared context.
-    directory("repo")
-    Dir.chdir(path_to("repo"))
-    ENV[ChefUtils.windows? ? "CD" : "PWD"] = Dir.pwd
-    ENV["HOME"] = path_to(".")
-  end
 
-  context "with no argument" do
-    subject { knife_use_profile.stderr }
-    it { is_expected.to eq "FATAL: You must specify a profile\n" }
-  end
-
-  context "with an argument" do
-    let(:cmd_args) { %w{production} }
-    before { file(".chef/credentials", <<~EOH) }
-      [production]
-      client_name = "testuser"
-      client_key = "testkey.pem"
-      chef_server_url = "https://example.com/organizations/testorg"
-    EOH
-    it do
-      is_expected.to eq "Set default profile to production\n"
-      expect(File.read(path_to(".chef/context"))).to eq "production\n"
+    subject { knife_use_profile.stdout }
+
+    around do |ex|
+      # Store and reset the value of some env vars.
+      old_chef_home = ENV["CHEF_HOME"]
+      old_knife_home = ENV["KNIFE_HOME"]
+      old_home = ENV["HOME"]
+      old_wd = Dir.pwd
+      ChefConfig::PathHelper.per_tool_home_environment = "KNIFE_HOME"
+      # Clear these out because they are cached permanently.
+      ChefConfig::PathHelper.class_exec { remove_class_variable(:@@home_dir) }
+      Chef::Knife::ConfigUseProfile.reset_config_loader!
+      begin
+        ex.run
+      ensure
+        ENV["CHEF_HOME"] = old_chef_home
+        ENV["KNIFE_HOME"] = old_knife_home
+        ENV["HOME"] = old_home
+        Dir.chdir(old_wd)
+        ENV[ChefUtils.windows? ? "CD" : "PWD"] = Dir.pwd
+        ChefConfig::PathHelper.per_tool_home_environment = nil
+      end
     end
-  end
 
-  context "with no credentials file" do
-    let(:cmd_args) { %w{production} }
-    subject { knife_use_profile.stderr }
-    it { is_expected.to eq "FATAL: No profiles found, #{path_to(".chef/credentials")} does not exist or is empty\n" }
-  end
-
-  context "with an empty credentials file" do
-    let(:cmd_args) { %w{production} }
-    before { file(".chef/credentials", "") }
-    subject { knife_use_profile.stderr }
-    it { is_expected.to eq "FATAL: No profiles found, #{path_to(".chef/credentials")} does not exist or is empty\n" }
-  end
+    before do
+      # Always run from the temp folder. This can't be in the `around` block above
+      # because it has to run after the before set in the "with a chef repo" shared context.
+      directory("repo")
+      Dir.chdir(path_to("repo"))
+      ENV[ChefUtils.windows? ? "CD" : "PWD"] = Dir.pwd
+      ENV["HOME"] = path_to(".")
+    end
 
-  context "with an wrong argument" do
-    let(:cmd_args) { %w{staging} }
-    before { file(".chef/credentials", <<~EOH) }
-      [production]
-      client_name = "testuser"
-      client_key = "testkey.pem"
-      chef_server_url = "https://example.com/organizations/testorg"
-    EOH
-    subject { knife_use_profile }
-    it { expect { subject }.to raise_error ChefConfig::ConfigurationError, "Profile staging doesn't exist. Please add it to #{path_to(".chef/credentials")} and if it is profile with DNS name check that you are not missing single quotes around it as per docs https://docs.chef.io/workstation/knife_setup/#knife-profiles." }
-  end
+    context "with no argument" do
+      subject { knife_use_profile.stderr }
+      it { is_expected.to eq "FATAL: You must specify a profile\n" }
+    end
 
-  context "with $CHEF_HOME" do
-    let(:cmd_args) { %w{staging} }
-    before do
-      ENV["CHEF_HOME"] = path_to("chefhome"); file("chefhome/tmp", "")
-      file("chefhome/.chef/credentials", <<~EOH
-      [staging]
-      client_name = "testuser"
-      client_key = "testkey.pem"
-      chef_server_url = "https://example.com/organizations/testorg"
+    context "with an argument" do
+      let(:cmd_args) { %w{production} }
+      before { file(".chef/credentials", <<~EOH) }
+        [production]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
       EOH
-      )
+      it do
+        is_expected.to eq "Set default profile to production\n"
+        expect(File.read(path_to(".chef/context"))).to eq "production\n"
+      end
     end
 
-    it do
-      is_expected.to eq "Set default profile to staging\n"
-      expect(File.read(path_to("chefhome/.chef/context"))).to eq "staging\n"
-      expect(File.exist?(path_to(".chef/context"))).to be_falsey
+    context "with no credentials file" do
+      let(:cmd_args) { %w{production} }
+      subject { knife_use_profile.stderr }
+      it { is_expected.to eq "FATAL: No profiles found, #{path_to(".chef/credentials")} does not exist or is empty\n" }
     end
-  end
 
-  context "with $KNIFE_HOME" do
-    let(:cmd_args) { %w{development} }
+    context "with an empty credentials file" do
+      let(:cmd_args) { %w{production} }
+      before { file(".chef/credentials", "") }
+      subject { knife_use_profile.stderr }
+      it { is_expected.to eq "FATAL: No profiles found, #{path_to(".chef/credentials")} does not exist or is empty\n" }
+    end
 
-    before do
-      ENV["KNIFE_HOME"] = path_to("knifehome"); file("knifehome/tmp", "")
-      file("knifehome/.chef/credentials", <<~EOH
-      [development]
-      client_name = "testuser"
-      client_key = "testkey.pem"
-      chef_server_url = "https://example.com/organizations/testorg"
+    context "with an wrong argument" do
+      let(:cmd_args) { %w{staging} }
+      before { file(".chef/credentials", <<~EOH) }
+        [production]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
       EOH
-      )
+      subject { knife_use_profile }
+      it { expect { subject }.to raise_error ChefConfig::ConfigurationError, "Profile staging doesn't exist. Please add it to #{path_to(".chef/credentials")} and if it is profile with DNS name check that you are not missing single quotes around it as per docs https://docs.chef.io/workstation/knife_setup/#knife-profiles." }
+    end
+
+    context "with $CHEF_HOME" do
+      let(:cmd_args) { %w{staging} }
+      before do
+        ENV["CHEF_HOME"] = path_to("chefhome"); file("chefhome/tmp", "")
+        file("chefhome/.chef/credentials", <<~EOH
+        [staging]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
+        EOH
+        )
+      end
+
+      it do
+        is_expected.to eq "Set default profile to staging\n"
+        expect(File.read(path_to("chefhome/.chef/context"))).to eq "staging\n"
+        expect(File.exist?(path_to(".chef/context"))).to be_falsey
+      end
     end
 
-    it do
-      is_expected.to eq "Set default profile to development\n"
-      expect(File.read(path_to("knifehome/.chef/context"))).to eq "development\n"
-      expect(File.exist?(path_to(".chef/context"))).to be_falsey
+    context "with $KNIFE_HOME" do
+      let(:cmd_args) { %w{development} }
+
+      before do
+        ENV["KNIFE_HOME"] = path_to("knifehome"); file("knifehome/tmp", "")
+        file("knifehome/.chef/credentials", <<~EOH
+        [development]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
+        EOH
+        )
+      end
+
+      it do
+        is_expected.to eq "Set default profile to development\n"
+        expect(File.read(path_to("knifehome/.chef/context"))).to eq "development\n"
+        expect(File.exist?(path_to(".chef/context"))).to be_falsey
+      end
     end
   end
 end