Merge "Add a description field for resource plan"

karbor/api/v1/plans.py

@@ -77,6 +77,7 @@ class PlanViewBuilder(common.ViewBuilder):
             'plan': {
                 'id': plan.get('id'),
                 'name': plan.get('name'),
+                'description': plan.get('description'),
                 'resources': plan.get('resources'),
                 'provider_id': plan.get('provider_id'),
                 'status': plan.get('status'),
@@ -263,6 +264,7 @@ class PlansController(wsgi.Controller):
 
         plan_properties = {
             'name': plan.get('name', None),
+            'description': plan.get('description', None),
             'provider_id': plan.get('provider_id', None),
             'project_id': context.project_id,
             'status': constants.PLAN_STATUS_SUSPENDED,

karbor/db/sqlalchemy/migrate_repo/versions/001_karbor_init.py

@@ -43,6 +43,7 @@ def define_tables(meta):
         Column('deleted', Boolean),
         Column('id', String(36), primary_key=True, nullable=False),
         Column('name', String(length=255)),
+        Column('description', String(length=255)),
         Column('provider_id', String(length=36)),
         Column('project_id', String(length=255)),
         Column('status', String(length=64)),

karbor/db/sqlalchemy/models.py

@@ -149,6 +149,7 @@ class Plan(BASE, KarborBase):
     __tablename__ = 'plans'
     id = Column(String(36), primary_key=True)
     name = Column(String(255))
+    description = Column(String(255))
     provider_id = Column(String(36))
     project_id = Column(String(255))
     status = Column(String(64))

karbor/objects/plan.py

@@ -37,6 +37,7 @@ class Plan(base.KarborPersistentObject, base.KarborObject,
     fields = {
         'id': fields.UUIDField(),
         'name': fields.StringField(),
+        'description': fields.StringField(nullable=True),
         'provider_id': fields.UUIDField(),
         'project_id': fields.UUIDField(),
         'status': fields.StringField(nullable=True),

karbor/tests/unit/api/v1/test_plans.py

@@ -25,6 +25,7 @@ from karbor.tests.unit.api import fakes
 CONF = cfg.CONF
 
 DEFAULT_NAME = 'My 3 tier application'
+DEFAULT_DESCRIPTION = 'My 3 tier application protection plan'
 DEFAULT_PROVIDER_ID = 'efc6a88b-9096-4bb6-8634-cda182a6e12a'
 DEFAULT_PROJECT_ID = '39bb894794b741e982bd26144d2949f6'
 DEFAULT_RESOURCES = [{'id': 'key1',
@@ -57,6 +58,7 @@ class PlanApiTest(base.TestCase):
     def test_plan_create_InvalidProviderId(self):
         plan = self._plan_in_request_body(
             name=DEFAULT_NAME,
+            description=DEFAULT_DESCRIPTION,
             provider_id="",
             status=constants.PLAN_STATUS_SUSPENDED,
             project_id=DEFAULT_PROJECT_ID,
@@ -69,6 +71,7 @@ class PlanApiTest(base.TestCase):
     def test_plan_create_InvalidResources(self):
         plan = self._plan_in_request_body(
             name=DEFAULT_NAME,
+            description=DEFAULT_DESCRIPTION,
             provider_id=DEFAULT_PROVIDER_ID,
             status=constants.PLAN_STATUS_SUSPENDED,
             project_id=DEFAULT_PROJECT_ID,
@@ -110,6 +113,7 @@ class PlanApiTest(base.TestCase):
     def test_plan_update_InvalidResources(self):
         plan = self._plan_in_request_body(
             name=DEFAULT_NAME,
+            description=DEFAULT_DESCRIPTION,
             provider_id=DEFAULT_PROVIDER_ID,
             status=constants.PLAN_STATUS_SUSPENDED,
             project_id=DEFAULT_PROJECT_ID,
@@ -169,6 +173,7 @@ class PlanApiTest(base.TestCase):
             self, mock_plan_get, mock_check_policy):
         plan = self._plan_in_request_body(
             name=DEFAULT_NAME,
+            description=DEFAULT_DESCRIPTION,
             provider_id=DEFAULT_PROVIDER_ID,
             status=constants.PLAN_STATUS_STARTED,
             project_id=DEFAULT_PROJECT_ID,
@@ -182,6 +187,7 @@ class PlanApiTest(base.TestCase):
                           body)
 
     def _plan_in_request_body(self, name=DEFAULT_NAME,
+                              description=DEFAULT_DESCRIPTION,
                               provider_id=DEFAULT_PROVIDER_ID,
                               status=constants.PLAN_STATUS_SUSPENDED,
                               project_id=DEFAULT_PROJECT_ID,
@@ -189,6 +195,7 @@ class PlanApiTest(base.TestCase):
                               parameters=DEFAULT_PARAMETERS):
         plan_req = {
             'name': name,
+            'description': description,
             'provider_id': provider_id,
             'status': status,
             'project_id': project_id,

karbor/tests/unit/db/test_models.py

@@ -401,6 +401,7 @@ class PlanDbTestCase(base.TestCase):
 
     fake_plan = {
         'name': 'My 3 tier application',
+        'description': 'My 3 tier application protection plan',
         'provider_id': 'efc6a88b-9096-4bb6-8634-cda182a6e12a',
         'status': 'suspended',
         'project_id': '39bb894794b741e982bd26144d2949f6',
@@ -410,6 +411,7 @@ class PlanDbTestCase(base.TestCase):
 
     fake_plan_with_resources = {
         'name': 'My 3 tier application',
+        'description': 'My 3 tier application protection plan',
         'provider_id': 'efc6a88b-9096-4bb6-8634-cda182a6e12a',
         'status': 'suspended',
         'project_id': '39bb894794b741e982bd26144d2949f6',