fix: make command metadata specs side effect free

Author: Arcoders

tests/unit/commands/create_tenant.spec.ts

@@ -1,27 +1,26 @@
 import { test } from '@japa/runner'
 import { readFile } from 'node:fs/promises'
-import CreateTenant from '../../../src/commands/create_tenant.js'
 
+/**
+ * Metadata-only spec. We intentionally do NOT import
+ * `src/commands/create_tenant.ts`: its module graph reaches
+ * `jobs/install_tenant.ts`, which eagerly imports
+ * `@adonisjs/core/services/logger`. That logger module top-level
+ * `await`s `app.booted(...)`, which throws when evaluated outside an
+ * Ignitor (i.e. the unit suite). Reading the same contract from
+ * `commands.json` + the barrel keeps the assertion meaningful while
+ * staying side-effect-free.
+ */
 test.group('tenant:create — command metadata', () => {
-  test('exports a command with the canonical name', ({ assert }) => {
-    assert.equal(CreateTenant.commandName, 'tenant:create')
-  })
-
-  test('description names the contract clearly', ({ assert }) => {
-    assert.match(CreateTenant.description, /create a new tenant/i)
-  })
-
-  test('starts the app (needs the container booted to resolve the repo)', ({ assert }) => {
-    assert.equal(CreateTenant.options?.startApp, true)
-  })
-
-  test('is registered in commands.json with name + email args', async ({ assert }) => {
+  test('is registered in commands.json with the canonical contract', async ({ assert }) => {
     const json = JSON.parse(
       await readFile(new URL('../../../src/commands/commands.json', import.meta.url), 'utf-8')
     )
     const entry = json.commands.find((c: any) => c.commandName === 'tenant:create')
     assert.exists(entry, 'tenant:create missing from commands.json')
     assert.equal(entry.filePath, 'create_tenant.js')
+    assert.match(entry.description, /create a new tenant/i)
+    assert.equal(entry.options?.startApp, true, 'must start the app to resolve the repo')
 
     const argNames = entry.args.map((a: any) => a.argumentName)
     assert.deepEqual(argNames, ['name', 'email'])

tests/unit/commands/destroy_tenant.spec.ts

@@ -1,29 +1,21 @@
 import { test } from '@japa/runner'
 import { readFile } from 'node:fs/promises'
-import DestroyTenant from '../../../src/commands/destroy_tenant.js'
 
+/**
+ * Metadata-only spec — see `create_tenant.spec.ts` for the rationale
+ * behind not importing the command module here. We assert the same
+ * contract through `commands.json` + the barrel.
+ */
 test.group('tenant:destroy — command metadata', () => {
-  test('exports a command with the canonical name', ({ assert }) => {
-    assert.equal(DestroyTenant.commandName, 'tenant:destroy')
-  })
-
-  test('description names the contract clearly', ({ assert }) => {
-    assert.match(DestroyTenant.description, /soft-delete.*tear down/i)
-  })
-
-  test('starts the app (lifecycle hooks + driver need the container)', ({ assert }) => {
-    assert.equal(DestroyTenant.options?.startApp, true)
-  })
-
-  test('is registered in commands.json with --force and --keep-schema flags', async ({
-    assert,
-  }) => {
+  test('is registered in commands.json with the canonical contract', async ({ assert }) => {
     const json = JSON.parse(
       await readFile(new URL('../../../src/commands/commands.json', import.meta.url), 'utf-8')
     )
     const entry = json.commands.find((c: any) => c.commandName === 'tenant:destroy')
     assert.exists(entry, 'tenant:destroy missing from commands.json')
     assert.equal(entry.filePath, 'destroy_tenant.js')
+    assert.match(entry.description, /soft-delete.*tear down/i)
+    assert.equal(entry.options?.startApp, true)
 
     const flagNames = entry.flags.map((f: any) => f.flagName).sort()
     assert.deepEqual(flagNames, ['force', 'keep-schema'])

tests/unit/commands/tenant_backup.spec.ts

@@ -1,27 +1,20 @@
 import { test } from '@japa/runner'
 import { readFile } from 'node:fs/promises'
-import TenantBackup from '../../../src/commands/tenant_backup.js'
 
+/**
+ * Metadata-only spec — see `create_tenant.spec.ts` for the rationale
+ * behind not importing the command module here.
+ */
 test.group('tenant:backup — command metadata', () => {
-  test('exports a command with the canonical name', ({ assert }) => {
-    assert.equal(TenantBackup.commandName, 'tenant:backup')
-  })
-
-  test('description names the contract clearly', ({ assert }) => {
-    assert.match(TenantBackup.description, /backup.*tenant/i)
-  })
-
-  test('starts the app (BackupService reads runtime config)', ({ assert }) => {
-    assert.equal(TenantBackup.options?.startApp, true)
-  })
-
-  test('is registered in commands.json with the --tenant filter flag', async ({ assert }) => {
+  test('is registered in commands.json with the canonical contract', async ({ assert }) => {
     const json = JSON.parse(
       await readFile(new URL('../../../src/commands/commands.json', import.meta.url), 'utf-8')
     )
     const entry = json.commands.find((c: any) => c.commandName === 'tenant:backup')
     assert.exists(entry, 'tenant:backup missing from commands.json')
     assert.equal(entry.filePath, 'tenant_backup.js')
+    assert.match(entry.description, /backup.*tenant/i)
+    assert.equal(entry.options?.startApp, true)
 
     const flagNames = entry.flags.map((f: any) => f.flagName).sort()
     assert.deepEqual(flagNames, ['tenant'])

tests/unit/commands/tenant_doctor.spec.ts

@@ -1,27 +1,20 @@
 import { test } from '@japa/runner'
 import { readFile } from 'node:fs/promises'
-import TenantDoctor from '../../../src/commands/tenant_doctor.js'
 
+/**
+ * Metadata-only spec — see `create_tenant.spec.ts` for the rationale
+ * behind not importing the command module here.
+ */
 test.group('tenant:doctor — command metadata', () => {
-  test('exports a command with the canonical name', ({ assert }) => {
-    assert.equal(TenantDoctor.commandName, 'tenant:doctor')
-  })
-
-  test('description names the contract clearly', ({ assert }) => {
-    assert.match(TenantDoctor.description, /diagnose tenancy state/i)
-  })
-
-  test('starts the app (DoctorService and checks need the container booted)', ({ assert }) => {
-    assert.equal(TenantDoctor.options?.startApp, true)
-  })
-
   test('is registered in commands.json with the full operator surface', async ({ assert }) => {
     const json = JSON.parse(
       await readFile(new URL('../../../src/commands/commands.json', import.meta.url), 'utf-8')
     )
     const entry = json.commands.find((c: any) => c.commandName === 'tenant:doctor')
     assert.exists(entry, 'tenant:doctor missing from commands.json')
     assert.equal(entry.filePath, 'tenant_doctor.js')
+    assert.match(entry.description, /diagnose tenancy state/i)
+    assert.equal(entry.options?.startApp, true)
 
     const flagNames = entry.flags.map((f: any) => f.flagName).sort()
     assert.deepEqual(flagNames, ['check', 'fix', 'interval', 'json', 'tenant', 'watch'])

tests/unit/commands/tenant_restore.spec.ts

@@ -1,29 +1,20 @@
 import { test } from '@japa/runner'
 import { readFile } from 'node:fs/promises'
-import TenantRestore from '../../../src/commands/tenant_restore.js'
 
+/**
+ * Metadata-only spec — see `create_tenant.spec.ts` for the rationale
+ * behind not importing the command module here.
+ */
 test.group('tenant:restore — command metadata', () => {
-  test('exports a command with the canonical name', ({ assert }) => {
-    assert.equal(TenantRestore.commandName, 'tenant:restore')
-  })
-
-  test('description names the contract clearly', ({ assert }) => {
-    assert.match(TenantRestore.description, /restore.*backup/i)
-  })
-
-  test('starts the app (BackupService reads runtime config)', ({ assert }) => {
-    assert.equal(TenantRestore.options?.startApp, true)
-  })
-
-  test('is registered in commands.json with --tenant + --file required flags', async ({
-    assert,
-  }) => {
+  test('is registered in commands.json with the canonical contract', async ({ assert }) => {
     const json = JSON.parse(
       await readFile(new URL('../../../src/commands/commands.json', import.meta.url), 'utf-8')
     )
     const entry = json.commands.find((c: any) => c.commandName === 'tenant:restore')
     assert.exists(entry, 'tenant:restore missing from commands.json')
     assert.equal(entry.filePath, 'tenant_restore.js')
+    assert.match(entry.description, /restore.*backup/i)
+    assert.equal(entry.options?.startApp, true)
 
     const flagNames = entry.flags.map((f: any) => f.flagName).sort()
     assert.deepEqual(flagNames, ['file', 'tenant'])