[MNG-8685] Better support for CI systems (#2254)

Improve CI detection of Maven, make possible to propagate some options from CI to Maven.

Changes:
* `InvokerRequest` carries new info: `Optional<CIInfo>`: if present, we run on CI, if empty, not.
* `Parser` (creating `InvokerRequest`) already inspects env and assembles invoker request, so make it detect CI as well
* `CIDetector` is a Java Service (this all happens early, no DI yet) that can be extended (like adding CI specific detectors). Core had one implementation that became the "generic" that is what Maven 4 had so far.
* Added "jenkins", "github", "teamcity", "circle" and "travis" support.

---

https://issues.apache.org/jira/browse/MNG-8685

Author: cstamas

api/maven-api-cli/src/main/java/org/apache/maven/api/cli/InvokerRequest.java

@@ -28,6 +28,7 @@
 import org.apache.maven.api.annotations.Experimental;
 import org.apache.maven.api.annotations.Immutable;
 import org.apache.maven.api.annotations.Nonnull;
+import org.apache.maven.api.cli.cisupport.CIInfo;
 import org.apache.maven.api.services.Lookup;
 import org.apache.maven.api.services.MessageBuilderFactory;
 
@@ -182,11 +183,28 @@ default Optional<OutputStream> stdErr() {
     @Nonnull
     Optional<List<CoreExtensions>> coreExtensions();
 
+    /**
+     * Returns detected CI system, if any.
+     *
+     * @return an {@link Optional} containing the {@link CIInfo} collected from CI system. or empty if CI not
+     * detected.
+     */
+    @Nonnull
+    Optional<CIInfo> ciInfo();
+
     /**
      * Returns the options associated with this invocation request.
      *
      * @return the options object
      */
     @Nonnull
     Options options();
+
+    /**
+     * This method returns "verbose" option value derived from multiple places: CLI options, but also CI detection,
+     * if applicable.
+     */
+    default boolean effectiveVerbose() {
+        return options().verbose().orElse(ciInfo().isPresent() && ciInfo().get().isVerbose());
+    }
 }

api/maven-api-cli/src/main/java/org/apache/maven/api/cli/cisupport/CIInfo.java

@@ -0,0 +1,49 @@
+/*
+ * 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.api.cli.cisupport;
+
+import org.apache.maven.api.annotations.Nonnull;
+
+/**
+ * CI support: this class contains gathered information and more from CI that Maven process runs on.
+ *
+ * @since 4.0.0
+ */
+public interface CIInfo {
+    /**
+     * Short distinct name of CI system: "GH", "Jenkins", etc.
+     */
+    @Nonnull
+    String name();
+
+    /**
+     * May return a message that will be logged by Maven explaining why it was detected (and possibly more).
+     */
+    @Nonnull
+    default String message() {
+        return "";
+    }
+
+    /**
+     * Some CI systems may allow running jobs in "debug" (or some equivalent) mode.
+     */
+    default boolean isVerbose() {
+        return false;
+    }
+}

impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/BaseInvokerRequest.java

@@ -28,6 +28,7 @@
 import org.apache.maven.api.cli.CoreExtensions;
 import org.apache.maven.api.cli.InvokerRequest;
 import org.apache.maven.api.cli.ParserRequest;
+import org.apache.maven.api.cli.cisupport.CIInfo;
 
 import static java.util.Objects.requireNonNull;
 
@@ -42,6 +43,7 @@ public abstract class BaseInvokerRequest implements InvokerRequest {
     private final Path topDirectory;
     private final Path rootDirectory;
     private final List<CoreExtensions> coreExtensions;
+    private final CIInfo ciInfo;
 
     @SuppressWarnings("ParameterNumber")
     public BaseInvokerRequest(
@@ -54,7 +56,8 @@ public BaseInvokerRequest(
             @Nonnull Map<String, String> systemProperties,
             @Nonnull Path topDirectory,
             @Nullable Path rootDirectory,
-            @Nullable List<CoreExtensions> coreExtensions) {
+            @Nullable List<CoreExtensions> coreExtensions,
+            @Nullable CIInfo ciInfo) {
         this.parserRequest = requireNonNull(parserRequest);
         this.parsingFailed = parsingFailed;
         this.cwd = requireNonNull(cwd);
@@ -66,6 +69,7 @@ public BaseInvokerRequest(
         this.topDirectory = requireNonNull(topDirectory);
         this.rootDirectory = rootDirectory;
         this.coreExtensions = coreExtensions;
+        this.ciInfo = ciInfo;
     }
 
     @Override
@@ -117,4 +121,9 @@ public Optional<Path> rootDirectory() {
     public Optional<List<CoreExtensions>> coreExtensions() {
         return Optional.ofNullable(coreExtensions);
     }
+
+    @Override
+    public Optional<CIInfo> ciInfo() {
+        return Optional.ofNullable(ciInfo);
+    }
 }

impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/BaseParser.java

@@ -43,11 +43,13 @@
 import org.apache.maven.api.cli.Options;
 import org.apache.maven.api.cli.Parser;
 import org.apache.maven.api.cli.ParserRequest;
+import org.apache.maven.api.cli.cisupport.CIInfo;
 import org.apache.maven.api.cli.extensions.CoreExtension;
 import org.apache.maven.api.cli.extensions.InputLocation;
 import org.apache.maven.api.cli.extensions.InputSource;
 import org.apache.maven.api.services.Interpolator;
 import org.apache.maven.cling.internal.extension.io.CoreExtensionsStaxReader;
+import org.apache.maven.cling.invoker.cisupport.CIDetectorHelper;
 import org.apache.maven.cling.props.MavenPropertiesLoader;
 import org.apache.maven.cling.utils.CLIReportingUtils;
 import org.apache.maven.properties.internal.EnvironmentUtils;
@@ -86,6 +88,9 @@ public LocalContext(ParserRequest parserRequest) {
         @Nullable
         public List<CoreExtensions> extensions;
 
+        @Nullable
+        public CIInfo ciInfo;
+
         public Options options;
 
         public Map<String, String> extraInterpolationSource() {
@@ -190,6 +195,9 @@ public InvokerRequest parseInvocation(ParserRequest parserRequest) {
             parserRequest.logger().error("Error reading core extensions descriptor", e);
         }
 
+        // CI detection
+        context.ciInfo = detectCI(context);
+
         // only if not failed so far; otherwise we may have no options to validate
         if (!context.parsingFailed) {
             validate(context);
@@ -500,4 +508,19 @@ protected List<CoreExtension> validateCoreExtensionsDescriptorFromFile(
                                         .collect(Collectors.joining(", ")))
                         .collect(Collectors.joining("; ")));
     }
+
+    @Nullable
+    protected CIInfo detectCI(LocalContext context) {
+        List<CIInfo> detected = CIDetectorHelper.detectCI();
+        if (detected.isEmpty()) {
+            return null;
+        } else if (detected.size() > 1) {
+            // warn
+            context.parserRequest
+                    .logger()
+                    .warn("Multiple CI systems detected: "
+                            + detected.stream().map(CIInfo::name).collect(Collectors.joining(", ")));
+        }
+        return detected.get(0);
+    }
 }

impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/LookupInvoker.java

@@ -46,6 +46,7 @@
 import org.apache.maven.api.cli.InvokerRequest;
 import org.apache.maven.api.cli.Logger;
 import org.apache.maven.api.cli.Options;
+import org.apache.maven.api.cli.cisupport.CIInfo;
 import org.apache.maven.api.cli.logging.AccumulatingLogger;
 import org.apache.maven.api.services.BuilderProblem;
 import org.apache.maven.api.services.Interpolator;
@@ -278,7 +279,7 @@ protected void configureLogging(C context) throws Exception {
         context.slf4jConfiguration = Slf4jConfigurationFactory.getConfiguration(context.loggerFactory);
 
         context.loggerLevel = Slf4jConfiguration.Level.INFO;
-        if (mavenOptions.verbose().orElse(false)) {
+        if (context.invokerRequest.effectiveVerbose()) {
             context.loggerLevel = Slf4jConfiguration.Level.DEBUG;
         } else if (mavenOptions.quiet().orElse(false)) {
             context.loggerLevel = Slf4jConfiguration.Level.ERROR;
@@ -465,7 +466,7 @@ protected void showVersion(C context) {
         InvokerRequest invokerRequest = context.invokerRequest;
         if (invokerRequest.options().quiet().orElse(false)) {
             writer.accept(CLIReportingUtils.showVersionMinimal());
-        } else if (invokerRequest.options().verbose().orElse(false)) {
+        } else if (invokerRequest.effectiveVerbose()) {
             writer.accept(CLIReportingUtils.showVersion(
                     ProcessHandle.current().info().commandLine().orElse(null), describe(context.terminal)));
 
@@ -493,9 +494,8 @@ protected String describe(Terminal terminal) {
     }
 
     protected void preCommands(C context) throws Exception {
-        Options mavenOptions = context.invokerRequest.options();
-        boolean verbose = mavenOptions.verbose().orElse(false);
-        boolean version = mavenOptions.showVersion().orElse(false);
+        boolean verbose = context.invokerRequest.effectiveVerbose();
+        boolean version = context.invokerRequest.options().showVersion().orElse(false);
         if (verbose || version) {
             showVersion(context);
         }
@@ -726,11 +726,11 @@ protected boolean mayDisableInteractiveMode(C context, boolean proposedInteracti
             if (context.invokerRequest.options().nonInteractive().orElse(false)) {
                 return false;
             } else {
-                boolean runningOnCI = isRunningOnCI(context);
-                if (runningOnCI) {
+                if (context.invokerRequest.ciInfo().isPresent()) {
+                    CIInfo ci = context.invokerRequest.ciInfo().get();
                     context.logger.info(
-                            "Making this build non-interactive, because the environment variable CI equals \"true\"."
-                                    + " Disable this detection by removing that variable or adding --force-interactive.");
+                            "Making this build non-interactive, because CI detected. Disable this detection by adding --force-interactive.");
+                    context.logger.info("Detected CI system: '" + ci.name() + "': " + ci.message());
                     return false;
                 }
             }
@@ -935,10 +935,5 @@ protected int calculateDegreeOfConcurrency(String threadConfiguration) {
         }
     }
 
-    protected boolean isRunningOnCI(C context) {
-        String ciEnv = context.protoSession.getSystemProperties().get("env.CI");
-        return ciEnv != null && !"false".equals(ciEnv);
-    }
-
     protected abstract int execute(C context) throws Exception;
 }

impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/cisupport/CIDetector.java

@@ -0,0 +1,35 @@
+/*
+ * 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.cling.invoker.cisupport;
+
+import java.util.Optional;
+
+import org.apache.maven.api.cli.cisupport.CIInfo;
+
+/**
+ * Service interface to detect CI system process runs on, if any.
+ *
+ * @since 4.0.0
+ */
+public interface CIDetector {
+    /**
+     * Returns non-empty optional with CI information, if CI is detected, empty otherwise.
+     */
+    Optional<CIInfo> detectCI();
+}

impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/cisupport/CIDetectorHelper.java

@@ -0,0 +1,50 @@
+/*
+ * 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.cling.invoker.cisupport;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+import java.util.ServiceLoader;
+import java.util.stream.Collectors;
+
+import org.apache.maven.api.cli.cisupport.CIInfo;
+
+/**
+ * CI detector helper: it uses service discovery to discover {@link CIDetector}s. If resulting list has more than
+ * one element, it will remove the {@link GenericCIDetector} result, assuming a more specific one is also present.
+ */
+public final class CIDetectorHelper {
+    private CIDetectorHelper() {}
+
+    public static List<CIInfo> detectCI() {
+        ArrayList<CIInfo> result = ServiceLoader.load(CIDetector.class).stream()
+                .map(ServiceLoader.Provider::get)
+                .map(CIDetector::detectCI)
+                .filter(Optional::isPresent)
+                .map(Optional::get)
+                .collect(Collectors.toCollection(ArrayList::new));
+
+        if (result.size() > 1) {
+            // remove generic
+            result.removeIf(c -> GenericCIDetector.NAME.equals(c.name()));
+        }
+        return result;
+    }
+}

impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/cisupport/CircleCIDetector.java

@@ -0,0 +1,46 @@
+/*
+ * 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.cling.invoker.cisupport;
+
+import java.util.Optional;
+
+import org.apache.maven.api.cli.cisupport.CIInfo;
+
+/**
+ * Circle CI support.
+ */
+public class CircleCIDetector implements CIDetector {
+    public static final String NAME = "CircleCI";
+
+    private static final String CIRCLECI = "CIRCLECI";
+
+    @Override
+    public Optional<CIInfo> detectCI() {
+        String ciEnv = System.getenv(CIRCLECI);
+        if ("true".equals(ciEnv)) {
+            return Optional.of(new CIInfo() {
+                @Override
+                public String name() {
+                    return NAME;
+                }
+            });
+        }
+        return Optional.empty();
+    }
+}