Fixed #809, #810, #811: pass through, and preserve comments, indent config, and fix conflicting attrs

Author: grtjn

deploy/lib/server_config.rb

@@ -62,7 +62,6 @@ def initialize(options)
 
     @properties = options[:properties]
     @environment = @properties["environment"]
-    @config_file = @properties["ml.config.file"]
 
     @properties["ml.server"] = @properties["ml.#{@environment}-server"] unless @properties["ml.server"]
     if (@properties["ml.server"] == nil)
@@ -763,15 +762,23 @@ def reindex_db(target_db)
 
   def config
     setup = File.read ServerConfig.expand_path("#{@@path}/lib/xquery/setup.xqy")
-    r = execute_query %Q{
+    query = %Q{
       #{setup}
       try {
-        setup:rewrite-config(#{get_config})
+        xdmp:quote(
+          setup:rewrite-config(#{get_config}, (), fn:true()),
+          <options xmlns="xdmp:quote">
+            <indent>yes</indent>
+            <indent-untyped>yes</indent-untyped>
+          </options>
+        )
       } catch($ex) {
         xdmp:log($ex),
         fn:concat($ex/err:format-string/text(), '&#10;See MarkLogic Server error log for more details.')
       }
     }
+    logger.debug query
+    r = execute_query query
     logger.debug "code: #{r.code.to_i}"
 
     r.body = parse_body(r.body)
@@ -2599,8 +2606,14 @@ def execute_query_8(query, properties = {})
       end
     end
 
+    #logger.debug headers
+    #logger.debug params
+
     r = go "#{@protocol}://#{@hostname}:#{@qconsole_port}/v1/eval", "post", headers, params
 
+    #logger.debug r.code
+    #logger.debug r.body
+
     raise ExitException.new(JSON.pretty_generate(JSON.parse(r.body))) if r.body.match(/\{"error"/)
 
     r
@@ -3022,7 +3035,7 @@ def build_config(config_files)
     config.gsub!("{", "{{")
     config.gsub!("}", "}}")
 
-      configs << config
+      configs << "<file>" + config + "</file>/node()"
     end
 
     %Q{(#{configs.join(", ")})}

deploy/lib/xquery/setup.xqy

@@ -433,19 +433,46 @@ declare function setup:suppress-comments($nodes) {
     default return $node
 };
 
+declare function setup:unique-attributes($attrs) {
+  let $result := map:map()
+  let $_ :=
+    for $attr in $attrs
+    let $attr-name := fn:name($attr)
+    let $existing-attr := map:get($result, $attr-name)
+    return
+      if (fn:exists($existing-attr) and fn:string($existing-attr) != fn:string($attr)) then
+        fn:error(
+          xs:QName("ATTR-CONFLICT"),
+          fn:concat("The config-files contain multiple attributes ", $attr-name, " with different values: " || fn:string($existing-attr) || " vs " || fn:string($attr))
+        )
+      else
+        map:put($result, name($attr), $attr)
+  return map:keys($result) ! map:get($result, .)
+};
+
 (: for backwards-compatibility :)
-declare function setup:rewrite-config($import-configs as element(configuration)+) as element(configuration)
+declare function setup:rewrite-config($import-configs as node()+) as element(configuration)
 {
   setup:rewrite-config($import-configs, ())
 };
 
-declare function setup:rewrite-config($import-configs as element(configuration)+, $silent as xs:boolean?) as element(configuration)
+declare function setup:rewrite-config($import-configs as node()+, $silent as xs:boolean?) as element(configuration)
+{
+  setup:rewrite-config($import-configs, $silent, ())
+};
+
+declare function setup:rewrite-config($import-configs as node()+, $silent as xs:boolean?, $keep-comments as xs:boolean?) as element(configuration)
 {
   let $config :=
     element { fn:node-name($import-configs[1]) } {
-      $import-configs/@*,
+      setup:unique-attributes($import-configs/@*),
 
-      <groups xmlns="http://marklogic.com/xdmp/group" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://marklogic.com/xdmp/group group.xsd">{
+      (: capture comments before gr:groups, and its older counterparts :)
+      $import-configs/(
+        gr:groups, gr:http-servers, gr:xdbc-servers, gr:odbc-servers, gr:task-server
+      )/preceding-sibling::node(),
+
+      <groups xmlns="http://marklogic.com/xdmp/group">{
         let $default-group := ($import-configs/@default-group, "Default")[1]
         for $group in fn:distinct-values(
           ($import-configs/gr:groups/gr:group/gr:group-name, $import-configs/(gr:http-servers/gr:http-server, gr:xdbc-servers/gr:xdbc-server,
@@ -460,8 +487,10 @@ declare function setup:rewrite-config($import-configs as element(configuration)+
         where fn:exists($servers | $databases | $group-config)
         return
           <group>
+            { setup:unique-attributes($group-config/@*) }
             <group-name>{$group}</group-name>
             {
+              $group-config/(node() except (gr:group-name, gr:http-servers, gr:xdbc-servers, gr:odbc-servers, gr:task-server)),
               if ($http-servers) then
                 <http-servers>{$http-servers}</http-servers>
               else (),
@@ -473,13 +502,20 @@ declare function setup:rewrite-config($import-configs as element(configuration)+
               else (),
               if ($task-server) then
                 $task-server
-              else (),
-              $group-config/(node() except gr:group-name)
+              else ()
             }
           </group>
       }</groups>,
 
-      $import-configs/(node() except (gr:groups, gr:http-servers, gr:xdbc-servers, gr:odbc-servers, gr:task-server))
+      (: capture anything following gr:groups, and its older counterparts :)
+      $import-configs/(
+        gr:groups, gr:http-servers, gr:xdbc-servers, gr:odbc-servers, gr:task-server
+      )/following-sibling::node(),
+
+      (: other fragments with configuration as root :)
+      $import-configs[fn:empty((
+        gr:groups, gr:http-servers, gr:xdbc-servers, gr:odbc-servers, gr:task-server
+      ))]/node()
     }
 
   (: Check config on group consistency! :)
@@ -492,10 +528,11 @@ declare function setup:rewrite-config($import-configs as element(configuration)+
       return
         fn:error(
           xs:QName("NO_HOSTS_IN_GROUP"),
-          fn:concat("No hosts assigned to group ", $group, ", needed for app servers and forests!"))
+          fn:concat("No hosts assigned to group ", $group, ", needed for app servers and forests!")
+        )
 
   (: all good :)
-  return setup:suppress-comments($config)
+  return if ($keep-comments) then $config else setup:suppress-comments($config)
 };
 
 
@@ -544,7 +581,7 @@ declare private function setup:parse-options( $options as xs:string ) as map:map
   return $optionsMap
 };
 
-declare function setup:do-setup($import-config as element(configuration)+, $options as xs:string) as item()*
+declare function setup:do-setup($import-config as node()+, $options as xs:string) as item()*
 {
   let $optionsMap := setup:parse-options( $options )
   let $do-internals := map:contains( $optionsMap, "internals" )
@@ -611,7 +648,7 @@ declare function setup:do-setup($import-config as element(configuration)+, $opti
   }
 };
 
-declare function setup:do-wipe($import-config as element(configuration)+, $options as xs:string) as item()*
+declare function setup:do-wipe($import-config as node()+, $options as xs:string) as item()*
 {
   let $options := if(fn:empty($options) or $options eq "") then ("all") else fn:tokenize($options, ",")
 
@@ -1038,7 +1075,7 @@ declare function setup:do-wipe($import-config as element(configuration)+, $optio
   Attempt to remove replicas that are to be decommissioned due to scaling out of the cluster.
   Replicas are only removed after their new replacements have gone to sync replication.
 :)
-declare function setup:do-clean-replicas($import-config as element(configuration)+, $options as xs:string) as item()*
+declare function setup:do-clean-replicas($import-config as node()+, $options as xs:string) as item()*
 {
   let $optionsMap := setup:parse-options( $options )
   let $do-internals := map:contains( $optionsMap, "internals" )
@@ -1119,7 +1156,7 @@ declare function setup:do-clean-replicas($import-config as element(configuration
 (:
   Cleanup scale-out replica state files.
 :)
-declare function setup:do-clean-replicas-state($import-config as element(configuration)+, $options as xs:string) as item()*
+declare function setup:do-clean-replicas-state($import-config as node()+, $options as xs:string) as item()*
 {
   let $optionsMap := setup:parse-options( $options )
   let $do-internals := map:contains( $optionsMap, "internals" )