Merge branch 'feature/console_resource_add_tests' into develop

Author: hirsch88

README.md

@@ -40,27 +40,104 @@ Try it!! We are happy to hear your feedback or any kind of new features.
 - **Integrated Testing Tool** thanks to [Wallaby.js](https://wallabyjs.com/)
 
 ## Getting Started
-### Prerequisites
-* Install [Node.js](http://nodejs.org)
-    * on OSX use [homebrew](http://brew.sh) `brew install node`
-    * on Windows use [chocolatey](https://chocolatey.org/) `choco install nodejs`
-* Install yarn globally `npm install yarn -g`
-
-### Installing
-* `fork` this repo
-* `clone` your fork
-* `cp .env.example .env` to copy the example .env file and enter your database connection
-* Create a new database. You will find the name in the .env file.
-* Run `npm run setup` or enter the following commands manually:
-    * `yarn install` to install all dependencies and typings.
-    * `npm run db:migrate` to create the schema.
-    * `npm run db:seed` to insert some test data.
-* `npm run serve` to start the application.
-
-### Running the app
-After you have installed all dependencies you can run the app.
-Enter `npm run serve` to start a local server using `nodemon`, which will watch for any file changes and will restart the sever according to these changes.
-The server address will be displayed to you as `http://0.0.0.0:3000`.
+### Step 1:  Set up the Development Environment
+You need to set up your development environment before you can do anything.
+
+Install [Node.js and NPM](https://nodejs.org/en/download/)
+* on OSX use [homebrew](http://brew.sh) `brew install node`
+* on Windows use [chocolatey](https://chocolatey.org/) `choco install nodejs`
+
+Install yarn globally
+```
+npm install yarn -g
+```
+
+Install a MySQL database.
+
+> If you work with a mac, we recommend to use homebrew for the installation.
+
+### Step 2: Create new Project
+Fork or download this project. Configure your package.json for your new project.
+
+Then copy the `example.env` file and rename it to `.env`. In this file you have to add your database connection information.
+
+Create a new database with the name you have in your `.env`-file.
+
+Then setup your application environment.
+```
+npm run setup
+```
+
+> This installs all dependencies with yarn. After that it migrates the database and seeds some test data into it. So after that your development environment is ready to use.
+
+### Step 3: Serve your App
+Go to the project dir and start your app with this npm script.
+```
+npm run serve
+```
+
+> This starts a local server using `nodemon`, which will watch for any file changes and will restart the sever according to these changes.
+> The server address will be displayed to you as `http://0.0.0.0:3000`.
+
+### Step 4: Create a new Resource
+Go to the project dir and hit this command in your terminal.
+```
+npm run console make:resource
+```
+
+Apply the same information like you see in the screenshot below.
+
+![console](console.png)
+
+> With that you just have created a complete new endpoint in your api for the resource pets.
+
+Normally a pet belogns to a user, so we have to add the relationship between users an pets. Open the created migration file and replace the user property with these lines.
+```
+table.integer('user_id').unsigned();
+table.foreign('user_id').references('id').inTable('users').onDelete('cascade');
+```
+
+Next we have to add this relationship also in the pets model.
+```
+public user(): User {
+    return this.belongsTo(User);
+}
+```
+
+> The relationship between the users and pets are set and ready. So you can migrate your database with `npm run db:migrate`
+
+### Step 5: Create a Seeder
+To seed some cute pets we need a smart factory. So open the ./src/database/factories/index.ts and add this code.
+```
+/**
+ * PET - Factory
+ */
+factory.define(Pet, (faker: Faker.FakerStatic, args: any[]) => {
+    const type = args[0];
+    return {
+        name: faker.name.firstName(),
+        type: type || 'dog',
+        userId: factory.get(User).returning('id')
+    };
+});
+```
+
+> This factory helps us to create a fake pet to seed to the database.
+
+Run this command in your terminal and call the new seeder `create pets`.
+```
+npm run console make:seed
+```
+
+Open the file and place this code into it.
+```
+await factory.get(Pet)
+    .create(10);
+```
+
+> Now we can seed some nice cats into the database with `npm run db:seed`.
+
+> That was easy! Now its your turn to make something great out of it.
 
 ## Scripts / Tasks
 All script are defined in the package.json file, but the most important ones are listed here.

console.png

@@ -0,0 +1,21 @@
+/**
+ * MakeSeedCommand
+ * -------------------------------------
+ *
+ */
+import { AbstractMakeCommand } from './lib/AbstractMakeCommand';
+
+
+export class MakeApiTestCommand extends AbstractMakeCommand {
+
+    public static command = 'make:api-test';
+    public static description = 'Generate new api test';
+
+    public target = '/black-box';
+    public type = 'API Test';
+    public suffix = '';
+    public template = 'api-test.hbs';
+    public updateTargets = false;
+    public isTest = true;
+
+}

src/console/MakeApiTestCommand.ts

@@ -47,7 +47,7 @@ export class MakeModelCommand extends AbstractMakeCommand {
         await super.write();
 
         // Create interface for this resource object
-        const filePath = buildFilePath('types/resources', this.context.name.camelCase, '.d.ts');
+        const filePath = buildFilePath('types/resources', this.context.name.camelCase, false, '.d.ts');
         await existsFile(filePath, true);
         await writeTemplate('resource.hbs', filePath, this.context);
     }

src/console/MakeModelCommand.ts

@@ -10,6 +10,7 @@ import { MakeRepoCommand } from './MakeRepoCommand';
 import { MakeServiceCommand } from './MakeServiceCommand';
 import { MakeControllerCommand } from './MakeControllerCommand';
 import { MakeRequestCommand } from './MakeRequestCommand';
+import { MakeApiTestCommand } from './MakeApiTestCommand';
 
 
 export class MakeResourceCommand extends AbstractMakeCommand {
@@ -29,9 +30,10 @@ export class MakeResourceCommand extends AbstractMakeCommand {
     public makeControllerCommand: AbstractMakeCommand;
     public makeCreateRequestCommand: MakeRequestCommand;
     public makeUpdateRequestCommand: MakeRequestCommand;
+    public makeApiTestCommand: MakeApiTestCommand;
 
     public async run(): Promise<void> {
-        this.context = await askFileName(this.context, this.type, this.suffix, this.prefix);
+        this.context = await this.askFileName(this.context, this.type, this.suffix, this.prefix);
         this.context.properties = await askProperties(this.context.name);
         this.context.hasProperties = true;
         this.context.isResourceTemplate = true;
@@ -43,6 +45,7 @@ export class MakeResourceCommand extends AbstractMakeCommand {
         this.makeControllerCommand = new MakeControllerCommand(this.context);
         this.makeCreateRequestCommand = new MakeRequestCommand(this.context, 'Create');
         this.makeUpdateRequestCommand = new MakeRequestCommand(this.context, 'Update');
+        this.makeApiTestCommand = new MakeApiTestCommand(this.context);
 
         // Ask all meta-data
         await this.makeModelCommand.run();
@@ -51,6 +54,7 @@ export class MakeResourceCommand extends AbstractMakeCommand {
         await this.makeControllerCommand.run();
         await this.makeCreateRequestCommand.run();
         await this.makeUpdateRequestCommand.run();
+        await this.makeApiTestCommand.run();
     }
 
     public async write(): Promise<void> {
@@ -60,6 +64,7 @@ export class MakeResourceCommand extends AbstractMakeCommand {
         await this.makeControllerCommand.write();
         await this.makeCreateRequestCommand.write();
         await this.makeUpdateRequestCommand.write();
+        await this.makeApiTestCommand.write();
     }
 
 }

src/console/MakeResourceCommand.ts

@@ -3,9 +3,9 @@
  * -------------------------------------
  *
  */
+import * as _ from 'lodash';
 import { AbstractMakeCommand } from './lib/AbstractMakeCommand';
 
-
 export class MakeSeedCommand extends AbstractMakeCommand {
 
     public static command = 'make:seed';
@@ -17,4 +17,10 @@ export class MakeSeedCommand extends AbstractMakeCommand {
     public template = 'seed.hbs';
     public updateTargets = false;
 
+    public parseName(suffix: string = '', prefix: string = ''): (name: string) => string {
+        return (name: string) => {
+            return _.snakeCase(name);
+        };
+    }
+
 }

src/console/MakeSeedCommand.ts

@@ -4,8 +4,11 @@
  *
  */
 import * as _ from 'lodash';
+import * as path from 'path';
+import * as inquirer from 'inquirer';
+
 import { writeTemplate } from './template';
-import { askFileName, buildFilePath, existsFile, parseName, updateTargets } from './utils';
+import { existsFile, parseName, updateTargets, inputIsRequired } from './utils';
 
 export interface MakeCommand {
     context: any;
@@ -44,20 +47,56 @@ export class AbstractMakeCommand {
     public template = 'template.hbs';
     public target = 'api/target/path';
     public updateTargets = true;
+    public isTest = false;
 
     constructor(context?: any) {
         this.context = _.cloneDeep(context);
     }
 
     public async run(): Promise<void> {
-        this.context = await askFileName(this.context, this.type, this.suffix, this.prefix);
+        this.context = await this.askFileName(this.context, this.type, this.suffix, this.prefix);
     }
 
     public async write(): Promise<void> {
-        const filePath = buildFilePath(this.target, this.context.name);
-        await existsFile(filePath, true);
+        const filePath = this.buildFilePath(this.target, this.context.name, this.isTest);
+        await existsFile(filePath, true, this.isTest);
         this.context.name = parseName(this.context.name, this.suffix);
         await writeTemplate(this.template, filePath, this.context);
     }
 
+    public buildFilePath = (targetPath: string, fileName: string, isTest = false, extension = '.ts') => {
+        return path.join(__dirname, `/../../${targetPath}`, `${fileName}${extension}`);
+    }
+
+    public parseName(suffix: string = '', prefix: string = ''): (name: string) => string {
+        return (name: string) => {
+            let ns = name.split('/');
+            ns = ns.map((v) => _.camelCase(v));
+            ns[ns.length - 1] = _.capitalize(ns[ns.length - 1]);
+            return (ns.join('/')) + prefix + suffix;
+        };
+    }
+
+    public async askFileName(context: any, name: string, suffix: string, prefix: string): Promise<any> {
+        const nameParser = this.parseName(suffix, prefix);
+        if (context === undefined || context.name === undefined) {
+            const prompt = inquirer.createPromptModule();
+            context = await prompt([
+                {
+                    type: 'input',
+                    name: 'name',
+                    message: `Enter the name of the ${name}:`,
+                    filter: nameParser,
+                    validate: inputIsRequired
+                }
+            ]);
+            const amount = context.name.split('/').length - 1;
+            context.deepness = '';
+            _.times(amount, () => context.deepness += '../');
+        } else {
+            context.name = nameParser(context.name);
+        }
+        return context;
+    }
+
 }

src/console/lib/AbstractMakeCommand.ts

@@ -21,50 +21,40 @@ export const removeSufix = (suffix: string, value: string) => {
 };
 
 export const filterInput = (suffix: string, prefix = '') => (value: string) => {
+    if (value.indexOf('/') < 0) {
+        return value;
+    }
     let vs = value.split('/');
     vs = vs.map((v) => _.camelCase(v));
     vs[vs.length - 1] = _.capitalize(vs[vs.length - 1]);
     return (vs.join('/')) + prefix + suffix;
 };
 
-export const buildFilePath = (targetPath: string, fileName: string, extension = '.ts') =>
-    path.join(__dirname, `/../../${targetPath}`, `${fileName}${extension}`);
-
-export const inputIsRequired = (value: any) => !!value;
-
-export const askFileName = async (context: any, name: string, suffix: string, prefix: string) => {
-    if (context === undefined || context.name === undefined) {
-        const prompt = inquirer.createPromptModule();
-        context = await prompt([
-            {
-                type: 'input',
-                name: 'name',
-                message: `Enter the name of the ${name}:`,
-                filter: filterInput(suffix, prefix),
-                validate: inputIsRequired
-            }
-        ]);
-        const amount = context.name.split('/').length - 1;
-        context.deepness = '';
-        _.times(amount, () => context.deepness += '../');
+export const buildFilePath = (targetPath: string, fileName: string, isTest = false, extension = '.ts') => {
+    if (isTest) {
+        return path.join(__dirname, `/../../../test/${targetPath}`, `${fileName}.test${extension}`);
     } else {
-        context.name = filterInput(suffix, prefix)(context.name);
+        return path.join(__dirname, `/../../${targetPath}`, `${fileName}${extension}`);
     }
-    return context;
 };
 
-export const existsFile = async (path: string, stop: boolean = false) => {
+export const inputIsRequired = (value: any) => !!value;
+
+export const existsFile = async (path: string, stop: boolean = false, isTest = false) => {
     const prompt = inquirer.createPromptModule();
     return new Promise((resolve, reject) => {
         fs.exists(path, async (exists) => {
 
             if (exists) {
-                const fileName = path.split('/src/')[1];
+                let fileName = path.split('/src/')[1];
+                if (isTest) {
+                    fileName = path.split('/test/')[1];
+                }
                 const answer = await prompt([
                     {
                         type: 'confirm',
                         name: 'override',
-                        message: `Override "src/${fileName}"?`,
+                        message: `Override "${isTest ? 'test' : 'src'}/${fileName}"?`,
                         default: true
                     }
                 ]);