ruby_spec.rb

# frozen_string_literal: true

require 'spec_helper'
require 'puppet'

provider_class = Puppet::Type.type(:ini_setting).provider(:ruby)
describe provider_class do
  include PuppetlabsSpec::Files

  let(:tmpfile) { tmpfilename('ini_setting_test') }
  let(:emptyfile) { tmpfilename('ini_setting_test_empty') }

  let(:common_params) do
    {
      title: 'ini_setting_ensure_present_test',
      path: tmpfile,
      section: 'section2'
    }
  end

  def validate_file(expected_content, tmpfile)
    expect(File.read(tmpfile)).to eq(expected_content)
  end

  before :each do
    File.write(tmpfile, orig_content)
    File.write(emptyfile, '')
  end

  context 'when calling instances' do
    let :orig_content do
      ''
    end

    it 'fails when file path is not set' do
      expect {
        provider_class.instances
      }.to raise_error(Puppet::Error, 'Ini_settings only support collecting instances when a file path is hard coded')
    end

    context 'when file path is set by a child class' do
      child_one = Class.new(provider_class) do
        def self.file_path
          emptyfile
        end
      end
      it 'returns [] when file is empty' do
        allow(child_one).to receive(:file_path).and_return(emptyfile)
        expect(child_one.instances).to eq([])
      end

      child_two = Class.new(provider_class) do
        def self.file_path
          '/some/file/path'
        end
      end
      it 'overrides the provider instances file_path' do
        resource = Puppet::Type::Ini_setting.new(common_params)
        provider = child_two.new(resource)
        expect(provider.file_path).to eq('/some/file/path')
      end
    end

    context 'when file has contecnts' do
      let(:orig_content) do
        <<-INIFILE
          # This is a comment
          [section1]
          ; This is also a comment
          foo=foovalue

          bar = barvalue
          main = true
          [section2]

          foo= foovalue2
          baz=bazvalue
          url = http://192.168.1.1:8080
          [section:sub]
          subby=bar
              #another comment
           ; yet another comment
        INIFILE
      end

      it 'is able to parse the results' do
        child_three = Class.new(provider_class) do
          def self.file_path
            '/some/file/path'
          end
        end
        expect(child_three).to receive(:file_path).twice.and_return(tmpfile)
        expect(child_three.instances.size).to eq(7)
        expected_array = [
          { name: 'section1/foo', value: 'foovalue' },
          { name: 'section1/bar', value: 'barvalue' },
          { name: 'section1/main', value: 'true' },
          { name: 'section2/foo', value: 'foovalue2' },
          { name: 'section2/baz', value: 'bazvalue' },
          { name: 'section2/url', value: 'http://192.168.1.1:8080' },
          { name: 'section:sub/subby', value: 'bar' },
        ]
        real_array = []
        ensure_array = []
        child_three.instances.each do |x|
          prop_hash    = x.instance_variable_get(:@property_hash)
          ensure_value = prop_hash.delete(:ensure)
          ensure_array.push(ensure_value)
          real_array.push(prop_hash)
        end
        expect(ensure_array.uniq).to eq([:present])
        expect((real_array - expected_array) && (expected_array - real_array)).to eq([])
      end
    end
  end

  context 'when ensuring that a setting is present' do
    let(:orig_content) do
      <<~INIFILE
        # This is a comment
        [section1]
        ; This is also a comment
        foo=foovalue

        bar = barvalue
        main = true
        [section2]

        foo= foovalue2
        baz=bazvalue
        url = http://192.168.1.1:8080
        [section:sub]
        subby=bar
            #another comment
         ; yet another comment

        -nonstandard-
          shoes = purple
      INIFILE
    end

    expected_content_one = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      yahoo = yippee
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = purple
    INIFILE
    it 'adds a missing setting to the correct section' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(setting: 'yahoo', value: 'yippee'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_one, tmpfile)
    end

    expected_content_two = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = purple
        yahoo = yippee
    INIFILE
    it 'adds a missing setting to the correct section with pre/suffix' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'nonstandard', setting: 'yahoo', value: 'yippee', section_prefix: '-', section_suffix: '-'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_two, tmpfile)
    end

    expected_content_three = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = purple
      		indented = weirdly
    INIFILE
    it 'adds a missing setting to the correct section with indent_char' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'nonstandard', setting: 'indented', value: 'weirdly', section_prefix: '-', section_suffix: '-', indent_char: "\t"))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_three, tmpfile)
    end

    expected_content_four = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = purple
      				indented = weirdly
    INIFILE
    it 'adds a missing setting to the correct section indented by indent_char * indent_width' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'nonstandard', setting: 'indented', value: 'weirdly',
                                                                   section_prefix: '-', section_suffix: '-', indent_char: "\t", indent_width: 4))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_four, tmpfile)
    end

    expected_content_five = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = purple
      				indented = weirdly
    INIFILE
    it 'treats a string indent_width as an integer' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'nonstandard', setting: 'indented', value: 'weirdly',
                                                                   section_prefix: '-', section_suffix: '-', indent_char: "\t", indent_width: '4'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_five, tmpfile)
    end

    expected_content_six = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = purple
      yahoo = yippee
    INIFILE
    it 'adds a missing setting to the correct section with colon' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section:sub', setting: 'yahoo', value: 'yippee'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_six, tmpfile)
    end

    expected_content_seven = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue2
      url = http://192.168.1.1:8080
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = purple
    INIFILE
    it 'modifies an existing setting with a different value' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(setting: 'baz', value: 'bazvalue2'))
      provider = described_class.new(resource)
      expect(provider).to be_exists
      provider.value = 'bazvalue2'
      validate_file(expected_content_seven, tmpfile)
    end

    expected_content_eight = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = false
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = purple
    INIFILE
    it 'modifies an existing setting with a different boolean value' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section1', setting: 'main', value: false))
      provider = described_class.new(resource)
      expect(provider.exists?).to be true
      transaction = instance_double('transaction', persistence: true)
      expect(Puppet::Transaction::ResourceHarness.new(transaction).evaluate(provider.resource).out_of_sync).to be(true)
      validate_file(expected_content_eight, tmpfile)
    end

    expected_content_nine = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = orange
    INIFILE
    it 'modifies an existing setting with pre/suffix with a different value' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'nonstandard', setting: 'shoes', value: 'orange', section_prefix: '-', section_suffix: '-'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be true
      provider.value = 'orange'
      validate_file(expected_content_nine, tmpfile)
    end

    expected_content_ten = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section:sub]
      subby=foo
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = purple
    INIFILE
    it 'modifies an existing setting with a different value - with colon in section' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section:sub', setting: 'subby', value: 'foo'))
      provider = described_class.new(resource)
      expect(provider.value).to eq('bar')
      provider.value = 'foo'
      validate_file(expected_content_ten, tmpfile)
    end

    expected_content_eleven = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.0.1:8080
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = purple
    INIFILE
    it 'is able to handle settings with non alphanumbering settings' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(setting: 'url', value: 'http://192.168.0.1:8080'))
      provider = described_class.new(resource)
      expect(provider.value).to eq('http://192.168.1.1:8080')
      provider.value = 'http://192.168.0.1:8080'
      validate_file(expected_content_eleven, tmpfile)
    end

    expected_content_twelve = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = http://192.168.0.1:8080
    INIFILE
    it 'is able to handle settings with pre/suffix with non alphanumbering settings' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'nonstandard', setting: 'shoes', value: 'http://192.168.0.1:8080', section_prefix: '-', section_suffix: '-'))
      provider = described_class.new(resource)
      expect(provider.value).to eq('purple')
      provider.value = 'http://192.168.0.1:8080'
      validate_file(expected_content_twelve, tmpfile)
    end

    it 'recognizes an existing setting with the specified value' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(setting: 'baz', value: 'bazvalue'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be true
    end

    it 'recognizes an existing setting with pre/suffix with the specified value' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'nonstandard', setting: 'shoes', value: 'purple',
                                                                   section_prefix: '-', section_suffix: '-'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be true
    end

    expected_content_thirteen = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = purple

      [section3]
      huzzah = shazaam
    INIFILE
    it 'adds a new section if the section does not exist' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section3', setting: 'huzzah', value: 'shazaam'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_thirteen, tmpfile)
    end

    expected_content_fourteen = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = purple

      -section3-
      huzzah = shazaam
    INIFILE
    it 'adds a new section with pre/suffix if the section does not exist' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section3', setting: 'huzzah', value: 'shazaam', section_prefix: '-', section_suffix: '-'))
      provider = described_class.new(resource)
      expect(provider).not_to be_exists
      provider.create
      validate_file(expected_content_fourteen, tmpfile)
    end

    expected_content_fifteen = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = purple

      [section:subsection]
      huzzah = shazaam
    INIFILE
    it 'adds a new section if the section does not exist - with colon' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section:subsection', setting: 'huzzah', value: 'shazaam'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_fifteen, tmpfile)
    end

    expected_content_sixteen = <<~INIFILE
      # This is a comment
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

      -nonstandard-
        shoes = purple

      -section:subsection-
      huzzah = shazaam
    INIFILE
    it 'adds a new section with pre/suffix if the section does not exist - with colon' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section:subsection', setting: 'huzzah', value: 'shazaam', section_prefix: '-', section_suffix: '-'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_sixteen, tmpfile)
    end

    it 'adds a new empty section' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file("#{orig_content}\n[section]\n", tmpfile)
    end

    it 'is able to handle variables of any type' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section1', setting: 'main', value: true))
      provider = described_class.new(resource)
      expect(provider.value).to eq('true')
    end
  end

  context 'when no sections exist' do
    let(:orig_content) do
      ''
    end

    validate_zero = "[section]\n"

    it 'adds an empty section' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section', path: emptyfile))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(validate_zero, emptyfile)
    end

    validate_one = '[section1]
setting1 = hellowworld
'
    it 'adds a new section' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section1', setting: 'setting1', value: 'hellowworld', path: emptyfile))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(validate_one, emptyfile)
    end

    validate_two = '-section1-
setting1 = hellowworld
'
    it 'adds a new section with pre/suffix' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section1', setting: 'setting1', value: 'hellowworld', path: emptyfile, section_prefix: '-', section_suffix: '-'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(validate_two, emptyfile)
    end

    validate_three = '[section:subsection]
setting1 = hellowworld
'
    it 'adds a new section with colon' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section:subsection', setting: 'setting1', value: 'hellowworld', path: emptyfile))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(validate_three, emptyfile)
    end

    validate_four = '-section:subsection-
setting1 = hellowworld
'
    it 'adds a new section with pre/suffix with colon' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section:subsection', setting: 'setting1', value: 'hellowworld', path: emptyfile, section_prefix: '-', section_suffix: '-'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(validate_four, emptyfile)
    end
  end

  context 'when only an empty section exists' do
    let(:orig_content) do
      "[section]\n"
    end

    it 'adds a new setting' do
      expected = orig_content
      { 'section' => { 'first' => 1 } }.each_pair do |section, settings|
        settings.each_pair do |setting, value|
          resource = Puppet::Type::Ini_setting.new(common_params.merge(section:, setting:, value:))
          provider = described_class.new(resource)
          expect(provider.exists?).to be false
          # byebug
          provider.create
          expected += "#{setting} = #{value}\n"
        end
      end
      validate_file(expected, tmpfile)
    end
  end

  context 'when dealing with a global section' do
    let(:orig_content) do
      <<~INIFILE
        # This is a comment
        foo=blah
        [section2]
        foo = http://192.168.1.1:8080
         ; yet another comment
      INIFILE
    end

    expected_content_one = <<~INIFILE
      # This is a comment
      foo=blah
      bar = yippee
      [section2]
      foo = http://192.168.1.1:8080
       ; yet another comment
    INIFILE
    it "adds a missing setting if it doesn't exist" do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: '', setting: 'bar', value: 'yippee'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_one, tmpfile)
    end

    expected_content_two = <<~INIFILE
      # This is a comment
      foo=yippee
      [section2]
      foo = http://192.168.1.1:8080
       ; yet another comment
    INIFILE
    it 'modifies an existing setting with a different value' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: '', setting: 'foo', value: 'yippee'))
      provider = described_class.new(resource)
      expect(provider.value).to eq('blah')
      provider.value = 'yippee'
      validate_file(expected_content_two, tmpfile)
    end

    it 'recognizes an existing setting with the specified value' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: '', setting: 'foo', value: 'blah'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be true
    end
  end

  context 'when the first line of the file is a section' do
    let(:orig_content) do
      <<~INIFILE
        [section2]
        foo = http://192.168.1.1:8080
      INIFILE
    end

    expected_content_one = <<~INIFILE
      foo = yippee

      [section2]
      foo = http://192.168.1.1:8080
    INIFILE
    it 'is able to add a global setting' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: '', setting: 'foo', value: 'yippee'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_one, tmpfile)
    end

    expected_content_two = <<~INIFILE
      [section2]
      foo = yippee
    INIFILE
    it 'modifies an existing setting' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section2', setting: 'foo', value: 'yippee'))
      provider = described_class.new(resource)
      expect(provider.value).to eq('http://192.168.1.1:8080')
      provider.value = 'yippee'
      validate_file(expected_content_two, tmpfile)
    end

    expected_content_three = <<~INIFILE
      [section2]
      foo = http://192.168.1.1:8080
      bar = baz
    INIFILE
    it 'adds a new setting' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section2', setting: 'bar', value: 'baz'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_three, tmpfile)
    end
  end

  context 'when overriding the separator' do
    let(:orig_content) do
      <<~INIFILE
        [section2]
        foo=bar
      INIFILE
    end

    expected_content_one = <<~INIFILE
      [section2]
      foo=yippee
    INIFILE
    it 'modifies an existing setting' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section2', setting: 'foo', value: 'yippee', key_val_separator: '='))
      provider = described_class.new(resource)
      expect(provider.value).to eq('bar')
      provider.value = 'yippee'
      validate_file(expected_content_one, tmpfile)
    end
  end

  context 'when overriding the separator to something other than =' do
    let(:orig_content) do
      <<~INIFILE
        [section2]
        foo: bar
      INIFILE
    end

    expected_content_one = <<~INIFILE
      [section2]
      foo: yippee
    INIFILE
    it 'modifies an existing setting' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section2', setting: 'foo', value: 'yippee', key_val_separator: ': '))
      provider = described_class.new(resource)
      expect(provider.value).to eq('bar')
      provider.value = 'yippee'
      validate_file(expected_content_one, tmpfile)
    end

    expected_content_two = <<~INIFILE
      [section2]
      foo: bar
      bar: baz
    INIFILE
    it 'adds a new setting' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section2', setting: 'bar', value: 'baz', key_val_separator: ': '))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_two, tmpfile)
    end
  end

  context 'when overriding the separator to a space' do
    let(:orig_content) do
      <<~INIFILE
        [section2]
        foo bar
      INIFILE
    end

    expected_content_one = <<~INIFILE
      [section2]
      foo yippee
    INIFILE
    it 'modifies an existing setting' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section2', setting: 'foo', value: 'yippee', key_val_separator: ' '))
      provider = described_class.new(resource)
      expect(provider.value).to eq('bar')
      provider.value = 'yippee'
      validate_file(expected_content_one, tmpfile)
    end

    expected_content_two = <<~INIFILE
      [section2]
      foo bar
      bar baz
    INIFILE
    it 'adds a new setting' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section2', setting: 'bar', value: 'baz', key_val_separator: ' '))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_two, tmpfile)
    end
  end

  context 'when ensuring that a setting is absent' do
    let(:orig_content) do
      <<~INIFILE
        [section1]
        ; This is also a comment
        foo=foovalue

        bar = barvalue
        main = true
        [section2]

        foo= foovalue2
        baz=bazvalue
        url = http://192.168.1.1:8080
        [section3]
        # com = ment
        uncom = ment
        [section4]
        uncom = ment
        [section:sub]
        subby=bar
            #another comment
         ; yet another comment

         -nonstandard-
           shoes = purple
      INIFILE
    end

    expected_content_one = <<~INIFILE
      [section1]
      ; This is also a comment

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section3]
      # com = ment
      uncom = ment
      [section4]
      uncom = ment
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

       -nonstandard-
         shoes = purple
    INIFILE
    it 'removes a setting that exists' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section1', setting: 'foo', ensure: 'absent'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be true
      provider.destroy
      validate_file(expected_content_one, tmpfile)
    end

    expected_content_two = <<~INIFILE
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section3]
      # com = ment
      uncom = ment
      [section4]
      uncom = ment
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

    INIFILE
    it 'removes a setting with pre/suffix that exists' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'nonstandard', setting: 'shoes', ensure: 'absent', section_prefix: '-', section_suffix: '-'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be true
      provider.destroy
      validate_file(expected_content_two, tmpfile)
    end

    expected_content_three = <<~INIFILE
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section3]
      # com = ment
      uncom = ment
      [section4]
      uncom = ment
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

       -nonstandard-
         shoes = purple
    INIFILE
    it 'does nothing for a setting that does not exist' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section:sub', setting: 'foo', ensure: 'absent'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.destroy
      validate_file(expected_content_three, tmpfile)
    end

    expected_content_four = <<~INIFILE
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section3]
      # com = ment
      uncom = ment
      [section4]
      uncom = ment
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

       -nonstandard-
         shoes = purple
    INIFILE
    it 'does nothing for a setting with pre/suffix that does not exist' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'nonstandard', setting: 'foo', ensure: 'absent', section_prefix: '-', section_suffix: '-'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.destroy
      validate_file(expected_content_four, tmpfile)
    end

    expected_content_five = <<~INIFILE
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section3]
      # com = ment
      [section4]
      uncom = ment
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

       -nonstandard-
         shoes = purple
    INIFILE
    it 'does not remove a section when the last uncommented setting is removed if there are comments' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section3', setting: 'uncom', ensure: 'absent'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be true
      provider.destroy
      validate_file(expected_content_five, tmpfile)
    end

    expected_content_six = <<~INIFILE
      [section1]
      ; This is also a comment
      foo=foovalue

      bar = barvalue
      main = true
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://192.168.1.1:8080
      [section3]
      # com = ment
      uncom = ment
      [section:sub]
      subby=bar
          #another comment
       ; yet another comment

       -nonstandard-
         shoes = purple
    INIFILE
    it 'removes the section when removing the last line in the section' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section4', setting: 'uncom', ensure: 'absent'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be true
      provider.destroy
      validate_file(expected_content_six, tmpfile)
    end
  end

  context 'when section has only empty line' do
    let(:orig_content) do
      <<~INIFILE
        [section1]
        foo=foovalue


        [section2]

        foo= foovalue2
        baz=bazvalue
        url = http://
      INIFILE
    end

    expected_content = <<~INIFILE
      [section2]

      foo= foovalue2
      baz=bazvalue
      url = http://
    INIFILE

    it 'remove empty section' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section1', setting: 'foo', ensure: 'absent'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be true
      provider.destroy
      validate_file(expected_content, tmpfile)
    end
  end

  context 'when dealing with indentation in sections' do
    let(:orig_content) do
      <<~INIFILE
        # This is a comment
             [section1]
             ; This is also a comment
             foo=foovalue

             bar = barvalue
             main = true

        [section2]
          foo= foovalue2
          baz=bazvalue
          url = http://192.168.1.1:8080
        [section:sub]
         subby=bar
            #another comment
          fleezy = flam
         ; yet another comment
      INIFILE
    end

    expected_content_one = <<~INIFILE
      # This is a comment
           [section1]
           ; This is also a comment
           foo=foovalue

           bar = barvalue
           main = true
           yahoo = yippee

      [section2]
        foo= foovalue2
        baz=bazvalue
        url = http://192.168.1.1:8080
      [section:sub]
       subby=bar
          #another comment
        fleezy = flam
       ; yet another comment
    INIFILE
    it 'adds a missing setting at the correct indentation when the header is aligned' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section1', setting: 'yahoo', value: 'yippee'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_one, tmpfile)
    end

    expected_content_two = <<~INIFILE
      # This is a comment
           [section1]
           ; This is also a comment
           foo=foovalue

           bar = barvalue2
           main = true

      [section2]
        foo= foovalue2
        baz=bazvalue
        url = http://192.168.1.1:8080
      [section:sub]
       subby=bar
          #another comment
        fleezy = flam
       ; yet another comment
    INIFILE
    it 'updates an existing setting at the correct indentation when the header is aligned' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section1', setting: 'bar', value: 'barvalue2'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be true
      provider.create
      validate_file(expected_content_two, tmpfile)
    end

    expected_content_three = <<~INIFILE
      # This is a comment
           [section1]
           ; This is also a comment
           foo=foovalue

           bar = barvalue
           main = true

      [section2]
        foo= foovalue2
        baz=bazvalue
        url = http://192.168.1.1:8080
        yahoo = yippee
      [section:sub]
       subby=bar
          #another comment
        fleezy = flam
       ; yet another comment
    INIFILE
    it 'adds a missing setting at the correct indentation when the header is not aligned' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section2', setting: 'yahoo', value: 'yippee'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_three, tmpfile)
    end

    expected_content_four = <<~INIFILE
      # This is a comment
           [section1]
           ; This is also a comment
           foo=foovalue

           bar = barvalue
           main = true

      [section2]
        foo= foovalue2
        baz=bazvalue2
        url = http://192.168.1.1:8080
      [section:sub]
       subby=bar
          #another comment
        fleezy = flam
       ; yet another comment
    INIFILE
    it 'updates an existing setting at the correct indentation when the header is not aligned' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section2', setting: 'baz', value: 'bazvalue2'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be true
      provider.create
      validate_file(expected_content_four, tmpfile)
    end

    expected_content_five = <<~INIFILE
      # This is a comment
           [section1]
           ; This is also a comment
           foo=foovalue

           bar = barvalue
           main = true

      [section2]
        foo= foovalue2
        baz=bazvalue
        url = http://192.168.1.1:8080
      [section:sub]
       subby=bar
          #another comment
        fleezy = flam
       ; yet another comment
       yahoo = yippee
    INIFILE
    it 'adds a missing setting at the min indentation when the section is not aligned' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section:sub', setting: 'yahoo', value: 'yippee'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_five, tmpfile)
    end

    expected_content_six = <<~INIFILE
      # This is a comment
           [section1]
           ; This is also a comment
           foo=foovalue

           bar = barvalue
           main = true

      [section2]
        foo= foovalue2
        baz=bazvalue
        url = http://192.168.1.1:8080
      [section:sub]
       subby=bar
          #another comment
        fleezy = flam2
       ; yet another comment
    INIFILE
    it 'updates an existing setting at the previous indentation when the section is not aligned' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section:sub', setting: 'fleezy', value: 'flam2'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be true
      provider.create
      validate_file(expected_content_six, tmpfile)
    end

    expected_content_seven = <<~INIFILE
      # This is a comment
           [section1]
           ; This is also a comment
           foo=foovalue

           bar = barvalue
           main = true

      [section2]
        foo= foovalue2
        baz=bazvalue
        url = http://192.168.1.1:8080
      [section:sub]
       subby=bar
          #another comment
        fleezy = flam2
       ; yet another comment
    INIFILE
    it 'updates an existing setting at the previous indentation regardless of indent_char and indent_width settings' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section:sub', setting: 'fleezy', value: 'flam2', indent_char: 'ignore this', indent_width: 10))
      provider = described_class.new(resource)
      expect(provider.exists?).to be true
      provider.create
      validate_file(expected_content_seven, tmpfile)
    end
  end

  context 'when dealing settings that have a commented version present' do
    let(:orig_content) do
      <<~INIFILE
             [section1]
             # foo=foovalue
             bar=barvalue
             foo = foovalue2

        [section2]
        # foo = foovalue
        ;bar=barvalue
        blah = blah
        #baz=
      INIFILE
    end

    expected_content_eight = <<~INIFILE
           [section1]
           # foo=foovalue
           bar=barvalue
           foo = foovalue2

      [section2]
      # foo = foovalue
      foo = foo3
      ;bar=barvalue
      blah = blah
      #baz=
    INIFILE
    it 'adds a new setting below a commented version of that setting' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section2', setting: 'foo', value: 'foo3'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_eight, tmpfile)
    end

    expected_content_nine = <<~INIFILE
           [section1]
           # foo=foovalue
           bar=barvalue
           foo = foo3

      [section2]
      # foo = foovalue
      ;bar=barvalue
      blah = blah
      #baz=
    INIFILE
    it 'updates an existing setting in place, even if there is a commented version of that setting' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section1', setting: 'foo', value: 'foo3'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be true
      provider.create
      validate_file(expected_content_nine, tmpfile)
    end

    expected_content_ten = <<~INIFILE
           [section1]
           # foo=foovalue
           bar=barvalue
           foo = foovalue2

      [section2]
      # foo = foovalue
      ;bar=barvalue
      bar = bar3
      blah = blah
      #baz=
    INIFILE
    it 'adds a new setting below a commented version of that setting, respecting semicolons as comments' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section2', setting: 'bar', value: 'bar3'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_ten, tmpfile)
    end

    expected_content_four = <<~INIFILE
           [section1]
           # foo=foovalue
           bar=barvalue
           foo = foovalue2

      [section2]
      # foo = foovalue
      ;bar=barvalue
      blah = blah
      #baz=
      baz = bazvalue
    INIFILE
    it 'adds a new setting below an empty commented version of that setting' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section2', setting: 'baz', value: 'bazvalue'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_four, tmpfile)
    end

    context 'when a section only contains comments' do
      let(:orig_content) do
        <<~INIFILE
          [section1]
          # foo=foovalue
          # bar=bar2
        INIFILE
      end

      expected_content_one = <<~INIFILE
        [section1]
        # foo=foovalue
        foo = foovalue2
        # bar=bar2
      INIFILE
      it 'is able to add a new setting when a section contains only comments' do
        resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section1', setting: 'foo', value: 'foovalue2'))
        provider = described_class.new(resource)
        expect(provider.exists?).to be false
        provider.create
        validate_file(expected_content_one, tmpfile)
      end

      expected_content_two = <<~INIFILE
        [section1]
        # foo=foovalue
        # bar=bar2
        bar = barvalue2
      INIFILE
      it 'is able to add a new setting when it matches a commented out line other than the first one' do
        resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section1', setting: 'bar', value: 'barvalue2'))
        provider = described_class.new(resource)
        expect(provider.exists?).to be false
        provider.create
        validate_file(expected_content_two, tmpfile)
      end
    end

    context 'when sections have spaces and dashes' do
      let(:orig_content) do
        <<~INIFILE
          # This is a comment
          [section - one]
          ; This is also a comment
          foo=foovalue

          bar = barvalue
          main = true
          [section - two]

          foo= foovalue2
          baz=bazvalue
          url = http://192.168.1.1:8080
          [section:sub]
          subby=bar
              #another comment
           ; yet another comment
        INIFILE
      end

      expected_content_one = <<~INIFILE
        # This is a comment
        [section - one]
        ; This is also a comment
        foo=foovalue

        bar = barvalue
        main = true
        [section - two]

        foo= foovalue2
        baz=bazvalue
        url = http://192.168.1.1:8080
        yahoo = yippee
        [section:sub]
        subby=bar
            #another comment
         ; yet another comment
      INIFILE
      it 'adds a missing setting to the correct section' do
        resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'section - two', setting: 'yahoo', value: 'yippee'))
        provider = described_class.new(resource)
        expect(provider.exists?).to be false
        provider.create
        validate_file(expected_content_one, tmpfile)
      end
    end
  end

  context 'when sections have spaces and quotations' do
    let(:orig_content) do
      <<~INIFILE
        [branch "main"]
                remote = origin
                merge = refs/heads/main

        [alias]
        to-deploy = log --merges --grep='pull request' --format='%s (%cN)' origin/production..origin/main
        [branch "production"]
                remote = origin
                merge = refs/heads/production
      INIFILE
    end

    expected_content_one = <<~INIFILE
      [branch "main"]
              remote = origin
              merge = refs/heads/main

      [alias]
      to-deploy = log --merges --grep='pull request' --format='%s (%cN)' origin/production..origin/main
      foo = bar
      [branch "production"]
              remote = origin
              merge = refs/heads/production
    INIFILE
    it 'adds a missing setting to the correct section' do
      resource = Puppet::Type::Ini_setting.new(common_params.merge(section: 'alias', setting: 'foo', value: 'bar'))
      provider = described_class.new(resource)
      expect(provider.exists?).to be false
      provider.create
      validate_file(expected_content_one, tmpfile)
    end
  end
end