|
| 1 | +/* |
| 2 | + * Copyright (c) 2025, Salesforce, Inc. |
| 3 | + * SPDX-License-Identifier: Apache-2 |
| 4 | + * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0 |
| 5 | + */ |
| 6 | + |
| 7 | +import {expect} from 'chai'; |
| 8 | +import {execa} from 'execa'; |
| 9 | +import path from 'node:path'; |
| 10 | +import {fileURLToPath} from 'node:url'; |
| 11 | + |
| 12 | +const __filename = fileURLToPath(import.meta.url); |
| 13 | +const __dirname = path.dirname(__filename); |
| 14 | + |
| 15 | +/** |
| 16 | + * E2E Tests for Authentication Token Generation |
| 17 | + */ |
| 18 | +describe('Auth Token E2E Tests', function () { |
| 19 | + this.timeout(120_000); // 2 minutes |
| 20 | + this.retries(2); |
| 21 | + |
| 22 | + const CLI_BIN = path.resolve(__dirname, '../../../bin/run.js'); |
| 23 | + |
| 24 | + before(function () { |
| 25 | + if (!process.env.SFCC_CLIENT_ID || !process.env.SFCC_CLIENT_SECRET) { |
| 26 | + this.skip(); |
| 27 | + } |
| 28 | + }); |
| 29 | + |
| 30 | + async function runCLI(args: string[], env?: Record<string, string>) { |
| 31 | + const result = await execa('node', [CLI_BIN, ...args], { |
| 32 | + env: { |
| 33 | + ...process.env, |
| 34 | + ...env, |
| 35 | + SFCC_LOG_LEVEL: 'silent', |
| 36 | + }, |
| 37 | + reject: false, |
| 38 | + }); |
| 39 | + return result; |
| 40 | + } |
| 41 | + |
| 42 | + function decodeJWT(token: string): Record<string, unknown> { |
| 43 | + const parts = token.split('.'); |
| 44 | + if (parts.length !== 3) { |
| 45 | + throw new Error('Invalid JWT format'); |
| 46 | + } |
| 47 | + const payload = Buffer.from(parts[1], 'base64').toString('utf-8'); |
| 48 | + return JSON.parse(payload); |
| 49 | + } |
| 50 | + |
| 51 | + it('should generate a valid OAuth token with correct format, scopes, and expiration', async function () { |
| 52 | + const result = await runCLI(['auth:token', '--json']); |
| 53 | + expect(result.exitCode).to.equal(0, `Token generation failed: ${result.stderr}`); |
| 54 | + expect(result.stdout).to.not.be.empty; |
| 55 | + |
| 56 | + const response = JSON.parse(result.stdout); |
| 57 | + expect(response).to.be.an('object'); |
| 58 | + expect(response.accessToken).to.be.a('string').and.not.be.empty; |
| 59 | + expect(response.expires).to.be.a('string'); |
| 60 | + expect(response.scopes).to.be.an('array').that.is.not.empty; |
| 61 | + |
| 62 | + // Validate JWT format |
| 63 | + const payload = decodeJWT(response.accessToken); |
| 64 | + expect(payload.sub).to.exist; |
| 65 | + expect(payload.exp).to.exist; |
| 66 | + |
| 67 | + // Validate expiration |
| 68 | + const now = Math.floor(Date.now() / 1000); |
| 69 | + expect(payload.exp as number).to.be.greaterThan(now); |
| 70 | + expect(payload.exp as number - now).to.be.lessThan(86400); |
| 71 | + |
| 72 | + // Validate expires field matches exp approximately |
| 73 | + const expiresDate = new Date(response.expires).getTime() / 1000; |
| 74 | + expect(Math.abs(expiresDate - (payload.exp as number))).to.be.lessThan(10); |
| 75 | + |
| 76 | + // Validate scopes |
| 77 | + expect(payload.scope, 'Token should contain scope claim').to.exist; |
| 78 | + const tokenScopes = Array.isArray(payload.scope) |
| 79 | + ? payload.scope |
| 80 | + : (payload.scope as string).split(' '); |
| 81 | + response.scopes.forEach((s: string) => { |
| 82 | + expect(tokenScopes, `Token should include scope "${s}"`).to.include(s); |
| 83 | + }); |
| 84 | + }); |
| 85 | + |
| 86 | + describe('Generate Token With Additional Scopes', function () { |
| 87 | + it('should generate a token with allowed additional scopes', async function () { |
| 88 | + // Use only scopes your client actually has |
| 89 | + const extraScopes = ['profile', 'roles']; |
| 90 | + |
| 91 | + const result = await runCLI([ |
| 92 | + 'auth:token', |
| 93 | + '--scope', |
| 94 | + extraScopes.join(','), |
| 95 | + '--json', |
| 96 | + ]); |
| 97 | + |
| 98 | + expect(result.exitCode).to.equal( |
| 99 | + 0, |
| 100 | + `Token generation with extra scopes failed: ${result.stderr}` |
| 101 | + ); |
| 102 | + |
| 103 | + const response = JSON.parse(result.stdout); |
| 104 | + const accessToken = response.accessToken as string; |
| 105 | + expect(accessToken).to.be.a('string').and.not.be.empty; |
| 106 | + expect(response.scopes).to.include.members(extraScopes); |
| 107 | + |
| 108 | + const payload = decodeJWT(accessToken); |
| 109 | + expect(payload.scope).to.exist; |
| 110 | + |
| 111 | + const tokenScopes = Array.isArray(payload.scope) |
| 112 | + ? payload.scope |
| 113 | + : (payload.scope as string).split(' '); |
| 114 | + |
| 115 | + extraScopes.forEach((s) => { |
| 116 | + expect(tokenScopes, `Token should include scope "${s}"`).to.include(s); |
| 117 | + }); |
| 118 | + |
| 119 | + console.log(`Token with additional scopes: ${tokenScopes.join(', ')}`); |
| 120 | + }); |
| 121 | + }); |
| 122 | + |
| 123 | + describe('Invalid Credentials', function () { |
| 124 | + it('should fail with invalid client credentials', async function () { |
| 125 | + const result = await runCLI(['auth:token', '--json'], { |
| 126 | + SFCC_CLIENT_ID: 'invalid-client-id', |
| 127 | + SFCC_CLIENT_SECRET: 'invalid-client-secret', |
| 128 | + }); |
| 129 | + |
| 130 | + expect(result.exitCode).to.not.equal(0); |
| 131 | + expect(result.stderr).to.not.be.empty; |
| 132 | + expect(result.stderr).to.match(/401|unauthorized|invalid.*client/i); |
| 133 | + }); |
| 134 | + }); |
| 135 | + |
| 136 | + describe('JSON Output Structure', function () { |
| 137 | + it('should return correct JSON keys', async function () { |
| 138 | + const result = await runCLI(['auth:token', '--json']); |
| 139 | + const response = JSON.parse(result.stdout); |
| 140 | + expect(response).to.have.all.keys('accessToken', 'expires', 'scopes'); |
| 141 | + }); |
| 142 | + }); |
| 143 | + |
| 144 | + describe('Default Scopes', function () { |
| 145 | + it('should return default scopes when no scopes are requested', async function () { |
| 146 | + const result = await runCLI(['auth:token', '--json']); |
| 147 | + const response = JSON.parse(result.stdout); |
| 148 | + expect(response.scopes.length).to.be.greaterThan(0); |
| 149 | + }); |
| 150 | + }); |
| 151 | + |
| 152 | + describe('Non-JSON Output', function () { |
| 153 | + it('should output raw token in non-JSON mode', async function () { |
| 154 | + const result = await runCLI(['auth:token']); |
| 155 | + expect(result.exitCode).to.equal(0); |
| 156 | + expect(result.stdout).to.match( |
| 157 | + /^ey[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+$/ |
| 158 | + ); // JWT regex |
| 159 | + }); |
| 160 | + }); |
| 161 | +}); |
0 commit comments