NoticeFilesTest.java

/*
 * Copyright (c) 2023 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.jersey.test.artifacts;

import org.apache.maven.model.Model;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import org.glassfish.jersey.message.internal.ReaderWriter;
import org.junit.Assert;
import org.junit.Test;

import jakarta.ws.rs.core.MediaType;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.LinkedList;
import java.util.List;
import java.util.StringTokenizer;
import java.util.regex.Pattern;

public class NoticeFilesTest {

    @Test
    public void test() throws IOException, XmlPullParserException {
        Model model = MavenUtil.getModelFromFile("../../pom.xml");
        List<NoticeDependencyVersionPair> mainExpectedNoticeDeps = mainExpectedDependencies();

        File mainNotice = new File("../../NOTICE.md");
        List<NoticeDependencyVersionPair> mainNoticeDeps = parseNoticeFileVersions(mainNotice);
        TestResult testResult = compareDependencies(mainExpectedNoticeDeps, mainNoticeDeps, model, mainNotice.getCanonicalPath());

        // Nothing to check here, yet
//        File commonNotice = new File("../../core-common/src/main/resources/META-INF/NOTICE.markdown");
//        List<NoticeDependencyVersionPair> commonNoticeDeps = parseNoticeFileVersions(mainNotice);
//        testResult.append(compareDependencies(expectedNoticeDeps, commonNoticeDeps, model, commonNotice.getCanonicalPath()));

        File serverNotice = new File("../../core-server/src/main/resources/META-INF/NOTICE.markdown");
        List<NoticeDependencyVersionPair> serverNoticeDeps = parseNoticeFileVersions(serverNotice);
        List<NoticeDependencyVersionPair> serverExpectedNoticeDeps = serverExpectedDependencies();
        testResult.append(
                compareDependencies(serverExpectedNoticeDeps, serverNoticeDeps, model, serverNotice.getCanonicalPath()));

        File jacksonNotice = new File("../../media/json-jackson/src/main/resources/META-INF/NOTICE.markdown");
        List<NoticeDependencyVersionPair> jacksonNoticeDeps = parseNoticeFileVersions(jacksonNotice);
        List<NoticeDependencyVersionPair> jacksonExpectedNoticeDeps = jacksonExpectedDependencies();
        testResult.append(
                compareDependencies(jacksonExpectedNoticeDeps, jacksonNoticeDeps, model, jacksonNotice.getCanonicalPath()));

        File bvNotice = new File("../../ext/bean-validation/src/main/resources/META-INF/NOTICE.markdown");
        List<NoticeDependencyVersionPair> bvNoticeDeps = parseNoticeFileVersions(bvNotice);
        List<NoticeDependencyVersionPair> bvExpectedNoticeDeps = bvExpectedDependencies();
        testResult.append(
                compareDependencies(bvExpectedNoticeDeps, bvNoticeDeps, model, bvNotice.getCanonicalPath()));

        File examplesNotice = new File("../../examples/NOTICE.md");
        List<NoticeDependencyVersionPair> examplesNoticeDeps = parseNoticeFileVersions(examplesNotice);
        testResult.append(
                compareDependencies(mainExpectedNoticeDeps, examplesNoticeDeps, model, examplesNotice.getCanonicalPath()));

        Assert.assertTrue("Some error occurred, see previous messages", testResult.result());
    }

    private TestResult compareDependencies(List<NoticeDependencyVersionPair> expectedDeps,
                                     List<NoticeDependencyVersionPair> actualDeps,
                                     Model model, String noticeName) {
        TestResult testResult = new TestResult();
        NextExpected:
        for (NoticeDependencyVersionPair expectedDep : expectedDeps) {
            for (NoticeDependencyVersionPair actualDep : actualDeps) {
                if (expectedDep.dependency.equals(actualDep.dependency)) {
                    String expectedVersion = findVersionInModel(expectedDep, model);
                    testResult.ok().append("Expected dependency ").append(expectedDep.dependency).println(" found");
                    if (expectedVersion.equals(actualDep.version)) {
                        testResult.ok().append("Dependency ").append(actualDep.dependency).append(" contains expected version ")
                                .append(expectedVersion).append(" in ").println(noticeName);
                    } else {
                        testResult.exception().append("Dependency ").append(actualDep.dependency).append(" differs version ")
                                .append(expectedVersion).append(" from ").append(noticeName).append(" version ")
                                .println(actualDep.version);
                    }
                    continue NextExpected;
                }
            }
            testResult.exception().append("Expected dependency ").append(expectedDep.dependency).append(" not found in ")
                    .println(noticeName);
        }
        return testResult;
    }

    private static String findVersionInModel(NoticeDependencyVersionPair pair, Model model) {
        if (pair.version.startsWith("${")) {
            String version = pair.version.substring(2, pair.version.length() - 1);
            return model.getProperties().getProperty(version);
        } else {
            return pair.version;
        }
    }

    private void cat(File path) throws IOException {
        StringTokenizer tokenizer = tokenizerFromNoticeFile(path);
        while (tokenizer.hasMoreTokens()) {
            String token = tokenizer.nextToken();
            if (token.trim().length() > 1 && !token.trim().startsWith("*")) {
                System.out.println(token);
//                String filteredToken = removeUnnecessary(token);
//                System.out.println(filteredToken);
//                Pattern versionizer = Pattern.compile("([.*])?([\\d])");
//                System.out.println(versionizer.matcher(filteredToken).replaceFirst("$1:$2"));
            }
        }
    }

    private List<NoticeDependencyVersionPair> parseNoticeFileVersions(File path) throws IOException {
        List<NoticeDependencyVersionPair> list = new LinkedList<>();
        StringTokenizer tokenizer = tokenizerFromNoticeFile(path);
        while (tokenizer.hasMoreTokens()) {
            String token = tokenizer.nextToken();
            if (token.trim().length() > 1 && !token.trim().startsWith("*")) {
                String filteredToken = removeUnnecessary(token);
                Pattern versionizer = Pattern.compile("([.*])?([\\d])");
                String[] args = versionizer.matcher(filteredToken).replaceFirst("$1:$2").split(":", 2);
                NoticeDependencyVersionPair pair = args.length == 2
                        ? new NoticeDependencyVersionPair(args[0], args[1])
                        : new NoticeDependencyVersionPair(args[0], "");
                list.add(pair);
            }
        }

        return list;
    }

    private StringTokenizer tokenizerFromNoticeFile(File path) throws IOException {
        StringTokenizer tokenizer = new StringTokenizer(getFile(path), "\n");
        while (tokenizer.hasMoreTokens()) {
            String token = tokenizer.nextToken();
            if (token.trim().startsWith("## Third-party Content")) {
                break;
            }
        }
        return tokenizer;
    }

    private String getFile(File path) throws IOException {
        return ReaderWriter.readFromAsString(new FileInputStream(path), MediaType.TEXT_PLAIN_TYPE);
    }

    private String removeUnnecessary(String dependency) {
        String filtered = dependency
                .replace(" Version ", "").replace(" version ", "")
                .replace(" API ", "")
                .replace(" v", "")
                .replace(", ", "").replace(",", "")
                .replace(": ", "").replace(": ", "");
        return filtered;
    }

    /**
     * Return pair of Notice file dependency name & pom.xml version property name
     */
    private List<NoticeDependencyVersionPair> mainExpectedDependencies() {
        final List<NoticeDependencyVersionPair> dependencyPairs = new LinkedList<>();
        dependencyPairs.add(new NoticeDependencyVersionPair("org.objectweb.asm", "${asm.version}"));
        dependencyPairs.add(new NoticeDependencyVersionPair("org.osgi.core", "${osgi.version}"));
        dependencyPairs.add(new NoticeDependencyVersionPair("Jackson JAX-RS Providers", "${jackson.version}"));
        dependencyPairs.add(new NoticeDependencyVersionPair("Javassist", "${javassist.version}"));
        dependencyPairs.add(new NoticeDependencyVersionPair("Hibernate Validator CDI", "${validation.impl.version}"));
        dependencyPairs.add(new NoticeDependencyVersionPair("Bean Validation", "${jakarta.validation.api.version}"));
        return dependencyPairs;
    }

    private List<NoticeDependencyVersionPair> serverExpectedDependencies() {
        final List<NoticeDependencyVersionPair> dependencyPairs = new LinkedList<>();
        dependencyPairs.add(new NoticeDependencyVersionPair("org.objectweb.asm", "${asm.version}"));
        return dependencyPairs;
    }

    private List<NoticeDependencyVersionPair> bvExpectedDependencies() {
        final List<NoticeDependencyVersionPair> dependencyPairs = new LinkedList<>();
        dependencyPairs.add(new NoticeDependencyVersionPair("Hibernate Validator CDI", "${validation.impl.version}"));
        return dependencyPairs;
    }

    private List<NoticeDependencyVersionPair> jacksonExpectedDependencies() {
        final List<NoticeDependencyVersionPair> dependencyPairs = new LinkedList<>();
        dependencyPairs.add(new NoticeDependencyVersionPair("Jackson JAX-RS Providers", "${jackson.version}"));
        return dependencyPairs;
    }

    private static class NoticeDependencyVersionPair {
        private final String dependency;
        private final String version;

        private NoticeDependencyVersionPair(String dependency, String version) {
            this.dependency = dependency.trim();
            this.version = version.trim();
        }
    }
}