Merge pull request #1712 from puppetlabs/MODULES-11802

(MODULES-11802) Add support for RHEL 10

Author: skyamgarp

lib/puppet/type/mysql_database.rb

@@ -14,15 +14,33 @@
     desc 'The name of the MySQL database to manage.'
   end
 
+  # `utf8` is a deprecated alias for `utf8mb3` in both MySQL and MariaDB. Newer
+  # servers (e.g. MariaDB 11 on RHEL 10) report the canonical `utf8mb3` name back,
+  # while users typically request `utf8`. Treat the two spellings as equivalent so
+  # the resource stays idempotent regardless of which the server reports. Charset
+  # and collation names are case-insensitive and the server reports them
+  # lowercased, so downcase first to also match user input such as `UTF8`.
+  def self.normalise_utf8(value)
+    value.to_s.downcase.sub(%r{^utf8mb3}, 'utf8')
+  end
+
   newproperty(:charset) do
     desc 'The CHARACTER SET setting for the database'
     defaultto :utf8
     newvalue(%r{^\S+$})
+
+    def insync?(is)
+      resource.class.normalise_utf8(is) == resource.class.normalise_utf8(should)
+    end
   end
 
   newproperty(:collate) do
     desc 'The COLLATE setting for the database'
     defaultto :utf8_general_ci
     newvalue(%r{^\S+$})
+
+    def insync?(is)
+      resource.class.normalise_utf8(is) == resource.class.normalise_utf8(should)
+    end
   end
 end

metadata.json

@@ -19,7 +19,8 @@
       "operatingsystemrelease": [
         "7",
         "8",
-        "9"
+        "9",
+        "10"
       ]
     },
     {

spec/unit/puppet/type/mysql_database_spec.rb

@@ -24,4 +24,42 @@
       Puppet::Type.type(:mysql_database).new({})
     }.to raise_error(Puppet::Error, 'Title or name must be provided')
   end
+
+  describe 'utf8/utf8mb3 alias equivalence' do
+    # MariaDB 11 (RHEL 10) reports the canonical `utf8mb3`, users request `utf8`.
+    it 'treats charset utf8 and utf8mb3 as in sync' do
+      resource = Puppet::Type.type(:mysql_database).new(name: 'test', charset: 'utf8')
+      expect(resource.property(:charset).insync?('utf8mb3')).to be true
+    end
+
+    it 'treats charset utf8mb3 and utf8 as in sync' do
+      resource = Puppet::Type.type(:mysql_database).new(name: 'test', charset: 'utf8mb3')
+      expect(resource.property(:charset).insync?('utf8')).to be true
+    end
+
+    it 'treats collate utf8_general_ci and utf8mb3_general_ci as in sync' do
+      resource = Puppet::Type.type(:mysql_database).new(name: 'test', collate: 'utf8_general_ci')
+      expect(resource.property(:collate).insync?('utf8mb3_general_ci')).to be true
+    end
+
+    it 'still reports drift for a genuinely different charset' do
+      resource = Puppet::Type.type(:mysql_database).new(name: 'test', charset: 'utf8')
+      expect(resource.property(:charset).insync?('utf8mb4')).to be false
+    end
+
+    it 'still reports drift for a genuinely different collate' do
+      resource = Puppet::Type.type(:mysql_database).new(name: 'test', collate: 'utf8_general_ci')
+      expect(resource.property(:collate).insync?('latin1_swedish_ci')).to be false
+    end
+
+    it 'treats uppercase charset input as in sync with the lowercase server value' do
+      resource = Puppet::Type.type(:mysql_database).new(name: 'test', charset: 'UTF8')
+      expect(resource.property(:charset).insync?('utf8mb3')).to be true
+    end
+
+    it 'treats uppercase collate input as in sync with the lowercase server value' do
+      resource = Puppet::Type.type(:mysql_database).new(name: 'test', collate: 'UTF8_GENERAL_CI')
+      expect(resource.property(:collate).insync?('utf8mb3_general_ci')).to be true
+    end
+  end
 end