Merge pull request #2195 from yakatz/bug/docroot_with_vhostalias

Allow `docroot` with `mod_vhost_alias` `virtual_docroot`

Author: david22swan

REFERENCE.md

@@ -7756,6 +7756,7 @@ The following parameters are available in the `apache::vhost` defined type:
 * [`suphp_engine`](#suphp_engine)
 * [`vhost_name`](#vhost_name)
 * [`virtual_docroot`](#virtual_docroot)
+* [`virtual_use_default_docroot`](#virtual_use_default_docroot)
 * [`wsgi_daemon_process`](#wsgi_daemon_process)
 * [`wsgi_daemon_process_options`](#wsgi_daemon_process_options)
 * [`wsgi_application_group`](#wsgi_application_group)
@@ -9957,6 +9958,8 @@ Data type: `Any`
 
 Sets up a virtual host with a wildcard alias subdomain mapped to a directory with the
 same name. For example, `http://example.com` would map to `/var/www/example.com`.
+Note that the `DocumentRoot` directive will not be present even though there is a value
+set for `docroot` in the manifest. See [`virtual_use_default_docroot`](#virtual_use_default_docroot) to change this behavior.
 ``` puppet
 apache::vhost { 'subdomain.loc':
   vhost_name      => '*',
@@ -9969,6 +9972,25 @@ apache::vhost { 'subdomain.loc':
 
 Default value: ``false``
 
+##### <a name="virtual_use_default_docroot"></a>`virtual_use_default_docroot`
+
+Data type: `Any`
+
+By default, when using `virtual_docroot`, the value of `docroot` is ignored. Setting this
+to `true` will mean both directives will be added to the configuration.
+``` puppet
+apache::vhost { 'subdomain.loc':
+  vhost_name                  => '*',
+  port                        => '80',
+  virtual_docroot             => '/var/www/%-2+',
+  docroot                     => '/var/www',
+  virtual_use_default_docroot => true,
+  serveraliases               => ['*.loc',],
+}
+```
+
+Default value: ``false``
+
 ##### <a name="wsgi_daemon_process"></a>`wsgi_daemon_process`
 
 Data type: `Optional[Variant[String,Hash]]`

manifests/vhost.pp

@@ -1221,6 +1221,8 @@
 # @param virtual_docroot
 #   Sets up a virtual host with a wildcard alias subdomain mapped to a directory with the 
 #   same name. For example, `http://example.com` would map to `/var/www/example.com`.
+#   Note that the `DocumentRoot` directive will not be present even though there is a value
+#   set for `docroot` in the manifest. See [`virtual_use_default_docroot`](#virtual_use_default_docroot) to change this behavior.
 #   ``` puppet
 #   apache::vhost { 'subdomain.loc':
 #     vhost_name      => '*',
@@ -1231,6 +1233,20 @@
 #   }
 #   ```
 # 
+# @param virtual_use_default_docroot
+#   By default, when using `virtual_docroot`, the value of `docroot` is ignored. Setting this
+#   to `true` will mean both directives will be added to the configuration.
+#   ``` puppet
+#   apache::vhost { 'subdomain.loc':
+#     vhost_name                  => '*',
+#     port                        => '80',
+#     virtual_docroot             => '/var/www/%-2+',
+#     docroot                     => '/var/www',
+#     virtual_use_default_docroot => true,
+#     serveraliases               => ['*.loc',],
+#   }
+#   ```
+#
 # @param wsgi_daemon_process
 #   Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside
 #   wsgi_daemon_process_options, wsgi_process_group, 
@@ -1746,6 +1762,7 @@
   Variant[Boolean,String] $docroot,
   $manage_docroot                                                                   = true,
   $virtual_docroot                                                                  = false,
+  $virtual_use_default_docroot                                                      = false,
   $port                                                                             = undef,
   $ip                                                                               = undef,
   Boolean $ip_based                                                                 = false,
@@ -2429,6 +2446,7 @@
 
   # Template uses:
   # - $virtual_docroot
+  # - $virtual_use_default_docroot
   # - $docroot
   if $docroot {
     concat::fragment { "${name}-docroot":

spec/defines/vhost_spec.rb

@@ -58,6 +58,7 @@
               'docroot'                     => '/var/www/foo',
               'manage_docroot'              => false,
               'virtual_docroot'             => true,
+              'virtual_use_default_docroot' => false,
               'port'                        => '8080',
               'ip'                          => '127.0.0.1',
               'ip_based'                    => true,
@@ -1747,6 +1748,48 @@
           it { is_expected.not_to contain_concat__fragment('NameVirtualHost *:80') }
         end
 
+        context 'vhost with backwards compatible virtual_docroot' do
+          let :params do
+            {
+              'docroot'         => '/var/www/html',
+              'virtual_docroot' => '/var/www/sites/%0',
+            }
+          end
+
+          it { is_expected.to compile }
+          it {
+            is_expected.to contain_concat__fragment('rspec.example.com-docroot').with(
+              content: %r{^\s+VirtualDocumentRoot "/var/www/sites/%0"$},
+            )
+          }
+          it {
+            is_expected.not_to contain_concat__fragment('rspec.example.com-docroot').with(
+              content: %r{^\s+DocumentRoot "/var/www/html"$},
+            )
+          }
+        end
+        context 'vhost with virtual_docroot and docroot' do
+          let :params do
+            {
+              'docroot'                     => '/var/www/html',
+              'virtual_use_default_docroot' => true,
+              'virtual_docroot'             => '/var/www/sites/%0',
+            }
+          end
+
+          it { is_expected.to compile }
+          it {
+            is_expected.to contain_concat__fragment('rspec.example.com-docroot').with(
+              content: %r{^\s+VirtualDocumentRoot "/var/www/sites/%0"$},
+            )
+          }
+          it {
+            is_expected.to contain_concat__fragment('rspec.example.com-docroot').with(
+              content: %r{^\s+DocumentRoot "/var/www/html"$},
+            )
+          }
+        end
+
         context 'modsec_audit_log' do
           let :params do
             {

templates/vhost/_docroot.erb

@@ -2,6 +2,7 @@
   ## Vhost docroot
 <% if @virtual_docroot -%>
   VirtualDocumentRoot "<%= @virtual_docroot %>"
-<% elsif @docroot -%>
+<% end -%>
+<% if @docroot and ((not @virtual_docroot) or @virtual_use_default_docroot) -%>
   DocumentRoot "<%= @docroot %>"
 <% end -%>