Add integration tests setup with Jest

openvidu-test-integration/.gitignore

@@ -0,0 +1,130 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

openvidu-test-integration/jest.config.ts

@@ -0,0 +1,7 @@
+import type { Config } from "jest";
+
+const config: Config = {
+    preset: "ts-jest"
+};
+
+export default config;

openvidu-test-integration/package.json

@@ -0,0 +1,17 @@
+{
+    "name": "openvidu-test-integration",
+    "version": "1.0.0",
+    "scripts": {
+        "test": "jest --forceExit",
+        "test:ci": "jest --ci --json --outputFile=test-results.json --forceExit"
+    },
+    "devDependencies": {
+        "@types/jest": "29.5.14",
+        "@types/node": "22.10.1",
+        "jest": "29.7.0",
+        "mongodb": "6.11.0",
+        "ts-jest": "29.2.5",
+        "ts-node": "10.9.2",
+        "typescript": "5.7.2"
+    }
+}

openvidu-test-integration/tests/utils/helper.ts

@@ -0,0 +1,86 @@
+import { execSync, spawn } from "child_process";
+
+const LOCAL_DEPLOYMENT_PATH = "../../openvidu-local-deployment/community/docker-compose.yaml";
+const LIVEKIT_URL = "ws://localhost:7880";
+const LIVEKIT_API_KEY = "devkey";
+const LIVEKIT_API_SECRET = "secret";
+
+const execCommand = (command: string): string => {
+    try {
+        return execSync(command).toString().trim();
+    } catch (error) {
+        console.error(`Error executing command: ${command}`);
+        console.error(error);
+        throw error;
+    }
+};
+
+const execCommandInBackground = (command: string, args: string[]): number | undefined => {
+    const child = spawn(command, args, { detached: true, stdio: "ignore" });
+    // child.unref();
+    return child.pid;
+};
+
+export const killProcess = (pid: number) => {
+    process.kill(-pid);
+};
+
+export const sleep = async (seconds: number) => {
+    return new Promise((resolve) => {
+        setTimeout(resolve, seconds * 1000);
+    });
+};
+
+export const startLocalDeployment = async () => {
+    console.log("Starting local deployment...");
+    execCommand(`docker compose -f ${LOCAL_DEPLOYMENT_PATH} up -d`);
+    let statusCode: string;
+
+    // Check that container "ready-check" exited with code 0
+    do {
+        await sleep(1);
+        statusCode = execCommand("docker inspect ready-check -f {{.State.Status}}:{{.State.ExitCode}}");
+    } while (statusCode !== "exited:0");
+
+    console.log("Local deployment started");
+};
+
+export const stopLocalDeployment = () => {
+    console.log("Stopping local deployment...");
+    execCommand(`docker compose -f ${LOCAL_DEPLOYMENT_PATH} down -v`);
+};
+
+export const startComposeContainer = (containerName: string) => {
+    console.log(`Starting container ${containerName}...`);
+    execCommand(`docker compose -f ${LOCAL_DEPLOYMENT_PATH} start ${containerName}`);
+};
+
+export const stopComposeContainer = (containerName: string) => {
+    console.log(`Stopping container ${containerName}...`);
+    execCommand(`docker compose -f ${LOCAL_DEPLOYMENT_PATH} stop ${containerName}`);
+};
+
+export const joinParticipantToRoom = (participantIdentity: string, roomName: string): number => {
+    const command = "lk";
+    const args = [
+        "room",
+        "join",
+        "--url",
+        LIVEKIT_URL,
+        "--api-key",
+        LIVEKIT_API_KEY,
+        "--api-secret",
+        LIVEKIT_API_SECRET,
+        "--publish-demo",
+        "--identity",
+        participantIdentity,
+        roomName
+    ];
+    const pid = execCommandInBackground(command, args);
+
+    if (!pid) {
+        throw new Error("Error starting participant");
+    }
+
+    return pid;
+};

openvidu-test-integration/tests/utils/mongodb.ts

@@ -0,0 +1,80 @@
+import { Collection, Db, Document, MongoClient, WithId } from "mongodb";
+import { ActiveEntity, EntityType } from "./types";
+
+const DATABASE_URL =
+    "mongodb://mongoadmin:mongoadmin@localhost:27017/?replicaSet=rs0&readPreference=primaryPreferred&directConnection=true";
+const DATABASE_NAME = "openvidu";
+const EVENTS_COLLECTION = "events";
+const ACTIVE_ENTITIES_COLLECTION = "active-entities";
+
+const entityStartEventTypesMap: Map<EntityType, string> = new Map([
+    [EntityType.ROOM, "ROOM_CREATED"],
+    [EntityType.PARTICIPANT, "PARTICIPANT_ACTIVE"]
+]);
+const entityCloseEventTypesMap: Map<EntityType, string> = new Map([
+    [EntityType.ROOM, "ROOM_ENDED"],
+    [EntityType.PARTICIPANT, "PARTICIPANT_LEFT"]
+]);
+const entityIdFieldMap: Map<EntityType, string> = new Map([
+    [EntityType.ROOM, "room.sid"],
+    [EntityType.PARTICIPANT, "participant.sid"]
+]);
+const entityNameFieldMap: Map<EntityType, string> = new Map([
+    [EntityType.ROOM, "room.name"],
+    [EntityType.PARTICIPANT, "participant.identity"]
+]);
+
+export class MongoService {
+    private static instace: MongoService;
+    private client: MongoClient;
+    private db: Db;
+    private eventsCollection: Collection;
+    private activeEntitiesCollection: Collection<ActiveEntity>;
+
+    private constructor() {
+        this.client = new MongoClient(DATABASE_URL);
+        this.db = this.client.db(DATABASE_NAME);
+        this.eventsCollection = this.db.collection(EVENTS_COLLECTION);
+        this.activeEntitiesCollection = this.db.collection(ACTIVE_ENTITIES_COLLECTION);
+    }
+
+    public static getInstance(): MongoService {
+        if (!MongoService.instace) {
+            MongoService.instace = new MongoService();
+        }
+
+        return MongoService.instace;
+    }
+
+    public async findStartEvent(entityType: EntityType, entityName: string): Promise<WithId<Document> | null> {
+        try {
+            const eventType = entityStartEventTypesMap.get(entityType)!;
+            const nameField = entityNameFieldMap.get(entityType)!;
+            return await this.eventsCollection.findOne({ type: eventType, [nameField]: entityName });
+        } catch (error) {
+            console.error("Error finding start event", error);
+            throw error;
+        }
+    }
+
+    public async findCloseEvent(entityType: EntityType, entityId: string): Promise<WithId<Document> | null> {
+        try {
+            const eventType = entityCloseEventTypesMap.get(entityType)!;
+            const idField = entityIdFieldMap.get(entityType)!;
+            return await this.eventsCollection.findOne({ type: eventType, [idField]: entityId });
+        } catch (error) {
+            console.error("Error finding close event", error);
+            throw error;
+        }
+    }
+
+    public async isActiveEntity(id: string): Promise<boolean> {
+        try {
+            const result = await this.activeEntitiesCollection.findOne({ _id: id });
+            return !!result;
+        } catch (error) {
+            console.error("Error finding active entity", error);
+            throw error;
+        }
+    }
+}

openvidu-test-integration/tests/utils/types.ts

@@ -0,0 +1,9 @@
+export const enum EntityType {
+    ROOM = "room",
+    PARTICIPANT = "participant"
+}
+
+export interface ActiveEntity {
+    _id: string;
+    entity: EntityType;
+}

openvidu-test-integration/tsconfig.json

@@ -0,0 +1,111 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "rewriteRelativeImportExtensions": true,          /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "noUncheckedSideEffectImports": true,             /* Check side effect imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}