openstack/puppet-placement
Code Issues Proposed changes

Add logging params to placement::wsgi::apache

Browse Source 
Adds the params access_log_file, access_log_format and
error_log_file to placement::wsgi::apache like all others
has.

Adds spec testing for the placement::wsgi::apache class and
also aligns some parameter in the same order as the documentation
for the params is.

Change-Id: Ia88e21761a0f93d65563a7dcb1dd4fe1427b0e1e
This commit is contained in:
Tobias Urdin
2019-01-09 15:10:04 +01:00
parent a59aecb4fa
commit 363c74c3ad
3 changed files with 184 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
manifests/wsgi/apache.pp
View File

@@ -72,6 +72,18 @@
# (Optional) apache::vhost ssl parameters.
# Default to apache::vhost 'ssl_*' defaults.
#
# [*access_log_file*]
# (Optional) The log file name for the virtualhost.
# Defaults to false
#
# [*access_log_format*]
# (Optional) The log format for the virtualhost.
# Defaults to false
#
# [*error_log_file*]
# (Optional) The error log file name for the virtualhost.
# Defaults to undef
#
# == Examples
#
# include apache
@@ -85,6 +97,10 @@ class placement::wsgi::apache (
$path = '/placement',
$ssl = true,
$workers = 1,
$priority = '10',
$threads = $::os_workers,
$wsgi_process_display_name = undef,
$ensure_package = 'present',
$ssl_cert = undef,
$ssl_key = undef,
$ssl_chain = undef,
@@ -92,10 +108,9 @@ class placement::wsgi::apache (
$ssl_crl_path = undef,
$ssl_crl = undef,
$ssl_certs_dir = undef,
$wsgi_process_display_name = undef,
$threads = $::os_workers,
$priority = '10',
$ensure_package = 'present',
$access_log_file = false,
$access_log_format = false,
$error_log_file = undef,
) {
include ::placement::params
@@ -152,6 +167,9 @@ class placement::wsgi::apache (
wsgi_script_dir => $::placement::params::wsgi_script_path,
wsgi_script_file => 'placement-api',
wsgi_script_source => $::placement::params::wsgi_script_source,
access_log_file => $access_log_file,
access_log_format => $access_log_format,
error_log_file => $error_log_file,
}
}

5
releasenotes/notes/wsgi-logging-e7a851aaf20e27b4.yaml Normal file
View File

@@ -0,0 +1,5 @@
---
features:
- |
Added access_log_file, access_log_format and error_log_file parameters
to the placement::wsgi::apache class.

157
spec/classes/placement_wsgi_apache.rb Normal file
View File

@@ -0,0 +1,157 @@
require 'spec_helper'
describe 'placement::wsgi::apache' do
shared_examples 'placement::wsgi::apache' do
context 'with default parameters' do
it {
should contain_class('placement::params')
should contain_class('apache')
should contain_class('apache::mod::wsgi')
should contain_class('apache::mod::ssl')
}
it { should contain_placement__generic_service('api').with(
:service_name => false,
:package_name => platform_params[:package_name],
:ensure_package => 'present',
)}
it { should contain_file(platform_params[:httpd_config_file]).with_ensure('present') }
it { should contain_openstacklib__wsgi__apache('placement_wsgi').with(
:bind_host => nil,
:bind_port => 80,
:group => 'placement',
:path => '/placement',
:priority => '10',
:servername => facts[:fqdn],
:ssl => true,
:ssl_ca => nil,
:ssl_cert => nil,
:ssl_certs_dir => nil,
:ssl_chain => nil,
:ssl_crl => nil,
:ssl_crl_path => nil,
:ssl_key => nil,
:threads => facts[:os_workers],
:user => 'placement',
:workers => 1,
:wsgi_daemon_process => 'placement-api',
:wsgi_process_display_name => nil,
:wsgi_process_group => 'placement-api',
:wsgi_script_dir => platform_params[:wsgi_script_path],
:wsgi_script_file => 'placement-api',
:wsgi_script_source => platform_params[:wsgi_script_source],
:access_log_file => false,
:access_log_format => false,
:error_log_file => nil,
)}
end
context 'when overriding parameters' do
let :params do
{
:servername => 'dummy.host',
:bind_host => '10.42.51.1',
:api_port => 12345,
:path => '/custom',
:ssl => false,
:workers => 10,
:ssl_cert => '/etc/ssl/certs/placement.crt',
:ssl_key => '/etc/ssl/private/placement.key',
:ssl_chain => '/etc/ssl/certs/chain.pem',
:ssl_ca => '/etc/ssl/certs/ca.pem',
:ssl_crl_path => '/etc/ssl/crl',
:ssl_crl => '/etc/ssl/certs/crl.crt',
:ssl_certs_dir => '/etc/ssl/certs',
:wsgi_process_display_name => 'custom',
:threads => 5,
:priority => '25',
:ensure_package => 'absent',
:access_log_file => '/var/log/httpd/access_log',
:access_log_format => 'some format',
:error_log_file => '/var/log/httpd/error_log',
}
end
it {
should contain_class('placement::params')
should contain_class('apache')
should contain_class('apache::mod::wsgi')
should_not contain_class('apache::mod::ssl')
}
it { should contain_placement__generic_service('api').with(
:service_name => false,
:package_name => platform_params[:package_name],
:ensure_package => params[:ensure_package],
)}
it { should contain_file(platform_params[:httpd_config_file]).with_ensure('present') }
it { should contain_openstacklib__wsgi__apache('placement_wsgi').with(
:bind_host => params[:bind_host],
:bind_port => params[:api_port],
:group => 'placement',
:path => params[:path],
:priority => params[:priority],
:servername => params[:servername],
:ssl => params[:ssl],
:ssl_ca => params[:ssl_ca],
:ssl_cert => params[:ssl_cert],
:ssl_certs_dir => params[:ssl_certs_dir],
:ssl_chain => params[:ssl_chain],
:ssl_crl => params[:ssl_crl],
:ssl_crl_path => params[:ssl_crl_path],
:ssl_key => params[:ssl_key],
:threads => params[:threads],
:user => 'placement',
:workers => params[:workers],
:wsgi_daemon_process => 'placement-api',
:wsgi_process_display_name => params[:wsgi_process_display_name],
:wsgi_process_group => 'placement-api',
:wsgi_script_dir => platform_params[:wsgi_script_path],
:wsgi_script_file => 'placement-api',
:wsgi_script_source => platform_params[:wsgi_script_source],
:access_log_file => params[:access_log_file],
:access_log_format => params[:access_log_format],
:error_log_file => params[:error_log_file],
)}
end
end
on_supported_os({
:supported_os => OSDefaults.get_supported_os
}).each do |os,facts|
context "on #{os}" do
let (:facts) do
facts.merge!(OSDefaults.get_facts({
:os_workers => 42,
:concat_basedir => '/var/lib/puppet/concat',
:fqdn => 'some.host.tld',
}))
end
let(:platform_params) do
case facts[:osfamily]
when 'Debian'
{
:package_name => 'placement-api',
:httpd_config_file => '/etc/apache2/sites-available/nova-placement-api.conf',
:wsgi_script_path => '/var/www/cgi-bin/placement',
:wsgi_script_source => '/usr/bin/placement-api',
}
when 'RedHat'
{
:package_name => 'openstack-placement-api',
:httpd_config_file => '/etc/httpd/conf.d/00-placement-api.conf',
:wsgi_script_path => '/var/www/cgi-bin/placement',
:wsgi_script_source => '/usr/bin/placement-api',
}
end
end
it_behaves_like 'placement::wsgi::apache'
end
end
end