Merge pull request #1237 from qha/repair-mysql-grant-docs-diagnostics

Repair mysql_grant docs and diagnostics

Author: michaeltlombardi

REFERENCE.md

@@ -1111,7 +1111,7 @@ The following parameters are available in the `mysql_grant` type.
 
 namevar
 
-Name to describe the grant.
+Name to describe the grant. Must match *user*@*host*/*table*.
 
 ### mysql_plugin
 

lib/puppet/type/mysql_grant.rb

@@ -33,12 +33,12 @@ def initialize(*args)
   end
   # rubocop:enable Style/MultilineBlockChain
   validate do
-    raise(_('`privileges` `parameter` is required.')) if self[:ensure] == :present && self[:privileges].nil?
-    raise(_('`privileges` `parameter`: PROXY can only be specified by itself.')) if Array(self[:privileges]).count > 1 && Array(self[:privileges]).include?('PROXY')
-    raise(_('`table` `parameter` is required.')) if self[:ensure] == :present && self[:table].nil?
-    raise(_('`user` `parameter` is required.')) if self[:ensure] == :present && self[:user].nil?
+    raise(_('mysql_grant: `privileges` `parameter` is required.')) if self[:ensure] == :present && self[:privileges].nil?
+    raise(_('mysql_grant: `privileges` `parameter`: PROXY can only be specified by itself.')) if Array(self[:privileges]).count > 1 && Array(self[:privileges]).include?('PROXY')
+    raise(_('mysql_grant: `table` `parameter` is required.')) if self[:ensure] == :present && self[:table].nil?
+    raise(_('mysql_grant: `user` `parameter` is required.')) if self[:ensure] == :present && self[:user].nil?
     if self[:user] && self[:table]
-      raise(_('`name` `parameter` must match user@host/table format.')) if self[:name] != "#{self[:user]}/#{self[:table]}"
+      raise(_('mysql_grant: `name` `parameter` must match user@host/table format.')) if self[:name] != "#{self[:user]}/#{self[:table]}"
     end
   end
 
@@ -56,7 +56,7 @@ def initialize(*args)
     validate do |value|
       mysql_version = Facter.value(:mysql_version)
       if value =~ %r{proxy}i && Puppet::Util::Package.versioncmp(mysql_version, '5.5.0') < 0
-        raise(ArgumentError, _('PROXY user not supported on mysql versions < 5.5.0. Current version %{version}.') % { version: mysql_version })
+        raise(ArgumentError, _('mysql_grant: PROXY user not supported on mysql versions < 5.5.0. Current version %{version}.') % { version: mysql_version })
       end
     end
   end
@@ -66,7 +66,7 @@ def initialize(*args)
 
     validate do |value|
       if Array(@resource[:privileges]).include?('PROXY') && !%r{^[0-9a-zA-Z$_]*@[\w%\.:\-\/]*$}.match(value)
-        raise(ArgumentError, _('`table` `property` for PROXY should be specified as proxy_user@proxy_host.'))
+        raise(ArgumentError, _('mysql_grant: `table` `property` for PROXY should be specified as proxy_user@proxy_host.'))
       end
     end
 
@@ -95,15 +95,15 @@ def initialize(*args)
         user_part = matches[1]
         host_part = matches[2]
       else
-        raise(ArgumentError, _('Invalid database user %{user}.') % { user: value })
+        raise(ArgumentError, _('mysql_grant: Invalid database user %{user}.') % { user: value })
       end
       # rubocop:enable Lint/AssignmentInCondition
       # rubocop:enable Lint/UselessAssignment
       mysql_version = Facter.value(:mysql_version)
       unless mysql_version.nil?
-        raise(ArgumentError, _('MySQL usernames are limited to a maximum of 16 characters.')) if Puppet::Util::Package.versioncmp(mysql_version, '5.7.8') < 0 && user_part.size > 16
-        raise(ArgumentError, _('MySQL usernames are limited to a maximum of 32 characters.')) if Puppet::Util::Package.versioncmp(mysql_version, '10.0.0') < 0 && user_part.size > 32
-        raise(ArgumentError, _('MySQL usernames are limited to a maximum of 80 characters.')) if Puppet::Util::Package.versioncmp(mysql_version, '10.0.0') > 0 && user_part.size > 80
+        raise(ArgumentError, _('mysql_grant: MySQL usernames are limited to a maximum of 16 characters.')) if Puppet::Util::Package.versioncmp(mysql_version, '5.7.8') < 0 && user_part.size > 16
+        raise(ArgumentError, _('mysql_grant: MySQL usernames are limited to a maximum of 32 characters.')) if Puppet::Util::Package.versioncmp(mysql_version, '10.0.0') < 0 && user_part.size > 32
+        raise(ArgumentError, _('mysql_grant: MySQL usernames are limited to a maximum of 80 characters.')) if Puppet::Util::Package.versioncmp(mysql_version, '10.0.0') > 0 && user_part.size > 80
       end
     end
 

spec/unit/puppet/type/mysql_grant_spec.rb

@@ -71,7 +71,7 @@
   it 'requires the name to match the user and table #specific' do
     expect {
       Puppet::Type.type(:mysql_grant).new(name: 'foo', privileges: ['ALL'], table: ['*.*'], user: 'foo@localhost')
-    }.to raise_error %r{`name` `parameter` must match user@host\/table format}
+    }.to raise_error %r{mysql_grant: `name` `parameter` must match user@host\/table format}
   end
 
   describe 'it should munge privileges' do