make_controller.spec.ts

/*
 * @adonisjs/core
 *
 * (c) AdonisJS
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

import { test } from '@japa/runner'
import { AceFactory } from '../../factories/core/ace.js'
import { StubsFactory } from '../../factories/stubs.js'
import MakeControllerCommand from '../../commands/make/controller.js'

test.group('Make controller', () => {
  test('create controller', async ({ assert, fs }) => {
    const ace = await new AceFactory().make(fs.baseUrl)
    await ace.app.init()
    ace.ui.switchMode('raw')

    const command = await ace.create(MakeControllerCommand, ['user'])
    await command.exec()

    const { contents } = await new StubsFactory().prepare('make/controller/main.stub', {
      entity: ace.app.generators.createEntity('user'),
      singular: false,
    })

    await assert.fileEquals('app/controllers/users_controller.ts', contents)

    assert.deepEqual(ace.ui.logger.getLogs(), [
      {
        message: 'green(DONE:)    create app/controllers/users_controller.ts',
        stream: 'stdout',
      },
    ])
  })

  test('skip when controller already exists', async ({ assert, fs }) => {
    const ace = await new AceFactory().make(fs.baseUrl)
    await ace.app.init()
    ace.ui.switchMode('raw')

    await fs.create('app/controllers/users_controller.ts', `export default class {}`)

    const command = await ace.create(MakeControllerCommand, ['user'])
    await command.exec()

    await assert.fileEquals('app/controllers/users_controller.ts', `export default class {}`)

    assert.deepEqual(ace.ui.logger.getLogs(), [
      {
        message:
          'cyan(SKIPPED:) create app/controllers/users_controller.ts dim((File already exists))',
        stream: 'stdout',
      },
    ])
  })

  test('create resource controller', async ({ assert, fs }) => {
    const ace = await new AceFactory().make(fs.baseUrl)
    await ace.app.init()
    ace.ui.switchMode('raw')

    const command = await ace.create(MakeControllerCommand, ['user', '--resource'])
    await command.exec()

    const { contents } = await new StubsFactory().prepare('make/controller/resource.stub', {
      entity: ace.app.generators.createEntity('user'),
      singular: false,
    })

    await assert.fileEquals('app/controllers/users_controller.ts', contents)

    assert.deepEqual(ace.ui.logger.getLogs(), [
      {
        message: 'green(DONE:)    create app/controllers/users_controller.ts',
        stream: 'stdout',
      },
    ])
  })

  test('create api controller', async ({ assert, fs }) => {
    const ace = await new AceFactory().make(fs.baseUrl)
    await ace.app.init()
    ace.ui.switchMode('raw')

    const command = await ace.create(MakeControllerCommand, ['user', '--api'])
    await command.exec()

    const { contents } = await new StubsFactory().prepare('make/controller/api.stub', {
      entity: ace.app.generators.createEntity('user'),
      singular: false,
    })

    await assert.fileEquals('app/controllers/users_controller.ts', contents)

    assert.deepEqual(ace.ui.logger.getLogs(), [
      {
        message: 'green(DONE:)    create app/controllers/users_controller.ts',
        stream: 'stdout',
      },
    ])
  })

  test('create api controller when both api and resource flags are used', async ({
    assert,
    fs,
  }) => {
    const ace = await new AceFactory().make(fs.baseUrl)
    await ace.app.init()
    ace.ui.switchMode('raw')

    const command = await ace.create(MakeControllerCommand, ['user', '--api', '--resource'])
    await command.exec()

    const { contents } = await new StubsFactory().prepare('make/controller/api.stub', {
      entity: ace.app.generators.createEntity('user'),
      singular: false,
    })

    await assert.fileEquals('app/controllers/users_controller.ts', contents)

    assert.deepEqual(ace.ui.logger.getLogs(), [
      {
        message:
          '[ yellow(warn) ] --api and --resource flags cannot be used together. Ignoring --resource',
        stream: 'stdout',
      },
      {
        message: 'green(DONE:)    create app/controllers/users_controller.ts',
        stream: 'stdout',
      },
    ])
  })

  test('create controller with actions', async ({ assert, fs }) => {
    const ace = await new AceFactory().make(fs.baseUrl)
    await ace.app.init()
    ace.ui.switchMode('raw')

    const command = await ace.create(MakeControllerCommand, [
      'user',
      'index',
      'show',
      'delete-profile',
    ])
    await command.exec()

    const { contents } = await new StubsFactory().prepare('make/controller/actions.stub', {
      entity: ace.app.generators.createEntity('user'),
      singular: false,
      actions: ['index', 'show', 'deleteProfile'],
    })

    await assert.fileEquals('app/controllers/users_controller.ts', contents)

    assert.deepEqual(ace.ui.logger.getLogs(), [
      {
        message: 'green(DONE:)    create app/controllers/users_controller.ts',
        stream: 'stdout',
      },
    ])
  })

  test('warn when using --resource flag with actions', async ({ assert, fs }) => {
    const ace = await new AceFactory().make(fs.baseUrl)
    await ace.app.init()
    ace.ui.switchMode('raw')

    const command = await ace.create(MakeControllerCommand, [
      'user',
      'index',
      'show',
      'delete-profile',
      '--resource',
    ])
    await command.exec()

    const { contents } = await new StubsFactory().prepare('make/controller/actions.stub', {
      entity: ace.app.generators.createEntity('user'),
      singular: false,
      actions: ['index', 'show', 'deleteProfile'],
    })

    await assert.fileEquals('app/controllers/users_controller.ts', contents)

    assert.deepEqual(ace.ui.logger.getLogs(), [
      {
        message: '[ yellow(warn) ] Cannot use --resource flag with actions. Ignoring --resource',
        stream: 'stdout',
      },
      {
        message: 'green(DONE:)    create app/controllers/users_controller.ts',
        stream: 'stdout',
      },
    ])
  })

  test('warn when using --resource and --api flag with actions', async ({ assert, fs }) => {
    const ace = await new AceFactory().make(fs.baseUrl)
    await ace.app.init()
    ace.ui.switchMode('raw')

    const command = await ace.create(MakeControllerCommand, [
      'user',
      'index',
      'show',
      'delete-profile',
      '--resource',
      '--api',
    ])
    await command.exec()

    const { contents } = await new StubsFactory().prepare('make/controller/actions.stub', {
      entity: ace.app.generators.createEntity('user'),
      singular: false,
      actions: ['index', 'show', 'deleteProfile'],
    })

    await assert.fileEquals('app/controllers/users_controller.ts', contents)

    assert.deepEqual(ace.ui.logger.getLogs(), [
      {
        message: '[ yellow(warn) ] Cannot use --resource flag with actions. Ignoring --resource',
        stream: 'stdout',
      },
      {
        message: '[ yellow(warn) ] Cannot use --api flag with actions. Ignoring --api',
        stream: 'stdout',
      },
      {
        message: 'green(DONE:)    create app/controllers/users_controller.ts',
        stream: 'stdout',
      },
    ])
  })

  test('create singular controller', async ({ assert, fs }) => {
    const ace = await new AceFactory().make(fs.baseUrl)
    await ace.app.init()
    ace.ui.switchMode('raw')

    const command = await ace.create(MakeControllerCommand, ['user', '-s'])
    await command.exec()

    const { contents } = await new StubsFactory().prepare('make/controller/main.stub', {
      entity: ace.app.generators.createEntity('user'),
      singular: true,
    })

    await assert.fileEquals('app/controllers/user_controller.ts', contents)

    assert.deepEqual(ace.ui.logger.getLogs(), [
      {
        message: 'green(DONE:)    create app/controllers/user_controller.ts',
        stream: 'stdout',
      },
    ])
  })

  test('create singular resource controller', async ({ assert, fs }) => {
    const ace = await new AceFactory().make(fs.baseUrl)
    await ace.app.init()
    ace.ui.switchMode('raw')

    const command = await ace.create(MakeControllerCommand, ['user', '--resource', '-s'])
    await command.exec()

    const { contents } = await new StubsFactory().prepare('make/controller/resource.stub', {
      entity: ace.app.generators.createEntity('user'),
      singular: true,
    })

    await assert.fileEquals('app/controllers/user_controller.ts', contents)

    assert.deepEqual(ace.ui.logger.getLogs(), [
      {
        message: 'green(DONE:)    create app/controllers/user_controller.ts',
        stream: 'stdout',
      },
    ])
  })

  test('create singular controller with actions', async ({ assert, fs }) => {
    const ace = await new AceFactory().make(fs.baseUrl)
    await ace.app.init()
    ace.ui.switchMode('raw')

    const command = await ace.create(MakeControllerCommand, [
      'user',
      'index',
      'show',
      'delete-profile',
      '-s',
    ])
    await command.exec()

    const { contents } = await new StubsFactory().prepare('make/controller/actions.stub', {
      entity: ace.app.generators.createEntity('user'),
      actions: ['index', 'show', 'deleteProfile'],
      singular: true,
    })

    await assert.fileEquals('app/controllers/user_controller.ts', contents)

    assert.deepEqual(ace.ui.logger.getLogs(), [
      {
        message: 'green(DONE:)    create app/controllers/user_controller.ts',
        stream: 'stdout',
      },
    ])
  })

  test('create singular api controller', async ({ assert, fs }) => {
    const ace = await new AceFactory().make(fs.baseUrl)
    await ace.app.init()
    ace.ui.switchMode('raw')

    const command = await ace.create(MakeControllerCommand, ['user', '--api', '-s'])
    await command.exec()

    const { contents } = await new StubsFactory().prepare('make/controller/api.stub', {
      entity: ace.app.generators.createEntity('user'),
      singular: true,
    })

    await assert.fileEquals('app/controllers/user_controller.ts', contents)

    assert.deepEqual(ace.ui.logger.getLogs(), [
      {
        message: 'green(DONE:)    create app/controllers/user_controller.ts',
        stream: 'stdout',
      },
    ])
  })
})