From 64f22889c8936f19dacb720d1d83321b0fd0683d Mon Sep 17 00:00:00 2001 From: Takashi Kajinami Date: Tue, 23 Apr 2024 18:18:04 +0900 Subject: [PATCH] Remove trove::api::service_credentials The class was deprecated during the previous cycle[1] for renaming to the trove::service_credentials class. [1] 80a89f49a0f44d8deba8f50e6582d9acafac7cdd Change-Id: Ica9f192337b654200024acc3b3fefb0dcab6e57d --- examples/site.pp | 2 +- manifests/api.pp | 3 - manifests/api/service_credentials.pp | 62 ------------- ...-service_credentials-9faa76a3466ab8d6.yaml | 5 ++ .../trove_api_service_credentials_spec.rb | 90 ------------------- spec/classes/trove_api_spec.rb | 4 - 6 files changed, 6 insertions(+), 160 deletions(-) delete mode 100644 manifests/api/service_credentials.pp create mode 100644 releasenotes/notes/remove-api-service_credentials-9faa76a3466ab8d6.yaml delete mode 100644 spec/classes/trove_api_service_credentials_spec.rb diff --git a/examples/site.pp b/examples/site.pp index f2fa3f0e..750b6ddb 100644 --- a/examples/site.pp +++ b/examples/site.pp @@ -21,7 +21,7 @@ class { 'trove': default_transport_url => 'rabbit://trove:an_even_bigger_secret@10.0.0.1:5672/trove', } -class { 'trove::api::service_credentials': +class { 'trove::service_credentials': password => 'verysecrete', } diff --git a/manifests/api.pp b/manifests/api.pp index 70387403..2bc75ef6 100644 --- a/manifests/api.pp +++ b/manifests/api.pp @@ -128,9 +128,6 @@ class trove::api( include trove::deps include trove::db include trove::db::sync - if (!defined(Class[trove::service_credentials])) { - include trove::api::service_credentials - } # basic service config trove_config { diff --git a/manifests/api/service_credentials.pp b/manifests/api/service_credentials.pp deleted file mode 100644 index 9836572d..00000000 --- a/manifests/api/service_credentials.pp +++ /dev/null @@ -1,62 +0,0 @@ -# The trove::api::service_credentials class helps configure auth settings -# -# == Parameters -# -# [*password*] -# (required) the keystone password for trove services -# -# [*auth_url*] -# (optional) the keystone public endpoint -# Defaults to 'http://127.0.0.1:5000' -# -# [*region_name*] -# (optional) the keystone region of this node -# Defaults to 'RegionOne' -# -# [*username*] -# (optional) the keystone user for trove services -# Defaults to 'trove' -# -# [*project_name*] -# (optional) the keystone tenant name for trove services -# Defaults to 'services' -# -# [*project_domain_name*] -# (optional) the keystone project domain name for trove services -# Defaults to 'Default' -# -# [*user_domain_name*] -# (optional) the keystone user domain name for trove services -# Defaults to 'Default' -# -# [*system_scope*] -# (optional) Scope for system operations. -# Defaults to $facts['os_service_default'] -# -class trove::api::service_credentials ( - $password, - $auth_url = 'http://127.0.0.1:5000', - $region_name = 'RegionOne', - $username = 'trove', - $project_name = 'services', - $project_domain_name = 'Default', - $user_domain_name = 'Default', - $system_scope = $facts['os_service_default'], -) { - - include trove::deps - - warning("The trove::api::service_credentials class is deprecated. \ -Use the trove::service_credentials class instead.") - - class { 'trove::service_credentials': - password => $password, - auth_url => $auth_url, - region_name => $region_name, - username => $username, - project_name => $project_name, - project_domain_name => $project_domain_name, - user_domain_name => $user_domain_name, - system_scope => $system_scope, - } -} diff --git a/releasenotes/notes/remove-api-service_credentials-9faa76a3466ab8d6.yaml b/releasenotes/notes/remove-api-service_credentials-9faa76a3466ab8d6.yaml new file mode 100644 index 00000000..e495ca28 --- /dev/null +++ b/releasenotes/notes/remove-api-service_credentials-9faa76a3466ab8d6.yaml @@ -0,0 +1,5 @@ +--- +upgrade: + - | + The deprecated ``trove::api::service_credentials`` class has been removed. + Use the ``trove::service_credentials`` class instead. diff --git a/spec/classes/trove_api_service_credentials_spec.rb b/spec/classes/trove_api_service_credentials_spec.rb deleted file mode 100644 index ea28babd..00000000 --- a/spec/classes/trove_api_service_credentials_spec.rb +++ /dev/null @@ -1,90 +0,0 @@ -# -# Copyright (C) 2020 Red Hat, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. You may obtain -# a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -require 'spec_helper' - -describe 'trove::api::service_credentials' do - - shared_examples 'trove::api::service_credentials' do - - let :params do - { - :password => 'verysecrete' - } - end - - context 'with default parameters' do - it 'configures service credentials with default parameters' do - is_expected.to contain_trove_config('service_credentials/auth_url').with_value('http://127.0.0.1:5000') - is_expected.to contain_trove_config('service_credentials/username').with_value('trove') - is_expected.to contain_trove_config('service_credentials/password').with_value('verysecrete').with_secret(true) - is_expected.to contain_trove_config('service_credentials/project_name').with_value('services') - is_expected.to contain_trove_config('service_credentials/region_name').with_value('RegionOne') - is_expected.to contain_trove_config('service_credentials/user_domain_name').with_value('Default') - is_expected.to contain_trove_config('service_credentials/project_domain_name').with_value('Default') - is_expected.to contain_trove_config('service_credentials/system_scope').with_value('') - end - end - - context 'when overriding defaults' do - before do - params.merge!({ - :auth_url => 'http://localhost:5000', - :username => 'trove2', - :project_name => 'services2', - :region_name => 'RegionTwo', - :user_domain_name => 'MyDomain', - :project_domain_name => 'MyDomain', - }) - end - - it 'configures service credentials with default parameters' do - is_expected.to contain_trove_config('service_credentials/auth_url').with_value('http://localhost:5000') - is_expected.to contain_trove_config('service_credentials/username').with_value('trove2') - is_expected.to contain_trove_config('service_credentials/project_name').with_value('services2') - is_expected.to contain_trove_config('service_credentials/region_name').with_value('RegionTwo') - is_expected.to contain_trove_config('service_credentials/user_domain_name').with_value('MyDomain') - is_expected.to contain_trove_config('service_credentials/project_domain_name').with_value('MyDomain') - is_expected.to contain_trove_config('service_credentials/system_scope').with_value('') - end - end - - context 'when system_scope is set' do - before do - params.merge!( - :system_scope => 'all' - ) - end - it 'configures system-scoped credential' do - is_expected.to contain_trove_config('service_credentials/project_domain_name').with_value('') - is_expected.to contain_trove_config('service_credentials/project_name').with_value('') - is_expected.to contain_trove_config('service_credentials/system_scope').with_value('all') - end - end - end - - on_supported_os({ - :supported_os => OSDefaults.get_supported_os - }).each do |os,facts| - let (:facts) do - facts.merge!(OSDefaults.get_facts()) - end - - context "on #{os}" do - it_configures 'trove::api::service_credentials' - end - end - -end diff --git a/spec/classes/trove_api_spec.rb b/spec/classes/trove_api_spec.rb index d4679214..14e45ccc 100644 --- a/spec/classes/trove_api_spec.rb +++ b/spec/classes/trove_api_spec.rb @@ -32,9 +32,6 @@ describe 'trove::api' do let :pre_condition do "class { 'trove': } - class { 'trove::api::service_credentials': - password => 'verysectrete', - } class { 'trove::keystone::authtoken': password => 'a_big_secret', }" @@ -45,7 +42,6 @@ describe 'trove::api' do is_expected.to contain_class('trove::db') is_expected.to contain_class('trove::db::sync') is_expected.to contain_class('trove::params') - is_expected.to contain_class('trove::api::service_credentials') end it 'installs trove-api package and service' do