Add support for Vhost metadata

[jimmybigcommerce]

Adding support for Vhost metadata - resolves #963

Allows for the following resource definition:

rabbitmq_vhost { 'myvhost':
  ensure             => present,
  description        => 'myvhost description',
  tags               => ['tag1', 'tag2'],
  default_queue_type => 'quorum',
}

Manual testing

Adding a various assortment of Vhosts with various settings defined:

Puppet run:

Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_no_desc_or_tags_or_queue_type-temp]/ensure: created
Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_tags_and_desc_stream_no_queue_type-temp]/ensure: created
Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_no_desc_or_tags_stream-temp]/ensure: created
Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_desc_no_tags_stream-temp]/ensure: created
Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_tags_and_desc_stream-temp]/ensure: created
Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_no_desc_or_tags_quorum-temp]/ensure: created
Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_desc_no_tags_quorum-temp]/ensure: created
Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_tags_and_desc_quorum-temp]/ensure: created
Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_no_desc_or_tags_classic-temp]/ensure: created
Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_desc_no_tags_classic-temp]/ensure: created
Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_tags_and_desc_classic-temp]/ensure: created

And the resulting vhost list:

# rabbitmqctl list_vhosts name,description,default_queue_type,tags -s | grep 'temp'
test_desc_no_tags_classic-temp	Vhost with a description but no tags, default queue type classic	classic	[]
test_desc_no_tags_quorum-temp	Vhost with a description but no tags, default queue type quorum	quorum	[]
test_no_desc_or_tags_classic-temp		classic	[]
test_no_desc_or_tags_quorum-temp		quorum	[]
test_tags_and_desc_classic-temp	Vhost with a description and tags, default queue type classic	classic	[tag1, tag2]
test_desc_no_tags_stream-temp	Vhost with a description but no tags, default queue type stream	stream	[]
test_tags_and_desc_quorum-temp	Vhost with a description and tags, default queue type quorum	quorum	[tag1, tag2]
test_no_desc_or_tags_or_queue_type-temp		undefined	[]
test_tags_and_desc_stream-temp	Vhost with a description and tags, default queue type stream	stream	[tag1, tag2]
test_no_desc_or_tags_stream-temp		stream	[]
test_tags_and_desc_stream_no_queue_type-temp	Vhost with a description and tags, no default queue type	undefined	[tag1, tag2]

Change some tags and default queue types and rerun

Puppet run:

Info: Applying configuration version '6da7560f7d - Wed Dec 6 10:01:34 2023 +1100'
Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_no_desc_or_tags_or_queue_type-temp]/default_queue_type: default_queue_type changed  to 'quorum'
Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_tags_and_desc_stream_no_queue_type-temp]/tags: tags changed ['tag1', 'tag2'] to ['tag1', 'newtag']
Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_tags_and_desc_quorum-temp]/description: description changed 'Vhost with a description and tags, default queue type quorum' to 'Vhost with an amended description and tags, default queue type quorum'

Vhost list:

# rabbitmqctl list_vhosts name,description,default_queue_type,tags -s | grep 'temp'
test_desc_no_tags_classic-temp	Vhost with a description but no tags, default queue type classic	classic	[]
test_desc_no_tags_quorum-temp	Vhost with a description but no tags, default queue type quorum	quorum	[]
test_no_desc_or_tags_classic-temp		classic	[]
test_no_desc_or_tags_quorum-temp		quorum	[]
test_tags_and_desc_classic-temp	Vhost with a description and tags, default queue type classic	classic	[tag1, tag2]
test_desc_no_tags_stream-temp	Vhost with a description but no tags, default queue type stream	stream	[]
test_tags_and_desc_quorum-temp	Vhost with an amended description and tags, default queue type quorum	quorum	[tag1, tag2]
test_no_desc_or_tags_or_queue_type-temp		quorum	[]
test_tags_and_desc_stream-temp	Vhost with a description and tags, default queue type stream	stream	[tag1, tag2]
test_no_desc_or_tags_stream-temp		stream	[]
test_tags_and_desc_stream_no_queue_type-temp	Vhost with a description and tags, no default queue type	undefined	[tag1, newtag

Absent some Vhosts

Puppet run:

Info: Applying configuration version '31ff014b16 - Wed Dec 6 10:01:34 2023 +1100'
Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_no_desc_or_tags_or_queue_type-temp]/ensure: removed
Notice: /Stage[main]/Test_rabbitmq::Server::Vhosts/Rabbitmq_vhost[test_tags_and_desc_stream_no_queue_type-temp]/ensure: removed

Vhost list:

# rabbitmqctl list_vhosts name,description,default_queue_type,tags -s | grep 'temp'
test_desc_no_tags_classic-temp	Vhost with a description but no tags, default queue type classic	classic	[]
test_desc_no_tags_quorum-temp	Vhost with a description but no tags, default queue type quorum	quorum	[]
test_no_desc_or_tags_classic-temp		classic	[]
test_no_desc_or_tags_quorum-temp		quorum	[]
test_tags_and_desc_classic-temp	Vhost with a description and tags, default queue type classic	classic	[tag1, tag2]
test_desc_no_tags_stream-temp	Vhost with a description but no tags, default queue type stream	stream	[]
test_tags_and_desc_quorum-temp	Vhost with an amended description and tags, default queue type quorum	quorum	[tag1, tag2]
test_tags_and_desc_stream-temp	Vhost with a description and tags, default queue type stream	stream	[tag1, tag2]
test_no_desc_or_tags_stream-temp		stream	[]

[wyardley]

If you get the local setup and pre-commit checks setup, will probably help with some of the roundtrips.
With that current failure about reference.md being outdated, you need to run the rake command to update it after your changes - I think bundle exec rake strings:generate:reference

[wyardley]

Looks good to me from what I can see 👍 Thanks for all the hard work on this.

It would be nice to have an acceptance test for this, but I'm guessing the version supported currently doesn't support this feature anyway.

[jimmybigcommerce]

@wyardley Thanks for your help with this mate! Are you cool if I cut a release PR for this? Should it be 13.2.0?

[wyardley]

Are you cool if I cut a release PR for this? Should it be 13.2.0?

Yes please, and yes. You've tested your recent changes on actual infrastructure, right?

[jimmybigcommerce]

Are you cool if I cut a release PR for this? Should it be 13.2.0?

Yes please, and yes. You've tested your recent changes on actual infrastructure, right?

👍 Yes, it's been tested thoroughly on real infra. Once the release is cut, we we roll out everywhere. If we encounter any unforseen issues, I'll immediately create an issue/submit a patch in this repo, however so far it's been rock solid.