@adonisjs/assembler 5.5.2-0 → 5.6.0

package/build/commands/Invoke.d.ts

@@ -6,6 +6,7 @@ export default class Configure extends BaseCommand {
     static commandName: string;
     static description: string;
     static aliases: string[];
+    private appType;
     /**
      * Use yarn when building for production to install dependencies
      */

package/build/commands/Invoke.js

@@ -25,6 +25,10 @@ const Manifest_1 = require("../src/Manifest");
  * Configure a package
  */
 class Configure extends standalone_1.BaseCommand {
+    constructor() {
+        super(...arguments);
+        this.appType = process.env['ADONIS_CREATE_APP_BOILERPLATE'] || 'web';
+    }
     /**
      * Configure encore
      */
@@ -85,7 +89,7 @@ class Configure extends standalone_1.BaseCommand {
         /**
          * Create "tests/functional/hello_world.spec.ts" file
          */
-        const helloWorldTestFile = new sink_1.files.MustacheFile(this.application.appRoot, 'tests/functional/hello_world.spec.ts', (0, path_1.join)(__dirname, '..', 'templates/tests/functional/hello_world.spec.txt'));
+        const helloWorldTestFile = new sink_1.files.MustacheFile(this.application.appRoot, 'tests/functional/hello_world.spec.ts', (0, path_1.join)(__dirname, '..', `templates/tests/functional/hello_world_${this.appType}.spec.txt`));
         if (!helloWorldTestFile.exists()) {
             helloWorldTestFile.apply({}).commit();
             sink_1.logger.action('create').succeeded('tests/functional/hello_world.spec.ts');
@@ -113,6 +117,21 @@ class Configure extends standalone_1.BaseCommand {
         });
         rcFile.commit();
         sink_1.logger.action('update').succeeded('.adonisrc.json');
+        /**
+         * Create ".env.test" file
+         */
+        const testEnvFile = new sink_1.files.NewLineFile(this.application.appRoot, '.env.test');
+        if (!testEnvFile.exists()) {
+            testEnvFile.add('NODE_ENV=test');
+            /**
+             * Set additional .env variables for "web" boilerplate
+             */
+            if (this.appType === 'web') {
+                testEnvFile.add(['ASSETS_DRIVER=fake', 'SESSION_DRIVER=memory']);
+            }
+            testEnvFile.commit();
+            sink_1.logger.action('create').succeeded('.env.test');
+        }
         /**
          * Install required dependencies
          */

package/build/config/paths.d.ts

@@ -3,5 +3,5 @@ export declare const DEFAULT_BUILD_DIR = "build";
 export declare const RCFILE_NAME = ".adonisrc.json";
 export declare const ENV_FILES: string[];
 export declare const SERVER_ENTRY_FILE = "server.ts";
-export declare const TESTS_ENTRY_FILE = "tests.ts";
+export declare const TESTS_ENTRY_FILE = "test.ts";
 export declare const TSCONFIG_FILE_NAME = "tsconfig.json";

package/build/config/paths.js

@@ -14,5 +14,5 @@ exports.DEFAULT_BUILD_DIR = 'build';
 exports.RCFILE_NAME = '.adonisrc.json';
 exports.ENV_FILES = ['.env', '.env.testing'];
 exports.SERVER_ENTRY_FILE = 'server.ts';
-exports.TESTS_ENTRY_FILE = 'tests.ts';
+exports.TESTS_ENTRY_FILE = 'test.ts';
 exports.TSCONFIG_FILE_NAME = 'tsconfig.json';

package/build/src/EnvParser/index.d.ts

@@ -2,8 +2,10 @@
  * Parses the env file inside the project root.
  */
 export declare class EnvParser {
+    private envFileName;
     private envContents;
     private parser;
+    constructor(envFileName?: string);
     /**
      * Parse .env file contents
      */

package/build/src/EnvParser/index.js

@@ -16,7 +16,8 @@ const env_1 = require("@adonisjs/env");
  * Parses the env file inside the project root.
  */
 class EnvParser {
-    constructor() {
+    constructor(envFileName = '.env') {
+        this.envFileName = envFileName;
         this.envContents = {};
         this.parser = new env_1.EnvParser(false);
     }
@@ -25,7 +26,7 @@ class EnvParser {
      */
     async parse(rootDir) {
         try {
-            this.envContents = this.parser.parse(await (0, fs_extra_1.readFile)((0, path_1.join)(rootDir, '.env'), 'utf-8'));
+            this.envContents = this.parser.parse(await (0, fs_extra_1.readFile)((0, path_1.join)(rootDir, this.envFileName), 'utf-8'));
         }
         catch { }
     }

package/build/src/Test/index.d.ts

@@ -54,6 +54,11 @@ export declare class TestsServer {
      * Kill current process
      */
     private kill;
+    /**
+     * Returns the HOST and the PORT environment variables
+     * for the HTTP server
+     */
+    private getEnvironmentVariables;
     /**
      * Run tests. Use [[watch]] to also watch for file
      * changes

package/build/src/Test/index.js

@@ -21,6 +21,8 @@ const RcFile_1 = require("../RcFile");
 const Manifest_1 = require("../Manifest");
 const process_1 = require("./process");
 const paths_1 = require("../../config/paths");
+const EnvParser_1 = require("../EnvParser");
+const get_port_1 = __importDefault(require("get-port"));
 /**
  * Exposes the API to watch project for compilition changes and
  * run/re-run tests
@@ -99,6 +101,26 @@ class TestsServer {
     kill() {
         process.exit();
     }
+    /**
+     * Returns the HOST and the PORT environment variables
+     * for the HTTP server
+     */
+    async getEnvironmentVariables() {
+        const envParser = new EnvParser_1.EnvParser('.env.test');
+        await envParser.parse(this.appRoot);
+        const envOptions = envParser.asEnvObject(['PORT', 'TZ', 'HOST']);
+        const HOST = process.env.HOST || envOptions.HOST || '0.0.0.0';
+        let PORT = Number(process.env.PORT || envOptions.PORT);
+        /**
+         * Use the port defined inside ".env.test" file or use
+         * a random port
+         */
+        PORT = await (0, get_port_1.default)({
+            port: !isNaN(PORT) ? [PORT] : [],
+            host: HOST,
+        });
+        return { HOST, PORT: String(PORT) };
+    }
     /**
      * Run tests. Use [[watch]] to also watch for file
      * changes
@@ -116,7 +138,7 @@ class TestsServer {
             filters['--files'] = [filePath];
         }
         this.busy = true;
-        const { hasErrors } = await new process_1.TestProcess(paths_1.TESTS_ENTRY_FILE, this.appRoot, filters, this.nodeArgs, this.logger, {}).run();
+        const { hasErrors } = await new process_1.TestProcess(paths_1.TESTS_ENTRY_FILE, this.appRoot, filters, this.nodeArgs, this.logger, await this.getEnvironmentVariables()).run();
         this.busy = false;
         if (!this.watchingFileSystem) {
             if (hasErrors) {

package/build/templates/test-entrypoint.txt

@@ -12,7 +12,7 @@
 |
 */
 
-process.env.NODE_ENV = 'testing'
+process.env.NODE_ENV = 'test'
 
 import 'reflect-metadata'
 import sourceMapSupport from 'source-map-support'

package/build/templates/tests/bootstrap.txt

@@ -0,0 +1,69 @@
+/**
+ * File source: https://bit.ly/3ukaHTz
+ *
+ * Feel free to let us know via PR, if you find something broken in this contract
+ * file.
+ */
+
+import type { Config } from '@japa/runner'
+import TestUtils from '@ioc:Adonis/Core/TestUtils'
+import { assert, runFailedTests, specReporter, apiClient } from '@japa/preset-adonis'
+
+/*
+|--------------------------------------------------------------------------
+| Japa Plugins
+|--------------------------------------------------------------------------
+|
+| Japa plugins allows you to add additional features to Japa. By default
+| we register the assertion plugin.
+|
+| Feel free to remove existing plugins or add more.
+|
+*/
+export const plugins: Config['plugins'] = [assert(), runFailedTests(), apiClient()]
+
+/*
+|--------------------------------------------------------------------------
+| Japa Reporters
+|--------------------------------------------------------------------------
+|
+| Japa reporters displays/saves the progress of tests as they are executed.
+| By default, we register the spec reporter to show a detailed report
+| of tests on the terminal.
+|
+*/
+export const reporters: Config['reporters'] = [specReporter()]
+
+/*
+|--------------------------------------------------------------------------
+| Runner hooks
+|--------------------------------------------------------------------------
+|
+| Runner hooks are executed after booting the AdonisJS app and
+| before the test files are imported.
+|
+| You can perform actions like starting the HTTP server or running migrations
+| within the runner hooks
+|
+*/
+export const runnerHooks: Required<Pick<Config, 'setup' | 'teardown'>> = {
+  setup: [() => TestUtils.ace().loadCommands()],
+  teardown: [],
+}
+
+/*
+|--------------------------------------------------------------------------
+| Configure individual suites
+|--------------------------------------------------------------------------
+|
+| The configureSuite method gets called for every test suite registered
+| within ".adonisrc.json" file.
+|
+| You can use this method to configure suites. For example: Only start
+| the HTTP server when it is a functional suite.
+*/
+export const configureSuite: Config['configureSuite'] = (suite) => {
+  if (suite.name === 'functional') {
+    suite.setup(() => TestUtils.httpServer().start())
+  }
+}

package/build/templates/tests/functional/hello_world_api.spec.txt

@@ -0,0 +1,8 @@
+import { test } from '@japa/runner'
+
+test('display welcome page', async ({ client }) => {
+  const response = await client.get('/')
+
+  response.assertStatus(200)
+  response.assertBodyContains({ hello: 'world' })
+})

package/build/templates/tests/functional/hello_world_slim.spec.txt

@@ -0,0 +1,8 @@
+import { test } from '@japa/runner'
+
+test('display welcome page', async ({ client }) => {
+  const response = await client.get('/')
+
+  response.assertStatus(200)
+  response.assertTextIncludes('Hello world')
+})

package/build/templates/tests/functional/hello_world_web.spec.txt

@@ -0,0 +1,8 @@
+import { test } from '@japa/runner'
+
+test('display welcome page', async ({ client }) => {
+  const response = await client.get('/')
+
+  response.assertStatus(200)
+  response.assertTextIncludes('<h1 class="title"> It Works! </h1>')
+})

package/build/templates/tests-contract.txt

@@ -1,5 +1,5 @@
 /**
- * Contract source: https://github.com/adonisjs/core/blob/master/templates/contracts/tests.txt
+ * Contract source: https://bit.ly/3DP1ypf
  *
  * Feel free to let us know via PR, if you find something broken in this contract
  * file.
@@ -12,7 +12,7 @@ declare module '@japa/runner' {
     // Extend context
   }
 
-  interface Test<DataSet> {
+  interface Test<TestData> {
     // Extend test
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/assembler",
-  "version": "5.5.2-0",
+  "version": "5.6.0",
   "description": "Core commands to compiler and build AdonisJs project",
   "main": "build/ace-manifest.json",
   "files": [
@@ -19,7 +19,7 @@
     "lint": "eslint . --ext=.ts",
     "clean": "del build",
     "compile": "npm run lint && npm run clean && tsc",
-    "build": "npm run compile && node build/bin/index.js && copyfiles \"templates/*\" build",
+    "build": "npm run compile && node build/bin/index.js && copyfiles \"templates/**\" build",
     "commit": "git-cz",
     "release": "np --message=\"chore(release): %s\"",
     "version": "npm run build",
@@ -112,7 +112,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "next"
+    "tag": "latest"
   },
   "mrmConfig": {
     "core": true,