Allow adding and removing attributes in Context (#502) (#503)

* Allow adding and removing attributes  in Context (#502)

* Fix white space lint errors

* Correct indentation

* Update commons-daemon-native version to match Tomcat bundled version

Author: uoe-pjackson

manifests/config/context.pp

@@ -2,12 +2,18 @@
 #
 # @param catalina_base
 #   Specifies the root of the Tomcat installation.
+# @param additional_attributes
+#   Specifies any additional attributes to add to the Context. Should be a hash of the format 'attribute' => 'value'. Optional
+# @param attributes_to_remove
+#   Specifies an array of attributes to remove from the element. Valid options: an array of strings. `[]`.
 # @param show_diff
 #   Specifies display differences when augeas changes files, defaulting to true. Valid options: true or false.
 #
 define tomcat::config::context (
-  Optional[Stdlib::Absolutepath] $catalina_base  = undef,
-  Boolean                        $show_diff      = true,
+  Optional[Stdlib::Absolutepath] $catalina_base          = undef,
+  Hash                           $additional_attributes  = {},
+  Array                          $attributes_to_remove   = [],
+  Boolean                        $show_diff              = true,
 ) {
   include tomcat
   $_catalina_base = pick($catalina_base, $tomcat::catalina_home)
@@ -17,9 +23,35 @@
     fail('Server configurations require Augeas >= 1.0.0')
   }
 
+  $base_path = 'Context'
+
+  if ! empty($additional_attributes) {
+    $set_additional_attributes = suffix(prefix(join_keys_to_values($additional_attributes, " '"), "set ${base_path}/#attribute/"), "'")
+
+    # Extra augeas to add atttibutes if there are currently no attrributes in <Context> element
+    augeas { "context-add_attribute_${_catalina_base}":
+      incl    => "${catalina_base}/conf/context.xml",
+      lens    => 'Xml.lns',
+      context => "/files/${catalina_base}/conf/context.xml",
+      changes => ['ins #attribute before Context/#text[1]'] + $set_additional_attributes,
+      onlyif  => 'match Context/#attribute size == 0',
+    }
+  } else {
+    $set_additional_attributes = undef
+  }
+  if ! empty(any2array($attributes_to_remove)) {
+    $rm_attributes_to_remove = prefix(any2array($attributes_to_remove), "rm ${base_path}/#attribute/")
+  } else {
+    $rm_attributes_to_remove = undef
+  }
+
   $_watched_resource = 'set Context/WatchedResource/#text "WEB-INF/web.xml"'
 
-  $changes = delete_undef_values([$_watched_resource])
+  $changes = delete_undef_values(flatten([
+        $_watched_resource,
+        $set_additional_attributes,
+        $rm_attributes_to_remove,
+  ]))
 
   if ! empty($changes) {
     augeas { "context-${_catalina_base}":

spec/defines/config/context_spec.rb

@@ -32,6 +32,32 @@
     }
   end
 
+  context 'Add Attribute' do
+    let :params do
+      {
+        catalina_base: '/opt/apache-tomcat/test',
+        additional_attributes: {
+          'crossContext' => 'true',
+        },
+        attributes_to_remove: [
+          'foobar',
+        ],
+      }
+    end
+
+    changes = [
+      'set Context/WatchedResource/#text "WEB-INF/web.xml"',
+      'set Context/#attribute/crossContext \'true\'',
+      'rm Context/#attribute/foobar',
+    ]
+    it {
+      is_expected.to contain_augeas('context-/opt/apache-tomcat/test').with(
+        'lens' => 'Xml.lns',
+        'incl' => '/opt/apache-tomcat/test/conf/context.xml',
+        'changes' => changes,
+      )
+    }
+  end
   describe 'failing tests' do
     context 'old augeas' do
       let :facts do