From fb94d56227a55a9bba5ed3de36ab8f01f2b4451f Mon Sep 17 00:00:00 2001 From: Saravanan KR Date: Fri, 18 Aug 2017 18:49:13 +0530 Subject: [PATCH] Add a warning message for the list of unused parameters Having parameters which are unused may harm sometimes, in case if a parameters is deprecated in one cycle and removed in the following and user didn't migrate to the new parameter. But this also adds the list of parameters which are valid but currently not used (since the related service is disabled). This patch adds a warning message to the user to know the list of parameters which are not used in the current deployment plan. Change-Id: Id59a016c73fc4847c4ba507b3ec2492eee7234a0 --- .../notes/unused-param-warning-c5717c129adf543a.yaml | 5 +++++ tripleoclient/workflows/parameters.py | 9 +++++++++ 2 files changed, 14 insertions(+) create mode 100644 releasenotes/notes/unused-param-warning-c5717c129adf543a.yaml diff --git a/releasenotes/notes/unused-param-warning-c5717c129adf543a.yaml b/releasenotes/notes/unused-param-warning-c5717c129adf543a.yaml new file mode 100644 index 000000000..e105e37dc --- /dev/null +++ b/releasenotes/notes/unused-param-warning-c5717c129adf543a.yaml @@ -0,0 +1,5 @@ +--- +features: + - | + Added a warning message to provide the list of parameters which are + not used in a deployment plan, but provided by the user via environments. diff --git a/tripleoclient/workflows/parameters.py b/tripleoclient/workflows/parameters.py index 54b29adbe..e54989fa1 100644 --- a/tripleoclient/workflows/parameters.py +++ b/tripleoclient/workflows/parameters.py @@ -117,14 +117,23 @@ def check_deprecated_parameters(clients, container): messages = base.wait_for_messages(workflow_client, ws, execution, 120) deprecated_params = [] + unused_params = [] for message in messages: if message['status'] == 'SUCCESS': for param in message.get('deprecated', []): if param.get('user_defined'): deprecated_params.append(param['parameter']) + unused_params = message.get('unused', []) if deprecated_params: print('WARNING: Following parameters are deprecated and still ' 'defined. Deprecated parameters will be removed soon!') print('\n'.join([' {}'.format(param) for param in deprecated_params])) + + if unused_params: + print('WARNING: Following parameters are defined but not used in ' + 'plan. Could be possible that parameter is valid but ' + 'currently not used.') + print('\n'.join([' {}'.format(param) + for param in unused_params]))