Fix "undefined method `gsub' for nil:NilClass" when changing existing rule UID from absent to any present

[onyxmaster]

Hi,
Currently when updating an existing rule that did not have uid specified to include an uid the module fails with the following:

Error: undefined method `gsub' for nil:NilClass
Info: Unknown failure using insync_values? on type: Firewall[100 OUTPUT IPSEC isakmp access] / property: uid to compare values [nil] and 
Error: /Stage[base]/Node_templates::Softrouter::Ipsec/Firewall[100 OUTPUT IPSEC isakmp access]/uid: change from  to 'root' failed: undefined method `gsub' for nil:NilClass

It appears that uid.insync? property (along with gid one) do not support when is is nil (see stacktrace below).

This patch fixes this issue.

Error: undefined method `gsub' for nil:NilClass
/opt/puppetlabs/puppet/cache/lib/puppet/type/firewall.rb:1376:in `insync?'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/property.rb:276:in `safe_insync?'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/transaction/resource_harness.rb:125:in `sync_if_needed'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/transaction/resource_harness.rb:90:in `block in perform_changes'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/transaction/resource_harness.rb:89:in `each'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/transaction/resource_harness.rb:89:in `perform_changes'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/transaction/resource_harness.rb:21:in `evaluate'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/transaction.rb:267:in `apply'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/transaction.rb:287:in `eval_resource'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/transaction.rb:191:in `call'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/transaction.rb:191:in `block (2 levels) in evaluate'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/util.rb:546:in `block in thinmark'
/opt/puppetlabs/puppet/lib/ruby/2.5.0/benchmark.rb:308:in `realtime'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/util.rb:545:in `thinmark'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/transaction.rb:191:in `block in evaluate'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/graph/relationship_graph.rb:122:in `traverse'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/transaction.rb:178:in `evaluate'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/resource/catalog.rb:240:in `block (2 levels) in apply'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/util.rb:546:in `block in thinmark'
/opt/puppetlabs/puppet/lib/ruby/2.5.0/benchmark.rb:308:in `realtime'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/util.rb:545:in `thinmark'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/resource/catalog.rb:239:in `block in apply'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/util/log.rb:161:in `with_destination'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/transaction/report.rb:148:in `as_logging_destination'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/resource/catalog.rb:238:in `apply'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/configurer.rb:193:in `block (2 levels) in apply_catalog'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/util.rb:546:in `block in thinmark'
/opt/puppetlabs/puppet/lib/ruby/2.5.0/benchmark.rb:308:in `realtime'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/util.rb:545:in `thinmark'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/configurer.rb:192:in `block in apply_catalog'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/util.rb:233:in `block in benchmark'
/opt/puppetlabs/puppet/lib/ruby/2.5.0/benchmark.rb:308:in `realtime'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/util.rb:232:in `benchmark'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/configurer.rb:191:in `apply_catalog'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/configurer.rb:433:in `run_internal'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/configurer.rb:248:in `block in run'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/context.rb:62:in `override'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet.rb:314:in `override'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/configurer.rb:218:in `run'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/agent.rb:60:in `block (5 levels) in run'
/opt/puppetlabs/puppet/lib/ruby/2.5.0/timeout.rb:93:in `block in timeout'
/opt/puppetlabs/puppet/lib/ruby/2.5.0/timeout.rb:103:in `timeout'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/agent.rb:59:in `block (4 levels) in run'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/agent/locker.rb:21:in `lock'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/agent.rb:53:in `block (3 levels) in run'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/agent.rb:136:in `with_client'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/agent.rb:50:in `block (2 levels) in run'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/agent.rb:101:in `run_in_fork'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/agent.rb:49:in `block in run'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/application.rb:179:in `controlled_run'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/agent.rb:47:in `run'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/application/agent.rb:426:in `onetime'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/application/agent.rb:386:in `block in run_command'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/context.rb:62:in `override'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet.rb:314:in `override'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/application/agent.rb:382:in `run_command'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/application.rb:382:in `block in run'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/util.rb:735:in `exit_on_fail'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/application.rb:382:in `run'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/util/command_line.rb:143:in `run'
/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/util/command_line.rb:77:in `execute'
/opt/puppetlabs/puppet/bin/puppet:5:in `<main>'
Info: Unknown failure using insync_values? on type: Firewall[100 OUTPUT IPSEC isakmp access] / property: uid to compare values [nil] and 
Error: /Stage[base]/Node_templates::Softrouter::Ipsec/Firewall[100 OUTPUT IPSEC isakmp access]/uid: change from  to 'root' failed: undefined method `gsub' for nil:NilClass

[puppet-community-rangefinder]

firewall is a type

Breaking changes to this file WILL impact these 120 modules (exact match):

• danfoster-networker
• echoes-monit
• ploperations-haproxy_consul
• gnubilafrance-nfs
• praekeltfoundation-docker_firewall
• myoung34-mirthconnect
• tomkrieger-remediate_install
• railsdog-awsfirewall
• evenup-common
• karume-openstack
• maxadamo-zfs_nas
• pennycoders-mesos
• tedivm-psad
• jamesread-commonlinuxstuff
• jlambert121-puppet
• puppet-smokeping
• jgazeley-freeradius
• maxadamo-galera_maxscale
• pennycoders-zookeeper
• treydock-osg
• wdec-echoes_monit
• maany-simple_grid
• soli-monit
• tufin-secureapp
• radez-pacemaker
• binarin-binarin
• puppetlabs-puppetdb
• puppetlabs-awsdemo_profiles
• openstack-pacemaker
• compass-examdb
• olevole-memcached
• wdec-monit
• puppetlabs-openstack
• myoung34-hbase
• echoes-echoes_firewall
• abstractit-nrpe
• pmuller-aws_firewall
• enterprisemodules-ora_profile
• glarizza-profiles
• bashtoni-masq
• huit-ipa
• themeier-ssh
• SchnWalter-happydev
• Nextdoor-strongswan
• evenup-puppet
• tomkrieger-security_baseline
• narasimhasv-openstack
• jethrocarr-timemachine
• treydock-globus
• mtsinc1-trac
• puppetlabs-wordpress_app
• mikegleasonjr-server
• dhogland-splunk
• geoffwilliams-r_profile
• CERNOps-bdii
• jethrocarr-roadwarrior
• enterprisemodules-ora_rac
• danfoster-sitefirewall
• ffquintella-firewallmanager
• compass-rserve
• locp-cassandra
• puppetfinland-packetfilter
• jgazeley-speedtest
• aco-tomcat
• olevole-ssh
• shearn89-toughen
• maxchk-varnish
• godp1301-postgresql
• stesie-gluon
• seteam-role
• puppetfinland-puppetmaster
• mdelaney-icecc
• maxadamo-galera_proxysql
• rogierslag-openswan
• 42ways-railsapp
• thias-rhel
• puppet-cassandra
• compass-learninglocker
• wdijkerman-zabbix
• andrewkroh-base_firewall
• treydock-gpfs
• mvasilenko-gocd
• alexharvey-firewall_multi
• treydock-slurm
• oris-appserver
• evenup-riakdev
• dhollinger-devopsdays
• tscopp-jss
• jgazeley-networker
• jgazeley-ekahau_throughput_server
• glorpen-g_firewall
• jgazeley-monyog
• jgazeley-nagios
• maxadamo-tiny_nas
• jmkeyes-gocd
• puppet-zabbix
• thoherr-railsapp
• saz-memcached
• pennycoders-marathon
• cloudscaling-scaleio
• ghoneycutt-ssh
• hesco-weave
• gabe-pe_razor_complete
• myoung34-marklogic
• jonnyx-samba
• tracywebtech-dofirewall
• sjoeboo-puppet
• fraenki-galera
• rendhalver-nrpe
• inkling-postgresql
• sat6qe-katellovirt
• eelcomaljaars-friendica
• pltraining-selfpaced
• calmenergy-fail2ban
• abiquo-abiquo
• eschiller-trac
• cnafsd-bdii
• emccode-scaleio
• echoes-strongswan
• wazuh-wazuh

Breaking changes to this file MAY impact these 143 modules (near match):

• niksv-mediawiki
• puppetfinland-postfix
• puppetfinland-easy_ipa
• puppetfinland-gitdaemon
• puppetfinland-monit
• puppetfinland-bacula
• example42-tinc
• gururaj-mediawiki
• jgazeley-iperf
• example42-postgresql
• example42-postfix
• sathieu-c_icap
• example42-lighttpd
• puppetfinland-snmpd
• example42-vagrant
• puppetfinland-webserver
• maestrodev-maestro_nodes
• example42-dhcpd
• example42-xinetd
• gsachar1-mediawiki
• HEPPuppet-htcondor
• tscopp-bigfix
• lcgdm-voms
• puppetfinland-buildbot
• rehan-samba
• example42-tftp
• example42-openntpd
• echoes-wrappers
• shantanumalik-mediawiki
• manish1984-mediawiki
• example42-apache
• example42-splunk
• counsyl-memcached
• example42-resolver
• example42-dovecot
• ravishankar1jan-mediawiki
• example42-snmpd
• example42-psick
• infnpd-creamce
• suvarnagodri-mediawiki
• netmanagers-bacula
• example42-nfs
• example42-newrelic
• tedivm-hieratic
• example42-freeradius
• autostructure-secure_linux_cis
• hemantgangwar-mediawiki
• anthomas-mediawiki
• pia-mediawiki
• openstack-tripleo
• devopera-docommon
• example42-sysklogd
• example42-foreman
• concrete-nagios
• Azcender-profile
• webserve-mediawiki
• example42-mcollective
• jmkeyes-bind
• example42-vsftpd
• example42-jenkins
• camptocamp-pacemaker
• example42-multipath
• mithilas-mediawiki
• esakazmi-mediawiki
• CERNOps-fts
• narenv-mediawiki
• example42-tomcat
• rehan-cfssl
• example42-exim
• nitish741-mediawiki
• example42-heartbeat
• example42-nginx
• netmanagers-bind
• jethrocarr-unifi_controller
• example42-samba
• example42-redis
• puppetfinland-openvpn
• prakash007-mediawiki
• fuzeman-bind
• example42-puppetdashboard
• kiranhosamani-mediawiki
• puppetfinland-sshd
• example42-libvirt
• example42-nrpe
• abhaysoni-mediawiki
• counsyl-redis
• example42-monit
• dbsrinivasulu-mediawiki
• vinaycharles-mediawiki
• raviforge-mediawiki
• example42-munin
• 214310-mediawiki
• preethi-mediawiki
• puppet-jenkins
• jaysingh-mediawiki
• puppetfinland-mysql
• puppetfinland-dirsrv
• example42-elasticsearch
• mmack-cfssl
• hegdec-mediawiki
• example42-sendmail
• example42-rsyslog
• example42-clvm
• netmanagers-nut
• byjupv-mediakwiki
• example42-rsync
• maestrodev-avahi
• netmanagers-dnsmasq
• example42-orientdb
• puppetfinland-aptcacherng
• puppetfinland-znc
• funaccount-mediawiki
• rehan-nginx
• intelliment-itlm
• jethrocarr-unifi_video
• example42-graylog2
• puppetfinland-tinyproxy
• dharknes-scst
• vshn-uhosting
• example42-jboss
• example42-ntp
• example42-activemq
• example42-puppet
• example42-mysql
• parthitraining-mediawiki
• rtyler-jenkins
• example42-logstash
• gardouille-proxmox
• example42-puppetdb
• tykeal-gerrit
• sunilh-mediawiki
• example42-rhcs
• seteam-profile
• puppetfinland-ntp
• pbhutani-mediawiki
• example42-autofs
• soli-wrappers
• example42-openvpn
• counsyl-sys
• example42-openssh
• example42-proftpd
• neillturner-teamcity
• netmanagers-bareos

This module is declared in 108 of 578 indexed public Puppetfiles.

---

These results were generated with Rangefinder, a tool that helps predict the downstream impact of breaking changes to elements used in Puppet modules. You can run this on the command line to get a full report.

Exact matches are those that we can positively identify via namespace and the declaring modules' metadata. Non-namespaced items, such as Puppet 3.x functions, will always be reported as near matches only.

[CLAassistant]

All committers have signed the CLA.

[adrianiurca]

Hey @onyxmaster, thank you for your contribution!

kind regards,
@adrianiurca