v1/controller/AnnotationControllerTest.java

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * See LICENSE.txt included in this distribution for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at LICENSE.txt.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
 * Portions Copyright (c) 2020, Chris Fraire <cfraire@me.com>.
 */
package org.opengrok.web.api.v1.controller;

import jakarta.ws.rs.core.Application;
import jakarta.ws.rs.core.GenericType;
import org.glassfish.jersey.server.ResourceConfig;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.opengrok.indexer.configuration.RuntimeEnvironment;
import org.opengrok.indexer.history.HistoryGuru;
import org.opengrok.indexer.history.RepositoryFactory;
import org.opengrok.indexer.index.Indexer;
import org.opengrok.indexer.util.TestRepository;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.stream.Collectors;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;

public class AnnotationControllerTest extends OGKJerseyTest {

    private final RuntimeEnvironment env = RuntimeEnvironment.getInstance();

    private TestRepository repository;

    @Override
    protected Application configure() {
        return new ResourceConfig(AnnotationController.class);
    }

    @BeforeEach
    @Override
    public void setUp() throws Exception {
        super.setUp();
        repository = new TestRepository();
        repository.create(HistoryGuru.class.getResource("/repositories"));

        env.setSourceRoot(repository.getSourceRoot());
        env.setDataRoot(repository.getDataRoot());
        env.setProjectsEnabled(true);
        env.setHistoryEnabled(true);
        RepositoryFactory.initializeIgnoredNames(env);

        Indexer.getInstance().prepareIndexer(
                env,
                true, // search for repositories
                true, // scan and add projects
                false, // don't create dictionary
                null, // subFiles - needed when refreshing history partially
                null); // repositories - needed when refreshing history partially
    }

    @AfterEach
    @Override
    public void tearDown() throws Exception {
        super.tearDown();

        // This should match Configuration constructor.
        env.setProjects(new ConcurrentHashMap<>());
        env.setRepositories(new ArrayList<>());
        env.getProjectRepositoriesMap().clear();

        repository.destroy();
    }

    private static int getNumLines(File file) throws IOException {
        int lines = 0;

        try (BufferedReader in = new BufferedReader(new FileReader(file))) {
            while (in.readLine() != null) {
                lines++;
            }
        }

        return lines;
    }

    @Test
    public void testAnnotationAPI() throws IOException {
        final String path = "git/Makefile";
        List<AnnotationController.AnnotationDTO> annotations = target("annotation")
                .queryParam("path", path)
                .request()
                .get(new GenericType<>() {
                });
        assertEquals(getNumLines(new File(env.getSourceRootFile(), path)), annotations.size());
        assertEquals("Trond Norbye", annotations.get(0).getAuthor());
        List<String> ids = annotations.stream().
                map(AnnotationController.AnnotationDTO::getRevision).
                collect(Collectors.toList());
        assertEquals(Arrays.asList("bb74b7e8", "bb74b7e8", "bb74b7e8", "bb74b7e8", "bb74b7e8",
                "bb74b7e8", "bb74b7e8", "bb74b7e8", "aa35c258", "aa35c258", "aa35c258"), ids);
        List<String> versions = annotations.stream().
                map(AnnotationController.AnnotationDTO::getVersion).
                collect(Collectors.toList());
        assertEquals(Arrays.asList("1/2", "1/2", "1/2", "1/2", "1/2", "1/2", "1/2", "1/2", "2/2", "2/2", "2/2"),
                versions);
        assertTrue(annotations.get(0).getDescription().contains("sunray"));
    }

    @Test
    public void testAnnotationAPIWithRevision() {
        final String path = "git/Makefile";
        List<AnnotationController.AnnotationDTO> annotations = target("annotation")
                .queryParam("path", path)
                .queryParam("revision", "bb74b7e8")
                .request()
                .get(new GenericType<>() {
                });
        assertEquals(8, annotations.size());
        assertEquals("Trond Norbye", annotations.get(0).getAuthor());
        Set<String> ids = annotations.stream().
                map(AnnotationController.AnnotationDTO::getRevision).
                collect(Collectors.toSet());
        List<String> versions = annotations.stream().
                map(AnnotationController.AnnotationDTO::getVersion).
                collect(Collectors.toList());
        assertEquals(Arrays.asList("1/1", "1/1", "1/1", "1/1", "1/1", "1/1", "1/1", "1/1"),
                versions);
        assertEquals(Collections.singleton("bb74b7e8"), ids);
    }
}