Merge pull request #1377 from RedisInsight/feature/RI-3637_databases-import

#RI-3637 databases import.

Author: vlad-dargel

redisinsight/api/config/stack.ts

@@ -5,6 +5,7 @@ export default {
     excludeRoutes: [
       'redis-enterprise/*',
       'redis-sentinel/*',
+      { path: 'databases/import' },
       { path: 'databases', method: RequestMethod.POST },
       { path: 'databases', method: RequestMethod.DELETE },
       { path: 'databases/:id', method: RequestMethod.DELETE },

redisinsight/api/migration/1670252337342-database-new.ts

@@ -0,0 +1,20 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class databaseNew1670252337342 implements MigrationInterface {
+    name = 'databaseNew1670252337342'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`CREATE TABLE "temporary_database_instance" ("id" varchar PRIMARY KEY NOT NULL, "host" varchar NOT NULL, "port" integer NOT NULL, "name" varchar NOT NULL, "username" varchar, "password" varchar, "tls" boolean, "verifyServerCert" boolean, "lastConnection" datetime, "caCertId" varchar, "clientCertId" varchar, "connectionType" varchar NOT NULL DEFAULT ('STANDALONE'), "nodes" varchar DEFAULT ('[]'), "nameFromProvider" varchar, "sentinelMasterName" varchar, "sentinelMasterUsername" varchar, "sentinelMasterPassword" varchar, "provider" varchar DEFAULT ('UNKNOWN'), "modules" varchar NOT NULL DEFAULT ('[]'), "db" integer, "encryption" varchar, "tlsServername" varchar, "new" boolean, CONSTRAINT "FK_3b9b625266c00feb2d66a9f36e4" FOREIGN KEY ("clientCertId") REFERENCES "client_certificate" ("id") ON DELETE SET NULL ON UPDATE NO ACTION, CONSTRAINT "FK_d1bc747b5938e22b4b708d8e9a5" FOREIGN KEY ("caCertId") REFERENCES "ca_certificate" ("id") ON DELETE SET NULL ON UPDATE NO ACTION)`);
+        await queryRunner.query(`INSERT INTO "temporary_database_instance"("id", "host", "port", "name", "username", "password", "tls", "verifyServerCert", "lastConnection", "caCertId", "clientCertId", "connectionType", "nodes", "nameFromProvider", "sentinelMasterName", "sentinelMasterUsername", "sentinelMasterPassword", "provider", "modules", "db", "encryption", "tlsServername") SELECT "id", "host", "port", "name", "username", "password", "tls", "verifyServerCert", "lastConnection", "caCertId", "clientCertId", "connectionType", "nodes", "nameFromProvider", "sentinelMasterName", "sentinelMasterUsername", "sentinelMasterPassword", "provider", "modules", "db", "encryption", "tlsServername" FROM "database_instance"`);
+        await queryRunner.query(`DROP TABLE "database_instance"`);
+        await queryRunner.query(`ALTER TABLE "temporary_database_instance" RENAME TO "database_instance"`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "database_instance" RENAME TO "temporary_database_instance"`);
+        await queryRunner.query(`CREATE TABLE "database_instance" ("id" varchar PRIMARY KEY NOT NULL, "host" varchar NOT NULL, "port" integer NOT NULL, "name" varchar NOT NULL, "username" varchar, "password" varchar, "tls" boolean, "verifyServerCert" boolean, "lastConnection" datetime, "caCertId" varchar, "clientCertId" varchar, "connectionType" varchar NOT NULL DEFAULT ('STANDALONE'), "nodes" varchar DEFAULT ('[]'), "nameFromProvider" varchar, "sentinelMasterName" varchar, "sentinelMasterUsername" varchar, "sentinelMasterPassword" varchar, "provider" varchar DEFAULT ('UNKNOWN'), "modules" varchar NOT NULL DEFAULT ('[]'), "db" integer, "encryption" varchar, "tlsServername" varchar, CONSTRAINT "FK_3b9b625266c00feb2d66a9f36e4" FOREIGN KEY ("clientCertId") REFERENCES "client_certificate" ("id") ON DELETE SET NULL ON UPDATE NO ACTION, CONSTRAINT "FK_d1bc747b5938e22b4b708d8e9a5" FOREIGN KEY ("caCertId") REFERENCES "ca_certificate" ("id") ON DELETE SET NULL ON UPDATE NO ACTION)`);
+        await queryRunner.query(`INSERT INTO "database_instance"("id", "host", "port", "name", "username", "password", "tls", "verifyServerCert", "lastConnection", "caCertId", "clientCertId", "connectionType", "nodes", "nameFromProvider", "sentinelMasterName", "sentinelMasterUsername", "sentinelMasterPassword", "provider", "modules", "db", "encryption", "tlsServername") SELECT "id", "host", "port", "name", "username", "password", "tls", "verifyServerCert", "lastConnection", "caCertId", "clientCertId", "connectionType", "nodes", "nameFromProvider", "sentinelMasterName", "sentinelMasterUsername", "sentinelMasterPassword", "provider", "modules", "db", "encryption", "tlsServername" FROM "temporary_database_instance"`);
+        await queryRunner.query(`DROP TABLE "temporary_database_instance"`);
+    }
+
+}

redisinsight/api/migration/index.ts

@@ -21,6 +21,7 @@ import { databaseAnalysis1664785208236 } from './1664785208236-database-analysis
 import { databaseAnalysisExpirationGroups1664886479051 } from './1664886479051-database-analysis-expiration-groups';
 import { workbenchExecutionTime1667368983699 } from './1667368983699-workbench-execution-time';
 import { database1667477693934 } from './1667477693934-database';
+import { databaseNew1670252337342 } from './1670252337342-database-new';
 
 export default [
   initialMigration1614164490968,
@@ -46,4 +47,5 @@ export default [
   databaseAnalysisExpirationGroups1664886479051,
   workbenchExecutionTime1667368983699,
   database1667477693934,
+  databaseNew1670252337342,
 ];

redisinsight/api/src/__mocks__/common.ts

@@ -32,6 +32,7 @@ export const mockQueryBuilderExecute = jest.fn();
 export const mockCreateQueryBuilder = jest.fn(() => ({
   // where: jest.fn().mockReturnThis(),
   where: mockQueryBuilderWhere,
+  orWhere: mockQueryBuilderWhere,
   update: jest.fn().mockReturnThis(),
   select: jest.fn().mockReturnThis(),
   set: jest.fn().mockReturnThis(),

redisinsight/api/src/__mocks__/database-import.ts

@@ -0,0 +1,89 @@
+import { DatabaseImportResponse, DatabaseImportStatus } from 'src/modules/database-import/dto/database-import.response';
+import { BadRequestException, ForbiddenException } from '@nestjs/common';
+import { mockDatabase, mockSentinelDatabaseWithTlsAuth } from 'src/__mocks__/databases';
+import { ValidationException } from 'src/common/exceptions';
+import { mockCaCertificate, mockClientCertificate } from 'src/__mocks__/certificates';
+import {
+  InvalidCaCertificateBodyException, InvalidCertificateNameException,
+} from 'src/modules/database-import/exceptions';
+
+export const mockDatabasesToImportArray = new Array(10).fill(mockSentinelDatabaseWithTlsAuth);
+
+export const mockDatabaseImportFile = {
+  originalname: 'filename.json',
+  mimetype: 'application/json',
+  size: 1,
+  buffer: Buffer.from(JSON.stringify(mockDatabasesToImportArray)),
+};
+
+export const mockDatabaseImportResultSuccess = {
+  index: 0,
+  status: DatabaseImportStatus.Success,
+  host: mockDatabase.host,
+  port: mockDatabase.port,
+};
+
+export const mockDatabaseImportResultFail = {
+  index: 0,
+  status: DatabaseImportStatus.Fail,
+  host: mockDatabase.host,
+  port: mockDatabase.port,
+  errors: [new BadRequestException()],
+};
+
+export const mockDatabaseImportResultPartial = {
+  index: 0,
+  status: DatabaseImportStatus.Partial,
+  host: mockDatabase.host,
+  port: mockDatabase.port,
+  errors: [new InvalidCaCertificateBodyException()],
+};
+
+export const mockDatabaseImportResponse = Object.assign(new DatabaseImportResponse(), {
+  total: 10,
+  success: (new Array(5).fill(mockDatabaseImportResultSuccess)).map((v, index) => ({
+    ...v,
+    index: index + 5,
+  })),
+  partial: [
+    [new InvalidCaCertificateBodyException(), new InvalidCertificateNameException()],
+    [new InvalidCertificateNameException()],
+  ].map((errors, index) => ({
+    ...mockDatabaseImportResultPartial,
+    index: index + 3,
+    errors,
+  })),
+  fail: [
+    new ValidationException('Bad request'),
+    new BadRequestException(),
+    new ForbiddenException(),
+  ].map((error, index) => ({
+    ...mockDatabaseImportResultFail,
+    index,
+    errors: [error],
+  })),
+});
+
+export const mockDatabaseImportPartialAnalyticsPayload = {
+  partially: mockDatabaseImportResponse.partial.length,
+  errors: ['InvalidCaCertificateBodyException', 'InvalidCertificateNameException'],
+};
+
+export const mockDatabaseImportFailedAnalyticsPayload = {
+  failed: mockDatabaseImportResponse.fail.length,
+  errors: ['ValidationException', 'BadRequestException', 'ForbiddenException'],
+};
+
+export const mockDatabaseImportSucceededAnalyticsPayload = {
+  succeed: mockDatabaseImportResponse.success.length,
+};
+
+export const mockDatabaseImportAnalytics = jest.fn(() => ({
+  sendImportResults: jest.fn(),
+  sendImportFailed: jest.fn(),
+}));
+
+export const mockCertificateImportService = jest.fn(() => ({
+  processCaCertificate: jest.fn().mockResolvedValue(mockCaCertificate),
+  processClientCertificate: jest.fn().mockResolvedValue(mockClientCertificate),
+}));

redisinsight/api/src/__mocks__/databases.ts

@@ -8,6 +8,7 @@ import { mockSentinelMasterDto } from 'src/__mocks__/redis-sentinel';
 import { pick } from 'lodash';
 import { RedisDatabaseInfoResponse } from 'src/modules/database/dto/redis-info.dto';
 import { DatabaseOverview } from 'src/modules/database/models/database-overview';
+import { ClientContext, ClientMetadata } from 'src/common/models';
 
 export const mockDatabaseId = 'a77b23c1-7816-4ea4-b61f-d37795a0f805-db-id';
 
@@ -25,6 +26,7 @@ export const mockDatabase = Object.assign(new Database(), {
   host: '127.0.100.1',
   port: 6379,
   connectionType: ConnectionType.STANDALONE,
+  new: false,
 });
 
 export const mockDatabaseEntity = Object.assign(new DatabaseEntity(), {
@@ -113,6 +115,17 @@ export const mockClusterDatabaseWithTlsAuthEntity = Object.assign(new DatabaseEn
   nodes: JSON.stringify(mockClusterNodes),
 });
 
+export const mockNewDatabase = Object.assign(new Database(), {
+  ...mockDatabase,
+  new: true,
+});
+
+export const mockClientMetadata: ClientMetadata = {
+  session: undefined,
+  databaseId: mockDatabase.id,
+  context: ClientContext.Common,
+};
+
 export const mockDatabaseOverview: DatabaseOverview = {
   version: '6.2.4',
   usedMemory: 1,

redisinsight/api/src/__mocks__/index.ts

@@ -16,3 +16,4 @@ export * from './redis';
 export * from './server';
 export * from './redis-enterprise';
 export * from './redis-sentinel';
+export * from './database-import';

redisinsight/api/src/app.module.ts

@@ -19,6 +19,7 @@ import { ServerModule } from 'src/modules/server/server.module';
 import { LocalDatabaseModule } from 'src/local-database.module';
 import { CoreModule } from 'src/core.module';
 import { AutodiscoveryModule } from 'src/modules/autodiscovery/autodiscovery.module';
+import { DatabaseImportModule } from 'src/modules/database-import/database-import.module';
 import { DummyAuthMiddleware } from 'src/common/middlewares/dummy-auth.middleware';
 import { BrowserModule } from './modules/browser/browser.module';
 import { RedisEnterpriseModule } from './modules/redis-enterprise/redis-enterprise.module';
@@ -53,6 +54,7 @@ const PATH_CONFIG = config.get('dir_path');
     BulkActionsModule,
     ClusterMonitorModule,
     DatabaseAnalysisModule,
+    DatabaseImportModule,
     ...(SERVER_CONFIG.staticContent
       ? [
         ServeStaticModule.forRoot({

redisinsight/api/src/common/exceptions/index.ts

@@ -0,0 +1 @@
+export * from './validation.exception';

redisinsight/api/src/common/exceptions/validation.exception.ts

@@ -0,0 +1,3 @@
+import { BadRequestException } from '@nestjs/common';
+
+export class ValidationException extends BadRequestException {}