Mock users and groups

User mocks

You are able to create partial mock of a user using createUser, where all properties besides id and username are optional. You need to import { createUser } from "@foundry/functions-testing-lib".

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import { MyFunctions } from ".."

import { verifyOntologyEditFunction, createGroup, createUser } from "@foundry/functions-testing-lib";

describe("example test suite", () => {
    const myFunctions = new MyFunctions();
    test("test users and groups", async () => {
        const group = createGroup({
            id: "groupId",
        });
        const user = createUser({
            id: "userId",
            username: "username",
        });
        await expect(myFunctions.searchUsers("userId", "groupId")).resolves.toEqual([user, group]);
    });
});

This can be used to test the following function:

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
import { Function, OntologyEditFunction, Users, Group, Principal } from "@foundry/functions-api";

export class MyFunctions {
    @Function()
    public async searchUsers(userId: string, groupId: string): Promise<Principal[]> {
        const existingPrincipals = await Promise.all([
            Users.getUserByIdAsync(userId),
            Users.getGroupByIdAsync(groupId),
        ]);
        return existingPrincipals.filter(r => !!r).map(r => r!);
    }
}

Group mocks

You are also able to create partial mock of a group using createGroup, where all properties besides id are optional. You need to import { createGroup } from "@foundry/functions-testing-lib".

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
import { MyFunctions } from ".."

import { verifyOntologyEditFunction, createGroup } from "@foundry/functions-testing-lib";

describe("example test suite", () => {
    const myFunctions = new MyFunctions();
    test("test groups", async () => {
        const group = createGroup({
            id: "groupId",
        });
        await expect(myFunctions.searchGroups("groupId")).resolves.toEqual([group]);
    });
});

This can be used to test the following function:

Copied!
1
2
3
4
5
6
7
8
9
10
11
import { Function, OntologyEditFunction, Users, Group, Principal } from "@foundry/functions-api";

export class MyFunctions {
    @Function()
    public async searchGroups(groupId: string): Promise<Principal[]> {
        const existingPrincipals = await Promise.all([
            Users.getGroupByIdAsync(groupId),
        ]);
        return existingPrincipals.filter(r => !!r).map(r => r!);
    }
}