Wrong help message of heal CLI

Bug #1954744 reported by renu rani
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
tacker
Fix Released
Undecided
Pooja Singla

Bug Description

Following message is displayed in -h of tacker-client Heal, but VNF ID mentioned after the VNFC ID as described in the help below, the command gets failed.

In a normal situation, it is needed to specify the option of --vnfc-instance after specifying the VNF ID.

Problem:
$ openstack vnflcm heal -h
usage: openstack vnflcm heal [-h] [--cause CAUSE]
                             [--vnfc-instance <vnfc-instance-id> [<vnfc-instance-id> ...]]
                             <vnf-instance>
Heal VNF Instance
positional arguments:
  <vnf-instance> VNF instance ID to heal
optional arguments:
  -h, --help show this help message and exit
  --cause CAUSE Specify the reason why a healing procedure is
                        required.
  --vnfc-instance <vnfc-instance-id> [<vnfc-instance-id> ...]
                        List of VNFC instances requiring a healing action.
  --additional-param [<additionalParams>]
                        User defined data for the VNF package

This command is provided by the python-tackerclient plugin.

renu rani (renur)
description: updated
Pooja Singla (psingla)
Changed in tacker:
assignee: nobody → Pooja Singla (psingla)
status: New → In Progress
renu rani (renur)
description: updated
Revision history for this message
Pooja Singla (psingla) wrote :

I am working on fix of this bug.

Revision history for this message
Pooja Singla (psingla) wrote :

Usage message of all cli commands are constructed by argument parser. It includes optional parameter first and insert positional parameter at end.
Heal cli is a special case in which optional parameter is coming at end and positional parameter is coming before optional. Therefore for fixing of this bug we have set usage parameter of argument parser in heal cli.

Gerrit review : https://review.opendev.org/c/openstack/python-tackerclient/+/821819

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to tacker (master)

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/tacker/+/829878

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to tacker (master)

Reviewed: https://review.opendev.org/c/openstack/tacker/+/829878
Committed: https://opendev.org/openstack/tacker/commit/7d659b18700dd9a14875e313058add0bdcb8b3fe
Submitter: "Zuul (22348)"
Branch: master

commit 7d659b18700dd9a14875e313058add0bdcb8b3fe
Author: Pooja Singla <email address hidden>
Date: Fri Feb 18 16:57:41 2022 +0530

    Help usage message of heal cli modified

    Updated cli doc for help cli usage message.

    Closes-Bug: #1954744
    Change-Id: Ifce4d8ceb40e9d00eb1b8715b26aac8a5546bd9b

Changed in tacker:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/tacker 7.0.0.0rc1

This issue was fixed in the openstack/tacker 7.0.0.0rc1 release candidate.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/python-tackerclient 1.11.0

This issue was fixed in the openstack/python-tackerclient 1.11.0 release.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/python-tackerclient 1.10.1

This issue was fixed in the openstack/python-tackerclient 1.10.1 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.