Add support for [cors] options

This change introduces the new cloudkitty::cors class, which manages
parameters of the cors middleware from oslo.middleware.

Change-Id: Ida34189343e2202b557e71c214bfe5c01c6759fa
This commit is contained in:
Takashi Kajinami 2021-11-02 09:51:15 +09:00
parent 39c9ad822b
commit c409f6e269
3 changed files with 115 additions and 0 deletions

58
manifests/cors.pp Normal file
View File

@ -0,0 +1,58 @@
# == Class: cloudkitty::cors
#
# Configure the cloudkitty cors
#
# === Parameters
#
# [*allowed_origin*]
# (Optional) Indicate whether this resource may be shared with the domain
# received in the requests "origin" header.
# (string value)
# Defaults to $::os_service_default.
#
# [*allow_credentials*]
# (Optional) Indicate that the actual request can include user credentials.
# (boolean value)
# Defaults to $::os_service_default.
#
# [*expose_headers*]
# (Optional) Indicate which headers are safe to expose to the API.
# (list value)
# Defaults to $::os_service_default.
#
# [*max_age*]
# (Optional) Maximum cache age of CORS preflight requests.
# (integer value)
# Defaults to $::os_service_default.
#
# [*allow_methods*]
# (Optional) Indicate which methods can be used during the actual request.
# (list value)
# Defaults to $::os_service_default.
#
# [*allow_headers*]
# (Optional) Indicate which header field names may be used during the actual
# request.
# (list value)
# Defaults to $::os_service_default.
#
class cloudkitty::cors (
$allowed_origin = $::os_service_default,
$allow_credentials = $::os_service_default,
$expose_headers = $::os_service_default,
$max_age = $::os_service_default,
$allow_methods = $::os_service_default,
$allow_headers = $::os_service_default,
) {
include cloudkitty::deps
oslo::cors { 'cloudkitty_config':
allowed_origin => $allowed_origin,
allow_credentials => $allow_credentials,
expose_headers => $expose_headers,
max_age => $max_age,
allow_methods => $allow_methods,
allow_headers => $allow_headers,
}
}

View File

@ -0,0 +1,4 @@
---
features:
- |
The new ``cloudkitty::cors`` class has been added.

View File

@ -0,0 +1,53 @@
require 'spec_helper'
describe 'cloudkitty::cors' do
shared_examples_for 'cloudkitty::cors' do
it 'configure cors default params' do
is_expected.to contain_oslo__cors('cloudkitty_config').with(
:allowed_origin => '<SERVICE DEFAULT>',
:allow_credentials => '<SERVICE DEFAULT>',
:expose_headers => '<SERVICE DEFAULT>',
:max_age => '<SERVICE DEFAULT>',
:allow_methods => '<SERVICE DEFAULT>',
:allow_headers => '<SERVICE DEFAULT>',
)
end
context 'with specific parameters' do
let :params do
{ :allowed_origin => '*',
:allow_credentials => true,
:expose_headers => 'Content-Language,Expires',
:max_age => 3600,
:allow_methods => 'GET,POST,PUT,DELETE,OPTIONS',
:allow_headers => 'Content-Type,Cache-Control',
}
end
it 'configure cors params' do
is_expected.to contain_oslo__cors('cloudkitty_config').with(
:allowed_origin => '*',
:allow_credentials => true,
:expose_headers => 'Content-Language,Expires',
:max_age => 3600,
:allow_methods => 'GET,POST,PUT,DELETE,OPTIONS',
:allow_headers => 'Content-Type,Cache-Control',
)
end
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())
end
it_behaves_like 'cloudkitty::cors'
end
end
end