chore(tests): small improvements (#259)

* feat(e2e): added e2e tests config and setup

* remove unnecessary code

* fix socket client tests

* better test separation

* increase timeout for ci

* fix integration tests

* improve structure

* fix socket tests

* chore(tests): reorganize tests and improve setup (#257)

* fix yarn dev

* remove console.log

* improvements

* jest.config -> jest.unit.config

* fix

* fix

* fix

* remove some unecessary global setups and teardowns

Co-authored-by: Laurent Leclerc-Poulin <[email protected]>
Co-authored-by: Laurent Leclerc Poulin <[email protected]>

Author: samuelmasse

.github/workflows/tests.yml

@@ -35,7 +35,7 @@ jobs:
           yarn --frozen-lockfile
       - name: Run tests
         run: |
-          yarn test:functional --coverage --verbose
+          yarn test:func --coverage --verbose
 
   e2e:
     name: E2E

doc/configuration.md

@@ -20,6 +20,7 @@ You can configure the server using environmnent variables. An `.env` file in the
 | REDIS_OPTIONS             | Advances options for redis. Refer to the [ioredis documentation](https://github.com/luin/ioredis/blob/master/API.md) (ex: `{"password":"admin123","connectTimeout":20000})`                                                                                                                                                                                                                                                   |
 | REDIS_SCOPE               | Allows to prefix Redis channels and keys when multiple clients use the same Redis cluster (e.g. `development`, `production`, `server-a`)                                                                                                                                                                                                                                                                                      |
 | LOGGING_ENABLED           | Toggles if incoming and outgoing messages are logged to the console. Defaults to `false` when in `production` mode and `true` when in `development` mode                                                                                                                                                                                                                                                                      |
+| SUPPRESS_LOGGING          | Completely disables all logging to the console                                                                                                                                                                                                                                                                                                                                                                                |
 | SYNC                      | Array of sync requests to be executed when the server starts. This can be used to configure sandboxes, or test clients                                                                                                                                                                                                                                                                                                        |
 | SKIP_LOAD_ENV             | If set to `true`, the server will skip loading any config from the `.env` file                                                                                                                                                                                                                                                                                                                                                |
 | NO_LOGO                   | Toggles the Messaging Server logo when starting the server                                                                                                                                                                                                                                                                                                                                                                    |

jest.e2e.config.ts

@@ -1,9 +1,8 @@
 import type { Config } from '@jest/types'
 import { defaults as tsjPreset } from 'ts-jest/presets'
 import { pathsToModuleNameMapper } from 'ts-jest/utils'
-
-const ClientConfig = require('./packages/client/test/tsconfig.json')
-const SocketConfig = require('./packages/socket/test/tsconfig.json')
+import ClientConfig from './packages/client/test/tsconfig.json'
+import SocketConfig from './packages/socket/test/tsconfig.json'
 
 const config: Config.InitialOptions = {
   preset: 'ts-jest',

jest.functional.config.ts

@@ -1,12 +1,10 @@
 import type { Config } from '@jest/types'
 import { defaults as tsjPreset } from 'ts-jest/presets'
 import { pathsToModuleNameMapper } from 'ts-jest/utils'
-
-const ServerConfig = require('./packages/server/test/tsconfig.json')
+import ServerConfig from './packages/server/test/tsconfig.json'
 
 const config: Config.InitialOptions = {
   preset: 'ts-jest',
-  globalSetup: './test/jest.functional.setup.ts',
   globalTeardown: './test/jest.functional.teardown.ts',
   projects: [
     {

jest.config.ts jest.unit.config.ts

@@ -1,8 +1,7 @@
 import type { Config } from '@jest/types'
 import { defaults as tsjPreset } from 'ts-jest/presets'
 import { pathsToModuleNameMapper } from 'ts-jest/utils'
-
-const ServerConfig = require('./packages/server/test/tsconfig.json')
+import ServerConfig from './packages/server/test/tsconfig.json'
 
 const config: Config.InitialOptions = {
   preset: 'ts-jest',
@@ -15,8 +14,6 @@ const config: Config.InitialOptions = {
       statements: 60
     }
   }*/
-  globalSetup: './test/jest.setup.ts',
-  globalTeardown: './test/jest.teardown.ts',
   projects: [
     {
       rootDir: 'packages/engine',

package.json

@@ -16,10 +16,10 @@
     "start": "yarn workspace @botpress/messaging-server start",
     "dev": "yarn workspace @botpress/messaging-server dev",
     "board": "yarn workspace @botpress/messaging-board dev",
-    "test": "yarn test:unit && yarn test:functional && yarn test:e2e",
-    "test:unit": "yarn --silent && jest",
-    "test:functional": "yarn --silent && jest -c jest.functional.config.ts",
-    "test:e2e": "yarn --silent && jest -c jest.e2e.config.ts"
+    "test": "yarn test:unit && yarn test:func && yarn test:e2e",
+    "test:unit": "jest -c jest.unit.config.ts",
+    "test:func": "jest -c jest.functional.config.ts",
+    "test:e2e": "jest -c jest.e2e.config.ts"
   },
   "bin": "./packages/server/dist/index.js",
   "pkg": {

packages/engine/src/global.ts

@@ -3,6 +3,7 @@ export interface EngineEnv {
 
   // logger
   LOGGING_ENABLED?: string
+  SUPPRESS_LOGGING?: string
   SINGLE_LINE_LOGGING?: string
   DISABLE_LOGGING_TIMESTAMP?: string
 

packages/engine/src/logger/types.ts

@@ -111,8 +111,10 @@ export class Logger {
       definedParams = this.singleLine(definedParams)
     }
 
-    // eslint-disable-next-line no-console
-    console.log(...definedParams)
+    if (!yn(process.env.SUPPRESS_LOGGING)) {
+      // eslint-disable-next-line no-console
+      console.log(...definedParams)
+    }
   }
 
   private singleLine(params: Param[]) {

packages/server/test/functional/utils/index.ts

@@ -1,10 +1,23 @@
+import path from 'path'
 import { v4 as uuidv4 } from 'uuid'
 import { App } from '../../../src/app'
 
 let app: App
 
 const setupApp = async () => {
-  process.env.DATABASE_URL = `.test-data/${uuidv4()}.sqlite`
+  process.env.SKIP_LOAD_ENV = 'true'
+  process.env.SUPPRESS_LOGGING = 'true'
+  process.env.DATABASE_URL = path.join(
+    __dirname,
+    '..',
+    '..',
+    '..',
+    '..',
+    '..',
+    'test',
+    '.test-data',
+    `${uuidv4()}.sqlite`
+  )
 
   app = new App()
   await app.setup()

test/jest.e2e.setup.ts

@@ -2,13 +2,13 @@
 require('ts-node/register')
 
 import { setup as setupDevServer } from 'jest-dev-server'
-import jestSetup from './jest.setup'
+import path from 'path'
+import { v4 as uuidv4 } from 'uuid'
 
 const setup = async () => {
-  await jestSetup()
-
-  // TODO: Maybe put this somewhere else?
+  process.env.SKIP_LOAD_ENV = 'true'
   process.env.ENABLE_EXPERIMENTAL_SOCKETS = 'true'
+  process.env.DATABASE_URL = path.join(__dirname, '.test-data', `${uuidv4()}.sqlite`)
 
   await setupDevServer({
     command: 'yarn dev',

test/jest.e2e.teardown.ts

@@ -1,8 +1,13 @@
+import fs from 'fs'
 import { teardown as teardownDevServer } from 'jest-dev-server'
-const jestTeardown = require('./jest.teardown').default
+import path from 'path'
 
 const teardown = async () => {
-  await jestTeardown()
+  const dir = path.join(__dirname, '.test-data')
+  if (fs.existsSync(dir)) {
+    fs.rmdirSync(dir, { recursive: true })
+  }
+
   await teardownDevServer()
 }
 

test/jest.functional.setup.ts

@@ -1,7 +1,11 @@
-const jestTeardown = require('./jest.teardown').default
+import fs from 'fs'
+import path from 'path'
 
 const teardown = async () => {
-  await jestTeardown()
+  const dir = path.join(__dirname, '.test-data')
+  if (fs.existsSync(dir)) {
+    fs.rmdirSync(dir, { recursive: true })
+  }
 }
 
 export default teardown

test/jest.functional.teardown.ts

@@ -8,6 +8,8 @@
   "include": [],
   "exclude": ["node_modules", "**/node_modules"],
   "compilerOptions": {
-    "esModuleInterop": true
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "strict": true
   }
 }