Skip to content
Browse files

First update to launcher documentation

  • Loading branch information...
1 parent 21df141 commit 0a79f1ebbd8088788f0144b1a13110df5d2976d6 @harrah committed Oct 24, 2009
Showing with 87 additions and 49 deletions.
  1. +87 −49 launch.specification
View
136 launch.specification
@@ -4,79 +4,96 @@ The sbt launcher component is a self-contained jar that boots a Scala applicatio
= Overview =
-A user downloads the sbt launcher jar and creates a script to run it (here, the script will be assumed to be called 'launch'):
+A user downloads the launcher jar and creates a script to run it. In this documentation, the script will be assumed to be called 'launch'. For unix, the script would look like:
+{{{
java -jar sbt-launcher.jar "$@"
+}}}
-The user then downloads the configuration file for the application (call it my.app.configuration) and creates a script to launch it (call it myapp):
+The user then downloads the configuration file for the application (call it `my.app.configuration`) and creates a script to launch it (call it `myapp`):
+{{{
launch @my.app.configuration "$@"
+}}}
The user can then launch the application using
+{{{
myapp arg1 arg2 ...
+}}}
-Like the launcher used to distribute sbt, the downloaded launcher jar will retrieve Scala and the application. The difference is that this behavior is now configurable. The versions may be fixed or read from a configuration file (the location of which is also configurable). The location to which the Scala and application jars are downloaded is configurable as well. The repositories searched are configurable.
+Like the launcher used to distribute `sbt`, the downloaded launcher jar will retrieve Scala and the application. The difference is that this behavior is now configurable. The versions may be fixed or read from a configuration file (the location of which is also configurable). The location to which the Scala and application jars are downloaded is configurable as well. The repositories searched are configurable. Optional initialization of a properties file is configurable.
-Once the launcher has downloaded the jars, it loads the application and calls its entry point. The application is passed information about how it was called: command line arguments, current working directory, Scala version, and application ID (organization, name, version). In addition, the launcher can ask the launcher to perform operations such as obtaining the Scala jars and a ClassLoader for any version of Scala retrievable from the repositories specified in the configuration file. It can request that other applications be downloaded and run. When the application completes, it can tell the launcher to exit with a specific exit code or to reload the application with a different version of Scala, a different version of the application, and different arguments.
+Once the launcher has downloaded the necessary jars, it loads the application and calls its entry point. The application is passed information about how it was called: command line arguments, current working directory, Scala version, and application ID (organization, name, version). In addition, the launcher can ask the launcher to perform operations such as obtaining the Scala jars and a `ClassLoader` for any version of Scala retrievable from the repositories specified in the configuration file. It can request that other applications be downloaded and run. When the application completes, it can tell the launcher to exit with a specific exit code or to reload the application with a different version of Scala, a different version of the application, or different arguments.
-There are some other options for setup, such as putting the configuration file inside the sbt launcher jar and distributing that as a single download. The rest of this documentation describes the details of configuring, writing, distributing, and running the application.
+There are some other options for setup, such as putting the configuration file inside the launcher jar and distributing that as a single download. The rest of this documentation describes the details of configuring, writing, distributing, and running the application.
== Configuration ==
The launcher may be configured in one of the following ways in increasing order of precedence:
- * Replace the /sbt/sbt.boot.properties file in the jar
- * Put a configuration file named sbt.boot.properties on the classpath. Put it in the classpath root without the /sbt prefix.
- * Specify the location of an alternate configuration on the command line. This can be done by either specifying the location as the system property 'sbt.boot.properties' or as the first argument to the launcher prefixed by '@'. The system property has lower precedence. Resolution of a relative path is first attempted against the current working directory, then against the user's home directory, and then against the directory containing the launcher jar. An error is generated if none of these attempts succeed.
-
-The configuration file is line-based, read as UTF-8 encoded, and defined by the following grammer. 'nl' is a newline or end of file and 'text' is plain text without newlines or the surrounding delimiters (such as parentheses or square brackets):
+ * Replace the `/sbt/sbt.boot.properties` file in the jar
+ * Put a configuration file named `sbt.boot.properties` on the classpath. Put it in the classpath root without the `/sbt` prefix.
+ * Specify the location of an alternate configuration on the command line. This can be done by either specifying the location as the system property `sbt.boot.properties` or as the first argument to the launcher prefixed by `'@'`. The system property has lower precedence. Resolution of a relative path is first attempted against the current working directory, then against the user's home directory, and then against the directory containing the launcher jar. An error is generated if none of these attempts succeed.
+The configuration file is line-based, read as UTF-8 encoded, and defined by the following grammer. `'nl'` is a newline or end of file and `'text'` is plain text without newlines or the surrounding delimiters (such as parentheses or square brackets):
+{{{
configuration ::= scala app repositories boot log app-properties
- scala ::= '[' 'scala' ']' nl versionSpecification nl
- app ::= '[' 'app' ']' nl org nl name nl versionSpecification nl components nl class nl cross-versioned nl
+ scala ::= '[' 'scala' ']' nl version nl
+ app ::= '[' 'app' ']' nl org nl name nl version nl components nl class nl cross-versioned nl
repositories ::= '[' 'repositories' ']' nl (repository nl)*
- boot ::= '[' 'boot' ']' nl directory nl properties nl search nl
+ boot ::= '[' 'boot' ']' nl directory nl bootProperties nl search nl promptCreate nl promptFill nl quickOption nl
log ::= '[' 'log' ']' nl logLevel nl
app-properties ::= '[' 'app-properties' ']' nl property*
- directory ::= 'directory' ':' path
- properties ::= 'properties' ':' path
- search ::= 'search' ':' ('none'|'nearest'|'root-first'|'only') (',' path)*
- logLevel ::= 'log-level' ':' ('debug' | 'info' | 'warn' | 'error')
-
- versionSpecification ::= 'version' ':' ( ( 'read' [defaultVersion] ) | fixedVersion )
- defaultVersion ::= text
- fixedVersion ::= text
+ directory ::= 'directory' ':' path
+ bootProperties ::= 'properties' ':' path
+ search ::= 'search' ':' ('none'|'nearest'|'root-first'|'only') (',' path)*
+ logLevel ::= 'log-level' ':' ('debug' | 'info' | 'warn' | 'error')
+ promptCreate ::= 'prompt-create' ':' label
+ promptFill ::= 'prompt-fill' ':' boolean
+ quickOption ::= 'quick-option' ':' boolean
+
+ version ::= 'version' ':' versionSpecification
+ versionSpecification ::= readProperty | fixedVersion
+ readProperty ::= 'read' '(' propertyName ')' '[' default ']'
+ fixedVersion ::= text
org ::= 'org' ':' text
name ::= 'name' ':' text
class ::= 'class' ':' text
components ::= 'components' ':' component (',' component)*
- cross-versioned ::= 'cross-versioned' ':' ('true' | 'false')
+ cross-versioned ::= 'cross-versioned' ':' boolean
- repository ::= ( predefinedRepository | ( label ':' url [',' pattern] ) ) nl
- predefinedRepository ::= 'local' | 'maven-local' | 'maven-central' | 'scala-tools-releases' | 'scala-tools-snapshots'
+ repository ::= ( predefinedRepository | customRepository ) nl
+ predefinedRepository ::= 'local' | 'maven-local' | 'maven-central' | 'scala-tools-releases' | 'scala-tools-snapshots'
+ customRepository ::= label ':' url [',' pattern]
property ::= label ':' propertyDefinition (',' propertyDefinition)* nl
- propertyDefinition ::= ('quick' | 'new' | 'fill') '=' (set | prompt)
- set ::= 'set' '(' text ')'
- prompt ::= 'prompt' '(' text ')' ('[' text ']')?
-
+ propertyDefinition ::= mode '=' (set | prompt)
+ mode ::= 'quick' | 'new' | 'fill'
+ set ::= 'set' '(' value ')'
+ prompt ::= 'prompt' '(' label ')' ('[' default ']')?
+
+ boolean ::= 'true' | 'false'
+ path, propertyName, label, default ::= text
+}}}
The default configuration file for sbt looks like:
-
+{{{
[scala]
- version: read
+ version: read(def.scala.version)
[app]
org: org.scala-tools.sbt
name: sbt
- version: read
+ version: read(sbt.version)
class: sbt.xMain
components: xsbti
cross-versioned: true
[repositories]
local
maven-local
+ sbt: file:///home/mark/.ivy2/test/, [organization]/[module]/[revision]/[type]s/[artifact](-[classifier]).[ext]
maven-central
scala-tools-releases
+ scala-tools-snapshots
[boot]
directory: project/boot
@@ -90,22 +107,39 @@ The default configuration file for sbt looks like:
[app-properties]
project.name: quick=set(test), new=prompt(Name), fill=prompt(Name)
+ project.organization: new=prompt(Organization)
project.version: quick=set(1.0), new=prompt(Version)[1.0], fill=prompt(Version)[1.0]
- build.init.scala.version: quick=set(2.7.5), new=prompt(Scala version)[2.7.5]
- scala.version: quick=set(2.7.5), new=set(2.7.5), fill=set(2.7.5)
- sbt.version: quick=set(0.5.6-SNAPSHOT), new=prompt(sbt version)[0.5.6-SNAPSHOT], fill=prompt(sbt version)[0.5.6-SNAPSHOT]
+ def.scala.version: quick=set(2.7.5), new=set(2.7.5), fill=set(2.7.5)
+ build.scala.versions: quick=set(2.7.5), new=prompt(Scala version)[2.7.5], fill=prompt(Scala version)[2.7.5]
+ sbt.version: quick=set(0.6.0), new=prompt(sbt version)[0.6.0], fill=prompt(sbt version)[0.6.0]
project.scratch: quick=set(true)
project.initialize: quick=set(true), new=set(true)
+}}}
+
+The `scala.version` property specifies the version of Scala used to run the application. The `app.org`, `app.name`, and `app.version` properties specify the organization, module ID, and version of the application, respectively. These are used to resolve and retrieve the application from the repositories listed in `[repositories]`. If `app.cross-versioned` is true, the resolved module ID is `{app.name+'_'+scala.version}`
+
+Jars are retrieved to the directory given by `boot.directory`. You can make this an absolute path to be shared by all sbt instances on the machine. You might see messages like:
+{{{
+ Waiting for lock on <lock-file> to be available...
+}}}
+if multiple versions access it simultaneously.
-The scala.version property specifies the version of Scala used to run the application. The app.org, app.name, and app.version properties specify the organization, module ID, and version of the application, respectively. These are used to resolve and retrieve the application from the repositories listed in [repositories]. If app.cross-versioned is true, the resolved module ID is {app.name+'_'+scala.version}
+The `boot.properties` property specifies the location of the properties file to use if `app.version` or `scala.version` is specified as `read`. The `prompt-create`, `prompt-fill`, and `quick-option` properties together with the property definitions in `[app.properties]` can be used to initialize the `boot.properties` file.
-The app.class property specifies the name of the entry point to the application. An application entry point must be a public class with a no-argument constructor that implements xsbti.AppMain. The AppMain interface specifies the entry method signature 'run'. The run method is passed an instance of AppConfiguration, which provides access to the startup environment. AppConfiguration also provides an interface to retrieve other versions of Scala or other applications. Finally, the return type of the run method is `xsbti.MainResult`, which has two subtypes: xsbti.Reboot and xsbti.Exit. To exit with a specific code, return an instance of xsbti.Exit with the requested code. To restart the application, return an instance of Reboot. You can change some aspects of the configuration with a reboot, such as the version of Scala, the application ID, and the arguments.
+The app.class property specifies the name of the entry point to the application. An application entry point must be a public class with a no-argument constructor that implements `xsbti.AppMain`. The `AppMain` interface specifies the entry method signature 'run'. The run method is passed an instance of AppConfiguration, which provides access to the startup environment. `AppConfiguration` also provides an interface to retrieve other versions of Scala or other applications. Finally, the return type of the run method is `xsbti.MainResult`, which has two subtypes: `xsbti.Reboot` and `xsbti.Exit`. To exit with a specific code, return an instance of `xsbti.Exit` with the requested code. To restart the application, return an instance of Reboot. You can change some aspects of the configuration with a reboot, such as the version of Scala, the application ID, and the arguments.
== Execution ==
-On startup, the launcher searches for its configuration in the order described in the Configuration section and then parses it. If either the Scala version or the application version are specified as 'read', the launcher determines them in the following manner. The file given by the 'boot.properties' property is read as a Java properties file to obtain the version. The expected property names are ${app.name}.version for the application version (where ${app.name} is replaced with the value of the app.name property from the boot configuration file) and scala.version for the Scala version. If the properties file does not exist, the default value provided is used. If no default was provided, an error is generated.
+On startup, the launcher searches for its configuration in the order described in the Configuration section and then parses it. If either the Scala version or the application version are specified as 'read', the launcher determines them in the following manner. The file given by the 'boot.properties' property is read as a Java properties file to obtain the version. The expected property names are `${app.name}.version` for the application version (where `${app.name}` is replaced with the value of the `app.name` property from the boot configuration file) and `scala.version` for the Scala version. If the properties file does not exist, the default value provided is used. If no default was provided, an error is generated.
-Once the final configuration is resolved, the launcher proceeds to obtain the necessary jars to launch the application. The 'boot.directory' property is used as a base directory to retrieve jars to. No locking is done on the directory, so it should not be shared system-wide. The launcher retrieves the requested version of Scala to ${boot.directory}/${scala.version}/lib/. If this directory already exists, the launcher takes a shortcut for performance and assumes that the jars have already been downloaded. If the directory does not exist, the launcher uses Apache Ivy to resolve and retrieve the jars. A similar process occurs for the application itself. It and its dependencies are retreived to ${boot.directory}/${scala.version}/${app.org}/${app.name}/.
+Once the final configuration is resolved, the launcher proceeds to obtain the necessary jars to launch the application. The `boot.directory` property is used as a base directory to retrieve jars to. No locking is done on the directory, so it should not be shared system-wide. The launcher retrieves the requested version of Scala to
+{{{
+${boot.directory}/${scala.version}/lib/
+}}}
+If this directory already exists, the launcher takes a shortcut for startup performance and assumes that the jars have already been downloaded. If the directory does not exist, the launcher uses Apache Ivy to resolve and retrieve the jars. A similar process occurs for the application itself. It and its dependencies are retreived to
+{{{
+${boot.directory}/${scala.version}/${app.org}/${app.name}/.
+}}}
Once all required code is downloaded, the class loaders are set up. The launcher creates a class loader for the requested version of Scala. It then creates a child class loader containing the jars for the requested 'app.components'. An application that does not use components will have all of its jars in this class loader.
@@ -114,11 +148,11 @@ The main class for the application is then instantiated. It must be a public cl
== Creating a Launched Application ==
This section shows how to make an application that is launched by this launcher. First, declare a dependency on the launcher-interface. Do not declare a dependency on the launcher itself. The launcher interface consists strictly of Java interfaces in order to avoid binary incompatibility between the version of Scala used to compile the launcher and the version used to compile your application. The launcher interface class will be provided by the launcher, so it is only a compile-time dependency. If you are building with sbt, your dependency definition would be:
-
+{{{
val launchInterface = "org.scala-tools.sbt" % "launcher-interface" % "0.7" % "provided"
-
-Make the entry point to your class implement 'xsbti.AppMain'. An example that uses some of the information av:
-
+}}}
+Make the entry point to your class implement 'xsbti.AppMain'. An example that uses some of the information:
+{{{
package xsbt.test
class Main extends xsbti.AppMain
{
@@ -146,9 +180,9 @@ class Main extends xsbti.AppMain
}
class Exit(val code) extends xsbti.Exit
}
-
+}}}
Next, define a configuration file for the launcher. For the above class, it might look like:
-
+{{{
[scala]
version: 2.7.5
[app]
@@ -165,12 +199,16 @@ Next, define a configuration file for the launcher. For the above class, it mig
# scala-tools-snapshots
[boot]
directory: boot
-
-Then, +publish-local the application to make it available.
+}}}
+Then, `publish-local` or `+publish-local` the application to make it available.
== Running an Application ==
As mentioned above, there are a few options to actually run the application. The first involves providing a modified jar for download. The second two require providing a configuration file for download.
-1) Replace the /sbt/sbt.boot.properties file in the launcher jar and distribute the modified jar. The user would need to run 'java -jar your-launcher.jar arg1 arg2 ...'.
-2) The user downloads the vanilla sbt launcher jar and you provide the sbt.boot.properties file. The user would need to run 'java -Dsbt.boot.properties=your.boot.properties -jar sbt-launcher.jar'.
-3) The user sets up the sbt launcher, including the bash script. You provide the sbt.boot.properties file and the user runs sbt @your.boot.properties arg1 arg2.
+1) Replace the /sbt/sbt.boot.properties file in the launcher jar and distribute the modified jar. The user would need a script to run 'java -jar your-launcher.jar arg1 arg2 ...'.
+2) The user downloads the launcher jar and you provide the configuration file.
+ i) The user needs to run 'java -Dsbt.boot.properties=your.boot.properties -jar launcher.jar'.
+ ii) The user already has a script to run the launcher (call it 'launch'). The user needs to run
+{{{
+ launch @your.boot.properties your-arg-1 your-arg-2
+}}}

0 comments on commit 0a79f1e

Please sign in to comment.
Something went wrong with that request. Please try again.