feat: add integration tests (#339)

* feat: add integration tests

* chore: use spaces in sf commands

* chore: clean up

.circleci/config.yml

@@ -18,14 +18,29 @@ workflows:
                 - latest
                 - lts
                 - maintenance
+            alias: unit-tests
+      - release-management/test-package:
+          matrix:
+            parameters:
+              os:
+                - linux
+                - windows
+              node_version:
+                - latest
+                - lts
+                - maintenance
+              command:
+                - yarn test:e2e
+            alias: integration-tests
       - release-management/release-package:
           context: SF-CLI-RELEASE-PROCESS
           filters:
             branches:
               only: main
           github-release: true
           requires:
-            - release-management/test-package
+            - unit-tests
+            - integration-tests
   dependabot-automerge:
     triggers:
       - schedule:

package.json

@@ -8,7 +8,7 @@
     "@oclif/linewrap": "^1.0.0",
     "chalk": "^4.1.2",
     "clean-stack": "^3.0.1",
-    "cli-ux": "6.0.5",
+    "cli-ux": "^6.0.6",
     "debug": "^4.3.3",
     "fs-extra": "^9.1.0",
     "get-package-type": "^0.1.0",
@@ -40,6 +40,7 @@
     "@types/node-notifier": "^8.0.2",
     "@types/proxyquire": "^1.3.28",
     "@types/semver": "^7.3.9",
+    "@types/shelljs": "^0.8.10",
     "@types/strip-ansi": "^5.2.1",
     "@types/wrap-ansi": "^3.0.0",
     "chai": "^4.3.4",
@@ -54,6 +55,7 @@
     "mocha": "^8.4.0",
     "nock": "^13.2.1",
     "proxyquire": "^2.1.3",
+    "shelljs": "^0.8.4",
     "shx": "^0.3.3",
     "sinon": "^11.1.2",
     "ts-node": "^9.1.1",
@@ -96,6 +98,7 @@
     "posttest": "yarn lint",
     "prepack": "yarn run build",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "test:e2e": "mocha \"test/**/*.e2e.ts\" --timeout 600000",
     "pretest": "yarn build --noEmit && tsc -p test --noEmit"
   },
   "types": "lib/index.d.ts"

test/integration/plugins.e2e.ts

@@ -0,0 +1,268 @@
+import * as os from 'os'
+import {expect} from 'chai'
+import {Executor, Result, setup} from './util'
+
+describe('oclif plugins', () => {
+  let executor: Executor
+  before(async () => {
+    executor = await setup(__filename, {
+      repo: 'git@github.com:oclif/hello-world.git',
+      plugins: [
+        '@oclif/plugin-autocomplete',
+        '@oclif/plugin-commands',
+        '@oclif/plugin-help',
+        '@oclif/plugin-not-found',
+        '@oclif/plugin-plugins',
+        '@oclif/plugin-update',
+        '@oclif/plugin-version',
+        '@oclif/plugin-which',
+      ],
+    })
+  })
+
+  describe('plugin-help', () => {
+    describe('<CLI> help', () => {
+      let help: Result
+      before(async () => {
+        help = await executor.executeCommand('help')
+      })
+
+      it('should show description', () => {
+        expect(help.output).to.include('oclif example Hello World CLI')
+      })
+      it('should show version', () => {
+        expect(help.output).to.include('VERSION\n  oclif-hello-world/0.0.0')
+      })
+      it('should show usage', () => {
+        expect(help.output).to.include('USAGE\n  $ oclif-hello-world [COMMAND]')
+      })
+      it('should show topics', () => {
+        expect(help.output).to.include('TOPICS\n  plugins')
+      })
+      it('should show commands', () => {
+        const regex = /COMMANDS\n\s\sautocomplete|\s\scommands|\s\shelp|\s\splugins|\s\sversion|\s\supdate|\s\swhich/
+        expect(regex.test(help.output!)).to.be.true
+      })
+    })
+
+    describe('help <TOPIC>', () => {
+      let help: Result
+      before(async () => {
+        help = await executor.executeCommand('help plugins')
+      })
+
+      it('should show summary', () => {
+        expect(help.output).to.include('List installed plugins.')
+      })
+      it('should show usage', () => {
+        expect(help.output).to.include('USAGE\n  $ oclif-hello-world plugins [--core]')
+      })
+      it('should show description', () => {
+        expect(help.output).to.include('DESCRIPTION\n  List installed plugins.')
+      })
+      it('should show examples', () => {
+        expect(help.output).to.include('EXAMPLES\n  $ oclif-hello-world plugins')
+      })
+      it('should show commands', () => {
+        const regex = /COMMANDS\n\s\splugins:inspect|\s\splugins:install|\s\splugins:link|\s\splugins:uninstall|\s\splugins:update/
+        expect(regex.test(help.output!)).to.be.true
+      })
+    })
+
+    describe('help <COMMAND>', () => {
+      let help: Result
+      before(async () => {
+        help = await executor.executeCommand('help plugins:install')
+      })
+
+      it('should show summary', () => {
+        expect(help.output).to.include('Installs a plugin into the CLI.')
+      })
+      it('should show usage', () => {
+        expect(help.output).to.include('USAGE\n  $ oclif-hello-world plugins:install PLUGIN...')
+      })
+      it('should show arguments', () => {
+        expect(help.output).to.include('ARGUMENTS\n  PLUGIN  Plugin to install.')
+      })
+      it('should show flags', () => {
+        expect(help.output).to.include('FLAGS\n')
+        expect(help.output).to.include('-f, --force    Run yarn install with force flag.')
+        expect(help.output).to.include('-h, --help     Show CLI help.')
+        expect(help.output).to.include('-v, --verbose')
+      })
+      it('should show description', () => {
+        expect(help.output).to.include('DESCRIPTION\n  Installs a plugin into the CLI.')
+      })
+      it('should show aliases', () => {
+        expect(help.output).to.include('ALIASES\n  $ oclif-hello-world plugins:add')
+      })
+      it('should show examples', () => {
+        expect(help.output).to.include('EXAMPLES\n')
+        expect(help.output).to.include('$ oclif-hello-world plugins:install myplugin')
+        expect(help.output).to.include('$ oclif-hello-world plugins:install https://github.com/someuser/someplugin')
+        expect(help.output).to.include('$ oclif-hello-world plugins:install someuser/someplugin')
+      })
+    })
+  })
+
+  describe('plugin-commands', () => {
+    let commands: Result
+
+    it('should show commands', async () => {
+      commands = await executor.executeCommand('commands')
+      expect(commands.output).to.include('commands')
+      expect(commands.output).to.include('help')
+      expect(commands.output).to.include('plugins')
+      expect(commands.output).to.include('plugins:inspect')
+      expect(commands.output).to.include('plugins:install')
+      expect(commands.output).to.include('plugins:link')
+      expect(commands.output).to.include('plugins:uninstall')
+      expect(commands.output).to.include('plugins:update')
+      expect(commands.output).to.include('version')
+      expect(commands.output).to.include('which')
+    })
+
+    it('should fliter commands', async () => {
+      commands = await executor.executeCommand('commands --filter "command=plugins"')
+      expect(commands.output).to.include('plugins')
+      expect(commands.output).to.include('plugins:inspect')
+      expect(commands.output).to.include('plugins:install')
+      expect(commands.output).to.include('plugins:link')
+      expect(commands.output).to.include('plugins:uninstall')
+      expect(commands.output).to.include('plugins:update')
+
+      expect(commands.output).to.not.include('commands')
+      expect(commands.output).to.not.include('help')
+      expect(commands.output).to.not.include('version')
+      expect(commands.output).to.not.include('which')
+    })
+
+    it('should extedned columns', async () => {
+      commands = await executor.executeCommand('commands --extended')
+      expect(commands.output).to.include('Command')
+      expect(commands.output).to.include('Summary')
+      expect(commands.output).to.include('Description')
+      expect(commands.output).to.include('Usage')
+      expect(commands.output).to.include('Plugin')
+      expect(commands.output).to.include('Type')
+      expect(commands.output).to.include('Hidden')
+    })
+
+    it('should filter columns', async () => {
+      commands = await executor.executeCommand('commands --columns Command')
+      expect(commands.output).to.include('Command')
+      expect(commands.output).to.not.include('Summary')
+    })
+
+    it('should show commands in csv', async () => {
+      commands = await executor.executeCommand('commands --csv')
+      expect(commands.output).to.include('Command,Summary\n')
+      expect(commands.output).to.include('commands')
+      expect(commands.output).to.include('help')
+      expect(commands.output).to.include('plugins')
+      expect(commands.output).to.include('plugins:inspect')
+      expect(commands.output).to.include('plugins:install')
+      expect(commands.output).to.include('plugins:link')
+      expect(commands.output).to.include('plugins:uninstall')
+      expect(commands.output).to.include('plugins:update')
+      expect(commands.output).to.include('version')
+      expect(commands.output).to.include('which')
+    })
+
+    it('should show commands in json', async () => {
+      commands = await executor.executeCommand('commands --json')
+      const json = JSON.parse(commands.output!) as Array<{ id: string }>
+      const commandIds = json.map(j => j.id)
+      expect(commandIds).to.include('commands')
+      expect(commandIds).to.include('help')
+      expect(commandIds).to.include('plugins')
+      expect(commandIds).to.include('plugins:inspect')
+      expect(commandIds).to.include('plugins:install')
+      expect(commandIds).to.include('plugins:link')
+      expect(commandIds).to.include('plugins:uninstall')
+      expect(commandIds).to.include('plugins:update')
+      expect(commandIds).to.include('version')
+      expect(commandIds).to.include('which')
+    })
+  })
+
+  describe('plugin-plugins', () => {
+    afterEach(async () => {
+      await executor.executeCommand('plugins:uninstall @oclif/plugin-warn-if-update-available')
+    })
+
+    describe('installing a plugin by name', () => {
+      it('should install the plugin', async () => {
+        const result = await executor.executeCommand('plugins:install @oclif/plugin-warn-if-update-available')
+        expect(result.code).to.equal(0)
+        expect(result.output).to.include('@oclif/plugin-warn-if-update-available... installed v')
+
+        const pluginsResult = await executor.executeCommand('plugins')
+        expect(pluginsResult.code).to.equal(0)
+        expect(pluginsResult.output).to.include('@oclif/plugin-warn-if-update-available')
+      })
+    })
+
+    describe('installing a plugin by github url', () => {
+      after(async () => {
+        await executor.executeCommand('plugins:uninstall @oclif/plugin-warn-if-update-available')
+      })
+
+      it('should install the plugin', async () => {
+        const result = await executor.executeCommand('plugins:install https://github.com/oclif/plugin-warn-if-update-available')
+        expect(result.code).to.equal(0)
+
+        const pluginsResult = await executor.executeCommand('plugins')
+        expect(pluginsResult.code).to.equal(0)
+        expect(pluginsResult.output).to.include('@oclif/plugin-warn-if-update-available')
+      })
+    })
+
+    describe('forcefully installing a plugin', () => {
+      it('should install the plugin', async () => {
+        const result = await executor.executeCommand('plugins:install @oclif/plugin-warn-if-update-available --force')
+        expect(result.code).to.equal(0)
+        expect(result.output).to.include('@oclif/plugin-warn-if-update-available... installed v')
+
+        const pluginsResult = await executor.executeCommand('plugins')
+        expect(pluginsResult.code).to.equal(0)
+        expect(pluginsResult.output).to.include('@oclif/plugin-warn-if-update-available')
+      })
+    })
+
+    describe('uninstalling a plugin', () => {
+      beforeEach(async () => {
+        await executor.executeCommand('plugins:install @oclif/plugin-warn-if-update-available')
+      })
+
+      it('should uninstall the plugin', async () => {
+        const result = await executor.executeCommand('plugins:uninstall @oclif/plugin-warn-if-update-available')
+        expect(result.code).to.equal(0)
+        expect(result.output).to.include('success Uninstalled packages.Uninstalling @oclif/plugin-warn-if-update-available... done\n')
+
+        const pluginsResult = await executor.executeCommand('plugins')
+        expect(pluginsResult.code).to.equal(0)
+        expect(pluginsResult.output).to.not.include('@oclif/plugin-warn-if-update-available')
+      })
+    })
+  })
+
+  describe('plugin-version', () => {
+    let version: Result
+    before(async () => {
+      version = await executor.executeCommand('version')
+    })
+
+    it('should show version', () => expect(version.output).to.include('oclif-hello-world/0.0.0'))
+    it('should show platform', () => expect(version.output).to.include(process.platform))
+    it('should show arch', () => expect(version.output).to.include(os.arch()))
+    it('should show node version', () => expect(version.output).to.include(process.version))
+  })
+
+  describe('plugin-which', () => {
+    it('should show the plugin that a command belongs to', async () => {
+      const result = await executor.executeCommand('which plugins:install')
+      expect(result.output).to.include('@oclif/plugin-plugins')
+    })
+  })
+})

test/integration/sf.e2e.ts

@@ -0,0 +1,45 @@
+import {expect} from 'chai'
+import {Executor, setup} from './util'
+
+describe('Salesforce CLI (sf)', () => {
+  let executor: Executor
+  before(async () => {
+    executor = await setup(__filename, {repo: 'git@github.com:salesforcecli/cli.git'})
+  })
+
+  it('should show custom help', async () => {
+    const help = await executor.executeCommand('deploy metadata --help')
+    /**
+     * Regex matches that the help output matches this form:
+     *
+     * @example
+     * <summary>
+     *
+     * USAGE
+     *   <usage>
+     *
+     * FLAGS
+     *   <flags>
+     *
+     * GLOBAL FLAGS
+     *   <global flags>
+     *
+     * DESCRIPTION
+     *   <description>
+     *
+     * EXAMPLES
+     *   <examples>
+     *
+     * FLAG DESCRIPTIONS
+     *   <flag descriptions>
+     *
+     * CONFIGURATION VARIABLES
+     *   <configuration variables>
+     *
+     * ENVIRONMENT VARIABLES
+     *   <environment variables>
+     */
+    const regex = /^[A-Z].*\n\nUSAGE[\S\s]*\n\nFLAGS[\S\s]*\n\nGLOBAL FLAGS[\S\s]*\n\nDESCRIPTION[\S\s]*\n\nEXAMPLES[\S\s]*\n\nFLAG DESCRIPTIONS[\S\s]*\n\nCONFIGURATION VARIABLES[\S\s]*\n\nENVIRONMENT VARIABLES[\S\s]*$/g
+    expect(regex.test(help.output!)).to.be.true
+  })
+})