Merge pull request #1224 from DavidS/allow_no_docroot

(MODULES-2120) Allow empty docroot
xbezdick · Oct 13, 2015 · 6124598 · 6124598
2 parents 3a1a4e4 + b63aac2
commit 6124598
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -133,6 +133,7 @@
 [`logroot`]: #logroot
 [Log security]: http://httpd.apache.org/docs/current/logs.html#security
 
+[`manage_docroot`]: #manage_docroot
 [`manage_user`]: #manage_user
 [`manage_group`]: #manage_group
 [`MaxConnectionsPerChild`]: https://httpd.apache.org/docs/current/mod/mpm_common.html#maxconnectionsperchild
@@ -1886,6 +1887,8 @@ Sets the list of resources to look for when a client requests an index of the di
 
 **Required**. Sets the [`DocumentRoot`][] location, from which Apache serves files.
 
+If `docroot` and [`manage_docroot`][] are both set to `false`, no [`DocumentRoot`][] will be set and the accompanying `<Directory /path/to/directory>` block will not be created.
+
 ##### `docroot_group`
 
 Sets group access to the [`docroot`][] directory. Defaults to 'root'.

diff --git a/manifests/vhost.pp b/manifests/vhost.pp
@@ -227,6 +227,12 @@
   if $limit_request_field_size {
     validate_integer($limit_request_field_size)
   }
+
+  # Validate the docroot as a string if:
+  # - $manage_docroot is true
+  if $manage_docroot {
+    validate_string($docroot)
+  }
   # Input validation ends
 
   if $ssl and $ensure == 'present' {
@@ -271,7 +277,7 @@
 
   # This ensures that the docroot exists
   # But enables it to be specified across multiple vhost resources
-  if ! defined(File[$docroot]) and $manage_docroot {
+  if $manage_docroot and $docroot and ! defined(File[$docroot]) {
     file { $docroot:
       ensure  => directory,
       owner   => $docroot_owner,
@@ -443,7 +449,7 @@
       fail("Apache::Vhost[${name}]: 'directories' must be either a Hash or an Array of Hashes")
     }
     $_directories = $directories
-  } else {
+  } elsif $docroot {
     $_directory = {
       provider       => 'directory',
       path           => $docroot,
@@ -518,10 +524,12 @@
   # Template uses:
   # - $virtual_docroot
   # - $docroot
-  concat::fragment { "${name}-docroot":
-    target  => "${priority_real}${filename}.conf",
-    order   => 10,
-    content => template('apache/vhost/_docroot.erb'),
+  if $docroot {
+    concat::fragment { "${name}-docroot":
+      target  => "${priority_real}${filename}.conf",
+      order   => 10,
+      content => template('apache/vhost/_docroot.erb'),
+    }
   }
 
   # Template uses:

diff --git a/spec/defines/vhost_spec.rb b/spec/defines/vhost_spec.rb
@@ -612,6 +612,16 @@
       it { is_expected.to_not contain_concat__fragment('rspec.example.com-limits') }
       it { is_expected.to contain_concat__fragment('rspec.example.com-file_footer') }
     end
+    context 'when not setting nor managing the docroot' do
+      let :params do
+        {
+          'docroot'                     => false,
+          'manage_docroot'              => false,
+        }
+      end
+      it { is_expected.to compile }
+      it { is_expected.not_to contain_concat__fragment('rspec.example.com-docroot') }
+    end
   end
   describe 'access logs' do
     let :facts do

diff --git a/templates/vhost/_docroot.erb b/templates/vhost/_docroot.erb
@@ -2,6 +2,6 @@
   ## Vhost docroot
 <% if @virtual_docroot -%>
   VirtualDocumentRoot "<%= @virtual_docroot %>"
-<% else -%>
+<% elsif @docroot -%>
   DocumentRoot "<%= @docroot %>"
 <% end -%>