differentiating required and optional arguments in the help text for …

samples/vmc/helpers/sample_cli.py

@@ -0,0 +1,48 @@
+"""
+* *******************************************************
+* Copyright (c) VMware, Inc. 2019. All Rights Reserved.
+* SPDX-License-Identifier: MIT
+* *******************************************************
+*
+* DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+* WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+* EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+* WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+* NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+"""
+
+__author__ = 'VMware, Inc.'
+__copyright__ = 'Copyright 2019 VMware, Inc. All rights reserved.'
+
+import argparse
+
+"""
+Builds a standard argument parser with required and optional argument groups
+
+Most of the VMC samples require these three standard required arguments.
+If any of these arguments are not required, then build your own parser
+
+--refresh_token
+--org_id
+--sddc_id
+
+"""
+parser = argparse.ArgumentParser()
+
+required_args = parser.add_argument_group(
+        'required arguments')
+optional_args = parser.add_argument_group(
+        'optional arguments')
+
+required_args.add_argument(
+        '--refresh_token',
+        required=True,
+        help='Refresh token obtained from CSP')
+required_args.add_argument(
+        '--org_id',
+        required=True,
+        help='Orgization ID')
+required_args.add_argument(
+        '--sddc_id',
+        required=True,
+        help='SDDC ID')

samples/vmc/networks_nsxt/cgw_firewall_crud.py

@@ -16,8 +16,8 @@
 __author__ = 'VMware, Inc.'
 __vcenter_version__ = '6.8.0+'
 
-import argparse
 import requests
+from samples.vmc.helpers.sample_cli import parser
 from com.vmware.nsx_policy_client_for_vmc import create_nsx_policy_client_for_vmc
 from com.vmware.nsx_policy.model_client import IPAddressExpression
 from com.vmware.nsx_policy.model_client import Group
@@ -36,21 +36,6 @@ class NSXPolicyCGWFirewall(object):
     """
 
     def __init__(self):
-        parser = argparse.ArgumentParser(
-            formatter_class=argparse.ArgumentDefaultsHelpFormatter)
-
-        parser.add_argument('--refresh_token',
-                            required=True,
-                            help='Refresh token obtained from CSP')
-
-        parser.add_argument('--org_id',
-                            required=True,
-                            help='Orgization ID')
-
-        parser.add_argument('--sddc_id',
-                            required=True,
-                            help='Sddc ID')
-
         args = parser.parse_args()
 
         self.nsx_client = create_nsx_policy_client_for_vmc(

samples/vmc/networks_nsxt/dfw_firewall_crud.py

@@ -16,8 +16,8 @@
 __author__ = 'VMware, Inc.'
 __vcenter_version__ = '6.8.0+'
 
-import argparse
 import requests
+from samples.vmc.helpers.sample_cli import parser
 from com.vmware.nsx_policy_client_for_vmc import create_nsx_policy_client_for_vmc
 from com.vmware.nsx_policy.model_client import IPAddressExpression
 from com.vmware.nsx_policy.model_client import Group
@@ -38,21 +38,6 @@ class NSXPolicyDFWFirewall(object):
     """
 
     def __init__(self):
-        parser = argparse.ArgumentParser(
-            formatter_class=argparse.ArgumentDefaultsHelpFormatter)
-
-        parser.add_argument('--refresh_token',
-                            required=True,
-                            help='Refresh token obtained from CSP')
-
-        parser.add_argument('--org_id',
-                            required=True,
-                            help='Orgization ID')
-
-        parser.add_argument('--sddc_id',
-                            required=True,
-                            help='Sddc ID')
-
         args = parser.parse_args()
 
         self.nsx_client = create_nsx_policy_client_for_vmc(

samples/vmc/networks_nsxt/hello_world.py

@@ -15,9 +15,8 @@
 
 __author__ = 'VMware, Inc.'
 
-import argparse
 import pprint
-
+from samples.vmc.helpers.sample_cli import parser
 from com.vmware.nsx_policy_client_for_vmc import (
     create_nsx_policy_client_for_vmc)
 
@@ -33,20 +32,6 @@ class AuthExample(object):
     """
 
     def __init__(self):
-        parser = argparse.ArgumentParser(
-            formatter_class=argparse.ArgumentDefaultsHelpFormatter)
-        parser.add_argument('-r', '--refresh-token',
-                            required=True,
-                            help='VMware Cloud API refresh token')
-
-        parser.add_argument('-o', '--org-id',
-                            required=True,
-                            help='Organization identifier.')
-
-        parser.add_argument('-s', '--sddc-id',
-                            required=True,
-                            help='Sddc Identifier.')
-
         args = parser.parse_args()
 
         self.org_id = args.org_id

samples/vmc/networks_nsxt/l3_vpn_crud.py

@@ -15,7 +15,7 @@
 
 __author__ = 'VMware, Inc.'
 
-import argparse
+from samples.vmc.helpers.sample_cli import parser, required_args
 from com.vmware.nsx_policy_client_for_vmc import create_nsx_policy_client_for_vmc
 from vmware.vapi.bindings.struct import PrettyPrinter as NsxPrettyPrinter
 from com.vmware.nsx_policy.model_client import ApiError
@@ -39,26 +39,11 @@ class NSXPolicyL3VPN(object):
     """
 
     def __init__(self):
-        parser = argparse.ArgumentParser(
-            formatter_class=argparse.ArgumentDefaultsHelpFormatter)
-
-        parser.add_argument('--refresh_token',
-                            required=True,
-                            help='Refresh token obtained from CSP')
-
-        parser.add_argument('--org_id',
-                            required=True,
-                            help='Orgization ID')
-
-        parser.add_argument('--sddc_id',
-                            required=True,
-                            help='Sddc ID')
-
-        parser.add_argument('--remote_endpoint_public_ip',
+        required_args.add_argument('--remote_endpoint_public_ip',
                             required=True,
                             help='L3 VPN Remote end point\'s public ip')
 
-        parser.add_argument('--passphrase',
+        required_args.add_argument('--passphrase',
                             required=True,
                             help='Passphrase used for VPN')
 

samples/vmc/networks_nsxt/nat_crud.py

@@ -16,8 +16,9 @@
 __author__ = 'VMware, Inc.'
 __vcenter_version__ = '6.8.1+'
 
-import argparse
 import requests
+
+from samples.vmc.helpers.sample_cli import parser
 from com.vmware.nsx_policy_client_for_vmc import create_nsx_policy_client_for_vmc
 from com.vmware.nsx_vmc_app_client_for_vmc import create_nsx_vmc_app_client_for_vmc
 from com.vmware.nsx_vmc_app.model_client import PublicIp
@@ -36,21 +37,6 @@ class NSXPolicyNAT(object):
     """
 
     def __init__(self):
-        parser = argparse.ArgumentParser(
-            formatter_class=argparse.ArgumentDefaultsHelpFormatter)
-
-        parser.add_argument('--refresh_token',
-                            required=True,
-                            help='Refresh token obtained from CSP')
-
-        parser.add_argument('--org_id',
-                            required=True,
-                            help='Orgization ID')
-
-        parser.add_argument('--sddc_id',
-                            required=True,
-                            help='Sddc ID')
-
         args = parser.parse_args()
 
         self.nsx_client = create_nsx_policy_client_for_vmc(

samples/vmc/networks_nsxt/security_group_create.py

@@ -15,10 +15,11 @@
 __author__ = 'VMware, Inc'
 __vcenter_version__ = 'VMware Cloud on AWS'
 
-import argparse
 import random
 
 import requests
+
+from samples.vmc.helpers.sample_cli import parser, required_args, optional_args
 from com.vmware.nsx_policy.infra_client import Domains
 from com.vmware.nsx_policy.model_client import (Expression, Group,
                                                 IPAddressExpression)
@@ -35,34 +36,19 @@
 Sample Prerequisites:
     - SDDC deployed in VMware Cloud on AWS
 """
-parser = argparse.ArgumentParser(
-    formatter_class=argparse.ArgumentDefaultsHelpFormatter)
-
-parser.add_argument('--refresh_token',
-                    required=True,
-                    help='Refresh token obtained from CSP')
-
-parser.add_argument('--org_id',
-                    required=True,
-                    help='Orgization ID')
-
-parser.add_argument('--sddc_id',
-                    required=True,
-                    help='Sddc ID')
-
-parser.add_argument('--gateway_type',
+optional_args.add_argument('--gateway_type',
                     default='mgw',
                     help='Gateway type. Either mgw or cgw')
 
-parser.add_argument('--name',
+required_args.add_argument('--name',
                     required=True,
                     help='Name of the security group to be created')
 
-parser.add_argument('--ip_address',
+optional_args.add_argument('--ip_address',
                     default='172.31.0.0/24',
                     help='IP address for the expression')
 
-parser.add_argument('--group_id',
+optional_args.add_argument('--group_id',
                     help='ID of the group. A random ID will be used by default')
 
 args = parser.parse_args()

samples/vmc/networks_nsxt/security_group_delete.py

@@ -16,10 +16,10 @@
 __author__ = 'VMware, Inc'
 __vcenter_version__ = 'VMware Cloud on AWS'
 
-import argparse
 import random
 
 import requests
+from samples.vmc.helpers.sample_cli import parser, optional_args
 from com.vmware.nsx_policy.infra_client import Domains
 from com.vmware.nsx_policy.model_client import (Expression, Group,
                                                 IPAddressExpression)
@@ -39,26 +39,11 @@
     - SDDC deployed in VMware Cloud on AWS
     - A NSX-T security group
 """
-parser = argparse.ArgumentParser(
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
-
-parser.add_argument('--refresh_token',
-                    required=True,
-                    help='Refresh token obtained from CSP')
-
-parser.add_argument('--org_id',
-                    required=True,
-                    help='Orgization ID')
-
-parser.add_argument('--sddc_id',
-                    required=True,
-                    help='Sddc ID')
-
-parser.add_argument('--gateway_type',
+optional_args.add_argument('--gateway_type',
                     default='mgw',
                     help='Gateway type. Either mgw or cgw')
 
-parser.add_argument('--group_id',
+optional_args.add_argument('--group_id',
                     help='ID of the group to be deleted')
 
 args = parser.parse_args()

samples/vmc/networks_nsxt/security_group_list.py

@@ -17,8 +17,8 @@
 __vcenter_version__ = 'VMware Cloud on AWS'
 
 import requests
-import argparse
 
+from samples.vmc.helpers.sample_cli import parser, optional_args
 from com.vmware.nsx_policy.infra_client import Domains
 from com.vmware.nsx_policy_client_for_vmc import create_nsx_policy_client_for_vmc
 from vmware.vapi.bindings.struct import PrettyPrinter
@@ -34,22 +34,7 @@
 Sample Prerequisites:
     - SDDC deployed in VMware Cloud on AWS
 """
-parser = argparse.ArgumentParser(
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
-
-parser.add_argument('--refresh_token',
-                    required=True,
-                    help='Refresh token obtained from CSP')
-
-parser.add_argument('--org_id',
-                    required=True,
-                    help='Orgization ID')
-
-parser.add_argument('--sddc_id',
-                    required=True,
-                    help='Sddc ID')
-
-parser.add_argument('--gateway_type',
+optional_args.add_argument('--gateway_type',
                     default='mgw',
                     help='Gateway type. Either mgw or cgw')
 

samples/vmc/networks_nsxt/security_group_update.py

@@ -16,10 +16,10 @@
 __author__ = 'VMware, Inc'
 __vcenter_version__ = 'VMware Cloud on AWS'
 
-import argparse
 import random
 
 import requests
+from samples.vmc.helpers.sample_cli import parser, required_args, optional_args
 from com.vmware.nsx_policy.infra_client import Domains
 from com.vmware.nsx_policy.model_client import (Expression, Group,
                                                 IPAddressExpression)
@@ -40,29 +40,14 @@
     - SDDC deployed in VMware Cloud on AWS
     - A NSX-T security group
 """
-parser = argparse.ArgumentParser(
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
-
-parser.add_argument('--refresh_token',
-                    required=True,
-                    help='Refresh token obtained from CSP')
-
-parser.add_argument('--org_id',
-                    required=True,
-                    help='Orgization ID')
-
-parser.add_argument('--sddc_id',
-                    required=True,
-                    help='Sddc ID')
-
-parser.add_argument('--gateway_type',
+optional_args.add_argument('--gateway_type',
                     default='mgw',
                     help='Gateway type. Either mgw or cgw')
 
-parser.add_argument('--group_id',
+optional_args.add_argument('--group_id',
                     help='ID of the group to be updated')
 
-parser.add_argument('--name',
+required_args.add_argument('--name',
                     required=True,
                     help='New name of the security group to be updated')