Fix Deprecation (#788)

Co-authored-by: cocker-cc <[email protected]>

Author: chouetz

.fixtures.yml

@@ -2,7 +2,7 @@ fixtures:
   repositories:
     stdlib:
       repo: "git://github.com/puppetlabs/puppetlabs-stdlib.git"
-      ref: "4.24.0"
+      ref: "4.25.0"
     concat:
       repo: "git://github.com/puppetlabs/puppetlabs-concat.git"
       ref: "4.1.1"

environments/etc/Puppetfile

@@ -4,7 +4,7 @@ mod 'puppetlabs-apt', '2.4.0'
 mod 'puppetlabs-concat', '4.0.0'
 mod 'puppetlabs-puppetserver_gem', '1.0.0'
 mod 'puppetlabs-ruby', '1.0.0'
-mod 'puppetlabs-stdlib', '4.24.0'
+mod 'puppetlabs-stdlib', '4.25.0'
 mod 'puppetlabs-powershell', '2.3.0'
 mod 'puppetlabs-yumrepo_core', '1.0.3'
 mod 'puppet-zypprepo', '3.1.0'

manifests/init.pp

@@ -69,18 +69,13 @@
 #   $log_to_syslog
 #       Set value of 'log_to_syslog' variable. Default is true -> yes as in dd-agent.
 #       Valid values here are: true or false.
-#   $dogstatsd_port
-#       Set value of the 'dogstatsd_port' variable. Defaultis 8125.
 #   $report_fact_tags
 #       Sets tags for report events sent to Datadog from specified facts
 #   $report_trusted_fact_tags
 #       Sets tags for report events sent to Datadog from specified trusted facts
 #   $statsd_forward_host
 #       Set the value of the statsd_forward_host varable. Used to forward all
 #       statsd metrics to another host.
-#   $statsd_forward_port
-#       Set the value of the statsd_forward_port varable. Used to forward all
-#       statsd metrics to another host.
 #   $manage_repo
 #       Deprecated. Only works for RPM. Install datadog-agent manually and then set
 #       manage_install=false to achieve the same behaviour as setting this to false.
@@ -131,7 +126,7 @@
 #       String. Default: empty
 #   $dogstatsd_port
 #       Specifies the port to be used by dogstatsd. Must have use_dogstatsd set
-#       String. Default: empty
+#       String. Default: 8125
 #   $dogstatsd_target
 #       Change the target to be used by dogstatsd. Must have use_dogstatsd set
 #       set
@@ -146,8 +141,9 @@
 #       Enables forwarding of statsd packetsto host. Must have use_dogstatsd set
 #       String. Default: empty
 #   $statsd_forward_port
-#       Specifis port for $statsd_forward_host. Must have use_dogstatsd set
-#       String. Default: empty
+#       Specifies port for $statsd_forward_host. Must have use_dogstatsd set String.
+#       Used to forward all statsd metrics to another host.
+#       Default: empty
 #   $device_blacklist_re
 #       Specifies pattern for device blacklisting.
 #       String. Default: empty
@@ -288,30 +284,30 @@
   Boolean $manage_install = true,
   $hostname_extraction_regex = undef,
   Boolean $hostname_fqdn = false,
-  $dogstatsd_port = 8125,
+  Variant[Stdlib::Port, Pattern[/^\d*$/]] $dogstatsd_port = 8125,
   $dogstatsd_socket = '',
   Array $report_fact_tags = [],
   Array $report_trusted_fact_tags = [],
   String $statsd_forward_host = '',
-  $statsd_forward_port = '',
+  Variant[Stdlib::Port, Pattern[/^\d*$/]] $statsd_forward_port = '',
   String $statsd_histogram_percentiles = '0.95',
   Optional[String] $proxy_host = undef,
   Optional[Variant[Integer, Pattern[/^\d*$/]]] $proxy_port = undef,
   Optional[String] $proxy_user = undef,
   Optional[String] $proxy_password = undef,
-  $graphite_listen_port = '',
+  Variant[Stdlib::Port, Pattern[/^\d*$/]] $graphite_listen_port = '',
   String $extra_template = '',
   String $ganglia_host = '',
   $ganglia_port = 8651,
   Boolean $skip_ssl_validation = false,
   Boolean $skip_apt_key_trusting = false,
   Boolean $use_curl_http_client = false,
   String $recent_point_threshold = '',
-  $listen_port = '',
+  Variant[Stdlib::Port, Pattern[/^\d*$/]] $listen_port = '',
   Optional[String] $additional_checksd = undef,
   String $bind_host = '',
   Boolean $use_pup = false,
-  $pup_port = '',
+  Variant[Stdlib::Port, Pattern[/^\d*$/]] $pup_port = '',
   String $pup_interface = '',
   String $pup_url = '',
   Boolean $use_dogstatsd = true,
@@ -326,7 +322,7 @@
   String $dogstatsd_log_file = '',
   String $pup_log_file = '',
   String $syslog_host  = '',
-  $syslog_port  = '',
+  Variant[Stdlib::Port, Pattern[/^\d*$/]] $syslog_port  = '',
   String $service_discovery_backend = '',
   String $sd_config_backend = '',
   String $sd_backend_host = '',
@@ -391,23 +387,6 @@
     $dd_user = $datadog_agent::params::dd_user
   }
 
-  # Allow ports to be passed as integers or strings.
-  # lint:ignore:only_variable_string
-  $_dogstatsd_port = "${dogstatsd_port}"
-  $_statsd_forward_port = "${statsd_forward_port}"
-  $_graphite_listen_port = "${graphite_listen_port}"
-  $_listen_port = "${listen_port}"
-  $_pup_port = "${pup_port}"
-  $_syslog_port = "${syslog_port}"
-  # lint:endignore
-
-  validate_legacy(String, 'validate_re', $_dogstatsd_port, '^\d*$')
-  validate_legacy(String, 'validate_re', $_statsd_forward_port, '^\d*$')
-  validate_legacy(String, 'validate_re', $_graphite_listen_port, '^\d*$')
-  validate_legacy(String, 'validate_re', $_listen_port, '^\d*$')
-  validate_legacy(String, 'validate_re', $_pup_port, '^\d*$')
-  validate_legacy(String, 'validate_re', $_syslog_port, '^\d*$')
-
   if $conf_dir == undef {
     if $_agent_major_version == 5 {
       $_conf_dir = $datadog_agent::params::legacy_conf_dir
@@ -571,7 +550,7 @@
       require => File['/etc/dd-agent'],
     }
 
-    if ($dd_url == '') {
+    if $dd_url.empty {
       $_dd_url = 'https://app.datadoghq.com'
     } else {
       $_dd_url = $dd_url
@@ -599,7 +578,7 @@
       order   => '05',
     }
 
-    if ($extra_template != '') {
+    unless $extra_template.empty {
       concat::fragment{ 'datadog extra_template footer':
         target  => '/etc/dd-agent/datadog.conf',
         content => template($extra_template),
@@ -677,12 +656,12 @@
         },
       }
     }
-    if $host != '' {
+    if $host.empty {
+        $host_config = {}
+    } else {
         $host_config = {
           'hostname' => $host,
         }
-    } else {
-        $host_config = {}
     }
 
     if $apm_analyzed_spans {
@@ -705,19 +684,19 @@
         $apm_obfuscation_config = {}
     }
 
-    if $statsd_forward_host != '' {
-        if $_statsd_forward_port != '' {
+    if $statsd_forward_host.empty {
+        $statsd_forward_config = {}
+    } else {
+        if String($statsd_forward_port).empty {
             $statsd_forward_config = {
               'statsd_forward_host' => $statsd_forward_host,
-              'statsd_forward_port' => $statsd_forward_port,
             }
         } else {
             $statsd_forward_config = {
               'statsd_forward_host' => $statsd_forward_host,
+              'statsd_forward_port' => $statsd_forward_port,
             }
         }
-    } else {
-        $statsd_forward_config = {}
     }
 
     if $additional_checksd {

metadata.json

@@ -10,7 +10,7 @@
   "dependencies": [
     {
       "name": "puppetlabs/stdlib",
-      "version_requirement": ">=4.24.0 <9.0.0"
+      "version_requirement": ">=4.25.0 <9.0.0"
     },
     {
       "name": "puppetlabs/ruby",

templates/datadog_footer.conf.erb

@@ -21,17 +21,17 @@ recent_point_threshold: <%= @recent_point_threshold %>
 <% end -%>
 
 # Change port the Agent is listening to
-<% if @_listen_port.empty? -%>
+<% if @listen_port.to_s.empty? -%>
 # listen_port: 17123
 <% else -%>
-listen_port: <%= @_listen_port %>
+listen_port: <%= @listen_port %>
 <% end -%>
 
 # Start a graphite listener on this port
-<% if @_graphite_listen_port.empty? -%>
+<% if @graphite_listen_port.to_s.empty? -%>
 # graphite_listen_port: 17124
 <% else -%>
-graphite_listen_port: <%= @_graphite_listen_port %>
+graphite_listen_port: <%= @graphite_listen_port %>
 <% end -%>
 
 # Additional directory to look for Datadog checks
@@ -71,10 +71,10 @@ bind_host: <%= @bind_host %>
 
 use_pup: <%= @use_pup ? "yes" : "no" %>
 
-<% if @_pup_port.empty? -%>
+<% if @pup_port.to_s.empty? -%>
 # pup_port: 17125
 <% else -%>
-pup_port: <%= @_pup_port %>
+pup_port: <%= @pup_port %>
 <% end -%>
 
 <% if @pup_interface.empty? -%>
@@ -100,10 +100,10 @@ use_dogstatsd: <%= @use_dogstatsd ? "yes" : "no" %>
 # usage information, check out http://api.datadoghq.com
 
 #  Make sure your client is sending to the same port.
-<% if @_dogstatsd_port.empty? -%>
+<% if @dogstatsd_port.to_s.empty? -%>
 # dogstatsd_port: 8125
 <% else -%>
-dogstatsd_port: <%= @_dogstatsd_port %>
+dogstatsd_port: <%= @dogstatsd_port %>
 <% end -%>
 
 # By default dogstatsd will post aggregate metrics to the Agent (which handles
@@ -137,10 +137,10 @@ histogram_percentiles: <%= @statsd_histogram_percentiles %>
 <% else -%>
 statsd_forward_host: <%= @statsd_forward_host %>
 <% end -%>
-<% if @_statsd_forward_port.empty? -%>
+<% if @statsd_forward_port.to_s.empty? -%>
 # statsd_forward_port: 8125
 <% else -%>
-statsd_forward_port: <%= @_statsd_forward_port %>
+statsd_forward_port: <%= @statsd_forward_port %>
 <% end -%>
 
 # ========================================================================== #
@@ -277,10 +277,10 @@ log_to_syslog: <%= @log_to_syslog ? "yes" : "no" %>
 syslog_host: <%= @syslog_host  %>
 <% end -%>
 
-<% if @_syslog_port.empty? -%>
+<% if @syslog_port.to_s.empty? -%>
 # syslog_port:
 <% else -%>
-syslog_port: <%= @_syslog_port  %>
+syslog_port: <%= @syslog_port  %>
 <% end -%>
 
 

templates/datadog_header.conf.erb

@@ -11,7 +11,7 @@ dd_url: <%= @_dd_url %>
 <% else -%>
 proxy_host: <%= @proxy_host %>
 <% end -%>
-<% if !defined?(@proxy_port) || "#{@proxy_port}".empty? -%>
+<% if !defined?(@proxy_port) || @proxy_port.to_s.empty? -%>
 # proxy_port:
 <% else -%>
 proxy_port: <%= @proxy_port %>