Merge "Add a description field for resource plan"

karborclient/tests/unit/v1/test_plans.py

@@ -48,7 +48,7 @@ class PlansTest(base.TestCaseShell):
     @mock.patch('karborclient.common.http.HTTPClient.json_request')
     def test_create_plan(self, mock_request):
         mock_request.return_value = mock_request_return
-        cs.plans.create('Plan name', 'provider_id', '', "")
+        cs.plans.create('Plan name', 'provider_id', '', "", '')
         mock_request.assert_called_with(
             'POST',
             '/plans',
@@ -56,7 +56,8 @@ class PlansTest(base.TestCaseShell):
                 'plan': {'provider_id': 'provider_id',
                          'name': 'Plan name',
                          'resources': '',
-                         'parameters': ''}},
+                         'parameters': '',
+                         'description': ''}},
             headers={})
 
     @mock.patch('karborclient.common.http.HTTPClient.raw_request')

karborclient/v1/plans.py

@@ -24,8 +24,10 @@ class Plan(base.Resource):
 class PlanManager(base.ManagerWithFind):
     resource_class = Plan
 
-    def create(self, name, provider_id, resources, parameters):
+    def create(self, name, provider_id, resources, parameters,
+               description=None):
         body = {'plan': {'name': name,
+                         'description': description,
                          'provider_id': provider_id,
                          'resources': resources,
                          'parameters': parameters

karborclient/v1/shell.py

@@ -94,7 +94,7 @@ def do_plan_list(cs, args):
                           limit=args.limit, sort_key=args.sort_key,
                           sort_dir=args.sort_dir, sort=args.sort)
 
-    key_list = ['Id', 'Name', 'Provider id', 'Status']
+    key_list = ['Id', 'Name', 'Description', 'Provider id', 'Status']
 
     if args.sort_key or args.sort_dir or args.sort:
         sortby_index = None
@@ -129,12 +129,15 @@ def do_plan_list(cs, args):
            'resource_id: limit the parameters to a specific resource. '
            'Other keys and values: according to provider\'s protect schema.'
            )
+@utils.arg('--description',
+           metavar='<description>',
+           help='The description of a plan.')
 def do_plan_create(cs, args):
     """Create a plan."""
     plan_resources = _extract_resources(args)
     plan_parameters = _extract_parameters(args)
     plan = cs.plans.create(args.name, args.provider_id, plan_resources,
-                           plan_parameters)
+                           plan_parameters, description=args.description)
     utils.print_dict(plan.to_dict())