wallet-core/packages/merchant-backoffice-ui/src/hooks/instance.test.ts
2023-05-05 08:52:58 -03:00

732 lines
21 KiB
TypeScript

/*
This file is part of GNU Taler
(C) 2021-2023 Taler Systems S.A.
GNU Taler is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 3, or (at your option) any later version.
GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
GNU Taler; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
*/
/**
*
* @author Sebastian Javier Marchano (sebasjm)
*/
import * as tests from "@gnu-taler/web-util/testing";
import { expect } from "chai";
import { MerchantBackend } from "../declaration.js";
import {
useAdminAPI,
useBackendInstances,
useInstanceAPI,
useInstanceDetails,
useManagementAPI,
} from "./instance.js";
import { ApiMockEnvironment } from "./testing.js";
import {
API_CREATE_INSTANCE,
API_DELETE_INSTANCE,
API_GET_CURRENT_INSTANCE,
API_LIST_INSTANCES,
API_UPDATE_CURRENT_INSTANCE,
API_UPDATE_CURRENT_INSTANCE_AUTH,
API_UPDATE_INSTANCE_BY_ID,
} from "./urls.js";
describe("instance api interaction with details", () => {
it("should evict cache when updating an instance", async () => {
const env = new ApiMockEnvironment();
env.addRequestExpectation(API_GET_CURRENT_INSTANCE, {
response: {
name: "instance_name",
} as MerchantBackend.Instances.QueryInstancesResponse,
});
const hookBehavior = await tests.hookBehaveLikeThis(
() => {
const api = useInstanceAPI();
const query = useInstanceDetails();
return { query, api };
},
{},
[
({ query, api }) => {
expect(query.loading).true;
},
({ query, api }) => {
expect(env.assertJustExpectedRequestWereMade()).deep.eq({
result: "ok",
});
expect(query.loading).false;
expect(query.ok).true;
if (!query.ok) return;
expect(query.data).deep.equals({
name: "instance_name",
});
env.addRequestExpectation(API_UPDATE_CURRENT_INSTANCE, {
request: {
name: "other_name",
} as MerchantBackend.Instances.InstanceReconfigurationMessage,
});
env.addRequestExpectation(API_GET_CURRENT_INSTANCE, {
response: {
name: "other_name",
} as MerchantBackend.Instances.QueryInstancesResponse,
});
api.updateInstance({
name: "other_name",
} as MerchantBackend.Instances.InstanceReconfigurationMessage);
},
({ query, api }) => {
expect(env.assertJustExpectedRequestWereMade()).deep.eq({
result: "ok",
});
expect(query.loading).false;
expect(query.ok).true;
if (!query.ok) return;
expect(query.data).deep.equals({
name: "other_name",
});
},
],
env.buildTestingContext(),
);
expect(hookBehavior).deep.eq({ result: "ok" });
expect(env.assertJustExpectedRequestWereMade()).deep.eq({ result: "ok" });
});
it("should evict cache when setting the instance's token", async () => {
const env = new ApiMockEnvironment();
env.addRequestExpectation(API_GET_CURRENT_INSTANCE, {
response: {
name: "instance_name",
auth: {
method: "token",
token: "not-secret",
},
} as MerchantBackend.Instances.QueryInstancesResponse,
});
const hookBehavior = await tests.hookBehaveLikeThis(
() => {
const api = useInstanceAPI();
const query = useInstanceDetails();
return { query, api };
},
{},
[
({ query, api }) => {
expect(query.loading).true;
},
({ query, api }) => {
expect(env.assertJustExpectedRequestWereMade()).deep.eq({
result: "ok",
});
expect(query.loading).false;
expect(query.ok).true;
if (!query.ok) return;
expect(query.data).deep.equals({
name: "instance_name",
auth: {
method: "token",
token: "not-secret",
},
});
env.addRequestExpectation(API_UPDATE_CURRENT_INSTANCE_AUTH, {
request: {
method: "token",
token: "secret",
} as MerchantBackend.Instances.InstanceAuthConfigurationMessage,
});
env.addRequestExpectation(API_GET_CURRENT_INSTANCE, {
response: {
name: "instance_name",
auth: {
method: "token",
token: "secret",
},
} as MerchantBackend.Instances.QueryInstancesResponse,
});
api.setNewToken("secret");
},
({ query, api }) => {
expect(env.assertJustExpectedRequestWereMade()).deep.eq({
result: "ok",
});
expect(query.loading).false;
expect(query.ok).true;
if (!query.ok) return;
expect(query.data).deep.equals({
name: "instance_name",
auth: {
method: "token",
token: "secret",
},
});
},
],
env.buildTestingContext(),
);
expect(hookBehavior).deep.eq({ result: "ok" });
expect(env.assertJustExpectedRequestWereMade()).deep.eq({ result: "ok" });
});
it("should evict cache when clearing the instance's token", async () => {
const env = new ApiMockEnvironment();
env.addRequestExpectation(API_GET_CURRENT_INSTANCE, {
response: {
name: "instance_name",
auth: {
method: "token",
token: "not-secret",
},
} as MerchantBackend.Instances.QueryInstancesResponse,
});
const hookBehavior = await tests.hookBehaveLikeThis(
() => {
const api = useInstanceAPI();
const query = useInstanceDetails();
return { query, api };
},
{},
[
({ query, api }) => {
expect(query.loading).true;
},
({ query, api }) => {
expect(env.assertJustExpectedRequestWereMade()).deep.eq({
result: "ok",
});
expect(query.loading).false;
expect(query.ok).true;
if (!query.ok) return;
expect(query.data).deep.equals({
name: "instance_name",
auth: {
method: "token",
token: "not-secret",
},
});
env.addRequestExpectation(API_UPDATE_CURRENT_INSTANCE_AUTH, {
request: {
method: "external",
} as MerchantBackend.Instances.InstanceAuthConfigurationMessage,
});
env.addRequestExpectation(API_GET_CURRENT_INSTANCE, {
response: {
name: "instance_name",
auth: {
method: "external",
},
} as MerchantBackend.Instances.QueryInstancesResponse,
});
api.clearToken();
},
({ query, api }) => {
expect(env.assertJustExpectedRequestWereMade()).deep.eq({
result: "ok",
});
expect(query.loading).false;
expect(query.ok).true;
if (!query.ok) return;
expect(query.data).deep.equals({
name: "instance_name",
auth: {
method: "external",
},
});
},
],
env.buildTestingContext(),
);
expect(hookBehavior).deep.eq({ result: "ok" });
expect(env.assertJustExpectedRequestWereMade()).deep.eq({ result: "ok" });
// const { result, waitForNextUpdate } = renderHook(
// () => {
// const api = useInstanceAPI();
// const query = useInstanceDetails();
// return { query, api };
// },
// { wrapper: TestingContext }
// );
// expect(result.current).not.undefined;
// if (!result.current) {
// return;
// }
// expect(result.current.query.loading).true;
// await waitForNextUpdate({ timeout: 1 });
// expect(env.assertJustExpectedRequestWereMade()).deep.eq({ result: "ok" });
// expect(result.current.query.loading).false;
// expect(result.current?.query.ok).true;
// if (!result.current?.query.ok) return;
// expect(result.current.query.data).equals({
// name: 'instance_name',
// auth: {
// method: 'token',
// token: 'not-secret',
// }
// });
// act(async () => {
// await result.current?.api.clearToken();
// });
// expect(env.assertJustExpectedRequestWereMade()).deep.eq({ result: "ok" });
// expect(result.current.query.loading).false;
// await waitForNextUpdate({ timeout: 1 });
// expect(env.assertJustExpectedRequestWereMade()).deep.eq({ result: "ok" });
// expect(result.current.query.loading).false;
// expect(result.current.query.ok).true;
// expect(result.current.query.data).equals({
// name: 'instance_name',
// auth: {
// method: 'external',
// }
// });
});
});
describe("instance admin api interaction with listing", () => {
it("should evict cache when creating a new instance", async () => {
const env = new ApiMockEnvironment();
env.addRequestExpectation(API_LIST_INSTANCES, {
response: {
instances: [
{
name: "instance_name",
} as MerchantBackend.Instances.Instance,
],
},
});
const hookBehavior = await tests.hookBehaveLikeThis(
() => {
const api = useAdminAPI();
const query = useBackendInstances();
return { query, api };
},
{},
[
({ query, api }) => {
expect(query.loading).true;
},
({ query, api }) => {
expect(env.assertJustExpectedRequestWereMade()).deep.eq({
result: "ok",
});
expect(query.loading).false;
expect(query.ok).true;
if (!query.ok) return;
expect(query.data).deep.equals({
instances: [
{
name: "instance_name",
},
],
});
env.addRequestExpectation(API_CREATE_INSTANCE, {
request: {
name: "other_name",
} as MerchantBackend.Instances.InstanceConfigurationMessage,
});
env.addRequestExpectation(API_LIST_INSTANCES, {
response: {
instances: [
{
name: "instance_name",
} as MerchantBackend.Instances.Instance,
{
name: "other_name",
} as MerchantBackend.Instances.Instance,
],
},
});
api.createInstance({
name: "other_name",
} as MerchantBackend.Instances.InstanceConfigurationMessage);
},
({ query, api }) => {
expect(env.assertJustExpectedRequestWereMade()).deep.eq({
result: "ok",
});
expect(query.loading).false;
expect(query.ok).true;
if (!query.ok) return;
expect(query.data).deep.equals({
instances: [
{
name: "instance_name",
},
{
name: "other_name",
},
],
});
},
],
env.buildTestingContext(),
);
expect(hookBehavior).deep.eq({ result: "ok" });
expect(env.assertJustExpectedRequestWereMade()).deep.eq({ result: "ok" });
});
it("should evict cache when deleting an instance", async () => {
const env = new ApiMockEnvironment();
env.addRequestExpectation(API_LIST_INSTANCES, {
response: {
instances: [
{
id: "default",
name: "instance_name",
} as MerchantBackend.Instances.Instance,
{
id: "the_id",
name: "second_instance",
} as MerchantBackend.Instances.Instance,
],
},
});
const hookBehavior = await tests.hookBehaveLikeThis(
() => {
const api = useAdminAPI();
const query = useBackendInstances();
return { query, api };
},
{},
[
({ query, api }) => {
expect(query.loading).true;
},
({ query, api }) => {
expect(env.assertJustExpectedRequestWereMade()).deep.eq({
result: "ok",
});
expect(query.loading).false;
expect(query.ok).true;
if (!query.ok) return;
expect(query.data).deep.equals({
instances: [
{
id: "default",
name: "instance_name",
},
{
id: "the_id",
name: "second_instance",
},
],
});
env.addRequestExpectation(API_DELETE_INSTANCE("the_id"), {});
env.addRequestExpectation(API_LIST_INSTANCES, {
response: {
instances: [
{
id: "default",
name: "instance_name",
} as MerchantBackend.Instances.Instance,
],
},
});
api.deleteInstance("the_id");
},
({ query, api }) => {
expect(env.assertJustExpectedRequestWereMade()).deep.eq({
result: "ok",
});
expect(query.loading).false;
expect(query.ok).true;
if (!query.ok) return;
expect(query.data).deep.equals({
instances: [
{
id: "default",
name: "instance_name",
},
],
});
},
],
env.buildTestingContext(),
);
expect(hookBehavior).deep.eq({ result: "ok" });
expect(env.assertJustExpectedRequestWereMade()).deep.eq({ result: "ok" });
// const { result, waitForNextUpdate } = renderHook(
// () => {
// const api = useAdminAPI();
// const query = useBackendInstances();
// return { query, api };
// },
// { wrapper: TestingContext }
// );
// expect(result.current).not.undefined;
// if (!result.current) {
// return;
// }
// expect(result.current.query.loading).true;
// await waitForNextUpdate({ timeout: 1 });
// expect(env.assertJustExpectedRequestWereMade()).deep.eq({ result: "ok" });
// expect(result.current.query.loading).false;
// expect(result.current?.query.ok).true;
// if (!result.current?.query.ok) return;
// expect(result.current.query.data).equals({
// instances: [{
// id: 'default',
// name: 'instance_name'
// }, {
// id: 'the_id',
// name: 'second_instance'
// }]
// });
// env.addRequestExpectation(API_DELETE_INSTANCE('the_id'), {});
// act(async () => {
// await result.current?.api.deleteInstance('the_id');
// });
// expect(env.assertJustExpectedRequestWereMade()).deep.eq({ result: "ok" });
// env.addRequestExpectation(API_LIST_INSTANCES, {
// response: {
// instances: [{
// id: 'default',
// name: 'instance_name'
// } as MerchantBackend.Instances.Instance]
// },
// });
// expect(result.current.query.loading).false;
// await waitForNextUpdate({ timeout: 1 });
// expect(env.assertJustExpectedRequestWereMade()).deep.eq({ result: "ok" });
// expect(result.current.query.loading).false;
// expect(result.current.query.ok).true;
// expect(result.current.query.data).equals({
// instances: [{
// id: 'default',
// name: 'instance_name'
// }]
// });
});
it("should evict cache when deleting (purge) an instance", async () => {
const env = new ApiMockEnvironment();
env.addRequestExpectation(API_LIST_INSTANCES, {
response: {
instances: [
{
id: "default",
name: "instance_name",
} as MerchantBackend.Instances.Instance,
{
id: "the_id",
name: "second_instance",
} as MerchantBackend.Instances.Instance,
],
},
});
const hookBehavior = await tests.hookBehaveLikeThis(
() => {
const api = useAdminAPI();
const query = useBackendInstances();
return { query, api };
},
{},
[
({ query, api }) => {
expect(query.loading).true;
},
({ query, api }) => {
expect(env.assertJustExpectedRequestWereMade()).deep.eq({
result: "ok",
});
expect(query.loading).false;
expect(query.ok).true;
if (!query.ok) return;
expect(query.data).deep.equals({
instances: [
{
id: "default",
name: "instance_name",
},
{
id: "the_id",
name: "second_instance",
},
],
});
env.addRequestExpectation(API_DELETE_INSTANCE("the_id"), {
qparam: {
purge: "YES",
},
});
env.addRequestExpectation(API_LIST_INSTANCES, {
response: {
instances: [
{
id: "default",
name: "instance_name",
} as MerchantBackend.Instances.Instance,
],
},
});
api.purgeInstance("the_id");
},
({ query, api }) => {
expect(env.assertJustExpectedRequestWereMade()).deep.eq({
result: "ok",
});
expect(query.loading).false;
expect(query.ok).true;
if (!query.ok) return;
expect(query.data).deep.equals({
instances: [
{
id: "default",
name: "instance_name",
},
],
});
},
],
env.buildTestingContext(),
);
expect(hookBehavior).deep.eq({ result: "ok" });
expect(env.assertJustExpectedRequestWereMade()).deep.eq({ result: "ok" });
});
});
describe("instance management api interaction with listing", () => {
it("should evict cache when updating an instance", async () => {
const env = new ApiMockEnvironment();
env.addRequestExpectation(API_LIST_INSTANCES, {
response: {
instances: [
{
id: "managed",
name: "instance_name",
} as MerchantBackend.Instances.Instance,
],
},
});
const hookBehavior = await tests.hookBehaveLikeThis(
() => {
const api = useManagementAPI("managed");
const query = useBackendInstances();
return { query, api };
},
{},
[
({ query, api }) => {
expect(query.loading).true;
},
({ query, api }) => {
expect(env.assertJustExpectedRequestWereMade()).deep.eq({
result: "ok",
});
expect(query.loading).false;
expect(query.ok).true;
if (!query.ok) return;
expect(query.data).deep.equals({
instances: [
{
id: "managed",
name: "instance_name",
},
],
});
env.addRequestExpectation(API_UPDATE_INSTANCE_BY_ID("managed"), {
request: {
name: "other_name",
} as MerchantBackend.Instances.InstanceReconfigurationMessage,
});
env.addRequestExpectation(API_LIST_INSTANCES, {
response: {
instances: [
{
id: "managed",
name: "other_name",
} as MerchantBackend.Instances.Instance,
],
},
});
api.updateInstance({
name: "other_name",
} as MerchantBackend.Instances.InstanceConfigurationMessage);
},
({ query, api }) => {
expect(env.assertJustExpectedRequestWereMade()).deep.eq({
result: "ok",
});
expect(query.loading).false;
expect(query.ok).true;
if (!query.ok) return;
expect(query.data).deep.equals({
instances: [
{
id: "managed",
name: "other_name",
},
],
});
},
],
env.buildTestingContext(),
);
expect(hookBehavior).deep.eq({ result: "ok" });
expect(env.assertJustExpectedRequestWereMade()).deep.eq({ result: "ok" });
});
});