Feature/812 cli command to create test files

[fecony]

Description

CLI command to create example test file.

boost new:test SimpleTest

Will create test file (simple-test.test.ts) with following content in test/ folder:

import { BoosterConfig } from '@boostercloud/framework-types'
import { expect } from 'chai'

const config = new BoosterConfig('test')
config.appName = 'testing-booster-app' // <- app name

describe('[SimpleTestTest]', () => {
  it('should be true', () => {
    expect(true).to.be.true
  })
})

Test files use chai that is not installed by default in new projects.

Maybe it should be included or should print message after test file was created. "Run npm install -D chai @types/chai to install required dependencies" ?

Changes

• Add new:test command to generate test file
• Add new template for test files
• Tests to test simple cases that test file is generated

Checks

• Project Builds
• Project passes tests and checks
  - [] Updated documentation accordingly

Additional Information

Closes #812

This command may be expanded to:

• allow users create tests in subfolders
• check if user has recommended expect.ts file
• use another testing tools (as flag ?)

[NickSeagull]

Thanks for this @fecony ! Actually this is a feature that the core team has been discussing internally, so this pushes it forward!

I'd like to hear more from the @boostercloud/booster-core team. Maybe @juanjoman can shed some light on his thoughts (I believe you were the one working on the draft on testing, right Juanjo?)

[juanjoman]

Amazing work @fecony!! I would just like to check that we're providing chai as we're importing it on the generated test. Could you check it? 🙏

[juanjoman]

Just have a question, does the project's package.json includes chai as a dependency? 😮

[fecony]

Hey @juanjoman. That is something I mention in PR description "Test files use chai that is not installed by default in new projects." 😄

I think we should include chai as dependency because Booster docs use chai but we don't provide it by default? 😅

• if chai is not in the project.json dependencies, what we should use as expect assertion instead?

[fecony]

@juanjoman I though about importing expect from ./expect if it exists, as we might expect it to be here (because it is recommended file)

If not, check if chai exists and import it instead. But if user doesn't have them? 🤔

[juanjoman]

oooh sorry @fecony, I didn't read it 😓. I think it's ok then to import it from ./expect and let the user choose their test library, but we should document that 😄

[fecony]

Closing, as I have no time/knowledge which path to take. 😬

• We could take the path of creating automated tests, as @ClaytonFarr did investigate, that was mentioned on Discord here
• Take simple path and assume that user has expect.ts
• Force user to use [insert testing library here]
• Create Booster-specific test matchers expect(...).to.registerEvents(...)