Merge pull request #491 from tuxmea/context_resources

Allow usage of Context/Resources

Author: david22swan

manifests/config/context/resources.pp

@@ -0,0 +1,77 @@
+# @summary Configure Resources elements in $CATALINA_BASE/conf/context.xml
+#
+# @param ensure
+#   Specifies whether you are trying to add or remove the Resources element.
+# @param resources_name
+#   The name of the Resources to be created, relative to the `java:comp/env` context. `$name`.
+# @param name
+#   `$resources_name`
+# @param resources_type
+#   The fully qualified Java class name expected by the web application when it performs a lookup for this resources. Required to create the resource.
+# @param catalina_base
+#   Specifies the root of the Tomcat installation.
+# @param additional_attributes
+#   Specifies any additional attributes to add to the Valve. 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::resources (
+  Enum['present','absent'] $ensure = 'present',
+  $resources_name                  = $name,
+  $resources_type                  = undef,
+  $catalina_base                   = $::tomcat::catalina_home,
+  Hash $additional_attributes      = {},
+  Array $attributes_to_remove      = [],
+  Boolean $show_diff               = true,
+) {
+  if versioncmp($::augeasversion, '1.0.0') < 0 {
+    fail('Server configurations require Augeas >= 1.0.0')
+  }
+
+  if $resources_name {
+    $_resources_name = $resources_name
+  } else {
+    $_resources_name = $name
+  }
+
+  $base_path = "Context/Resources[#attribute/name='${_resources_name}']"
+
+  if $ensure == 'absent' {
+    $changes = "rm ${base_path}"
+  } else {
+    # (MODULES-3353) does this need to be quoted?
+    $set_name = "set ${base_path}/#attribute/name ${_resources_name}"
+    if $resources_type {
+      $set_type = "set ${base_path}/#attribute/type ${resources_type}"
+    } else {
+      $set_type = undef
+    }
+
+    if ! empty($additional_attributes) {
+      $set_additional_attributes = suffix(prefix(join_keys_to_values($additional_attributes, " '"), "set ${base_path}/#attribute/"), "'")
+    } 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
+    }
+
+    $changes = delete_undef_values(flatten([
+          $set_name,
+          $set_type,
+          $set_additional_attributes,
+          $rm_attributes_to_remove,
+    ]))
+  }
+
+  augeas { "context-${catalina_base}-resources-${name}":
+    lens      => 'Xml.lns',
+    incl      => "${catalina_base}/conf/context.xml",
+    changes   => $changes,
+    show_diff => $show_diff,
+  }
+}

spec/defines/config/context/resources_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'tomcat::config::context::resources', type: :define do
+  let :pre_condition do
+    'class {"tomcat": }'
+  end
+  let :facts do
+    {
+      osfamily: 'Debian',
+      augeasversion: '1.0.0',
+    }
+  end
+  let :title do
+    'jdbc'
+  end
+
+  context 'Add Resources' do
+    let :params do
+      {
+        catalina_base: '/opt/apache-tomcat/test',
+        resources_type: 'net.sourceforge.jtds.jdbcx.JtdsDataSource',
+        additional_attributes: {
+          'cachingAllowed'  => 'true',
+          'cacheMaxSize'    => '100000',
+        },
+        attributes_to_remove: [
+          'foobar',
+        ],
+      }
+    end
+
+    changes = [
+      'set Context/Resources[#attribute/name=\'jdbc\']/#attribute/name jdbc',
+      'set Context/Resources[#attribute/name=\'jdbc\']/#attribute/type net.sourceforge.jtds.jdbcx.JtdsDataSource',
+      'set Context/Resources[#attribute/name=\'jdbc\']/#attribute/cachingAllowed \'true\'',
+      'set Context/Resources[#attribute/name=\'jdbc\']/#attribute/cacheMaxSize \'100000\'',
+      'rm Context/Resources[#attribute/name=\'jdbc\']/#attribute/foobar',
+    ]
+    it {
+      is_expected.to contain_augeas('context-/opt/apache-tomcat/test-resources-jdbc').with(
+        'lens' => 'Xml.lns',
+        'incl' => '/opt/apache-tomcat/test/conf/context.xml',
+        'changes' => changes,
+      )
+    }
+  end
+  context 'Remove Resources' do
+    let :params do
+      {
+        catalina_base: '/opt/apache-tomcat/test',
+        ensure: 'absent',
+      }
+    end
+
+    it {
+      is_expected.to contain_augeas('context-/opt/apache-tomcat/test-resources-jdbc').with(
+        'lens' => 'Xml.lns',
+        'incl' => '/opt/apache-tomcat/test/conf/context.xml',
+        'changes' => ['rm Context/Resources[#attribute/name=\'jdbc\']'],
+      )
+    }
+  end
+end