chore: create-cli cleanup

.gitignore

@@ -16,3 +16,4 @@ local
 .tsbuildinfo
 **/checkly-github-report.md
 **/checkly-summary.md
+**/e2e/__tests__/fixtures/empty-project/e2e-test-project-*

packages/create-cli/index.mjs → packages/create-cli/bin/run

@@ -10,4 +10,6 @@ if (requiredVersion < minimumVersion) {
   process.exit(1)
 }
 
-import('./dist/index.js').then(({ main }) => main())
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

packages/create-cli/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

packages/create-cli/e2e/__tests__/bootstrap.spec.ts

@@ -0,0 +1,275 @@
+import axios from 'axios'
+import * as rimraf from 'rimraf'
+import * as path from 'path'
+import * as fs from 'fs'
+import { v4 as uuidv4 } from 'uuid'
+import { runChecklyCreateCli } from '../run-create-cli'
+import { getUserGreeting } from '../../src/utils/messages'
+import { PROJECT_TEMPLATES } from '../../src/utils/prompts'
+import { SpawnSyncReturns } from 'child_process'
+
+const E2E_PROJECT_PREFIX = 'e2e-test-project-'
+
+function cleanupProjects () {
+  rimraf.sync(`${path.join(__dirname, 'fixtures', 'empty-project', E2E_PROJECT_PREFIX)}*`, { glob: true })
+  rimraf.windowsSync(`${path.join(__dirname, 'fixtures', 'empty-project', E2E_PROJECT_PREFIX)}*`, { glob: true })
+}
+
+function expectVersionAndName ({
+  commandOutput,
+  version,
+  latestVersion,
+  greeting,
+}: {
+  commandOutput: SpawnSyncReturns<string>
+  version?: string
+  latestVersion: string
+  greeting: string
+}) {
+  if (!version) {
+    expect(commandOutput.stdout).toContain(`Notice: replacing version '0.0.1-dev' with latest '${latestVersion}'.`)
+  }
+  expect(commandOutput.stdout).toContain(`v${version ?? latestVersion} Build and Run Synthetics That Scale`)
+  expect(commandOutput.stdout).toContain(`${greeting} Let's get you started on your monitoring as code journey!`)
+}
+
+function expectCompleteCreation ({
+  commandOutput,
+  projectFolder,
+}: {
+  commandOutput: SpawnSyncReturns<string>
+  projectFolder: string
+}) {
+  expect(commandOutput.stdout).toContain(`All done. Time to get testing & monitoring with Checkly
+
+         > Enter your project directory using cd ${projectFolder}
+         > Run npx checkly login to login to your Checkly account
+         > Run npx checkly test to dry run your checks
+         > Run npx checkly deploy to deploy your checks to the Checkly cloud
+
+         Questions?
+
+         - Check the docs at https://checklyhq.com/docs/cli
+         - Join the Checkly Slack community at https://checklyhq.com/slack`)
+}
+
+describe('bootstrap', () => {
+  let latestVersion = ''
+  let projectName = ''
+  let greeting = ''
+  beforeAll(async () => {
+    const packageInformation = await axios.get('https://registry.npmjs.org/checkly/latest')
+    latestVersion = packageInformation.data.version
+    greeting = await getUserGreeting()
+  })
+  beforeEach(() => {
+    projectName = `${E2E_PROJECT_PREFIX}${uuidv4()}`
+  })
+  afterAll(() => cleanupProjects())
+
+  it('Should create project with advanced-project template', () => {
+    const directory = path.join(__dirname, 'fixtures', 'empty-project')
+    const projectFolder = path.join(directory, projectName)
+    const commandOutput = runChecklyCreateCli({
+      directory,
+      promptsInjection: [projectName, 'advanced-project', true, true],
+    })
+
+    const { status, stdout, stderr } = commandOutput
+
+    expectVersionAndName({ commandOutput, latestVersion, greeting })
+
+    expect(stdout).toContain('Downloading example template...')
+    expect(stdout).toContain('Example template copied!')
+    expect(stdout).toContain('installing packages')
+    expect(stdout).toContain('Packages installed successfully')
+
+    expect(stderr).toBe('')
+    expect(status).toBe(0)
+
+    expect(fs.existsSync(path.join(projectFolder, 'package.json'))).toBe(true)
+    expect(fs.existsSync(path.join(projectFolder, 'checkly.config.ts'))).toBe(true)
+    expect(fs.existsSync(path.join(projectFolder, 'node_modules'))).toBe(true)
+    expect(fs.existsSync(path.join(projectFolder, '.git'))).toBe(true)
+  }, 30000)
+
+  it('Should create an boilerplate-project without installing dependencies', () => {
+    const directory = path.join(__dirname, 'fixtures', 'empty-project')
+    const projectFolder = path.join(directory, projectName)
+    const commandOutput = runChecklyCreateCli({
+      directory,
+      promptsInjection: [projectName, 'boilerplate-project', false, false],
+    })
+
+    expectVersionAndName({ commandOutput, latestVersion, greeting })
+
+    const { status, stdout, stderr } = commandOutput
+
+    expect(stdout).toContain('Downloading example template...')
+    expect(stdout).toContain('Example template copied!')
+    expect(stdout).not.toContain('installing packages')
+    expect(stdout).not.toContain('Packages installed successfully')
+
+    // no git initialization message
+    expect(stdout).toContain('No worries. Just remember to install the dependencies after this setup')
+
+    expectCompleteCreation({ commandOutput, projectFolder })
+
+    expect(stderr).toBe('')
+    expect(status).toBe(0)
+
+    expect(fs.existsSync(path.join(projectFolder, 'package.json'))).toBe(true)
+    expect(fs.existsSync(path.join(projectFolder, 'checkly.config.ts'))).toBe(true)
+
+    // node_modules nor .git shouldn't exist
+    expect(fs.existsSync(path.join(projectFolder, 'node_modules'))).toBe(false)
+    expect(fs.existsSync(path.join(projectFolder, '.git'))).toBe(false)
+  }, 15000)
+
+  it('Should create an boilerplate-project using an older version', () => {
+    const directory = path.join(__dirname, 'fixtures', 'empty-project')
+    const projectFolder = path.join(directory, projectName)
+    const version = '4.0.13'
+    const commandOutput = runChecklyCreateCli({
+      directory,
+      version,
+      promptsInjection: [projectName, 'boilerplate-project', false, false],
+    })
+
+    expectVersionAndName({ commandOutput, version, latestVersion, greeting })
+
+    const { status, stdout, stderr } = commandOutput
+
+    expect(stdout).toContain('Downloading example template...')
+    expect(stdout).toContain('Example template copied!')
+    expect(stdout).not.toContain('installing packages')
+    expect(stdout).not.toContain('Packages installed successfully')
+
+    // no git initialization message
+    expect(stdout).toContain('No worries. Just remember to install the dependencies after this setup')
+
+    expectCompleteCreation({ commandOutput, projectFolder })
+
+    expect(stderr).toBe('')
+    expect(status).toBe(0)
+
+    expect(fs.existsSync(path.join(projectFolder, 'package.json'))).toBe(true)
+    expect(fs.existsSync(path.join(projectFolder, 'checkly.config.ts'))).toBe(true)
+
+    // node_modules nor .git shouldn't exist
+    expect(fs.existsSync(path.join(projectFolder, 'node_modules'))).toBe(false)
+    expect(fs.existsSync(path.join(projectFolder, '.git'))).toBe(false)
+  }, 15000)
+
+  it('Should fail for already initiated project', () => {
+    const directory = path.join(__dirname, 'fixtures', 'initiated-project')
+    const commandOutput = runChecklyCreateCli({
+      directory,
+      promptsInjection: [projectName, 'advanced-project', false, false],
+    })
+
+    expectVersionAndName({ commandOutput, latestVersion, greeting })
+
+    const { status, stdout, stderr } = commandOutput
+
+    expect(stderr)
+      .toContain('It looks like you already have "__checks__" folder or "checkly.config.ts". ' +
+      'Please, remove them and try again.')
+
+    expect(stdout).not.toContain('Downloading example template...')
+    expect(stdout).not.toContain('Example template copied!')
+    expect(stdout).not.toContain('installing packages')
+    expect(stdout).not.toContain('Packages installed successfully')
+
+    expect(status).toBe(1)
+  }, 15000)
+
+  it('Should cancel command and show message', () => {
+    const directory = path.join(__dirname, 'fixtures', 'empty-project')
+    const commandOutput = runChecklyCreateCli({
+      directory,
+      promptsInjection: [new Error()],
+    })
+
+    expectVersionAndName({ commandOutput, latestVersion, greeting })
+    const { status, stderr } = commandOutput
+    expect(stderr).toContain('Bailing, hope to see you again soon!')
+    expect(status).toBe(2)
+  }, 15000)
+
+  it('Should create projects with all available templates (without installing dependencies)', () => {
+    const availableTemplates = PROJECT_TEMPLATES.map(t => t.value)
+
+    availableTemplates.forEach(template => {
+      const newProjectName = `${E2E_PROJECT_PREFIX}${uuidv4()}`
+      const directory = path.join(__dirname, 'fixtures', 'empty-project')
+      const projectFolder = path.join(directory, newProjectName)
+      const commandOutput = runChecklyCreateCli({
+        directory,
+        promptsInjection: [newProjectName, template, false, false],
+      })
+
+      expectVersionAndName({ commandOutput, latestVersion, greeting })
+
+      const { status, stdout, stderr } = commandOutput
+
+      expect(stdout).toContain('Downloading example template...')
+      expect(stdout).toContain('Example template copied!')
+      expect(stdout).not.toContain('installing packages')
+      expect(stdout).not.toContain('Packages installed successfully')
+
+      // no git initialization message
+      expect(stdout).toContain('No worries. Just remember to install the dependencies after this setup')
+
+      expectCompleteCreation({ commandOutput, projectFolder })
+
+      expect(stderr).toBe('')
+      expect(status).toBe(0)
+
+      expect(fs.existsSync(path.join(projectFolder, 'package.json'))).toBe(true)
+      expect(
+        fs.existsSync(path.join(projectFolder, 'checkly.config.ts')) ||
+        fs.existsSync(path.join(projectFolder, 'checkly.config.js')),
+      ).toBe(true)
+
+      // node_modules nor .git shouldn't exist
+      expect(fs.existsSync(path.join(projectFolder, 'node_modules'))).toBe(false)
+      expect(fs.existsSync(path.join(projectFolder, '.git'))).toBe(false)
+    })
+  }, 30000)
+
+  it('Should create a project with --template argument', () => {
+    const directory = path.join(__dirname, 'fixtures', 'empty-project')
+    const projectFolder = path.join(directory, projectName)
+    const commandOutput = runChecklyCreateCli({
+      directory,
+      args: ['--template', 'boilerplate-project-js'],
+      promptsInjection: [projectName, false, false],
+    })
+
+    expectVersionAndName({ commandOutput, latestVersion, greeting })
+
+    const { status, stdout, stderr } = commandOutput
+
+    expect(stdout).toContain('Downloading example template...')
+    expect(stdout).toContain('Example template copied!')
+    expect(stdout).not.toContain('installing packages')
+    expect(stdout).not.toContain('Packages installed successfully')
+
+    // no git initialization message
+    expect(stdout).toContain('No worries. Just remember to install the dependencies after this setup')
+
+    expectCompleteCreation({ commandOutput, projectFolder })
+
+    expect(stderr).toBe('')
+    expect(status).toBe(0)
+
+    expect(fs.existsSync(path.join(projectFolder, 'package.json'))).toBe(true)
+    expect(fs.existsSync(path.join(projectFolder, 'checkly.config.js'))).toBe(true)
+    expect(fs.existsSync(path.join(projectFolder, '__checks__', 'api.check.js'))).toBe(true)
+
+    // node_modules nor .git shouldn't exist
+    expect(fs.existsSync(path.join(projectFolder, 'node_modules'))).toBe(false)
+    expect(fs.existsSync(path.join(projectFolder, '.git'))).toBe(false)
+  }, 15000)
+})

packages/create-cli/e2e/__tests__/fixtures/empty-project/README.md

@@ -0,0 +1 @@
+This is an empty project to test create-cli E2E tests.

packages/create-cli/e2e/__tests__/fixtures/initiated-project/__checks__/api.check.ts

@@ -0,0 +1,18 @@
+import { ApiCheck, AssertionBuilder } from 'checkly/constructs'
+
+const apiCheck = new ApiCheck('dummy-check', {
+  name: 'Dummy API check',
+  alertChannels: [],
+  degradedResponseTime: 10000,
+  maxResponseTime: 20000,
+  request: {
+    url: 'https://danube-web.shop/api/books',
+    method: 'GET',
+    followRedirects: true,
+    skipSSL: false,
+    assertions: [
+      AssertionBuilder.statusCode().equals(200),
+      AssertionBuilder.jsonBody('$[0].id').isNotNull(),
+    ],
+  },
+})

packages/create-cli/e2e/__tests__/fixtures/initiated-project/checkly.config.ts

@@ -0,0 +1,23 @@
+import { defineConfig } from 'checkly'
+
+const config = defineConfig({
+  projectName: 'Dummy Project',
+  logicalId: 'e2e-test-project',
+  repoUrl: 'https://github.com/checkly/checkly-cli',
+  checks: {
+    frequency: 10,
+    locations: ['us-east-1', 'eu-west-1'],
+    tags: ['mac'],
+    runtimeId: '2023.02',
+    checkMatch: '**/__checks__/**/*.check.ts',
+    browserChecks: {
+      testMatch: '**/__checks__/**/*.spec.ts',
+    },
+  },
+  cli: {
+    runLocation: 'eu-west-1',
+    reporters: ['list'],
+  },
+})
+
+export default config

packages/create-cli/e2e/__tests__/fixtures/initiated-project/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "dummy-project",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "checkly": "latest",
+    "ts-node": "latest",
+    "typescript": "latest"
+  }
+}

packages/create-cli/e2e/run-create-cli.ts

@@ -0,0 +1,34 @@
+import * as path from 'path'
+import * as childProcess from 'node:child_process'
+
+const CHECKLY_PATH = path.resolve(path.dirname(__filename), '..', 'bin', 'run')
+
+export function runChecklyCreateCli (options: {
+  directory?: string,
+  args?: string[],
+  env?: object,
+  version?: string,
+  promptsInjection?: (string | boolean | object)[],
+  timeout?: number,
+}) {
+  const {
+    directory,
+    args = [],
+    env = {},
+    version,
+    promptsInjection = [],
+    timeout = 30000,
+  } = options
+  return childProcess.spawnSync(CHECKLY_PATH, args, {
+    env: {
+      PATH: process.env.PATH,
+      CHECKLY_CLI_VERSION: version,
+      CHECKLY_E2E_PROMPTS_INJECTIONS: promptsInjection?.length ? JSON.stringify(promptsInjection) : undefined,
+      ...env,
+    },
+    cwd: directory ?? process.cwd(),
+    encoding: 'utf-8',
+    timeout,
+    shell: process.platform === 'win32',
+  })
+}