feat: new import command to import your existing Checkly resources to the CLI [sc-23506]

packages/cli/e2e/__tests__/help.spec.ts

@@ -23,6 +23,18 @@ describe('help', () => {
               <value>".`)
   })
 
+  it('should print import topic help', async () => {
+    const { stdout } = await runChecklyCli({
+      args: ['import', '--help'],
+    })
+    // use a 80 char line output
+    expect(stdout).toContain(`COMMANDS
+  import apply   Attach imported resources into your project in a pending state.
+  import cancel  Cancels an ongoing import plan that has not been committed yet.
+  import commit  Permanently commit imported resources into your project.
+  import plan    Begin the import process by creating a plan.`)
+  })
+
   it('should print core and additional commands and topic', async () => {
     const { stdout } = await runChecklyCli({
       args: ['--help'],
@@ -36,6 +48,8 @@ describe('help', () => {
   destroy          Destroy your project with all its related resources.
   env              Manage Checkly environment variables.
   help             Display help for checkly.
+  import           Import existing resources from your Checkly account to your
+                   project.
   login            Login to your Checkly account or create a new one.
   logout           Log out and clear any local credentials.
   runtimes         List all supported runtimes and dependencies.

packages/cli/package.json

@@ -59,6 +59,9 @@
     "topics": {
       "env": {
         "description": "Manage Checkly environment variables."
+      },
+      "import": {
+        "description": "Import existing resources from your Checkly account to your project."
       }
     },
     "helpClass": "./dist/help/help-extension",

packages/cli/src/commands/import/apply.ts

@@ -0,0 +1,96 @@
+import { Flags, ux } from '@oclif/core'
+import prompts from 'prompts'
+
+import * as api from '../../rest/api'
+import { AuthCommand } from '../authCommand'
+import commonMessages from '../../messages/common-messages'
+import { splitConfigFilePath } from '../../services/util'
+import { loadChecklyConfig } from '../../services/checkly-config-loader'
+import { ImportPlan } from '../../rest/projects'
+
+export default class ImportApplyCommand extends AuthCommand {
+  static hidden = false
+  static description = 'Attach imported resources into your project in a pending state.'
+
+  static flags = {
+    config: Flags.string({
+      char: 'c',
+      description: commonMessages.configFile,
+    }),
+  }
+
+  async run (): Promise<void> {
+    const { flags } = await this.parse(ImportApplyCommand)
+    const {
+      config: configFilename,
+    } = flags
+
+    const { configDirectory, configFilenames } = splitConfigFilePath(configFilename)
+    const {
+      config: checklyConfig,
+    } = await loadChecklyConfig(configDirectory, configFilenames)
+
+    const {
+      logicalId,
+    } = checklyConfig
+
+    const { data: unappliedPlans } = await api.projects.findImportPlans(logicalId, {
+      onlyUnapplied: true,
+    })
+
+    const plan = await this.#selectPlan(unappliedPlans)
+
+    if (this.fancy) {
+      ux.action.start('Applying plan')
+    }
+
+    try {
+      await api.projects.applyImportPlan(plan.id)
+
+      if (this.fancy) {
+        ux.action.stop('✅ ')
+      }
+    } catch (err) {
+      if (this.fancy) {
+        ux.action.stop('❌')
+      }
+
+      throw err
+    }
+  }
+
+  async #selectPlan (plans: ImportPlan[]): Promise<ImportPlan> {
+    const choices: prompts.Choice[] = plans.map((plan, index) => ({
+      title: `Plan #${index + 1} from ${new Date(plan.createdAt)}`,
+      value: plan.id,
+      description: `ID: ${plan.id}`,
+    }))
+
+    choices.unshift({
+      title: 'Exit without applying',
+      value: 'exit',
+      description: 'No changes will be made.',
+    })
+
+    const plansById = plans.reduce((m, plan) => m.set(plan.id, plan), new Map<string, ImportPlan>())
+
+    const { planId } = await prompts({
+      name: 'planId',
+      type: 'select',
+      message: `Found ${plans.length} unapplied plan(s). Which one to apply?`,
+      choices,
+    })
+
+    if (planId === 'exit') {
+      this.log('Exiting without making any changes.')
+      this.exit(0)
+    }
+
+    const plan = plansById.get(planId)
+    if (plan === undefined) {
+      throw new Error('Bug: plan ID missing from plan map')
+    }
+
+    return plan
+  }
+}

packages/cli/src/commands/import/cancel.ts

@@ -0,0 +1,112 @@
+import { Flags, ux } from '@oclif/core'
+import prompts from 'prompts'
+import logSymbols from 'log-symbols'
+
+import * as api from '../../rest/api'
+import { AuthCommand } from '../authCommand'
+import commonMessages from '../../messages/common-messages'
+import { splitConfigFilePath } from '../../services/util'
+import { loadChecklyConfig } from '../../services/checkly-config-loader'
+import { ImportPlan } from '../../rest/projects'
+
+export default class ImportCancelCommand extends AuthCommand {
+  static hidden = false
+  static description = 'Cancels an ongoing import plan that has not been committed yet.'
+
+  static flags = {
+    config: Flags.string({
+      char: 'c',
+      description: commonMessages.configFile,
+    }),
+  }
+
+  async run (): Promise<void> {
+    const { flags } = await this.parse(ImportCancelCommand)
+    const {
+      config: configFilename,
+    } = flags
+
+    const { configDirectory, configFilenames } = splitConfigFilePath(configFilename)
+    const {
+      config: checklyConfig,
+    } = await loadChecklyConfig(configDirectory, configFilenames)
+
+    const {
+      logicalId,
+    } = checklyConfig
+
+    const { data: cancelablePlans } = await api.projects.findImportPlans(logicalId, {
+      onlyUncommitted: true,
+    })
+
+    const plans = await this.#selectPlans(cancelablePlans)
+
+    if (this.fancy) {
+      ux.action.start('Canceling selected plan(s)')
+    }
+
+    try {
+      for (const plan of plans) {
+        await api.projects.cancelImportPlan(plan.id)
+        this.log(`${logSymbols.success} Canceled plan ${plan.id}`)
+      }
+
+      if (this.fancy) {
+        ux.action.stop('✅ ')
+      }
+    } catch (err) {
+      if (this.fancy) {
+        ux.action.stop('❌')
+      }
+
+      throw err
+    }
+  }
+
+  async #selectPlans (plans: ImportPlan[]): Promise<ImportPlan[]> {
+    const choices: prompts.Choice[] = plans.map(plan => ({
+      title: `Plan #1 from ${new Date(plan.createdAt)}`,
+      value: plan.id,
+      description: `ID: ${plan.id}`,
+    }))
+
+    choices.unshift({
+      title: 'Exit without canceling',
+      value: 'exit',
+      description: 'No changes will be made.',
+    })
+
+    if (plans.length > 0) {
+      choices.push({
+        title: 'Cancel all plans',
+        value: 'all',
+        description: 'All uncommitted plans will be canceled.',
+      })
+    }
+
+    const plansById = plans.reduce((m, plan) => m.set(plan.id, plan), new Map<string, ImportPlan>())
+
+    const { planId } = await prompts({
+      name: 'planId',
+      type: 'select',
+      message: `Found ${plans.length} cancelable plan(s). Which one to cancel?`,
+      choices,
+    })
+
+    if (planId === 'exit') {
+      this.log('Exiting without making any changes.')
+      this.exit(0)
+    }
+
+    if (planId === 'all') {
+      return plans
+    }
+
+    const plan = plansById.get(planId)
+    if (plan === undefined) {
+      throw new Error('Bug: plan ID missing from plan map')
+    }
+
+    return [plan]
+  }
+}

packages/cli/src/commands/import/commit.ts

@@ -0,0 +1,104 @@
+import { Flags, ux } from '@oclif/core'
+import prompts from 'prompts'
+import logSymbols from 'log-symbols'
+
+import * as api from '../../rest/api'
+import { AuthCommand } from '../authCommand'
+import commonMessages from '../../messages/common-messages'
+import { splitConfigFilePath } from '../../services/util'
+import { loadChecklyConfig } from '../../services/checkly-config-loader'
+import { ImportPlan } from '../../rest/projects'
+
+export default class ImportCommitCommand extends AuthCommand {
+  static hidden = false
+  static description = 'Permanently commit imported resources into your project.'
+
+  static flags = {
+    config: Flags.string({
+      char: 'c',
+      description: commonMessages.configFile,
+    }),
+  }
+
+  async run (): Promise<void> {
+    const { flags } = await this.parse(ImportCommitCommand)
+    const {
+      config: configFilename,
+    } = flags
+
+    const { configDirectory, configFilenames } = splitConfigFilePath(configFilename)
+    const {
+      config: checklyConfig,
+    } = await loadChecklyConfig(configDirectory, configFilenames)
+
+    const {
+      logicalId,
+    } = checklyConfig
+
+    const { data } = await api.projects.findImportPlans(logicalId, {
+      onlyUncommitted: true,
+    })
+
+    // Uncommitted plans also include unapplied plans, filter them out.
+    const uncommittedPlans = data.filter(plan => {
+      return plan.appliedAt
+    })
+
+    const plan = await this.#selectPlan(uncommittedPlans)
+
+    if (this.fancy) {
+      ux.action.start('Committing plan')
+    }
+
+    try {
+      await api.projects.commitImportPlan(plan.id)
+
+      if (this.fancy) {
+        ux.action.stop('✅ ')
+      }
+    } catch (err) {
+      if (this.fancy) {
+        ux.action.stop('❌')
+      }
+
+      throw err
+    }
+
+    this.log(`${logSymbols.success} All imported plan resources are now fully managed by the Checkly CLI.`)
+  }
+
+  async #selectPlan (plans: ImportPlan[]): Promise<ImportPlan> {
+    const choices: prompts.Choice[] = plans.map((plan, index) => ({
+      title: `Plan #${index + 1} from ${new Date(plan.createdAt)}`,
+      value: plan.id,
+      description: `ID: ${plan.id}`,
+    }))
+
+    choices.unshift({
+      title: 'Exit without committing',
+      value: 'exit',
+      description: 'No changes will be made.',
+    })
+
+    const plansById = plans.reduce((m, plan) => m.set(plan.id, plan), new Map<string, ImportPlan>())
+
+    const { planId } = await prompts({
+      name: 'planId',
+      type: 'select',
+      message: `Found ${plans.length} applied plan(s). Which one to commit?`,
+      choices,
+    })
+
+    if (planId === 'exit') {
+      this.log('Exiting without making any changes.')
+      this.exit(0)
+    }
+
+    const plan = plansById.get(planId)
+    if (plan === undefined) {
+      throw new Error('Bug: plan ID missing from plan map')
+    }
+
+    return plan
+  }
+}