LITE-27243 Limited allowed number of DBs per Account

maxipavlovic · maxipavlovic · commit 7169ad67d2bc · 2023-04-18T18:33:11.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -23,3 +23,8 @@
     * Added workload description and external link to docs
 * 0.3.2: Backend dependencies are bumped
 * 0.3.3: Removed limit of returned DB objects in DB List API
+* 0.4.0: Enhancements
+  * DB Owner is shown in Databases API and Administrative UI
+  * Max number of allowed DB per account can now be set via `DB_MAX_ALLOWED_NUMBER_PER_ACCOUNT` env variable 
+  * Frontend changes:
+    * 400 and 422 server errors are better handled
diff --git a/dbaas/extension.json b/dbaas/extension.json
@@ -1,9 +1,9 @@
 {
   "name": "DBaaS",
   "description": "On-demand provisioning of cloud-based database storages as a service.",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "audience": ["reseller", "distributor", "vendor"],
-  "readme_url": "https://github.com/cloudblue/connect-extension-dbaas/blob/0.3.3/README.md",
-  "changelog_url": "https://github.com/cloudblue/connect-extension-dbaas/blob/0.3.3/CHANGELOG.md",
+  "readme_url": "https://github.com/cloudblue/connect-extension-dbaas/blob/0.4.0/README.md",
+  "changelog_url": "https://github.com/cloudblue/connect-extension-dbaas/blob/0.4.0/CHANGELOG.md",
   "icon": "googleExtensionBaseline"
 }
diff --git a/dbaas/services.py b/dbaas/services.py
@@ -88,6 +88,8 @@ async def create(
         if tech_contact['id'] != context.user_id:
             actor = await cls._get_actor(context, client)
 
+        await cls._validate_allowed_db_number_per_account(db, context, config)
+
         prepared_db_doc = cls._prepare_db_document(data, context, region_doc, tech_contact, actor)
         inserted_db_doc = await cls._create_db_document(
             prepared_db_doc, db, context, client, config,
@@ -355,6 +357,25 @@ async def _get_validated_tech_contact(
 
         return tech_contact
 
+    @classmethod
+    async def _validate_allowed_db_number_per_account(
+        cls,
+        db: AsyncIOMotorDatabase,
+        context: Context,
+        config: dict,
+    ):
+        if is_admin_context(context):
+            return
+
+        max_allowed_number_of_db = int(config.get('DB_MAX_ALLOWED_NUMBER_PER_ACCOUNT', 50))
+
+        db_coll = db[cls.COLLECTION]
+        current_number_of_db = await db_coll.count_documents(cls._default_query(context))
+        if current_number_of_db + 1 > max_allowed_number_of_db:
+            raise ValueError(
+                f'Max allowed number of databases is reached: {max_allowed_number_of_db}.',
+            )
+
     @classmethod
     async def _get_actor(cls, context: Context, client: AsyncConnectClient) -> dict:
         actor = await ConnectAccountUser.retrieve(context.account_id, context.user_id, client)
@@ -461,7 +482,7 @@ def _db_collection_from_db_session(cls, db_session, config):
 
     @staticmethod
     def _generate_id(config: dict) -> str:
-        id_random_length = config.get('DB_ID_RANDOM_LENGTH', 5)
+        id_random_length = int(config.get('DB_ID_RANDOM_LENGTH', 5))
         id_prefix = config.get('DB_ID_PREFIX', 'DBPG')
 
         random_part = ''.join(random.choice(string.digits) for _ in range(id_random_length))
diff --git a/dbaas/static/7cace99224d3d55c5b00.js b/dbaas/static/7cace99224d3d55c5b00.js
diff --git a/dbaas/static/7cace99224d3d55c5b00.js.LICENSE.txt b/dbaas/static/7cace99224d3d55c5b00.js.LICENSE.txt
diff --git a/dbaas/static/9606f1a55fe0a2d35893.js b/dbaas/static/9606f1a55fe0a2d35893.js
diff --git a/dbaas/static/index.html b/dbaas/static/index.html
@@ -1 +1 @@
-<html><head><title>Lorem ipsum</title><link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700|Roboto+Mono:400,500|Material+Icons" rel="stylesheet"><link id="mock-favicon" rel="shortcut icon" href="#"><script defer="defer" src="9606f1a55fe0a2d35893.js"></script><link href="main.css" rel="stylesheet"></head><body><div id="app"></div></body></html>
+<html><head><title>Lorem ipsum</title><link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700|Roboto+Mono:400,500|Material+Icons" rel="stylesheet"><link id="mock-favicon" rel="shortcut icon" href="#"><script defer="defer" src="7cace99224d3d55c5b00.js"></script><link href="main.css" rel="stylesheet"></head><body><div id="app"></div></body></html>
diff --git a/dbaas/static/main.css b/dbaas/static/main.css
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cloudblueconnect/eaas-database-extension",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "On-demand provisioning of cloud-based database storages as a service.",
   "author": "Ingram Micro",
   "license": "Apache Software License 2.0",
diff --git a/tests/services/test_db.py b/tests/services/test_db.py
@@ -268,6 +268,36 @@ async def test__get_actor_ok(async_client_mocker_factory, mocker):
     p.assert_called_once_with('PA-123', user['id'], 'client')
 
 
+@pytest.mark.asyncio
+async def test__validate_allowed_db_number_per_account_is_admin(admin_context):
+    assert await DB._validate_allowed_db_number_per_account('db', admin_context, 'config') is None
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize('max_num, error', (
+    (0, 'Max allowed number of databases is reached: 0.'),
+    (1, 'Max allowed number of databases is reached: 1.'),
+))
+async def test__validate_allowed_db_number_per_account_exceeds_max(
+    db, common_context, max_num, error,
+):
+    account_id = 'VA-234'
+    common_context.account_id = account_id
+    await db[Collections.DB].insert_one({'id': 'DB-200', 'account_id': account_id})
+
+    config = {'DB_MAX_ALLOWED_NUMBER_PER_ACCOUNT': max_num}
+
+    with pytest.raises(ValueError) as e:
+        await DB._validate_allowed_db_number_per_account(db, common_context, config)
+
+    assert str(e.value) == error
+
+
+@pytest.mark.asyncio
+async def test__validate_allowed_db_number_per_account_ok(db, common_context, config):
+    assert await DB._validate_allowed_db_number_per_account(db, common_context, config) is None
+
+
 def test__prepare_db_document(mocker):
     data = {'name': 'DB-1'}
     context = Context(account_id='VA-123')
@@ -529,6 +559,10 @@ async def test_create_ok(mocker, context_uid, am_call_count, actor):
         'dbaas.services.DB._get_actor',
         AsyncMock(return_value=actor),
     )
+    vn_p = mocker.patch(
+        'dbaas.services.DB._validate_allowed_db_number_per_account',
+        AsyncMock(),
+    )
     pdd_p = mocker.patch('dbaas.services.DB._prepare_db_document', return_value='prepared_db_doc')
     cdd_p = mocker.patch(
         'dbaas.services.DB._create_db_document',
@@ -548,6 +582,7 @@ async def test_create_ok(mocker, context_uid, am_call_count, actor):
 
     gvrd_p.assert_called_once_with(data, 'db')
     gvtc_p.assert_called_once_with(data, context, 'client')
+    vn_p.assert_called_once_with('db', context, 'config')
     assert ga_p.call_count == am_call_count
     pdd_p.assert_called_once_with(
         data, context, 'region_doc', {'id': 'UR-123-456'}, actor,
diff --git a/ui/app/tools/rest.js b/ui/app/tools/rest.js
@@ -116,10 +116,17 @@ async function request(
       data = responseData;
     }
 
+    let errorMsg = `Server responded with non-ok code: ${response.status}`;
+    if (response.status === 422) {
+      errorMsg = 'An input error occurred. Please fill all required fields';
+    } else if (response.status === 400 && 'message' in data) {
+      errorMsg = data.message;
+    }
+
     throw new ApiError(
       data,
       response,
-      `Server responded with non-ok code: ${response.status}`,
+      errorMsg,
     );
   }
 
diff --git a/ui/app/views/ActivateDialog.vue b/ui/app/views/ActivateDialog.vue
@@ -141,12 +141,7 @@ export default {
         this.$emit('saved');
         this.close();
       } catch (e) {
-        if (e.status === 422) {
-          this.errorText = 'An input error occurred. Please fill all required fields';
-        } else {
-          this.errorText = `#${e.status} ${e.message}`;
-        }
-
+        this.errorText = e.message;
         this.emit({ name: 'snackbar:error', value: e });
       }
 
@@ -158,6 +153,8 @@ export default {
     value: {
       immediate: true,
       handler(v) {
+        this.errorText = null;
+
         const data = clone(this.item);
         if (!data?.credentials) data.credentials = initialForm().credentials;
         this.form = data;
diff --git a/ui/app/views/CreateEditDialog.vue b/ui/app/views/CreateEditDialog.vue
@@ -217,12 +217,7 @@ export default {
         this.$emit('saved');
         this.close();
       } catch (e) {
-        if (e.status === 422) {
-          this.errorText = 'An input error occurred. Please fill all required fields';
-        } else {
-          this.errorText = `#${e.status} ${e.message}`;
-        }
-
+        this.errorText = e.message;
         this.emit({ name: 'snackbar:error', value: e });
       }
 
@@ -235,6 +230,7 @@ export default {
       immediate: true,
       async handler(v) {
         if (v) {
+          this.errorText = null;
           if (this.item) this.form = clone(this.item);
 
           try {
diff --git a/ui/app/views/ReconfDialog.spec.js b/ui/app/views/ReconfDialog.spec.js
@@ -18,6 +18,7 @@ describe('ReconfDialog', () => {
   describe('#data', () => {
     it('should provide initial data', () => {
       expect(cmp.data()).toEqual({
+        errorText: null,
         dialogOpened: false,
         acceptTermsAndConds: false,
         saving: false,
diff --git a/ui/app/views/ReconfDialog.vue b/ui/app/views/ReconfDialog.vue
@@ -3,6 +3,7 @@ ez-dialog(
   v-model="dialogOpened",
   width="800",
   title="Request Reconfiguration",
+  :error-text="errorText",
 )
   ui-card(title="Type")
     .two-columns
@@ -106,6 +107,7 @@ export default {
   },
 
   data: () => ({
+    errorText: null,
     dialogOpened: false,
     acceptTermsAndConds: false,
     form: initialForm(),
@@ -138,6 +140,7 @@ export default {
         this.$emit('saved', item);
         this.close();
       } catch (e) {
+        this.errorText = e.message;
         this.emit({ name: 'snackbar:error', value: e });
         /* eslint-disable no-console */
         console.error(e);
@@ -151,6 +154,7 @@ export default {
     value: {
       immediate: true,
       handler(v) {
+        this.errorText = null;
         this.dialogOpened = v;
       },
     },

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,9 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "DBaaS",`
`3`	`3`	`"description": "On-demand provisioning of cloud-based database storages as a service.",`
`4`		`- "version": "0.3.3",`
	`4`	`+ "version": "0.4.0",`
`5`	`5`	`"audience": ["reseller", "distributor", "vendor"],`
`6`		`- "readme_url": "https://github.com/cloudblue/connect-extension-dbaas/blob/0.3.3/README.md",`
`7`		`- "changelog_url": "https://github.com/cloudblue/connect-extension-dbaas/blob/0.3.3/CHANGELOG.md",`
	`6`	`+ "readme_url": "https://github.com/cloudblue/connect-extension-dbaas/blob/0.4.0/README.md",`
	`7`	`+ "changelog_url": "https://github.com/cloudblue/connect-extension-dbaas/blob/0.4.0/CHANGELOG.md",`
`8`	`8`	`"icon": "googleExtensionBaseline"`
`9`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-<html><head><title>Lorem ipsum</title><link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700\|Roboto+Mono:400,500\|Material+Icons" rel="stylesheet"><link id="mock-favicon" rel="shortcut icon" href="#"><script defer="defer" src="9606f1a55fe0a2d35893.js"></script><link href="main.css" rel="stylesheet"></head><body><div id="app"></div></body></html>`
	`1`	`+<html><head><title>Lorem ipsum</title><link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700\|Roboto+Mono:400,500\|Material+Icons" rel="stylesheet"><link id="mock-favicon" rel="shortcut icon" href="#"><script defer="defer" src="7cace99224d3d55c5b00.js"></script><link href="main.css" rel="stylesheet"></head><body><div id="app"></div></body></html>`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@cloudblueconnect/eaas-database-extension",`
`3`		`- "version": "0.3.2",`
	`3`	`+ "version": "0.4.0",`
`4`	`4`	`"description": "On-demand provisioning of cloud-based database storages as a service.",`
`5`	`5`	`"author": "Ingram Micro",`
`6`	`6`	`"license": "Apache Software License 2.0",`