Merge "Add support for swift_{proxy,account,container}_uwsgi_config in Debian"

This commit is contained in:
Zuul 2021-05-18 13:10:21 +00:00 committed by Gerrit Code Review
commit 3ccb2cd44e
20 changed files with 685 additions and 0 deletions

View File

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

View File

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

View File

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

View File

@ -0,0 +1,27 @@
Puppet::Type.newtype(:swift_account_uwsgi_config) do
ensurable
newparam(:name, :namevar => true) do
desc 'Section/setting name to manage from /etc/swift/swift-account-server-uwsgi.ini'
newvalues(/\S+\/\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
['swift::install::end']
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
end
end

View File

@ -0,0 +1,27 @@
Puppet::Type.newtype(:swift_container_uwsgi_config) do
ensurable
newparam(:name, :namevar => true) do
desc 'Section/setting name to manage from /etc/swift/swift-container-server-uwsgi.ini'
newvalues(/\S+\/\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
['swift::install::end']
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
end
end

View File

@ -0,0 +1,27 @@
Puppet::Type.newtype(:swift_proxy_uwsgi_config) do
ensurable
newparam(:name, :namevar => true) do
desc 'Section/setting name to manage from /etc/swift/swift-proxy-server-uwsgi.ini'
newvalues(/\S+\/\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
['swift::install::end']
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
end
end

View File

@ -46,6 +46,19 @@ class swift::deps {
-> Concat<| tag == 'swift-concat' |>
~> Anchor['swift::config::end']
# On any uwsgi config change, we must restart Swift.
Anchor['swift::config::begin']
-> Swift_proxy_uwsgi_config<||>
~> Anchor['swift::config::end']
Anchor['swift::config::begin']
-> Swift_account_uwsgi_config<||>
~> Anchor['swift::config::end']
Anchor['swift::config::begin']
-> Swift_container_uwsgi_config<||>
~> Anchor['swift::config::end']
# Support packages need to be installed in the install phase, but we don't
# put them in the chain above because we don't want any false dependencies
# between packages with the swift-package tag and the swift-support-package

View File

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

View File

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

View File

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

View File

@ -0,0 +1,9 @@
---
features:
- |
3 new classes swift::wsgi::uwsgi_proxy, swift::wsgi::uwsgi_account and
swift::wsgi::uwsgi_container exist to allow configuring uwsgi in
operating systems that support this (ie: currently Debian). This helps
configuring the number of processes and listen socket.
Also, 3 new swift_proxy_uwsgi_config, swift_account_uwsgi_config, and
swift_container_uwsgi_config providers now exist.

View File

@ -0,0 +1,30 @@
require 'spec_helper'
describe 'swift::wsgi::uwsgi_account' do
shared_examples 'swift::wsgi::uwsgi_account' do
context 'with default parameters' do
it {
should contain_class('swift::deps')
}
it {
is_expected.to contain_swift_account_uwsgi_config('uwsgi/processes').with_value(facts[:os_workers])
is_expected.to contain_swift_account_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 'swift::wsgi::uwsgi_account'
end
end
end

View File

@ -0,0 +1,30 @@
require 'spec_helper'
describe 'swift::wsgi::uwsgi_container' do
shared_examples 'swift::wsgi::uwsgi_container' do
context 'with default parameters' do
it {
should contain_class('swift::deps')
}
it {
is_expected.to contain_swift_container_uwsgi_config('uwsgi/processes').with_value(facts[:os_workers])
is_expected.to contain_swift_container_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 'swift::wsgi::uwsgi_container'
end
end
end

View File

@ -0,0 +1,30 @@
require 'spec_helper'
describe 'swift::wsgi::uwsgi_proxy' do
shared_examples 'swift::wsgi::uwsgi_proxy' do
context 'with default parameters' do
it {
should contain_class('swift::deps')
}
it {
is_expected.to contain_swift_proxy_uwsgi_config('uwsgi/processes').with_value(facts[:os_workers])
is_expected.to contain_swift_proxy_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 'swift::wsgi::uwsgi_proxy'
end
end
end

View File

@ -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(:swift_account_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::Swift_account_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::Swift_account_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::Swift_account_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::Swift_account_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

View File

@ -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(:swift_container_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::Swift_container_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::Swift_container_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::Swift_container_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::Swift_container_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

View File

@ -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(:swift_proxy_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::Swift_proxy_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::Swift_proxy_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::Swift_proxy_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::Swift_proxy_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

View File

@ -0,0 +1,64 @@
require 'puppet'
require 'puppet/type/swift_account_uwsgi_config'
describe 'Puppet::Type.type(:swift_account_uwsgi_config)' do
before :each do
@swift_account_uwsgi_config = Puppet::Type.type(:swift_account_uwsgi_config).new(:name => 'DEFAULT/foo', :value => 'bar')
end
it 'should require a name' do
expect {
Puppet::Type.type(:swift_account_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(:swift_account_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(:swift_account_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(:swift_account_uwsgi_config).new(:name => 'DEFAULT/foo', :ensure => :absent)
end
it 'should accept a valid value' do
@swift_account_uwsgi_config[:value] = 'bar'
expect(@swift_account_uwsgi_config[:value]).to eq('bar')
end
it 'should not accept a value with whitespace' do
@swift_account_uwsgi_config[:value] = 'b ar'
expect(@swift_account_uwsgi_config[:value]).to eq('b ar')
end
it 'should accept valid ensure values' do
@swift_account_uwsgi_config[:ensure] = :present
expect(@swift_account_uwsgi_config[:ensure]).to eq(:present)
@swift_account_uwsgi_config[:ensure] = :absent
expect(@swift_account_uwsgi_config[:ensure]).to eq(:absent)
end
it 'should not accept invalid ensure values' do
expect {
@swift_account_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 => 'swift::install::end')
catalog.add_resource anchor, @swift_account_uwsgi_config
dependency = @swift_account_uwsgi_config.autorequire
expect(dependency.size).to eq(1)
expect(dependency[0].target).to eq(@swift_account_uwsgi_config)
expect(dependency[0].source).to eq(anchor)
end
end

View File

@ -0,0 +1,64 @@
require 'puppet'
require 'puppet/type/swift_container_uwsgi_config'
describe 'Puppet::Type.type(:swift_container_uwsgi_config)' do
before :each do
@swift_container_uwsgi_config = Puppet::Type.type(:swift_container_uwsgi_config).new(:name => 'DEFAULT/foo', :value => 'bar')
end
it 'should require a name' do
expect {
Puppet::Type.type(:swift_container_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(:swift_container_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(:swift_container_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(:swift_container_uwsgi_config).new(:name => 'DEFAULT/foo', :ensure => :absent)
end
it 'should accept a valid value' do
@swift_container_uwsgi_config[:value] = 'bar'
expect(@swift_container_uwsgi_config[:value]).to eq('bar')
end
it 'should not accept a value with whitespace' do
@swift_container_uwsgi_config[:value] = 'b ar'
expect(@swift_container_uwsgi_config[:value]).to eq('b ar')
end
it 'should accept valid ensure values' do
@swift_container_uwsgi_config[:ensure] = :present
expect(@swift_container_uwsgi_config[:ensure]).to eq(:present)
@swift_container_uwsgi_config[:ensure] = :absent
expect(@swift_container_uwsgi_config[:ensure]).to eq(:absent)
end
it 'should not accept invalid ensure values' do
expect {
@swift_container_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 => 'swift::install::end')
catalog.add_resource anchor, @swift_container_uwsgi_config
dependency = @swift_container_uwsgi_config.autorequire
expect(dependency.size).to eq(1)
expect(dependency[0].target).to eq(@swift_container_uwsgi_config)
expect(dependency[0].source).to eq(anchor)
end
end

View File

@ -0,0 +1,64 @@
require 'puppet'
require 'puppet/type/swift_proxy_uwsgi_config'
describe 'Puppet::Type.type(:swift_proxy_uwsgi_config)' do
before :each do
@swift_proxy_uwsgi_config = Puppet::Type.type(:swift_proxy_uwsgi_config).new(:name => 'DEFAULT/foo', :value => 'bar')
end
it 'should require a name' do
expect {
Puppet::Type.type(:swift_proxy_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(:swift_proxy_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(:swift_proxy_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(:swift_proxy_uwsgi_config).new(:name => 'DEFAULT/foo', :ensure => :absent)
end
it 'should accept a valid value' do
@swift_proxy_uwsgi_config[:value] = 'bar'
expect(@swift_proxy_uwsgi_config[:value]).to eq('bar')
end
it 'should not accept a value with whitespace' do
@swift_proxy_uwsgi_config[:value] = 'b ar'
expect(@swift_proxy_uwsgi_config[:value]).to eq('b ar')
end
it 'should accept valid ensure values' do
@swift_proxy_uwsgi_config[:ensure] = :present
expect(@swift_proxy_uwsgi_config[:ensure]).to eq(:present)
@swift_proxy_uwsgi_config[:ensure] = :absent
expect(@swift_proxy_uwsgi_config[:ensure]).to eq(:absent)
end
it 'should not accept invalid ensure values' do
expect {
@swift_proxy_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 => 'swift::install::end')
catalog.add_resource anchor, @swift_proxy_uwsgi_config
dependency = @swift_proxy_uwsgi_config.autorequire
expect(dependency.size).to eq(1)
expect(dependency[0].target).to eq(@swift_proxy_uwsgi_config)
expect(dependency[0].source).to eq(anchor)
end
end