Unit test: inject KnoraApiConnection and spy on lib endpoint methods

[flavens]

We found a way to inject an instance of knora-api-connection and spy on one method in the knora-api-js-lib. However, this is not ideal and the MockFactory should provide a simpler way to get test data and call endpoint methods (e.g. getProjects()).

In this example, we create the spy in the beforeEach() because the method to get projects in the component is triggered in ngOnInit().

main.component.ts

 ngOnInit() {
       [...]
        this.loadProjects();
}

loadProjects() {
        this.loading = true;
        this.knoraApiConnection.admin.projectsEndpoint.getProjects().subscribe(
            (response: ApiResponseData<ProjectsResponse>) => { ... }
);}

main.component.spec.ts

[...]
beforeEach(inject([KnoraApiConnectionToken], (knoraApiConn) => {
        projectSpy = spyOn(knoraApiConn.admin.projectsEndpoint, 'getProjects').and.callFake(
            () => {
                const projectList = {
                    body: {
                        projects: [
                            {
                                id: 'http://rdfh.ch/projects/0801',
                                description: [
                                    {
                                        value: 'Bernoulli-Euler Online'
                                    }
                                ],
                                keywords: [],
                                logo: null,
                                longname: 'Bernoulli-Euler Online',
                                ontologies: [
                                    'http://www.knora.org/ontology/0801/leibniz',
                                    'http://www.knora.org/ontology/0801/biblio',
                                    'http://www.knora.org/ontology/0801/newton',
                                    'http://www.knora.org/ontology/0801/beol'
                                ],
                                selfjoin: false,
                                shortcode: '0801',
                                shortname: 'beol',
                                status: true
                            },
                            {
                                id: 'http://rdfh.ch/projects/0001',
                                description: [
                                    {
                                        value: 'Anything Project'
                                    }
                                ],
                                keywords: [],
                                logo: null,
                                longname: 'Anything Project',
                                ontologies: [
                                    'http://www.knora.org/ontology/0001/anything',
                                    'http://www.knora.org/ontology/0001/minimal',
                                    'http://www.knora.org/ontology/0001/something'
                                ],
                                selfjoin: false,
                                shortcode: '0001',
                                shortname: 'anything',
                                status: true
                            }
                        ]
                    }
                };

                return of(projectList);
            });

        fixture = TestBed.createComponent(MainComponent);
        component = fixture.componentInstance;
        element = fixture.nativeElement; // the HTML reference
        fixture.detectChanges();
}));

it('should load projects', () => {
        expect(projectSpy).toHaveBeenCalledTimes(1);
});

[tobiasschweizer]

I guess it should not be hard to add something to the public API that generates admin response data.