Skip to content

Clean up includes and templates in vhost.pp #2254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Jun 28, 2022
Merged

Clean up includes and templates in vhost.pp #2254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
d44b683
Correct parameter alignment
ekohl Jun 22, 2022
09727b3
Localize apache::mod::alias inclusion in vhost.pp
ekohl Jun 22, 2022
ff409d4
Localize apache::mod::proxy inclusion in vhost.pp
ekohl Jun 22, 2022
0df379d
Localize apache::mod::fastcgi inclusion in vhost.pp
ekohl Jun 22, 2022
0be7b8d
Localize apache::mod::vhost_alias inclusion in vhost.pp
ekohl Jun 22, 2022
770ce8b
Localize apache::mod::wsgi inclusion in vhost.pp
ekohl Jun 22, 2022
3013ebb
Localize apache::mod::suexec inclusion in vhost.pp
ekohl Jun 22, 2022
bc0891d
Localize apache::mod::passenger inclusion in vhost.pp
ekohl Jun 22, 2022
e9e39d7
Localize apache::mod::auth_kerb inclusion in vhost.pp
ekohl Jun 22, 2022
fd969b8
Localize apache::mod::auth_openidc inclusion in vhost.pp
ekohl Jun 22, 2022
b19a09e
Localize apache::mod::ssl inclusion in vhost.pp
ekohl Jun 22, 2022
3b6c262
Clean up inclusion of mod::env and mod::setenvif
ekohl Jun 22, 2022
2817713
Simplify scriptalias template
ekohl Jun 22, 2022
e10459d
Simplify apache::vhost::serveraliases logic
ekohl Jun 22, 2022
f496d76
Document uses of $mdomain
ekohl Jun 22, 2022
3262f23
Only include modules if ensure is present
ekohl Jun 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 52 additions & 90 deletions manifests/vhost.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1847,7 +1847,7 @@
Boolean $proxy_preserve_host = false,
Optional[Variant[String,Boolean]] $proxy_add_headers = undef,
Boolean $proxy_error_override = false,
Variant[String,Array[String]] $redirect_source = '/',
Variant[String,Array[String]] $redirect_source = '/',
Optional[Variant[Array[String],String]] $redirect_dest = undef,
Optional[Variant[Array[String],String]] $redirect_status = undef,
Optional[Variant[Array[String],String]] $redirectmatch_status = undef,
Expand Down Expand Up @@ -2013,12 +2013,6 @@

# Input validation ends

if $ssl and $ensure == 'present' {
include apache::mod::ssl
# Required for the AddType lines.
include apache::mod::mime
}

if $ssl_honorcipherorder =~ Boolean or $ssl_honorcipherorder == undef {
$_ssl_honorcipherorder = $ssl_honorcipherorder
} else {
Expand All @@ -2031,30 +2025,6 @@
}
}

if $auth_kerb and $ensure == 'present' {
include apache::mod::auth_kerb
}

if $auth_oidc and $ensure == 'present' {
include apache::mod::auth_openidc
}

if $virtual_docroot {
include apache::mod::vhost_alias
}

if $wsgi_application_group or $wsgi_daemon_process or ($wsgi_import_script and $wsgi_import_script_options) or $wsgi_process_group or ($wsgi_script_aliases and ! empty($wsgi_script_aliases)) or $wsgi_pass_authorization {
include apache::mod::wsgi
}

if $suexec_user_group {
include apache::mod::suexec
}

if $passenger_enabled != undef or $passenger_start_timeout != undef or $passenger_ruby != undef or $passenger_python != undef or $passenger_nodejs != undef or $passenger_meteor_app_settings != undef or $passenger_app_env != undef or $passenger_app_root != undef or $passenger_app_group_name != undef or $passenger_app_start_command != undef or $passenger_app_type != undef or $passenger_startup_file != undef or $passenger_restart_dir != undef or $passenger_spawn_method != undef or $passenger_load_shell_envvars != undef or $passenger_preload_bundler != undef or $passenger_rolling_restarts != undef or $passenger_resist_deployment_errors != undef or $passenger_min_instances != undef or $passenger_max_instances != undef or $passenger_max_preloader_idle_time != undef or $passenger_force_max_concurrent_requests_per_process != undef or $passenger_concurrency_model != undef or $passenger_thread_count != undef or $passenger_high_performance != undef or $passenger_max_request_queue_size != undef or $passenger_max_request_queue_time != undef or $passenger_user != undef or $passenger_group != undef or $passenger_friendly_error_pages != undef or $passenger_buffer_upload != undef or $passenger_buffer_response != undef or $passenger_allow_encoded_slashes != undef or $passenger_lve_min_uid != undef or $passenger_base_uri != undef or $passenger_error_override != undef or $passenger_sticky_sessions != undef or $passenger_sticky_sessions_cookie_name != undef or $passenger_sticky_sessions_cookie_attributes != undef or $passenger_app_log_file != undef or $passenger_debugger != undef or $passenger_max_requests != undef or $passenger_max_request_time != undef or $passenger_memory_limit != undef {
include apache::mod::passenger
}

# Configure the defaultness of a vhost
if $priority {
$priority_real = "${priority}-"
Expand Down Expand Up @@ -2220,50 +2190,6 @@
}
}

# Load mod_alias if needed and not yet loaded
if ($scriptalias or $scriptaliases != [])
or ($redirect_source and $redirect_dest)
or ($redirectmatch_regexp or $redirectmatch_status or $redirectmatch_dest) {
if ! defined(Class['apache::mod::alias']) and ($ensure == 'present') {
include apache::mod::alias
}
}

# Load mod_proxy if needed and not yet loaded
if ($proxy_dest or $proxy_pass or $proxy_pass_match or $proxy_dest_match) {
if ! defined(Class['apache::mod::proxy']) {
include apache::mod::proxy
}
if ! defined(Class['apache::mod::proxy_http']) {
include apache::mod::proxy_http
}
}

# Load mod_fastcgi if needed and not yet loaded
if $fastcgi_server and $fastcgi_socket {
if ! defined(Class['apache::mod::fastcgi']) {
include apache::mod::fastcgi
}
}

# Check if mod_env is required and not yet loaded.
# create an expression to simplify the conditional check
$use_env_mod = $setenv and ! empty($setenv)
if ($use_env_mod) {
if ! defined(Class['apache::mod::env']) {
include apache::mod::env
}
}
# Check if mod_setenvif is required and not yet loaded.
# create an expression to simplify the conditional check
$use_setenvif_mod = ($setenvif and ! empty($setenvif)) or ($setenvifnocase and ! empty($setenvifnocase))

if ($use_setenvif_mod) {
if ! defined(Class['apache::mod::setenvif']) {
include apache::mod::setenvif
}
}

## Create a default directory list if none defined
if $directories {
$_directories = $directories
Expand Down Expand Up @@ -2355,6 +2281,7 @@
# - $protocols
# - $protocols_honor_order
# - $apache_version
# - $mdomain
concat::fragment { "${name}-apache-header":
target => "${priority_real}${filename}.conf",
order => 0,
Expand All @@ -2365,7 +2292,11 @@
# - $virtual_docroot
# - $virtual_use_default_docroot
# - $docroot
if $docroot {
if $docroot and $ensure == 'present' {
if $virtual_docroot {
include apache::mod::vhost_alias
}

concat::fragment { "${name}-docroot":
target => "${priority_real}${filename}.conf",
order => 10,
Expand Down Expand Up @@ -2556,7 +2487,10 @@
# - $proxy_preserve_host
# - $proxy_add_headers
# - $no_proxy_uris
if $proxy_dest or $proxy_pass or $proxy_pass_match or $proxy_dest_match or $proxy_preserve_host {
if ($proxy_dest or $proxy_pass or $proxy_pass_match or $proxy_dest_match or $proxy_preserve_host) and $ensure == 'present' {
include apache::mod::proxy
include apache::mod::proxy_http

concat::fragment { "${name}-proxy":
target => "${priority_real}${filename}.conf",
order => 170,
Expand All @@ -2577,7 +2511,9 @@
# - $redirectmatch_status_a
# - $redirectmatch_regexp_a
# - $redirectmatch_dest
if ($redirect_source and $redirect_dest) or ($redirectmatch_regexp and $redirectmatch_dest) {
if (($redirect_source and $redirect_dest) or ($redirectmatch_regexp and $redirectmatch_dest)) and $ensure == 'present' {
include apache::mod::alias

concat::fragment { "${name}-redirect":
target => "${priority_real}${filename}.conf",
order => 180,
Expand All @@ -2604,7 +2540,9 @@
# Template uses:
# - $scriptaliases
# - $scriptalias
if ( $scriptalias or $scriptaliases != []) {
if ($scriptalias or !empty($scriptaliases)) and $ensure == 'present' {
include apache::mod::alias

concat::fragment { "${name}-scriptalias":
target => "${priority_real}${filename}.conf",
order => 200,
Expand All @@ -2614,7 +2552,7 @@

# Template uses:
# - $serveraliases
if $serveraliases and ! empty($serveraliases) {
if ! empty($serveraliases) and $ensure == 'present' {
concat::fragment { "${name}-serveralias":
target => "${priority_real}${filename}.conf",
order => 210,
Expand All @@ -2625,7 +2563,16 @@
# Template uses:
# - $setenv
# - $setenvif
if ($use_env_mod or $use_setenvif_mod) {
$use_env_mod = !empty($setenv)
$use_setenvif_mod = !empty($setenvif) or !empty($setenvifnocase)
if ($use_env_mod or $use_setenvif_mod) and $ensure == 'present' {
if $use_env_mod {
include apache::mod::env
}
if $use_setenvif_mod {
include apache::mod::setenvif
}

concat::fragment { "${name}-setenv":
target => "${priority_real}${filename}.conf",
order => 220,
Expand All @@ -2652,7 +2599,10 @@
# - $ssl_openssl_conf_cmd
# - $ssl_stapling
# - $apache_version
# - $mdomain
if $ssl and $ensure == 'present' {
include apache::mod::ssl

concat::fragment { "${name}-ssl":
target => "${priority_real}${filename}.conf",
order => 230,
Expand Down Expand Up @@ -2686,7 +2636,9 @@
# - $krb_auth_realms
# - $krb_5keytab
# - $krb_local_user_mapping
if $auth_kerb {
if $auth_kerb and $ensure == 'present' {
include apache::mod::auth_kerb

concat::fragment { "${name}-auth_kerb":
target => "${priority_real}${filename}.conf",
order => 230,
Expand Down Expand Up @@ -2740,7 +2692,9 @@
if $wsgi_daemon_process_options {
deprecation('apache::vhost::wsgi_daemon_process_options', 'This parameter is deprecated. Please add values inside Hash `wsgi_daemon_process`.')
}
if $wsgi_application_group or $wsgi_daemon_process or ($wsgi_import_script and $wsgi_import_script_options) or $wsgi_process_group or ($wsgi_script_aliases and ! empty($wsgi_script_aliases)) or $wsgi_pass_authorization {
if ($wsgi_application_group or $wsgi_daemon_process or ($wsgi_import_script and $wsgi_import_script_options) or $wsgi_process_group or ($wsgi_script_aliases and ! empty($wsgi_script_aliases)) or $wsgi_pass_authorization) and $ensure == 'present' {
include apache::mod::wsgi

concat::fragment { "${name}-wsgi":
target => "${priority_real}${filename}.conf",
order => 260,
Expand All @@ -2764,7 +2718,9 @@
# - $fastcgi_dir
# - $fastcgi_idle_timeout
# - $apache_version
if $fastcgi_server or $fastcgi_dir {
if ($fastcgi_server or $fastcgi_dir) and $ensure == 'present' {
include apache::mod::fastcgi

concat::fragment { "${name}-fastcgi":
target => "${priority_real}${filename}.conf",
order => 280,
Expand All @@ -2774,15 +2730,17 @@

# Template uses:
# - $suexec_user_group
if $suexec_user_group {
if $suexec_user_group and $ensure == 'present' {
include apache::mod::suexec

concat::fragment { "${name}-suexec":
target => "${priority_real}${filename}.conf",
order => 290,
content => template('apache/vhost/_suexec.erb'),
}
}

if $h2_copy_files != undef or $h2_direct != undef or $h2_early_hints != undef or $h2_max_session_streams != undef or $h2_modern_tls_only != undef or $h2_push != undef or $h2_push_diary_size != undef or $h2_push_priority != [] or $h2_push_resource != [] or $h2_serialize_headers != undef or $h2_stream_max_mem_size != undef or $h2_tls_cool_down_secs != undef or $h2_tls_warm_up_size != undef or $h2_upgrade != undef or $h2_window_size != undef {
if ($h2_copy_files != undef or $h2_direct != undef or $h2_early_hints != undef or $h2_max_session_streams != undef or $h2_modern_tls_only != undef or $h2_push != undef or $h2_push_diary_size != undef or $h2_push_priority != [] or $h2_push_resource != [] or $h2_serialize_headers != undef or $h2_stream_max_mem_size != undef or $h2_tls_cool_down_secs != undef or $h2_tls_warm_up_size != undef or $h2_upgrade != undef or $h2_window_size != undef) and $ensure == 'present' {
include apache::mod::http2

concat::fragment { "${name}-http2":
Expand All @@ -2792,13 +2750,13 @@
}
}

if $mdomain {
if $mdomain and $ensure == 'present' {
include apache::mod::md
}

# Template uses:
# - $userdir
if $userdir {
if $userdir and $ensure == 'present' {
include apache::mod::userdir

concat::fragment { "${name}-userdir":
Expand Down Expand Up @@ -2853,7 +2811,9 @@
# - $passenger_max_requests
# - $passenger_max_request_time
# - $passenger_memory_limit
if $passenger_enabled != undef or $passenger_start_timeout != undef or $passenger_ruby != undef or $passenger_python != undef or $passenger_nodejs != undef or $passenger_meteor_app_settings != undef or $passenger_app_env != undef or $passenger_app_root != undef or $passenger_app_group_name != undef or $passenger_app_start_command != undef or $passenger_app_type != undef or $passenger_startup_file != undef or $passenger_restart_dir != undef or $passenger_spawn_method != undef or $passenger_load_shell_envvars != undef or $passenger_preload_bundler != undef or $passenger_rolling_restarts != undef or $passenger_resist_deployment_errors != undef or $passenger_min_instances != undef or $passenger_max_instances != undef or $passenger_max_preloader_idle_time != undef or $passenger_force_max_concurrent_requests_per_process != undef or $passenger_concurrency_model != undef or $passenger_thread_count != undef or $passenger_high_performance != undef or $passenger_max_request_queue_size != undef or $passenger_max_request_queue_time != undef or $passenger_user != undef or $passenger_group != undef or $passenger_friendly_error_pages != undef or $passenger_buffer_upload != undef or $passenger_buffer_response != undef or $passenger_allow_encoded_slashes != undef or $passenger_lve_min_uid != undef or $passenger_base_uri != undef or $passenger_error_override != undef or $passenger_sticky_sessions != undef or $passenger_sticky_sessions_cookie_name != undef or $passenger_sticky_sessions_cookie_attributes != undef or $passenger_app_log_file != undef or $passenger_debugger != undef or $passenger_max_requests != undef or $passenger_max_request_time != undef or $passenger_memory_limit != undef {
if ($passenger_enabled != undef or $passenger_start_timeout != undef or $passenger_ruby != undef or $passenger_python != undef or $passenger_nodejs != undef or $passenger_meteor_app_settings != undef or $passenger_app_env != undef or $passenger_app_root != undef or $passenger_app_group_name != undef or $passenger_app_start_command != undef or $passenger_app_type != undef or $passenger_startup_file != undef or $passenger_restart_dir != undef or $passenger_spawn_method != undef or $passenger_load_shell_envvars != undef or $passenger_preload_bundler != undef or $passenger_rolling_restarts != undef or $passenger_resist_deployment_errors != undef or $passenger_min_instances != undef or $passenger_max_instances != undef or $passenger_max_preloader_idle_time != undef or $passenger_force_max_concurrent_requests_per_process != undef or $passenger_concurrency_model != undef or $passenger_thread_count != undef or $passenger_high_performance != undef or $passenger_max_request_queue_size != undef or $passenger_max_request_queue_time != undef or $passenger_user != undef or $passenger_group != undef or $passenger_friendly_error_pages != undef or $passenger_buffer_upload != undef or $passenger_buffer_response != undef or $passenger_allow_encoded_slashes != undef or $passenger_lve_min_uid != undef or $passenger_base_uri != undef or $passenger_error_override != undef or $passenger_sticky_sessions != undef or $passenger_sticky_sessions_cookie_name != undef or $passenger_sticky_sessions_cookie_attributes != undef or $passenger_app_log_file != undef or $passenger_debugger != undef or $passenger_max_requests != undef or $passenger_max_request_time != undef or $passenger_memory_limit != undef) and $ensure == 'present' {
include apache::mod::passenger

concat::fragment { "${name}-passenger":
target => "${priority_real}${filename}.conf",
order => 300,
Expand Down Expand Up @@ -2946,7 +2906,9 @@
# Template uses:
# - $auth_oidc
# - $oidc_settings
if $auth_oidc {
if $auth_oidc and $ensure == 'present' {
include apache::mod::auth_openidc

concat::fragment { "${name}-auth_oidc":
target => "${priority_real}${filename}.conf",
order => 360,
Expand Down
18 changes: 5 additions & 13 deletions spec/defines/vhost_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2118,7 +2118,7 @@
is_expected.to contain_concat('25-rspec.example.com.conf').with('ensure' => 'absent')
}
it { is_expected.to contain_concat__fragment('rspec.example.com-apache-header') }
it { is_expected.to contain_concat__fragment('rspec.example.com-docroot') }
it { is_expected.not_to contain_concat__fragment('rspec.example.com-docroot') }
it { is_expected.not_to contain_concat__fragment('rspec.example.com-aliases') }
it { is_expected.not_to contain_concat__fragment('rspec.example.com-itk') }
it { is_expected.not_to contain_concat__fragment('rspec.example.com-fallbackresource') }
Expand Down Expand Up @@ -2641,22 +2641,14 @@
describe 'redirectmatch_*' do
let(:params) { super().merge(port: '84') }

context 'status' do
let(:params) { super().merge(redirectmatch_status: '404') }

it { is_expected.to contain_class('apache::mod::alias') }
end
context 'dest' do
let(:params) { super().merge(redirectmatch_dest: 'http://other.example.com$1.jpg') }

it { is_expected.to contain_class('apache::mod::alias') }
end
context 'regexp' do
let(:params) { super().merge(redirectmatch_regexp: "(.*)\.gif$") }
context 'dest and regexp' do
let(:params) { super().merge(redirectmatch_dest: 'http://other.example.com$1.jpg', redirectmatch_regexp: "(.*)\.gif$") }

it { is_expected.to contain_concat__fragment('rspec.example.com-redirect') }
it { is_expected.to contain_class('apache::mod::alias') }
end
context 'none' do
it { is_expected.not_to contain_concat__fragment('rspec.example.com-redirect') }
it { is_expected.not_to contain_class('apache::mod::alias') }
end
end
Expand Down
14 changes: 2 additions & 12 deletions templates/vhost/_scriptalias.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,8 @@
<%- if @scriptaliases.is_a?(Array) -%>
<%- aliases = @scriptaliases -%>
<%- elsif @scriptaliases.is_a?(Hash) -%>
<%- aliases = [@scriptaliases] -%>
<%- else -%>
<%- # Nothing to do with any other data type -%>
<%- aliases = [] -%>
<%- end -%>
<%- if @scriptalias or !aliases.empty? -%>
<%- aliases = @scriptaliases -%>
## Script alias directives
<%# Combine scriptalais and scriptaliases into a single data structure -%>
<%# Combine scriptalias and scriptaliases into a single data structure -%>
<%# for backward compatibility and ease of implementation -%>
<%- aliases << { 'alias' => '/cgi-bin', 'path' => @scriptalias } if @scriptalias -%>
<%- aliases.flatten.compact! -%>
<%- aliases.each do |salias| -%>
<%- if salias["path"] != '' -%>
<%- if salias["alias"] and salias["alias"] != '' -%>
Expand All @@ -21,4 +12,3 @@
<%- end -%>
<%- end -%>
<%- end -%>
<%- end -%>
2 changes: 1 addition & 1 deletion templates/vhost/_serveralias.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<% if @serveraliases and ! @serveraliases.empty? -%>
<% unless @serveraliases.empty? -%>

## Server aliases
<%- Array(@serveraliases).each do |serveralias| -%>
Expand Down
6 changes: 3 additions & 3 deletions templates/vhost/_setenv.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<% if @setenv and ! @setenv.empty? -%>
<% unless @setenv.empty? -%>

## SetEnv/SetEnvIf for environment variables
<%- Array(@setenv).each do |envvar| -%>
SetEnv <%= envvar %>
<%- end -%>
<% end -%>
<% if @setenvif and ! @setenvif.empty? -%>
<% unless @setenvif.empty? -%>
<%- Array(@setenvif).each do |envifvar| -%>
SetEnvIf <%= envifvar %>
<%- end -%>
<% end -%>
<% if @setenvifnocase and ! @setenvifnocase.empty? -%>
<% unless @setenvifnocase.empty? -%>
<%- Array(@setenvifnocase).each do |envifncvar| -%>
SetEnvIfNoCase <%= envifncvar %>
<%- end -%>
Expand Down