Be/feature/broken itests (#5102)

* RI-7583: fix ITests

Author: ArtemHoruzhenko

.github/workflows/tests-integration.yml

@@ -50,12 +50,13 @@ env:
   TEST_MEDIUM_DB_DUMP: ${{ secrets.TEST_MEDIUM_DB_DUMP }}
   TEST_BIG_DB_DUMP: ${{ secrets.TEST_BIG_DB_DUMP }}
   REPORT_NAME: 'report-it'
+  #  Disabled RTE for now. Need to prepare reasonable dataset to not take so much time for tests.
+  #  "oss-st-big": "OSS Standalone v6 and all modules and predefined amount of data inside (~3-4M)",
   ITESTS_NAMES: |
     {
       "oss-st-5": "OSS Standalone v5",
       "oss-st-5-pass": "OSS Standalone v5 with admin pass required",
       "oss-st-6": "OSS Standalone v6 and all modules",
-      "oss-st-big": "OSS Standalone v6 and all modules and predefined amount of data inside (~3-4M)",
       "mods-preview": "OSS Standalone and all preview modules",
       "oss-st-6-tls": "OSS Standalone v6 with TLS enabled",
       "oss-st-6-tls-auth": "OSS Standalone v6 with TLS auth required",
@@ -153,6 +154,15 @@ jobs:
           cp ./redisinsight/api/test/test-runs/coverage/test-run-result.xml ./itest/results/${{ matrix.rte }}.result.xml
           cp ./redisinsight/api/test/test-runs/coverage/test-run-coverage.json ./itest/coverages/${{ matrix.rte }}.coverage.json
 
+      - name: Process test results
+        if: always()
+        run: |
+          mkdir -p itest/coverages && mkdir -p itest/results
+
+          cp ./redisinsight/api/test/test-runs/coverage/test-run-result.json ./itest/results/${{ matrix.rte }}.result.json
+          cp ./redisinsight/api/test/test-runs/coverage/test-run-result.xml ./itest/results/${{ matrix.rte }}.result.xml
+          cp ./redisinsight/api/test/test-runs/coverage/test-run-coverage.json ./itest/coverages/${{ matrix.rte }}.coverage.json
+
       - name: Upload coverage files as artifact
         if: always()
         uses: actions/upload-artifact@v4
@@ -230,7 +240,7 @@ jobs:
           reporter: java-junit
           list-tests: 'failed'
           list-suites: 'failed'
-          fail-on-error: 'false'
+          fail-on-error: 'true'
 
       - name: Add link to report in the workflow summary
         if: always()

redisinsight/api/package.json

@@ -34,7 +34,7 @@
     "typeorm": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js -d ./config/ormconfig.ts",
     "test:api": "cross-env NODE_ENV=test ts-mocha --paths --config ./test/api/.mocharc.yml",
     "test:api:cov": "nyc --reporter=html --reporter=text --reporter=text-summary yarn run test:api",
-    "test:api:ci:cov": "cross-env NODE_ENV=test nyc --temp-dir coverage/.nyc_output --report-dir coverage --instrument -r text -r text-summary -r html yarn run test:api --reporter mocha-multi-reporters --reporter-options configFile=test/api/reporters.json; echo 'Exit code from tests:' $? > coverage/debug.log; echo 'NYC tests completed, checking .nyc_output...' >> coverage/debug.log; ls -la coverage/.nyc_output >> coverage/debug.log 2>&1; echo 'Running NYC merge...' >> coverage/debug.log; nyc merge coverage/.nyc_output coverage/test-run-coverage.json >> coverage/debug.log 2>&1; echo 'NYC merge exit code:' $? >> coverage/debug.log; echo 'NYC merge completed!' >> coverage/debug.log; ls -la coverage/test-run-coverage.json >> coverage/debug.log 2>&1",
+    "test:api:ci:cov": "cross-env nyc -r text -r text-summary -r html yarn run test:api --reporter mocha-multi-reporters --reporter-options configFile=test/api/reporters.json && nyc merge .nyc_output ./coverage/test-run-coverage.json",
     "typeorm:migrate": "cross-env NODE_ENV=staging yarn typeorm migration:generate ./migration/migration",
     "typeorm:run": "yarn typeorm migration:run",
     "typeorm:run:stage": "cross-env NODE_ENV=staging yarn typeorm migration:run"

redisinsight/api/src/modules/cloud/common/exceptions/cloud-api.error.handler.ts

@@ -23,7 +23,7 @@ export const wrapCloudApiError = (
   }
 
   if (response) {
-    const errorOptions = { cause: new Error(response?.data as string) };
+    const errorOptions = { cause: response?.data };
     switch (response?.status) {
       case 401:
         return new CloudApiUnauthorizedException(errorMessage, errorOptions);

redisinsight/api/src/modules/cloud/common/exceptions/cloud-capi.error.handler.ts

@@ -13,7 +13,7 @@ export const wrapCloudCapiError = (
 
   if (error.response?.status === 401) {
     return new CloudCapiUnauthorizedException(message || error.message, {
-      cause: new Error(error.response?.data as string),
+      cause: error.response?.data,
     });
   }
 

redisinsight/api/src/modules/database/providers/database.factory.spec.ts

@@ -98,7 +98,7 @@ describe('DatabaseFactory', () => {
         await service.createDatabaseModel(mockSessionMetadata, mockDatabase);
         fail();
       } catch (e) {
-        expect(e.message).toEqual(RedisErrorCodes.SentinelParamsRequired);
+        expect(e.message).toEqual(ERROR_MESSAGES.SENTINEL_MASTER_NAME_REQUIRED);
       }
     });
     it('should create cluster database model', async () => {

redisinsight/api/src/modules/database/providers/database.factory.ts

@@ -4,7 +4,7 @@ import {
   ConnectionType,
   HostingProvider,
 } from 'src/modules/database/entities/database.entity';
-import { getHostingProvider } from 'src/utils';
+import { getHostingProvider, getRedisConnectionException } from 'src/utils';
 import { Database } from 'src/modules/database/models/database';
 import { ClientContext, SessionMetadata } from 'src/common/models';
 import ERROR_MESSAGES from 'src/constants/error-messages';
@@ -23,6 +23,7 @@ import {
   isSentinel,
 } from 'src/modules/redis/utils';
 import { RedisClient } from 'src/modules/redis/client';
+import { ReplyError } from 'src/models';
 
 @Injectable()
 export class DatabaseFactory {
@@ -66,7 +67,10 @@ export class DatabaseFactory {
 
     if (await isSentinel(client)) {
       if (!database.sentinelMaster) {
-        throw new Error(RedisErrorCodes.SentinelParamsRequired);
+        throw getRedisConnectionException(
+          new ReplyError(RedisErrorCodes.SentinelParamsRequired),
+          database,
+        );
       }
       model = await this.createSentinelDatabaseModel(
         sessionMetadata,

redisinsight/api/src/utils/logsFormatter.spec.ts

@@ -14,8 +14,16 @@ import {
   sanitizeErrors,
 } from './logsFormatter';
 
+const stringCause = 'string cause';
+const objectCause = { object: 'cause' };
 const simpleError = new Error('Original error');
 simpleError['some'] = 'field';
+const errorWithStringCause = new NotFoundException('Not found', {
+  cause: stringCause,
+});
+const errorWithObjectCause = new NotFoundException('Not found', {
+  cause: objectCause,
+});
 const errorWithCause = new NotFoundException('Not found', {
   cause: simpleError,
 });
@@ -26,6 +34,10 @@ const errorWithCauseDepth3 = new CloudOauthMisconfigurationException(
   'Misconfigured',
   { cause: errorWithCauseDepth2 },
 );
+const errorWithObjectCauseDepth = new CloudOauthMisconfigurationException(
+  'Misconfigured',
+  { cause: errorWithObjectCause },
+);
 const axiosError = new AxiosError(
   'Request failed with status code 404',
   'NOT_FOUND',
@@ -132,8 +144,18 @@ describe('logsFormatter', () => {
       expect(getOriginalErrorCause(errorWithCauseDepth3)).toEqual(simpleError);
     });
 
-    it('should return undefined if input is not an Error instance', () => {
-      expect(getOriginalErrorCause({ cause: simpleError })).toEqual(undefined);
+    it('should return simple error if it is last in the chain and only the one in cause', () => {
+      expect(getOriginalErrorCause({ cause: simpleError })).toEqual(
+        simpleError,
+      );
+    });
+
+    it('should return string as cause', () => {
+      expect(getOriginalErrorCause(errorWithStringCause)).toEqual(stringCause);
+    });
+
+    it('should return object as cause', () => {
+      expect(getOriginalErrorCause(errorWithObjectCause)).toEqual(objectCause);
     });
 
     it('should not fail if input is not specified', () => {
@@ -170,6 +192,16 @@ describe('logsFormatter', () => {
       });
     });
 
+    it('should return sanitized object with a single original cause for nested errors', () => {
+      expect(
+        sanitizeError(errorWithObjectCauseDepth, { omitSensitiveData: true }),
+      ).toEqual({
+        type: 'CloudOauthMisconfigurationException',
+        message: errorWithObjectCauseDepth.message,
+        cause: objectCause,
+      });
+    });
+
     it('should return sanitized object with a single original cause for nested errors (with stack)', () => {
       expect(sanitizeError(errorWithCauseDepth3)).toEqual({
         type: 'CloudOauthMisconfigurationException',

redisinsight/api/src/utils/logsFormatter.ts

@@ -14,14 +14,13 @@ type SanitizedError = {
   type: string;
   message: string;
   stack?: string;
-  cause?: ReturnType<typeof sanitizeError>;
+  cause?: unknown;
 };
 
-export const getOriginalErrorCause = (cause: unknown): Error | undefined => {
-  if (cause instanceof Error) {
-    return getOriginalErrorCause((cause as any).cause) || cause;
+export const getOriginalErrorCause = (cause: unknown): unknown => {
+  if (cause) {
+    return getOriginalErrorCause(cause['cause']) || cause;
   }
-  return undefined;
 };
 
 export const sanitizeError = (
@@ -30,11 +29,17 @@ export const sanitizeError = (
 ): SanitizedError | undefined => {
   if (!error) return undefined;
 
+  let cause = getOriginalErrorCause(error['cause']);
+
+  if (cause instanceof Error) {
+    cause = sanitizeError(cause, opts);
+  }
+
   return {
     type: error.constructor?.name ?? 'UnknownError',
     message: String(error.message ?? 'Unknown error'),
     stack: opts.omitSensitiveData ? undefined : error.stack,
-    cause: sanitizeError(getOriginalErrorCause((error as any).cause), opts),
+    cause,
   };
 };
 
@@ -86,7 +91,11 @@ export const prettyFileFormat = format.printf((info) => {
 });
 
 const MAX_DEPTH = 10;
-export const logDataToPlain = (value: any, seen = new WeakSet(), depth = 0): any => {
+export const logDataToPlain = (
+  value: any,
+  seen = new WeakSet(),
+  depth = 0,
+): any => {
   if (depth > MAX_DEPTH) return '[MaxDepthExceeded]';
 
   if (value === null || typeof value !== 'object' || value instanceof Error) {

redisinsight/api/test/api/cloud/autodiscovery/POST-cloud-autodiscovery-databases.test.ts

@@ -174,9 +174,9 @@ describe('POST /cloud/autodiscovery/databases', () => {
               `/fixed/subscriptions/${mockImportCloudDatabaseDtoFixed.subscriptionId}/databases/${mockImportCloudDatabaseDtoFixed.databaseId}`,
             )
             .replyWithError({
+              message: 'Unauthorized for this action',
               response: {
                 status: 403,
-                data: { message: 'Unauthorized for this action' },
               },
             });
         },
@@ -206,6 +206,7 @@ describe('POST /cloud/autodiscovery/databases', () => {
               `/subscriptions/${mockImportCloudDatabaseDto.subscriptionId}/databases/${mockImportCloudDatabaseDto.databaseId}`,
             )
             .replyWithError({
+              message: ERROR_MESSAGES.UNAUTHORIZED,
               response: {
                 status: 401,
                 data: '',
@@ -238,9 +239,10 @@ describe('POST /cloud/autodiscovery/databases', () => {
               `/subscriptions/${mockImportCloudDatabaseDto.subscriptionId}/databases/${mockImportCloudDatabaseDto.databaseId}`,
             )
             .replyWithError({
+              message: ERROR_MESSAGES.NOT_FOUND,
               response: {
                 status: 404,
-                data: 'Database was not found',
+                data: ERROR_MESSAGES.NOT_FOUND,
               },
             });
         },

redisinsight/api/test/api/cloud/autodiscovery/POST-cloud-autodiscovery-get_databases.test.ts

@@ -154,9 +154,9 @@ describe('POST /cloud/autodiscovery/get-databases', () => {
               `/subscriptions/${mockGetCloudSubscriptionDatabasesDto.subscriptionId}/databases`,
             )
             .replyWithError({
+              message: 'Unauthorized for this action',
               response: {
                 status: 403,
-                data: { message: 'Unauthorized for this action' },
               },
             });
         },
@@ -180,9 +180,9 @@ describe('POST /cloud/autodiscovery/get-databases', () => {
               `/subscriptions/${mockGetCloudSubscriptionDatabasesDto.subscriptionId}/databases`,
             )
             .replyWithError({
+              message: ERROR_MESSAGES.UNAUTHORIZED,
               response: {
                 status: 401,
-                data: '',
               },
             });
         },
@@ -206,6 +206,7 @@ describe('POST /cloud/autodiscovery/get-databases', () => {
               `/subscriptions/${mockGetCloudSubscriptionDatabasesDto.subscriptionId}/databases`,
             )
             .replyWithError({
+              message: ERROR_MESSAGES.NOT_FOUND,
               response: {
                 status: 404,
                 data: 'Subscription is not found',