#RI-4815 add tests

Author: irinaAbramova-dev

redisinsight/api/test/api/string/POST-databases-id-string-download_value.test.ts

@@ -0,0 +1,114 @@
+import {
+  describe,
+  before,
+  Joi,
+  deps,
+  requirements,
+  generateInvalidDataTestCases,
+  validateInvalidDataTestCase,
+  getMainCheckFn
+} from '../deps';
+const { server, request, constants, rte } = deps;
+
+// endpoint to test
+const endpoint = (instanceId = constants.TEST_INSTANCE_ID) =>
+  request(server).post(`/${constants.API.DATABASES}/${instanceId}/string/download-value`);
+
+// input data schema
+const dataSchema = Joi.object({
+  keyName: Joi.string().allow('').required(),
+}).strict();
+
+const validInputData = {
+  keyName: constants.TEST_STRING_KEY_1,
+};
+
+const mainCheckFn = getMainCheckFn(endpoint);
+
+describe('POST /databases/:instanceId/string/download-value', () => {
+  describe('Main', () => {
+    before(() => rte.data.generateKeys(true));
+
+    describe('Validation', () => {
+      generateInvalidDataTestCases(dataSchema, validInputData).map(
+        validateInvalidDataTestCase(endpoint, dataSchema),
+      );
+    });
+
+    describe('Common', () => {
+      [
+        {
+          name: 'Should download value',
+          data: {
+            keyName: constants.TEST_STRING_KEY_1,
+          },
+          responseHeaders: {
+            'content-type': 'application/octet-stream',
+            'content-disposition': 'attachment;filename="string_value.txt"',
+            'access-control-expose-headers': 'Content-Disposition',
+          },
+          responseBody: Buffer.from(`"${constants.TEST_STRING_VALUE_1}"`),
+        },
+        {
+          name: 'Should return an error when incorrect type',
+          data: {
+            keyName: constants.TEST_LIST_KEY_1,
+          },
+          statusCode: 400,
+          responseBody: {
+            statusCode: 400,
+            error: 'Bad Request',
+          },
+        },
+        {
+          name: 'Should return NotFound error if instance id does not exists',
+          endpoint: () => endpoint(constants.TEST_NOT_EXISTED_INSTANCE_ID),
+          data: {
+            keyName: constants.TEST_STRING_KEY_1,
+          },
+          statusCode: 404,
+          responseBody: {
+            statusCode: 404,
+            error: 'Not Found',
+            message: 'Invalid database instance id.',
+          },
+        },
+      ].map(mainCheckFn);
+    });
+
+    describe('ACL', () => {
+      requirements('rte.acl');
+      before(async () => rte.data.setAclUserRules('~* +@all'));
+
+      [
+        {
+          name: 'Should download value',
+          endpoint: () => endpoint(constants.TEST_INSTANCE_ACL_ID),
+          data: {
+            keyName: constants.TEST_STRING_KEY_1,
+          },
+          responseHeaders: {
+            'content-type': 'application/octet-stream',
+            'content-disposition': 'attachment;filename="string_value.txt"',
+            'access-control-expose-headers': 'Content-Disposition',
+          },
+          responseBody: Buffer.from(`"${constants.TEST_STRING_VALUE_1}"`),
+        },
+        {
+          name: 'Should throw error if no permissions for "set" command',
+          endpoint: () => endpoint(constants.TEST_INSTANCE_ACL_ID),
+          data: {
+            keyName: constants.getRandomString(),
+            value: constants.getRandomString(),
+          },
+          statusCode: 403,
+          responseBody: {
+            statusCode: 403,
+            error: 'Forbidden',
+          },
+          before: () => rte.data.setAclUserRules('~* +@all -get')
+        },
+      ].map(mainCheckFn);
+    });
+  });
+});

redisinsight/api/test/api/string/POST-databases-id-string-get_value.test.ts

@@ -48,17 +48,6 @@ describe('POST /databases/:instanceId/string/get-value', () => {
           value: constants.TEST_STRING_VALUE_BIN_UTF8_1,
         },
       },
-      {
-        name: 'Should return part of value in utf8 (specified length)',
-        data: {
-          keyName: constants.TEST_STRING_KEY_BIN_BUF_OBJ_1,
-          stringMaxLen: constants.TEST_STRING_KEY_LENGTH
-        },
-        responseBody: {
-          keyName: constants.TEST_STRING_KEY_BIN_UTF8_1,
-          value: constants.TEST_STRING_VALUE_BIN_UTF8_1.slice(0, constants.TEST_STRING_KEY_LENGTH),
-        },
-      },
       {
         name: 'Should return value in utf8',
         query: {
@@ -132,6 +121,17 @@ describe('POST /databases/:instanceId/string/get-value', () => {
             value: constants.TEST_STRING_VALUE_1,
           },
         },
+        {
+          name: 'Should get part of value (specified length)',
+          data: {
+            keyName: constants.TEST_STRING_KEY_1,
+            stringMaxLen: constants.TEST_STRING_KEY_LENGTH
+          },
+          responseBody: {
+            keyName: constants.TEST_STRING_KEY_1,
+            value: constants.TEST_STRING_VALUE_1.slice(0, constants.TEST_STRING_KEY_LENGTH),
+          },
+        },
         {
           name: 'Should return an error when incorrect type',
           data: {
@@ -144,6 +144,18 @@ describe('POST /databases/:instanceId/string/get-value', () => {
             // message: 'WRONGTYPE Operation against a key holding the wrong kind of value',
           },
         },
+        {
+          name: 'Should return an error when incorrect string length',
+          data: {
+            keyName: constants.TEST_STRING_KEY_1,
+            stringMaxLen: 0
+          },
+          statusCode: 400,
+          responseBody: {
+            statusCode: 400,
+            error: 'Bad Request',
+          },
+        },
         {
           name: 'Should return NotFound error if instance id does not exists',
           endpoint: () => endpoint(constants.TEST_NOT_EXISTED_INSTANCE_ID),

redisinsight/api/test/helpers/test.ts

@@ -32,6 +32,7 @@ interface ITestCaseInput {
   statusCode?: number;
   responseSchema?: Joi.AnySchema;
   responseBody?: any;
+  responseHeaders?: object,
   checkFn?: Function;
   preconditionFn?: Function;
   postCheckFn?: Function;
@@ -51,6 +52,7 @@ export const validateApiCall = async function ({
   statusCode = 200,
   responseSchema,
   responseBody,
+  responseHeaders,
   checkFn,
 }: ITestCaseInput): Promise<any> {
   const request = endpoint();
@@ -93,6 +95,11 @@ export const validateApiCall = async function ({
 
   expect(response.res.statusCode).to.eq(statusCode)
 
+  // validate response headers if passed
+  if (responseHeaders) {
+    expect(response.res.headers).to.include(responseHeaders);
+  }
+
   // validate response schema if passed
   if (responseSchema) {
     Joi.assert(response.body, responseSchema);