Allow to set log_format's "escape" parameter

While here, rely on #inspect to generate espaped quoted string.
voxpupuli · Aug 24, 2022 · c8273df · c8273df
1 parent 6d59c0e
commit c8273df
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 6 deletions.
diff --git a/manifests/init.pp b/manifests/init.pp
@@ -122,7 +122,7 @@
   Enum['on', 'off'] $http_tcp_nopush                         = 'off',
   $keepalive_timeout                                         = '65s',
   $keepalive_requests                                        = '100',
-  $log_format                                                = {},
+  Hash[String[1], Nginx::LogFormat] $log_format              = {},
   Boolean $mail                                              = false,
   Variant[String, Boolean] $mime_types_path                  = 'mime.types',
   Boolean $stream                                            = false,

diff --git a/spec/classes/nginx_spec.rb b/spec/classes/nginx_spec.rb
@@ -554,10 +554,10 @@
                   },
                 },
                 match: [
-                  '  log_format format1 \'FORMAT1\';',
-                  '  log_format format2 \'FORMAT2\';',
-                  '  log_format format3 \'FORMAT3\';',
-                  '  log_format format4 \'escape=json\' \'{"response": $status, "verb": "$request_method"}\';'
+                  '  log_format format1 "FORMAT1";',
+                  '  log_format format2 "FORMAT2";',
+                  '  log_format format3 "FORMAT3";',
+                  '  log_format format4 escape=json "{\\"response\\": $status, \\"verb\\": \\"$request_method\\"}";'
                 ]
               },
               {

diff --git a/templates/conf.d/nginx.conf.erb b/templates/conf.d/nginx.conf.erb
@@ -74,7 +74,11 @@ http {
   default_type  application/octet-stream;
 <% if @log_format -%>
 <% @log_format.sort_by{|k,v| k}.each do |key,value| -%>
-  log_format <%= key %> '<%= value %>';
+  <%- if value.is_a?(Hash) -%>
+  log_format <%= key %> <%= "escape=#{value['escape']} " if value['escape'] %><%= value['format'].inspect %>;
+  <%- else -%>
+  log_format <%= key %> <%= value.inspect %>;
+  <%- end -%>
 <% end -%>
 <% end -%>
 

diff --git a/types/logformat.pp b/types/logformat.pp
@@ -0,0 +1,7 @@
+type Nginx::LogFormat = Variant[
+  String[1],
+  Struct[{
+    Optional[escape] => Enum['default', 'json', 'none'],
+    format           => String[1],
+  }],
+]