Files
alfresco-ng2-components/lib/js-api/test/auth.spec.ts

474 lines
18 KiB
TypeScript

/*!
* @license
* Copyright © 2005-2026 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import assert from 'assert';
import * as sinon from 'sinon';
import { resetGlobalMockAgent, flushMicrotasks } from './mockObjects/base.mock';
import { EcmAuthMock, BpmAuthMock, NodeMock, ProfileMock } from './mockObjects';
import { NodesApi, UserProfileApi, AlfrescoApi } from '../src';
import { describe, it, beforeEach, afterEach, before, after } from 'node:test';
const ECM_HOST = 'https://127.0.0.1:8080';
const BPM_HOST = 'https://127.0.0.1:9999';
describe('Auth', () => {
// Handler to suppress unhandledRejection for error responses that escape the test context
// This is needed for auth.spec.ts tests that use the AlfrescoApi.login() wrapper which
// can have promise chaining issues. Direct testing in content-auth.spec.ts and
// process-auth-error.spec.ts avoids this pattern.
const unhandledRejectionHandler = (reason: any) => {
// Suppress rejections from error-path tests (401, 403, 404 responses)
if (reason?.status && (reason.status === 401 || reason.status === 403 || reason.status === 404)) {
return; // Suppress
}
// Let other rejections propagate normally
};
before(() => {
process.on('unhandledRejection', unhandledRejectionHandler);
});
after(() => {
process.off('unhandledRejection', unhandledRejectionHandler);
});
describe('ECM Provider config', () => {
let authResponseEcmMock: EcmAuthMock;
let nodeMock: NodeMock;
let nodesApi: NodesApi;
let sandbox: sinon.SinonSandbox;
beforeEach(() => {
sandbox = sinon.createSandbox();
authResponseEcmMock = new EcmAuthMock(ECM_HOST);
nodeMock = new NodeMock(ECM_HOST);
authResponseEcmMock.get201Response();
});
afterEach(async () => {
sandbox.restore();
authResponseEcmMock.cleanAll();
nodeMock.cleanAll();
resetGlobalMockAgent();
// Flush any pending microtasks
await flushMicrotasks();
});
describe('With Authentication', () => {
let alfrescoJsApi: AlfrescoApi;
beforeEach(() => {
alfrescoJsApi = new AlfrescoApi({
hostEcm: ECM_HOST
});
nodesApi = new NodesApi(alfrescoJsApi);
});
describe('login', () => {
it('should return the Ticket if all is ok', async () => {
authResponseEcmMock.get201Response();
const data = await alfrescoJsApi.login('admin', 'admin');
assert.equal(data, 'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1');
});
});
describe('isLoggedIn', () => {
it('should return true if the api is logged in', async () => {
authResponseEcmMock.get201Response();
await alfrescoJsApi.login('admin', 'admin');
assert.equal(alfrescoJsApi.isLoggedIn(), true);
});
it('should return false if the api is logged out', async () => {
authResponseEcmMock.get201Response();
try {
await alfrescoJsApi.login('admin', 'admin');
} catch {
// Ignore login errors in this test
}
authResponseEcmMock.get204ResponseLogout();
await alfrescoJsApi.logout();
assert.equal(alfrescoJsApi.isLoggedIn(), false);
});
});
describe('Events ', () => {
it('should login fire success event if is all ok 201', async () => {
authResponseEcmMock.get201Response();
const data = await alfrescoJsApi.login('admin', 'admin');
assert.equal(data, 'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1');
});
it('should login fire logout event if the logout is successfull', async () => {
authResponseEcmMock.get201Response();
await alfrescoJsApi.login('admin', 'admin');
authResponseEcmMock.get204ResponseLogout();
await alfrescoJsApi.logout();
assert.equal(alfrescoJsApi.isLoggedIn(), false);
});
});
describe('With Ticket Authentication', () => {
it('should Ticket be present in the client', () => {
authResponseEcmMock.get400Response();
const api = new AlfrescoApi({
ticketEcm: 'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1',
hostEcm: ECM_HOST
});
assert.equal('TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1', api.contentClient.authentications.basicAuth.password);
});
it('should Ticket login be validate against the server if is valid', async () => {
const ticket = 'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1';
authResponseEcmMock.get200ValidTicket(ticket);
const data = await alfrescoJsApi.loginTicket(ticket, null);
assert.equal(alfrescoJsApi.contentAuth.authentications.basicAuth.password, ticket);
assert.equal(data, ticket);
});
it('should Ticket login be validate against the server d is NOT valid', async () => {
const ticket = 'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1';
authResponseEcmMock.get400Response();
let errorWasCaught = false;
try {
await alfrescoJsApi.loginTicket(ticket, null);
} catch {
errorWasCaught = true;
}
assert.equal(errorWasCaught, true, 'Expected loginTicket to throw an error');
});
});
describe('Logout Api', () => {
beforeEach(async () => {
authResponseEcmMock.get201Response('TICKET_22d7a5a83d78b9cc9666ec4e412475e5455b33bd');
await alfrescoJsApi.login('admin', 'admin');
});
it('should Ticket be absent in the client and the resolve promise should be called', async () => {
authResponseEcmMock.get204ResponseLogout();
await alfrescoJsApi.logout();
assert.equal(alfrescoJsApi.config.ticket, undefined);
});
it('should Logout be rejected if the Ticket is already expired', async () => {
authResponseEcmMock.get404ResponseLogout();
try {
await alfrescoJsApi.logout();
assert.fail('Expected logout to fail with 404');
} catch (error: any) {
assert.equal(error.status, 404);
}
});
});
describe('Unauthorized', () => {
beforeEach(async () => {
authResponseEcmMock.get201Response('TICKET_22d7a5a83d78b9cc9666ec4e412475e5455b33bd');
await alfrescoJsApi.login('admin', 'admin');
});
it('should 401 invalidate the ticket', async () => {
nodeMock.get401CreationFolder();
try {
await nodesApi.createFolder('newFolder', null, null);
} catch {
assert.equal(alfrescoJsApi.contentAuth.authentications.basicAuth.password, null);
}
});
it('should 401 invalidate the session and logout', async () => {
nodeMock.get401CreationFolder();
try {
await nodesApi.createFolder('newFolder', null, null);
} catch {
assert.equal(alfrescoJsApi.isLoggedIn(), false);
}
});
it('should emit an error event if a failing call is executed', async () => {
let errorEventFired = false;
alfrescoJsApi.on('error', () => {
errorEventFired = true;
});
nodeMock.get401CreationFolder();
try {
await nodesApi.createFolder('newFolder', null, null);
} catch {
// Expected error
}
assert.equal(errorEventFired, true, 'Error event should have fired');
});
});
afterEach(async () => {
alfrescoJsApi = null as any;
await flushMicrotasks();
});
});
});
describe('BPM Provider config', () => {
let profileMock: ProfileMock;
let authResponseBpmMock: BpmAuthMock;
let alfrescoJsApi: AlfrescoApi;
let profileApi: UserProfileApi;
let sandbox: sinon.SinonSandbox;
beforeEach(() => {
sandbox = sinon.createSandbox();
profileMock = new ProfileMock(BPM_HOST);
authResponseBpmMock = new BpmAuthMock(BPM_HOST);
alfrescoJsApi = new AlfrescoApi({
hostBpm: BPM_HOST,
provider: 'BPM'
});
profileApi = new UserProfileApi(alfrescoJsApi);
});
afterEach(async () => {
sandbox.restore();
authResponseBpmMock.cleanAll();
profileMock.cleanAll();
resetGlobalMockAgent();
alfrescoJsApi = null as any;
await flushMicrotasks();
});
describe('With Authentication', () => {
describe('login', () => {
it('should return the Ticket if all is ok', async () => {
authResponseBpmMock.get200Response();
const data = await alfrescoJsApi.login('admin', 'admin');
assert.equal(data, 'Basic YWRtaW46YWRtaW4=');
});
});
describe('isLoggedIn', () => {
it('should return true if the api is logged in', async () => {
authResponseBpmMock.get200Response();
await alfrescoJsApi.login('admin', 'admin');
assert.equal(alfrescoJsApi.isLoggedIn(), true);
});
it('should return false if the api is logged out', async () => {
authResponseBpmMock.get200Response();
await alfrescoJsApi.login('admin', 'admin');
authResponseBpmMock.get200ResponseLogout();
await alfrescoJsApi.logout();
assert.equal(alfrescoJsApi.isLoggedIn(), false);
});
});
describe('Events ', () => {
it('should the Api fire success event if is all ok 201', async () => {
authResponseBpmMock.get200Response();
const data = await alfrescoJsApi.login('admin', 'admin');
assert.equal(data, 'Basic YWRtaW46YWRtaW4=');
});
it('should the Api fire logout event if the logout is successfull', async () => {
authResponseBpmMock.get200Response();
await alfrescoJsApi.login('admin', 'admin');
authResponseBpmMock.get200ResponseLogout();
await alfrescoJsApi.logout();
assert.equal(alfrescoJsApi.isLoggedIn(), false);
});
});
describe('Unauthorized', () => {
beforeEach(async () => {
authResponseBpmMock.get200Response();
await alfrescoJsApi.login('admin', 'admin');
});
it('should 401 invalidate the ticket', async () => {
profileMock.get401getProfile();
try {
await profileApi.getProfile();
} catch {
assert.equal(alfrescoJsApi.processAuth.authentications.basicAuth.ticket, null);
}
});
it('should 401 invalidate the session and logout', async () => {
profileMock.get401getProfile();
try {
await profileApi.getProfile();
} catch {
assert.equal(alfrescoJsApi.isLoggedIn(), false);
}
});
});
afterEach(async () => {
alfrescoJsApi = null as any;
await flushMicrotasks();
});
});
});
describe('BPM and ECM Provider config', () => {
let authResponseEcmMock: EcmAuthMock;
let authResponseBpmMock: BpmAuthMock;
let alfrescoJsApi: AlfrescoApi;
let sandbox: sinon.SinonSandbox;
beforeEach(() => {
sandbox = sinon.createSandbox();
authResponseEcmMock = new EcmAuthMock(ECM_HOST);
authResponseBpmMock = new BpmAuthMock(BPM_HOST);
authResponseEcmMock.cleanAll();
authResponseBpmMock.cleanAll();
alfrescoJsApi = new AlfrescoApi({
hostEcm: ECM_HOST,
hostBpm: BPM_HOST,
provider: 'ALL'
});
});
afterEach(async () => {
sandbox.restore();
authResponseEcmMock.cleanAll();
authResponseBpmMock.cleanAll();
resetGlobalMockAgent();
alfrescoJsApi = null as any;
await flushMicrotasks();
});
describe('With Authentication', () => {
it('should Ticket be present in the client', () => {
authResponseBpmMock.get200Response();
authResponseEcmMock.get201Response();
const api = new AlfrescoApi({
ticketEcm: 'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1',
ticketBpm: 'Basic YWRtaW46YWRtaW4=',
hostEcm: ECM_HOST,
hostBpm: BPM_HOST,
provider: 'ALL'
});
assert.equal('Basic YWRtaW46YWRtaW4=', api.processClient.authentications.basicAuth.ticket);
assert.equal('TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1', api.contentClient.authentications.basicAuth.password);
});
describe('login', () => {
it('should return the Ticket if all is ok', async () => {
authResponseBpmMock.get200Response();
authResponseEcmMock.get201Response();
const data = await alfrescoJsApi.login('admin', 'admin');
assert.equal(data[0], 'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1');
assert.equal(data[1], 'Basic YWRtaW46YWRtaW4=');
});
});
describe('isLoggedIn', () => {
it('should return false if the api is logged out', async () => {
authResponseBpmMock.get200Response();
authResponseEcmMock.get201Response();
await alfrescoJsApi.login('admin', 'admin');
authResponseBpmMock.get200ResponseLogout();
authResponseEcmMock.get204ResponseLogout();
await alfrescoJsApi.logout();
assert.equal(alfrescoJsApi.isLoggedIn(), false);
});
});
it('should return true if the api is logged in', async () => {
authResponseBpmMock.get200Response();
authResponseEcmMock.get201Response();
await alfrescoJsApi.login('admin', 'admin');
assert.equal(alfrescoJsApi.isLoggedIn(), true);
});
describe('Events ', () => {
it('should The Api fire success event if is all ok 201', async () => {
authResponseBpmMock.get200Response();
authResponseEcmMock.get201Response();
const data = await alfrescoJsApi.login('admin', 'admin');
assert.equal(Array.isArray(data), true);
assert.equal(data[0], 'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1');
assert.equal(data[1], 'Basic YWRtaW46YWRtaW4=');
});
it('should The Api fire logout event if the logout is successful', async () => {
authResponseBpmMock.get200Response();
authResponseEcmMock.get201Response();
await alfrescoJsApi.login('admin', 'admin');
authResponseBpmMock.get200ResponseLogout();
authResponseEcmMock.get204ResponseLogout();
await alfrescoJsApi.logout();
assert.equal(alfrescoJsApi.isLoggedIn(), false);
});
});
afterEach(async () => {
alfrescoJsApi = null as any;
await flushMicrotasks();
});
});
});
});