puppet 7.28.0 → 7.29.1

data/spec/unit/util/inifile_spec.rb

@@ -1,510 +0,0 @@
-require 'spec_helper'
-require 'puppet/util/inifile'
-
-describe Puppet::Util::IniConfig::Section do
-
-  subject { described_class.new('testsection', '/some/imaginary/file') }
-
-  describe "determining if the section is dirty" do
-    it "is not dirty on creation" do
-      expect(subject).to_not be_dirty
-    end
-
-    it "is dirty if a key is changed" do
-      subject['hello'] = 'world'
-      expect(subject).to be_dirty
-    end
-
-    it "is dirty if the section has been explicitly marked as dirty" do
-      subject.mark_dirty
-      expect(subject).to be_dirty
-    end
-
-    it "is dirty if the section is marked for deletion" do
-      subject.destroy = true
-      expect(subject).to be_dirty
-    end
-
-    it "is clean if the section has been explicitly marked as clean" do
-      subject['hello'] = 'world'
-      subject.mark_clean
-      expect(subject).to_not be_dirty
-    end
-  end
-
-  describe "reading an entry" do
-    it "returns nil if the key is not present" do
-      expect(subject['hello']).to be_nil
-    end
-
-    it "returns the value if the key is specified" do
-      subject.entries << ['hello', 'world']
-      expect(subject['hello']).to eq 'world'
-    end
-
-    it "ignores comments when looking for a match" do
-      subject.entries << '#this = comment'
-      expect(subject['#this']).to be_nil
-    end
-  end
-
-  describe "formatting the section" do
-    it "prefixes the output with the section header" do
-      expect(subject.format).to eq "[testsection]\n"
-    end
-
-    it "restores comments and blank lines" do
-      subject.entries << "#comment\n"
-      subject.entries << "    "
-      expect(subject.format).to eq(
-        "[testsection]\n" +
-        "#comment\n" +
-        "    "
-      )
-    end
-
-    it "adds all keys that have values" do
-      subject.entries << ['somekey', 'somevalue']
-      expect(subject.format).to eq("[testsection]\nsomekey=somevalue\n")
-    end
-
-    it "excludes keys that have a value of nil" do
-      subject.entries << ['empty', nil]
-      expect(subject.format).to eq("[testsection]\n")
-    end
-
-    it "preserves the order of the section" do
-      subject.entries << ['firstkey', 'firstval']
-      subject.entries << "# I am a comment, hear me roar\n"
-      subject.entries << ['secondkey', 'secondval']
-
-      expect(subject.format).to eq(
-        "[testsection]\n" +
-        "firstkey=firstval\n" +
-        "# I am a comment, hear me roar\n" +
-        "secondkey=secondval\n"
-      )
-    end
-
-    it "is empty if the section is marked for deletion" do
-      subject.entries << ['firstkey', 'firstval']
-      subject.destroy = true
-      expect(subject.format).to eq('')
-    end
-  end
-end
-
-describe Puppet::Util::IniConfig::PhysicalFile do
-  subject { described_class.new('/some/nonexistent/file') }
-
-  let(:first_sect) do
-    sect = Puppet::Util::IniConfig::Section.new('firstsection', '/some/imaginary/file')
-    sect.entries << "# comment\n" << ['onefish', 'redfish'] << "\n"
-    sect
-  end
-
-  let(:second_sect) do
-    sect = Puppet::Util::IniConfig::Section.new('secondsection', '/some/imaginary/file')
-    sect.entries << ['twofish', 'bluefish']
-    sect
-  end
-
-  describe "when reading a file" do
-    it "raises an error if the file does not exist" do
-      allow(subject.filetype).to receive(:read)
-      expect {
-        subject.read
-      }.to raise_error(%r[Cannot read nonexistent file .*/some/nonexistent/file])
-    end
-
-    it "passes the contents of the file to #parse" do
-      allow(subject.filetype).to receive(:read).and_return("[section]")
-      expect(subject).to receive(:parse).with("[section]")
-
-      subject.read
-    end
-  end
-
-  describe "when parsing a file" do
-    describe "parsing sections" do
-      it "creates new sections the first time that the section is found" do
-        text = "[mysect]\n"
-
-        subject.parse(text)
-
-        expect(subject.contents.count).to eq 1
-        sect = subject.contents[0]
-        expect(sect.name).to eq "mysect"
-      end
-
-      it "raises an error if a section is redefined in the file" do
-        text = "[mysect]\n[mysect]\n"
-
-        expect {
-          subject.parse(text)
-        }.to raise_error(Puppet::Util::IniConfig::IniParseError,
-                         /Section "mysect" is already defined, cannot redefine/)
-      end
-
-      it "raises an error if a section is redefined in the file collection" do
-        subject.file_collection = double('file collection', :get_section => true)
-        text = "[mysect]\n[mysect]\n"
-
-        expect {
-          subject.parse(text)
-        }.to raise_error(Puppet::Util::IniConfig::IniParseError,
-                         /Section "mysect" is already defined, cannot redefine/)
-      end
-    end
-
-    describe 'parsing properties' do
-      it 'raises an error if the property is not within a section' do
-        text = "key=val\n"
-
-        expect {
-          subject.parse(text)
-        }.to raise_error(Puppet::Util::IniConfig::IniParseError,
-                         /Property with key "key" outside of a section/)
-      end
-
-      it 'adds the property to the current section' do
-        text = "[main]\nkey=val\n"
-
-        subject.parse(text)
-        expect(subject.contents.count).to eq 1
-        sect = subject.contents[0]
-        expect(sect['key']).to eq 'val'
-      end
-
-      context 'with white space' do
-        let(:section) do
-          text = <<-INIFILE
-[main]
-  leading_white_space=value1
-white_space_after_key =value2
-white_space_after_equals= value3
-white_space_after_value=value4\t
-INIFILE
-          subject.parse(text)
-          expect(subject.contents.count).to eq 1
-          subject.contents[0]
-        end
-
-        it 'allows and ignores white space before the key' do
-          expect(section['leading_white_space']).to eq('value1')
-        end
-
-        it 'allows and ignores white space before the equals' do
-          expect(section['white_space_after_key']).to eq('value2')
-        end
-
-        it 'allows and ignores white space after the equals' do
-          expect(section['white_space_after_equals']).to eq('value3')
-        end
-
-        it 'allows and ignores white spaces after the value' do
-          expect(section['white_space_after_value']).to eq('value4')
-        end
-      end
-    end
-
-    describe "parsing line continuations" do
-      it "adds the continued line to the last parsed property" do
-        text = "[main]\nkey=val\n moreval"
-
-        subject.parse(text)
-        expect(subject.contents.count).to eq 1
-        sect = subject.contents[0]
-        expect(sect['key']).to eq "val\n moreval"
-      end
-    end
-
-    describe "parsing comments and whitespace" do
-      it "treats # as a comment leader" do
-        text = "# octothorpe comment"
-
-        subject.parse(text)
-        expect(subject.contents).to eq ["# octothorpe comment"]
-      end
-
-      it "treats ; as a comment leader" do
-        text = "; semicolon comment"
-
-        subject.parse(text)
-        expect(subject.contents).to eq ["; semicolon comment"]
-      end
-
-      it "treates 'rem' as a comment leader" do
-        text = "rem rapid eye movement comment"
-
-        subject.parse(text)
-        expect(subject.contents).to eq ["rem rapid eye movement comment"]
-      end
-
-      it "stores comments and whitespace in a section in the correct section" do
-        text = "[main]\n; main section comment"
-
-        subject.parse(text)
-
-        sect = subject.get_section("main")
-        expect(sect.entries).to eq ["; main section comment"]
-      end
-    end
-  end
-
-  it "can return all sections" do
-    text = "[first]\n" +
-           "; comment\n" +
-           "[second]\n" +
-           "key=value"
-
-    subject.parse(text)
-
-    sections = subject.sections
-    expect(sections.count).to eq 2
-    expect(sections[0].name).to eq "first"
-    expect(sections[1].name).to eq "second"
-  end
-
-  it "can retrieve a specific section" do
-    text = "[first]\n" +
-           "; comment\n" +
-           "[second]\n" +
-           "key=value"
-
-    subject.parse(text)
-
-    section = subject.get_section("second")
-    expect(section.name).to eq "second"
-    expect(section["key"]).to eq "value"
-  end
-
-  describe "formatting" do
-    it "concatenates each formatted section in order" do
-      subject.contents << first_sect << second_sect
-
-      expected = "[firstsection]\n" +
-        "# comment\n" +
-        "onefish=redfish\n" +
-        "\n" +
-        "[secondsection]\n" +
-        "twofish=bluefish\n"
-
-      expect(subject.format).to eq expected
-    end
-
-    it "includes comments that are not within a section" do
-      subject.contents << "# This comment is not in a section\n" << first_sect << second_sect
-
-      expected = "# This comment is not in a section\n" +
-        "[firstsection]\n" +
-        "# comment\n" +
-        "onefish=redfish\n" +
-        "\n" +
-        "[secondsection]\n" +
-        "twofish=bluefish\n"
-
-      expect(subject.format).to eq expected
-    end
-
-    it "excludes sections that are marked to be destroyed" do
-      subject.contents << first_sect << second_sect
-      first_sect.destroy = true
-
-      expected = "[secondsection]\n" + "twofish=bluefish\n"
-
-      expect(subject.format).to eq expected
-    end
-  end
-
-  describe "storing the file" do
-    describe "with empty contents" do
-      describe "and destroy_empty is true" do
-        before { subject.destroy_empty = true }
-        it "removes the file if there are no sections" do
-          expect(File).to receive(:unlink)
-          subject.store
-        end
-
-        it "removes the file if all sections are marked to be destroyed" do
-          subject.contents << first_sect << second_sect
-          first_sect.destroy = true
-          second_sect.destroy = true
-
-          expect(File).to receive(:unlink)
-          subject.store
-        end
-
-        it "doesn't remove the file if not all sections are marked to be destroyed" do
-          subject.contents << first_sect << second_sect
-          first_sect.destroy = true
-          second_sect.destroy = false
-
-          expect(File).not_to receive(:unlink)
-          allow(subject.filetype).to receive(:write)
-          subject.store
-        end
-      end
-
-      it "rewrites the file if destroy_empty is false" do
-        subject.contents << first_sect << second_sect
-        first_sect.destroy = true
-        second_sect.destroy = true
-
-        expect(File).not_to receive(:unlink)
-        allow(subject).to receive(:format).and_return("formatted")
-        expect(subject.filetype).to receive(:write).with("formatted")
-        subject.store
-      end
-    end
-
-    it "rewrites the file if any section is dirty" do
-      subject.contents << first_sect << second_sect
-      first_sect.mark_dirty
-      second_sect.mark_clean
-
-      allow(subject).to receive(:format).and_return("formatted")
-      expect(subject.filetype).to receive(:write).with("formatted")
-      subject.store
-    end
-
-    it "doesn't modify the file if all sections are clean" do
-      subject.contents << first_sect << second_sect
-      first_sect.mark_clean
-      second_sect.mark_clean
-
-      allow(subject).to receive(:format).and_return("formatted")
-      expect(subject.filetype).not_to receive(:write)
-      subject.store
-    end
-  end
-end
-
-describe Puppet::Util::IniConfig::FileCollection do
-  let(:path_a) { '/some/nonexistent/file/a' }
-  let(:path_b) { '/some/nonexistent/file/b' }
-
-  let(:file_a) { Puppet::Util::IniConfig::PhysicalFile.new(path_a) }
-  let(:file_b) { Puppet::Util::IniConfig::PhysicalFile.new(path_b) }
-
-  let(:sect_a1) { Puppet::Util::IniConfig::Section.new('sect_a1', path_a) }
-  let(:sect_a2) { Puppet::Util::IniConfig::Section.new('sect_a2', path_a) }
-
-  let(:sect_b1) { Puppet::Util::IniConfig::Section.new('sect_b1', path_b) }
-  let(:sect_b2) { Puppet::Util::IniConfig::Section.new('sect_b2', path_b) }
-
-  before do
-    file_a.contents << sect_a1 << sect_a2
-    file_b.contents << sect_b1 << sect_b2
-  end
-
-  describe "reading a file" do
-    let(:stub_file) { double('Physical file') }
-
-    it "creates a new PhysicalFile and uses that to read the file" do
-      expect(stub_file).to receive(:read)
-      expect(stub_file).to receive(:file_collection=)
-      expect(Puppet::Util::IniConfig::PhysicalFile).to receive(:new).with(path_a).and_return(stub_file)
-
-      subject.read(path_a)
-    end
-
-    it "stores the PhysicalFile and the path to the file" do
-      allow(stub_file).to receive(:read)
-      allow(stub_file).to receive(:file_collection=)
-      allow(Puppet::Util::IniConfig::PhysicalFile).to receive(:new).with(path_a).and_return(stub_file)
-      subject.read(path_a)
-
-      path, physical_file = subject.files.first
-
-      expect(path).to eq(path_a)
-      expect(physical_file).to eq stub_file
-    end
-  end
-
-  describe "storing all files" do
-    before do
-      subject.files[path_a] = file_a
-      subject.files[path_b] = file_b
-    end
-
-    it "stores all files in the collection" do
-      expect(file_a).to receive(:store).once
-      expect(file_b).to receive(:store).once
-
-      subject.store
-    end
-  end
-
-  describe "iterating over sections" do
-    before do
-      subject.files[path_a] = file_a
-      subject.files[path_b] = file_b
-    end
-
-    it "yields every section from every file" do
-      expect { |b|
-        subject.each_section(&b)
-      }.to yield_successive_args(sect_a1, sect_a2, sect_b1, sect_b2)
-    end
-  end
-
-  describe "iterating over files" do
-    before do
-      subject.files[path_a] = file_a
-      subject.files[path_b] = file_b
-    end
-
-    it "yields the path to every file in the collection" do
-      expect { |b|
-        subject.each_file(&b)
-      }.to yield_successive_args(path_a, path_b)
-    end
-  end
-
-  describe "retrieving a specific section" do
-    before do
-      subject.files[path_a] = file_a
-      subject.files[path_b] = file_b
-    end
-
-    it "retrieves the first section defined" do
-      expect(subject.get_section('sect_b1')).to eq sect_b1
-    end
-
-    it "returns nil if there was no section with the given name" do
-      expect(subject.get_section('nope')).to be_nil
-    end
-
-    it "allows #[] to be used as an alias to #get_section" do
-      expect(subject['b2']).to eq subject.get_section('b2')
-    end
-  end
-
-  describe "checking if a section has been defined" do
-    before do
-      subject.files[path_a] = file_a
-      subject.files[path_b] = file_b
-    end
-
-    it "is true if a section with the given name is defined" do
-      expect(subject.include?('sect_a1')).to be_truthy
-    end
-
-    it "is false if a section with the given name can't be found" do
-      expect(subject.include?('nonexistent')).to be_falsey
-    end
-  end
-
-  describe "adding a new section" do
-    before do
-      subject.files[path_a] = file_a
-      subject.files[path_b] = file_b
-    end
-
-    it "adds the section to the appropriate file" do
-      expect(file_a).to receive(:add_section).with('newsect')
-      subject.add_section('newsect', path_a)
-    end
-  end
-end

data/spec/unit/util/json_lockfile_spec.rb

@@ -1,48 +0,0 @@
-require 'spec_helper'
-
-require 'puppet/util/json_lockfile'
-
-describe Puppet::Util::JsonLockfile do
-  require 'puppet_spec/files'
-  include PuppetSpec::Files
-
-  before(:each) do
-    @lockfile = tmpfile("lock")
-    @lock = Puppet::Util::JsonLockfile.new(@lockfile)
-  end
-
-  describe "#lock" do
-    it "should create a lock file containing a json hash" do
-      data = { "foo" => "foofoo", "bar" => "barbar" }
-      @lock.lock(data)
-
-      expect(PSON.parse(File.read(@lockfile))).to eq(data)
-    end
-  end
-
-  describe "reading lock data" do
-    it "returns deserialized JSON from the lockfile" do
-      data = { "foo" => "foofoo", "bar" => "barbar" }
-      @lock.lock(data)
-      expect(@lock.lock_data).to eq data
-    end
-
-    it "returns nil if the file read returned nil" do
-      @lock.lock
-      allow(File).to receive(:read).and_return(nil)
-      expect(@lock.lock_data).to be_nil
-    end
-
-    it "returns nil if the file was empty" do
-      @lock.lock
-      allow(File).to receive(:read).and_return('')
-      expect(@lock.lock_data).to be_nil
-    end
-
-    it "returns nil if the file was not in PSON" do
-      @lock.lock
-      allow(File).to receive(:read).and_return('][')
-      expect(@lock.lock_data).to be_nil
-    end
-  end
-end

data/spec/unit/util/json_spec.rb

@@ -1,126 +0,0 @@
-# coding: utf-8
-require 'spec_helper'
-require 'puppet/util/json'
-
-describe Puppet::Util::Json do
-  include PuppetSpec::Files
-
-  shared_examples_for 'json file loader' do |load_method|
-    it 'reads a JSON file from disk' do
-      file_path = file_containing('input', JSON.dump({ "my" => "data" }))
-
-      expect(load_method.call(file_path)).to eq({ "my" => "data" })
-    end
-
-    it 'reads JSON as UTF-8' do
-      file_path = file_containing('input', JSON.dump({ "my" => "𠜎" }))
-
-      expect(load_method.call(file_path)).to eq({ "my" => "𠜎" })
-    end
-  end
-
-  context "#load" do
-    it 'raises an error if JSON is invalid' do
-      expect {
-        Puppet::Util::Json.load('{ invalid')
-      }.to raise_error(Puppet::Util::Json::ParseError, /unexpected token at '{ invalid'/)
-    end
-
-    it 'raises an error if the content is empty' do
-      expect {
-        Puppet::Util::Json.load('')
-      }.to raise_error(Puppet::Util::Json::ParseError)
-    end
-
-    it 'loads true' do
-      expect(Puppet::Util::Json.load('true')).to eq(true)
-    end
-
-    it 'loads false' do
-      expect(Puppet::Util::Json.load('false')).to eq(false)
-    end
-
-    it 'loads a numeric' do
-      expect(Puppet::Util::Json.load('42')).to eq(42)
-    end
-
-    it 'loads a string' do
-      expect(Puppet::Util::Json.load('"puppet"')).to eq('puppet')
-    end
-
-    it 'loads an array' do
-      expect(Puppet::Util::Json.load(<<~JSON)).to eq([1, 2])
-        [1, 2]
-      JSON
-    end
-
-    it 'loads a hash' do
-      expect(Puppet::Util::Json.load(<<~JSON)).to eq('a' => 1, 'b' => 2)
-        {
-          "a": 1,
-          "b": 2
-        }
-      JSON
-    end
-  end
-
-  context "load_file_if_valid" do
-    before do
-      Puppet[:log_level] = 'debug'
-    end
-
-    it_should_behave_like 'json file loader', Puppet::Util::Json.method(:load_file_if_valid)
-
-    it 'returns nil when the file is invalid JSON and debug logs about it' do
-      file_path = file_containing('input', '{ invalid')
-      expect(Puppet).to receive(:debug)
-        .with(/Could not retrieve JSON content .+: unexpected token at '{ invalid'/).and_call_original
-
-      expect(Puppet::Util::Json.load_file_if_valid(file_path)).to eql(nil)
-    end
-
-    it 'returns nil when the filename is illegal and debug logs about it' do
-      expect(Puppet).to receive(:debug)
-        .with(/Could not retrieve JSON content .+: pathname contains null byte/).and_call_original
-
-      expect(Puppet::Util::Json.load_file_if_valid("not\0allowed")).to eql(nil)
-    end
-
-    it 'returns nil when the file does not exist and debug logs about it' do
-      expect(Puppet).to receive(:debug)
-        .with(/Could not retrieve JSON content .+: No such file or directory/).and_call_original
-
-      expect(Puppet::Util::Json.load_file_if_valid('does/not/exist.json')).to eql(nil)
-    end
-  end
-
-  context '#load_file' do
-    it_should_behave_like 'json file loader', Puppet::Util::Json.method(:load_file)
-
-    it 'raises an error when the file is invalid JSON' do
-      file_path = file_containing('input', '{ invalid')
-
-      expect {
-        Puppet::Util::Json.load_file(file_path)
-      }.to raise_error(Puppet::Util::Json::ParseError, /unexpected token at '{ invalid'/)
-    end
-
-    it 'raises an error when the filename is illegal' do
-      expect {
-        Puppet::Util::Json.load_file("not\0allowed")
-      }.to raise_error(ArgumentError, /null byte/)
-    end
-
-    it 'raises an error when the file does not exist' do
-      expect {
-        Puppet::Util::Json.load_file('does/not/exist.json')
-      }.to raise_error(Errno::ENOENT, /No such file or directory/)
-    end
-
-    it 'writes data formatted as JSON to disk' do
-      file_path = file_containing('input', Puppet::Util::Json.dump({ "my" => "data" }))
-
-      expect(Puppet::Util::Json.load_file(file_path)).to eq({ "my" => "data" })
-    end
-  end
-end