brooklyn.cli.Main Maven / Gradle / Ivy
package brooklyn.cli;
import groovy.lang.GroovyClassLoader;
import groovy.lang.GroovyShell;
import java.io.InputStream;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.util.Arrays;
import java.util.Collection;
import java.util.concurrent.Callable;
import javax.inject.Inject;
import org.iq80.cli.Cli;
import org.iq80.cli.Cli.CliBuilder;
import org.iq80.cli.Command;
import org.iq80.cli.Help;
import org.iq80.cli.Option;
import org.iq80.cli.OptionType;
import org.iq80.cli.ParseException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import brooklyn.BrooklynVersion;
import brooklyn.entity.Application;
import brooklyn.entity.Entity;
import brooklyn.entity.basic.AbstractApplication;
import brooklyn.entity.basic.AbstractEntity;
import brooklyn.entity.basic.ApplicationBuilder;
import brooklyn.entity.basic.Entities;
import brooklyn.entity.basic.StartableApplication;
import brooklyn.entity.proxying.EntitySpec;
import brooklyn.entity.proxying.EntitySpecs;
import brooklyn.entity.trait.Startable;
import brooklyn.launcher.BrooklynLauncher;
import brooklyn.launcher.BrooklynServerDetails;
import brooklyn.management.ManagementContext;
import brooklyn.util.ResourceUtils;
import brooklyn.util.text.Strings;
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.joran.JoranConfigurator;
import ch.qos.logback.core.util.StatusPrinter;
import com.google.common.annotations.Beta;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Objects;
import com.google.common.base.Objects.ToStringHelper;
import com.google.common.collect.ImmutableList;
public class Main {
// Launch banner
public static final String BANNER =
" _ _ _ \n" +
"| |__ _ __ ___ ___ | | _| |_ _ _ __ (R)\n" +
"| '_ \\| '__/ _ \\ / _ \\| |/ / | | | | '_ \\ \n" +
"| |_) | | | (_) | (_) | <| | |_| | | | |\n" +
"|_.__/|_| \\___/ \\___/|_|\\_\\_|\\__, |_| |_|\n" +
" |___/ "+BrooklynVersion.get()+"\n";
// Error codes
public static final int SUCCESS = 0;
public static final int PARSE_ERROR = 1;
public static final int EXECUTION_ERROR = 2;
public static final Logger log = LoggerFactory.getLogger(Main.class);
public static void main(String... args) {
Cli parser = buildCli();
try {
log.debug("Parsing command line arguments: {}", Arrays.asList(args));
BrooklynCommand command = parser.parse(args);
log.debug("Executing command: {}", command);
command.call();
System.exit(SUCCESS);
} catch (ParseException pe) { // looks like the user typed it wrong
System.err.println("Parse error: " + pe.getMessage()); // display
// error
System.err.println(getUsageInfo(parser)); // display cli help
System.exit(PARSE_ERROR);
} catch (Exception e) { // unexpected error during command execution
log.error("Execution error: {}\n{}" + e.getMessage(), e.getStackTrace());
System.err.println("Execution error: " + e.getMessage());
e.printStackTrace();
System.exit(EXECUTION_ERROR);
}
}
public static abstract class BrooklynCommand implements Callable {
@Inject
public Help help;
@Option(type = OptionType.GLOBAL, name = { "-v", "--verbose" }, description = "Verbose mode")
public boolean verbose = false;
@Option(type = OptionType.GLOBAL, name = { "-q", "--quiet" }, description = "Quiet mode")
public boolean quiet = false;
public ToStringHelper string() {
return Objects.toStringHelper(getClass())
.add("verbose", verbose)
.add("quiet", quiet);
}
@Override
public String toString() {
return string().toString();
}
}
@Command(name = "help", description = "Display help for available commands")
public static class HelpCommand extends BrooklynCommand {
@Override
public Void call() throws Exception {
if (log.isDebugEnabled()) log.debug("Invoked help command: {}", this);
return help.call();
}
}
@Command(name = "info", description = "Display information about brooklyn")
public static class InfoCommand extends BrooklynCommand {
@Override
public Void call() throws Exception {
if (log.isDebugEnabled()) log.debug("Invoked info command: {}", this);
// Get current version
String version = BrooklynVersion.get();
// Display info text
System.out.println(BANNER);
System.out.println("Version: " + version);
System.out.println("Website: http://brooklyn.io/");
System.out.println("Source: https://github.com/brooklyncentral/brooklyn/");
System.out.println();
System.out.println("Copyright 2011-2013 by Cloudsoft Corp.");
System.out.println("Licensed under the Apache 2.0 License");
System.out.println();
return null;
}
}
@Command(name = "launch", description = "Starts a brooklyn application. " +
"Note that a BROOKLYN_CLASSPATH environment variable needs to be set up beforehand " +
"to point to the user application classpath.")
public static class LaunchCommand extends BrooklynCommand {
@Option(name = { "--localBrooklynProperties" }, title = "local brooklyn.properties file",
description = "local brooklyn.properties file, specific to this launch (appending to and overriding global properties)")
public String localBrooklynProperties;
@Option(name = { "-a", "--app" }, title = "application class or file",
description = "The Application to start. " +
"For example my.AppName or file://my/AppName.groovy or classpath://my/AppName.groovy")
public String app;
@Beta
@Option(name = { "-s", "--script" }, title = "script URI",
description = "EXPERIMENTAL. URI for a Groovy script to parse and load." +
" This script will run before starting the app.")
public String script = null;
@Option(name = { "-l", "--location", "--locations" }, title = "location list",
description = "Specifies the locations where the application will be launched. " +
"You can specify more than one location like this: \"loc1,loc2,loc3\"")
public String locations;
@Option(name = { "-p", "--port" }, title = "port number",
description = "Specifies the port to be used by the Brooklyn Management Console.")
public String port = "8081+";
@Option(name = { "-nc", "--noConsole" },
description = "Whether to start the web console")
public boolean noConsole = false;
@Option(name = { "--noConsoleSecurity" },
description = "Whether to disable security for the web console with no security (i.e. no authentication required)")
public Boolean noConsoleSecurity = false;
@Option(name = { "-ns", "--noShutdownOnExit" },
description = "Whether to stop the application when the JVM exits")
public boolean noShutdownOnExit = false;
/**
* Note that this is a temporary workaround to allow for running the
* brooklyn-whirr example.
*
* This will be replaced by more powerful CLI control for running
* processes, to send shutdown and other commands to brooklyn.
*
* Without using this flag you get a
* java.util.concurrent.RejectedExecutionException because the brooklyn
* and whirr shutdown hooks get executed in parallel. This is how it
* looks like: {@linktourl https://gist.github.com/47066f72d6f6f79b953e}
*/
@Beta
@Option(name = { "-sk", "--stopOnKeyPress" },
description = "After the application gets started, brooklyn will wait for a key press to stop it.")
public boolean stopOnKeyPress = false;
@Override
public Void call() throws Exception {
if (log.isDebugEnabled()) log.debug("Invoked launch command {}", this);
if (!quiet) System.out.println(BANNER);
if (verbose) {
if (app != null) {
System.out.println("Launching brooklyn app: " + app + " in " + locations);
} else {
System.out.println("Launching brooklyn server (no app)");
}
}
if (Strings.isBlank(locations)) {
if (app != null) {
System.err.println("Locations parameter not supplied: assuming localhost");
locations = "localhost";
}
} else {
if (app == null) {
System.err.println("Locations specified without any applications; ignoring locations");
}
}
ResourceUtils utils = new ResourceUtils(this);
ClassLoader parent = utils.getLoader();
GroovyClassLoader loader = new GroovyClassLoader(parent);
// First, run a setup script if the user has provided one
if (script != null) {
execGroovyScript(utils, loader, script);
}
BrooklynLauncher launcher = BrooklynLauncher.newInstance();
launcher
.localBrooklynPropertiesFile(localBrooklynProperties)
.webconsolePort(port)
.webconsole(!noConsole)
.shutdownOnExit(!noShutdownOnExit)
.locations(Strings.isBlank(locations) ? ImmutableList.of() : ImmutableList.of(locations));
if (noConsoleSecurity)
launcher.installSecurityFilter(false);
if (app != null) {
// Create the instance of the brooklyn app
log.debug("Load the user's application: {}", app);
Object loadedApp = loadApplicationFromClasspathOrParse(utils, loader, app);
if (loadedApp instanceof ApplicationBuilder) {
launcher.application((ApplicationBuilder)loadedApp);
} else if (loadedApp instanceof Application) {
launcher.application((AbstractApplication)loadedApp);
} else {
throw new IllegalStateException("Unexpected application type "+(loadedApp==null ? null : loadedApp.getClass())+", for app "+loadedApp);
}
}
// Launch server
try {
launcher.start();
} catch (Exception e) {
// Don't terminate the VM; leave it as-is until someone explicitly stops it
log.error("Error starting brooklyn app(s)", e);
}
BrooklynServerDetails server = launcher.getServerDetails();
ManagementContext ctx = server.getManagementContext();
// Force load of catalog (so web console is up to date)
ctx.getCatalog().getCatalogItems();
if (verbose) {
Entities.dumpInfo(launcher.getApplications());
}
if (stopOnKeyPress) {
// Wait for the user to type a key
log.info("Server started. Press return to stop.");
System.in.read();
stopAllApps(ctx.getApplications());
} else {
// Block forever so that Brooklyn doesn't exit (until someone does cntrl-c or kill)
log.info("Launched Brooklyn; now blocking to wait for cntrl-c or kill");
waitUntilInterrupted();
}
return null;
}
@VisibleForTesting
void waitUntilInterrupted() {
Object mutex = new Object();
synchronized (mutex) {
try {
while (!Thread.currentThread().isInterrupted()) {
mutex.wait();
log.debug("Spurious wake in brooklyn Main while waiting for interrupt, how about that!");
}
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
return; // exit gracefully
}
}
}
@VisibleForTesting
void execGroovyScript(ResourceUtils utils, GroovyClassLoader loader, String script) {
log.debug("Running the user provided script: {}", script);
String content = utils.getResourceAsString(script);
GroovyShell shell = new GroovyShell(loader);
shell.evaluate(content);
}
/**
* Helper method that gets an instance of a brooklyn {@link AbstractApplication} or an {@link ApplicationBuilder}.
* Guaranteed to be non-null result of one of those types (throwing exception if app not appropriate).
*/
@VisibleForTesting
Object loadApplicationFromClasspathOrParse(ResourceUtils utils, GroovyClassLoader loader, String app)
throws SecurityException, NoSuchMethodException, IllegalArgumentException, InstantiationException,
IllegalAccessException, InvocationTargetException {
// Load the app class
Class tempclazz;
try {
log.debug("Trying to load application as class on classpath: {}", app);
tempclazz = loader.loadClass(app, true, false);
} catch (ClassNotFoundException cnfe) { // Not a class on the classpath
log.debug("Loading \"{}\" as class on classpath failed, now trying as .groovy source file", app);
String content = utils.getResourceAsString(app);
tempclazz = loader.parseClass(content);
}
final Class clazz = tempclazz;
// Intantiate an app builder (wrapping app class in ApplicationBuilder, if necessary)
if (ApplicationBuilder.class.isAssignableFrom(clazz)) {
Constructor constructor = clazz.getConstructor();
return (ApplicationBuilder) constructor.newInstance();
} else if (StartableApplication.class.isAssignableFrom(clazz)) {
@SuppressWarnings("unchecked")
EntitySpec appSpec = EntitySpecs.appSpec((Class)clazz);
return new ApplicationBuilder(appSpec) {
@Override protected void doBuild() {
}};
} else if (AbstractApplication.class.isAssignableFrom(clazz)) {
// TODO If this application overrides init() then in trouble, as that won't get called!
// TODO grr; what to do about non-startable applications?
// without this we could return ApplicationBuilder rather than Object
Constructor constructor = clazz.getConstructor();
return (AbstractApplication) constructor.newInstance();
} else if (AbstractEntity.class.isAssignableFrom(clazz)) {
// TODO Should we really accept any entity type, and just wrap it in an app? That's not documented!
return new ApplicationBuilder() {
@SuppressWarnings("unchecked")
@Override protected void doBuild() {
addChild(EntitySpecs.spec(Entity.class).impl((Class)clazz));
}};
} else if (Entity.class.isAssignableFrom(clazz)) {
return new ApplicationBuilder() {
@SuppressWarnings("unchecked")
@Override protected void doBuild() {
addChild(EntitySpecs.spec((Class)clazz));
}};
} else {
throw new IllegalArgumentException("Application class "+clazz+" must extend one of ApplicationBuilder or AbstractApplication");
}
}
@VisibleForTesting
void stopAllApps(Collection applications) {
for (Application application : applications) {
try {
if (application instanceof Startable) {
((Startable)application).stop();
}
} catch (Exception e) {
log.error("Error stopping "+application+": "+e, e);
}
}
}
@Override
public ToStringHelper string() {
return super.string()
.add("app", app)
.add("script", script)
.add("location", locations)
.add("port", port)
.add("noConsole", noConsole)
.add("noConsoleSecurity", noConsoleSecurity)
.add("noShutdownOnExit", noShutdownOnExit)
.add("stopOnKeyPress", stopOnKeyPress)
.add("localBrooklynProperties", localBrooklynProperties);
}
}
@VisibleForTesting
static Cli buildCli() {
@SuppressWarnings({ "unchecked" })
CliBuilder builder = Cli.buildCli("brooklyn", BrooklynCommand.class)
.withDescription("Brooklyn Management Service")
.withCommands(
HelpCommand.class,
InfoCommand.class,
LaunchCommand.class
);
return builder.build();
}
static String getUsageInfo(Cli parser) {
StringBuilder help = new StringBuilder();
help.append("\n");
Help.help(parser.getMetadata(), ImmutableList.of("brooklyn"), help);
help.append("See 'brooklyn help ' for more information on a specific command.");
return help.toString();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy