From 6a1e0f0b23727be2bfb996c769155b54db266ce5 Mon Sep 17 00:00:00 2001 From: "Piotr P. Karwasz" Date: Mon, 1 Apr 2024 14:48:45 +0200 Subject: [PATCH 1/2] Remove CLI tools from `log4j-core` and `log4j-1.2-api` We remove the command line tools to generate logger wrappers and convert Log4j 1.x configuration. The tools have been submitted to Log4j Transform: * apache/logging-log4j-transform#92 * apache/logging-log4j-transform#93 and are not necessary at runtime. The `Log4j1ConfigurationFactory` that has been removed from `log4j-1.2-api` is an **older** and deprecated version of the `PropertiesConfigurationFactory`. --- .../log4j/config/InputStreamWrapper.java | 91 - .../config/Log4j1ConfigurationConverter.java | 249 - .../config/Log4j1ConfigurationFactory.java | 57 - .../config/Log4j1ConfigurationParser.java | 474 -- ...tractLog4j1ConfigurationConverterTest.java | 86 - ...og4j1ConfigurationConverterHadoopTest.java | 36 - ...Log4j1ConfigurationConverterSparkTest.java | 36 - .../Log4j1ConfigurationFactoryTest.java | 191 - .../src/main/resources/log4j.properties | 23 - .../src/main/conf/log4j.properties | 324 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 30 - .../src/main/resources/log4j.properties | 30 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 50 - .../src/test/resources/log4j.properties | 51 - .../src/test/resources/log4j.properties | 50 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 29 - .../src/test/resources/log4j.properties | 26 - .../src/test/resources/log4j.properties | 28 - .../src/main/sample-conf/log4j.properties | 23 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 64 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 24 - .../src/test/resources/log4j.properties | 24 - .../config-1.2/spark/R/log4j.properties | 28 - .../src/test/resources/log4j.properties | 27 - .../src/test/resources/log4j.properties | 24 - .../core/src/test/resources/log4j.properties | 36 - .../src/test/resources/log4j.properties | 27 - .../flume/src/test/resources/log4j.properties | 27 - .../src/test/resources/log4j.properties | 27 - .../src/test/resources/log4j.properties | 27 - .../src/test/resources/log4j.properties | 27 - .../src/main/resources/log4j.properties | 37 - .../src/test/resources/log4j.properties | 27 - .../src/test/resources/log4j.properties | 27 - .../src/test/resources/log4j.properties | 33 - .../mllib/src/test/resources/log4j.properties | 27 - .../repl/src/test/resources/log4j.properties | 27 - .../src/test/resources/log4j.properties | 27 - .../core/src/test/resources/log4j.properties | 57 - .../hive/src/test/resources/log4j.properties | 61 - .../src/test/resources/log4j.properties | 27 - .../yarn/src/test/resources/log4j.properties | 31 - .../core/tools/GenerateCustomLoggerTest.java | 181 - .../tools/GenerateExtendedLoggerTest.java | 200 - .../core/tools/BasicCommandLineArguments.java | 36 - .../core/tools/CustomLoggerGenerator.java | 30 - .../core/tools/ExtendedLoggerGenerator.java | 30 - .../logging/log4j/core/tools/Generate.java | 1165 ---- .../log4j/core/tools/package-info.java | 25 - .../log4j/core/tools/picocli/CommandLine.java | 5619 ----------------- src/changelog/.3.x.x/remove_cli_tools.xml | 10 + 67 files changed, 10 insertions(+), 10297 deletions(-) delete mode 100644 log4j-1.2-api/src/main/java/org/apache/log4j/config/InputStreamWrapper.java delete mode 100644 log4j-1.2-api/src/main/java/org/apache/log4j/config/Log4j1ConfigurationConverter.java delete mode 100644 log4j-1.2-api/src/main/java/org/apache/log4j/config/Log4j1ConfigurationFactory.java delete mode 100644 log4j-1.2-api/src/main/java/org/apache/log4j/config/Log4j1ConfigurationParser.java delete mode 100644 log4j-1.2-api/src/test/java/org/apache/log4j/config/AbstractLog4j1ConfigurationConverterTest.java delete mode 100644 log4j-1.2-api/src/test/java/org/apache/log4j/config/Log4j1ConfigurationConverterHadoopTest.java delete mode 100644 log4j-1.2-api/src/test/java/org/apache/log4j/config/Log4j1ConfigurationConverterSparkTest.java delete mode 100644 log4j-1.2-api/src/test/java/org/apache/log4j/config/Log4j1ConfigurationFactoryTest.java delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-auth-examples/src/main/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-common/src/main/conf/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-common/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-kms/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-minikdc/src/main/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-nfs/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-hdfs-project/hadoop-hdfs-client/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-hdfs-project/hadoop-hdfs/src/contrib/bkjournal/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-hdfs-project/hadoop-hdfs/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-app/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-common/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-hs/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-jobclient/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-nativetask/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-shuffle/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-aws/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-azure/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-openstack/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-sls/src/main/sample-conf/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-distributedshell/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-unmanaged-am-launcher/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-tests/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-timelineservice-hbase-tests/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-timelineservice/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/R/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/common/network-common/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/common/network-shuffle/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/core/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/external/flume-sink/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/external/flume/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/external/java8-tests/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/external/kafka-0-10/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/external/kafka-0-8/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/external/kinesis-asl/src/main/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/external/kinesis-asl/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/graphx/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/launcher/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/mllib/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/repl/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/sql/catalyst/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/sql/core/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/sql/hive/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/streaming/src/test/resources/log4j.properties delete mode 100644 log4j-1.2-api/src/test/resources/config-1.2/spark/yarn/src/test/resources/log4j.properties delete mode 100644 log4j-core-test/src/test/java/org/apache/logging/log4j/core/tools/GenerateCustomLoggerTest.java delete mode 100644 log4j-core-test/src/test/java/org/apache/logging/log4j/core/tools/GenerateExtendedLoggerTest.java delete mode 100644 log4j-core/src/main/java/org/apache/logging/log4j/core/tools/BasicCommandLineArguments.java delete mode 100644 log4j-core/src/main/java/org/apache/logging/log4j/core/tools/CustomLoggerGenerator.java delete mode 100644 log4j-core/src/main/java/org/apache/logging/log4j/core/tools/ExtendedLoggerGenerator.java delete mode 100644 log4j-core/src/main/java/org/apache/logging/log4j/core/tools/Generate.java delete mode 100644 log4j-core/src/main/java/org/apache/logging/log4j/core/tools/package-info.java delete mode 100644 log4j-core/src/main/java/org/apache/logging/log4j/core/tools/picocli/CommandLine.java create mode 100644 src/changelog/.3.x.x/remove_cli_tools.xml diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/config/InputStreamWrapper.java b/log4j-1.2-api/src/main/java/org/apache/log4j/config/InputStreamWrapper.java deleted file mode 100644 index 49eaea9187c..00000000000 --- a/log4j-1.2-api/src/main/java/org/apache/log4j/config/InputStreamWrapper.java +++ /dev/null @@ -1,91 +0,0 @@ -/* - * 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.log4j.config; - -import java.io.IOException; -import java.io.InputStream; - -class InputStreamWrapper extends InputStream { - - private final String description; - private final InputStream input; - - public InputStreamWrapper(final InputStream input, final String description) { - this.input = input; - this.description = description; - } - - @Override - public int available() throws IOException { - return input.available(); - } - - @Override - public void close() throws IOException { - input.close(); - } - - @Override - public boolean equals(final Object obj) { - return input.equals(obj); - } - - @Override - public int hashCode() { - return input.hashCode(); - } - - @Override - public synchronized void mark(final int readlimit) { - input.mark(readlimit); - } - - @Override - public boolean markSupported() { - return input.markSupported(); - } - - @Override - public int read() throws IOException { - return input.read(); - } - - @Override - public int read(final byte[] b) throws IOException { - return input.read(b); - } - - @Override - public int read(final byte[] b, final int off, final int len) throws IOException { - return input.read(b, off, len); - } - - @Override - public synchronized void reset() throws IOException { - input.reset(); - } - - @Override - public long skip(final long n) throws IOException { - return input.skip(n); - } - - @Override - public String toString() { - return getClass().getSimpleName() + " [description=" + description + ", input=" + input + "]"; - } -} diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/config/Log4j1ConfigurationConverter.java b/log4j-1.2-api/src/main/java/org/apache/log4j/config/Log4j1ConfigurationConverter.java deleted file mode 100644 index c0f8e73fcb7..00000000000 --- a/log4j-1.2-api/src/main/java/org/apache/log4j/config/Log4j1ConfigurationConverter.java +++ /dev/null @@ -1,249 +0,0 @@ -/* - * 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.log4j.config; - -import java.io.ByteArrayInputStream; -import java.io.ByteArrayOutputStream; -import java.io.IOException; -import java.io.InputStream; -import java.io.OutputStream; -import java.nio.file.FileVisitResult; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.SimpleFileVisitor; -import java.nio.file.attribute.BasicFileAttributes; -import java.util.concurrent.atomic.AtomicInteger; -import javax.xml.transform.TransformerException; -import javax.xml.transform.stream.StreamResult; -import javax.xml.transform.stream.StreamSource; -import org.apache.logging.log4j.core.config.ConfigurationException; -import org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder; -import org.apache.logging.log4j.core.config.builder.impl.BuiltConfiguration; -import org.apache.logging.log4j.core.config.builder.impl.DefaultConfigurationBuilder; -import org.apache.logging.log4j.core.tools.BasicCommandLineArguments; -import org.apache.logging.log4j.core.tools.picocli.CommandLine; -import org.apache.logging.log4j.core.tools.picocli.CommandLine.Command; -import org.apache.logging.log4j.core.tools.picocli.CommandLine.Option; - -/** - * Tool for converting a Log4j 1.x properties configuration file to Log4j 2.x XML configuration file. - * - *

- * Run with "--help" on the command line. - *

- * - *

- * Example: - *

- * - * 
- * java org.apache.log4j.config.Log4j1ConfigurationConverter --recurse
- * E:\vcs\git\apache\logging\logging-log4j2\log4j-1.2-api\src\test\resources\config-1.2\hadoop --in log4j.properties --verbose
- *
- */ -public final class Log4j1ConfigurationConverter { - - @Command(name = "Log4j1ConfigurationConverter") - public static class CommandLineArguments extends BasicCommandLineArguments implements Runnable { - - @Option( - names = {"--failfast", "-f"}, - description = "Fails on the first failure in recurse mode.") - private boolean failFast; - - @Option( - names = {"--in", "-i"}, - description = "Specifies the input file.") - private Path pathIn; - - @Option( - names = {"--out", "-o"}, - description = "Specifies the output file.") - private Path pathOut; - - @Option( - names = {"--recurse", "-r"}, - description = "Recurses into this folder looking for the input file") - private Path recurseIntoPath; - - @Option( - names = {"--verbose", "-v"}, - description = "Be verbose.") - private boolean verbose; - - public Path getPathIn() { - return pathIn; - } - - public Path getPathOut() { - return pathOut; - } - - public Path getRecurseIntoPath() { - return recurseIntoPath; - } - - public boolean isFailFast() { - return failFast; - } - - public boolean isVerbose() { - return verbose; - } - - public void setFailFast(final boolean failFast) { - this.failFast = failFast; - } - - public void setPathIn(final Path pathIn) { - this.pathIn = pathIn; - } - - public void setPathOut(final Path pathOut) { - this.pathOut = pathOut; - } - - public void setRecurseIntoPath(final Path recurseIntoPath) { - this.recurseIntoPath = recurseIntoPath; - } - - public void setVerbose(final boolean verbose) { - this.verbose = verbose; - } - - @Override - public void run() { - if (isHelp()) { - CommandLine.usage(this, System.err); - return; - } - new Log4j1ConfigurationConverter(this).run(); - } - - @Override - public String toString() { - return "CommandLineArguments [recurseIntoPath=" + recurseIntoPath + ", verbose=" + verbose + ", pathIn=" - + pathIn + ", pathOut=" + pathOut + "]"; - } - } - - private static final String FILE_EXT_XML = ".xml"; - - public static void main(final String[] args) { - CommandLine.run(new CommandLineArguments(), System.err, args); - } - - public static Log4j1ConfigurationConverter run(final CommandLineArguments cla) { - final Log4j1ConfigurationConverter log4j1ConfigurationConverter = new Log4j1ConfigurationConverter(cla); - log4j1ConfigurationConverter.run(); - return log4j1ConfigurationConverter; - } - - private final CommandLineArguments cla; - - private Log4j1ConfigurationConverter(final CommandLineArguments cla) { - this.cla = cla; - } - - protected void convert(final InputStream input, final OutputStream output) throws IOException { - final ConfigurationBuilder builder = - new Log4j1ConfigurationParser().buildConfigurationBuilder(input); - builder.writeXmlConfiguration(output); - } - - InputStream getInputStream() throws IOException { - final Path pathIn = cla.getPathIn(); - return pathIn == null ? System.in : new InputStreamWrapper(Files.newInputStream(pathIn), pathIn.toString()); - } - - OutputStream getOutputStream() throws IOException { - final Path pathOut = cla.getPathOut(); - return pathOut == null ? System.out : Files.newOutputStream(pathOut); - } - - private void run() { - if (cla.getRecurseIntoPath() != null) { - final AtomicInteger countOKs = new AtomicInteger(); - final AtomicInteger countFails = new AtomicInteger(); - try { - Files.walkFileTree(cla.getRecurseIntoPath(), new SimpleFileVisitor() { - @Override - public FileVisitResult visitFile(final Path file, final BasicFileAttributes attrs) - throws IOException { - if (cla.getPathIn() == null || file.getFileName().equals(cla.getPathIn())) { - verbose("Reading %s", file); - String newFile = file.getFileName().toString(); - final int lastIndex = newFile.lastIndexOf("."); - newFile = lastIndex < 0 - ? newFile + FILE_EXT_XML - : newFile.substring(0, lastIndex) + FILE_EXT_XML; - final Path resolvedPath = file.resolveSibling(newFile); - try (final InputStream input = - new InputStreamWrapper(Files.newInputStream(file), file.toString()); - final OutputStream output = Files.newOutputStream(resolvedPath)) { - try { - final ByteArrayOutputStream tmpOutput = new ByteArrayOutputStream(); - convert(input, tmpOutput); - tmpOutput.close(); - DefaultConfigurationBuilder.formatXml( - new StreamSource(new ByteArrayInputStream(tmpOutput.toByteArray())), - new StreamResult(output)); - countOKs.incrementAndGet(); - } catch (ConfigurationException | IOException e) { - countFails.incrementAndGet(); - if (cla.isFailFast()) { - throw e; - } - e.printStackTrace(); - } catch (TransformerException e) { - countFails.incrementAndGet(); - if (cla.isFailFast()) { - throw new IOException(e); - } - e.printStackTrace(); - } - verbose("Wrote %s", resolvedPath); - } - } - return FileVisitResult.CONTINUE; - } - }); - } catch (final IOException e) { - throw new ConfigurationException(e); - } finally { - verbose( - "OK = %,d, Failures = %,d, Total = %,d", - countOKs.get(), countFails.get(), countOKs.get() + countFails.get()); - } - } else { - verbose("Reading %s", cla.getPathIn()); - try (final InputStream input = getInputStream(); - final OutputStream output = getOutputStream()) { - convert(input, output); - } catch (final IOException e) { - throw new ConfigurationException(e); - } - verbose("Wrote %s", cla.getPathOut()); - } - } - - private void verbose(final String template, final Object... args) { - if (cla.isVerbose()) { - System.err.println(String.format(template, args)); - } - } -} diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/config/Log4j1ConfigurationFactory.java b/log4j-1.2-api/src/main/java/org/apache/log4j/config/Log4j1ConfigurationFactory.java deleted file mode 100644 index 5454ad7c0b5..00000000000 --- a/log4j-1.2-api/src/main/java/org/apache/log4j/config/Log4j1ConfigurationFactory.java +++ /dev/null @@ -1,57 +0,0 @@ -/* - * 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.log4j.config; - -import java.io.IOException; -import java.io.InputStream; -import org.apache.logging.log4j.core.LoggerContext; -import org.apache.logging.log4j.core.config.Configuration; -import org.apache.logging.log4j.core.config.ConfigurationException; -import org.apache.logging.log4j.core.config.ConfigurationFactory; -import org.apache.logging.log4j.core.config.ConfigurationSource; -import org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder; -import org.apache.logging.log4j.core.config.builder.impl.BuiltConfiguration; - -/** - * Experimental ConfigurationFactory for Log4j 1.2 properties configuration files. - */ -// TODO -// @Category(ConfigurationFactory.CATEGORY) -// @Plugin("Log4j1ConfigurationFactory") -// -// Best Value? -// @Order(50) -public class Log4j1ConfigurationFactory extends ConfigurationFactory { - - private static final String[] SUFFIXES = {".properties"}; - - @Override - public Configuration getConfiguration(final LoggerContext loggerContext, final ConfigurationSource source) { - final ConfigurationBuilder builder; - try (final InputStream configStream = source.getInputStream()) { - builder = new Log4j1ConfigurationParser().buildConfigurationBuilder(configStream); - } catch (final IOException e) { - throw new ConfigurationException("Unable to load " + source, e); - } - return builder.build(); - } - - @Override - protected String[] getSupportedTypes() { - return SUFFIXES; - } -} diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/config/Log4j1ConfigurationParser.java b/log4j-1.2-api/src/main/java/org/apache/log4j/config/Log4j1ConfigurationParser.java deleted file mode 100644 index 4e8ea68650c..00000000000 --- a/log4j-1.2-api/src/main/java/org/apache/log4j/config/Log4j1ConfigurationParser.java +++ /dev/null @@ -1,474 +0,0 @@ -/* - * 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.log4j.config; - -import java.io.IOException; -import java.io.InputStream; -import java.util.Arrays; -import java.util.HashMap; -import java.util.Map; -import java.util.Objects; -import java.util.Properties; -import java.util.TreeMap; -import org.apache.log4j.helpers.OptionConverter; -import org.apache.logging.log4j.Level; -import org.apache.logging.log4j.core.Filter.Result; -import org.apache.logging.log4j.core.appender.ConsoleAppender; -import org.apache.logging.log4j.core.appender.FileAppender; -import org.apache.logging.log4j.core.appender.NullAppender; -import org.apache.logging.log4j.core.appender.RollingFileAppender; -import org.apache.logging.log4j.core.config.ConfigurationException; -import org.apache.logging.log4j.core.config.builder.api.AppenderComponentBuilder; -import org.apache.logging.log4j.core.config.builder.api.ComponentBuilder; -import org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder; -import org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilderFactory; -import org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder; -import org.apache.logging.log4j.core.config.builder.api.LoggerComponentBuilder; -import org.apache.logging.log4j.core.config.builder.api.RootLoggerComponentBuilder; -import org.apache.logging.log4j.core.config.builder.impl.BuiltConfiguration; -import org.apache.logging.log4j.status.StatusLogger; -import org.apache.logging.log4j.util.Strings; - -/** - * Experimental parser for Log4j 1.2 properties configuration files. - * - * This class is not thread-safe. - * - *

- * From the Log4j 1.2 Javadocs: - *

- *

- * All option values admit variable substitution. The syntax of variable substitution is similar to that of Unix shells. The string between - * an opening "${" and closing "}" is interpreted as a key. The value of the substituted variable can be defined as a system property or in - * the configuration file itself. The value of the key is first searched in the system properties, and if not found there, it is then - * searched in the configuration file being parsed. The corresponding value replaces the ${variableName} sequence. For example, if java.home - * system property is set to /home/xyz, then every occurrence of the sequence ${java.home} will be interpreted as /home/xyz. - *

- */ -public class Log4j1ConfigurationParser { - - private static final String COMMA_DELIMITED_RE = "\\s*,\\s*"; - private static final String ROOTLOGGER = "rootLogger"; - private static final String ROOTCATEGORY = "rootCategory"; - private static final String TRUE = "true"; - private static final String FALSE = "false"; - private static final String RELATIVE = "RELATIVE"; - private static final String NULL = "NULL"; - - private final Properties properties = new Properties(); - - private final ConfigurationBuilder builder = - ConfigurationBuilderFactory.newConfigurationBuilder(); - - /** - * Parses a Log4j 1.2 properties configuration file in ISO 8859-1 encoding into a ConfigurationBuilder. - * - * @param input - * InputStream to read from is assumed to be ISO 8859-1, and will not be closed. - * @return the populated ConfigurationBuilder, never {@code null} - * @throws IOException - * if unable to read the input - * @throws ConfigurationException - * if the input does not contain a valid configuration - */ - public ConfigurationBuilder buildConfigurationBuilder(final InputStream input) - throws IOException { - try { - properties.load(input); - final String rootCategoryValue = getLog4jValue(ROOTCATEGORY); - final String rootLoggerValue = getLog4jValue(ROOTLOGGER); - if (rootCategoryValue == null && rootLoggerValue == null) { - // This is not a Log4j 1 properties configuration file. - warn("Missing " + ROOTCATEGORY + " or " + ROOTLOGGER + " in " + input); - // throw new ConfigurationException( - // "Missing " + ROOTCATEGORY + " or " + ROOTLOGGER + " in " + input); - } - builder.setConfigurationName("Log4j1"); - // DEBUG - final String debugValue = getLog4jValue("debug"); - if (Boolean.parseBoolean(debugValue)) { - builder.setStatusLevel(Level.DEBUG); - } - // global threshold - final String threshold = OptionConverter.findAndSubst(PropertiesConfiguration.THRESHOLD_KEY, properties); - if (threshold != null) { - final Level level = OptionConverter.convertLevel(threshold.trim(), Level.ALL); - builder.add(builder.newFilter("ThresholdFilter", Result.NEUTRAL, Result.DENY) - .addAttribute("level", level)); - } - // Root - buildRootLogger(getLog4jValue(ROOTCATEGORY)); - buildRootLogger(getLog4jValue(ROOTLOGGER)); - // Appenders - final Map appenderNameToClassName = buildClassToPropertyPrefixMap(); - for (final Map.Entry entry : appenderNameToClassName.entrySet()) { - final String appenderName = entry.getKey(); - final String appenderClass = entry.getValue(); - buildAppender(appenderName, appenderClass); - } - // Loggers - buildLoggers("log4j.category."); - buildLoggers("log4j.logger."); - buildProperties(); - return builder; - } catch (final IllegalArgumentException e) { - throw new ConfigurationException(e); - } - } - - private void buildProperties() { - for (final Map.Entry entry : new TreeMap<>(properties).entrySet()) { - final String key = entry.getKey().toString(); - if (!key.startsWith("log4j.") && !key.equals(ROOTCATEGORY) && !key.equals(ROOTLOGGER)) { - builder.addProperty(key, Objects.toString(entry.getValue(), Strings.EMPTY)); - } - } - } - - private void warn(final String string) { - System.err.println(string); - } - - private Map buildClassToPropertyPrefixMap() { - final String prefix = "log4j.appender."; - final int preLength = prefix.length(); - final Map map = new HashMap<>(); - for (final Map.Entry entry : properties.entrySet()) { - final Object keyObj = entry.getKey(); - if (keyObj != null) { - final String key = keyObj.toString().trim(); - if (key.startsWith(prefix)) { - if (key.indexOf('.', preLength) < 0) { - final String name = key.substring(preLength); - final Object value = entry.getValue(); - if (value != null) { - map.put(name, value.toString().trim()); - } - } - } - } - } - return map; - } - - private void buildAppender(final String appenderName, final String appenderClass) { - switch (appenderClass) { - case "org.apache.log4j.ConsoleAppender": - buildConsoleAppender(appenderName); - break; - case "org.apache.log4j.FileAppender": - buildFileAppender(appenderName); - break; - case "org.apache.log4j.DailyRollingFileAppender": - buildDailyRollingFileAppender(appenderName); - break; - case "org.apache.log4j.RollingFileAppender": - buildRollingFileAppender(appenderName); - break; - case "org.apache.log4j.varia.NullAppender": - buildNullAppender(appenderName); - break; - default: - reportWarning("Unknown appender class: " + appenderClass + "; ignoring appender: " + appenderName); - } - } - - private void buildConsoleAppender(final String appenderName) { - final AppenderComponentBuilder appenderBuilder = builder.newAppender(appenderName, ConsoleAppender.PLUGIN_NAME); - final String targetValue = getLog4jAppenderValue(appenderName, "Target", "System.out"); - if (targetValue != null) { - final ConsoleAppender.Target target; - switch (targetValue) { - case "System.out": - target = ConsoleAppender.Target.SYSTEM_OUT; - break; - case "System.err": - target = ConsoleAppender.Target.SYSTEM_ERR; - break; - default: - reportWarning("Unknown value for console Target: " + targetValue); - target = null; - } - if (target != null) { - appenderBuilder.addAttribute("target", target); - } - } - buildAttribute(appenderName, appenderBuilder, "Follow", "follow"); - if (FALSE.equalsIgnoreCase(getLog4jAppenderValue(appenderName, "ImmediateFlush"))) { - reportWarning("ImmediateFlush=false is not supported on Console appender"); - } - buildAppenderLayout(appenderName, appenderBuilder); - builder.add(appenderBuilder); - } - - private void buildFileAppender(final String appenderName) { - final AppenderComponentBuilder appenderBuilder = builder.newAppender(appenderName, FileAppender.PLUGIN_NAME); - buildFileAppender(appenderName, appenderBuilder); - builder.add(appenderBuilder); - } - - private void buildFileAppender(final String appenderName, final AppenderComponentBuilder appenderBuilder) { - buildMandatoryAttribute(appenderName, appenderBuilder, "File", "fileName"); - buildAttribute(appenderName, appenderBuilder, "Append", "append"); - buildAttribute(appenderName, appenderBuilder, "BufferedIO", "bufferedIo"); - buildAttribute(appenderName, appenderBuilder, "BufferSize", "bufferSize"); - buildAttribute(appenderName, appenderBuilder, "ImmediateFlush", "immediateFlush"); - buildAppenderLayout(appenderName, appenderBuilder); - } - - private void buildDailyRollingFileAppender(final String appenderName) { - final AppenderComponentBuilder appenderBuilder = - builder.newAppender(appenderName, RollingFileAppender.PLUGIN_NAME); - buildFileAppender(appenderName, appenderBuilder); - final String fileName = getLog4jAppenderValue(appenderName, "File"); - final String datePattern = getLog4jAppenderValue(appenderName, "DatePattern", ".yyyy-MM-dd"); - appenderBuilder.addAttribute("filePattern", fileName + "%d{" + datePattern + "}"); - final ComponentBuilder triggeringPolicy = builder.newComponent("Policies") - .addComponent(builder.newComponent("TimeBasedTriggeringPolicy").addAttribute("modulate", true)); - appenderBuilder.addComponent(triggeringPolicy); - appenderBuilder.addComponent(builder.newComponent("DefaultRolloverStrategy") - .addAttribute("max", Integer.MAX_VALUE) - .addAttribute("fileIndex", "min")); - builder.add(appenderBuilder); - } - - private void buildRollingFileAppender(final String appenderName) { - final AppenderComponentBuilder appenderBuilder = - builder.newAppender(appenderName, RollingFileAppender.PLUGIN_NAME); - buildFileAppender(appenderName, appenderBuilder); - final String fileName = getLog4jAppenderValue(appenderName, "File"); - appenderBuilder.addAttribute("filePattern", fileName + ".%i"); - final String maxFileSizeString = getLog4jAppenderValue(appenderName, "MaxFileSize", "10485760"); - final String maxBackupIndexString = getLog4jAppenderValue(appenderName, "MaxBackupIndex", "1"); - final ComponentBuilder triggeringPolicy = builder.newComponent("Policies") - .addComponent( - builder.newComponent("SizeBasedTriggeringPolicy").addAttribute("size", maxFileSizeString)); - appenderBuilder.addComponent(triggeringPolicy); - appenderBuilder.addComponent(builder.newComponent("DefaultRolloverStrategy") - .addAttribute("max", maxBackupIndexString) - .addAttribute("fileIndex", "min")); - builder.add(appenderBuilder); - } - - private void buildAttribute( - final String componentName, - final ComponentBuilder componentBuilder, - final String sourceAttributeName, - final String targetAttributeName) { - final String attributeValue = getLog4jAppenderValue(componentName, sourceAttributeName); - if (attributeValue != null) { - componentBuilder.addAttribute(targetAttributeName, attributeValue); - } - } - - private void buildMandatoryAttribute( - final String componentName, - final ComponentBuilder componentBuilder, - final String sourceAttributeName, - final String targetAttributeName) { - final String attributeValue = getLog4jAppenderValue(componentName, sourceAttributeName); - if (attributeValue != null) { - componentBuilder.addAttribute(targetAttributeName, attributeValue); - } else { - reportWarning("Missing " + sourceAttributeName + " for " + componentName); - } - } - - private void buildNullAppender(final String appenderName) { - final AppenderComponentBuilder appenderBuilder = builder.newAppender(appenderName, NullAppender.PLUGIN_NAME); - builder.add(appenderBuilder); - } - - private void buildAppenderLayout(final String name, final AppenderComponentBuilder appenderBuilder) { - final String layoutClass = getLog4jAppenderValue(name, "layout", null); - if (layoutClass != null) { - switch (layoutClass) { - case "org.apache.log4j.PatternLayout": - case "org.apache.log4j.EnhancedPatternLayout": { - String pattern = getLog4jAppenderValue(name, "layout.ConversionPattern", null); - if (pattern != null) { - pattern = pattern - // Log4j 2 and Log4j 1 level names differ for custom levels - .replaceAll("%([-\\.\\d]*)p(?!\\w)", "%$1v1Level") - // Log4j 2's %x (NDC) is not compatible with Log4j 1's - // %x - // Log4j 1: "foo bar baz" - // Log4j 2: "[foo, bar, baz]" - // Use %ndc to get the Log4j 1 format - .replaceAll("%([-\\.\\d]*)x(?!\\w)", "%$1ndc") - - // Log4j 2's %X (MDC) is not compatible with Log4j 1's - // %X - // Log4j 1: "{{foo,bar}{hoo,boo}}" - // Log4j 2: "{foo=bar,hoo=boo}" - // Use %properties to get the Log4j 1 format - .replaceAll("%([-\\.\\d]*)X(?!\\w)", "%$1properties"); - } else { - pattern = "%m%n"; - } - appenderBuilder.add(newPatternLayout(pattern)); - break; - } - case "org.apache.log4j.SimpleLayout": { - appenderBuilder.add(newPatternLayout("%v1Level - %m%n")); - break; - } - case "org.apache.log4j.TTCCLayout": { - String pattern = ""; - final String dateFormat = getLog4jAppenderValue(name, "layout.DateFormat", RELATIVE); - final String timezone = getLog4jAppenderValue(name, "layout.TimeZone", null); - if (dateFormat != null) { - if (RELATIVE.equalsIgnoreCase(dateFormat)) { - pattern += "%r "; - } else if (!NULL.equalsIgnoreCase(dateFormat)) { - pattern += "%d{" + dateFormat + "}"; - if (timezone != null) { - pattern += "{" + timezone + "}"; - } - pattern += " "; - } - } - if (Boolean.parseBoolean(getLog4jAppenderValue(name, "layout.ThreadPrinting", TRUE))) { - pattern += "[%t] "; - } - pattern += "%p "; - if (Boolean.parseBoolean(getLog4jAppenderValue(name, "layout.CategoryPrefixing", TRUE))) { - pattern += "%c "; - } - if (Boolean.parseBoolean(getLog4jAppenderValue(name, "layout.ContextPrinting", TRUE))) { - pattern += "%notEmpty{%ndc }"; - } - pattern += "- %m%n"; - appenderBuilder.add(newPatternLayout(pattern)); - break; - } - case "org.apache.log4j.HTMLLayout": { - final LayoutComponentBuilder htmlLayout = builder.newLayout("HtmlLayout"); - htmlLayout.addAttribute("title", getLog4jAppenderValue(name, "layout.Title", "Log4J Log Messages")); - htmlLayout.addAttribute( - "locationInfo", - Boolean.parseBoolean(getLog4jAppenderValue(name, "layout.LocationInfo", FALSE))); - appenderBuilder.add(htmlLayout); - break; - } - case "org.apache.log4j.xml.XMLLayout": { - final LayoutComponentBuilder xmlLayout = builder.newLayout("Log4j1XmlLayout"); - xmlLayout.addAttribute( - "locationInfo", - Boolean.parseBoolean(getLog4jAppenderValue(name, "layout.LocationInfo", FALSE))); - xmlLayout.addAttribute( - "properties", - Boolean.parseBoolean(getLog4jAppenderValue(name, "layout.Properties", FALSE))); - appenderBuilder.add(xmlLayout); - break; - } - default: - reportWarning("Unknown layout class: " + layoutClass); - } - } - } - - private LayoutComponentBuilder newPatternLayout(final String pattern) { - final LayoutComponentBuilder layoutBuilder = builder.newLayout("PatternLayout"); - if (pattern != null) { - layoutBuilder.addAttribute("pattern", pattern); - } - return layoutBuilder; - } - - private void buildRootLogger(final String rootLoggerValue) { - if (rootLoggerValue == null) { - return; - } - final String[] rootLoggerParts = rootLoggerValue.split(COMMA_DELIMITED_RE); - final String rootLoggerLevel = getLevelString(rootLoggerParts, Level.ERROR.name()); - final RootLoggerComponentBuilder loggerBuilder = builder.newRootLogger(rootLoggerLevel); - // - final String[] sortedAppenderNames = Arrays.copyOfRange(rootLoggerParts, 1, rootLoggerParts.length); - Arrays.sort(sortedAppenderNames); - for (final String appender : sortedAppenderNames) { - loggerBuilder.add(builder.newAppenderRef(appender)); - } - builder.add(loggerBuilder); - } - - private String getLevelString(final String[] loggerParts, final String defaultLevel) { - return loggerParts.length > 0 ? loggerParts[0] : defaultLevel; - } - - private void buildLoggers(final String prefix) { - final int preLength = prefix.length(); - for (final Map.Entry entry : properties.entrySet()) { - final Object keyObj = entry.getKey(); - if (keyObj != null) { - final String key = keyObj.toString().trim(); - if (key.startsWith(prefix)) { - final String name = key.substring(preLength); - final Object value = entry.getValue(); - if (value != null) { - // a Level may be followed by a list of Appender refs. - final String valueStr = value.toString().trim(); - final String[] split = valueStr.split(COMMA_DELIMITED_RE); - final String level = getLevelString(split, null); - if (level == null) { - warn("Level is missing for entry " + entry); - } else { - final LoggerComponentBuilder newLogger = builder.newLogger(name, level); - if (split.length > 1) { - // Add Appenders to this logger - final String[] sortedAppenderNames = Arrays.copyOfRange(split, 1, split.length); - Arrays.sort(sortedAppenderNames); - for (final String appenderName : sortedAppenderNames) { - newLogger.add(builder.newAppenderRef(appenderName)); - } - } - builder.add(newLogger); - } - } - } - } - } - } - - private String getLog4jAppenderValue(final String appenderName, final String attributeName) { - return getProperty("log4j.appender." + appenderName + "." + attributeName); - } - - private String getProperty(final String key) { - final String value = properties.getProperty(key); - final String substVars = OptionConverter.substVars(value, properties); - return substVars == null ? null : substVars.trim(); - } - - private String getProperty(final String key, final String defaultValue) { - final String value = getProperty(key); - return value == null ? defaultValue : value; - } - - private String getLog4jAppenderValue( - final String appenderName, final String attributeName, final String defaultValue) { - return getProperty("log4j.appender." + appenderName + "." + attributeName, defaultValue); - } - - private String getLog4jValue(final String key) { - return getProperty("log4j." + key); - } - - private void reportWarning(final String msg) { - StatusLogger.getLogger().warn("Log4j 1 configuration parser: " + msg); - } -} diff --git a/log4j-1.2-api/src/test/java/org/apache/log4j/config/AbstractLog4j1ConfigurationConverterTest.java b/log4j-1.2-api/src/test/java/org/apache/log4j/config/AbstractLog4j1ConfigurationConverterTest.java deleted file mode 100644 index 55ac05fbc90..00000000000 --- a/log4j-1.2-api/src/test/java/org/apache/log4j/config/AbstractLog4j1ConfigurationConverterTest.java +++ /dev/null @@ -1,86 +0,0 @@ -/* - * 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.log4j.config; - -import static org.junit.jupiter.api.Assertions.assertFalse; - -import java.io.IOException; -import java.nio.file.FileVisitResult; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.Paths; -import java.nio.file.SimpleFileVisitor; -import java.nio.file.attribute.BasicFileAttributes; -import java.util.ArrayList; -import java.util.List; -import javax.xml.parsers.DocumentBuilderFactory; -import javax.xml.parsers.ParserConfigurationException; -import org.junit.Test; -import org.junit.runner.RunWith; -import org.junit.runners.Parameterized; -import org.xml.sax.SAXException; - -@RunWith(Parameterized.class) -public abstract class AbstractLog4j1ConfigurationConverterTest { - - protected static List getPaths(final String root) throws IOException { - final List paths = new ArrayList<>(); - Files.walkFileTree(Paths.get(root), new SimpleFileVisitor() { - @Override - public FileVisitResult visitFile(final Path file, final BasicFileAttributes attrs) throws IOException { - paths.add(file.toAbsolutePath()); - return FileVisitResult.CONTINUE; - } - }); - return paths; - } - - private final Path pathIn; - - public AbstractLog4j1ConfigurationConverterTest(final Path path) { - this.pathIn = path; - } - - @Test - public void test() throws Exception { - final Path tempFile = Files.createTempFile("log4j2", ".xml"); - try { - final Log4j1ConfigurationConverter.CommandLineArguments cla = - new Log4j1ConfigurationConverter.CommandLineArguments(); - cla.setPathIn(pathIn); - cla.setPathOut(tempFile); - Log4j1ConfigurationConverter.run(cla); - checkWellFormedXml(tempFile); - checkUnnecessaryEscaping(tempFile); - } finally { - Files.deleteIfExists(tempFile); - } - } - - private void checkUnnecessaryEscaping(final Path tempFile) throws IOException { - for (String line : Files.readAllLines(tempFile)) { - assertFalse(line.endsWith(" ")); - } - } - - private void checkWellFormedXml(final Path xmlFilePath) - throws SAXException, IOException, ParserConfigurationException { - DocumentBuilderFactory.newInstance() - .newDocumentBuilder() - .parse(xmlFilePath.toUri().toString()); - } -} diff --git a/log4j-1.2-api/src/test/java/org/apache/log4j/config/Log4j1ConfigurationConverterHadoopTest.java b/log4j-1.2-api/src/test/java/org/apache/log4j/config/Log4j1ConfigurationConverterHadoopTest.java deleted file mode 100644 index 13ef2b68f7e..00000000000 --- a/log4j-1.2-api/src/test/java/org/apache/log4j/config/Log4j1ConfigurationConverterHadoopTest.java +++ /dev/null @@ -1,36 +0,0 @@ -/* - * 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.log4j.config; - -import java.io.IOException; -import java.nio.file.Path; -import java.util.List; -import org.junit.runner.RunWith; -import org.junit.runners.Parameterized; - -@RunWith(Parameterized.class) -public class Log4j1ConfigurationConverterHadoopTest extends AbstractLog4j1ConfigurationConverterTest { - - @Parameterized.Parameters(name = "{0}") - public static List data() throws IOException { - return getPaths("src/test/resources/config-1.2/hadoop"); - } - - public Log4j1ConfigurationConverterHadoopTest(final Path path) { - super(path); - } -} diff --git a/log4j-1.2-api/src/test/java/org/apache/log4j/config/Log4j1ConfigurationConverterSparkTest.java b/log4j-1.2-api/src/test/java/org/apache/log4j/config/Log4j1ConfigurationConverterSparkTest.java deleted file mode 100644 index 3b2384a782b..00000000000 --- a/log4j-1.2-api/src/test/java/org/apache/log4j/config/Log4j1ConfigurationConverterSparkTest.java +++ /dev/null @@ -1,36 +0,0 @@ -/* - * 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.log4j.config; - -import java.io.IOException; -import java.nio.file.Path; -import java.util.List; -import org.junit.runner.RunWith; -import org.junit.runners.Parameterized; - -@RunWith(Parameterized.class) -public class Log4j1ConfigurationConverterSparkTest extends AbstractLog4j1ConfigurationConverterTest { - - @Parameterized.Parameters(name = "{0}") - public static List data() throws IOException { - return getPaths("src/test/resources/config-1.2/spark"); - } - - public Log4j1ConfigurationConverterSparkTest(final Path path) { - super(path); - } -} diff --git a/log4j-1.2-api/src/test/java/org/apache/log4j/config/Log4j1ConfigurationFactoryTest.java b/log4j-1.2-api/src/test/java/org/apache/log4j/config/Log4j1ConfigurationFactoryTest.java deleted file mode 100644 index 0e16e26b62c..00000000000 --- a/log4j-1.2-api/src/test/java/org/apache/log4j/config/Log4j1ConfigurationFactoryTest.java +++ /dev/null @@ -1,191 +0,0 @@ -/* - * 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.log4j.config; - -import static org.junit.Assert.fail; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertFalse; -import static org.junit.jupiter.api.Assertions.assertNotNull; -import static org.junit.jupiter.api.Assertions.assertTrue; - -import java.net.URISyntaxException; -import java.net.URL; -import org.apache.log4j.layout.Log4j1XmlLayout; -import org.apache.logging.log4j.Level; -import org.apache.logging.log4j.core.Appender; -import org.apache.logging.log4j.core.Filter; -import org.apache.logging.log4j.core.Layout; -import org.apache.logging.log4j.core.LoggerContext; -import org.apache.logging.log4j.core.appender.ConsoleAppender; -import org.apache.logging.log4j.core.appender.ConsoleAppender.Target; -import org.apache.logging.log4j.core.config.Configuration; -import org.apache.logging.log4j.core.config.LoggerConfig; -import org.apache.logging.log4j.core.filter.ThresholdFilter; -import org.apache.logging.log4j.core.layout.PatternLayout; -import org.junit.Test; - -public class Log4j1ConfigurationFactoryTest extends AbstractLog4j1ConfigurationTest { - - private static final String SUFFIX = ".properties"; - - @Override - protected Configuration getConfiguration(final String configResource) throws URISyntaxException { - final URL configLocation = ClassLoader.getSystemResource(configResource + SUFFIX); - assertNotNull(configLocation, configResource); - final Configuration configuration = - new Log4j1ConfigurationFactory().getConfiguration(null, "test", configLocation.toURI()); - assertNotNull(configuration); - return configuration; - } - - private Layout testConsole(final String configResource) throws Exception { - final Configuration configuration = getConfiguration(configResource); - final String name = "Console"; - final ConsoleAppender appender = configuration.getAppender(name); - assertNotNull( - appender, "Missing appender '" + name + "' in configuration " + configResource + " → " + configuration); - assertEquals(Target.SYSTEM_ERR, appender.getTarget()); - // - final LoggerConfig loggerConfig = configuration.getLoggerConfig("com.example.foo"); - assertNotNull(loggerConfig); - assertEquals(Level.DEBUG, loggerConfig.getLevel()); - configuration.start(); - configuration.stop(); - return appender.getLayout(); - } - - @Override - @Test - public void testConsoleEnhancedPatternLayout() throws Exception { - super.testConsoleEnhancedPatternLayout(); - } - - @Override - @Test - public void testConsoleHtmlLayout() throws Exception { - super.testConsoleHtmlLayout(); - } - - @Test - public void testConsolePatternLayout() throws Exception { - super.testConsolePatternLayout(); - } - - @Override - @Test - public void testConsoleSimpleLayout() throws Exception { - super.testConsoleSimpleLayout(); - } - - @Override - @Test - public void testConsoleTtccLayout() throws Exception { - super.testConsoleTtccLayout(); - } - - @Test - public void testConsoleXmlLayout() throws Exception { - final Log4j1XmlLayout layout = (Log4j1XmlLayout) testConsole("config-1.2/log4j-console-XmlLayout"); - assertTrue(layout.isLocationInfo()); - assertFalse(layout.isProperties()); - } - - @Override - @Test - public void testFileSimpleLayout() throws Exception { - super.testFileSimpleLayout(); - } - - @Override - @Test - public void testNullAppender() throws Exception { - super.testNullAppender(); - } - - @Override - @Test - public void testRollingFileAppender() throws Exception { - super.testRollingFileAppender(); - } - - @Override - @Test - public void testDailyRollingFileAppender() throws Exception { - super.testDailyRollingFileAppender(); - } - - @Test - public void testRollingFileAppenderWithProperties() throws Exception { - super.testRollingFileAppenderWithProperties(); - } - - @Override - @Test - public void testSystemProperties1() throws Exception { - super.testSystemProperties1(); - } - - @Override - @Test - public void testSystemProperties2() throws Exception { - super.testSystemProperties2(); - } - - @Override - @Test - public void testConsoleCapitalization() throws Exception { - super.testConsoleCapitalization(); - } - - @Override - @Test - public void testDefaultValues() throws Exception { - super.testDefaultValues(); - } - - @Test - public void testUntrimmedValues() throws Exception { - try { - final Configuration config = getConfiguration("config-1.2/log4j-untrimmed"); - final LoggerConfig rootLogger = config.getRootLogger(); - assertEquals(Level.DEBUG, rootLogger.getLevel()); - final Appender appender = config.getAppender("Console"); - assertTrue(appender instanceof ConsoleAppender); - final Layout layout = appender.getLayout(); - assertTrue(layout instanceof PatternLayout); - assertEquals("%v1Level - %m%n", ((PatternLayout) layout).getConversionPattern()); - // No filter support - config.start(); - config.stop(); - } catch (NoClassDefFoundError e) { - fail(e.getMessage()); - } - } - - @Test - public void testGlobalThreshold() throws Exception { - try (final LoggerContext ctx = configure("config-1.2/log4j-global-threshold")) { - final Configuration config = ctx.getConfiguration(); - final Filter filter = config.getFilter(); - assertTrue(filter instanceof ThresholdFilter); - final ThresholdFilter thresholdFilter = (ThresholdFilter) filter; - assertEquals(Level.INFO, thresholdFilter.getLevel()); - assertEquals(Filter.Result.NEUTRAL, thresholdFilter.getOnMatch()); - assertEquals(Filter.Result.DENY, thresholdFilter.getOnMismatch()); - } - } -} diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-auth-examples/src/main/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-auth-examples/src/main/resources/log4j.properties deleted file mode 100644 index 1fbe7b51a3b..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-auth-examples/src/main/resources/log4j.properties +++ /dev/null @@ -1,23 +0,0 @@ -# -# 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. -# - -log4j.appender.test=org.apache.log4j.ConsoleAppender -log4j.appender.test.Target=System.out -log4j.appender.test.layout=org.apache.log4j.PatternLayout -log4j.appender.test.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n - -log4j.logger.org.apache.hadoop.security.authentication=DEBUG, test diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-common/src/main/conf/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-common/src/main/conf/log4j.properties deleted file mode 100644 index fc525df71b7..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-common/src/main/conf/log4j.properties +++ /dev/null @@ -1,324 +0,0 @@ -# -# 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. -# - -# Define some default values that can be overridden by system properties -hadoop.root.logger=INFO,console -hadoop.log.dir=target -hadoop.log.file=hadoop.log - -# Define the root logger to the system property "hadoop.root.logger". -log4j.rootLogger=${hadoop.root.logger}, EventCounter - -# Logging Threshold -log4j.threshold=ALL - -# Null Appender -log4j.appender.NullAppender=org.apache.log4j.varia.NullAppender - -# -# Rolling File Appender - cap space usage at 5gb. -# -hadoop.log.maxfilesize=256MB -hadoop.log.maxbackupindex=20 -log4j.appender.RFA=org.apache.log4j.RollingFileAppender -log4j.appender.RFA.File=${hadoop.log.dir}/${hadoop.log.file} - -log4j.appender.RFA.MaxFileSize=${hadoop.log.maxfilesize} -log4j.appender.RFA.MaxBackupIndex=${hadoop.log.maxbackupindex} - -log4j.appender.RFA.layout=org.apache.log4j.PatternLayout - -# Pattern format: Date LogLevel LoggerName LogMessage -log4j.appender.RFA.layout.ConversionPattern=%d{ISO8601} %p %c: %m%n -# Debugging Pattern format -#log4j.appender.RFA.layout.ConversionPattern=%d{ISO8601} %-5p %c{2} (%F:%M(%L)) - %m%n - - -# -# Daily Rolling File Appender -# - -log4j.appender.DRFA=org.apache.log4j.DailyRollingFileAppender -log4j.appender.DRFA.File=${hadoop.log.dir}/${hadoop.log.file} - -# Rollover at midnight -log4j.appender.DRFA.DatePattern=.yyyy-MM-dd - -log4j.appender.DRFA.layout=org.apache.log4j.PatternLayout - -# Pattern format: Date LogLevel LoggerName LogMessage -log4j.appender.DRFA.layout.ConversionPattern=%d{ISO8601} %p %c: %m%n -# Debugging Pattern format -#log4j.appender.DRFA.layout.ConversionPattern=%d{ISO8601} %-5p %c{2} (%F:%M(%L)) - %m%n - - -# -# console -# Add "console" to rootlogger above if you want to use this -# - -log4j.appender.console=org.apache.log4j.ConsoleAppender -log4j.appender.console.target=System.err -log4j.appender.console.layout=org.apache.log4j.PatternLayout -log4j.appender.console.layout.ConversionPattern=%d{ISO8601} %p %c{2}: %m%n - -# -# TaskLog Appender -# - -#Default values -hadoop.tasklog.taskid=null -hadoop.tasklog.iscleanup=false -hadoop.tasklog.noKeepSplits=4 -hadoop.tasklog.totalLogFileSize=100 -hadoop.tasklog.purgeLogSplits=true -hadoop.tasklog.logsRetainHours=12 - -log4j.appender.TLA=org.apache.hadoop.mapred.TaskLogAppender -log4j.appender.TLA.taskId=${hadoop.tasklog.taskid} -log4j.appender.TLA.isCleanup=${hadoop.tasklog.iscleanup} -log4j.appender.TLA.totalLogFileSize=${hadoop.tasklog.totalLogFileSize} - -log4j.appender.TLA.layout=org.apache.log4j.PatternLayout -log4j.appender.TLA.layout.ConversionPattern=%d{ISO8601} %p %c: %m%n - -# -# HDFS block state change log from block manager -# -# Uncomment the following to log normal block state change -# messages from BlockManager in NameNode. -#log4j.logger.BlockStateChange=DEBUG - -# -#Security appender -# -hadoop.security.logger=INFO,NullAppender -hadoop.security.log.maxfilesize=256MB -hadoop.security.log.maxbackupindex=20 -log4j.category.SecurityLogger=${hadoop.security.logger} -hadoop.security.log.file=SecurityAuth-${user.name}.audit -log4j.appender.RFAS=org.apache.log4j.RollingFileAppender -log4j.appender.RFAS.File=${hadoop.log.dir}/${hadoop.security.log.file} -log4j.appender.RFAS.layout=org.apache.log4j.PatternLayout -log4j.appender.RFAS.layout.ConversionPattern=%d{ISO8601} %p %c: %m%n -log4j.appender.RFAS.MaxFileSize=${hadoop.security.log.maxfilesize} -log4j.appender.RFAS.MaxBackupIndex=${hadoop.security.log.maxbackupindex} - -# -# Daily Rolling Security appender -# -log4j.appender.DRFAS=org.apache.log4j.DailyRollingFileAppender -log4j.appender.DRFAS.File=${hadoop.log.dir}/${hadoop.security.log.file} -log4j.appender.DRFAS.layout=org.apache.log4j.PatternLayout -log4j.appender.DRFAS.layout.ConversionPattern=%d{ISO8601} %p %c: %m%n -log4j.appender.DRFAS.DatePattern=.yyyy-MM-dd - -# -# hadoop configuration logging -# - -# Uncomment the following line to turn off configuration deprecation warnings. -# log4j.logger.org.apache.hadoop.conf.Configuration.deprecation=WARN - -# -# hdfs audit logging -# -hdfs.audit.logger=INFO,NullAppender -hdfs.audit.log.maxfilesize=256MB -hdfs.audit.log.maxbackupindex=20 -log4j.logger.org.apache.hadoop.hdfs.server.namenode.FSNamesystem.audit=${hdfs.audit.logger} -log4j.additivity.org.apache.hadoop.hdfs.server.namenode.FSNamesystem.audit=false -log4j.appender.RFAAUDIT=org.apache.log4j.RollingFileAppender -log4j.appender.RFAAUDIT.File=${hadoop.log.dir}/hdfs-audit.log -log4j.appender.RFAAUDIT.layout=org.apache.log4j.PatternLayout -log4j.appender.RFAAUDIT.layout.ConversionPattern=%d{ISO8601} %p %c{2}: %m%n -log4j.appender.RFAAUDIT.MaxFileSize=${hdfs.audit.log.maxfilesize} -log4j.appender.RFAAUDIT.MaxBackupIndex=${hdfs.audit.log.maxbackupindex} - -# -# NameNode metrics logging. -# The default is to retain two namenode-metrics.log files up to 64MB each. -# -namenode.metrics.logger=INFO,NullAppender -log4j.logger.NameNodeMetricsLog=${namenode.metrics.logger} -log4j.additivity.NameNodeMetricsLog=false -log4j.appender.NNMETRICSRFA=org.apache.log4j.RollingFileAppender -log4j.appender.NNMETRICSRFA.File=${hadoop.log.dir}/namenode-metrics.log -log4j.appender.NNMETRICSRFA.layout=org.apache.log4j.PatternLayout -log4j.appender.NNMETRICSRFA.layout.ConversionPattern=%d{ISO8601} %m%n -log4j.appender.NNMETRICSRFA.MaxBackupIndex=1 -log4j.appender.NNMETRICSRFA.MaxFileSize=64MB - -# -# DataNode metrics logging. -# The default is to retain two datanode-metrics.log files up to 64MB each. -# -datanode.metrics.logger=INFO,NullAppender -log4j.logger.DataNodeMetricsLog=${datanode.metrics.logger} -log4j.additivity.DataNodeMetricsLog=false -log4j.appender.DNMETRICSRFA=org.apache.log4j.RollingFileAppender -log4j.appender.DNMETRICSRFA.File=${hadoop.log.dir}/datanode-metrics.log -log4j.appender.DNMETRICSRFA.layout=org.apache.log4j.PatternLayout -log4j.appender.DNMETRICSRFA.layout.ConversionPattern=%d{ISO8601} %m%n -log4j.appender.DNMETRICSRFA.MaxBackupIndex=1 -log4j.appender.DNMETRICSRFA.MaxFileSize=64MB - -# -# mapred audit logging -# -mapred.audit.logger=INFO,NullAppender -mapred.audit.log.maxfilesize=256MB -mapred.audit.log.maxbackupindex=20 -log4j.logger.org.apache.hadoop.mapred.AuditLogger=${mapred.audit.logger} -log4j.additivity.org.apache.hadoop.mapred.AuditLogger=false -log4j.appender.MRAUDIT=org.apache.log4j.RollingFileAppender -log4j.appender.MRAUDIT.File=${hadoop.log.dir}/mapred-audit.log -log4j.appender.MRAUDIT.layout=org.apache.log4j.PatternLayout -log4j.appender.MRAUDIT.layout.ConversionPattern=%d{ISO8601} %p %c{2}: %m%n -log4j.appender.MRAUDIT.MaxFileSize=${mapred.audit.log.maxfilesize} -log4j.appender.MRAUDIT.MaxBackupIndex=${mapred.audit.log.maxbackupindex} - -# Custom Logging levels - -#log4j.logger.org.apache.hadoop.mapred.JobTracker=DEBUG -#log4j.logger.org.apache.hadoop.mapred.TaskTracker=DEBUG -#log4j.logger.org.apache.hadoop.hdfs.server.namenode.FSNamesystem.audit=DEBUG - -# Jets3t library -log4j.logger.org.jets3t.service.impl.rest.httpclient.RestS3Service=ERROR - -# AWS SDK & S3A FileSystem -log4j.logger.com.amazonaws=ERROR -log4j.logger.com.amazonaws.http.AmazonHttpClient=ERROR -log4j.logger.org.apache.hadoop.fs.s3a.S3AFileSystem=WARN - -# -# Event Counter Appender -# Sends counts of logging messages at different severity levels to Hadoop Metrics. -# -log4j.appender.EventCounter=org.apache.hadoop.log.metrics.EventCounter - -# -# Job Summary Appender -# -# Use following logger to send summary to separate file defined by -# hadoop.mapreduce.jobsummary.log.file : -# hadoop.mapreduce.jobsummary.logger=INFO,JSA -# -hadoop.mapreduce.jobsummary.logger=${hadoop.root.logger} -hadoop.mapreduce.jobsummary.log.file=hadoop-mapreduce.jobsummary.log -hadoop.mapreduce.jobsummary.log.maxfilesize=256MB -hadoop.mapreduce.jobsummary.log.maxbackupindex=20 -log4j.appender.JSA=org.apache.log4j.RollingFileAppender -log4j.appender.JSA.File=${hadoop.log.dir}/${hadoop.mapreduce.jobsummary.log.file} -log4j.appender.JSA.MaxFileSize=${hadoop.mapreduce.jobsummary.log.maxfilesize} -log4j.appender.JSA.MaxBackupIndex=${hadoop.mapreduce.jobsummary.log.maxbackupindex} -log4j.appender.JSA.layout=org.apache.log4j.PatternLayout -log4j.appender.JSA.layout.ConversionPattern=%d{ISO8601} %p %c{2}: %m%n -log4j.logger.org.apache.hadoop.mapred.JobInProgress$JobSummary=${hadoop.mapreduce.jobsummary.logger} -log4j.additivity.org.apache.hadoop.mapred.JobInProgress$JobSummary=false - -# -# shuffle connection log from shuffleHandler -# Uncomment the following line to enable logging of shuffle connections -# log4j.logger.org.apache.hadoop.mapred.ShuffleHandler.audit=DEBUG - -# -# Yarn ResourceManager Application Summary Log -# -# Set the ResourceManager summary log filename -yarn.server.resourcemanager.appsummary.log.file=rm-appsummary.log -# Set the ResourceManager summary log level and appender -yarn.server.resourcemanager.appsummary.logger=${hadoop.root.logger} -#yarn.server.resourcemanager.appsummary.logger=INFO,RMSUMMARY - -# To enable AppSummaryLogging for the RM, -# set yarn.server.resourcemanager.appsummary.logger to -# ,RMSUMMARY in hadoop-env.sh - -# Appender for ResourceManager Application Summary Log -# Requires the following properties to be set -# - hadoop.log.dir (Hadoop Log directory) -# - yarn.server.resourcemanager.appsummary.log.file (resource manager app summary log filename) -# - yarn.server.resourcemanager.appsummary.logger (resource manager app summary log level and appender) - -log4j.logger.org.apache.hadoop.yarn.server.resourcemanager.RMAppManager$ApplicationSummary=${yarn.server.resourcemanager.appsummary.logger} -log4j.additivity.org.apache.hadoop.yarn.server.resourcemanager.RMAppManager$ApplicationSummary=false -log4j.appender.RMSUMMARY=org.apache.log4j.RollingFileAppender -log4j.appender.RMSUMMARY.File=${hadoop.log.dir}/${yarn.server.resourcemanager.appsummary.log.file} -log4j.appender.RMSUMMARY.MaxFileSize=256MB -log4j.appender.RMSUMMARY.MaxBackupIndex=20 -log4j.appender.RMSUMMARY.layout=org.apache.log4j.PatternLayout -log4j.appender.RMSUMMARY.layout.ConversionPattern=%d{ISO8601} %p %c{2}: %m%n - -# HS audit log configs -#mapreduce.hs.audit.logger=INFO,HSAUDIT -#log4j.logger.org.apache.hadoop.mapreduce.v2.hs.HSAuditLogger=${mapreduce.hs.audit.logger} -#log4j.additivity.org.apache.hadoop.mapreduce.v2.hs.HSAuditLogger=false -#log4j.appender.HSAUDIT=org.apache.log4j.DailyRollingFileAppender -#log4j.appender.HSAUDIT.File=${hadoop.log.dir}/hs-audit.log -#log4j.appender.HSAUDIT.layout=org.apache.log4j.PatternLayout -#log4j.appender.HSAUDIT.layout.ConversionPattern=%d{ISO8601} %p %c{2}: %m%n -#log4j.appender.HSAUDIT.DatePattern=.yyyy-MM-dd - -# Http Server Request Logs -#log4j.logger.http.requests.namenode=INFO,namenoderequestlog -#log4j.appender.namenoderequestlog=org.apache.hadoop.http.HttpRequestLogAppender -#log4j.appender.namenoderequestlog.Filename=${hadoop.log.dir}/jetty-namenode-yyyy_mm_dd.log -#log4j.appender.namenoderequestlog.RetainDays=3 - -#log4j.logger.http.requests.datanode=INFO,datanoderequestlog -#log4j.appender.datanoderequestlog=org.apache.hadoop.http.HttpRequestLogAppender -#log4j.appender.datanoderequestlog.Filename=${hadoop.log.dir}/jetty-datanode-yyyy_mm_dd.log -#log4j.appender.datanoderequestlog.RetainDays=3 - -#log4j.logger.http.requests.resourcemanager=INFO,resourcemanagerrequestlog -#log4j.appender.resourcemanagerrequestlog=org.apache.hadoop.http.HttpRequestLogAppender -#log4j.appender.resourcemanagerrequestlog.Filename=${hadoop.log.dir}/jetty-resourcemanager-yyyy_mm_dd.log -#log4j.appender.resourcemanagerrequestlog.RetainDays=3 - -#log4j.logger.http.requests.jobhistory=INFO,jobhistoryrequestlog -#log4j.appender.jobhistoryrequestlog=org.apache.hadoop.http.HttpRequestLogAppender -#log4j.appender.jobhistoryrequestlog.Filename=${hadoop.log.dir}/jetty-jobhistory-yyyy_mm_dd.log -#log4j.appender.jobhistoryrequestlog.RetainDays=3 - -#log4j.logger.http.requests.nodemanager=INFO,nodemanagerrequestlog -#log4j.appender.nodemanagerrequestlog=org.apache.hadoop.http.HttpRequestLogAppender -#log4j.appender.nodemanagerrequestlog.Filename=${hadoop.log.dir}/jetty-nodemanager-yyyy_mm_dd.log -#log4j.appender.nodemanagerrequestlog.RetainDays=3 - - -# WebHdfs request log on datanodes -# Specify -Ddatanode.webhdfs.logger=INFO,HTTPDRFA on datanode startup to -# direct the log to a separate file. -#datanode.webhdfs.logger=INFO,console -#log4j.logger.datanode.webhdfs=${datanode.webhdfs.logger} -#log4j.appender.HTTPDRFA=org.apache.log4j.DailyRollingFileAppender -#log4j.appender.HTTPDRFA.File=${hadoop.log.dir}/hadoop-datanode-webhdfs.log -#log4j.appender.HTTPDRFA.layout=org.apache.log4j.PatternLayout -#log4j.appender.HTTPDRFA.layout.ConversionPattern=%d{ISO8601} %m%n -#log4j.appender.HTTPDRFA.DatePattern=.yyyy-MM-dd - - -# Appender for viewing information for errors and warnings -yarn.ewma.cleanupInterval=300 -yarn.ewma.messageAgeLimitSeconds=86400 -yarn.ewma.maxUniqueMessages=250 -log4j.appender.EWMA=org.apache.hadoop.yarn.util.Log4jWarningErrorMetricsAppender -log4j.appender.EWMA.cleanupInterval=${yarn.ewma.cleanupInterval} -log4j.appender.EWMA.messageAgeLimitSeconds=${yarn.ewma.messageAgeLimitSeconds} -log4j.appender.EWMA.maxUniqueMessages=${yarn.ewma.maxUniqueMessages} diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-common/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-common/src/test/resources/log4j.properties deleted file mode 100644 index a40de161bd2..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-common/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-kms/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-kms/src/test/resources/log4j.properties deleted file mode 100644 index d57e5846ee1..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-kms/src/test/resources/log4j.properties +++ /dev/null @@ -1,30 +0,0 @@ -# -# 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. -# - -# STDOUT Appender -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.Target=System.out -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p %c{1} - %m%n - -log4j.rootLogger=INFO, stdout -log4j.logger.org.apache.hadoop.conf=ERROR -log4j.logger.org.apache.hadoop.crytpo.key.kms.server=ALL -log4j.logger.com.sun.jersey.server.wadl.generators.WadlGeneratorJAXBGrammarGenerator=OFF -log4j.logger.org.apache.hadoop.security=OFF -log4j.logger.org.apache.directory.server.core=OFF -log4j.logger.org.apache.hadoop.util.NativeCodeLoader=OFF diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-minikdc/src/main/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-minikdc/src/main/resources/log4j.properties deleted file mode 100644 index 29f00dda73e..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-minikdc/src/main/resources/log4j.properties +++ /dev/null @@ -1,30 +0,0 @@ -# -# 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. -# - -# STDOUT Appender -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.Target=System.err -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p %c{1} - %m%n - -log4j.rootLogger=INFO, stdout - -# Switching off most of Apache DS logqing which is QUITE verbose -log4j.logger.org.apache.directory=OFF -log4j.logger.org.apache.directory.server.kerberos=INFO, stdout -log4j.additivity.org.apache.directory=false -log4j.logger.net.sf.ehcache=INFO, stdout diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-nfs/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-nfs/src/test/resources/log4j.properties deleted file mode 100644 index a40de161bd2..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-nfs/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-hdfs-project/hadoop-hdfs-client/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-hdfs-project/hadoop-hdfs-client/src/test/resources/log4j.properties deleted file mode 100644 index 6c2fa4cb336..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-hdfs-project/hadoop-hdfs-client/src/test/resources/log4j.properties +++ /dev/null @@ -1,50 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} [%t] %-5p %c{2} (%F:%M(%L)) - %m%n - -# -# NameNode metrics logging. -# The default is to retain two namenode-metrics.log files up to 64MB each. -# -log4j.logger.NameNodeMetricsLog=INFO,NNMETRICSRFA -log4j.additivity.NameNodeMetricsLog=false -log4j.appender.NNMETRICSRFA=org.apache.log4j.RollingFileAppender -log4j.appender.NNMETRICSRFA.File=${hadoop.log.dir}/namenode-metrics.log -log4j.appender.NNMETRICSRFA.layout=org.apache.log4j.PatternLayout -log4j.appender.NNMETRICSRFA.layout.ConversionPattern=%d{ISO8601} %m%n -log4j.appender.NNMETRICSRFA.MaxBackupIndex=1 -log4j.appender.NNMETRICSRFA.MaxFileSize=64MB - -# -# DataNode metrics logging. -# The default is to retain two datanode-metrics.log files up to 64MB each. -# -log4j.logger.DataNodeMetricsLog=INFO,DNMETRICSRFA -log4j.additivity.DataNodeMetricsLog=false -log4j.appender.DNMETRICSRFA=org.apache.log4j.RollingFileAppender -log4j.appender.DNMETRICSRFA.File=${hadoop.log.dir}/datanode-metrics.log -log4j.appender.DNMETRICSRFA.layout=org.apache.log4j.PatternLayout -log4j.appender.DNMETRICSRFA.layout.ConversionPattern=%d{ISO8601} %m%n -log4j.appender.DNMETRICSRFA.MaxBackupIndex=1 -log4j.appender.DNMETRICSRFA.MaxFileSize=64MB diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-hdfs-project/hadoop-hdfs/src/contrib/bkjournal/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-hdfs-project/hadoop-hdfs/src/contrib/bkjournal/src/test/resources/log4j.properties deleted file mode 100644 index 58db1c8842d..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-hdfs-project/hadoop-hdfs/src/contrib/bkjournal/src/test/resources/log4j.properties +++ /dev/null @@ -1,51 +0,0 @@ -# -# 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. -# - -# -# Bookkeeper Journal Logging Configuration -# - -# Format is " (, )+ - -# DEFAULT: console appender only -log4j.rootLogger=DEBUG, CONSOLE - -# Example with rolling log file -#log4j.rootLogger=DEBUG, CONSOLE, ROLLINGFILE - -# Example with rolling log file and tracing -#log4j.rootLogger=TRACE, CONSOLE, ROLLINGFILE, TRACEFILE - -# -# Log INFO level and above messages to the console -# -log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender -log4j.appender.CONSOLE.Threshold=INFO -log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout -log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} - %-5p - [%t:%C{1}@%L] - %m%n - -# -# Add ROLLINGFILE to rootLogger to get log file output -# Log DEBUG level and above messages to a log file -log4j.appender.ROLLINGFILE=org.apache.log4j.DailyRollingFileAppender -log4j.appender.ROLLINGFILE.Threshold=DEBUG -log4j.appender.ROLLINGFILE.File=hdfs-namenode.log -log4j.appender.ROLLINGFILE.layout=org.apache.log4j.PatternLayout -log4j.appender.ROLLINGFILE.layout.ConversionPattern=%d{ISO8601} - %-5p - [%t:%C{1}@%L] - %m%n - -# Max log file size of 10MB -log4j.appender.ROLLINGFILE.MaxFileSize=10MB diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-hdfs-project/hadoop-hdfs/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-hdfs-project/hadoop-hdfs/src/test/resources/log4j.properties deleted file mode 100644 index 6c2fa4cb336..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-hdfs-project/hadoop-hdfs/src/test/resources/log4j.properties +++ /dev/null @@ -1,50 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} [%t] %-5p %c{2} (%F:%M(%L)) - %m%n - -# -# NameNode metrics logging. -# The default is to retain two namenode-metrics.log files up to 64MB each. -# -log4j.logger.NameNodeMetricsLog=INFO,NNMETRICSRFA -log4j.additivity.NameNodeMetricsLog=false -log4j.appender.NNMETRICSRFA=org.apache.log4j.RollingFileAppender -log4j.appender.NNMETRICSRFA.File=${hadoop.log.dir}/namenode-metrics.log -log4j.appender.NNMETRICSRFA.layout=org.apache.log4j.PatternLayout -log4j.appender.NNMETRICSRFA.layout.ConversionPattern=%d{ISO8601} %m%n -log4j.appender.NNMETRICSRFA.MaxBackupIndex=1 -log4j.appender.NNMETRICSRFA.MaxFileSize=64MB - -# -# DataNode metrics logging. -# The default is to retain two datanode-metrics.log files up to 64MB each. -# -log4j.logger.DataNodeMetricsLog=INFO,DNMETRICSRFA -log4j.additivity.DataNodeMetricsLog=false -log4j.appender.DNMETRICSRFA=org.apache.log4j.RollingFileAppender -log4j.appender.DNMETRICSRFA.File=${hadoop.log.dir}/datanode-metrics.log -log4j.appender.DNMETRICSRFA.layout=org.apache.log4j.PatternLayout -log4j.appender.DNMETRICSRFA.layout.ConversionPattern=%d{ISO8601} %m%n -log4j.appender.DNMETRICSRFA.MaxBackupIndex=1 -log4j.appender.DNMETRICSRFA.MaxFileSize=64MB diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-app/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-app/src/test/resources/log4j.properties deleted file mode 100644 index b7ca6914295..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-app/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-common/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-common/src/test/resources/log4j.properties deleted file mode 100644 index b7ca6914295..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-common/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/test/resources/log4j.properties deleted file mode 100644 index b7ca6914295..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-hs/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-hs/src/test/resources/log4j.properties deleted file mode 100644 index b7ca6914295..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-hs/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-jobclient/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-jobclient/src/test/resources/log4j.properties deleted file mode 100644 index b7ca6914295..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-jobclient/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-nativetask/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-nativetask/src/test/resources/log4j.properties deleted file mode 100644 index b7ca6914295..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-nativetask/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-shuffle/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-shuffle/src/test/resources/log4j.properties deleted file mode 100644 index b7ca6914295..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-shuffle/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-aws/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-aws/src/test/resources/log4j.properties deleted file mode 100644 index 396985af1e5..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-aws/src/test/resources/log4j.properties +++ /dev/null @@ -1,29 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} [%t] %-5p %c{2} (%F:%M(%L)) - %m%n - -log4j.logger.org.apache.hadoop.util.NativeCodeLoader=ERROR - -# for debugging low level S3a operations, uncomment this line -# log4j.logger.org.apache.hadoop.fs.s3a=DEBUG diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-azure/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-azure/src/test/resources/log4j.properties deleted file mode 100644 index 3bd94a6e2c2..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-azure/src/test/resources/log4j.properties +++ /dev/null @@ -1,26 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=INFO,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t]: %c{2} (%F:%M(%L)) - %m%n - -log4j.logger.org.apache.hadoop.fs.azure.AzureFileSystemThreadPoolExecutor=DEBUG diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-openstack/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-openstack/src/test/resources/log4j.properties deleted file mode 100644 index 83dd3f2fd9a..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-openstack/src/test/resources/log4j.properties +++ /dev/null @@ -1,28 +0,0 @@ -# -# 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. -# - -log4j.rootLogger=INFO,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.target=System.out -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} [%t] %-5p %c{2} (%F:%M(%L)) - %m%n -#log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} [%t] %-5p %c %x - %m%n" -#log4j.logger.org.apache.hadoop.fs.swift=DEBUG - -#crank back on warnings about -1 content length GETs -log4j.logger.org.apache.commons.httpclient.HttpMethodBase=ERROR diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-sls/src/main/sample-conf/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-sls/src/main/sample-conf/log4j.properties deleted file mode 100644 index 3672426f7e6..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-tools/hadoop-sls/src/main/sample-conf/log4j.properties +++ /dev/null @@ -1,23 +0,0 @@ -# -# 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. -# - -log4j.appender.test=org.apache.log4j.ConsoleAppender -log4j.appender.test.Target=System.out -log4j.appender.test.layout=org.apache.log4j.PatternLayout -log4j.appender.test.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n - -log4j.logger=NONE, test diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-distributedshell/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-distributedshell/src/test/resources/log4j.properties deleted file mode 100644 index b7ca6914295..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-distributedshell/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-unmanaged-am-launcher/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-unmanaged-am-launcher/src/test/resources/log4j.properties deleted file mode 100644 index 898a262af83..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-unmanaged-am-launcher/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=INFO,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/test/resources/log4j.properties deleted file mode 100644 index b7ca6914295..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/test/resources/log4j.properties deleted file mode 100644 index cd739b65be0..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/test/resources/log4j.properties +++ /dev/null @@ -1,64 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=INFO,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} [%t] %-5p %c{2} (%F:%M(%L)) - %m%n - -log4j.appender.subprocess=org.apache.log4j.ConsoleAppender -log4j.appender.subprocess.layout=org.apache.log4j.PatternLayout -log4j.appender.subprocess.layout.ConversionPattern=[%c{1}]: %m%n - -# packages under test -log4j.logger.org.apache.hadoop.yarn.registry=DEBUG -log4j.logger.org.apache.hadoop.service=DEBUG - -log4j.logger.org.apache.hadoop.security.UserGroupInformation=DEBUG - - -#crank back on some noise -log4j.logger.org.apache.hadoop.util.NativeCodeLoader=ERROR -log4j.logger.org.apache.hadoop.hdfs.server.datanode.BlockPoolSliceScanner=WARN -log4j.logger.org.apache.hadoop.hdfs.server.blockmanagement=WARN -log4j.logger.org.apache.hadoop.hdfs.server.namenode.FSNamesystem.audit=WARN -log4j.logger.org.apache.hadoop.hdfs=WARN - - -log4j.logger.org.apache.hadoop.yarn.server.nodemanager.containermanager.monitor=WARN -log4j.logger.org.apache.hadoop.yarn.server.nodemanager.NodeStatusUpdaterImpl=WARN -log4j.logger.org.apache.zookeeper=INFO -log4j.logger.org.apache.zookeeper.ClientCnxn=DEBUG - -log4j.logger.org.apache.hadoop.yarn.server.resourcemanager.security=WARN -log4j.logger.org.apache.hadoop.metrics2=ERROR -log4j.logger.org.apache.hadoop.util.HostsFileReader=WARN -log4j.logger.org.apache.hadoop.yarn.event.AsyncDispatcher=WARN -log4j.logger.org.apache.hadoop.security.token.delegation=WARN -log4j.logger.org.apache.hadoop.yarn.util.AbstractLivelinessMonitor=WARN -log4j.logger.org.apache.hadoop.yarn.server.nodemanager.security=WARN -log4j.logger.org.apache.hadoop.yarn.server.resourcemanager.RMNMInfo=WARN - -# curator noise -log4j.logger.org.apache.curator.framework.imps=WARN -log4j.logger.org.apache.curator.framework.state.ConnectionStateManager=ERROR - -log4j.logger.org.apache.directory.api.ldap=ERROR -log4j.logger.org.apache.directory.server=ERROR diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/test/resources/log4j.properties deleted file mode 100644 index b7ca6914295..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/test/resources/log4j.properties deleted file mode 100644 index b7ca6914295..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/test/resources/log4j.properties deleted file mode 100644 index b7ca6914295..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-tests/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-tests/src/test/resources/log4j.properties deleted file mode 100644 index 898a262af83..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-tests/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=INFO,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-timelineservice-hbase-tests/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-timelineservice-hbase-tests/src/test/resources/log4j.properties deleted file mode 100644 index b7ca6914295..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-timelineservice-hbase-tests/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-timelineservice/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-timelineservice/src/test/resources/log4j.properties deleted file mode 100644 index b7ca6914295..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-timelineservice/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# log4j configuration used during build and unit tests - -log4j.rootLogger=info,stdout -log4j.threshold=ALL -log4j.appender.stdout=org.apache.log4j.ConsoleAppender -log4j.appender.stdout.layout=org.apache.log4j.PatternLayout -log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{2} (%F:%M(%L)) - %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/R/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/R/log4j.properties deleted file mode 100644 index 6365f63b8bd..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/R/log4j.properties +++ /dev/null @@ -1,28 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file target/unit-tests.log -log4j.rootCategory=INFO, file -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=R/target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Ignore messages below warning level from Jetty, because it's a bit verbose -log4j.logger.org.eclipse.jetty=WARN -org.eclipse.jetty.LEVEL=WARN diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/common/network-common/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/common/network-common/src/test/resources/log4j.properties deleted file mode 100644 index e9feeb64f04..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/common/network-common/src/test/resources/log4j.properties +++ /dev/null @@ -1,27 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file target/unit-tests.log -log4j.rootCategory=DEBUG, file -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Silence verbose logs from 3rd-party libraries. -log4j.logger.io.netty=INFO diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/common/network-shuffle/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/common/network-shuffle/src/test/resources/log4j.properties deleted file mode 100644 index e8abecea806..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/common/network-shuffle/src/test/resources/log4j.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file target/unit-tests.log -log4j.rootCategory=DEBUG, file -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/core/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/core/src/test/resources/log4j.properties deleted file mode 100644 index d919270cf2b..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/core/src/test/resources/log4j.properties +++ /dev/null @@ -1,36 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file target/unit-tests.log -test.appender=file -log4j.rootCategory=INFO, ${test.appender} -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Tests that launch java subprocesses can set the "test.appender" system property to -# "console" to avoid having the child process's logs overwrite the unit test's -# log file. -log4j.appender.console=org.apache.log4j.ConsoleAppender -log4j.appender.console.target=System.err -log4j.appender.console.layout=org.apache.log4j.PatternLayout -log4j.appender.console.layout.ConversionPattern=%t: %m%n - -# Ignore messages below warning level from Jetty, because it's a bit verbose -log4j.logger.org.spark_project.jetty=WARN diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/external/flume-sink/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/external/flume-sink/src/test/resources/log4j.properties deleted file mode 100644 index bad5156b0f1..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/external/flume-sink/src/test/resources/log4j.properties +++ /dev/null @@ -1,27 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file streaming/target/unit-tests.log -log4j.rootCategory=INFO, file -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Ignore messages below warning level from Jetty, because it's a bit verbose -log4j.logger.org.spark_project.jetty=WARN diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/external/flume/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/external/flume/src/test/resources/log4j.properties deleted file mode 100644 index 001d0482aca..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/external/flume/src/test/resources/log4j.properties +++ /dev/null @@ -1,27 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file target/unit-tests.log -log4j.rootCategory=INFO, file -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Ignore messages below warning level from Jetty, because it's a bit verbose -log4j.logger.org.spark_project.jetty=WARN diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/external/java8-tests/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/external/java8-tests/src/test/resources/log4j.properties deleted file mode 100644 index 001d0482aca..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/external/java8-tests/src/test/resources/log4j.properties +++ /dev/null @@ -1,27 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file target/unit-tests.log -log4j.rootCategory=INFO, file -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Ignore messages below warning level from Jetty, because it's a bit verbose -log4j.logger.org.spark_project.jetty=WARN diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/external/kafka-0-10/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/external/kafka-0-10/src/test/resources/log4j.properties deleted file mode 100644 index 49618ae7b54..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/external/kafka-0-10/src/test/resources/log4j.properties +++ /dev/null @@ -1,27 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file target/unit-tests.log -log4j.rootCategory=INFO, file -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Ignore messages below warning level from Jetty, because it's a bit verbose -log4j.logger.org.spark-project.jetty=WARN diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/external/kafka-0-8/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/external/kafka-0-8/src/test/resources/log4j.properties deleted file mode 100644 index 001d0482aca..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/external/kafka-0-8/src/test/resources/log4j.properties +++ /dev/null @@ -1,27 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file target/unit-tests.log -log4j.rootCategory=INFO, file -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Ignore messages below warning level from Jetty, because it's a bit verbose -log4j.logger.org.spark_project.jetty=WARN diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/external/kinesis-asl/src/main/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/external/kinesis-asl/src/main/resources/log4j.properties deleted file mode 100644 index 798457fae65..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/external/kinesis-asl/src/main/resources/log4j.properties +++ /dev/null @@ -1,37 +0,0 @@ -# -# 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. -# - -log4j.rootCategory=WARN, console - -# File appender -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=false -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %p %c{1}: %m%n - -# Console appender -log4j.appender.console=org.apache.log4j.ConsoleAppender -log4j.appender.console.target=System.out -log4j.appender.console.layout=org.apache.log4j.PatternLayout -log4j.appender.console.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss} %p %c{1}: %m%n - -# Settings to quiet third party logs that are too verbose -log4j.logger.org.spark_project.jetty=WARN -log4j.logger.org.spark_project.jetty.util.component.AbstractLifeCycle=ERROR -log4j.logger.org.apache.spark.repl.SparkIMain$exprTyper=INFO -log4j.logger.org.apache.spark.repl.SparkILoop$SparkILoopInterpreter=INFO diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/external/kinesis-asl/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/external/kinesis-asl/src/test/resources/log4j.properties deleted file mode 100644 index 001d0482aca..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/external/kinesis-asl/src/test/resources/log4j.properties +++ /dev/null @@ -1,27 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file target/unit-tests.log -log4j.rootCategory=INFO, file -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Ignore messages below warning level from Jetty, because it's a bit verbose -log4j.logger.org.spark_project.jetty=WARN diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/graphx/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/graphx/src/test/resources/log4j.properties deleted file mode 100644 index 001d0482aca..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/graphx/src/test/resources/log4j.properties +++ /dev/null @@ -1,27 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file target/unit-tests.log -log4j.rootCategory=INFO, file -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Ignore messages below warning level from Jetty, because it's a bit verbose -log4j.logger.org.spark_project.jetty=WARN diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/launcher/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/launcher/src/test/resources/log4j.properties deleted file mode 100644 index 3e7f668307e..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/launcher/src/test/resources/log4j.properties +++ /dev/null @@ -1,33 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file core/target/unit-tests.log -test.appender=file -log4j.rootCategory=INFO, ${test.appender} -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=false -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -log4j.appender.childproc=org.apache.log4j.ConsoleAppender -log4j.appender.childproc.target=System.err -log4j.appender.childproc.layout=org.apache.log4j.PatternLayout -log4j.appender.childproc.layout.ConversionPattern=%t: %m%n - -# Ignore messages below warning level from Jetty, because it's a bit verbose -log4j.logger.org.spark_project.jetty=WARN diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/mllib/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/mllib/src/test/resources/log4j.properties deleted file mode 100644 index 001d0482aca..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/mllib/src/test/resources/log4j.properties +++ /dev/null @@ -1,27 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file target/unit-tests.log -log4j.rootCategory=INFO, file -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Ignore messages below warning level from Jetty, because it's a bit verbose -log4j.logger.org.spark_project.jetty=WARN diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/repl/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/repl/src/test/resources/log4j.properties deleted file mode 100644 index 2472d7dd173..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/repl/src/test/resources/log4j.properties +++ /dev/null @@ -1,27 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the target/unit-tests.log -log4j.rootCategory=INFO, file -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Ignore messages below warning level from Jetty, because it's a bit verbose -log4j.logger.org.spark_project.jetty=WARN diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/sql/catalyst/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/sql/catalyst/src/test/resources/log4j.properties deleted file mode 100644 index 001d0482aca..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/sql/catalyst/src/test/resources/log4j.properties +++ /dev/null @@ -1,27 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file target/unit-tests.log -log4j.rootCategory=INFO, file -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Ignore messages below warning level from Jetty, because it's a bit verbose -log4j.logger.org.spark_project.jetty=WARN diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/sql/core/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/sql/core/src/test/resources/log4j.properties deleted file mode 100644 index c216bec215d..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/sql/core/src/test/resources/log4j.properties +++ /dev/null @@ -1,57 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file core/target/unit-tests.log -log4j.rootLogger=INFO, CA, FA - -#Console Appender -log4j.appender.CA=org.apache.log4j.ConsoleAppender -log4j.appender.CA.layout=org.apache.log4j.PatternLayout -log4j.appender.CA.layout.ConversionPattern=%d{HH:mm:ss.SSS} %p %c: %m%n -log4j.appender.CA.Threshold = WARN -log4j.appender.CA.follow = true - - -#File Appender -log4j.appender.FA=org.apache.log4j.FileAppender -log4j.appender.FA.append=false -log4j.appender.FA.file=target/unit-tests.log -log4j.appender.FA.layout=org.apache.log4j.PatternLayout -log4j.appender.FA.layout.ConversionPattern=%d{HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Set the logger level of File Appender to WARN -log4j.appender.FA.Threshold = INFO - -# Some packages are noisy for no good reason. -log4j.additivity.org.apache.parquet.hadoop.ParquetRecordReader=false -log4j.logger.org.apache.parquet.hadoop.ParquetRecordReader=OFF - -log4j.additivity.org.apache.parquet.hadoop.ParquetOutputCommitter=false -log4j.logger.org.apache.parquet.hadoop.ParquetOutputCommitter=OFF - -log4j.additivity.org.apache.hadoop.hive.serde2.lazy.LazyStruct=false -log4j.logger.org.apache.hadoop.hive.serde2.lazy.LazyStruct=OFF - -log4j.additivity.org.apache.hadoop.hive.metastore.RetryingHMSHandler=false -log4j.logger.org.apache.hadoop.hive.metastore.RetryingHMSHandler=OFF - -log4j.additivity.hive.ql.metadata.Hive=false -log4j.logger.hive.ql.metadata.Hive=OFF - -# Parquet related logging -log4j.logger.org.apache.parquet.hadoop=WARN -log4j.logger.org.apache.spark.sql.parquet=INFO diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/sql/hive/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/sql/hive/src/test/resources/log4j.properties deleted file mode 100644 index 4f31a6aca58..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/sql/hive/src/test/resources/log4j.properties +++ /dev/null @@ -1,61 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file core/target/unit-tests.log -log4j.rootLogger=DEBUG, CA, FA - -#Console Appender -log4j.appender.CA=org.apache.log4j.ConsoleAppender -log4j.appender.CA.layout=org.apache.log4j.PatternLayout -log4j.appender.CA.layout.ConversionPattern=%d{HH:mm:ss.SSS} %p %c: %m%n -log4j.appender.CA.Threshold = WARN - - -#File Appender -log4j.appender.FA=org.apache.log4j.FileAppender -log4j.appender.FA.append=false -log4j.appender.FA.file=target/unit-tests.log -log4j.appender.FA.layout=org.apache.log4j.PatternLayout -log4j.appender.FA.layout.ConversionPattern=%d{HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Set the logger level of File Appender to WARN -log4j.appender.FA.Threshold = DEBUG - -# Some packages are noisy for no good reason. -log4j.additivity.org.apache.hadoop.hive.serde2.lazy.LazyStruct=false -log4j.logger.org.apache.hadoop.hive.serde2.lazy.LazyStruct=OFF - -log4j.additivity.org.apache.hadoop.hive.metastore.RetryingHMSHandler=false -log4j.logger.org.apache.hadoop.hive.metastore.RetryingHMSHandler=OFF - -log4j.additivity.hive.log=false -log4j.logger.hive.log=OFF - -log4j.additivity.parquet.hadoop.ParquetRecordReader=false -log4j.logger.parquet.hadoop.ParquetRecordReader=OFF - -log4j.additivity.org.apache.parquet.hadoop.ParquetRecordReader=false -log4j.logger.org.apache.parquet.hadoop.ParquetRecordReader=OFF - -log4j.additivity.org.apache.parquet.hadoop.ParquetOutputCommitter=false -log4j.logger.org.apache.parquet.hadoop.ParquetOutputCommitter=OFF - -log4j.additivity.hive.ql.metadata.Hive=false -log4j.logger.hive.ql.metadata.Hive=OFF - -log4j.additivity.org.apache.hadoop.hive.ql.io.RCFile=false -log4j.logger.org.apache.hadoop.hive.ql.io.RCFile=ERROR diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/streaming/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/streaming/src/test/resources/log4j.properties deleted file mode 100644 index 001d0482aca..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/streaming/src/test/resources/log4j.properties +++ /dev/null @@ -1,27 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file target/unit-tests.log -log4j.rootCategory=INFO, file -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Ignore messages below warning level from Jetty, because it's a bit verbose -log4j.logger.org.spark_project.jetty=WARN diff --git a/log4j-1.2-api/src/test/resources/config-1.2/spark/yarn/src/test/resources/log4j.properties b/log4j-1.2-api/src/test/resources/config-1.2/spark/yarn/src/test/resources/log4j.properties deleted file mode 100644 index 29ec90539be..00000000000 --- a/log4j-1.2-api/src/test/resources/config-1.2/spark/yarn/src/test/resources/log4j.properties +++ /dev/null @@ -1,31 +0,0 @@ -# -# 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. -# - -# Set everything to be logged to the file target/unit-tests.log -log4j.rootCategory=DEBUG, file -log4j.appender.file=org.apache.log4j.FileAppender -log4j.appender.file.append=true -log4j.appender.file.file=target/unit-tests.log -log4j.appender.file.layout=org.apache.log4j.PatternLayout -log4j.appender.file.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss.SSS} %t %p %c{1}: %m%n - -# Ignore messages below warning level from a few verbose libraries. -log4j.logger.com.sun.jersey=WARN -log4j.logger.org.apache.hadoop=WARN -log4j.logger.org.eclipse.jetty=WARN -log4j.logger.org.mortbay=WARN -log4j.logger.org.spark_project.jetty=WARN diff --git a/log4j-core-test/src/test/java/org/apache/logging/log4j/core/tools/GenerateCustomLoggerTest.java b/log4j-core-test/src/test/java/org/apache/logging/log4j/core/tools/GenerateCustomLoggerTest.java deleted file mode 100644 index 5932d113faf..00000000000 --- a/log4j-core-test/src/test/java/org/apache/logging/log4j/core/tools/GenerateCustomLoggerTest.java +++ /dev/null @@ -1,181 +0,0 @@ -/* - * 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.logging.log4j.core.tools; - -import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertTrue; - -import java.io.File; -import java.io.FileOutputStream; -import java.lang.reflect.Method; -import java.lang.reflect.Modifier; -import java.nio.charset.Charset; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.List; -import java.util.Locale; -import javax.tools.Diagnostic; -import javax.tools.DiagnosticCollector; -import javax.tools.JavaCompiler; -import javax.tools.JavaFileObject; -import javax.tools.StandardJavaFileManager; -import javax.tools.ToolProvider; -import org.apache.logging.log4j.LogManager; -import org.apache.logging.log4j.Marker; -import org.apache.logging.log4j.core.test.TestConstants; -import org.apache.logging.log4j.message.Message; -import org.apache.logging.log4j.message.MessageFactory; -import org.apache.logging.log4j.test.TestLogger; -import org.apache.logging.log4j.util.MessageSupplier; -import org.apache.logging.log4j.util.Strings; -import org.apache.logging.log4j.util.Supplier; -import org.junit.jupiter.api.AfterAll; -import org.junit.jupiter.api.Tag; -import org.junit.jupiter.api.Test; -import org.junitpioneer.jupiter.SetSystemProperty; - -@Tag("functional") -@SetSystemProperty( - key = TestConstants.LOGGER_CONTEXT_FACTORY, - value = "org.apache.logging.log4j.test.TestLoggerContextFactory") -public class GenerateCustomLoggerTest { - - private static final String TEST_SOURCE = "target/test-classes/org/apache/logging/log4j/core/MyCustomLogger.java"; - - @AfterAll - public static void afterClass() { - File file = new File(TEST_SOURCE); - final File parent = file.getParentFile(); - if (file.exists()) { - file.delete(); - } - file = new File(parent, "MyCustomLogger.class"); - if (file.exists()) { - file.delete(); - } - } - - @Test - @SuppressWarnings("ReturnValueIgnored") - public void testGenerateSource() throws Exception { - final String CLASSNAME = "org.apache.logging.log4j.core.MyCustomLogger"; - - // generate custom logger source - final List values = Arrays.asList("DEFCON1=350 DEFCON2=450 DEFCON3=550".split(" ")); - final List levels = Generate.LevelInfo.parse(values, Generate.CustomLogger.class); - final String src = Generate.generateSource(CLASSNAME, levels, Generate.Type.CUSTOM); - final File f = new File(TEST_SOURCE); - f.getParentFile().mkdirs(); - try (final FileOutputStream out = new FileOutputStream(f)) { - out.write(src.getBytes(Charset.defaultCharset())); - } - - // set up compiler - final JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); - final DiagnosticCollector diagnostics = new DiagnosticCollector<>(); - final List errors = new ArrayList<>(); - try (final StandardJavaFileManager fileManager = compiler.getStandardFileManager(diagnostics, null, null)) { - final Iterable compilationUnits = - fileManager.getJavaFileObjectsFromFiles(Collections.singletonList(f)); - final String classPath = System.getProperty("jdk.module.path"); - final List optionList = new ArrayList<>(); - if (Strings.isNotBlank(classPath)) { - optionList.add("-classpath"); - optionList.add(classPath); - } - // compile generated source - compiler.getTask(null, fileManager, diagnostics, optionList, null, compilationUnits) - .call(); - - // check we don't have any compilation errors - for (final Diagnostic diagnostic : diagnostics.getDiagnostics()) { - if (diagnostic.getKind() == Diagnostic.Kind.ERROR) { - errors.add(String.format("Compile error: %s%n", diagnostic.getMessage(Locale.getDefault()))); - } - } - } - assertTrue(errors.isEmpty(), errors.toString()); - - // load the compiled class - final Class cls = Class.forName(CLASSNAME); - - // check that all factory methods exist and are static - assertTrue(Modifier.isStatic(cls.getDeclaredMethod("create").getModifiers())); - assertTrue( - Modifier.isStatic(cls.getDeclaredMethod("create", Class.class).getModifiers())); - assertTrue( - Modifier.isStatic(cls.getDeclaredMethod("create", Object.class).getModifiers())); - assertTrue( - Modifier.isStatic(cls.getDeclaredMethod("create", String.class).getModifiers())); - assertTrue(Modifier.isStatic(cls.getDeclaredMethod("create", Class.class, MessageFactory.class) - .getModifiers())); - assertTrue(Modifier.isStatic(cls.getDeclaredMethod("create", Object.class, MessageFactory.class) - .getModifiers())); - assertTrue(Modifier.isStatic(cls.getDeclaredMethod("create", String.class, MessageFactory.class) - .getModifiers())); - - // check that all log methods exist - final String[] logMethods = {"defcon1", "defcon2", "defcon3"}; - for (final String name : logMethods) { - assertDoesNotThrow(() -> { - cls.getDeclaredMethod(name, Marker.class, Message.class, Throwable.class); - cls.getDeclaredMethod(name, Marker.class, Object.class, Throwable.class); - cls.getDeclaredMethod(name, Marker.class, String.class, Throwable.class); - cls.getDeclaredMethod(name, Marker.class, Message.class); - cls.getDeclaredMethod(name, Marker.class, Object.class); - cls.getDeclaredMethod(name, Marker.class, String.class); - cls.getDeclaredMethod(name, Message.class); - cls.getDeclaredMethod(name, Object.class); - cls.getDeclaredMethod(name, String.class); - cls.getDeclaredMethod(name, Message.class, Throwable.class); - cls.getDeclaredMethod(name, Object.class, Throwable.class); - cls.getDeclaredMethod(name, String.class, Throwable.class); - cls.getDeclaredMethod(name, String.class, Object[].class); - cls.getDeclaredMethod(name, Marker.class, String.class, Object[].class); - - // 2.4 lambda support - cls.getDeclaredMethod(name, Marker.class, MessageSupplier.class); - cls.getDeclaredMethod(name, Marker.class, MessageSupplier.class, Throwable.class); - cls.getDeclaredMethod(name, Marker.class, String.class, Supplier[].class); - cls.getDeclaredMethod(name, Marker.class, Supplier.class); - cls.getDeclaredMethod(name, Marker.class, Supplier.class, Throwable.class); - cls.getDeclaredMethod(name, MessageSupplier.class); - cls.getDeclaredMethod(name, MessageSupplier.class, Throwable.class); - cls.getDeclaredMethod(name, String.class, Supplier[].class); - cls.getDeclaredMethod(name, Supplier.class); - cls.getDeclaredMethod(name, Supplier.class, Throwable.class); - }); - } - - // now see if it actually works... - final Method create = cls.getDeclaredMethod("create", String.class); - final Object customLogger = create.invoke(null, "X.Y.Z"); - int n = 0; - for (final String name : logMethods) { - final Method method = cls.getDeclaredMethod(name, String.class); - method.invoke(customLogger, "This is message " + n++); - } - - final TestLogger underlying = (TestLogger) LogManager.getLogger("X.Y.Z"); - final List lines = underlying.getEntries(); - for (int i = 0; i < lines.size(); i++) { - assertEquals(" " + levels.get(i).name + " This is message " + i, lines.get(i)); - } - } -} diff --git a/log4j-core-test/src/test/java/org/apache/logging/log4j/core/tools/GenerateExtendedLoggerTest.java b/log4j-core-test/src/test/java/org/apache/logging/log4j/core/tools/GenerateExtendedLoggerTest.java deleted file mode 100644 index cb8f49afbf4..00000000000 --- a/log4j-core-test/src/test/java/org/apache/logging/log4j/core/tools/GenerateExtendedLoggerTest.java +++ /dev/null @@ -1,200 +0,0 @@ -/* - * 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.logging.log4j.core.tools; - -import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertTrue; - -import java.io.File; -import java.io.FileOutputStream; -import java.lang.reflect.Method; -import java.lang.reflect.Modifier; -import java.nio.charset.Charset; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.List; -import java.util.Locale; -import javax.tools.Diagnostic; -import javax.tools.DiagnosticCollector; -import javax.tools.JavaCompiler; -import javax.tools.JavaFileObject; -import javax.tools.StandardJavaFileManager; -import javax.tools.ToolProvider; -import org.apache.logging.log4j.LogManager; -import org.apache.logging.log4j.Marker; -import org.apache.logging.log4j.core.test.TestConstants; -import org.apache.logging.log4j.message.Message; -import org.apache.logging.log4j.message.MessageFactory; -import org.apache.logging.log4j.spi.ExtendedLogger; -import org.apache.logging.log4j.test.TestLogger; -import org.apache.logging.log4j.util.MessageSupplier; -import org.apache.logging.log4j.util.Strings; -import org.apache.logging.log4j.util.Supplier; -import org.junit.jupiter.api.AfterAll; -import org.junit.jupiter.api.Tag; -import org.junit.jupiter.api.Test; -import org.junitpioneer.jupiter.SetSystemProperty; - -@Tag("functional") -@SetSystemProperty( - key = TestConstants.LOGGER_CONTEXT_FACTORY, - value = "org.apache.logging.log4j.test.TestLoggerContextFactory") -public class GenerateExtendedLoggerTest { - - private static final String TEST_SOURCE = "target/test-classes/org/apache/logging/log4j/core/MyExtendedLogger.java"; - - @AfterAll - public static void afterClass() { - File file = new File(TEST_SOURCE); - final File parent = file.getParentFile(); - if (file.exists()) { - file.delete(); - } - file = new File(parent, "MyExtendedLogger.class"); - if (file.exists()) { - file.delete(); - } - } - - @Test - @SuppressWarnings("ReturnValueIgnored") - public void testGenerateSource() throws Exception { - final String CLASSNAME = "org.apache.logging.log4j.core.MyExtendedLogger"; - - // generate custom logger source - final List values = Arrays.asList("DIAG=350 NOTICE=450 VERBOSE=550".split(" ")); - final List levels = Generate.LevelInfo.parse(values, Generate.ExtendedLogger.class); - final String src = Generate.generateSource(CLASSNAME, levels, Generate.Type.EXTEND); - final File f = new File(TEST_SOURCE); - f.getParentFile().mkdirs(); - try (final FileOutputStream out = new FileOutputStream(f)) { - out.write(src.getBytes(Charset.defaultCharset())); - } - - final JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); - final DiagnosticCollector diagnostics = new DiagnosticCollector<>(); - final List errors = new ArrayList<>(); - try (final StandardJavaFileManager fileManager = compiler.getStandardFileManager(diagnostics, null, null)) { - final Iterable compilationUnits = - fileManager.getJavaFileObjectsFromFiles(Collections.singletonList(f)); - final String classPath = System.getProperty("jdk.module.path"); - final List optionList = new ArrayList<>(); - if (Strings.isNotBlank(classPath)) { - optionList.add("-classpath"); - optionList.add(classPath); - } - // compile generated source - compiler.getTask(null, fileManager, diagnostics, optionList, null, compilationUnits) - .call(); - - // check we don't have any compilation errors - for (final Diagnostic diagnostic : diagnostics.getDiagnostics()) { - if (diagnostic.getKind() == Diagnostic.Kind.ERROR) { - errors.add(String.format("Compile error: %s%n", diagnostic.getMessage(Locale.getDefault()))); - } - } - } - assertTrue(errors.isEmpty(), errors.toString()); - - // load the compiled class - final Class cls = Class.forName(CLASSNAME); - - // check that all factory methods exist and are static - assertTrue(Modifier.isStatic(cls.getDeclaredMethod("create").getModifiers())); - assertTrue( - Modifier.isStatic(cls.getDeclaredMethod("create", Class.class).getModifiers())); - assertTrue( - Modifier.isStatic(cls.getDeclaredMethod("create", Object.class).getModifiers())); - assertTrue( - Modifier.isStatic(cls.getDeclaredMethod("create", String.class).getModifiers())); - assertTrue(Modifier.isStatic(cls.getDeclaredMethod("create", Class.class, MessageFactory.class) - .getModifiers())); - assertTrue(Modifier.isStatic(cls.getDeclaredMethod("create", Object.class, MessageFactory.class) - .getModifiers())); - assertTrue(Modifier.isStatic(cls.getDeclaredMethod("create", String.class, MessageFactory.class) - .getModifiers())); - - // check that the extended log methods exist - final String[] extendedMethods = {"diag", "notice", "verbose"}; - for (final String name : extendedMethods) { - assertDoesNotThrow(() -> { - cls.getDeclaredMethod(name, Marker.class, Message.class, Throwable.class); - cls.getDeclaredMethod(name, Marker.class, Object.class, Throwable.class); - cls.getDeclaredMethod(name, Marker.class, String.class, Throwable.class); - cls.getDeclaredMethod(name, Marker.class, Message.class); - cls.getDeclaredMethod(name, Marker.class, Object.class); - cls.getDeclaredMethod(name, Marker.class, String.class); - cls.getDeclaredMethod(name, Message.class); - cls.getDeclaredMethod(name, Object.class); - cls.getDeclaredMethod(name, String.class); - cls.getDeclaredMethod(name, Message.class, Throwable.class); - cls.getDeclaredMethod(name, Object.class, Throwable.class); - cls.getDeclaredMethod(name, String.class, Throwable.class); - cls.getDeclaredMethod(name, String.class, Object[].class); - cls.getDeclaredMethod(name, Marker.class, String.class, Object[].class); - - // 2.4 lambda support - cls.getDeclaredMethod(name, Marker.class, MessageSupplier.class); - cls.getDeclaredMethod(name, Marker.class, MessageSupplier.class, Throwable.class); - cls.getDeclaredMethod(name, Marker.class, String.class, Supplier[].class); - cls.getDeclaredMethod(name, Marker.class, Supplier.class); - cls.getDeclaredMethod(name, Marker.class, Supplier.class, Throwable.class); - cls.getDeclaredMethod(name, MessageSupplier.class); - cls.getDeclaredMethod(name, MessageSupplier.class, Throwable.class); - cls.getDeclaredMethod(name, String.class, Supplier[].class); - cls.getDeclaredMethod(name, Supplier.class); - cls.getDeclaredMethod(name, Supplier.class, Throwable.class); - }); - } - - // now see if it actually works... - final Method create = cls.getDeclaredMethod("create", String.class); - final Object extendedLogger = create.invoke(null, "X.Y.Z"); - int n = 0; - for (final String name : extendedMethods) { - final Method method = cls.getDeclaredMethod(name, String.class); - method.invoke(extendedLogger, "This is message " + n++); - } - - // This logger extends o.a.l.log4j.spi.ExtendedLogger, - // so all the standard logging methods can be used as well - final ExtendedLogger logger = (ExtendedLogger) extendedLogger; - logger.trace("trace message"); - logger.debug("debug message"); - logger.info("info message"); - logger.warn("warn message"); - logger.error("error message"); - logger.fatal("fatal message"); - - final TestLogger underlying = (TestLogger) LogManager.getLogger("X.Y.Z"); - final List lines = underlying.getEntries(); - for (int i = 0; i < lines.size() - 6; i++) { - assertEquals(" " + levels.get(i).name + " This is message " + i, lines.get(i)); - } - - // test that the standard logging methods still work - int i = lines.size() - 6; - assertEquals(" TRACE trace message", lines.get(i++)); - assertEquals(" DEBUG debug message", lines.get(i++)); - assertEquals(" INFO info message", lines.get(i++)); - assertEquals(" WARN warn message", lines.get(i++)); - assertEquals(" ERROR error message", lines.get(i++)); - assertEquals(" FATAL fatal message", lines.get(i++)); - } -} diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/BasicCommandLineArguments.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/BasicCommandLineArguments.java deleted file mode 100644 index bacc03f61cf..00000000000 --- a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/BasicCommandLineArguments.java +++ /dev/null @@ -1,36 +0,0 @@ -/* - * 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.logging.log4j.core.tools; - -import org.apache.logging.log4j.core.tools.picocli.CommandLine.Option; - -public class BasicCommandLineArguments { - - @Option( - names = {"--help", "-?", "-h"}, - usageHelp = true, - description = "Prints this help and exits.") - private boolean help; - - public boolean isHelp() { - return help; - } - - public void setHelp(final boolean help) { - this.help = help; - } -} diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/CustomLoggerGenerator.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/CustomLoggerGenerator.java deleted file mode 100644 index 8f611167508..00000000000 --- a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/CustomLoggerGenerator.java +++ /dev/null @@ -1,30 +0,0 @@ -/* - * 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.logging.log4j.core.tools; - -/** - * Wrapper around {@link Generate.CustomLogger}. - */ -public class CustomLoggerGenerator { - /** - * Delegates to {@link Generate.CustomLogger#main(String[])} - * @param args the command line arguments to pass on - */ - public static void main(final String[] args) { - Generate.CustomLogger.main(args); - } -} diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/ExtendedLoggerGenerator.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/ExtendedLoggerGenerator.java deleted file mode 100644 index 339f9cc192e..00000000000 --- a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/ExtendedLoggerGenerator.java +++ /dev/null @@ -1,30 +0,0 @@ -/* - * 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.logging.log4j.core.tools; - -/** - * Wrapper around {@link Generate.ExtendedLogger}. - */ -public class ExtendedLoggerGenerator { - /** - * Delegates to {@link Generate.ExtendedLogger#main(String[])} - * @param args the command line arguments to pass on - */ - public static void main(final String[] args) { - Generate.ExtendedLogger.main(args); - } -} diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/Generate.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/Generate.java deleted file mode 100644 index 5c3d34e85fc..00000000000 --- a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/Generate.java +++ /dev/null @@ -1,1165 +0,0 @@ -/* - * 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.logging.log4j.core.tools; - -import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; -import java.io.PrintStream; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; - -/** - * Generates source code for custom or extended logger wrappers. - *

- * Usage: - *

- * To generate source code for an extended logger that adds custom log levels to the existing ones:
- * {@code java org.apache.logging.log4j.core.tools.Generate$ExtendedLogger = - * [CUSTOMLEVEL2=WEIGHT2 [CUSTOMLEVEL3=WEIGHT3] ...]} - *

- * Example of creating an extended logger:
- * {@code java org.apache.logging.log4j.core.tools.Generate$ExtendedLogger com.mycomp.ExtLogger DIAG=350 NOTICE=450 - * VERBOSE=550} - *

- * To generate source code for a custom logger that replaces the existing log levels with custom ones:
- * {@code java org.apache.logging.log4j.core.tools.Generate$CustomLogger = - * [CUSTOMLEVEL2=WEIGHT2 [CUSTOMLEVEL3=WEIGHT3] ...]} - *

- * Example of creating a custom logger:
- * {@code java org.apache.logging.log4j.core.tools.Generate$CustomLogger com.mycomp.MyLogger DEFCON1=350 DEFCON2=450 - * DEFCON3=550} - */ -public final class Generate { - // Implementation note: - // The generated code is in the user's namespace which has its own versioning scheme, so - // any @since tags in the generated code deliberately mention "Log4j-2.x" rather than just the log4j version number. - - static final String PACKAGE_DECLARATION = "package %s;%n%n"; - - enum Type { - CUSTOM { - @Override - String imports() { - // @formatter:off - return "" - + "import org.apache.logging.log4j.Level;%n" - + "import org.apache.logging.log4j.LogManager;%n" - + "import org.apache.logging.log4j.Logger;%n" - + "import org.apache.logging.log4j.Marker;%n" - + "import org.apache.logging.log4j.message.Message;%n" - + "import org.apache.logging.log4j.message.MessageFactory;%n" - + "import org.apache.logging.log4j.spi.ExtendedLogger;%n" - + "import org.apache.logging.log4j.spi.ExtendedLoggerWrapper;%n" - + "import org.apache.logging.log4j.util.MessageSupplier;%n" - + "import org.apache.logging.log4j.util.Supplier;%n" - + "%n"; - // @formatter:on - } - - @Override - String declaration() { - // @formatter:off - return "" - + "/**%n" - + " * Custom Logger interface with convenience methods for%n" - + " * %s%n" - + " *

Compatible with Log4j 2.6 or higher.

%n" - + " */%n" - + "public final class %s {%n" - + " private final ExtendedLoggerWrapper logger;%n" - + "%n"; - // @formatter:on - } - - @Override - String constructor() { - // @formatter:off - return "" - + "%n" - + " private %s(final Logger logger) {%n" - + " this.logger = new ExtendedLoggerWrapper((ExtendedLogger) logger, logger.getName(), " - + "logger.getMessageFactory());%n" - + " }%n"; - // @formatter:on - } - - @Override - Class generator() { - return CustomLogger.class; - } - }, - EXTEND { - @Override - String imports() { - // @formatter:off - return "" - + "import org.apache.logging.log4j.Level;%n" - + "import org.apache.logging.log4j.LogManager;%n" - + "import org.apache.logging.log4j.Logger;%n" - + "import org.apache.logging.log4j.Marker;%n" - + "import org.apache.logging.log4j.message.Message;%n" - + "import org.apache.logging.log4j.message.MessageFactory;%n" - + "import org.apache.logging.log4j.spi.ExtendedLogger;%n" - + "import org.apache.logging.log4j.spi.ExtendedLoggerWrapper;%n" - + "import org.apache.logging.log4j.util.MessageSupplier;%n" - + "import org.apache.logging.log4j.util.Supplier;%n" - + "%n"; - // @formatter:on - } - - @Override - String declaration() { - // @formatter:off - return "" - + "/**%n" - + " * Extended Logger interface with convenience methods for%n" - + " * %s%n" - + " *

Compatible with Log4j 2.6 or higher.

%n" - + " */%n" - + "public final class %s extends ExtendedLoggerWrapper {%n" - + " private static final long serialVersionUID = " + System.nanoTime() + "L;%n" - + " private final ExtendedLoggerWrapper logger;%n" - + "%n"; - // @formatter:on - } - - @Override - String constructor() { - // @formatter:off - return "" - + "%n" - + " private %s(final Logger logger) {%n" - + " super((ExtendedLogger) logger, logger.getName(), logger.getMessageFactory());%n" - + " this.logger = this;%n" - + " }%n"; - // @formatter:on - } - - @Override - Class generator() { - return ExtendedLogger.class; - } - }; - - abstract String imports(); - - abstract String declaration(); - - abstract String constructor(); - - abstract Class generator(); - } - - static final String FQCN_FIELD = "" + " private static final String FQCN = %s.class.getName();%n"; - - static final String LEVEL_FIELD = "" + " private static final Level %s = Level.forName(\"%s\", %d);%n"; - - static final String FACTORY_METHODS = "" - // @formatter:off - + "%n" - + " /**%n" - + " * Returns a custom Logger with the name of the calling class.%n" - + " * %n" - + " * @return The custom Logger for the calling class.%n" - + " */%n" - + " public static CLASSNAME create() {%n" - + " final Logger wrapped = LogManager.getLogger();%n" - + " return new CLASSNAME(wrapped);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Returns a custom Logger using the fully qualified name of the Class as%n" - + " * the Logger name.%n" - + " * %n" - + " * @param loggerName The Class whose name should be used as the Logger name.%n" - + " * If null it will default to the calling class.%n" - + " * @return The custom Logger.%n" - + " */%n" - + " public static CLASSNAME create(final Class loggerName) {%n" - + " final Logger wrapped = LogManager.getLogger(loggerName);%n" - + " return new CLASSNAME(wrapped);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Returns a custom Logger using the fully qualified name of the Class as%n" - + " * the Logger name.%n" - + " * %n" - + " * @param loggerName The Class whose name should be used as the Logger name.%n" - + " * If null it will default to the calling class.%n" - + " * @param messageFactory The message factory is used only when creating a%n" - + " * logger, subsequent use does not change the logger but will log%n" - + " * a warning if mismatched.%n" - + " * @return The custom Logger.%n" - + " */%n" - + " public static CLASSNAME create(final Class loggerName, final MessageFactory" - + " messageFactory) {%n" - + " final Logger wrapped = LogManager.getLogger(loggerName, messageFactory);%n" - + " return new CLASSNAME(wrapped);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Returns a custom Logger using the fully qualified class name of the value%n" - + " * as the Logger name.%n" - + " * %n" - + " * @param value The value whose class name should be used as the Logger%n" - + " * name. If null the name of the calling class will be used as%n" - + " * the logger name.%n" - + " * @return The custom Logger.%n" - + " */%n" - + " public static CLASSNAME create(final Object value) {%n" - + " final Logger wrapped = LogManager.getLogger(value);%n" - + " return new CLASSNAME(wrapped);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Returns a custom Logger using the fully qualified class name of the value%n" - + " * as the Logger name.%n" - + " * %n" - + " * @param value The value whose class name should be used as the Logger%n" - + " * name. If null the name of the calling class will be used as%n" - + " * the logger name.%n" - + " * @param messageFactory The message factory is used only when creating a%n" - + " * logger, subsequent use does not change the logger but will log%n" - + " * a warning if mismatched.%n" - + " * @return The custom Logger.%n" - + " */%n" - + " public static CLASSNAME create(final Object value, final MessageFactory messageFactory) {%n" - + " final Logger wrapped = LogManager.getLogger(value, messageFactory);%n" - + " return new CLASSNAME(wrapped);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Returns a custom Logger with the specified name.%n" - + " * %n" - + " * @param name The logger name. If null the name of the calling class will%n" - + " * be used.%n" - + " * @return The custom Logger.%n" - + " */%n" - + " public static CLASSNAME create(final String name) {%n" - + " final Logger wrapped = LogManager.getLogger(name);%n" - + " return new CLASSNAME(wrapped);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Returns a custom Logger with the specified name.%n" - + " * %n" - + " * @param name The logger name. If null the name of the calling class will%n" - + " * be used.%n" - + " * @param messageFactory The message factory is used only when creating a%n" - + " * logger, subsequent use does not change the logger but will log%n" - + " * a warning if mismatched.%n" - + " * @return The custom Logger.%n" - + " */%n" - + " public static CLASSNAME create(final String name, final MessageFactory messageFactory) {%n" - + " final Logger wrapped = LogManager.getLogger(name, messageFactory);%n" - + " return new CLASSNAME(wrapped);%n" - + " }%n"; - // @formatter:on - - static final String METHODS = "" - // @formatter:off - + "%n" - + " /**%n" - + " * Logs a message with the specific Marker at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param msg the message string to be logged%n" - + " */%n" - + " public void methodName(final Marker marker, final Message msg) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, msg, (Throwable) null);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with the specific Marker at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param msg the message string to be logged%n" - + " * @param t A Throwable or null.%n" - + " */%n" - + " public void methodName(final Marker marker, final Message msg, final Throwable t) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, msg, t);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message object with the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message object to log.%n" - + " */%n" - + " public void methodName(final Marker marker, final Object message) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, (Throwable) null);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message CharSequence with the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message CharSequence to log.%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final Marker marker, final CharSequence message) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, (Throwable) null);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message at the {@code CUSTOM_LEVEL} level including the stack trace of%n" - + " * the {@link Throwable} {@code t} passed as parameter.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message to log.%n" - + " * @param t the exception to log, including its stack trace.%n" - + " */%n" - + " public void methodName(final Marker marker, final Object message, final Throwable t) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, t);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message at the {@code CUSTOM_LEVEL} level including the stack trace of%n" - + " * the {@link Throwable} {@code t} passed as parameter.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the CharSequence to log.%n" - + " * @param t the exception to log, including its stack trace.%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final Marker marker, final CharSequence message, final Throwable t) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, t);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message object with the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message object to log.%n" - + " */%n" - + " public void methodName(final Marker marker, final String message) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, (Throwable) null);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param params parameters to the message.%n" - + " * @see #getMessageFactory()%n" - + " */%n" - + " public void methodName(final Marker marker, final String message, final Object... params) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, params);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final Marker marker, final String message, final Object p0) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, p0);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final Marker marker, final String message, final Object p0, " - + "final Object p1) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, p0, p1);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final Marker marker, final String message, final Object p0, " - + "final Object p1, final Object p2) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, p0, p1, p2);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @param p3 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final Marker marker, final String message, final Object p0, " - + "final Object p1, final Object p2,%n" - + " final Object p3) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, p0, p1, p2, p3);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @param p3 parameter to the message.%n" - + " * @param p4 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final Marker marker, final String message, final Object p0, " - + "final Object p1, final Object p2,%n" - + " final Object p3, final Object p4) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, p0, p1, p2, p3, p4);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @param p3 parameter to the message.%n" - + " * @param p4 parameter to the message.%n" - + " * @param p5 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final Marker marker, final String message, final Object p0, " - + "final Object p1, final Object p2,%n" - + " final Object p3, final Object p4, final Object p5) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, p0, p1, p2, p3, p4, p5);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @param p3 parameter to the message.%n" - + " * @param p4 parameter to the message.%n" - + " * @param p5 parameter to the message.%n" - + " * @param p6 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final Marker marker, final String message, final Object p0, " - + "final Object p1, final Object p2,%n" - + " final Object p3, final Object p4, final Object p5, final Object p6) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, p0, p1, p2, p3, p4, p5, p6);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @param p3 parameter to the message.%n" - + " * @param p4 parameter to the message.%n" - + " * @param p5 parameter to the message.%n" - + " * @param p6 parameter to the message.%n" - + " * @param p7 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final Marker marker, final String message, final Object p0, " - + "final Object p1, final Object p2,%n" - + " final Object p3, final Object p4, final Object p5, final Object p6,%n" - + " final Object p7) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, p0, p1, p2, p3, p4, p5, p6, p7);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @param p3 parameter to the message.%n" - + " * @param p4 parameter to the message.%n" - + " * @param p5 parameter to the message.%n" - + " * @param p6 parameter to the message.%n" - + " * @param p7 parameter to the message.%n" - + " * @param p8 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final Marker marker, final String message, final Object p0, " - + "final Object p1, final Object p2,%n" - + " final Object p3, final Object p4, final Object p5, final Object p6,%n" - + " final Object p7, final Object p8) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, p0, p1, p2, p3, p4, p5, p6, p7, " - + "p8);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @param p3 parameter to the message.%n" - + " * @param p4 parameter to the message.%n" - + " * @param p5 parameter to the message.%n" - + " * @param p6 parameter to the message.%n" - + " * @param p7 parameter to the message.%n" - + " * @param p8 parameter to the message.%n" - + " * @param p9 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final Marker marker, final String message, final Object p0, " - + "final Object p1, final Object p2,%n" - + " final Object p3, final Object p4, final Object p5, final Object p6,%n" - + " final Object p7, final Object p8, final Object p9) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, p0, p1, p2, p3, p4, p5, p6, p7, " - + "p8, p9);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message at the {@code CUSTOM_LEVEL} level including the stack trace of%n" - + " * the {@link Throwable} {@code t} passed as parameter.%n" - + " * %n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message to log.%n" - + " * @param t the exception to log, including its stack trace.%n" - + " */%n" - + " public void methodName(final Marker marker, final String message, final Throwable t) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, t);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs the specified Message at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param msg the message string to be logged%n" - + " */%n" - + " public void methodName(final Message msg) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, msg, (Throwable) null);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs the specified Message at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param msg the message string to be logged%n" - + " * @param t A Throwable or null.%n" - + " */%n" - + " public void methodName(final Message msg, final Throwable t) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, msg, t);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message object with the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param message the message object to log.%n" - + " */%n" - + " public void methodName(final Object message) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, (Throwable) null);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message at the {@code CUSTOM_LEVEL} level including the stack trace of%n" - + " * the {@link Throwable} {@code t} passed as parameter.%n" - + " * %n" - + " * @param message the message to log.%n" - + " * @param t the exception to log, including its stack trace.%n" - + " */%n" - + " public void methodName(final Object message, final Throwable t) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, t);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message CharSequence with the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param message the message CharSequence to log.%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final CharSequence message) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, (Throwable) null);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a CharSequence at the {@code CUSTOM_LEVEL} level including the stack trace of%n" - + " * the {@link Throwable} {@code t} passed as parameter.%n" - + " * %n" - + " * @param message the CharSequence to log.%n" - + " * @param t the exception to log, including its stack trace.%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final CharSequence message, final Throwable t) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, t);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message object with the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param message the message object to log.%n" - + " */%n" - + " public void methodName(final String message) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, (Throwable) null);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param params parameters to the message.%n" - + " * @see #getMessageFactory()%n" - + " */%n" - + " public void methodName(final String message, final Object... params) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, params);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final String message, final Object p0) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, p0);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final String message, final Object p0, " - + "final Object p1) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, p0, p1);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final String message, final Object p0, " - + "final Object p1, final Object p2) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, p0, p1, p2);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @param p3 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final String message, final Object p0, " - + "final Object p1, final Object p2,%n" - + " final Object p3) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, p0, p1, p2, p3);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @param p3 parameter to the message.%n" - + " * @param p4 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final String message, final Object p0, " - + "final Object p1, final Object p2,%n" - + " final Object p3, final Object p4) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, p0, p1, p2, p3, p4);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @param p3 parameter to the message.%n" - + " * @param p4 parameter to the message.%n" - + " * @param p5 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final String message, final Object p0, " - + "final Object p1, final Object p2,%n" - + " final Object p3, final Object p4, final Object p5) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, p0, p1, p2, p3, p4, p5);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @param p3 parameter to the message.%n" - + " * @param p4 parameter to the message.%n" - + " * @param p5 parameter to the message.%n" - + " * @param p6 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final String message, final Object p0, " - + "final Object p1, final Object p2,%n" - + " final Object p3, final Object p4, final Object p5, final Object p6) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, p0, p1, p2, p3, p4, p5, p6);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @param p3 parameter to the message.%n" - + " * @param p4 parameter to the message.%n" - + " * @param p5 parameter to the message.%n" - + " * @param p6 parameter to the message.%n" - + " * @param p7 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final String message, final Object p0, " - + "final Object p1, final Object p2,%n" - + " final Object p3, final Object p4, final Object p5, final Object p6,%n" - + " final Object p7) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, p0, p1, p2, p3, p4, p5, p6, p7);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @param p3 parameter to the message.%n" - + " * @param p4 parameter to the message.%n" - + " * @param p5 parameter to the message.%n" - + " * @param p6 parameter to the message.%n" - + " * @param p7 parameter to the message.%n" - + " * @param p8 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final String message, final Object p0, " - + "final Object p1, final Object p2,%n" - + " final Object p3, final Object p4, final Object p5, final Object p6,%n" - + " final Object p7, final Object p8) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, p0, p1, p2, p3, p4, p5, p6, p7, " - + "p8);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters at the {@code CUSTOM_LEVEL} level.%n" - + " * %n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param p0 parameter to the message.%n" - + " * @param p1 parameter to the message.%n" - + " * @param p2 parameter to the message.%n" - + " * @param p3 parameter to the message.%n" - + " * @param p4 parameter to the message.%n" - + " * @param p5 parameter to the message.%n" - + " * @param p6 parameter to the message.%n" - + " * @param p7 parameter to the message.%n" - + " * @param p8 parameter to the message.%n" - + " * @param p9 parameter to the message.%n" - + " * @see #getMessageFactory()%n" - + " * @since Log4j-2.6%n" - + " */%n" - + " public void methodName(final String message, final Object p0, " - + "final Object p1, final Object p2,%n" - + " final Object p3, final Object p4, final Object p5, final Object p6,%n" - + " final Object p7, final Object p8, final Object p9) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, p0, p1, p2, p3, p4, p5, p6, p7, " - + "p8, p9);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message at the {@code CUSTOM_LEVEL} level including the stack trace of%n" - + " * the {@link Throwable} {@code t} passed as parameter.%n" - + " * %n" - + " * @param message the message to log.%n" - + " * @param t the exception to log, including its stack trace.%n" - + " */%n" - + " public void methodName(final String message, final Throwable t) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, t);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message which is only to be constructed if the logging level is the {@code CUSTOM_LEVEL}" - + "level.%n" - + " *%n" - + " * @param msgSupplier A function, which when called, produces the desired log message;%n" - + " * the format depends on the message factory.%n" - + " * @since Log4j-2.4%n" - + " */%n" - + " public void methodName(final Supplier msgSupplier) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, msgSupplier, (Throwable) null);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message (only to be constructed if the logging level is the {@code CUSTOM_LEVEL}%n" - + " * level) including the stack trace of the {@link Throwable} t passed as parameter.%n" - + " *%n" - + " * @param msgSupplier A function, which when called, produces the desired log message;%n" - + " * the format depends on the message factory.%n" - + " * @param t the exception to log, including its stack trace.%n" - + " * @since Log4j-2.4%n" - + " */%n" - + " public void methodName(final Supplier msgSupplier, final Throwable t) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, msgSupplier, t);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message which is only to be constructed if the logging level is the%n" - + " * {@code CUSTOM_LEVEL} level with the specified Marker.%n" - + " *%n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param msgSupplier A function, which when called, produces the desired log message;%n" - + " * the format depends on the message factory.%n" - + " * @since Log4j-2.4%n" - + " */%n" - + " public void methodName(final Marker marker, final Supplier msgSupplier) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, msgSupplier, (Throwable) null);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters which are only to be constructed if the logging level is the%n" - + " * {@code CUSTOM_LEVEL} level.%n" - + " *%n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param paramSuppliers An array of functions, which when called, produce the desired log" - + " message parameters.%n" - + " * @since Log4j-2.4%n" - + " */%n" - + " public void methodName(final Marker marker, final String message, final Supplier..." - + " paramSuppliers) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, message, paramSuppliers);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message (only to be constructed if the logging level is the {@code CUSTOM_LEVEL}%n" - + " * level) with the specified Marker and including the stack trace of the {@link Throwable}%n" - + " * t passed as parameter.%n" - + " *%n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param msgSupplier A function, which when called, produces the desired log message;%n" - + " * the format depends on the message factory.%n" - + " * @param t A Throwable or null.%n" - + " * @since Log4j-2.4%n" - + " */%n" - + " public void methodName(final Marker marker, final Supplier msgSupplier, final Throwable t) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, msgSupplier, t);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message with parameters which are only to be constructed if the logging level is%n" - + " * the {@code CUSTOM_LEVEL} level.%n" - + " *%n" - + " * @param message the message to log; the format depends on the message factory.%n" - + " * @param paramSuppliers An array of functions, which when called, produce the desired log" - + " message parameters.%n" - + " * @since Log4j-2.4%n" - + " */%n" - + " public void methodName(final String message, final Supplier... paramSuppliers) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, message, paramSuppliers);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message which is only to be constructed if the logging level is the%n" - + " * {@code CUSTOM_LEVEL} level with the specified Marker. The {@code MessageSupplier} may or may%n" - + " * not use the {@link MessageFactory} to construct the {@code Message}.%n" - + " *%n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param msgSupplier A function, which when called, produces the desired log message.%n" - + " * @since Log4j-2.4%n" - + " */%n" - + " public void methodName(final Marker marker, final MessageSupplier msgSupplier) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, msgSupplier, (Throwable) null);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message (only to be constructed if the logging level is the {@code CUSTOM_LEVEL}%n" - + " * level) with the specified Marker and including the stack trace of the {@link Throwable}%n" - + " * t passed as parameter. The {@code MessageSupplier} may or may not use the%n" - + " * {@link MessageFactory} to construct the {@code Message}.%n" - + " *%n" - + " * @param marker the marker data specific to this log statement%n" - + " * @param msgSupplier A function, which when called, produces the desired log message.%n" - + " * @param t A Throwable or null.%n" - + " * @since Log4j-2.4%n" - + " */%n" - + " public void methodName(final Marker marker, final MessageSupplier msgSupplier, final " - + "Throwable t) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, marker, msgSupplier, t);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message which is only to be constructed if the logging level is the%n" - + " * {@code CUSTOM_LEVEL} level. The {@code MessageSupplier} may or may not use the%n" - + " * {@link MessageFactory} to construct the {@code Message}.%n" - + " *%n" - + " * @param msgSupplier A function, which when called, produces the desired log message.%n" - + " * @since Log4j-2.4%n" - + " */%n" - + " public void methodName(final MessageSupplier msgSupplier) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, msgSupplier, (Throwable) null);%n" - + " }%n" - + "%n" - + " /**%n" - + " * Logs a message (only to be constructed if the logging level is the {@code CUSTOM_LEVEL}%n" - + " * level) including the stack trace of the {@link Throwable} t passed as parameter.%n" - + " * The {@code MessageSupplier} may or may not use the {@link MessageFactory} to construct the%n" - + " * {@code Message}.%n" - + " *%n" - + " * @param msgSupplier A function, which when called, produces the desired log message.%n" - + " * @param t the exception to log, including its stack trace.%n" - + " * @since Log4j-2.4%n" - + " */%n" - + " public void methodName(final MessageSupplier msgSupplier, final Throwable t) {%n" - + " logger.logIfEnabled(FQCN, CUSTOM_LEVEL, null, msgSupplier, t);%n" - + " }%n"; - // @formatter:on - - private Generate() {} - - /** - * Generates source code for custom logger wrappers that only provide convenience methods for the specified custom - * levels, not for the standard built-in levels. - */ - public static final class CustomLogger { - /** - * Generates source code for custom logger wrappers that only provide convenience methods for the specified - * custom levels, not for the standard built-in levels. - * - * @param args className of the custom logger to generate, followed by a NAME=intLevel pair for each custom log - * level to generate convenience methods for - */ - public static void main(final String[] args) { - generate(args, Type.CUSTOM); - } - - private CustomLogger() {} - } - - /** - * Generates source code for extended logger wrappers that provide convenience methods for the specified custom - * levels, and by extending {@code org.apache.logging.log4j.spi.ExtendedLoggerWrapper}, inherit the convenience - * methods for the built-in levels provided by the {@code Logger} interface. - */ - public static final class ExtendedLogger { - /** - * Generates source code for extended logger wrappers that provide convenience methods for the specified custom - * levels. - * - * @param args className of the custom logger to generate, followed by a NAME=intLevel pair for each custom log - * level to generate convenience methods for - */ - public static void main(final String[] args) { - generate(args, Type.EXTEND); - } - - private ExtendedLogger() {} - } - - static class LevelInfo { - final String name; - final int intLevel; - - LevelInfo(final String description) { - final String[] parts = description.split("="); - name = parts[0]; - intLevel = Integer.parseInt(parts[1]); - } - - public static List parse(final List values, final Class generator) { - final List result = new ArrayList<>(values.size()); - for (int i = 0; i < values.size(); i++) { - try { - result.add(new LevelInfo(values.get(i))); - } catch (final Exception ex) { - System.err.println("Cannot parse custom level '" + values.get(i) + "': " + ex.toString()); - usage(System.err, generator); - System.exit(-1); - } - } - return result; - } - } - - private static void generate(final String[] args, final Type type) { - generate(args, type, System.out); - } - - /** - * Generates source code for extended logger wrappers that provide convenience methods for the specified custom - * levels. - * - * @param args className of the custom logger to generate, followed by a NAME=intLevel pair for each custom log - * level to generate convenience methods for - * @param printStream the stream to write the generated source code to - */ - public static void generateExtend(final String[] args, final PrintStream printStream) { - generate(args, Type.EXTEND, printStream); - } - - /** - * Generates source code for custom logger wrappers that only provide convenience methods for the specified - * custom levels, not for the standard built-in levels. - * - * @param args className of the custom logger to generate, followed by a NAME=intLevel pair for each custom log - * level to generate convenience methods for - * @param printStream the stream to write the generated source code to - */ - public static void generateCustom(final String[] args, final PrintStream printStream) { - generate(args, Type.CUSTOM, printStream); - } - - static void generate(final String[] args, final Type type, final PrintStream printStream) { - if (!validate(args)) { - usage(printStream, type.generator()); - System.exit(-1); - } - final List values = new ArrayList<>(Arrays.asList(args)); - final String classFQN = values.remove(0); - final List levels = LevelInfo.parse(values, type.generator()); - printStream.println(generateSource(classFQN, levels, type)); - } - - static boolean validate(final String[] args) { - return args.length >= 2; - } - - private static void usage(final PrintStream out, final Class generator) { - out.println("Usage: java " + generator.getName() + " className LEVEL1=intLevel1 [LEVEL2=intLevel2...]"); - out.println(" Where className is the fully qualified class name of the custom/extended logger"); - out.println(" to generate, followed by a space-separated list of custom log levels."); - out.println(" For each custom log level, specify NAME=intLevel (without spaces)."); - } - - @SuppressFBWarnings( - value = "FORMAT_STRING_MANIPULATION", - justification = "The format strings come from constants. The replacement is done for readability.") - static String generateSource(final String classNameFQN, final List levels, final Type type) { - final StringBuilder sb = new StringBuilder(10000 * levels.size()); - final int lastDot = classNameFQN.lastIndexOf('.'); - final String pkg = classNameFQN.substring(0, Math.max(lastDot, 0)); - if (!pkg.isEmpty()) { - sb.append(String.format(PACKAGE_DECLARATION, pkg)); - } - sb.append(String.format(type.imports(), "")); - final String className = classNameFQN.substring(classNameFQN.lastIndexOf('.') + 1); - final String javadocDescr = javadocDescription(levels); - sb.append(String.format(type.declaration(), javadocDescr, className)); - sb.append(String.format(FQCN_FIELD, className)); - for (final LevelInfo level : levels) { - sb.append(String.format(LEVEL_FIELD, level.name, level.name, level.intLevel)); - } - sb.append(String.format(type.constructor(), className)); - sb.append(String.format(FACTORY_METHODS.replaceAll("CLASSNAME", className), "")); - for (final LevelInfo level : levels) { - final String methodName = camelCase(level.name); - final String phase1 = METHODS.replaceAll("CUSTOM_LEVEL", level.name); - final String phase2 = phase1.replaceAll("methodName", methodName); - sb.append(String.format(phase2, "")); - } - - sb.append('}'); - sb.append(System.getProperty("line.separator")); - return sb.toString(); - } - - static String javadocDescription(final List levels) { - if (levels.size() == 1) { - return "the " + levels.get(0).name + " custom log level."; - } - final StringBuilder sb = new StringBuilder(512); - sb.append("the "); - String sep = ""; - for (int i = 0; i < levels.size(); i++) { - sb.append(sep); - sb.append(levels.get(i).name); - sep = (i == levels.size() - 2) ? " and " : ", "; - } - sb.append(" custom log levels."); - return sb.toString(); - } - - static String camelCase(final String customLevel) { - final StringBuilder sb = new StringBuilder(customLevel.length()); - boolean lower = true; - for (final char ch : customLevel.toCharArray()) { - if (ch == '_') { - lower = false; - continue; - } - sb.append(lower ? Character.toLowerCase(ch) : Character.toUpperCase(ch)); - lower = true; - } - return sb.toString(); - } -} diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/package-info.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/package-info.java deleted file mode 100644 index 8cbd2eb92fa..00000000000 --- a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/package-info.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * 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. - */ -/** - * Log4j 2 command line tools. - */ -@Export -@Version("2.20.1") -package org.apache.logging.log4j.core.tools; - -import org.osgi.annotation.bundle.Export; -import org.osgi.annotation.versioning.Version; diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/picocli/CommandLine.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/picocli/CommandLine.java deleted file mode 100644 index 37b5b46bf26..00000000000 --- a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/picocli/CommandLine.java +++ /dev/null @@ -1,5619 +0,0 @@ -/* - * 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.logging.log4j.core.tools.picocli; - -import static org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Column.Overflow.SPAN; -import static org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Column.Overflow.TRUNCATE; -import static org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Column.Overflow.WRAP; -import static org.apache.logging.log4j.util.Strings.toRootLowerCase; -import static org.apache.logging.log4j.util.Strings.toRootUpperCase; - -import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; -import java.io.File; -import java.io.PrintStream; -import java.lang.annotation.ElementType; -import java.lang.annotation.Retention; -import java.lang.annotation.RetentionPolicy; -import java.lang.annotation.Target; -import java.lang.reflect.Array; -import java.lang.reflect.Constructor; -import java.lang.reflect.Field; -import java.lang.reflect.ParameterizedType; -import java.lang.reflect.Type; -import java.lang.reflect.WildcardType; -import java.math.BigDecimal; -import java.math.BigInteger; -import java.net.InetAddress; -import java.net.MalformedURLException; -import java.net.URI; -import java.net.URISyntaxException; -import java.net.URL; -import java.nio.charset.Charset; -import java.nio.file.Path; -import java.nio.file.Paths; -import java.sql.Time; -import java.text.BreakIterator; -import java.text.ParseException; -import java.text.SimpleDateFormat; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collection; -import java.util.Collections; -import java.util.Comparator; -import java.util.Date; -import java.util.HashMap; -import java.util.HashSet; -import java.util.LinkedHashMap; -import java.util.LinkedHashSet; -import java.util.LinkedList; -import java.util.List; -import java.util.Map; -import java.util.Queue; -import java.util.Set; -import java.util.SortedSet; -import java.util.Stack; -import java.util.TreeSet; -import java.util.UUID; -import java.util.concurrent.Callable; -import java.util.regex.Pattern; -import org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.IStyle; -import org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.Style; -import org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.Text; - -/** - *

- * CommandLine interpreter that uses reflection to initialize an annotated domain object with values obtained from the - * command line arguments. - *

Example

- * 
import static picocli.CommandLine.*;
- *
- * @Command(header = "Encrypt FILE(s), or standard input, to standard output or to the output file.",
- *          version = "v1.2.3")
- * public class Encrypt {
- *
- *     @Parameters(type = File.class, description = "Any number of input files")
- *     private List<File> files = new ArrayList<File>();
- *
- *     @Option(names = { "-o", "--out" }, description = "Output file (default: print to console)")
- *     private File outputFile;
- *
- *     @Option(names = { "-v", "--verbose"}, description = "Verbosely list files processed")
- *     private boolean verbose;
- *
- *     @Option(names = { "-h", "--help", "-?", "-help"}, usageHelp = true, description = "Display this help and exit")
- *     private boolean help;
- *
- *     @Option(names = { "-V", "--version"}, versionHelp = true, description = "Display version info and exit")
- *     private boolean versionHelp;
- * }
- *
- *

- * Use {@code CommandLine} to initialize a domain object as follows: - * 

- * public static void main(String... args) {
- *     Encrypt encrypt = new Encrypt();
- *     try {
- *         List<CommandLine> parsedCommands = new CommandLine(encrypt).parse(args);
- *         if (!CommandLine.printHelpIfRequested(parsedCommands, System.err, Help.Ansi.AUTO)) {
- *             runProgram(encrypt);
- *         }
- *     } catch (ParameterException ex) { // command line arguments could not be parsed
- *         System.err.println(ex.getMessage());
- *         ex.getCommandLine().usage(System.err);
- *     }
- * }
- *

- * Invoke the above program with some command line arguments. The below are all equivalent: - *

- * 
- * --verbose --out=outfile in1 in2
- * --verbose --out outfile in1 in2
- * -v --out=outfile in1 in2
- * -v -o outfile in1 in2
- * -v -o=outfile in1 in2
- * -vo outfile in1 in2
- * -vo=outfile in1 in2
- * -v -ooutfile in1 in2
- * -vooutfile in1 in2
- *
- */ -public class CommandLine { - /** This is picocli version {@value}. */ - public static final String VERSION = "2.0.3"; - - private final Tracer tracer = new Tracer(); - private final Interpreter interpreter; - private String commandName = Help.DEFAULT_COMMAND_NAME; - private boolean overwrittenOptionsAllowed = false; - private boolean unmatchedArgumentsAllowed = false; - private final List unmatchedArguments = new ArrayList(); - private CommandLine parent; - private boolean usageHelpRequested; - private boolean versionHelpRequested; - private final List versionLines = new ArrayList(); - - /** - * Constructs a new {@code CommandLine} interpreter with the specified annotated object. - * When the {@link #parse(String...)} method is called, fields of the specified object that are annotated - * with {@code @Option} or {@code @Parameters} will be initialized based on command line arguments. - * @param command the object to initialize from the command line arguments - * @throws InitializationException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation - */ - public CommandLine(final Object command) { - interpreter = new Interpreter(command); - } - - /** Registers a subcommand with the specified name. For example: - * 
-     * CommandLine commandLine = new CommandLine(new Git())
-     *         .addSubcommand("status",   new GitStatus())
-     *         .addSubcommand("commit",   new GitCommit();
-     *         .addSubcommand("add",      new GitAdd())
-     *         .addSubcommand("branch",   new GitBranch())
-     *         .addSubcommand("checkout", new GitCheckout())
-     *         //...
-     *         ;
-     *
- * - *

The specified object can be an annotated object or a - * {@code CommandLine} instance with its own nested subcommands. For example:

- * 
-     * CommandLine commandLine = new CommandLine(new MainCommand())
-     *         .addSubcommand("cmd1",                 new ChildCommand1()) // subcommand
-     *         .addSubcommand("cmd2",                 new ChildCommand2())
-     *         .addSubcommand("cmd3", new CommandLine(new ChildCommand3()) // subcommand with nested sub-subcommands
-     *                 .addSubcommand("cmd3sub1",                 new GrandChild3Command1())
-     *                 .addSubcommand("cmd3sub2",                 new GrandChild3Command2())
-     *                 .addSubcommand("cmd3sub3", new CommandLine(new GrandChild3Command3()) // deeper nesting
-     *                         .addSubcommand("cmd3sub3sub1", new GreatGrandChild3Command3_1())
-     *                         .addSubcommand("cmd3sub3sub2", new GreatGrandChild3Command3_2())
-     *                 )
-     *         );
-     *
- *

The default type converters are available on all subcommands and nested sub-subcommands, but custom type - * converters are registered only with the subcommand hierarchy as it existed when the custom type was registered. - * To ensure a custom type converter is available to all subcommands, register the type converter last, after - * adding subcommands.

- *

See also the {@link Command#subcommands()} annotation to register subcommands declaratively.

- * - * @param name the string to recognize on the command line as a subcommand - * @param command the object to initialize with command line arguments following the subcommand name. - * This may be a {@code CommandLine} instance with its own (nested) subcommands - * @return this CommandLine object, to allow method chaining - * @see #registerConverter(Class, ITypeConverter) - * @since 0.9.7 - * @see Command#subcommands() - */ - public CommandLine addSubcommand(final String name, final Object command) { - final CommandLine commandLine = toCommandLine(command); - commandLine.parent = this; - interpreter.commands.put(name, commandLine); - return this; - } - /** Returns a map with the subcommands {@linkplain #addSubcommand(String, Object) registered} on this instance. - * @return a map with the registered subcommands - * @since 0.9.7 - */ - public Map getSubcommands() { - return new LinkedHashMap(interpreter.commands); - } - /** - * Returns the command that this is a subcommand of, or {@code null} if this is a top-level command. - * @return the command that this is a subcommand of, or {@code null} if this is a top-level command - * @see #addSubcommand(String, Object) - * @see Command#subcommands() - * @since 0.9.8 - */ - public CommandLine getParent() { - return parent; - } - - /** Returns the annotated object that this {@code CommandLine} instance was constructed with. - * @param the type of the variable that the return value is being assigned to - * @return the annotated object that this {@code CommandLine} instance was constructed with - * @since 0.9.7 - */ - public T getCommand() { - return (T) interpreter.command; - } - - /** Returns {@code true} if an option annotated with {@link Option#usageHelp()} was specified on the command line. - * @return whether the parser encountered an option annotated with {@link Option#usageHelp()}. - * @since 0.9.8 */ - public boolean isUsageHelpRequested() { - return usageHelpRequested; - } - - /** Returns {@code true} if an option annotated with {@link Option#versionHelp()} was specified on the command line. - * @return whether the parser encountered an option annotated with {@link Option#versionHelp()}. - * @since 0.9.8 */ - public boolean isVersionHelpRequested() { - return versionHelpRequested; - } - - /** Returns whether options for single-value fields can be specified multiple times on the command line. - * The default is {@code false} and a {@link OverwrittenOptionException} is thrown if this happens. - * When {@code true}, the last specified value is retained. - * @return {@code true} if options for single-value fields can be specified multiple times on the command line, {@code false} otherwise - * @since 0.9.7 - */ - public boolean isOverwrittenOptionsAllowed() { - return overwrittenOptionsAllowed; - } - - /** Sets whether options for single-value fields can be specified multiple times on the command line without a {@link OverwrittenOptionException} being thrown. - *

The specified setting will be registered with this {@code CommandLine} and the full hierarchy of its - * subcommands and nested sub-subcommands at the moment this method is called. Subcommands added - * later will have the default setting. To ensure a setting is applied to all - * subcommands, call the setter last, after adding subcommands.

- * @param newValue the new setting - * @return this {@code CommandLine} object, to allow method chaining - * @since 0.9.7 - */ - public CommandLine setOverwrittenOptionsAllowed(final boolean newValue) { - this.overwrittenOptionsAllowed = newValue; - for (final CommandLine command : interpreter.commands.values()) { - command.setOverwrittenOptionsAllowed(newValue); - } - return this; - } - - /** Returns whether the end user may specify arguments on the command line that are not matched to any option or parameter fields. - * The default is {@code false} and a {@link UnmatchedArgumentException} is thrown if this happens. - * When {@code true}, the last unmatched arguments are available via the {@link #getUnmatchedArguments()} method. - * @return {@code true} if the end use may specify unmatched arguments on the command line, {@code false} otherwise - * @see #getUnmatchedArguments() - * @since 0.9.7 - */ - public boolean isUnmatchedArgumentsAllowed() { - return unmatchedArgumentsAllowed; - } - - /** Sets whether the end user may specify unmatched arguments on the command line without a {@link UnmatchedArgumentException} being thrown. - *

The specified setting will be registered with this {@code CommandLine} and the full hierarchy of its - * subcommands and nested sub-subcommands at the moment this method is called. Subcommands added - * later will have the default setting. To ensure a setting is applied to all - * subcommands, call the setter last, after adding subcommands.

- * @param newValue the new setting. When {@code true}, the last unmatched arguments are available via the {@link #getUnmatchedArguments()} method. - * @return this {@code CommandLine} object, to allow method chaining - * @since 0.9.7 - * @see #getUnmatchedArguments() - */ - public CommandLine setUnmatchedArgumentsAllowed(final boolean newValue) { - this.unmatchedArgumentsAllowed = newValue; - for (final CommandLine command : interpreter.commands.values()) { - command.setUnmatchedArgumentsAllowed(newValue); - } - return this; - } - - /** Returns the list of unmatched command line arguments, if any. - * @return the list of unmatched command line arguments or an empty list - * @see #isUnmatchedArgumentsAllowed() - * @since 0.9.7 - */ - public List getUnmatchedArguments() { - return unmatchedArguments; - } - - /** - *

- * Convenience method that initializes the specified annotated object from the specified command line arguments. - *

- * This is equivalent to - * 

-     * CommandLine cli = new CommandLine(command);
-     * cli.parse(args);
-     * return command;
-     *
- * - * @param command the object to initialize. This object contains fields annotated with - * {@code @Option} or {@code @Parameters}. - * @param args the command line arguments to parse - * @param the type of the annotated object - * @return the specified annotated object - * @throws InitializationException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation - * @throws ParameterException if the specified command line arguments are invalid - * @since 0.9.7 - */ - public static T populateCommand(final T command, final String... args) { - final CommandLine cli = toCommandLine(command); - cli.parse(args); - return command; - } - - /** Parses the specified command line arguments and returns a list of {@code CommandLine} objects representing the - * top-level command and any subcommands (if any) that were recognized and initialized during the parsing process. - *

- * If parsing succeeds, the first element in the returned list is always {@code this CommandLine} object. The - * returned list may contain more elements if subcommands were {@linkplain #addSubcommand(String, Object) registered} - * and these subcommands were initialized by matching command line arguments. If parsing fails, a - * {@link ParameterException} is thrown. - *

- * - * @param args the command line arguments to parse - * @return a list with the top-level command and any subcommands initialized by this method - * @throws ParameterException if the specified command line arguments are invalid; use - * {@link ParameterException#getCommandLine()} to get the command or subcommand whose user input was invalid - */ - public List parse(final String... args) { - return interpreter.parse(args); - } - /** - * Represents a function that can process a List of {@code CommandLine} objects resulting from successfully - * {@linkplain #parse(String...) parsing} the command line arguments. This is a - * functional interface - * whose functional method is {@link #handleParseResult(List, PrintStream, CommandLine.Help.Ansi)}. - *

- * Implementations of this functions can be passed to the {@link #parseWithHandlers(IParseResultHandler, PrintStream, Help.Ansi, IExceptionHandler, String...) CommandLine::parseWithHandler} - * methods to take some next step after the command line was successfully parsed. - *

- * @see RunFirst - * @see RunLast - * @see RunAll - * @since 2.0 */ - public interface IParseResultHandler { - /** Processes a List of {@code CommandLine} objects resulting from successfully - * {@linkplain #parse(String...) parsing} the command line arguments and optionally returns a list of results. - * @param parsedCommands the {@code CommandLine} objects that resulted from successfully parsing the command line arguments - * @param out the {@code PrintStream} to print help to if requested - * @param ansi for printing help messages using ANSI styles and colors - * @return a list of results, or an empty list if there are no results - * @throws ExecutionException if a problem occurred while processing the parse results; use - * {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed - */ - List handleParseResult(List parsedCommands, PrintStream out, Help.Ansi ansi) - throws ExecutionException; - } - /** - * Represents a function that can handle a {@code ParameterException} that occurred while - * {@linkplain #parse(String...) parsing} the command line arguments. This is a - * functional interface - * whose functional method is {@link #handleException(CommandLine.ParameterException, PrintStream, CommandLine.Help.Ansi, String...)}. - *

- * Implementations of this functions can be passed to the {@link #parseWithHandlers(IParseResultHandler, PrintStream, Help.Ansi, IExceptionHandler, String...) CommandLine::parseWithHandler} - * methods to handle situations when the command line could not be parsed. - *

- * @see DefaultExceptionHandler - * @since 2.0 */ - public interface IExceptionHandler { - /** Handles a {@code ParameterException} that occurred while {@linkplain #parse(String...) parsing} the command - * line arguments and optionally returns a list of results. - * @param ex the ParameterException describing the problem that occurred while parsing the command line arguments, - * and the CommandLine representing the command or subcommand whose input was invalid - * @param out the {@code PrintStream} to print help to if requested - * @param ansi for printing help messages using ANSI styles and colors - * @param args the command line arguments that could not be parsed - * @return a list of results, or an empty list if there are no results - */ - List handleException(ParameterException ex, PrintStream out, Help.Ansi ansi, String... args); - } - /** - * Default exception handler that prints the exception message to the specified {@code PrintStream}, followed by the - * usage message for the command or subcommand whose input was invalid. - *

Implementation roughly looks like this:

- * 
-     *     System.err.println(paramException.getMessage());
-     *     paramException.getCommandLine().usage(System.err);
-     *
- * @since 2.0 */ - public static class DefaultExceptionHandler implements IExceptionHandler { - @Override - public List handleException( - final ParameterException ex, final PrintStream out, final Help.Ansi ansi, final String... args) { - out.println(ex.getMessage()); - ex.getCommandLine().usage(out, ansi); - return Collections.emptyList(); - } - } - /** - * Helper method that may be useful when processing the list of {@code CommandLine} objects that result from successfully - * {@linkplain #parse(String...) parsing} command line arguments. This method prints out - * {@linkplain #usage(PrintStream, Help.Ansi) usage help} if {@linkplain #isUsageHelpRequested() requested} - * or {@linkplain #printVersionHelp(PrintStream, Help.Ansi) version help} if {@linkplain #isVersionHelpRequested() requested} - * and returns {@code true}. Otherwise, if none of the specified {@code CommandLine} objects have help requested, - * this method returns {@code false}. - *

- * Note that this method only looks at the {@link Option#usageHelp() usageHelp} and - * {@link Option#versionHelp() versionHelp} attributes. The {@link Option#help() help} attribute is ignored. - *

- * @param parsedCommands the list of {@code CommandLine} objects to check if help was requested - * @param out the {@code PrintStream} to print help to if requested - * @param ansi for printing help messages using ANSI styles and colors - * @return {@code true} if help was printed, {@code false} otherwise - * @since 2.0 */ - public static boolean printHelpIfRequested( - final List parsedCommands, final PrintStream out, final Help.Ansi ansi) { - for (final CommandLine parsed : parsedCommands) { - if (parsed.isUsageHelpRequested()) { - parsed.usage(out, ansi); - return true; - } else if (parsed.isVersionHelpRequested()) { - parsed.printVersionHelp(out, ansi); - return true; - } - } - return false; - } - - private static Object execute(final CommandLine parsed) { - final Object command = parsed.getCommand(); - if (command instanceof Runnable) { - try { - ((Runnable) command).run(); - return null; - } catch (final Exception ex) { - throw new ExecutionException(parsed, "Error while running command (" + command + ")", ex); - } - } else if (command instanceof Callable) { - try { - return ((Callable) command).call(); - } catch (final Exception ex) { - throw new ExecutionException(parsed, "Error while calling command (" + command + ")", ex); - } - } - throw new ExecutionException(parsed, "Parsed command (" + command + ") is not Runnable or Callable"); - } - /** - * Command line parse result handler that prints help if requested, and otherwise executes the top-level - * {@code Runnable} or {@code Callable} command. - * For use in the {@link #parseWithHandlers(IParseResultHandler, PrintStream, Help.Ansi, IExceptionHandler, String...) parseWithHandler} methods. - *

- * From picocli v2.0, {@code RunFirst} is used to implement the {@link #run(Runnable, PrintStream, Help.Ansi, String...) run} - * and {@link #call(Callable, PrintStream, Help.Ansi, String...) call} convenience methods. - *

- * @since 2.0 */ - public static class RunFirst implements IParseResultHandler { - /** Prints help if requested, and otherwise executes the top-level {@code Runnable} or {@code Callable} command. - * If the top-level command does not implement either {@code Runnable} or {@code Callable}, a {@code ExecutionException} - * is thrown detailing the problem and capturing the offending {@code CommandLine} object. - * - * @param parsedCommands the {@code CommandLine} objects that resulted from successfully parsing the command line arguments - * @param out the {@code PrintStream} to print help to if requested - * @param ansi for printing help messages using ANSI styles and colors - * @return an empty list if help was requested, or a list containing a single element: the result of calling the - * {@code Callable}, or a {@code null} element if the top-level command was a {@code Runnable} - * @throws ExecutionException if a problem occurred while processing the parse results; use - * {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed - */ - @Override - public List handleParseResult( - final List parsedCommands, final PrintStream out, final Help.Ansi ansi) { - if (printHelpIfRequested(parsedCommands, out, ansi)) { - return Collections.emptyList(); - } - return Arrays.asList(execute(parsedCommands.get(0))); - } - } - /** - * Command line parse result handler that prints help if requested, and otherwise executes the most specific - * {@code Runnable} or {@code Callable} subcommand. - * For use in the {@link #parseWithHandlers(IParseResultHandler, PrintStream, Help.Ansi, IExceptionHandler, String...) parseWithHandler} methods. - *

- * Something like this:

- * 
-     *     // RunLast implementation: print help if requested, otherwise execute the most specific subcommand
-     *     if (CommandLine.printHelpIfRequested(parsedCommands, System.err, Help.Ansi.AUTO)) {
-     *         return emptyList();
-     *     }
-     *     CommandLine last = parsedCommands.get(parsedCommands.size() - 1);
-     *     Object command = last.getCommand();
-     *     if (command instanceof Runnable) {
-     *         try {
-     *             ((Runnable) command).run();
-     *         } catch (Exception ex) {
-     *             throw new ExecutionException(last, "Error in runnable " + command, ex);
-     *         }
-     *     } else if (command instanceof Callable) {
-     *         Object result;
-     *         try {
-     *             result = ((Callable) command).call();
-     *         } catch (Exception ex) {
-     *             throw new ExecutionException(last, "Error in callable " + command, ex);
-     *         }
-     *         // ...do something with result
-     *     } else {
-     *         throw new ExecutionException(last, "Parsed command (" + command + ") is not Runnable or Callable");
-     *     }
-     *
- * @since 2.0 */ - public static class RunLast implements IParseResultHandler { - /** Prints help if requested, and otherwise executes the most specific {@code Runnable} or {@code Callable} subcommand. - * If the last (sub)command does not implement either {@code Runnable} or {@code Callable}, a {@code ExecutionException} - * is thrown detailing the problem and capturing the offending {@code CommandLine} object. - * - * @param parsedCommands the {@code CommandLine} objects that resulted from successfully parsing the command line arguments - * @param out the {@code PrintStream} to print help to if requested - * @param ansi for printing help messages using ANSI styles and colors - * @return an empty list if help was requested, or a list containing a single element: the result of calling the - * {@code Callable}, or a {@code null} element if the last (sub)command was a {@code Runnable} - * @throws ExecutionException if a problem occurred while processing the parse results; use - * {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed - */ - @Override - public List handleParseResult( - final List parsedCommands, final PrintStream out, final Help.Ansi ansi) { - if (printHelpIfRequested(parsedCommands, out, ansi)) { - return Collections.emptyList(); - } - final CommandLine last = parsedCommands.get(parsedCommands.size() - 1); - return Arrays.asList(execute(last)); - } - } - /** - * Command line parse result handler that prints help if requested, and otherwise executes the top-level command and - * all subcommands as {@code Runnable} or {@code Callable}. - * For use in the {@link #parseWithHandlers(IParseResultHandler, PrintStream, Help.Ansi, IExceptionHandler, String...) parseWithHandler} methods. - * @since 2.0 */ - public static class RunAll implements IParseResultHandler { - /** Prints help if requested, and otherwise executes the top-level command and all subcommands as {@code Runnable} - * or {@code Callable}. If any of the {@code CommandLine} commands does not implement either - * {@code Runnable} or {@code Callable}, a {@code ExecutionException} - * is thrown detailing the problem and capturing the offending {@code CommandLine} object. - * - * @param parsedCommands the {@code CommandLine} objects that resulted from successfully parsing the command line arguments - * @param out the {@code PrintStream} to print help to if requested - * @param ansi for printing help messages using ANSI styles and colors - * @return an empty list if help was requested, or a list containing the result of executing all commands: - * the return values from calling the {@code Callable} commands, {@code null} elements for commands that implement {@code Runnable} - * @throws ExecutionException if a problem occurred while processing the parse results; use - * {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed - */ - @Override - public List handleParseResult( - final List parsedCommands, final PrintStream out, final Help.Ansi ansi) { - if (printHelpIfRequested(parsedCommands, out, ansi)) { - return null; - } - final List result = new ArrayList(); - for (final CommandLine parsed : parsedCommands) { - result.add(execute(parsed)); - } - return result; - } - } - /** - * Returns the result of calling {@link #parseWithHandlers(IParseResultHandler, PrintStream, Help.Ansi, IExceptionHandler, String...)} - * with {@code Help.Ansi.AUTO} and a new {@link DefaultExceptionHandler} in addition to the specified parse result handler, - * {@code PrintStream}, and the specified command line arguments. - *

- * This is a convenience method intended to offer the same ease of use as the {@link #run(Runnable, PrintStream, Help.Ansi, String...) run} - * and {@link #call(Callable, PrintStream, Help.Ansi, String...) call} methods, but with more flexibility and better - * support for nested subcommands. - *

- *

Calling this method roughly expands to:

- * 
-     * try {
-     *     List<CommandLine> parsedCommands = parse(args);
-     *     return parseResultsHandler.handleParseResult(parsedCommands, out, Help.Ansi.AUTO);
-     * } catch (ParameterException ex) {
-     *     return new DefaultExceptionHandler().handleException(ex, out, ansi, args);
-     * }
-     *
- *

- * Picocli provides some default handlers that allow you to accomplish some common tasks with very little code. - * The following handlers are available:

- *
    - *
  • {@link RunLast} handler prints help if requested, and otherwise gets the last specified command or subcommand - * and tries to execute it as a {@code Runnable} or {@code Callable}.
    • - *
  • {@link RunFirst} handler prints help if requested, and otherwise executes the top-level command as a {@code Runnable} or {@code Callable}.
    • - *
  • {@link RunAll} handler prints help if requested, and otherwise executes all recognized commands and subcommands as {@code Runnable} or {@code Callable} tasks.
    • - *
  • {@link DefaultExceptionHandler} prints the error message followed by usage help
    • - *
- * @param handler the function that will process the result of successfully parsing the command line arguments - * @param out the {@code PrintStream} to print help to if requested - * @param args the command line arguments - * @return a list of results, or an empty list if there are no results - * @throws ExecutionException if the command line arguments were parsed successfully but a problem occurred while processing the - * parse results; use {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed - * @see RunLast - * @see RunAll - * @since 2.0 */ - public List parseWithHandler( - final IParseResultHandler handler, final PrintStream out, final String... args) { - return parseWithHandlers(handler, out, Help.Ansi.AUTO, new DefaultExceptionHandler(), args); - } - /** - * Tries to {@linkplain #parse(String...) parse} the specified command line arguments, and if successful, delegates - * the processing of the resulting list of {@code CommandLine} objects to the specified {@linkplain IParseResultHandler handler}. - * If the command line arguments were invalid, the {@code ParameterException} thrown from the {@code parse} method - * is caught and passed to the specified {@link IExceptionHandler}. - *

- * This is a convenience method intended to offer the same ease of use as the {@link #run(Runnable, PrintStream, Help.Ansi, String...) run} - * and {@link #call(Callable, PrintStream, Help.Ansi, String...) call} methods, but with more flexibility and better - * support for nested subcommands. - *

- *

Calling this method roughly expands to:

- * 
-     * try {
-     *     List<CommandLine> parsedCommands = parse(args);
-     *     return parseResultsHandler.handleParseResult(parsedCommands, out, ansi);
-     * } catch (ParameterException ex) {
-     *     return new exceptionHandler.handleException(ex, out, ansi, args);
-     * }
-     *
- *

- * Picocli provides some default handlers that allow you to accomplish some common tasks with very little code. - * The following handlers are available:

- *
    - *
  • {@link RunLast} handler prints help if requested, and otherwise gets the last specified command or subcommand - * and tries to execute it as a {@code Runnable} or {@code Callable}.
    • - *
  • {@link RunFirst} handler prints help if requested, and otherwise executes the top-level command as a {@code Runnable} or {@code Callable}.
    • - *
  • {@link RunAll} handler prints help if requested, and otherwise executes all recognized commands and subcommands as {@code Runnable} or {@code Callable} tasks.
    • - *
  • {@link DefaultExceptionHandler} prints the error message followed by usage help
    • - *
- * - * @param handler the function that will process the result of successfully parsing the command line arguments - * @param out the {@code PrintStream} to print help to if requested - * @param ansi for printing help messages using ANSI styles and colors - * @param exceptionHandler the function that can handle the {@code ParameterException} thrown when the command line arguments are invalid - * @param args the command line arguments - * @return a list of results produced by the {@code IParseResultHandler} or the {@code IExceptionHandler}, or an empty list if there are no results - * @throws ExecutionException if the command line arguments were parsed successfully but a problem occurred while processing the parse - * result {@code CommandLine} objects; use {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed - * @see RunLast - * @see RunAll - * @see DefaultExceptionHandler - * @since 2.0 */ - public List parseWithHandlers( - final IParseResultHandler handler, - final PrintStream out, - final Help.Ansi ansi, - final IExceptionHandler exceptionHandler, - final String... args) { - try { - final List result = parse(args); - return handler.handleParseResult(result, out, ansi); - } catch (final ParameterException ex) { - return exceptionHandler.handleException(ex, out, ansi, args); - } - } - /** - * Equivalent to {@code new CommandLine(command).usage(out)}. See {@link #usage(PrintStream)} for details. - * @param command the object annotated with {@link Command}, {@link Option} and {@link Parameters} - * @param out the print stream to print the help message to - * @throws IllegalArgumentException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation - */ - public static void usage(final Object command, final PrintStream out) { - toCommandLine(command).usage(out); - } - - /** - * Equivalent to {@code new CommandLine(command).usage(out, ansi)}. - * See {@link #usage(PrintStream, Help.Ansi)} for details. - * @param command the object annotated with {@link Command}, {@link Option} and {@link Parameters} - * @param out the print stream to print the help message to - * @param ansi whether the usage message should contain ANSI escape codes or not - * @throws IllegalArgumentException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation - */ - public static void usage(final Object command, final PrintStream out, final Help.Ansi ansi) { - toCommandLine(command).usage(out, ansi); - } - - /** - * Equivalent to {@code new CommandLine(command).usage(out, colorScheme)}. - * See {@link #usage(PrintStream, Help.ColorScheme)} for details. - * @param command the object annotated with {@link Command}, {@link Option} and {@link Parameters} - * @param out the print stream to print the help message to - * @param colorScheme the {@code ColorScheme} defining the styles for options, parameters and commands when ANSI is enabled - * @throws IllegalArgumentException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation - */ - public static void usage(final Object command, final PrintStream out, final Help.ColorScheme colorScheme) { - toCommandLine(command).usage(out, colorScheme); - } - - /** - * Delegates to {@link #usage(PrintStream, Help.Ansi)} with the {@linkplain Help.Ansi#AUTO platform default}. - * @param out the printStream to print to - * @see #usage(PrintStream, Help.ColorScheme) - */ - public void usage(final PrintStream out) { - usage(out, Help.Ansi.AUTO); - } - - /** - * Delegates to {@link #usage(PrintStream, Help.ColorScheme)} with the {@linkplain Help#defaultColorScheme(CommandLine.Help.Ansi) default color scheme}. - * @param out the printStream to print to - * @param ansi whether the usage message should include ANSI escape codes or not - * @see #usage(PrintStream, Help.ColorScheme) - */ - public void usage(final PrintStream out, final Help.Ansi ansi) { - usage(out, Help.defaultColorScheme(ansi)); - } - /** - * Prints a usage help message for the annotated command class to the specified {@code PrintStream}. - * Delegates construction of the usage help message to the {@link Help} inner class and is equivalent to: - * 
-     * Help help = new Help(command).addAllSubcommands(getSubcommands());
-     * StringBuilder sb = new StringBuilder()
-     *         .append(help.headerHeading())
-     *         .append(help.header())
-     *         .append(help.synopsisHeading())      //e.g. Usage:
-     *         .append(help.synopsis())             //e.g. <main class> [OPTIONS] <command> [COMMAND-OPTIONS] [ARGUMENTS]
-     *         .append(help.descriptionHeading())   //e.g. %nDescription:%n%n
-     *         .append(help.description())          //e.g. {"Converts foos to bars.", "Use options to control conversion mode."}
-     *         .append(help.parameterListHeading()) //e.g. %nPositional parameters:%n%n
-     *         .append(help.parameterList())        //e.g. [FILE...] the files to convert
-     *         .append(help.optionListHeading())    //e.g. %nOptions:%n%n
-     *         .append(help.optionList())           //e.g. -h, --help   displays this help and exits
-     *         .append(help.commandListHeading())   //e.g. %nCommands:%n%n
-     *         .append(help.commandList())          //e.g.    add       adds the frup to the frooble
-     *         .append(help.footerHeading())
-     *         .append(help.footer());
-     * out.print(sb);
-     *
- *

Annotate your class with {@link Command} to control many aspects of the usage help message, including - * the program name, text of section headings and section contents, and some aspects of the auto-generated sections - * of the usage help message. - *

To customize the auto-generated sections of the usage help message, like how option details are displayed, - * instantiate a {@link Help} object and use a {@link Help.TextTable} with more of fewer columns, a custom - * {@linkplain Help.Layout layout}, and/or a custom option {@linkplain Help.IOptionRenderer renderer} - * for ultimate control over which aspects of an Option or Field are displayed where.

- * @param out the {@code PrintStream} to print the usage help message to - * @param colorScheme the {@code ColorScheme} defining the styles for options, parameters and commands when ANSI is enabled - */ - public void usage(final PrintStream out, final Help.ColorScheme colorScheme) { - final Help help = new Help(interpreter.command, colorScheme).addAllSubcommands(getSubcommands()); - if (!Help.DEFAULT_SEPARATOR.equals(getSeparator())) { - help.separator = getSeparator(); - help.parameterLabelRenderer = help.createDefaultParamLabelRenderer(); // update for new separator - } - if (!Help.DEFAULT_COMMAND_NAME.equals(getCommandName())) { - help.commandName = getCommandName(); - } - final StringBuilder sb = new StringBuilder() - .append(help.headerHeading()) - .append(help.header()) - .append(help.synopsisHeading()) // e.g. Usage: - .append(help.synopsis( - help.synopsisHeadingLength())) // e.g. <main class> [OPTIONS] <command> - // [COMMAND-OPTIONS] [ARGUMENTS] - .append(help.descriptionHeading()) // e.g. %nDescription:%n%n - .append(help.description()) // e.g. {"Converts foos to bars.", "Use options to control conversion - // mode."} - .append(help.parameterListHeading()) // e.g. %nPositional parameters:%n%n - .append(help.parameterList()) // e.g. [FILE...] the files to convert - .append(help.optionListHeading()) // e.g. %nOptions:%n%n - .append(help.optionList()) // e.g. -h, --help displays this help and exits - .append(help.commandListHeading()) // e.g. %nCommands:%n%n - .append(help.commandList()) // e.g. add adds the frup to the frooble - .append(help.footerHeading()) - .append(help.footer()); - out.print(sb); - } - - /** - * Delegates to {@link #printVersionHelp(PrintStream, Help.Ansi)} with the {@linkplain Help.Ansi#AUTO platform default}. - * @param out the printStream to print to - * @see #printVersionHelp(PrintStream, Help.Ansi) - * @since 0.9.8 - */ - public void printVersionHelp(final PrintStream out) { - printVersionHelp(out, Help.Ansi.AUTO); - } - - /** - * Prints version information from the {@link Command#version()} annotation to the specified {@code PrintStream}. - * Each element of the array of version strings is printed on a separate line. Version strings may contain - * markup for colors and style. - * @param out the printStream to print to - * @param ansi whether the usage message should include ANSI escape codes or not - * @see Command#version() - * @see Option#versionHelp() - * @see #isVersionHelpRequested() - * @since 0.9.8 - */ - public void printVersionHelp(final PrintStream out, final Help.Ansi ansi) { - for (final String versionInfo : versionLines) { - out.println(ansi.new Text(versionInfo)); - } - } - /** - * Prints version information from the {@link Command#version()} annotation to the specified {@code PrintStream}. - * Each element of the array of version strings is {@linkplain String#format(String, Object...) formatted} with the - * specified parameters, and printed on a separate line. Both version strings and parameters may contain - * markup for colors and style. - * @param out the printStream to print to - * @param ansi whether the usage message should include ANSI escape codes or not - * @param params Arguments referenced by the format specifiers in the version strings - * @see Command#version() - * @see Option#versionHelp() - * @see #isVersionHelpRequested() - * @since 1.0.0 - */ - public void printVersionHelp(final PrintStream out, final Help.Ansi ansi, final Object... params) { - for (final String versionInfo : versionLines) { - out.println(ansi.new Text(String.format(versionInfo, params))); - } - } - - /** - * Delegates to {@link #call(Callable, PrintStream, Help.Ansi, String...)} with {@link Help.Ansi#AUTO}. - *

- * From picocli v2.0, this method prints usage help or version help if {@linkplain #printHelpIfRequested(List, PrintStream, Help.Ansi) requested}, - * and any exceptions thrown by the {@code Callable} are caught and rethrown wrapped in an {@code ExecutionException}. - *

- * @param callable the command to call when {@linkplain #parse(String...) parsing} succeeds. - * @param out the printStream to print to - * @param args the command line arguments to parse - * @param the annotated object must implement Callable - * @param the return type of the most specific command (must implement {@code Callable}) - * @see #call(Callable, PrintStream, Help.Ansi, String...) - * @throws InitializationException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation - * @throws ExecutionException if the Callable throws an exception - * @return {@code null} if an error occurred while parsing the command line options, otherwise returns the result of calling the Callable - * @see #parseWithHandlers(IParseResultHandler, PrintStream, Help.Ansi, IExceptionHandler, String...) - * @see RunFirst - */ - public static , T> T call(final C callable, final PrintStream out, final String... args) { - return call(callable, out, Help.Ansi.AUTO, args); - } - /** - * Convenience method to allow command line application authors to avoid some boilerplate code in their application. - * The annotated object needs to implement {@link Callable}. Calling this method is equivalent to: - * 
-     * CommandLine cmd = new CommandLine(callable);
-     * List<CommandLine> parsedCommands;
-     * try {
-     *     parsedCommands = cmd.parse(args);
-     * } catch (ParameterException ex) {
-     *     out.println(ex.getMessage());
-     *     cmd.usage(out, ansi);
-     *     return null;
-     * }
-     * if (CommandLine.printHelpIfRequested(parsedCommands, out, ansi)) {
-     *     return null;
-     * }
-     * CommandLine last = parsedCommands.get(parsedCommands.size() - 1);
-     * try {
-     *     Callable<Object> subcommand = last.getCommand();
-     *     return subcommand.call();
-     * } catch (Exception ex) {
-     *     throw new ExecutionException(last, "Error calling " + last.getCommand(), ex);
-     * }
-     *
- *

- * If the specified Callable command has subcommands, the {@linkplain RunLast last} subcommand specified on the - * command line is executed. - * Commands with subcommands may be interested in calling the {@link #parseWithHandler(IParseResultHandler, PrintStream, String...) parseWithHandler} - * method with a {@link RunAll} handler or a custom handler. - *

- * From picocli v2.0, this method prints usage help or version help if {@linkplain #printHelpIfRequested(List, PrintStream, Help.Ansi) requested}, - * and any exceptions thrown by the {@code Callable} are caught and rethrown wrapped in an {@code ExecutionException}. - *

- * @param callable the command to call when {@linkplain #parse(String...) parsing} succeeds. - * @param out the printStream to print to - * @param ansi whether the usage message should include ANSI escape codes or not - * @param args the command line arguments to parse - * @param the annotated object must implement Callable - * @param the return type of the specified {@code Callable} - * @throws InitializationException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation - * @throws ExecutionException if the Callable throws an exception - * @return {@code null} if an error occurred while parsing the command line options, or if help was requested and printed. Otherwise returns the result of calling the Callable - * @see #parseWithHandlers(IParseResultHandler, PrintStream, Help.Ansi, IExceptionHandler, String...) - * @see RunLast - */ - public static , T> T call( - final C callable, final PrintStream out, final Help.Ansi ansi, final String... args) { - final CommandLine cmd = new CommandLine(callable); // validate command outside of try-catch - final List results = - cmd.parseWithHandlers(new RunLast(), out, ansi, new DefaultExceptionHandler(), args); - return results == null || results.isEmpty() ? null : (T) results.get(0); - } - - /** - * Delegates to {@link #run(Runnable, PrintStream, Help.Ansi, String...)} with {@link Help.Ansi#AUTO}. - *

- * From picocli v2.0, this method prints usage help or version help if {@linkplain #printHelpIfRequested(List, PrintStream, Help.Ansi) requested}, - * and any exceptions thrown by the {@code Runnable} are caught and rethrown wrapped in an {@code ExecutionException}. - *

- * @param runnable the command to run when {@linkplain #parse(String...) parsing} succeeds. - * @param out the printStream to print to - * @param args the command line arguments to parse - * @param the annotated object must implement Runnable - * @see #run(Runnable, PrintStream, Help.Ansi, String...) - * @throws InitializationException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation - * @throws ExecutionException if the Runnable throws an exception - * @see #parseWithHandlers(IParseResultHandler, PrintStream, Help.Ansi, IExceptionHandler, String...) - * @see RunFirst - */ - public static void run(final R runnable, final PrintStream out, final String... args) { - run(runnable, out, Help.Ansi.AUTO, args); - } - /** - * Convenience method to allow command line application authors to avoid some boilerplate code in their application. - * The annotated object needs to implement {@link Runnable}. Calling this method is equivalent to: - * 
-     * CommandLine cmd = new CommandLine(runnable);
-     * List<CommandLine> parsedCommands;
-     * try {
-     *     parsedCommands = cmd.parse(args);
-     * } catch (ParameterException ex) {
-     *     out.println(ex.getMessage());
-     *     cmd.usage(out, ansi);
-     *     return null;
-     * }
-     * if (CommandLine.printHelpIfRequested(parsedCommands, out, ansi)) {
-     *     return null;
-     * }
-     * CommandLine last = parsedCommands.get(parsedCommands.size() - 1);
-     * try {
-     *     Runnable subcommand = last.getCommand();
-     *     subcommand.run();
-     * } catch (Exception ex) {
-     *     throw new ExecutionException(last, "Error running " + last.getCommand(), ex);
-     * }
-     *
- *

- * If the specified Runnable command has subcommands, the {@linkplain RunLast last} subcommand specified on the - * command line is executed. - * Commands with subcommands may be interested in calling the {@link #parseWithHandler(IParseResultHandler, PrintStream, String...) parseWithHandler} - * method with a {@link RunAll} handler or a custom handler. - *

- * From picocli v2.0, this method prints usage help or version help if {@linkplain #printHelpIfRequested(List, PrintStream, Help.Ansi) requested}, - * and any exceptions thrown by the {@code Runnable} are caught and rethrown wrapped in an {@code ExecutionException}. - *

- * @param runnable the command to run when {@linkplain #parse(String...) parsing} succeeds. - * @param out the printStream to print to - * @param ansi whether the usage message should include ANSI escape codes or not - * @param args the command line arguments to parse - * @param the annotated object must implement Runnable - * @throws InitializationException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation - * @throws ExecutionException if the Runnable throws an exception - * @see #parseWithHandlers(IParseResultHandler, PrintStream, Help.Ansi, IExceptionHandler, String...) - * @see RunLast - */ - public static void run( - final R runnable, final PrintStream out, final Help.Ansi ansi, final String... args) { - final CommandLine cmd = new CommandLine(runnable); // validate command outside of try-catch - cmd.parseWithHandlers(new RunLast(), out, ansi, new DefaultExceptionHandler(), args); - } - - /** - * Registers the specified type converter for the specified class. When initializing fields annotated with - * {@link Option}, the field's type is used as a lookup key to find the associated type converter, and this - * type converter converts the original command line argument string value to the correct type. - *

- * Java 8 lambdas make it easy to register custom type converters: - *

- * 
-     * commandLine.registerConverter(java.nio.file.Path.class, s -> java.nio.file.Paths.get(s));
-     * commandLine.registerConverter(java.time.Duration.class, s -> java.time.Duration.parse(s));
- *

- * Built-in type converters are pre-registered for the following java 1.5 types: - *

- *
    - *
  • all primitive types
    • - *
  • all primitive wrapper types: Boolean, Byte, Character, Double, Float, Integer, Long, Short
    • - *
  • any enum
    • - *
  • java.io.File
    • - *
  • java.math.BigDecimal
    • - *
  • java.math.BigInteger
    • - *
  • java.net.InetAddress
    • - *
  • java.net.URI
    • - *
  • java.net.URL
    • - *
  • java.nio.charset.Charset
    • - *
  • java.sql.Time
    • - *
  • java.util.Date
    • - *
  • java.util.UUID
    • - *
  • java.util.regex.Pattern
    • - *
  • StringBuilder
    • - *
  • CharSequence
    • - *
  • String
    • - *
- *

The specified converter will be registered with this {@code CommandLine} and the full hierarchy of its - * subcommands and nested sub-subcommands at the moment the converter is registered. Subcommands added - * later will not have this converter added automatically. To ensure a custom type converter is available to all - * subcommands, register the type converter last, after adding subcommands.

- * - * @param cls the target class to convert parameter string values to - * @param converter the class capable of converting string values to the specified target type - * @param the target type - * @return this CommandLine object, to allow method chaining - * @see #addSubcommand(String, Object) - */ - public CommandLine registerConverter(final Class cls, final ITypeConverter converter) { - interpreter.converterRegistry.put(Assert.notNull(cls, "class"), Assert.notNull(converter, "converter")); - for (final CommandLine command : interpreter.commands.values()) { - command.registerConverter(cls, converter); - } - return this; - } - - /** Returns the String that separates option names from option values when parsing command line options. {@value Help#DEFAULT_SEPARATOR} by default. - * @return the String the parser uses to separate option names from option values */ - public String getSeparator() { - return interpreter.separator; - } - - /** Sets the String the parser uses to separate option names from option values to the specified value. - * The separator may also be set declaratively with the {@link CommandLine.Command#separator()} annotation attribute. - * @param separator the String that separates option names from option values - * @return this {@code CommandLine} object, to allow method chaining */ - public CommandLine setSeparator(final String separator) { - interpreter.separator = Assert.notNull(separator, "separator"); - return this; - } - - /** Returns the command name (also called program name) displayed in the usage help synopsis. {@value Help#DEFAULT_COMMAND_NAME} by default. - * @return the command name (also called program name) displayed in the usage */ - public String getCommandName() { - return commandName; - } - - /** Sets the command name (also called program name) displayed in the usage help synopsis to the specified value. - * Note that this method only modifies the usage help message, it does not impact parsing behaviour. - * The command name may also be set declaratively with the {@link CommandLine.Command#name()} annotation attribute. - * @param commandName command name (also called program name) displayed in the usage help synopsis - * @return this {@code CommandLine} object, to allow method chaining */ - public CommandLine setCommandName(final String commandName) { - this.commandName = Assert.notNull(commandName, "commandName"); - return this; - } - - private static boolean empty(final String str) { - return str == null || str.trim().length() == 0; - } - - private static boolean empty(final Object[] array) { - return array == null || array.length == 0; - } - - private static boolean empty(final Text txt) { - return txt == null || txt.plain.toString().trim().length() == 0; - } - - private static String str(final String[] arr, final int i) { - return (arr == null || arr.length == 0) ? "" : arr[i]; - } - - private static boolean isBoolean(final Class type) { - return type == Boolean.class || type == Boolean.TYPE; - } - - private static CommandLine toCommandLine(final Object obj) { - return obj instanceof CommandLine ? (CommandLine) obj : new CommandLine(obj); - } - - private static boolean isMultiValue(final Field field) { - return isMultiValue(field.getType()); - } - - private static boolean isMultiValue(final Class cls) { - return cls.isArray() || Collection.class.isAssignableFrom(cls) || Map.class.isAssignableFrom(cls); - } - - private static Class[] getTypeAttribute(final Field field) { - final Class[] explicit = field.isAnnotationPresent(Parameters.class) - ? field.getAnnotation(Parameters.class).type() - : field.getAnnotation(Option.class).type(); - if (explicit.length > 0) { - return explicit; - } - if (field.getType().isArray()) { - return new Class[] {field.getType().getComponentType()}; - } - if (isMultiValue(field)) { - final Type type = field.getGenericType(); // e.g. Map - if (type instanceof ParameterizedType) { - final ParameterizedType parameterizedType = (ParameterizedType) type; - final Type[] paramTypes = parameterizedType.getActualTypeArguments(); // e.g. ? extends Number - final Class[] result = new Class[paramTypes.length]; - for (int i = 0; i < paramTypes.length; i++) { - if (paramTypes[i] instanceof Class) { - result[i] = (Class) paramTypes[i]; - continue; - } // e.g. Long - if (paramTypes[i] instanceof WildcardType) { // e.g. ? extends Number - final WildcardType wildcardType = (WildcardType) paramTypes[i]; - final Type[] lower = wildcardType.getLowerBounds(); // e.g. [] - if (lower.length > 0 && lower[0] instanceof Class) { - result[i] = (Class) lower[0]; - continue; - } - final Type[] upper = wildcardType.getUpperBounds(); // e.g. Number - if (upper.length > 0 && upper[0] instanceof Class) { - result[i] = (Class) upper[0]; - continue; - } - } - Arrays.fill(result, String.class); - return result; // too convoluted generic type, giving up - } - return result; // we inferred all types from ParameterizedType - } - return new Class[] {String.class, String.class}; // field is multi-value but not ParameterizedType - } - return new Class[] {field.getType()}; // not a multi-value field - } - /** - *

- * Annotate fields in your class with {@code @Option} and picocli will initialize these fields when matching - * arguments are specified on the command line. - *

- * For example: - *

- * 
import static picocli.CommandLine.*;
-     *
-     * public class MyClass {
-     *     @Parameters(type = File.class, description = "Any number of input files")
-     *     private List<File> files = new ArrayList<File>();
-     *
-     *     @Option(names = { "-o", "--out" }, description = "Output file (default: print to console)")
-     *     private File outputFile;
-     *
-     *     @Option(names = { "-v", "--verbose"}, description = "Verbosely list files processed")
-     *     private boolean verbose;
-     *
-     *     @Option(names = { "-h", "--help", "-?", "-help"}, usageHelp = true, description = "Display this help and exit")
-     *     private boolean help;
-     *
-     *     @Option(names = { "-V", "--version"}, versionHelp = true, description = "Display version information and exit")
-     *     private boolean version;
-     * }
-     *
- *

- * A field cannot be annotated with both {@code @Parameters} and {@code @Option} or a - * {@code ParameterException} is thrown. - *

- */ - @Retention(RetentionPolicy.RUNTIME) - @Target(ElementType.FIELD) - public @interface Option { - /** - * One or more option names. At least one option name is required. - *

- * Different environments have different conventions for naming options, but usually options have a prefix - * that sets them apart from parameters. - * Picocli supports all of the below styles. The default separator is {@code '='}, but this can be configured. - *

- * *nix - *

- * In Unix and Linux, options have a short (single-character) name, a long name or both. - * Short options - * (POSIX - * style are single-character and are preceded by the {@code '-'} character, e.g., {@code `-v'}. - * GNU-style long - * (or mnemonic) options start with two dashes in a row, e.g., {@code `--file'}. - *

Picocli supports the POSIX convention that short options can be grouped, with the last option - * optionally taking a parameter, which may be attached to the option name or separated by a space or - * a {@code '='} character. The below examples are all equivalent: - * 

-         * -xvfFILE
-         * -xvf FILE
-         * -xvf=FILE
-         * -xv --file FILE
-         * -xv --file=FILE
-         * -x -v --file FILE
-         * -x -v --file=FILE
-         *

- * DOS - *

- * DOS options mostly have upper case single-character names and start with a single slash {@code '/'} character. - * Option parameters are separated by a {@code ':'} character. Options cannot be grouped together but - * must be specified separately. For example: - * 

-         * DIR /S /A:D /T:C
-         *

- * PowerShell - *

- * Windows PowerShell options generally are a word preceded by a single {@code '-'} character, e.g., {@code `-Help'}. - * Option parameters are separated by a space or by a {@code ':'} character. - *

- * @return one or more option names - */ - String[] names(); - - /** - * Indicates whether this option is required. By default this is false. - * If an option is required, but a user invokes the program without specifying the required option, - * a {@link MissingParameterException} is thrown from the {@link #parse(String...)} method. - * @return whether this option is required - */ - boolean required() default false; - - /** - * Set {@code help=true} if this option should disable validation of the remaining arguments: - * If the {@code help} option is specified, no error message is generated for missing required options. - *

- * This attribute is useful for special options like help ({@code -h} and {@code --help} on unix, - * {@code -?} and {@code -Help} on Windows) or version ({@code -V} and {@code --version} on unix, - * {@code -Version} on Windows). - *

- *

- * Note that the {@link #parse(String...)} method will not print help documentation. It will only set - * the value of the annotated field. It is the responsibility of the caller to inspect the annotated fields - * and take the appropriate action. - *

- * @return whether this option disables validation of the other arguments - * @deprecated Use {@link #usageHelp()} and {@link #versionHelp()} instead. See {@link #printHelpIfRequested(List, PrintStream, CommandLine.Help.Ansi)} - */ - boolean help() default false; - - /** - * Set {@code usageHelp=true} if this option allows the user to request usage help. If this option is - * specified on the command line, picocli will not validate the remaining arguments (so no "missing required - * option" errors) and the {@link CommandLine#isUsageHelpRequested()} method will return {@code true}. - *

- * This attribute is useful for special options like help ({@code -h} and {@code --help} on unix, - * {@code -?} and {@code -Help} on Windows). - *

- *

- * Note that the {@link #parse(String...)} method will not print usage help documentation. It will only set - * the value of the annotated field. It is the responsibility of the caller to inspect the annotated fields - * and take the appropriate action. - *

- * @return whether this option allows the user to request usage help - * @since 0.9.8 - */ - boolean usageHelp() default false; - - /** - * Set {@code versionHelp=true} if this option allows the user to request version information. If this option is - * specified on the command line, picocli will not validate the remaining arguments (so no "missing required - * option" errors) and the {@link CommandLine#isVersionHelpRequested()} method will return {@code true}. - *

- * This attribute is useful for special options like version ({@code -V} and {@code --version} on unix, - * {@code -Version} on Windows). - *

- *

- * Note that the {@link #parse(String...)} method will not print version information. It will only set - * the value of the annotated field. It is the responsibility of the caller to inspect the annotated fields - * and take the appropriate action. - *

- * @return whether this option allows the user to request version information - * @since 0.9.8 - */ - boolean versionHelp() default false; - - /** - * Description of this option, used when generating the usage documentation. - * @return the description of this option - */ - String[] description() default {}; - - /** - * Specifies the minimum number of required parameters and the maximum number of accepted parameters. - * If an option declares a positive arity, and the user specifies an insufficient number of parameters on the - * command line, a {@link MissingParameterException} is thrown by the {@link #parse(String...)} method. - *

- * In many cases picocli can deduce the number of required parameters from the field's type. - * By default, flags (boolean options) have arity zero, - * and single-valued type fields (String, int, Integer, double, Double, File, Date, etc) have arity one. - * Generally, fields with types that cannot hold multiple values can omit the {@code arity} attribute. - *

- * Fields used to capture options with arity two or higher should have a type that can hold multiple values, - * like arrays or Collections. See {@link #type()} for strongly-typed Collection fields. - *

- * For example, if an option has 2 required parameters and any number of optional parameters, - * specify {@code @Option(names = "-example", arity = "2..*")}. - *

- * A note on boolean options - *

- * By default picocli does not expect boolean options (also called "flags" or "switches") to have a parameter. - * You can make a boolean option take a required parameter by annotating your field with {@code arity="1"}. - * For example:

- * 
@Option(names = "-v", arity = "1") boolean verbose;
- *

- * Because this boolean field is defined with arity 1, the user must specify either {@code -v false} - * or {@code -v true} - * on the command line, or a {@link MissingParameterException} is thrown by the {@link #parse(String...)} - * method. - *

- * To make the boolean parameter possible but optional, define the field with {@code arity = "0..1"}. - * For example:

- * 
@Option(names="-v", arity="0..1") boolean verbose;
- *

This will accept any of the below without throwing an exception:

- * 
-         * -v
-         * -v true
-         * -v false
-         *
- * @return how many arguments this option requires - */ - String arity() default ""; - - /** - * Specify a {@code paramLabel} for the option parameter to be used in the usage help message. If omitted, - * picocli uses the field name in fish brackets ({@code '<'} and {@code '>'}) by default. Example: - * 
class Example {
-         *     @Option(names = {"-o", "--output"}, paramLabel="FILE", description="path of the output file")
-         *     private File out;
-         *     @Option(names = {"-j", "--jobs"}, arity="0..1", description="Allow N jobs at once; infinite jobs with no arg.")
-         *     private int maxJobs = -1;
-         * }
- *

By default, the above gives a usage help message like the following:

-         * Usage: <main class> [OPTIONS]
-         * -o, --output FILE       path of the output file
-         * -j, --jobs [<maxJobs>]  Allow N jobs at once; infinite jobs with no arg.
-         *
- * @return name of the option parameter used in the usage help message - */ - String paramLabel() default ""; - - /**

- * Optionally specify a {@code type} to control exactly what Class the option parameter should be converted - * to. This may be useful when the field type is an interface or an abstract class. For example, a field can - * be declared to have type {@code java.lang.Number}, and annotating {@code @Option(type=Short.class)} - * ensures that the option parameter value is converted to a {@code Short} before setting the field value. - *

- * For array fields whose component type is an interface or abstract class, specify the concrete component type. - * For example, a field with type {@code Number[]} may be annotated with {@code @Option(type=Short.class)} - * to ensure that option parameter values are converted to {@code Short} before adding an element to the array. - *

- * Picocli will use the {@link ITypeConverter} that is - * {@linkplain #registerConverter(Class, ITypeConverter) registered} for the specified type to convert - * the raw String values before modifying the field value. - *

- * Prior to 2.0, the {@code type} attribute was necessary for {@code Collection} and {@code Map} fields, - * but starting from 2.0 picocli will infer the component type from the generic type's type arguments. - * For example, for a field of type {@code Map} picocli will know the option parameter - * should be split up in key=value pairs, where the key should be converted to a {@code java.util.concurrent.TimeUnit} - * enum value, and the value should be converted to a {@code Long}. No {@code @Option(type=...)} type attribute - * is required for this. For generic types with wildcards, picocli will take the specified upper or lower bound - * as the Class to convert to, unless the {@code @Option} annotation specifies an explicit {@code type} attribute. - *

- * If the field type is a raw collection or a raw map, and you want it to contain other values than Strings, - * or if the generic type's type arguments are interfaces or abstract classes, you may - * specify a {@code type} attribute to control the Class that the option parameter should be converted to. - * @return the type(s) to convert the raw String values - */ - Class[] type() default {}; - - /** - * Specify a regular expression to use to split option parameter values before applying them to the field. - * All elements resulting from the split are added to the array or Collection. Ignored for single-value fields. - * @return a regular expression to split option parameter values or {@code ""} if the value should not be split - * @see String#split(String) - */ - String split() default ""; - - /** - * Set {@code hidden=true} if this option should not be included in the usage documentation. - * @return whether this option should be excluded from the usage message - */ - boolean hidden() default false; - } - /** - *

- * Fields annotated with {@code @Parameters} will be initialized with positional parameters. By specifying the - * {@link #index()} attribute you can pick which (or what range) of the positional parameters to apply. If no index - * is specified, the field will get all positional parameters (so it should be an array or a collection). - *

- * When parsing the command line arguments, picocli first tries to match arguments to {@link Option Options}. - * Positional parameters are the arguments that follow the options, or the arguments that follow a "--" (double - * dash) argument on the command line. - *

- * For example: - *

- * 
import static picocli.CommandLine.*;
-     *
-     * public class MyCalcParameters {
-     *     @Parameters(type = BigDecimal.class, description = "Any number of input numbers")
-     *     private List<BigDecimal> files = new ArrayList<BigDecimal>();
-     *
-     *     @Option(names = { "-h", "--help", "-?", "-help"}, help = true, description = "Display this help and exit")
-     *     private boolean help;
-     * }
-     *

- * A field cannot be annotated with both {@code @Parameters} and {@code @Option} or a {@code ParameterException} - * is thrown.

- */ - @Retention(RetentionPolicy.RUNTIME) - @Target(ElementType.FIELD) - public @interface Parameters { - /** Specify an index ("0", or "1", etc.) to pick which of the command line arguments should be assigned to this - * field. For array or Collection fields, you can also specify an index range ("0..3", or "2..*", etc.) to assign - * a subset of the command line arguments to this field. The default is "*", meaning all command line arguments. - * @return an index or range specifying which of the command line arguments should be assigned to this field - */ - String index() default "*"; - - /** Description of the parameter(s), used when generating the usage documentation. - * @return the description of the parameter(s) - */ - String[] description() default {}; - - /** - * Specifies the minimum number of required parameters and the maximum number of accepted parameters. If a - * positive arity is declared, and the user specifies an insufficient number of parameters on the command line, - * {@link MissingParameterException} is thrown by the {@link #parse(String...)} method. - *

The default depends on the type of the parameter: booleans require no parameters, arrays and Collections - * accept zero to any number of parameters, and any other type accepts one parameter.

- * @return the range of minimum and maximum parameters accepted by this command - */ - String arity() default ""; - - /** - * Specify a {@code paramLabel} for the parameter to be used in the usage help message. If omitted, - * picocli uses the field name in fish brackets ({@code '<'} and {@code '>'}) by default. Example: - * 
class Example {
-         *     @Parameters(paramLabel="FILE", description="path of the input FILE(s)")
-         *     private File[] inputFiles;
-         * }
- *

By default, the above gives a usage help message like the following:

-         * Usage: <main class> [FILE...]
-         * [FILE...]       path of the input FILE(s)
-         *
- * @return name of the positional parameter used in the usage help message - */ - String paramLabel() default ""; - - /** - *

- * Optionally specify a {@code type} to control exactly what Class the positional parameter should be converted - * to. This may be useful when the field type is an interface or an abstract class. For example, a field can - * be declared to have type {@code java.lang.Number}, and annotating {@code @Parameters(type=Short.class)} - * ensures that the positional parameter value is converted to a {@code Short} before setting the field value. - *

- * For array fields whose component type is an interface or abstract class, specify the concrete component type. - * For example, a field with type {@code Number[]} may be annotated with {@code @Parameters(type=Short.class)} - * to ensure that positional parameter values are converted to {@code Short} before adding an element to the array. - *

- * Picocli will use the {@link ITypeConverter} that is - * {@linkplain #registerConverter(Class, ITypeConverter) registered} for the specified type to convert - * the raw String values before modifying the field value. - *

- * Prior to 2.0, the {@code type} attribute was necessary for {@code Collection} and {@code Map} fields, - * but starting from 2.0 picocli will infer the component type from the generic type's type arguments. - * For example, for a field of type {@code Map} picocli will know the positional parameter - * should be split up in key=value pairs, where the key should be converted to a {@code java.util.concurrent.TimeUnit} - * enum value, and the value should be converted to a {@code Long}. No {@code @Parameters(type=...)} type attribute - * is required for this. For generic types with wildcards, picocli will take the specified upper or lower bound - * as the Class to convert to, unless the {@code @Parameters} annotation specifies an explicit {@code type} attribute. - *

- * If the field type is a raw collection or a raw map, and you want it to contain other values than Strings, - * or if the generic type's type arguments are interfaces or abstract classes, you may - * specify a {@code type} attribute to control the Class that the positional parameter should be converted to. - * @return the type(s) to convert the raw String values - */ - Class[] type() default {}; - - /** - * Specify a regular expression to use to split positional parameter values before applying them to the field. - * All elements resulting from the split are added to the array or Collection. Ignored for single-value fields. - * @return a regular expression to split operand values or {@code ""} if the value should not be split - * @see String#split(String) - */ - String split() default ""; - - /** - * Set {@code hidden=true} if this parameter should not be included in the usage message. - * @return whether this parameter should be excluded from the usage message - */ - boolean hidden() default false; - } - - /** - *

Annotate your class with {@code @Command} when you want more control over the format of the generated help - * message. - * 

-     * @Command(name      = "Encrypt",
-     *        description = "Encrypt FILE(s), or standard input, to standard output or to the output file.",
-     *        footer      = "Copyright (c) 2017")
-     * public class Encrypt {
-     *     @Parameters(paramLabel = "FILE", type = File.class, description = "Any number of input files")
-     *     private List<File> files     = new ArrayList<File>();
-     *
-     *     @Option(names = { "-o", "--out" }, description = "Output file (default: print to console)")
-     *     private File outputFile;
-     * }
- *

- * The structure of a help message looks like this: - *

    - *
  • [header]
    • - *
  • [synopsis]: {@code Usage: [OPTIONS] [FILE...]}
    • - *
  • [description]
    • - *
  • [parameter list]: {@code [FILE...] Any number of input files}
    • - *
  • [option list]: {@code -h, --help prints this help message and exits}
    • - *
  • [footer]
    • - *
*/ - @Retention(RetentionPolicy.RUNTIME) - @Target({ElementType.TYPE, ElementType.LOCAL_VARIABLE, ElementType.PACKAGE}) - public @interface Command { - /** Program name to show in the synopsis. If omitted, {@code "
"} is used. - * For {@linkplain #subcommands() declaratively added} subcommands, this attribute is also used - * by the parser to recognize subcommands in the command line arguments. - * @return the program name to show in the synopsis - * @see Help#commandName */ - String name() default "
"; - - /** A list of classes to instantiate and register as subcommands. When registering subcommands declaratively - * like this, you don't need to call the {@link CommandLine#addSubcommand(String, Object)} method. For example, this: - * 
-         * @Command(subcommands = {
-         *         GitStatus.class,
-         *         GitCommit.class,
-         *         GitBranch.class })
-         * public class Git { ... }
-         *
-         * CommandLine commandLine = new CommandLine(new Git());
-         *
is equivalent to this: - * 
-         * // alternative: programmatically add subcommands.
-         * // NOTE: in this case there should be no `subcommands` attribute on the @Command annotation.
-         * @Command public class Git { ... }
-         *
-         * CommandLine commandLine = new CommandLine(new Git())
-         *         .addSubcommand("status",   new GitStatus())
-         *         .addSubcommand("commit",   new GitCommit())
-         *         .addSubcommand("branch",   new GitBranch());
-         *
- * @return the declaratively registered subcommands of this command, or an empty array if none - * @see CommandLine#addSubcommand(String, Object) - * @since 0.9.8 - */ - Class[] subcommands() default {}; - - /** String that separates options from option parameters. Default is {@code "="}. Spaces are also accepted. - * @return the string that separates options from option parameters, used both when parsing and when generating usage help - * @see Help#separator - * @see CommandLine#setSeparator(String) */ - String separator() default "="; - - /** Version information for this command, to print to the console when the user specifies an - * {@linkplain Option#versionHelp() option} to request version help. This is not part of the usage help message. - * - * @return a string or an array of strings with version information about this command. - * @since 0.9.8 - * @see CommandLine#printVersionHelp(PrintStream) - */ - String[] version() default {}; - - /** Set the heading preceding the header section. May contain embedded {@linkplain java.util.Formatter format specifiers}. - * @return the heading preceding the header section - * @see Help#headerHeading(Object...) */ - String headerHeading() default ""; - - /** Optional summary description of the command, shown before the synopsis. - * @return summary description of the command - * @see Help#header - * @see Help#header(Object...) */ - String[] header() default {}; - - /** Set the heading preceding the synopsis text. May contain embedded - * {@linkplain java.util.Formatter format specifiers}. The default heading is {@code "Usage: "} (without a line - * break between the heading and the synopsis text). - * @return the heading preceding the synopsis text - * @see Help#synopsisHeading(Object...) */ - String synopsisHeading() default "Usage: "; - - /** Specify {@code true} to generate an abbreviated synopsis like {@code "
[OPTIONS] [PARAMETERS...]"}. - * By default, a detailed synopsis with individual option names and parameters is generated. - * @return whether the synopsis should be abbreviated - * @see Help#abbreviateSynopsis - * @see Help#abbreviatedSynopsis() - * @see Help#detailedSynopsis(Comparator, boolean) */ - boolean abbreviateSynopsis() default false; - - /** Specify one or more custom synopsis lines to display instead of an auto-generated synopsis. - * @return custom synopsis text to replace the auto-generated synopsis - * @see Help#customSynopsis - * @see Help#customSynopsis(Object...) */ - String[] customSynopsis() default {}; - - /** Set the heading preceding the description section. May contain embedded {@linkplain java.util.Formatter format specifiers}. - * @return the heading preceding the description section - * @see Help#descriptionHeading(Object...) */ - String descriptionHeading() default ""; - - /** Optional text to display between the synopsis line(s) and the list of options. - * @return description of this command - * @see Help#description - * @see Help#description(Object...) */ - String[] description() default {}; - - /** Set the heading preceding the parameters list. May contain embedded {@linkplain java.util.Formatter format specifiers}. - * @return the heading preceding the parameters list - * @see Help#parameterListHeading(Object...) */ - String parameterListHeading() default ""; - - /** Set the heading preceding the options list. May contain embedded {@linkplain java.util.Formatter format specifiers}. - * @return the heading preceding the options list - * @see Help#optionListHeading(Object...) */ - String optionListHeading() default ""; - - /** Specify {@code false} to show Options in declaration order. The default is to sort alphabetically. - * @return whether options should be shown in alphabetic order. - * @see Help#sortOptions */ - boolean sortOptions() default true; - - /** Prefix required options with this character in the options list. The default is no marker: the synopsis - * indicates which options and parameters are required. - * @return the character to show in the options list to mark required options - * @see Help#requiredOptionMarker */ - char requiredOptionMarker() default ' '; - - /** Specify {@code true} to show default values in the description column of the options list (except for - * boolean options). False by default. - * @return whether the default values for options and parameters should be shown in the description column - * @see Help#showDefaultValues */ - boolean showDefaultValues() default false; - - /** Set the heading preceding the subcommands list. May contain embedded {@linkplain java.util.Formatter format specifiers}. - * The default heading is {@code "Commands:%n"} (with a line break at the end). - * @return the heading preceding the subcommands list - * @see Help#commandListHeading(Object...) */ - String commandListHeading() default "Commands:%n"; - - /** Set the heading preceding the footer section. May contain embedded {@linkplain java.util.Formatter format specifiers}. - * @return the heading preceding the footer section - * @see Help#footerHeading(Object...) */ - String footerHeading() default ""; - - /** Optional text to display after the list of options. - * @return text to display after the list of options - * @see Help#footer - * @see Help#footer(Object...) */ - String[] footer() default {}; - } - /** - *

- * When parsing command line arguments and initializing - * fields annotated with {@link Option @Option} or {@link Parameters @Parameters}, - * String values can be converted to any type for which a {@code ITypeConverter} is registered. - *

- * This interface defines the contract for classes that know how to convert a String into some domain object. - * Custom converters can be registered with the {@link #registerConverter(Class, ITypeConverter)} method. - *

- * Java 8 lambdas make it easy to register custom type converters: - *

- * 
-     * commandLine.registerConverter(java.nio.file.Path.class, s -> java.nio.file.Paths.get(s));
-     * commandLine.registerConverter(java.time.Duration.class, s -> java.time.Duration.parse(s));
- *

- * Built-in type converters are pre-registered for the following java 1.5 types: - *

- *
    - *
  • all primitive types
    • - *
  • all primitive wrapper types: Boolean, Byte, Character, Double, Float, Integer, Long, Short
    • - *
  • any enum
    • - *
  • java.io.File
    • - *
  • java.math.BigDecimal
    • - *
  • java.math.BigInteger
    • - *
  • java.net.InetAddress
    • - *
  • java.net.URI
    • - *
  • java.net.URL
    • - *
  • java.nio.charset.Charset
    • - *
  • java.sql.Time
    • - *
  • java.util.Date
    • - *
  • java.util.UUID
    • - *
  • java.util.regex.Pattern
    • - *
  • StringBuilder
    • - *
  • CharSequence
    • - *
  • String
    • - *
- * @param the type of the object that is the result of the conversion - */ - public interface ITypeConverter { - /** - * Converts the specified command line argument value to some domain object. - * @param value the command line argument String value - * @return the resulting domain object - * @throws Exception an exception detailing what went wrong during the conversion - */ - K convert(String value) throws Exception; - } - /** Describes the number of parameters required and accepted by an option or a positional parameter. - * @since 0.9.7 - */ - public static class Range implements Comparable { - /** Required number of parameters for an option or positional parameter. */ - public final int min; - /** Maximum accepted number of parameters for an option or positional parameter. */ - public final int max; - - public final boolean isVariable; - private final boolean isUnspecified; - private final String originalValue; - - /** Constructs a new Range object with the specified parameters. - * @param min minimum number of required parameters - * @param max maximum number of allowed parameters (or Integer.MAX_VALUE if variable) - * @param variable {@code true} if any number or parameters is allowed, {@code false} otherwise - * @param unspecified {@code true} if no arity was specified on the option/parameter (value is based on type) - * @param originalValue the original value that was specified on the option or parameter - */ - public Range( - final int min, - final int max, - final boolean variable, - final boolean unspecified, - final String originalValue) { - this.min = min; - this.max = max; - this.isVariable = variable; - this.isUnspecified = unspecified; - this.originalValue = originalValue; - } - /** Returns a new {@code Range} based on the {@link Option#arity()} annotation on the specified field, - * or the field type's default arity if no arity was specified. - * @param field the field whose Option annotation to inspect - * @return a new {@code Range} based on the Option arity annotation on the specified field */ - public static Range optionArity(final Field field) { - return field.isAnnotationPresent(Option.class) - ? adjustForType( - Range.valueOf(field.getAnnotation(Option.class).arity()), field) - : new Range(0, 0, false, true, "0"); - } - /** Returns a new {@code Range} based on the {@link Parameters#arity()} annotation on the specified field, - * or the field type's default arity if no arity was specified. - * @param field the field whose Parameters annotation to inspect - * @return a new {@code Range} based on the Parameters arity annotation on the specified field */ - public static Range parameterArity(final Field field) { - return field.isAnnotationPresent(Parameters.class) - ? adjustForType( - Range.valueOf(field.getAnnotation(Parameters.class).arity()), field) - : new Range(0, 0, false, true, "0"); - } - /** Returns a new {@code Range} based on the {@link Parameters#index()} annotation on the specified field. - * @param field the field whose Parameters annotation to inspect - * @return a new {@code Range} based on the Parameters index annotation on the specified field */ - public static Range parameterIndex(final Field field) { - return field.isAnnotationPresent(Parameters.class) - ? Range.valueOf(field.getAnnotation(Parameters.class).index()) - : new Range(0, 0, false, true, "0"); - } - - static Range adjustForType(final Range result, final Field field) { - return result.isUnspecified ? defaultArity(field) : result; - } - /** Returns the default arity {@code Range}: for {@link Option options} this is 0 for booleans and 1 for - * other types, for {@link Parameters parameters} booleans have arity 0, arrays or Collections have - * arity "0..*", and other types have arity 1. - * @param field the field whose default arity to return - * @return a new {@code Range} indicating the default arity of the specified field - * @since 2.0 */ - public static Range defaultArity(final Field field) { - final Class type = field.getType(); - if (field.isAnnotationPresent(Option.class)) { - return defaultArity(type); - } - if (isMultiValue(type)) { - return Range.valueOf("0..1"); - } - return Range.valueOf("1"); // for single-valued fields (incl. boolean positional parameters) - } - /** Returns the default arity {@code Range} for {@link Option options}: booleans have arity 0, other types have arity 1. - * @param type the type whose default arity to return - * @return a new {@code Range} indicating the default arity of the specified type */ - public static Range defaultArity(final Class type) { - return isBoolean(type) ? Range.valueOf("0") : Range.valueOf("1"); - } - - private int size() { - return 1 + max - min; - } - - static Range parameterCapacity(final Field field) { - final Range arity = parameterArity(field); - if (!isMultiValue(field)) { - return arity; - } - final Range index = parameterIndex(field); - if (arity.max == 0) { - return arity; - } - if (index.size() == 1) { - return arity; - } - if (index.isVariable) { - return Range.valueOf(arity.min + "..*"); - } - if (arity.size() == 1) { - return Range.valueOf(arity.min * index.size() + ""); - } - if (arity.isVariable) { - return Range.valueOf(arity.min * index.size() + "..*"); - } - return Range.valueOf(arity.min * index.size() + ".." + arity.max * index.size()); - } - /** Leniently parses the specified String as an {@code Range} value and return the result. A range string can - * be a fixed integer value or a range of the form {@code MIN_VALUE + ".." + MAX_VALUE}. If the - * {@code MIN_VALUE} string is not numeric, the minimum is zero. If the {@code MAX_VALUE} is not numeric, the - * range is taken to be variable and the maximum is {@code Integer.MAX_VALUE}. - * @param range the value range string to parse - * @return a new {@code Range} value */ - public static Range valueOf(String range) { - range = range.trim(); - final boolean unspecified = range.length() == 0 || range.startsWith(".."); // || range.endsWith(".."); - int min = -1, max = -1; - boolean variable = false; - int dots = -1; - if ((dots = range.indexOf("..")) >= 0) { - min = parseInt(range.substring(0, dots), 0); - max = parseInt(range.substring(dots + 2), Integer.MAX_VALUE); - variable = max == Integer.MAX_VALUE; - } else { - max = parseInt(range, Integer.MAX_VALUE); - variable = max == Integer.MAX_VALUE; - min = variable ? 0 : max; - } - return new Range(min, max, variable, unspecified, range); - } - - private static int parseInt(final String str, final int defaultValue) { - try { - return Integer.parseInt(str); - } catch (final Exception ex) { - return defaultValue; - } - } - /** Returns a new Range object with the {@code min} value replaced by the specified value. - * The {@code max} of the returned Range is guaranteed not to be less than the new {@code min} value. - * @param newMin the {@code min} value of the returned Range object - * @return a new Range object with the specified {@code min} value */ - public Range min(final int newMin) { - return new Range(newMin, Math.max(newMin, max), isVariable, isUnspecified, originalValue); - } - - /** Returns a new Range object with the {@code max} value replaced by the specified value. - * The {@code min} of the returned Range is guaranteed not to be greater than the new {@code max} value. - * @param newMax the {@code max} value of the returned Range object - * @return a new Range object with the specified {@code max} value */ - public Range max(final int newMax) { - return new Range(Math.min(min, newMax), newMax, isVariable, isUnspecified, originalValue); - } - - /** - * Returns {@code true} if this Range includes the specified value, {@code false} otherwise. - * @param value the value to check - * @return {@code true} if the specified value is not less than the minimum and not greater than the maximum of this Range - */ - public boolean contains(final int value) { - return min <= value && max >= value; - } - - @Override - public boolean equals(final Object object) { - if (!(object instanceof Range)) { - return false; - } - final Range other = (Range) object; - return other.max == this.max && other.min == this.min && other.isVariable == this.isVariable; - } - - @Override - public int hashCode() { - return ((17 * 37 + max) * 37 + min) * 37 + (isVariable ? 1 : 0); - } - - @Override - public String toString() { - return min == max ? String.valueOf(min) : min + ".." + (isVariable ? "*" : max); - } - - @Override - public int compareTo(final Range other) { - final int result = min - other.min; - return (result == 0) ? max - other.max : result; - } - } - - static void init( - final Class cls, - final List requiredFields, - final Map optionName2Field, - final Map singleCharOption2Field, - final List positionalParametersFields) { - final Field[] declaredFields = cls.getDeclaredFields(); - for (final Field field : declaredFields) { - field.setAccessible(true); - if (field.isAnnotationPresent(Option.class)) { - final Option option = field.getAnnotation(Option.class); - if (option.required()) { - requiredFields.add(field); - } - for (final String name : option.names()) { // cannot be null or empty - final Field existing = optionName2Field.put(name, field); - if (existing != null && existing != field) { - throw DuplicateOptionAnnotationsException.create(name, field, existing); - } - if (name.length() == 2 && name.startsWith("-")) { - final char flag = name.charAt(1); - final Field existing2 = singleCharOption2Field.put(flag, field); - if (existing2 != null && existing2 != field) { - throw DuplicateOptionAnnotationsException.create(name, field, existing2); - } - } - } - } - if (field.isAnnotationPresent(Parameters.class)) { - if (field.isAnnotationPresent(Option.class)) { - throw new DuplicateOptionAnnotationsException( - "A field can be either @Option or @Parameters, but '" + field.getName() + "' is both."); - } - positionalParametersFields.add(field); - final Range arity = Range.parameterArity(field); - if (arity.min > 0) { - requiredFields.add(field); - } - } - } - } - - static void validatePositionalParameters(final List positionalParametersFields) { - int min = 0; - for (final Field field : positionalParametersFields) { - final Range index = Range.parameterIndex(field); - if (index.min > min) { - throw new ParameterIndexGapException("Missing field annotated with @Parameter(index=" + min - + "). Nearest field '" + field.getName() + "' has index=" + index.min); - } - min = Math.max(min, index.max); - min = min == Integer.MAX_VALUE ? min : min + 1; - } - } - - private static Stack reverse(final Stack stack) { - Collections.reverse(stack); - return stack; - } - /** - * Helper class responsible for processing command line arguments. - */ - private class Interpreter { - private final Map commands = new LinkedHashMap(); - private final Map, ITypeConverter> converterRegistry = new HashMap, ITypeConverter>(); - private final Map optionName2Field = new HashMap(); - private final Map singleCharOption2Field = new HashMap(); - private final List requiredFields = new ArrayList(); - private final List positionalParametersFields = new ArrayList(); - private final Object command; - private boolean isHelpRequested; - private String separator = Help.DEFAULT_SEPARATOR; - private int position; - - Interpreter(final Object command) { - converterRegistry.put(Path.class, new BuiltIn.PathConverter()); - converterRegistry.put(Object.class, new BuiltIn.StringConverter()); - converterRegistry.put(String.class, new BuiltIn.StringConverter()); - converterRegistry.put(StringBuilder.class, new BuiltIn.StringBuilderConverter()); - converterRegistry.put(CharSequence.class, new BuiltIn.CharSequenceConverter()); - converterRegistry.put(Byte.class, new BuiltIn.ByteConverter()); - converterRegistry.put(Byte.TYPE, new BuiltIn.ByteConverter()); - converterRegistry.put(Boolean.class, new BuiltIn.BooleanConverter()); - converterRegistry.put(Boolean.TYPE, new BuiltIn.BooleanConverter()); - converterRegistry.put(Character.class, new BuiltIn.CharacterConverter()); - converterRegistry.put(Character.TYPE, new BuiltIn.CharacterConverter()); - converterRegistry.put(Short.class, new BuiltIn.ShortConverter()); - converterRegistry.put(Short.TYPE, new BuiltIn.ShortConverter()); - converterRegistry.put(Integer.class, new BuiltIn.IntegerConverter()); - converterRegistry.put(Integer.TYPE, new BuiltIn.IntegerConverter()); - converterRegistry.put(Long.class, new BuiltIn.LongConverter()); - converterRegistry.put(Long.TYPE, new BuiltIn.LongConverter()); - converterRegistry.put(Float.class, new BuiltIn.FloatConverter()); - converterRegistry.put(Float.TYPE, new BuiltIn.FloatConverter()); - converterRegistry.put(Double.class, new BuiltIn.DoubleConverter()); - converterRegistry.put(Double.TYPE, new BuiltIn.DoubleConverter()); - converterRegistry.put(File.class, new BuiltIn.FileConverter()); - converterRegistry.put(URI.class, new BuiltIn.URIConverter()); - converterRegistry.put(URL.class, new BuiltIn.URLConverter()); - converterRegistry.put(Date.class, new BuiltIn.ISO8601DateConverter()); - converterRegistry.put(Time.class, new BuiltIn.ISO8601TimeConverter()); - converterRegistry.put(BigDecimal.class, new BuiltIn.BigDecimalConverter()); - converterRegistry.put(BigInteger.class, new BuiltIn.BigIntegerConverter()); - converterRegistry.put(Charset.class, new BuiltIn.CharsetConverter()); - converterRegistry.put(InetAddress.class, new BuiltIn.InetAddressConverter()); - converterRegistry.put(Pattern.class, new BuiltIn.PatternConverter()); - converterRegistry.put(UUID.class, new BuiltIn.UUIDConverter()); - - this.command = Assert.notNull(command, "command"); - Class cls = command.getClass(); - String declaredName = null; - String declaredSeparator = null; - boolean hasCommandAnnotation = false; - while (cls != null) { - init(cls, requiredFields, optionName2Field, singleCharOption2Field, positionalParametersFields); - if (cls.isAnnotationPresent(Command.class)) { - hasCommandAnnotation = true; - final Command cmd = cls.getAnnotation(Command.class); - declaredSeparator = (declaredSeparator == null) ? cmd.separator() : declaredSeparator; - declaredName = (declaredName == null) ? cmd.name() : declaredName; - CommandLine.this.versionLines.addAll(Arrays.asList(cmd.version())); - - for (final Class sub : cmd.subcommands()) { - final Command subCommand = sub.getAnnotation(Command.class); - if (subCommand == null || Help.DEFAULT_COMMAND_NAME.equals(subCommand.name())) { - throw new InitializationException("Subcommand " + sub.getName() - + " is missing the mandatory @Command annotation with a 'name' attribute"); - } - try { - final Constructor constructor = sub.getDeclaredConstructor(); - constructor.setAccessible(true); - final CommandLine commandLine = toCommandLine(constructor.newInstance()); - commandLine.parent = CommandLine.this; - commands.put(subCommand.name(), commandLine); - } catch (final InitializationException ex) { - throw ex; - } catch (final NoSuchMethodException ex) { - throw new InitializationException( - "Cannot instantiate subcommand " + sub.getName() + ": the class has no constructor", - ex); - } catch (final Exception ex) { - throw new InitializationException( - "Could not instantiate and add subcommand " + sub.getName() + ": " + ex, ex); - } - } - } - cls = cls.getSuperclass(); - } - separator = declaredSeparator != null ? declaredSeparator : separator; - CommandLine.this.commandName = declaredName != null ? declaredName : CommandLine.this.commandName; - Collections.sort(positionalParametersFields, new PositionalParametersSorter()); - validatePositionalParameters(positionalParametersFields); - - if (positionalParametersFields.isEmpty() && optionName2Field.isEmpty() && !hasCommandAnnotation) { - throw new InitializationException(command + " (" + command.getClass() - + ") is not a command: it has no @Command, @Option or @Parameters annotations"); - } - } - - /** - * Entry point into parsing command line arguments. - * @param args the command line arguments - * @return a list with all commands and subcommands initialized by this method - * @throws ParameterException if the specified command line arguments are invalid - */ - List parse(final String... args) { - Assert.notNull(args, "argument array"); - if (tracer.isInfo()) { - tracer.info("Parsing %d command line args %s%n", args.length, Arrays.toString(args)); - } - final Stack arguments = new Stack(); - for (int i = args.length - 1; i >= 0; i--) { - arguments.push(args[i]); - } - final List result = new ArrayList(); - parse(result, arguments, args); - return result; - } - - private void parse( - final List parsedCommands, - final Stack argumentStack, - final String[] originalArgs) { - // first reset any state in case this CommandLine instance is being reused - isHelpRequested = false; - CommandLine.this.versionHelpRequested = false; - CommandLine.this.usageHelpRequested = false; - - final Class cmdClass = this.command.getClass(); - if (tracer.isDebug()) { - tracer.debug( - "Initializing %s: %d options, %d positional parameters, %d required, %d subcommands.%n", - cmdClass.getName(), - new HashSet(optionName2Field.values()).size(), - positionalParametersFields.size(), - requiredFields.size(), - commands.size()); - } - parsedCommands.add(CommandLine.this); - final List required = new ArrayList(requiredFields); - final Set initialized = new HashSet(); - Collections.sort(required, new PositionalParametersSorter()); - try { - processArguments(parsedCommands, argumentStack, required, initialized, originalArgs); - } catch (final ParameterException ex) { - throw ex; - } catch (final Exception ex) { - final int offendingArgIndex = originalArgs.length - argumentStack.size() - 1; - final String arg = offendingArgIndex >= 0 && offendingArgIndex < originalArgs.length - ? originalArgs[offendingArgIndex] - : "?"; - throw ParameterException.create(CommandLine.this, ex, arg, offendingArgIndex, originalArgs); - } - if (!isAnyHelpRequested() && !required.isEmpty()) { - for (final Field missing : required) { - if (missing.isAnnotationPresent(Option.class)) { - throw MissingParameterException.create(CommandLine.this, required, separator); - } else { - assertNoMissingParameters(missing, Range.parameterArity(missing).min, argumentStack); - } - } - } - if (!unmatchedArguments.isEmpty()) { - if (!isUnmatchedArgumentsAllowed()) { - throw new UnmatchedArgumentException(CommandLine.this, unmatchedArguments); - } - if (tracer.isWarn()) { - tracer.warn("Unmatched arguments: %s%n", unmatchedArguments); - } - } - } - - private void processArguments( - final List parsedCommands, - final Stack args, - final Collection required, - final Set initialized, - final String[] originalArgs) - throws Exception { - // arg must be one of: - // 1. the "--" double dash separating options from positional arguments - // 1. a stand-alone flag, like "-v" or "--verbose": no value required, must map to boolean or Boolean field - // 2. a short option followed by an argument, like "-f file" or "-ffile": may map to any type of field - // 3. a long option followed by an argument, like "-file out.txt" or "-file=out.txt" - // 3. one or more remaining arguments without any associated options. Must be the last in the list. - // 4. a combination of stand-alone options, like "-vxr". Equivalent to "-v -x -r", "-v true -x true -r true" - // 5. a combination of stand-alone options and one option with an argument, like "-vxrffile" - - while (!args.isEmpty()) { - String arg = args.pop(); - if (tracer.isDebug()) { - tracer.debug( - "Processing argument '%s'. Remainder=%s%n", arg, reverse((Stack) args.clone())); - } - - // Double-dash separates options from positional arguments. - // If found, then interpret the remaining args as positional parameters. - if ("--".equals(arg)) { - tracer.info("Found end-of-options delimiter '--'. Treating remainder as positional parameters.%n"); - processRemainderAsPositionalParameters(required, initialized, args); - return; // we are done - } - - // if we find another command, we are done with the current command - if (commands.containsKey(arg)) { - if (!isHelpRequested && !required.isEmpty()) { // ensure current command portion is valid - throw MissingParameterException.create(CommandLine.this, required, separator); - } - if (tracer.isDebug()) { - tracer.debug( - "Found subcommand '%s' (%s)%n", - arg, - commands.get(arg).interpreter.command.getClass().getName()); - } - commands.get(arg).interpreter.parse(parsedCommands, args, originalArgs); - return; // remainder done by the command - } - - // First try to interpret the argument as a single option (as opposed to a compact group of options). - // A single option may be without option parameters, like "-v" or "--verbose" (a boolean value), - // or an option may have one or more option parameters. - // A parameter may be attached to the option. - boolean paramAttachedToOption = false; - final int separatorIndex = arg.indexOf(separator); - if (separatorIndex > 0) { - final String key = arg.substring(0, separatorIndex); - // be greedy. Consume the whole arg as an option if possible. - if (optionName2Field.containsKey(key) && !optionName2Field.containsKey(arg)) { - paramAttachedToOption = true; - final String optionParam = arg.substring(separatorIndex + separator.length()); - args.push(optionParam); - arg = key; - if (tracer.isDebug()) { - tracer.debug("Separated '%s' option from '%s' option parameter%n", key, optionParam); - } - } else { - if (tracer.isDebug()) { - tracer.debug( - "'%s' contains separator '%s' but '%s' is not a known option%n", - arg, separator, key); - } - } - } else { - if (tracer.isDebug()) { - tracer.debug("'%s' cannot be separated into