@nitwel/sandbox 1.0.1 → 1.0.2

package/dist/cockroachdb.yml

@@ -0,0 +1,14 @@
+services:
+  cockroachdb:
+    # change in the YY.R component denotes a major release
+    image: cockroachdb/cockroach:${DB_VERSION}
+    tmpfs: /cockroach/cockroach-data
+    command: start-single-node --cluster-name=example-single-node --insecure
+    ports:
+      - ${DB_PORT}:26257
+      - ${COCKROACH_UI}:8080
+    healthcheck:
+      test: ['CMD', 'curl', '--fail', 'http://localhost:8080/health']
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/dist/config.d.ts

@@ -96,7 +96,7 @@ declare const baseConfig: {
         readonly DB_PASSWORD: "secret";
         readonly DB_PORT: "$PORT";
         readonly DB_DATABASE: "directus";
-        readonly DB_VERSION: "18-alpine";
+        readonly DB_VERSION: "18-3.6-alpine";
     };
     readonly sqlite: {
         readonly TZ: "0" | "UTC";

package/dist/config.js

@@ -1,4 +1,5 @@
 import { join } from 'path';
+import { directusFolder } from './find-directus.js';
 const isWindows = ['win32', 'win64'].includes(process.platform);
 const directusConfig = {
     TZ: isWindows ? '0' : 'UTC',
@@ -9,7 +10,7 @@ const directusConfig = {
     TELEMETRY: 'false',
     CACHE_SCHEMA: 'true',
     CACHE_SCHEMA_MAX_ITERATIONS: '100',
-    CONFIG_PATH: join(import.meta.dirname, '..', '.env'), // Override to non existent file so process envs aren't overwritten by file envs
+    CONFIG_PATH: join(directusFolder, '.env'), // Override to non existent file so process envs aren't overwritten by file envs
     RATE_LIMITER_ENABLED: 'false',
     PRESSURE_LIMITER_ENABLED: 'false',
     LOG_LEVEL: 'info',
@@ -75,7 +76,7 @@ const postgres = {
     DB_PASSWORD: 'secret',
     DB_PORT: '$PORT',
     DB_DATABASE: 'directus',
-    DB_VERSION: '18-alpine',
+    DB_VERSION: '18-3.6-alpine',
     ...directusConfig,
 };
 const sqlite = {

package/dist/find-directus.d.ts

@@ -0,0 +1,2 @@
+export declare const directusFolder: string;
+export declare function findDirectus(): string;

package/dist/find-directus.js

@@ -0,0 +1,22 @@
+import { existsSync, readFileSync } from 'fs';
+import { dirname, join } from 'path';
+export const directusFolder = findDirectus();
+export function findDirectus() {
+    let currentDir = process.cwd();
+    while (true) {
+        const packagePath = join(currentDir, 'package.json');
+        if (existsSync(packagePath)) {
+            const file = readFileSync(packagePath, 'utf-8');
+            const json = JSON.parse(file);
+            if (json['name'] === 'directus-monorepo') {
+                return currentDir;
+            }
+        }
+        const parentDir = dirname(currentDir);
+        if (parentDir === currentDir) {
+            break;
+        }
+        currentDir = parentDir;
+    }
+    throw new Error('Sandbox is not executed in the directus monorepo');
+}

package/dist/maildev.yml

@@ -0,0 +1,12 @@
+services:
+  maildev:
+    image: maildev/maildev:latest
+    ports:
+      - '${MAILDEV_WEBUI}:1080' # Web interface
+      - '${EMAIL_SMTP_PORT}:1025' # SMTP server
+    restart: always
+    environment:
+      - MAILDEV_WEB_PORT=1080
+      - MAILDEV_SMTP_PORT=1025
+      - MAILDEV_INCOMING_USER=${EMAIL_SMTP_USER}
+      - MAILDEV_INCOMING_PASS=${EMAIL_SMTP_PASSWORD}

package/dist/maria.yml

@@ -0,0 +1,16 @@
+services:
+  maria:
+    image: mariadb:${DB_VERSION}
+    tmpfs: /var/lib/mysql
+    command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
+    environment:
+      MYSQL_ROOT_PASSWORD: ${DB_PASSWORD}
+      MYSQL_USER: ${DB_USER}
+      MYSQL_DATABASE: ${DB_DATABASE}
+    ports:
+      - ${DB_PORT}:3306
+    healthcheck:
+      test: ['CMD', 'healthcheck.sh', '--connect', '--innodb_initialized']
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/dist/minio.yml

@@ -0,0 +1,24 @@
+services:
+  minio:
+    # should stay compatible via S3 driver
+    image: minio/minio
+    command: server /data/minio/ --console-address :9001
+    ports:
+      - ${MINIO_PORT}:9000
+      - 8882:9001
+    environment:
+      MINIO_ROOT_USER: directus
+      MINIO_ROOT_PASSWORD: miniosecret
+
+  minio-mc:
+    image: minio/mc
+    depends_on:
+      - minio
+    entrypoint: >
+      /bin/sh -c " until (/usr/bin/mc alias set directusminio http://minio:9000 directus miniosecret &&
+             /usr/bin/mc admin info directusminio > /dev/null 2>&1); do
+          echo 'Waiting for MinIO to be ready...';
+          sleep 1;
+      done; /usr/bin/mc mb directusminio/directus-blackbox-test; while true; do
+          sleep 3600;
+      done;"

package/dist/mssql.yml

@@ -0,0 +1,28 @@
+services:
+  mssql:
+    image: mcr.microsoft.com/mssql/server:${DB_VERSION}
+    tmpfs: /var/opt/mssql/data
+    environment:
+      - ACCEPT_EULA=Y
+      - MSSQL_SA_PASSWORD=${DB_PASSWORD}
+      - MSSQL_PID=Express
+    ports:
+      - ${DB_PORT}:1433
+    healthcheck:
+      test:
+        [
+          'CMD',
+          '/opt/mssql-tools18/bin/sqlcmd',
+          '-S',
+          'localhost',
+          '-U',
+          'sa',
+          '-P',
+          '${DB_PASSWORD}',
+          '-Q',
+          'SELECT 1',
+          '-No',
+        ]
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/dist/mysql.yml

@@ -0,0 +1,15 @@
+services:
+  mysql:
+    image: mysql:${DB_VERSION}
+    tmpfs: /var/lib/mysql
+    command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
+    environment:
+      MYSQL_ROOT_PASSWORD: ${DB_PASSWORD}
+      MYSQL_DATABASE: ${DB_DATABASE}
+    ports:
+      - ${DB_PORT}:3306
+    healthcheck:
+      test: ['CMD', 'mysql', '--user=root', '--password=${DB_PASSWORD}', '--execute=SELECT 1;']
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/dist/oracle.yml

@@ -0,0 +1,16 @@
+services:
+  oracle:
+    image: gvenzl/oracle-xe:${DB_VERSION}
+    ports:
+      - ${DB_PORT}:1521
+    environment:
+      - OPATCH_JRE_MEMORY_OPTIONS=-Xms128m -Xmx256m -XX:PermSize=16m -XX:MaxPermSize=32m -Xss1m
+      - ORACLE_ALLOW_REMOTE=true
+      - ORACLE_RANDOM_PASSWORD=yes
+      - APP_USER=${DB_USER}
+      - APP_USER_PASSWORD=${DB_PASSWORD}
+    healthcheck:
+      test: healthcheck.sh
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/dist/postgres.yml

@@ -0,0 +1,14 @@
+services:
+  postgres:
+    image: postgis/postgis:${DB_VERSION}
+    environment:
+      POSTGRES_PASSWORD: ${DB_PASSWORD}
+      POSTGRES_USER: ${DB_USER}
+      POSTGRES_DB: ${DB_DATABASE}
+    ports:
+      - ${DB_PORT}:5432
+    healthcheck:
+      test: ['CMD-SHELL', 'pg_isready -U ${DB_USER} -d ${DB_DATABASE}']
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/dist/redis.yml

@@ -0,0 +1,5 @@
+services:
+  redis:
+    image: redis:6-alpine
+    ports:
+      - ${REDIS_PORT}:6379

package/dist/saml.yml

@@ -0,0 +1,10 @@
+services:
+  saml:
+    image: kristophjunge/test-saml-idp
+    ports:
+      - ${SAML_PORT}:8080
+    environment:
+      - SIMPLESAMLPHP_SP_ENTITY_ID=saml-test
+      - SIMPLESAMLPHP_SP_ASSERTION_CONSUMER_SERVICE=http://127.0.0.1:8080/auth/login/saml/acs
+    extra_hosts:
+      - 'host.docker.internal:host-gateway'

package/dist/sandbox.js

@@ -6,6 +6,7 @@ import { createLogger } from './logger.js';
 import { buildDirectus, bootstrap, dockerDown, dockerUp, loadSchema, saveSchema, startDirectus, } from './steps/index.js';
 import chalk from 'chalk';
 import getPort from 'get-port';
+import { directusFolder } from './find-directus.js';
 async function getOptions(options) {
     if (options?.schema === true)
         options.schema = 'snapshot.json';
@@ -39,7 +40,7 @@ async function getOptions(options) {
         cache: false,
     }, options);
 }
-export const apiFolder = join(import.meta.dirname, '..', '..', '..', 'api');
+export const apiFolder = join(directusFolder, 'api');
 export const databases = [
     'maria',
     'cockroachdb',

package/dist/steps/docker.js

@@ -15,15 +15,7 @@ export async function dockerUp(database, opts, env, logger) {
     const files = database === 'sqlite' ? extrasList : [database, ...extrasList];
     if (files.length === 0)
         return;
-    const docker = spawn('docker', [
-        'compose',
-        '-p',
-        project,
-        ...files.flatMap((file) => ['-f', join(import.meta.dirname, '..', 'docker', `${file}.yml`)]),
-        'up',
-        '-d',
-        '--wait',
-    ], {
+    const docker = spawn('docker', ['compose', '-p', project, ...files.flatMap((file) => ['-f', join('docker', `${file}.yml`)]), 'up', '-d', '--wait'], {
         env: {
             ...env,
             COMPOSE_STATUS_STDOUT: '1', //Ref: https://github.com/docker/compose/issues/7346

package/docker/cockroachdb.yml

@@ -0,0 +1,14 @@
+services:
+  cockroachdb:
+    # change in the YY.R component denotes a major release
+    image: cockroachdb/cockroach:${DB_VERSION}
+    tmpfs: /cockroach/cockroach-data
+    command: start-single-node --cluster-name=example-single-node --insecure
+    ports:
+      - ${DB_PORT}:26257
+      - ${COCKROACH_UI}:8080
+    healthcheck:
+      test: ['CMD', 'curl', '--fail', 'http://localhost:8080/health']
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/docker/maildev.yml

@@ -0,0 +1,12 @@
+services:
+  maildev:
+    image: maildev/maildev:latest
+    ports:
+      - '${MAILDEV_WEBUI}:1080' # Web interface
+      - '${EMAIL_SMTP_PORT}:1025' # SMTP server
+    restart: always
+    environment:
+      - MAILDEV_WEB_PORT=1080
+      - MAILDEV_SMTP_PORT=1025
+      - MAILDEV_INCOMING_USER=${EMAIL_SMTP_USER}
+      - MAILDEV_INCOMING_PASS=${EMAIL_SMTP_PASSWORD}

package/docker/maria.yml

@@ -0,0 +1,16 @@
+services:
+  maria:
+    image: mariadb:${DB_VERSION}
+    tmpfs: /var/lib/mysql
+    command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
+    environment:
+      MYSQL_ROOT_PASSWORD: ${DB_PASSWORD}
+      MYSQL_USER: ${DB_USER}
+      MYSQL_DATABASE: ${DB_DATABASE}
+    ports:
+      - ${DB_PORT}:3306
+    healthcheck:
+      test: ['CMD', 'healthcheck.sh', '--connect', '--innodb_initialized']
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/docker/minio.yml

@@ -0,0 +1,24 @@
+services:
+  minio:
+    # should stay compatible via S3 driver
+    image: minio/minio
+    command: server /data/minio/ --console-address :9001
+    ports:
+      - ${MINIO_PORT}:9000
+      - 8882:9001
+    environment:
+      MINIO_ROOT_USER: directus
+      MINIO_ROOT_PASSWORD: miniosecret
+
+  minio-mc:
+    image: minio/mc
+    depends_on:
+      - minio
+    entrypoint: >
+      /bin/sh -c " until (/usr/bin/mc alias set directusminio http://minio:9000 directus miniosecret &&
+             /usr/bin/mc admin info directusminio > /dev/null 2>&1); do
+          echo 'Waiting for MinIO to be ready...';
+          sleep 1;
+      done; /usr/bin/mc mb directusminio/directus-blackbox-test; while true; do
+          sleep 3600;
+      done;"

package/docker/mssql.yml

@@ -0,0 +1,28 @@
+services:
+  mssql:
+    image: mcr.microsoft.com/mssql/server:${DB_VERSION}
+    tmpfs: /var/opt/mssql/data
+    environment:
+      - ACCEPT_EULA=Y
+      - MSSQL_SA_PASSWORD=${DB_PASSWORD}
+      - MSSQL_PID=Express
+    ports:
+      - ${DB_PORT}:1433
+    healthcheck:
+      test:
+        [
+          'CMD',
+          '/opt/mssql-tools18/bin/sqlcmd',
+          '-S',
+          'localhost',
+          '-U',
+          'sa',
+          '-P',
+          '${DB_PASSWORD}',
+          '-Q',
+          'SELECT 1',
+          '-No',
+        ]
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/docker/mysql.yml

@@ -0,0 +1,15 @@
+services:
+  mysql:
+    image: mysql:${DB_VERSION}
+    tmpfs: /var/lib/mysql
+    command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
+    environment:
+      MYSQL_ROOT_PASSWORD: ${DB_PASSWORD}
+      MYSQL_DATABASE: ${DB_DATABASE}
+    ports:
+      - ${DB_PORT}:3306
+    healthcheck:
+      test: ['CMD', 'mysql', '--user=root', '--password=${DB_PASSWORD}', '--execute=SELECT 1;']
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/docker/oracle.yml

@@ -0,0 +1,16 @@
+services:
+  oracle:
+    image: gvenzl/oracle-xe:${DB_VERSION}
+    ports:
+      - ${DB_PORT}:1521
+    environment:
+      - OPATCH_JRE_MEMORY_OPTIONS=-Xms128m -Xmx256m -XX:PermSize=16m -XX:MaxPermSize=32m -Xss1m
+      - ORACLE_ALLOW_REMOTE=true
+      - ORACLE_RANDOM_PASSWORD=yes
+      - APP_USER=${DB_USER}
+      - APP_USER_PASSWORD=${DB_PASSWORD}
+    healthcheck:
+      test: healthcheck.sh
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/docker/postgres.yml

@@ -0,0 +1,14 @@
+services:
+  postgres:
+    image: postgis/postgis:${DB_VERSION}
+    environment:
+      POSTGRES_PASSWORD: ${DB_PASSWORD}
+      POSTGRES_USER: ${DB_USER}
+      POSTGRES_DB: ${DB_DATABASE}
+    ports:
+      - ${DB_PORT}:5432
+    healthcheck:
+      test: ['CMD-SHELL', 'pg_isready -U ${DB_USER} -d ${DB_DATABASE}']
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/docker/redis.yml

@@ -0,0 +1,5 @@
+services:
+  redis:
+    image: redis:6-alpine
+    ports:
+      - ${REDIS_PORT}:6379

package/docker/saml.yml

@@ -0,0 +1,10 @@
+services:
+  saml:
+    image: kristophjunge/test-saml-idp
+    ports:
+      - ${SAML_PORT}:8080
+    environment:
+      - SIMPLESAMLPHP_SP_ENTITY_ID=saml-test
+      - SIMPLESAMLPHP_SP_ASSERTION_CONSUMER_SERVICE=http://127.0.0.1:8080/auth/login/saml/acs
+    extra_hosts:
+      - 'host.docker.internal:host-gateway'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nitwel/sandbox",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Toolkit for spinning up directus test environments",
   "homepage": "https://directus.io",
   "exports": {
@@ -20,7 +20,7 @@
   "author": "Nils Twelker (nils@directus.io)",
   "license": "MIT",
   "private": false,
-  "dependencies": {
+  "devDependencies": {
     "@directus/tsconfig": "3.0.0",
     "@directus/utils": "13.0.9",
     "@types/lodash-es": "4.17.12",
@@ -50,7 +50,7 @@
   },
   "scripts": {
     "cli": "tsx src/cli.ts",
-    "build": "tsc && copyfiles src/docker/*.yml dist -u 1",
+    "build": "tsc && copyfiles docker/*.yml dist -u 1",
     "dev": "tsc -w ",
     "build:tests": "tsdown src/index.ts  --format=esm",
     "docs": "typedoc --plugin typedoc-plugin-markdown --out ./docs",