/*
 * JDrupes Builder
 * Copyright (C) 2025 Michael N. Lipp
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

package org.jdrupes.builder.junit;

import com.google.common.flogger.FluentLogger;
import static com.google.common.flogger.LazyArgs.*;
import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
import java.nio.file.Path;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Objects;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.jdrupes.builder.api.Generator;
import org.jdrupes.builder.api.Intent;
import static org.jdrupes.builder.api.Intent.*;
import org.jdrupes.builder.api.MergedTestProject;
import org.jdrupes.builder.api.Project;
import org.jdrupes.builder.api.Resource;
import org.jdrupes.builder.api.ResourceRequest;
import org.jdrupes.builder.api.ResourceType;
import org.jdrupes.builder.api.Resources;
import org.jdrupes.builder.api.TestResult;
import org.jdrupes.builder.core.AbstractGenerator;
import org.jdrupes.builder.java.ClassTree;
import org.jdrupes.builder.java.ClasspathElement;
import static org.jdrupes.builder.java.JavaTypes.*;
import org.junit.platform.engine.TestDescriptor.Type;
import org.junit.platform.engine.TestExecutionResult;
import org.junit.platform.engine.TestExecutionResult.Status;
import org.junit.platform.engine.discovery.DiscoverySelectors;
import org.junit.platform.engine.reporting.FileEntry;
import org.junit.platform.engine.reporting.ReportEntry;
import org.junit.platform.engine.support.descriptor.ClassSource;
import org.junit.platform.launcher.LauncherDiscoveryRequest;
import org.junit.platform.launcher.TestExecutionListener;
import org.junit.platform.launcher.TestIdentifier;
import org.junit.platform.launcher.TestPlan;
import org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder;
import org.junit.platform.launcher.core.LauncherFactory;
import org.junit.platform.launcher.listeners.LoggingListener;
import org.junit.platform.launcher.listeners.SummaryGeneratingListener;

/// A [Generator] for [TestResult]s using the JUnit platform. The runner
/// assumes that it is configured as [Generator] for a test project. 
/// The class path for running the tests is build as follows:
/// 
///  1. Request compilation classpath resources from the test project's
///     dependencies with [Intent#Consume], [Intent#Expose],
///     and [Intent#Supply]. This makes the resources available that
///     are used for compiling test classes as well as the compiled
///     test classes. 
/// 
///  2. If the project implements [MergedTestProject], get the
///     [Project#parentProject()], request compilation class path
///     resources from its dependencies with [Intent#Consume],
///     [Intent#Expose], and [Intent#Supply] and add them to the
///     class path. This makes the resources available that are used
///     for compiling the classes under test as well as the classes
///     under test. Note that this is partially redundant, because
///     test projects most likely have a dependency with [Intent#Consume]
///     on the project under test anyway in order to compile the test
///     classes. This dependency does not, however, provide all resources
///     that are required to test the project under test.  
/// 
/// The runner then requests all resources of type [ClassTree] from
/// the test projects's [Generator]'s and passes them to JUnit's
/// test class detector.
/// 
/// Libraries for compiling the tests and a test engine of your choice
/// must be provided explicitly to the runner's project as dependencies,
///  e.g. as:
/// ```
/// project.dependency(Consume, new MvnRepoLookup()
///     .bom("org.junit:junit-bom:5.12.2")
///     .resolve("org.junit.jupiter:junit-jupiter-api")
///     .resolve(Scope.Runtime,
///        "org.junit.jupiter:junit-jupiter-engine"));
/// ```
///
/// In order to track the execution of the each test, you can enable
/// level fine logging for this class. Level finer will also
/// provide information about the class paths.
/// 
public class JUnitTestRunner extends AbstractGenerator {

    private static final FluentLogger logger = FluentLogger.forEnclosingClass();
    private boolean ignoreFailed;
    private Object syncObject;

    /// Initializes a new test runner.
    ///
    /// @param project the project
    ///
    public JUnitTestRunner(Project project) {
        super(project);
    }

    /// Ignore failed tests. If invoked, the test runner does not set the
    /// faulty flag of the test results if a test has failed.
    ///
    /// @return the junit test runner
    ///
    public JUnitTestRunner ignoreFailed() {
        this.ignoreFailed = true;
        return this;
    }

    /// By default, [JUnitTestRunner]s run independently of each other.
    /// Because they run in the VM, this can cause concurrency issues if
    /// components in different test projects share static resources.
    /// 
    /// By invoking this method, [JUnitTestRunner]s with the same
    /// [syncObject] are synchronized, i.e. run in sequence.
    ///
    /// @param syncObject the sync object
    /// @return the j unit test runner
    ///
    public JUnitTestRunner syncOn(Object syncObject) {
        this.syncObject = syncObject;
        return this;
    }

    @Override
    @SuppressWarnings({ "PMD.AvoidSynchronizedStatement", "PMD.NcssCount" })
    protected <T extends Resource> Collection<T>
            doProvide(ResourceRequest<T> requested) {
        if (!requested.accepts(new ResourceType<TestResult>() {})) {
            return Collections.emptyList();
        }

        // Collect the classpath.
        var cpResources = Resources.of(ClasspathType)
            .addAll(project().resources(of(ClasspathElementType)
                .using(Consume, Reveal, Expose, Supply)));
        if (project() instanceof MergedTestProject) {
            cpResources.addAll(project().parentProject().get()
                .resources(of(ClasspathElementType).using(Consume,
                    Reveal, Expose, Supply)));
        }
        logger.atFiner().log("Testing in %s with classpath %s", project(),
            lazy(() -> cpResources.stream().map(e -> e.toPath().toString())
                .collect(Collectors.joining(File.pathSeparator))));

        // Run the tests
        ClassLoader oldLoader = Thread.currentThread().getContextClassLoader();
        try (URLClassLoader testLoader = new URLClassLoader(
            Stream.concat(project()
                .resources(of(ClasspathElementType).using(Consume, Reveal)),
                cpResources.stream()).map(ClasspathElement::toPath)
                .map(Path::toUri).map(uri -> {
                    try {
                        return uri.toURL();
                    } catch (MalformedURLException e) {
                        throw new IllegalArgumentException(e);
                    }
                }).toArray(URL[]::new),
            ClassLoader.getSystemClassLoader())) {
            Thread.currentThread().setContextClassLoader(testLoader);

            // Discover all tests from generator's output
            var testClassTrees = project().providers(Consume, Reveal).filter(
                p -> p instanceof Generator).resources(of(ClassTreeType))
                .map(ClassTree::root).collect(Collectors.toSet());
            LauncherDiscoveryRequest request
                = LauncherDiscoveryRequestBuilder.request().selectors(
                    DiscoverySelectors.selectClasspathRoots(testClassTrees))
                    .build();

            // Run the tests
            var launcher = LauncherFactory.create();
            var summaryListener = new SummaryGeneratingListener();
            var testListener = new TestListener();
            launcher.registerTestExecutionListeners(
                LoggingListener.forJavaUtilLogging(), summaryListener,
                testListener);
            logger.atInfo().log("Running tests in project %s",
                project().name());
            if (syncObject != null) {
                synchronized (syncObject) {
                    launcher.execute(request);
                }
            } else {
                launcher.execute(request);
            }

            // Evaluate results
            var summary = summaryListener.getSummary();
            var result = TestResult.of(project(), this,
                buildName(testListener), summary.getTestsStartedCount(),
                summary.getTestsFailedCount());
            if (summary.getTestsFailedCount() > 0 && !ignoreFailed) {
                result.setFaulty();
            }
            @SuppressWarnings("unchecked")
            var asList = List.of((T) result);
            return asList;
        } catch (IOException e) {
            logger.atWarning().withCause(e).log("Failed to close classloader");
        } finally {
            Thread.currentThread().setContextClassLoader(oldLoader);
        }

        // Return result
        return Collections.emptyList();
    }

    @SuppressWarnings("PMD.AvoidLiteralsInIfCondition")
    private String buildName(TestListener testListener) {
        StringBuilder asList = new StringBuilder();
        for (var testId : testListener.testIds()) {
            if (!asList.isEmpty()) {
                asList.append(", ");
            }
            if (asList.length() > 30) {
                asList.append(" ...");
                break;
            }
            asList.append(testId.getDisplayName());
        }
        return asList.toString();
    }

    private void printExecutionResult(String testName,
            TestExecutionResult result) {
        context().error().format("Failed: %s\n", testName);
        if (result.getThrowable().isEmpty()) {
            return;
        }

        // Find INITIAL exception
        Throwable thrown = result.getThrowable().get();
        while (thrown.getCause() != null) {
            thrown = thrown.getCause();
        }
        thrown.printStackTrace(context().error());
    }

    /// A [TestExecutionListener] for JUnit.
    ///
    /// @see TestEvent
    ///
    @SuppressWarnings("PMD.TestClassWithoutTestCases")
    private final class TestListener implements TestExecutionListener {

        private final Set<TestIdentifier> tests = new HashSet<>();
        private TestPlan testPlan;

        /// Return the test classes.
        ///
        /// @return the sets the
        ///
        private Set<TestIdentifier> testIds() {
            return tests;
        }

        private String prettyTestName(TestIdentifier testId) {
            return Stream.iterate(testId, Objects::nonNull,
                id -> testPlan.getParent(id).orElse(null))
                .toList().reversed().stream().skip(1)
                .map(TestIdentifier::getDisplayName)
                .collect(Collectors.joining(" > "));
        }

        @Override
        @SuppressWarnings("PMD.UnitTestShouldUseTestAnnotation")
        public void testPlanExecutionStarted(TestPlan testPlan) {
            this.testPlan = testPlan;
        }

        @Override
        @SuppressWarnings("PMD.UnitTestShouldUseTestAnnotation")
        public void testPlanExecutionFinished(TestPlan testPlan) {
            // Not tracked
        }

        @Override
        public void dynamicTestRegistered(TestIdentifier testIdentifier) {
            // Not tracked
        }

        @Override
        public void executionSkipped(TestIdentifier testIdentifier,
                String reason) {
            // Not tracked
        }

        @Override
        public void executionStarted(TestIdentifier testIdentifier) {
            if (testIdentifier.getSource().isPresent()
                && testIdentifier.getSource().get() instanceof ClassSource) {
                tests.add(testIdentifier);
            }
            context().statusLine().update(JUnitTestRunner.this
                + " running: " + prettyTestName(testIdentifier));
        }

        @Override
        public void executionFinished(TestIdentifier testIdentifier,
                TestExecutionResult testExecutionResult) {
            if (testExecutionResult.getStatus() == Status.SUCCESSFUL) {
                if (testIdentifier.getType() != Type.TEST) {
                    return;
                }
                logger.atFine().log("Succeeded: %s",
                    lazy(() -> prettyTestName(testIdentifier)));
                return;
            }
            if (testExecutionResult.getThrowable().isEmpty()) {
                logger.atWarning().log("Failed: %s",
                    lazy(() -> prettyTestName(testIdentifier)));
                printExecutionResult(prettyTestName(testIdentifier),
                    testExecutionResult);
                return;
            }
            logger.atWarning()
                .withCause(testExecutionResult.getThrowable().get())
                .log("Failed: %s", lazy(() -> prettyTestName(testIdentifier)));
            printExecutionResult(prettyTestName(testIdentifier),
                testExecutionResult);
        }

        @Override
        public void reportingEntryPublished(TestIdentifier testIdentifier,
                ReportEntry entry) {
            // Not tracked
        }

        @Override
        public void fileEntryPublished(TestIdentifier testIdentifier,
                FileEntry file) {
            // Not tracked
        }
    }
}