/*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you under the Apache License, Version 2.0 (the
    * "License"); you may not use this file except in compliance
    * with the License.  You may obtain a copy of the License at
    *
   *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   * KIND, either express or implied.  See the License for the
   * specific language governing permissions and limitations
   * under the License.
   */
  package org.apache.maven.surefire.junitcore;
  
  import java.util.Map;
  import java.util.Set;
  import java.util.concurrent.ConcurrentHashMap;
  
  import org.apache.maven.plugin.surefire.log.api.ConsoleLogger;
  import org.apache.maven.surefire.api.booter.Command;
  import org.apache.maven.surefire.api.provider.AbstractProvider;
  import org.apache.maven.surefire.api.provider.CommandChainReader;
  import org.apache.maven.surefire.api.provider.CommandListener;
  import org.apache.maven.surefire.api.provider.ProviderParameters;
  import org.apache.maven.surefire.api.report.ReporterFactory;
  import org.apache.maven.surefire.api.suite.RunResult;
  import org.apache.maven.surefire.api.testset.TestListResolver;
  import org.apache.maven.surefire.api.testset.TestSetFailedException;
  import org.apache.maven.surefire.api.util.RunOrderCalculator;
  import org.apache.maven.surefire.api.util.ScanResult;
  import org.apache.maven.surefire.api.util.ScannerFilter;
  import org.apache.maven.surefire.api.util.TestsToRun;
  import org.apache.maven.surefire.common.junit4.JUnit4RunListener;
  import org.apache.maven.surefire.common.junit4.JUnitTestFailureListener;
  import org.apache.maven.surefire.common.junit4.Notifier;
  import org.apache.maven.surefire.common.junit48.FilterFactory;
  import org.apache.maven.surefire.common.junit48.JUnit48Reflector;
  import org.apache.maven.surefire.common.junit48.JUnit48TestChecker;
  import org.junit.runner.Description;
  import org.junit.runner.manipulation.Filter;
  
  import static org.apache.maven.surefire.api.report.ConsoleOutputCapture.startCapture;
  import static org.apache.maven.surefire.api.report.RunMode.NORMAL_RUN;
  import static org.apache.maven.surefire.api.report.RunMode.RERUN_TEST_AFTER_FAILURE;
  import static org.apache.maven.surefire.api.testset.TestListResolver.optionallyWildcardFilter;
  import static org.apache.maven.surefire.api.util.TestsToRun.fromClass;
  import static org.apache.maven.surefire.common.junit4.JUnit4ProviderUtil.generateFailingTestDescriptions;
  import static org.apache.maven.surefire.common.junit4.JUnit4RunListenerFactory.createCustomListeners;
  import static org.apache.maven.surefire.common.junit4.Notifier.pureNotifier;
  import static org.apache.maven.surefire.junitcore.ConcurrentRunListener.createInstance;
  
  /**
   * @author Kristian Rosenvold
   */
  @SuppressWarnings({"UnusedDeclaration"})
  public class JUnitCoreProvider extends AbstractProvider {
      private final ClassLoader testClassLoader;
  
      private final JUnitCoreParameters jUnitCoreParameters;
  
      private final ScannerFilter scannerFilter;
  
      private final String customRunListeners;
  
      private final ProviderParameters providerParameters;
  
      private final ScanResult scanResult;
  
      private final int rerunFailingTestsCount;
  
      private final JUnit48Reflector jUnit48Reflector;
  
      private final RunOrderCalculator runOrderCalculator;
  
      private final TestListResolver testResolver;
  
      private final CommandChainReader commandsReader;
  
      private TestsToRun testsToRun;
  
      public JUnitCoreProvider(ProviderParameters bootParams) {
          // don't start a thread in CommandReader while we are in in-plugin process
          commandsReader = bootParams.isInsideFork() ? bootParams.getCommandReader() : null;
          providerParameters = bootParams;
          testClassLoader = bootParams.getTestClassLoader();
          scanResult = bootParams.getScanResult();
          runOrderCalculator = bootParams.getRunOrderCalculator();
          jUnitCoreParameters = new JUnitCoreParameters(bootParams.getProviderProperties());
          scannerFilter = new JUnit48TestChecker(testClassLoader);
          testResolver = bootParams.getTestRequest().getTestListResolver();
          rerunFailingTestsCount = bootParams.getTestRequest().getRerunFailingTestsCount();
          customRunListeners = bootParams.getProviderProperties().get("listener");
          jUnit48Reflector = new JUnit48Reflector(testClassLoader);
     }
 
     @Override
     public Iterable<Class<?>> getSuites() {
         testsToRun = scanClassPath();
         return testsToRun;
     }
 
     private boolean isSingleThreaded() {
         return jUnitCoreParameters.isNoThreading();
     }
 
     @Override
     public RunResult invoke(Object forkTestSet) throws TestSetFailedException {
         ReporterFactory reporterFactory = providerParameters.getReporterFactory();
         JUnit4RunListener listener = createRunListener(reporterFactory);
         listener.setRunMode(NORMAL_RUN);
         ConsoleLogger logger = listener.getConsoleLogger();
         Notifier notifier = new Notifier(listener, getSkipAfterFailureCount());
         // startCapture() called in createRunListener() in prior to setTestsToRun()
 
         Filter filter = jUnit48Reflector.isJUnit48Available() ? createJUnit48Filter() : null;
 
         if (testsToRun == null) {
             setTestsToRun(forkTestSet);
         }
 
         // Add test failure listener
         JUnitTestFailureListener testFailureListener = new JUnitTestFailureListener();
         notifier.addListener(testFailureListener);
 
         if (isFailFast() && commandsReader != null) {
             registerPleaseStopJUnitListener(notifier);
         }
 
         final RunResult runResult;
 
         try {
             JUnitCoreWrapper core = new JUnitCoreWrapper(notifier, jUnitCoreParameters, logger);
 
             if (commandsReader != null) {
                 registerShutdownListener(testsToRun);
                 commandsReader.awaitStarted();
             }
 
             notifier.asFailFast(isFailFast());
             core.execute(testsToRun, createCustomListeners(customRunListeners), filter);
             notifier.asFailFast(false);
 
             // Rerun failing tests if rerunFailingTestsCount is larger than 0
             if (isRerunFailingTests()) {
                 listener.setRunMode(RERUN_TEST_AFTER_FAILURE);
                 Notifier rerunNotifier = pureNotifier();
                 notifier.copyListenersTo(rerunNotifier);
                 JUnitCoreWrapper rerunCore = new JUnitCoreWrapper(rerunNotifier, jUnitCoreParameters, logger);
                 for (int i = 0;
                         i < rerunFailingTestsCount
                                 && !testFailureListener.getAllFailures().isEmpty();
                         i++) {
                     Set<Description> failures = generateFailingTestDescriptions(testFailureListener.getAllFailures());
                     testFailureListener.reset();
                     FilterFactory filterFactory = new FilterFactory(testClassLoader);
                     Filter failureDescriptionFilter = filterFactory.createMatchAnyDescriptionFilter(failures);
                     rerunCore.execute(testsToRun, failureDescriptionFilter);
                 }
             }
         } finally {
             runResult = reporterFactory.close();
             notifier.removeListeners();
         }
         return runResult;
     }
 
     private void setTestsToRun(Object forkTestSet) throws TestSetFailedException {
         if (forkTestSet instanceof TestsToRun) {
             testsToRun = (TestsToRun) forkTestSet;
         } else if (forkTestSet instanceof Class) {
             Class<?> theClass = (Class<?>) forkTestSet;
             testsToRun = fromClass(theClass);
         } else {
             testsToRun = scanClassPath();
         }
     }
 
     private boolean isRerunFailingTests() {
         return rerunFailingTestsCount > 0;
     }
 
     private boolean isFailFast() {
         return providerParameters.getSkipAfterFailureCount() > 0;
     }
 
     private int getSkipAfterFailureCount() {
         return isFailFast() ? providerParameters.getSkipAfterFailureCount() : 0;
     }
 
     private void registerShutdownListener(final TestsToRun testsToRun) {
         commandsReader.addShutdownListener(new CommandListener() {
             @Override
             public void update(Command command) {
                 testsToRun.markTestSetFinished();
             }
         });
     }
 
     private void registerPleaseStopJUnitListener(final Notifier stoppable) {
         commandsReader.addSkipNextTestsListener(new CommandListener() {
             @Override
             public void update(Command command) {
                 stoppable.pleaseStop();
             }
         });
     }
 
     private JUnit4RunListener createRunListener(ReporterFactory reporterFactory) {
         final JUnit4RunListener listener;
         if (isSingleThreaded()) {
             listener = new NonConcurrentRunListener(reporterFactory.createTestReportListener());
         } else {
             Map<String, TestSet> testSetMap = new ConcurrentHashMap<>();
             boolean parallelClasses = isParallelTypes();
             boolean parallelBoth = isParallelMethodsAndTypes();
             ConcurrentRunListener concurrentListener =
                     createInstance(testSetMap, reporterFactory, parallelClasses, parallelBoth);
             listener = new JUnitCoreRunListener(concurrentListener, testSetMap);
         }
 
         startCapture(listener);
         return listener;
     }
 
     private boolean isParallelMethodsAndTypes() {
         return jUnitCoreParameters.isParallelMethods() && isParallelTypes();
     }
 
     private boolean isParallelTypes() {
         return jUnitCoreParameters.isParallelClasses() || jUnitCoreParameters.isParallelSuites();
     }
 
     private Filter createJUnit48Filter() {
         final FilterFactory factory = new FilterFactory(testClassLoader);
         Map<String, String> props = providerParameters.getProviderProperties();
         Filter groupFilter = factory.canCreateGroupFilter(props) ? factory.createGroupFilter(props) : null;
         TestListResolver methodFilter = optionallyWildcardFilter(testResolver);
         boolean onlyGroups = methodFilter.isEmpty() || methodFilter.isWildcard();
         if (onlyGroups) {
             return groupFilter;
         } else {
             Filter jUnitMethodFilter = factory.createMethodFilter(methodFilter);
             return groupFilter == null ? jUnitMethodFilter : factory.and(groupFilter, jUnitMethodFilter);
         }
     }
 
     private TestsToRun scanClassPath() {
         TestsToRun scanned = scanResult.applyFilter(scannerFilter, testClassLoader);
         return runOrderCalculator.orderTestClasses(scanned);
     }
 }