feat(component-testing): Expose CT through CLI module API

[agg23]

• Closes Allow component tests to be run via the module API #16302

User facing changelog

Allows launching Component Testing through the CLI module API. This provides for programmatic access to the CT runner.

// Run/open Component Testing
cypress.run({ testingType: 'component' })
cypress.open({ testingType: 'component' })

// Run/open E2E Testing
cypress.run({ testingType: 'e2e' })
cypress.open({ testingType: 'e2e' })

// Defaults to e2e
cypress.run({})
cypress.open({})

Additional details

Slightly cleaned up the current CLI implementation of Component Testing. Expect further work on this front.

PR Tasks

• Have tests been added/updated?
• Has the original issue or this PR been tagged with a release in ZenHub?
• Has a PR for user-facing changes been opened in cypress-documentation? Add documentation for testingType cypress-documentation#3911
• Have API changes been updated in the type definitions?

[cypress-bot]

Thanks for taking the time to open a PR!

• Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.
• Become familiar with the Code Review Checklist for guidelines on coding standards and what needs to be done before a PR can be merged.

[cypress]

---

Test summary

13767 • 0 • 164 • 5 • 0

---

Run details

Project	cypress
Status	Passed
Commit	e330e25
Started	May 7, 2021 4:47 PM
Ended	May 7, 2021 4:58 PM
Duration	11:17 💡
OS	Linux Debian - 10.8
Browser	Multiple

View run in Cypress Dashboard ➡️

---

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

[lmiller1990]

One comment, mostly stylistic - the actual functionality looks good.

Maybe we can change one of the examples in npm/react to launch via the module api as a test?

[JessicaSachs]

This is great, one minor comment. How do I manually test the module API?

[agg23]

My testing was done with:

/* @ts-ignore */
import cypress from '../../cli/lib/cypress'

const run = cypress.run as (options?: Partial<CypressCommandLine.CypressRunOptions>) => Promise<CypressCommandLine.CypressRunResult | CypressCommandLine.CypressFailedRunResult>

run({
  spec: './cypress/component/advanced/framer-motion/Motion.spec.tsx',
  testingType: 'component',
  /* @ts-ignore */
  dev: true,
}).then(results => {
  console.log(results)
})

[JessicaSachs]

My testing was done with:

/* @ts-ignore */
import cypress from '../../cli/lib/cypress'

const run = cypress.run as (options?: Partial<CypressCommandLine.CypressRunOptions>) => Promise<CypressCommandLine.CypressRunResult | CypressCommandLine.CypressFailedRunResult>

run({
  spec: './cypress/component/advanced/framer-motion/Motion.spec.tsx',
  testingType: 'component',
  /* @ts-ignore */
  dev: true,
}).then(results => {
  console.log(results)
})

I kinda want this documented in the CONTRIBUTING.md, yknow? You didn't know how to test it either.

[agg23]

Done. See /cli/README.md

[elevatebart]

LGTM (we could have use the existing isComponentTesting flag but it felt odd)

[cypress-bot]

Released in 7.3.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v7.3.0, please open a new issue.