Browse Source

Add support for barbican_api_uwsgi_config in Debian

This patch is adding the configuration of the number of workers,
threads, and the size of the listen queue in Debian, which uses
uwsgi to run Nova API. Therefore, this patch adds a new
barbican_api_uwsgi_config provider as well as a new
barbican::wsgi::uwsgi class.

Change-Id: I3acdc3021e787ae1bc5e4ed3c464d530bfbde50a
changes/41/785241/3
Thomas Goirand 6 months ago
parent
commit
0edb3b1831
  1. 8
      lib/puppet/provider/barbican_api_uwsgi_config/ini_setting.rb
  2. 29
      lib/puppet/type/barbican_api_uwsgi_config.rb
  3. 5
      manifests/deps.pp
  4. 41
      manifests/wsgi/uwsgi.pp
  5. 7
      releasenotes/notes/uwsgi-62f17e06607b6b6f.yaml
  6. 31
      spec/classes/barbican_wsgi_uwsgi_spec.rb
  7. 57
      spec/unit/provider/barbican_api_uwsgi_config/ini_setting_spec.rb
  8. 64
      spec/unit/type/barbican_api_uwsgi_config_spec.rb

8
lib/puppet/provider/barbican_api_uwsgi_config/ini_setting.rb

@ -0,0 +1,8 @@
Puppet::Type.type(:barbican_api_uwsgi_config).provide(
:ini_setting,
:parent => Puppet::Type.type(:openstack_config).provider(:ini_setting)
) do
def self.file_path
'/etc/barbican/barbican-api-uwsgi.ini'
end
end

29
lib/puppet/type/barbican_api_uwsgi_config.rb

@ -0,0 +1,29 @@
Puppet::Type.newtype(:barbican_api_uwsgi_config) do
ensurable
newparam(:name, :namevar => true) do
desc 'Section/setting name to manage from /etc/barbican/barbican-api-uwsgi.ini'
newvalues(/\S+\/\S+/)
end
newproperty(:value) do
desc 'The value of the setting to be defined.'
munge do |value|
value = value.to_s.strip
value.capitalize! if value =~ /^(true|false)$/i
value
end
newvalues(/^[\S ]*$/)
end
newparam(:ensure_absent_val) do
desc 'A value that is specified as the value property will behave as if ensure => absent was specified'
defaultto('<SERVICE DEFAULT>')
end
autorequire(:anchor) do
['barbican::install::end']
end
end

5
manifests/deps.pp

@ -38,6 +38,11 @@ class barbican::deps {
-> Barbican_api_paste_ini<||>
~> Anchor['barbican::config::end']
# On any uwsgi config change, we must restart Barbican API.
Anchor['barbican::config::begin']
-> Barbican_api_uwsgi_config<||>
~> Anchor['barbican::config::end']
# Ensure files are modified in the config block
Anchor['barbican::config::begin']
-> File_line<| tag == 'modify-bind-port' |>

41
manifests/wsgi/uwsgi.pp

@ -0,0 +1,41 @@
#
# Copyright 2021 Thomas Goirand <zigo@debian.org>
#
# Author: Thomas Goirand <zigo@debian.org>
#
# == Class: barbican::wsgi::uwsgi
#
# Configure the UWSGI service for Barbican.
#
# == Parameters
#
# [*processes*]
# (Optional) Number of processes.
# Defaults to $::os_workers.
#
# [*threads*]
# (Optional) Number of threads.
# Defaults to 32.
#
# [*listen_queue_size*]
# (Optional) Socket listen queue size.
# Defaults to 100
#
class barbican::wsgi::uwsgi (
$processes = $::os_workers,
$threads = 32,
$listen_queue_size = 100,
){
include barbican::deps
if $::os_package_type != 'debian'{
warning('This class is only valid for Debian, as other operating systems are not using uwsgi by default.')
}
barbican_api_uwsgi_config {
'uwsgi/processes': value => $processes;
'uwsgi/threads': value => $threads;
'uwsgi/listen': value => $listen_queue_size;
}
}

7
releasenotes/notes/uwsgi-62f17e06607b6b6f.yaml

@ -0,0 +1,7 @@
---
features:
- |
A new class barbican::wsgi::uwsgi exist to allow configuring uwsgi in
operating systems that support this (ie: currently Debian). This helps
configuring the number of processes, threads and listen socket.
Also, a new barbican_api_wsgi_config provider now exist.

31
spec/classes/barbican_wsgi_uwsgi_spec.rb

@ -0,0 +1,31 @@
require 'spec_helper'
describe 'barbican::wsgi::uwsgi' do
shared_examples 'barbican::wsgi::uwsgi' do
context 'with default parameters' do
it {
should contain_class('barbican::deps')
}
it {
is_expected.to contain_barbican_api_uwsgi_config('uwsgi/processes').with_value(facts[:os_workers])
is_expected.to contain_barbican_api_uwsgi_config('uwsgi/threads').with_value('32')
is_expected.to contain_barbican_api_uwsgi_config('uwsgi/listen').with_value('100')
}
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 => 8,
}))
end
it_behaves_like 'barbican::wsgi::uwsgi'
end
end
end

57
spec/unit/provider/barbican_api_uwsgi_config/ini_setting_spec.rb

@ -0,0 +1,57 @@
#
# these tests are a little concerning b/c they are hacking around the
# modulepath, so these tests will not catch issues that may eventually arise
# related to loading these plugins.
# I could not, for the life of me, figure out how to programatcally set the modulepath
$LOAD_PATH.push(
File.join(
File.dirname(__FILE__),
'..',
'..',
'..',
'fixtures',
'modules',
'inifile',
'lib')
)
require 'spec_helper'
provider_class = Puppet::Type.type(:barbican_api_uwsgi_config).provider(:ini_setting)
describe provider_class do
it 'should default to the default setting when no other one is specified' do
resource = Puppet::Type::Barbican_api_uwsgi_config.new(
{:name => 'DEFAULT/foo', :value => 'bar'}
)
provider = provider_class.new(resource)
expect(provider.section).to eq('DEFAULT')
expect(provider.setting).to eq('foo')
end
it 'should allow setting to be set explicitly' do
resource = Puppet::Type::Barbican_api_uwsgi_config.new(
{:name => 'dude/foo', :value => 'bar'}
)
provider = provider_class.new(resource)
expect(provider.section).to eq('dude')
expect(provider.setting).to eq('foo')
end
it 'should ensure absent when <SERVICE DEFAULT> is specified as a value' do
resource = Puppet::Type::Barbican_api_uwsgi_config.new(
{:name => 'dude/foo', :value => '<SERVICE DEFAULT>'}
)
provider = provider_class.new(resource)
provider.exists?
expect(resource[:ensure]).to eq :absent
end
it 'should ensure absent when value matches ensure_absent_val' do
resource = Puppet::Type::Barbican_api_uwsgi_config.new(
{:name => 'dude/foo', :value => 'foo', :ensure_absent_val => 'foo' }
)
provider = provider_class.new(resource)
provider.exists?
expect(resource[:ensure]).to eq :absent
end
end

64
spec/unit/type/barbican_api_uwsgi_config_spec.rb

@ -0,0 +1,64 @@
require 'puppet'
require 'puppet/type/barbican_api_uwsgi_config'
describe 'Puppet::Type.type(:barbican_api_uwsgi_config)' do
before :each do
@barbican_api_uwsgi_config = Puppet::Type.type(:barbican_api_uwsgi_config).new(:name => 'DEFAULT/foo', :value => 'bar')
end
it 'should require a name' do
expect {
Puppet::Type.type(:barbican_api_uwsgi_config).new({})
}.to raise_error(Puppet::Error, 'Title or name must be provided')
end
it 'should not expect a name with whitespace' do
expect {
Puppet::Type.type(:barbican_api_uwsgi_config).new(:name => 'f oo')
}.to raise_error(Puppet::Error, /Parameter name failed/)
end
it 'should fail when there is no section' do
expect {
Puppet::Type.type(:barbican_api_uwsgi_config).new(:name => 'foo')
}.to raise_error(Puppet::Error, /Parameter name failed/)
end
it 'should not require a value when ensure is absent' do
Puppet::Type.type(:barbican_api_uwsgi_config).new(:name => 'DEFAULT/foo', :ensure => :absent)
end
it 'should accept a valid value' do
@barbican_api_uwsgi_config[:value] = 'bar'
expect(@barbican_api_uwsgi_config[:value]).to eq('bar')
end
it 'should not accept a value with whitespace' do
@barbican_api_uwsgi_config[:value] = 'b ar'
expect(@barbican_api_uwsgi_config[:value]).to eq('b ar')
end
it 'should accept valid ensure values' do
@barbican_api_uwsgi_config[:ensure] = :present
expect(@barbican_api_uwsgi_config[:ensure]).to eq(:present)
@barbican_api_uwsgi_config[:ensure] = :absent
expect(@barbican_api_uwsgi_config[:ensure]).to eq(:absent)
end
it 'should not accept invalid ensure values' do
expect {
@barbican_api_uwsgi_config[:ensure] = :latest
}.to raise_error(Puppet::Error, /Invalid value/)
end
it 'should autorequire the package that install the file' do
catalog = Puppet::Resource::Catalog.new
anchor = Puppet::Type.type(:anchor).new(:name => 'barbican::install::end')
catalog.add_resource anchor, @barbican_api_uwsgi_config
dependency = @barbican_api_uwsgi_config.autorequire
expect(dependency.size).to eq(1)
expect(dependency[0].target).to eq(@barbican_api_uwsgi_config)
expect(dependency[0].source).to eq(anchor)
end
end
Loading…
Cancel
Save