chore(test): set up ci for e2e and add a basic authenticated test

Author: justinedelson

.github/workflows/ci.yml

@@ -24,6 +24,13 @@ jobs:
     - run: npm version
     - run: npm install
     - run: npm test
+    - run: npm run e2e
+      env:
+        E2E_CLIENT_ID: ${{ secrets.E2E_CLIENT_ID }}
+        E2E_CLIENT_SECRET: ${{ secrets.E2E_CLIENT_SECRET }}
+        E2E_TA_EMAIL: ${{ secrets.E2E_TA_EMAIL }}
+        E2E_IMS_ORG_ID: ${{ secrets.E2E_IMS_ORG_ID }}
+        E2E_PRIVATE_KEY_B64: ${{ secrets.E2E_PRIVATE_KEY_B64 }}
     - run: npm run semantic-release-dry-run
     - name: Codecov
       uses: codecov/[email protected]

.github/workflows/release.yml

@@ -21,6 +21,14 @@ jobs:
         run: npm install
       - name: Test
         run: npm test
+      - name: End to End Test
+        run: npm run e2e
+        env:
+          E2E_CLIENT_ID: ${{ secrets.E2E_CLIENT_ID }}
+          E2E_CLIENT_SECRET: ${{ secrets.E2E_CLIENT_SECRET }}
+          E2E_TA_EMAIL: ${{ secrets.E2E_TA_EMAIL }}
+          E2E_IMS_ORG_ID: ${{ secrets.E2E_IMS_ORG_ID }}
+          E2E_PRIVATE_KEY_B64: ${{ secrets.E2E_PRIVATE_KEY_B64 }}
       - name: Codecov
         uses: codecov/[email protected]
         with:

.gitignore

@@ -15,3 +15,7 @@ junit.xml
 /package-lock.json
 .aio
 permissions.json
+.env
+.secrets
+certificate_pub.crt
+private.key

README.md

@@ -1417,6 +1417,30 @@ npm install
 
 Of course this should not replace proper unit testing.
 
+## End-to-End (E2E) Testing
+
+To execute the end-to-end tests, create a file named `.env` in the project directory and configure it with your JWT credentials:
+
+```
+E2E_CLIENT_ID=<CLIENT ID>
+E2E_CLIENT_SECRET=<CLIENT SECRET>
+E2E_TA_EMAIL=<TECHNICAL ACCOUNT EMAIL>
+E2E_IMS_ORG_ID=<ORG ID>
+E2E_PRIVATE_KEY_B64=<Base64-Encoded PRIVATE KEY>
+```
+
+Note that the private key **must** be base64 encoded, e.g. by running
+
+```
+$ base64 -i private.key
+```
+
+With this in place the end-to-end tests can be run with
+
+```
+npm run e2e
+```
+
 # Standalone Use
 
 In rare circumstances, it may be useful to run this plugin separately from the Adobe I/O CLI. To do this, install this npm module directly, i.e.

e2e/e2e.js

@@ -9,13 +9,44 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
+jest.unmock('@adobe/aio-lib-ims')
+jest.unmock('@adobe/aio-lib-core-config')
+
 const execa = require('execa')
 const chalk = require('chalk')
 const { stdout } = require('stdout-stderr')
+const { context } = require('@adobe/aio-lib-ims')
 const fs = require('fs')
 
+const CONTEXT_NAME = 'aio-cli-plugin-cloudmanager-e2e'
+
+const CONTEXT_ARGS = ['--imsContextName', CONTEXT_NAME]
+
 stdout.print = true
 
+beforeEach(async () => {
+  await clearAuthContext()
+})
+
+const clearAuthContext = async () => {
+  await context.set(CONTEXT_NAME, {})
+}
+
+const bootstrapAuthContext = async () => {
+  const contextObj = {
+    client_id: process.env.E2E_CLIENT_ID,
+    client_secret: process.env.E2E_CLIENT_SECRET,
+    technical_account_id: process.env.E2E_TA_EMAIL,
+    ims_org_id: process.env.E2E_IMS_ORG_ID,
+    meta_scopes: [
+      'ent_cloudmgr_sdk',
+    ],
+    private_key: Buffer.from(process.env.E2E_PRIVATE_KEY_B64, 'base64').toString(),
+  }
+
+  await context.set(CONTEXT_NAME, contextObj)
+}
+
 test('plugin-cloudmanager help test', async () => {
   const packagejson = JSON.parse(fs.readFileSync('package.json').toString())
   const name = `${packagejson.name}`
@@ -26,3 +57,19 @@ test('plugin-cloudmanager help test', async () => {
 
   console.log(chalk.green(`    - done for ${chalk.bold(name)}`))
 })
+
+test('plugin-cloudmanager list-programs', async () => {
+  await bootstrapAuthContext()
+  const packagejson = JSON.parse(fs.readFileSync('package.json').toString())
+  const name = `${packagejson.name}`
+  console.log(chalk.blue(`> e2e tests for ${chalk.bold(name)}`))
+
+  console.log(chalk.dim('    - plugin-cloudmanager list-programs ..'))
+
+  let result
+  expect(() => { result = execa.sync('./bin/run', ['cloudmanager:list-programs', ...CONTEXT_ARGS, '--json'], { stderr: 'inherit' }) }).not.toThrow()
+  const parsed = JSON.parse(result.stdout)
+  expect(parsed).toSatisfy(arr => arr.length > 0)
+
+  console.log(chalk.green(`    - done for ${chalk.bold(name)}`))
+})