Add support for mistral_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 Mistral API. Therefore, this patch adds a new
mistral_api_uwsgi_config provider as well as a new
mistral::wsgi::uwsgi class.

Signed-off-by: Thomas Goirand <zigo@debian.org>
Change-Id: I3e1a7b170c9840b0de83e0eb97c596154790d019

lib/puppet/provider/mistral_api_uwsgi_config/ini_setting.rb

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

lib/puppet/type/mistral_api_uwsgi_config.rb

@@ -0,0 +1,29 @@
+Puppet::Type.newtype(:mistral_api_uwsgi_config) do
+
+  ensurable
+
+  newparam(:name, :namevar => true) do
+    desc 'Section/setting name to manage from /etc/mistral/mistral-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
+    ['mistral::install::end']
+  end
+
+end

manifests/api.pp

@@ -113,6 +113,8 @@ class mistral::api (
           hasrestart => true,
           tag        => 'mistral-service',
         }
+        # On any uwsgi config change, we must restart Mistral API.
+        Mistral_api_uwsgi_config<||> ~> Service['mistral-api']
       }
     }
   }

manifests/deps.pp

@@ -24,6 +24,10 @@ class mistral::deps {
   ~> Service<| tag == 'mistral-service' |>
   ~> anchor { 'mistral::service::end': }
 
+  Anchor['mistral::config::begin']
+  -> Mistral_api_uwsgi_config<||>
+  -> Anchor['mistral::config::end']
+
   # We need openstackclient before marking service end so that mistral
   # will have clients available to create resources. This tag handles the
   # openstackclient but indirectly since the client is not available in

manifests/wsgi/uwsgi.pp

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

releasenotes/notes/uwsgi-b797b91577f2d1e6.yaml

@@ -0,0 +1,7 @@
+---
+features:
+  - |
+    A new class mistral::wsgi::wsgi exists 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 mistral_api_uwsgi_config provider now exist.

spec/classes/mistral_wsgi_uwsgi_spec.rb

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

spec/unit/provider/mistral_api_uwsgi_config/openstackconfig_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+provider_class = Puppet::Type.type(:mistral_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::Mistral_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::Mistral_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::Mistral_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::Mistral_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/mistral_api_uwsgi_config_spec.rb

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