passbolt-styleguide
Version:
Passbolt styleguide contains common styling assets used by the different sites, plugin, etc.
205 lines (178 loc) • 8.28 kB
JavaScript
/**
* Passbolt ~ Open source password manager for teams
* Copyright (c) Passbolt SA (https://www.passbolt.com)
*
* Licensed under GNU Affero General Public License version 3 of the or any later version.
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Passbolt SA (https://www.passbolt.com)
* @license https://opensource.org/licenses/AGPL-3.0 AGPL License
* @link https://www.passbolt.com Passbolt(tm)
* @since 5.0.0
*/
import EntitySchema from "../abstract/entitySchema";
import * as assertEntityProperty from "../../../../../test/assert/assertEntityProperty";
import SecretDataV5DefaultTotpEntity from "./secretDataV5DefaultTotpEntity";
import {
defaultSecretDataV5DefaultTotpEntityDto,
minimalSecretDataV5DefaultTotpEntityDto,
} from "./secretDataV5DefaultTotpEntity.test.data";
import TotpEntity from "../totp/totpEntity";
import { defaultTotpDto } from "../totp/totpDto.test.data";
import { SECRET_DATA_OBJECT_TYPE } from "./secretDataEntity";
import CustomFieldsCollection from "../customField/customFieldsCollection";
import { defaultCustomField } from "../customField/customFieldEntity.test.data";
import CustomFieldEntity from "../customField/customFieldEntity";
import { defaultCustomFieldsCollection } from "../customField/customFieldsCollection.test.data";
describe("SecretDataV5DefaultTotpEntity", () => {
describe("::getSchema", () => {
it("schema must validate", () => {
EntitySchema.validateSchema(SecretDataV5DefaultTotpEntity.name, SecretDataV5DefaultTotpEntity.getSchema());
});
it("validates object_type property", () => {
assertEntityProperty.enumeration(
SecretDataV5DefaultTotpEntity,
"object_type",
[SECRET_DATA_OBJECT_TYPE],
["any other values"],
);
});
it("validates password property", () => {
assertEntityProperty.string(SecretDataV5DefaultTotpEntity, "password");
assertEntityProperty.required(SecretDataV5DefaultTotpEntity, "password");
assertEntityProperty.nullable(SecretDataV5DefaultTotpEntity, "password");
assertEntityProperty.maxLength(SecretDataV5DefaultTotpEntity, "password", 4096);
});
it("validates totp property", () => {
expect.assertions(3);
const dto = minimalSecretDataV5DefaultTotpEntityDto();
const successScenario = [{ scenario: "a valid totp", value: defaultTotpDto() }];
const failScenario = [
{
scenario: "The totp validation should failed.",
value: defaultTotpDto({
algorithm: "not an algorithm",
}),
},
];
assertEntityProperty.assertAssociation(SecretDataV5DefaultTotpEntity, "totp", dto, successScenario, failScenario);
assertEntityProperty.required(SecretDataV5DefaultTotpEntity, "totp");
});
it("validates description property", () => {
assertEntityProperty.string(SecretDataV5DefaultTotpEntity, "description");
assertEntityProperty.nullable(SecretDataV5DefaultTotpEntity, "description");
assertEntityProperty.maxLength(SecretDataV5DefaultTotpEntity, "description", 50000);
});
});
describe("::associations", () => {
it("associations should have totp and custom_fields", () => {
expect.assertions(1);
expect(SecretDataV5DefaultTotpEntity.associations).toStrictEqual({
totp: TotpEntity,
custom_fields: CustomFieldsCollection,
});
});
});
describe("::constructor", () => {
it("constructor works if minimal valid DTO is provided", () => {
expect.assertions(2);
const dto = minimalSecretDataV5DefaultTotpEntityDto();
const entity = new SecretDataV5DefaultTotpEntity(dto);
expect(entity._props.password).toStrictEqual(dto.password);
expect(entity.totp.toDto()).toStrictEqual(dto.totp);
});
it("constructor works if valid DTO is provided", () => {
expect.assertions(3);
const dto = defaultSecretDataV5DefaultTotpEntityDto();
const entity = new SecretDataV5DefaultTotpEntity(dto);
expect(entity._props.password).toStrictEqual(dto.password);
expect(entity._props.description).toStrictEqual(dto.description);
expect(entity.totp.toDto()).toStrictEqual(dto.totp);
});
});
describe("::createFromDefault", () => {
it("create with no data provided", () => {
expect.assertions(5);
const dto = minimalSecretDataV5DefaultTotpEntityDto();
dto.totp.secret_key = "";
const entity = SecretDataV5DefaultTotpEntity.createFromDefault({}, { validate: false });
expect(entity.objectType).toStrictEqual(dto.object_type);
expect(entity.password).toStrictEqual("");
expect(entity.totp.toDto()).toStrictEqual(dto.totp);
expect(entity.description).toBeUndefined();
expect(entity.customFields).toBeNull();
});
it("create with data provided", () => {
expect.assertions(10);
const dto = defaultSecretDataV5DefaultTotpEntityDto({
custom_fields: [defaultCustomField()],
});
const entity = new SecretDataV5DefaultTotpEntity(dto);
expect(entity.objectType).toStrictEqual(dto.object_type);
expect(entity.password).toStrictEqual(dto.password);
expect(entity.totp.toDto()).toStrictEqual(dto.totp);
expect(entity.description).toStrictEqual(dto.description);
expect(entity.customFields).toBeInstanceOf(CustomFieldsCollection);
expect(entity.customFields).toHaveLength(1);
expect(entity.customFields.items[0]).toBeInstanceOf(CustomFieldEntity);
expect(entity.customFields.items[0]._props.id).toStrictEqual(dto.custom_fields[0].id);
expect(entity.customFields.items[0]._props.metadata_key).toStrictEqual(dto.custom_fields[0].metadata_key);
expect(entity.customFields.items[0].value).toStrictEqual(dto.custom_fields[0].secret_value);
});
});
describe("::getDefaultProp", () => {
it("get default password", () => {
expect.assertions(1);
expect(SecretDataV5DefaultTotpEntity.getDefaultProp("password")).toStrictEqual("");
});
it("get default description", () => {
expect.assertions(1);
expect(SecretDataV5DefaultTotpEntity.getDefaultProp("description")).toStrictEqual("");
});
it("get default totp", () => {
expect.assertions(1);
expect(SecretDataV5DefaultTotpEntity.getDefaultProp("totp")).toStrictEqual(
TotpEntity.createFromDefault({}, { validate: false }).toDto(),
);
});
it("get default unknown", () => {
expect.assertions(1);
expect(SecretDataV5DefaultTotpEntity.getDefaultProp("unknown")).toBeUndefined();
});
it("throw error if prop name is not a string", () => {
expect.assertions(1);
expect(() => SecretDataV5DefaultTotpEntity.getDefaultProp({})).toThrow(TypeError);
});
});
describe("::areSecretsDifferent", () => {
it("should return true", () => {
const dto = defaultSecretDataV5DefaultTotpEntityDto();
const entity = SecretDataV5DefaultTotpEntity.createFromDefault(dto);
expect(entity.areSecretsDifferent({ password: dto.password, totp: dto.totp })).toBeTruthy();
});
it("should return false", () => {
const dto = defaultSecretDataV5DefaultTotpEntityDto();
const entity = new SecretDataV5DefaultTotpEntity(dto);
expect(entity.areSecretsDifferent(dto)).toBeFalsy();
});
it("should return false if both custom fields collection are identical", () => {
const dto = defaultSecretDataV5DefaultTotpEntityDto({
custom_fields: defaultCustomFieldsCollection(),
});
const entity = new SecretDataV5DefaultTotpEntity(dto);
expect(entity.areSecretsDifferent(dto)).toBeFalsy();
});
it("should return true if both custom fields collection are different", () => {
const dtoA = defaultSecretDataV5DefaultTotpEntityDto({
custom_fields: defaultCustomFieldsCollection(),
});
const dtoB = {
...dtoA,
custom_fields: defaultCustomFieldsCollection(),
};
const entity = new SecretDataV5DefaultTotpEntity(dtoA);
expect(entity.areSecretsDifferent(dtoB)).toBeTruthy();
});
});
});