From 8d0f45e3b83279a81204a7d06f3561ebb9cf38e3 Mon Sep 17 00:00:00 2001 From: Takashi Kajinami Date: Mon, 1 Feb 2021 22:35:58 +0900 Subject: [PATCH] Add support for healthcheck middleware options Depends-on: https://review.opendev.org/772202 Change-Id: I019e6b65c2421716364053267117a9ea8f9d4fb4 --- manifests/healthcheck.pp | 41 ++++++++++++++ .../notes/healthcheck-0465f924bd2f4dbe.yaml | 5 ++ spec/classes/gnocchi_healthcheck_spec.rb | 55 +++++++++++++++++++ 3 files changed, 101 insertions(+) create mode 100644 manifests/healthcheck.pp create mode 100644 releasenotes/notes/healthcheck-0465f924bd2f4dbe.yaml create mode 100644 spec/classes/gnocchi_healthcheck_spec.rb diff --git a/manifests/healthcheck.pp b/manifests/healthcheck.pp new file mode 100644 index 00000000..dd20ea9b --- /dev/null +++ b/manifests/healthcheck.pp @@ -0,0 +1,41 @@ +# == Define: gnocchi::healthcheck +# +# Configure oslo_middleware options in healthcheck section +# +# == Params +# +# [*detailed*] +# (Optional) Show more detailed information as part of the response. +# Defaults to $::os_service_default +# +# [*backends*] +# (Optional) Additional backends that can perform health checks and report +# that information back as part of a request. +# Defaults to $::os_service_default +# +# [*disable_by_file_path*] +# (Optional) Check the presense of a file to determine if an application +# is running on a port. +# Defaults to $::os_service_default +# +# [*disable_by_file_paths*] +# (Optional) Check the presense of a file to determine if an application +# is running on a port. Expects a "port:path" list of strings. +# Defaults to $::os_service_default +# +class gnocchi::healthcheck ( + $detailed = $::os_service_default, + $backends = $::os_service_default, + $disable_by_file_path = $::os_service_default, + $disable_by_file_paths = $::os_service_default, +) { + + include gnocchi::deps + + oslo::healthcheck { 'gnocchi_config': + detailed => $detailed, + backends => $backends, + disable_by_file_path => $disable_by_file_path, + disable_by_file_paths => $disable_by_file_paths, + } +} diff --git a/releasenotes/notes/healthcheck-0465f924bd2f4dbe.yaml b/releasenotes/notes/healthcheck-0465f924bd2f4dbe.yaml new file mode 100644 index 00000000..83cec132 --- /dev/null +++ b/releasenotes/notes/healthcheck-0465f924bd2f4dbe.yaml @@ -0,0 +1,5 @@ +--- +features: + - | + The new ``gnocchi::healthcheck`` class has been added. This class manages + parameters of healthcheck middlware in oslo.middleware. diff --git a/spec/classes/gnocchi_healthcheck_spec.rb b/spec/classes/gnocchi_healthcheck_spec.rb new file mode 100644 index 00000000..6f1423ec --- /dev/null +++ b/spec/classes/gnocchi_healthcheck_spec.rb @@ -0,0 +1,55 @@ +require 'spec_helper' + +describe 'gnocchi::healthcheck' do + + shared_examples_for 'gnocchi::healthcheck' do + + context 'with default parameters' do + let :params do + {} + end + + it 'configures default values' do + is_expected.to contain_oslo__healthcheck('gnocchi_config').with( + :detailed => '', + :backends => '', + :disable_by_file_path => '', + :disable_by_file_paths => '', + ) + end + end + + context 'with specific parameters' do + let :params do + { + :detailed => true, + :backends => ['disable_by_file'], + :disable_by_file_path => '/etc/gnocchi/healthcheck/disabled', + :disable_by_file_paths => ['8004:/etc/gnocchi/healthcheck/disabled'], + } + end + + it 'configures specified values' do + is_expected.to contain_oslo__healthcheck('gnocchi_config').with( + :detailed => true, + :backends => ['disable_by_file'], + :disable_by_file_path => '/etc/gnocchi/healthcheck/disabled', + :disable_by_file_paths => ['8004:/etc/gnocchi/healthcheck/disabled'], + ) + 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_configures 'gnocchi::healthcheck' + end + end + +end