Add support for magnum_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 Magnum API. Therefore, this patch adds a new
magnum_api_uwsgi_config provider as well as a new
magnum::wsgi::uwsgi class.

Change-Id: Ibd80cee59c3a2b501e8dae1b5da4f651b6ac779d

lib/puppet/provider/magnum_api_uwsgi_config/openstackconfig.rb

@@ -0,0 +1,10 @@
+Puppet::Type.type(:magnum_api_uwsgi_config).provide(
+  :openstackconfig,
+  :parent => Puppet::Type.type(:openstack_config).provider(:ruby)
+) do
+
+  def self.file_path
+    '/etc/magnum/magnum-api-uwsgi.ini'
+  end
+
+end

lib/puppet/type/magnum_api_uwsgi_config.rb

@@ -0,0 +1,33 @@
+Puppet::Type.newtype(:magnum_api_uwsgi_config) do
+
+  ensurable
+
+  newparam(:name, :namevar => true) do
+    desc 'Section/setting name to manage from magnum-api-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
+
+  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
+
+  autorequire(:file) do
+    ['/etc/magnum/magnum-api-uwsgi.ini']
+  end
+
+  autorequire(:anchor) do
+    ['magnum::install::end']
+  end
+
+end

manifests/deps.pp

@@ -33,6 +33,11 @@ class magnum::deps {
   -> Openstacklib::Policy::Base<||>
   ~> Anchor['magnum::config::end']
 
+  # On any uwsgi config change, we must restart Magnum API.
+  Anchor['magnum::config::begin']
+  -> Magnum_api_uwsgi_config<||>
+  ~> Anchor['magnum::config::end']
+
   # Installation or config changes will always restart services.
   Anchor['magnum::install::end'] ~> Anchor['magnum::service::begin']
   Anchor['magnum::config::end']  ~> Anchor['magnum::service::begin']

manifests/wsgi/uwsgi.pp

@@ -0,0 +1,41 @@
+#
+# Copyright 2021 Thomas Goirand <zigo@debian.org>
+#
+# Author: Thomas Goirand <zigo@debian.org>
+#
+# == Class: magnum::wsgi::uwsgi
+#
+# Configure the UWSGI service for Magnum API.
+#
+# == 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 magnum::wsgi::uwsgi (
+  $processes         = $::os_workers,
+  $threads           = 32,
+  $listen_queue_size = 100,
+){
+
+  include magnum::deps
+
+  if $::os_package_type != 'debian'{
+    warning('This class is only valid for Debian, as other operating systems are not using uwsgi by default.')
+  }
+
+  magnum_api_uwsgi_config {
+    'uwsgi/processes': value => $processes;
+    'uwsgi/threads':   value => $threads;
+    'uwsgi/listen':    value => $listen_queue_size;
+  }
+}

releasenotes/notes/uwsgi-e2e776b8d7047c78.yaml

@@ -0,0 +1,7 @@
+---
+features:
+  - |
+    A new class magnum::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 magnum_api_uwsgi_config provider now exist.

spec/classes/magnum_wsgi_uwsgi_spec.rb

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

spec/unit/provider/magnum_api_uwsgi_config/openstackconfig_spec.rb

@@ -0,0 +1,68 @@
+#
+# 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')
+)
+$LOAD_PATH.push(
+  File.join(
+    File.dirname(__FILE__),
+    '..',
+    '..',
+    '..',
+    'fixtures',
+    'modules',
+    'openstacklib',
+    'lib')
+)
+require 'spec_helper'
+provider_class = Puppet::Type.type(:magnum_api_uwsgi_config).provider(:openstackconfig)
+describe provider_class do
+
+  it 'should default to the default setting when no other one is specified' do
+    resource = Puppet::Type::Magnum_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::Magnum_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::Magnum_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::Magnum_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

spec/unit/type/magnum_api_uwsgi_config_spec.rb

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