dev.jeka.core.tool.Main Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jeka-core Show documentation
Show all versions of jeka-core Show documentation
Build and Run Java Code from Everywhere
/*
* Copyright 2014-2024 the original author or authors.
*
* Licensed 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
*
* https://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 dev.jeka.core.tool;
import dev.jeka.core.api.depmanagement.JkDependencySet;
import dev.jeka.core.api.depmanagement.JkRepo;
import dev.jeka.core.api.depmanagement.JkRepoProperties;
import dev.jeka.core.api.depmanagement.JkRepoSet;
import dev.jeka.core.api.file.JkPathSequence;
import dev.jeka.core.api.java.JkClassLoader;
import dev.jeka.core.api.java.JkUrlClassLoader;
import dev.jeka.core.api.system.*;
import dev.jeka.core.api.text.Jk2ColumnsText;
import dev.jeka.core.api.utils.JkUtilsPath;
import dev.jeka.core.api.utils.JkUtilsString;
import dev.jeka.core.api.utils.JkUtilsSystem;
import dev.jeka.core.api.utils.JkUtilsTime;
import dev.jeka.core.tool.CommandLine.Model.CommandSpec;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
public class Main {
public static void main(String[] args) {
// Remove -r arguments sent by shell script
String[] filteredArgs = new CmdLineArgs(args).withoutShellArgs().get();
// Get the code base directory sent by script shell
String basedirProp = System.getProperty("jeka.current.basedir");
Path workingDir = Paths.get("");
Path baseDir = basedirProp == null ? workingDir : Paths.get(basedirProp);
if (baseDir.startsWith(workingDir)) {
baseDir = workingDir.relativize(baseDir);
}
exec(baseDir, args);
}
// TODO Make non-public. Replace by a call creating a new OS process
public static JkRunbase exec(Path baseDir, String ...args) {
long startTime = System.currentTimeMillis();
CmdLineArgs cmdArgs = new CmdLineArgs(args);
// Handle --help
// It needs to be fast and safe. Only loads KBeans found in current classpath
if (cmdArgs.isUsageHelpRequested()) {
PicocliHelp.printUsageHelp(System.out);
System.exit(0);
}
// Handle --version
if (cmdArgs.isVersionHelpRequested()) {
PicocliHelp.printVersionHelp(System.out);
System.exit(0);
}
// Interpolate command line with values found in properties
JkProperties props = dev.jeka.core.tool.JkRunbase.constructProperties(baseDir);
CmdLineArgs interpolatedArgs = cmdArgs.interpolated(props).withoutShellArgs();
LogSettings logs = LogSettings.ofDefault();
Engine engine = null;
try {
// first, parse only options
PicocliMainCommand mainCommand = new PicocliMainCommand();
CommandLine commandLine = new CommandLine(CommandSpec.forAnnotatedObject(mainCommand));
commandLine.parseArgs(interpolatedArgs.withOptionsOnly().get());
logs = mainCommand.logSettings();
BehaviorSettings behavior = mainCommand.behaviorSettings();
JkDependencySet dependencies = mainCommand.dependencies();
// setup logging
setupLogging(logs, baseDir, interpolatedArgs.get());
// Instantiate the Engine
JkRepoSet downloadRepos = JkRepoProperties.of(props).getDownloadRepos();
engine = Engine.of(baseDir, behavior.skipCompile,
downloadRepos, dependencies, logs, behavior);
// Compile jeka-src and resolve the dependencies and kbeans
JkConsoleSpinner.of("Booting JeKa...").run(engine::resolveKBeans);
if (logs.runtimeInformation) {
logRuntimeInfoBase(engine, props);
}
// Resolve KBeans
Engine.KBeanResolution kBeanResolution = engine.getKbeanResolution();
Engine.ClasspathSetupResult classpathSetupResult = engine.getClasspathSetupResult();
JkLog.debug("Found KBeans : %s" , kBeanResolution.allKbeans);
// Augment current classloader with resolved deps and compiled classes
ClassLoader augmentedClassloader = JkUrlClassLoader.of(classpathSetupResult.runClasspath).get();
Thread.currentThread().setContextClassLoader(augmentedClassloader);
// Handle doc ([kbean]: --doc)
String kbeanDoc = cmdArgs.kbeanDoc();
if (kbeanDoc != null) {
JkRunbase.setKBeanResolution(kBeanResolution);
boolean isDefaultKBean = "-default-".equals(kbeanDoc) && kBeanResolution.defaultKbeanClassname != null;
String kbean = isDefaultKBean ? kBeanResolution.defaultKbeanClassname : kbeanDoc;
if (JkUtilsString.isBlank(kbean) ) {
PicocliHelp.printCmdHelp(
engine.resolveClassPaths().runClasspath,
kBeanResolution,
props,
System.out);
System.exit(0);
}
boolean found = PicocliHelp.printKBeanHelp(
engine.resolveClassPaths().runClasspath,
kBeanResolution.allKbeans,
kbean,
System.out);
if (!found) {
System.err.printf("No KBean named '%s' found in classpath. Execute 'jeka --doc' to see available KBeans.", kbeanDoc);
System.exit(1);
}
System.exit(0);
}
// Validate KBean properties
if (!behavior.forceMode) {
validateKBeanProps(props, kBeanResolution.allKbeans);
}
// Parse command line to get action beans
KBeanAction.Container actionContainer = CmdLineParser.parse(
interpolatedArgs.withoutOptions(),
kBeanResolution);
// Prepend the init bean in action container
kBeanResolution.findInitBeanClass().ifPresent(actionContainer::addInitBean);
if (logs.runtimeInformation) {
logRuntimeInfoEngineCommands(actionContainer);
}
// Run
engine.initRunbase(actionContainer);
if (logs.runtimeInformation) {
logRuntimeInfoRun(engine.getRunbase());
}
engine.run();
logOutro(logs, startTime);
} catch (CommandLine.ParameterException e) {
JkBusyIndicator.stop();
String errorTxt = CommandLine.Help.Ansi.AUTO.string("@|red ERROR: |@");
CommandLine commandLine = e.getCommandLine();
commandLine.getErr().println(errorTxt + e.getMessage());
String suggestTxt = CommandLine.Help.Ansi.AUTO.string("Try @|yellow jeka --doc|@ to see available commands and parameters");
if (e.getMessage().startsWith("Unknown option")) {
suggestTxt = CommandLine.Help.Ansi.AUTO.string("Try @|yellow jeka --help|@ to see available options");
}
commandLine.getErr().println(suggestTxt);
if (logs.stackTrace) {
e.printStackTrace(commandLine.getErr());
}
System.exit(1);
} catch (Throwable t) {
handleGenericThrowable(t, startTime, logs);
System.exit(1);
}
return engine.getRunbase();
}
static void displayRuntimeInfo(Path baseDir, String[] cmdLine) {
Jk2ColumnsText txt = Jk2ColumnsText.of(18, 150);
txt.add("Working Directory", System.getProperty("user.dir"));
txt.add("Base Directory", baseDir);
txt.add("Command Line", String.join(" ", Arrays.asList(cmdLine)));
txt.add("Console Detected", JkUtilsSystem.CONSOLE != null);
txt.add("Java Home", System.getProperty("java.home"));
txt.add("Java Version", System.getProperty("java.version") + ", " + System.getProperty("java.vendor"));
txt.add("Jeka Version", JkInfo.getJekaVersion());
if ( embedded(JkLocator.getJekaHomeDir().normalize())) {
txt.add("Jeka Home", Paths.get(JkConstants.JEKA_BOOT_DIR).normalize() + " ( embedded !!! )");
} else {
txt.add("Jeka Home", JkLocator.getJekaHomeDir().normalize());
}
txt.add("Jeka User Home", JkLocator.getJekaUserHomeDir().toAbsolutePath().normalize());
txt.add("Jeka Cache Dir", JkLocator.getCacheDir().toAbsolutePath().normalize());
JkProperties properties = JkRunbase.constructProperties(Paths.get(""));
txt.add("Download Repos", JkRepoProperties.of(properties).getDownloadRepos().getRepos().stream()
.map(JkRepo::getUrl).collect(Collectors.toList()));
JkLog.info(txt.toString());
}
private static boolean embedded(Path jarFolder) {
if (!Files.exists(bootDir())) {
return false;
}
return JkUtilsPath.isSameFile(bootDir(), jarFolder);
}
private static Path bootDir() {
return Paths.get(JkConstants.JEKA_BOOT_DIR);
}
// This class should lies outside PicocliMainCommand to be referenced inn annotation
static class VersionProvider implements CommandLine.IVersionProvider {
@Override
public String[] getVersion() throws Exception {
return new String[] {JkInfo.getJekaVersion()};
}
}
private static void setupLogging(LogSettings logSettings, Path baseDir, String[] cmdLine) {
JkLog.setLogOnlyOnStdErr(logSettings.logOnStderr);
JkLog.setDecorator(logSettings.style);
if (logSettings.runtimeInformation) {
displayRuntimeInfo(baseDir, cmdLine);
}
if (logSettings.quiet) {
JkLog.setVerbosity(JkLog.Verbosity.MUTE);
} else if (logSettings.debug) {
JkLog.setVerbosity(JkLog.Verbosity.DEBUG);
} else if(logSettings.verbose) {
JkLog.setVerbosity(JkLog.Verbosity.VERBOSE);
}
// By default, log working animation when working dir = base dir (this mean that we are not
// invoking a tool packaged with JeKa.
Path workingDir = Paths.get("").toAbsolutePath();
boolean logAnimation = baseDir.toAbsolutePath().normalize().equals(workingDir);
if (logSettings.animation != null) {
logAnimation = logSettings.animation;
}
JkLog.setAcceptAnimation(logAnimation);
JkLog.setShowTaskDuration(logSettings.duration);
}
private static void displayDuration(long startTs) {
System.out.println("\nTotal Duration: " + JkUtilsTime.formatMillis(System.currentTimeMillis() - startTs));
}
private static void logRuntimeInfoBase(Engine engine, JkProperties props) {
JkLog.info(Jk2ColumnsText.of(18, 150)
.add("Init KBean", engine.resolveKBeans().initKBeanClassname)
.add("Default KBean", engine.resolveKBeans().defaultKbeanClassname)
.toString());
JkLog.info("Properties :");
JkLog.info(props.toColumnText(30, 90, !JkLog.isVerbose())
.setMarginLeft(" | ")
.setSeparator(" | ").toString());
JkPathSequence cp = engine.getClasspathSetupResult().runClasspath;
JkLog.info("Jeka Classpath :");
cp.forEach(entry -> JkLog.info(" | " + entry));
}
private static void logRuntimeInfoEngineCommands(KBeanAction.Container actionContainer) {
JkLog.info("Command Line :");
JkLog.info(actionContainer.toColumnText()
.setSeparator(" | ")
.setMarginLeft(" | ")
.toString());
}
private static void logRuntimeInfoRun(JkRunbase runbase) {
List beanNames = runbase.getBeans().stream()
.map(Object::getClass)
.map(KBean::name)
.collect(Collectors.toList());
JkLog.info("Involved KBeans :", beanNames);
JkLog.info(" " + String.join(", ", beanNames));
JkLog.info("");
}
private static void logOutro(LogSettings logs, long start) {
if (logs.duration) {
displayDuration(start);
}
}
private static void handleGenericThrowable(Throwable t, long start, LogSettings logs) {
JkBusyIndicator.stop();
JkLog.restoreToInitialState();
if (t.getMessage() != null) {
String txt = CommandLine.Help.Ansi.AUTO.string("@|red Error: |@" + t.getMessage());
System.err.println(txt);
} else {
String failedText = CommandLine.Help.Ansi.AUTO.string("@|red Failed! |@");
System.err.println(failedText);
}
String suggestTxt = CommandLine.Help.Ansi.AUTO.string("You can investigate using @|yellow --verbose|@, " +
"@|yellow --debug|@, @|yellow --stacktrace|@, @|yellow --doc|@ , @|yellow --inspect|@ " +
"or @|yellow -ls=DEBUG|@ options.");
System.err.println(suggestTxt);
System.err.println("If this originates from a bug, please report the issue at: " +
"https://github.com/jeka-dev/jeka/issues");
if ( (!(t instanceof JkException)) || shouldPrintExceptionDetails(logs)) {
printException(logs, t);
}
}
private static boolean shouldPrintExceptionDetails(LogSettings logs) {
return logs.verbose || logs.debug || logs.stackTrace;
}
private static void printException(LogSettings logs, Throwable e) {
System.err.println();
if (logs.verbose || logs.stackTrace) {
System.err.println("=============================== Stack Trace =============================================");
e.printStackTrace(System.err);
System.err.flush();
System.err.println("=========================================================================================");
}
}
private static void validateKBeanProps(JkProperties props, List allKbeanClassNames) {
Set propNames = props.getAllStartingWith("@", false).keySet();
for (String propName : propNames) {
String beanName = propName.contains(".") ?
JkUtilsString.substringBeforeFirst(propName, ".") : propName;
String kbeanClassName = null;
for (String kbeanClazz : allKbeanClassNames) {
if (KBean.nameMatches(kbeanClazz, beanName)) {
kbeanClassName = kbeanClazz;
break;
}
}
if (kbeanClassName == null) {
throw new IllegalStateException("Property '@" + propName + "' does not match to any KBean. " +
"Execute `jeka --doc' to see available KBeans.");
}
if (propName.contains(".")) {
String fieldName = JkUtilsString.substringAfterFirst(propName, ".");
Class kbeanClass = JkClassLoader.ofCurrent().load(kbeanClassName);
if (!KBeanDescription.of(kbeanClass, false).isContainingField(fieldName)) {
throw new IllegalStateException("Property '@" + propName + "' does not match any field in "
+ beanName + " KBean. Execute 'jeka " + beanName + ": --doc' to see available fields.");
}
}
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy