fix(api): change prometheus bucket size to array

Zooz · Oct 23, 2020 · 60b1d7f · 60b1d7f
1 parent 53c9229
commit 60b1d7f
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 24 deletions.
diff --git a/docs/devguide/docs/swagger-docs.yaml b/docs/devguide/docs/swagger-docs.yaml
@@ -2562,7 +2562,7 @@ components:
               type: string
               description: Prometheus push gateway url.
             buckets_sizes:
-              type: string
+              type: array
               description: Bucket sizes use to configure prometheus.
             labels:
               description: Labels which will be passed to prometheus push gateway.

diff --git a/docs/openapi3.yaml b/docs/openapi3.yaml
@@ -2611,7 +2611,7 @@ components:
               type: string
               description: Url of push gateway.
             buckets_sizes:
-              type: string
+              type: array
               description: Bucket sizes use to configure prometheus.
             labels:
               description: Labels which will be passed to prometheus push gateway.

diff --git a/tests/integration-tests/configManager/configHandler-test.js b/tests/integration-tests/configManager/configHandler-test.js
@@ -34,7 +34,7 @@ const updateBodyWithTypes = {
     },
     prometheus_metrics: {
         push_gateway_url: 'string_value',
-        buckets_sizes: 'string_value',
+        buckets_sizes: [0.01, 0.05, 0.10, 0.25, 0.50, 0.100, 0.200, 0.300, 0.400, 0.500, 1, 2, 5, 10, 30, 60, 120],
         labels: { key1: 'value1', key2: 'value2' }
     },
     smtp_server: {
@@ -76,7 +76,7 @@ const requestBody = {
     },
     prometheus_metrics: {
         push_gateway_url: 'string_value_push_gateway_url',
-        buckets_sizes: 'string_value_buckets_sizes',
+        buckets_sizes: [0.01, 0.05, 0.10, 0.25, 0.50, 0.100, 0.200, 0.300, 0.400, 0.500, 1, 2, 5, 10, 30, 60, 120],
         labels: { key1: 'value1', key2: 'value2' }
     },
     smtp_server: {
@@ -201,20 +201,50 @@ describe('update and get config', () => {
     });
 
     describe('Update config validation', () => {
+        describe('prometheus_metrics', () => {
+            it('should return input validation error if bucket_size is not an array', async () => {
+                const requestWithInvalidBucketSizeType = {
+                    prometheus_metrics: {
+                        push_gateway_url: 'string_value',
+                        buckets_sizes: "invalid_string_type_and_not_an_array",
+                        labels: { key1: 'value1', key2: 'value2' }
+                    },
+                };
+
+                const response = await configRequestCreator.updateConfig(requestWithInvalidBucketSizeType);
+                should(response.statusCode).eql(400);
+                should(response.body.message).eql(validationError);
+                should(response.body.validation_errors).have.lengthOf(1);
+                should(response.body.validation_errors[0]).eql('body/prometheus_metrics.buckets_sizes should be array');
+            });
+
+            it('should return input validation error if value for labels are not strings', async () => {
+                const response = await configRequestCreator.updateConfig({
+                    prometheus_metrics: {
+                        push_gateway_url: 'string_value',
+                        buckets_sizes: [0.01, 0.05, 0.10, 0.25, 0.50, 0.100, 0.200, 0.300, 0.400, 0.500, 1, 2, 5, 10, 30, 60, 120],
+                        labels: { key1: { innerKey1: 'value1' }, key2: 'value2' }
+                    }
+                });
+                should(response.statusCode).eql(400);
+                should(response.body.message).eql(validationError);
+                should(response.body.validation_errors).eql([
+                    "body/prometheus_metrics.labels['key1'] should be string"]);
+            });
+        });
+
         it('update config fail with validation require fields', async () => {
             const response = await configRequestCreator.updateConfig(requestBodyNotValidRequire);
             should(response.statusCode).eql(400);
             should(response.body.message).eql(validationError);
         });
-    });
-    describe('Update config validation', () => {
+
         it('update config fail with validation enum', async () => {
             const response = await configRequestCreator.updateConfig(requestBodyNotValidEnum);
             should(response.statusCode).eql(400);
             should(response.body.message).eql(validationError);
         });
-    });
-    describe('Update config validation', () => {
+
         it('update config fail with validation type', async () => {
             const response = await configRequestCreator.updateConfig(requestBodyNotValidType);
             should(response.statusCode).eql(400);
@@ -275,22 +305,6 @@ describe('update and get config', () => {
                 "body/benchmark_weights should have required property 'rps'"]);
         });
     });
-
-    describe('Update prometheus configuration with labels which are not key value', () => {
-        it('update config fail with validation type', async () => {
-            const response = await configRequestCreator.updateConfig({
-                prometheus_metrics: {
-                    push_gateway_url: 'string_value',
-                    buckets_sizes: 'string_value',
-                    labels: { key1: { innerKey1: 'value1' }, key2: 'value2' }
-                }
-            });
-            should(response.statusCode).eql(400);
-            should(response.body.message).eql(validationError);
-            should(response.body.validation_errors).eql([
-                "body/prometheus_metrics.labels['key1'] should be string"]);
-        });
-    });
 });
 
 async function cleanData() {