Merge pull request puppetlabs#1716 from gitkent/feature/disk_cache_ignore

added option to include CacheIgnoreHeaders for disk_cache module

Author: david22swan

README.md

@@ -1688,6 +1688,14 @@ class {'::apache::mod::disk_cache':
 }
 ```
 
+To specify cache ignore headers, pass a string to the `cache_ignore_headers` parameter.
+
+``` puppet
+class {'::apache::mod::disk_cache':
+  cache_ignore_headers => "Set-Cookie",
+}
+```
+
 ##### Class: `apache::mod::diskio`
 
 Installs and configures [`mod_diskio`][].

manifests/mod/disk_cache.pp

@@ -1,5 +1,6 @@
 class apache::mod::disk_cache (
-  $cache_root = undef,
+  $cache_root           = undef,
+  $cache_ignore_headers = undef,
 ) {
   include ::apache
   if $cache_root {

spec/classes/mod/disk_cache_spec.rb

@@ -15,6 +15,13 @@
         :is_pe                  => false,
       }
     end
+
+    let(:params) {
+      {
+        :cache_ignore_headers   => "Set-Cookie",
+      }
+    }
+
     context "with Apache version < 2.4" do
       let :pre_condition do
         'class{ "apache":
@@ -26,7 +33,7 @@
       it { should compile }
       it { should contain_class('apache::mod::disk_cache') }
       it { is_expected.to contain_apache__mod("disk_cache") }
-      it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/apache2\/mod_disk_cache\"\nCacheDirLevels 2\nCacheDirLength 1/) }
+      it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/apache2\/mod_disk_cache\"\nCacheDirLevels 2\nCacheDirLength 1\nCacheIgnoreHeaders Set-Cookie/) }
     end
     context "with Apache version >= 2.4" do
       let :pre_condition do
@@ -40,7 +47,7 @@
       it { should contain_class('apache::mod::disk_cache') }
       it { should contain_class('apache::mod::cache').that_comes_before('Class[Apache::Mod::Disk_cache]')  }
       it { is_expected.to contain_apache__mod("cache_disk") }
-      it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/apache2\/mod_cache_disk\"\nCacheDirLevels 2\nCacheDirLength 1/) }
+      it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/apache2\/mod_cache_disk\"\nCacheDirLevels 2\nCacheDirLength 1\nCacheIgnoreHeaders Set-Cookie/) }
     end
   end
 
@@ -57,6 +64,13 @@
         :is_pe                  => false,
       }
     end
+
+    let(:params) {
+      {
+        :cache_ignore_headers   => "Set-Cookie",
+      }
+    }
+
     context "with Apache version < 2.4" do
       let :pre_condition do
         'class{ "apache":
@@ -66,7 +80,7 @@
          }'
       end
       it { is_expected.to contain_apache__mod("disk_cache") }
-      it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/mod_proxy\"\nCacheDirLevels 2\nCacheDirLength 1/) }
+      it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/mod_proxy\"\nCacheDirLevels 2\nCacheDirLength 1\nCacheIgnoreHeaders Set-Cookie/) }
     end
     context "with Apache version >= 2.4" do
       let :pre_condition do
@@ -77,7 +91,7 @@
          }'
       end
       it { is_expected.to contain_apache__mod("cache_disk") }
-      it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/httpd\/proxy\"\nCacheDirLevels 2\nCacheDirLength 1/) }
+      it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/httpd\/proxy\"\nCacheDirLevels 2\nCacheDirLength 1\nCacheIgnoreHeaders Set-Cookie/) }
     end
   end
   context "on a FreeBSD OS" do
@@ -93,6 +107,13 @@
         :is_pe                  => false,
       }
     end
+
+    let(:params) {
+      {
+        :cache_ignore_headers   => "Set-Cookie",
+      }
+    }
+
     context "with Apache version < 2.4" do
       let :pre_condition do
         'class{ "apache":
@@ -105,7 +126,7 @@
       it { should contain_class('apache::mod::disk_cache') }
       it { should contain_class('apache::mod::cache').that_comes_before('Class[Apache::Mod::Disk_cache]')  }
       it { is_expected.to contain_apache__mod("disk_cache") }
-      it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/mod_disk_cache\"\nCacheDirLevels 2\nCacheDirLength 1/) }
+      it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/mod_disk_cache\"\nCacheDirLevels 2\nCacheDirLength 1\nCacheIgnoreHeaders Set-Cookie/) }
     end
     context "with Apache version >= 2.4" do
       let :pre_condition do
@@ -119,7 +140,7 @@
       it { should contain_class('apache::mod::disk_cache') }
       it { should contain_class('apache::mod::cache').that_comes_before('Class[Apache::Mod::Disk_cache]')  }
       it { is_expected.to contain_apache__mod("cache_disk") }
-      it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/mod_cache_disk\"\nCacheDirLevels 2\nCacheDirLength 1/) }
+      it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/mod_cache_disk\"\nCacheDirLevels 2\nCacheDirLength 1\nCacheIgnoreHeaders Set-Cookie/) }
     end
   end
 end

templates/mod/disk_cache.conf.erb

@@ -2,3 +2,6 @@ CacheEnable disk /
 CacheRoot "<%= @_cache_root %>"
 CacheDirLevels 2
 CacheDirLength 1
+<% if @cache_ignore_headers -%>
+CacheIgnoreHeaders <%= @cache_ignore_headers -%>
+<% end -%>