feat: add test command

Author: thetutlage

commands/Test.ts

@@ -0,0 +1,128 @@
+/*
+ * @adonisjs/assembler
+ *
+ * (c) Harminder Virk <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { BaseCommand, flags } from '@adonisjs/core/build/standalone'
+import { JapaFlags } from '../src/Contracts'
+
+/**
+ * Run tests
+ */
+export default class Test extends BaseCommand {
+  public static commandName = 'test'
+  public static description = 'Run AdonisJS tests'
+  public static settings = {
+    stayAlive: true,
+  }
+
+  /**
+   * Allows watching for file changes
+   */
+  @flags.boolean({
+    description: 'Watch for file changes and re-run tests on file change',
+    alias: 'w',
+  })
+  public watch: boolean
+
+  /**
+   * Detect changes by polling files
+   */
+  @flags.boolean({
+    description: 'Detect file changes by polling files instead of listening to filesystem events',
+    alias: 'p',
+  })
+  public poll: boolean
+
+  /**
+   * Arguments to pass to the `node` binary
+   */
+  @flags.array({ description: 'CLI options to pass to the node command line' })
+  public nodeArgs: string[] = []
+
+  @flags.array({ description: 'Run tests for only specified tags' })
+  public tags: string[]
+
+  @flags.array({ description: 'Run all the tests except the tests using specified tags' })
+  public ignoreTags: string[]
+
+  @flags.number({ description: 'Define timeout for tests' })
+  public timeout: number
+
+  @flags.array({ description: 'Run tests for only the specified suites' })
+  public suites: string[]
+
+  @flags.array({ description: 'Run tests for only the specified groups' })
+  public groups: string[]
+
+  @flags.array({ description: 'Run tests with the specified titles' })
+  public tests: string[]
+
+  @flags.boolean({ description: 'Force exit the tests runner process' })
+  public forceExit: boolean
+
+  /**
+   * Convert command flags to test filters
+   */
+  private getTestFilters() {
+    const filters: JapaFlags = {}
+    if (this.forceExit) {
+      filters['--force-exit'] = true
+    }
+
+    if (this.timeout !== undefined) {
+      filters['--timeout'] = this.timeout
+    }
+
+    if (this.tests) {
+      filters['--tests'] = this.tests
+    }
+
+    if (this.groups) {
+      filters['--groups'] = this.groups
+    }
+
+    if (this.suites) {
+      filters['--suites'] = this.suites
+    }
+
+    if (this.tags) {
+      filters['--tags'] = this.tags
+    }
+
+    if (this.ignoreTags) {
+      filters['--ignore-tags'] = this.ignoreTags
+    }
+
+    return filters
+  }
+
+  public async run() {
+    const { TestsServer } = await import('../src/Test')
+
+    try {
+      if (this.watch) {
+        await new TestsServer(
+          this.application.appRoot,
+          this.getTestFilters(),
+          this.nodeArgs,
+          this.logger
+        ).watch()
+      } else {
+        await new TestsServer(
+          this.application.appRoot,
+          this.getTestFilters(),
+          this.nodeArgs,
+          this.logger
+        ).run()
+      }
+    } catch (error) {
+      this.exitCode = 1
+      this.logger.fatal(error)
+    }
+  }
+}

config/paths.ts

@@ -12,4 +12,5 @@ export const DEFAULT_BUILD_DIR = 'build'
 export const RCFILE_NAME = '.adonisrc.json'
 export const ENV_FILES = ['.env', '.env.testing']
 export const SERVER_ENTRY_FILE = 'server.ts'
+export const TESTS_ENTRY_FILE = 'tests.ts'
 export const TSCONFIG_FILE_NAME = 'tsconfig.json'

src/Contracts/index.ts

@@ -0,0 +1,19 @@
+/*
+ * @adonisjs/assembler
+ *
+ * (c) Harminder Virk <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export type JapaFlags = Partial<{
+  '--tests': string[]
+  '--tags': string[]
+  '--groups': string[]
+  '--ignore-tags': string[]
+  '--files': string[]
+  '--timeout': number
+  '--suites': string[]
+  '--force-exit': boolean
+}>

src/RcFile/index.ts

@@ -38,6 +38,11 @@ export class RcFile {
    */
   public isMetaFile: (filePath: string) => boolean = picomatch(this.getMetaFilesGlob())
 
+  /**
+   * A matcher to know if file is a test file or not
+   */
+  public isTestsFile: (filePath: string) => boolean = picomatch(this.getTestsFileGlob())
+
   /**
    * A matcher to know if a file is part of the restart server files globs
    */
@@ -99,6 +104,19 @@ export class RcFile {
       .concat([ACE_FILE_NAME])
   }
 
+  /**
+   * Returns an array of globs for the test files
+   */
+  public getTestsFileGlob(): string[] {
+    return this.application.rcFile.tests.suites.reduce((result, suite) => {
+      if (suite.files) {
+        result = result.concat(suite.files)
+      }
+
+      return result
+    }, [] as string[])
+  }
+
   /**
    * Reloads the rcfile.json
    */
@@ -119,6 +137,7 @@ export class RcFile {
         reload: true,
         rcFile: true,
         metaFile: true,
+        testFile: false,
       }
     }
 
@@ -130,6 +149,7 @@ export class RcFile {
         reload: true,
         rcFile: false,
         metaFile: true,
+        testFile: false,
       }
     }
 
@@ -141,6 +161,19 @@ export class RcFile {
         reload: false,
         rcFile: false,
         metaFile: true,
+        testFile: false,
+      }
+    }
+
+    /**
+     * File is part of one of the tests suite
+     */
+    if (this.isTestsFile(filePath)) {
+      return {
+        reload: false,
+        rcFile: false,
+        metaFile: false,
+        testFile: true,
       }
     }
 
@@ -151,6 +184,7 @@ export class RcFile {
       reload: false,
       rcFile: false,
       metaFile: false,
+      testFile: false,
     }
   }
 }