Jump to: navigation, search

Difference between revisions of "Equinox/p2/Engine/Touchpoint Instructions"

< Equinox‎ | p2‎ | Engine
(Authoring touchpoint data)
Line 298: Line 298:
  
 
= Authoring touchpoint data =
 
= Authoring touchpoint data =
Touchpoint data can be added to a bundle by adding a file called p2.inf to the bundle's META-INF directory. The format of this file is key=value pairs as follow:
+
== Touchpoint advice file format ==
 +
Touchpoint instructions can be added to an installable unit at development time by writing a touchpoint advice file (p2.inf). The format of this file is key=value pairs as follow:
  
 
   instructions.<phase> = <raw actions>
 
   instructions.<phase> = <raw actions>
Line 309: Line 310:
 
     ln(targetDir:@artifact,linkTarget:foo/lib.1.so,linkName:lib.so);\
 
     ln(targetDir:@artifact,linkTarget:foo/lib.1.so,linkName:lib.so);\
 
     chmod(targetDir:@artifact,targetFile:lib/lib.so,permissions:755);
 
     chmod(targetDir:@artifact,targetFile:lib/lib.so,permissions:755);
 +
 +
== Where the touchpoint advice file can be used ==
 +
In Eclipse 3.4, touchpoint advice files were only supported in bundles. An advice file placed in the bundle at META-INF/p2.inf would be processed at PDE build time to add the instructions to the installable unit corresponding to the bundle.  In Eclipse 3.5, touchpoint advice files can be placed:
 +
* In bundles (META-INF/p2.inf): The instructions are added to the installable unit for the bundle
 +
* In features (META-INF/p2.inf): The instructions are added to the installable unit for the feature
 +
* In products (a p2.inf file co-located with the .product file): The instructions are added to the root installable unit for that product.
  
 
[[Category:Equinox p2|Touchpoint Instructions]]
 
[[Category:Equinox p2|Touchpoint Instructions]]

Revision as of 11:37, 5 December 2008

Introduction

A p2 Installable Unit (IU) is installed using the facilities provided by a touchpoint. The IU metadata consists of a reference to the touchpoint (Touchpoint Type) which also defines the version of the touchpoint (i.e an expectancy that it supports a certain set of operations), and describes instructions to execute in various p2 engine phases. The instructions are named after the phases - the phases "install", "uninstall", "configure", "unconfigure" are of interest when authoring, but there are also some internal phases such as "collect" and "checktrust" executed by the engine. Each instruction (e.g. "install") describes a sequence of actions to execute on the referenced touchpoint. Examples of actions are create and remove directories, change permissons, install and remove bundles. Currently, two touchpoints (native, and eclipse) have been implemented. The native touchpoint has approximately 5 different actions, and the eclipse touchpoint has approximately 20. Most of these actions take parameters. This wiki page describes these actions in detail.

The instructions are grouped and described in a Touchpoint Data Element. The touchpoint data element uses a Map where the key is the name of a p2 engine phase (such as "install"), and the value is a string representation of a sequence of actions. Using multiple touchpoint data elements is useful as it allows separation between sets of actions for install/uninstall/configure/unconfigure which makes it easier to maintain the meta data.

This wiki page describes the two touchpoints, the instructions they understand, and the format used to represent an action sequence.

Actions

Native Touchpoint Actions

The native touchpoint is used to install things "outside of eclipse".

instruction parameters description
cleanupzip source, target removes unzipped files and directories that where unzipped from source into target - i.e. an "undo operation" of an unzip instruction.
unzip source, target unzips the source into the target directory. The source can be the special @artifact source path, which denotes the download cache location for the first artifact key in the IU. Comments in code indicates that the use of @artifact may be deprecated.
chmod targetDir, targetFile, permissions changes mode on the targetFile in the targetDir (a path), permissions is written the same way as to the system command chmod,
collect - collects all associated artifacts for an IU and places them in a local touchpoint addressable cache. This action is not meant to be called directly and is used as part of the main Collect and Sizing phases.
link targetDir, linkTarget, linkName, force Performs the system action ln -s with the parameters linkTarget being the source-file, targetDir is the directory where the symbolic link will be created, and linkName is the name of the resulting link in the targetDir. The force parameter is a boolean in string form (i.e. "true"/"false") and indicates if an existing link with the same name should be removed before the new link is created.
the parameter names are quite confusing

Eclipse Touchpoint Actions

instruction parameters description
collect - collects all associated artifacts for an IU and places them in a local touchpoint addressable cache. This action is not meant to be called directly and is used as part of the main Collect and Sizing phases.
installBundle bundle Installs a bundle artifact specified by the parameter bundle
uninstallBundle bundle Uninstalls a bundle artifact with a bundle-id specified by the paramter bundle
addSourceBundle bundle Installs a source bundle artifact with the bundle-id specified by the parameter bundle
removeSourceBundle bundle Removes/uninstalls the source bundle artifact with the bundle-id specified by the parameter bundle
installFeature feature, featureId, version Installs the feature referenced by the parameter feature (matched against artifacts in the iu). The feature is installed with the id specified by the parameter featureId, or if this parameter has the value default, with the id specified in the artifact referenced by feature. The features is installed with the version specified in version, or with the version specified in the artifact referenced by the feature parameter if the version parameter has the value default
uninstallFeature feature, featureId, version Uninstalls a feature. Parameters have the same meaning as for the command installFeature
setLauncherName name Sets the name of the launcher to name. The launcher name is used to configure launcher name specific ini files.
addProgramArgument programArg Adds the string specified in the parameter programArg as an argument to the program. If the parameters is the special value @artifact, the location of the artifact referenced by the first artifact key in the IU is used as the parameter value.
removeProgramArgument programArg Removes the program argument specified in the string programArg - if the parameters is the special value @artifact, the location of the artifact referenced by the first artifact key in the IU is used as the parameter value.
setStartLevel startLevel Sets the start level to the integer value specified in the parameter startValue
markStarted started Marks the bundle referenced by the first artifact key in the IU as started / not started, as controlled by the boolean parameter started (in string form i.e. "true"/"false").
setFrameworkDependentProperty propName, propValue Sets the framework dependant property named propName to the value specified in propValue. Framework dependent properties are properties specific to the Equinox implementation of the OSGi framework.
setFrameworkIndependentProperty propName, propValue Sets the framework independant property named propName to the value specified in propValue. Framework independent properties do not specifically target Eclipse and are generally applicable to other OSGi frameworks.
setProgramProperty propName, propValue Sets the program property named propName to the value specified in propValue. Program properties are used by the executable program to among other things locate the jars needed to start Eclipse.
addJVMArg jvmArg Adds the string specified in the parameter jvmArg to the arguments passed to the JVM.
removeJVMArg jvmArg Removes the string specified in the parameter jvmArg from the arguments passed to the JVM.
mkdir path Creates the directory specified by the parameter path.
rmdir path Removes the directory specified by the parameter path.
link targetDir, linkTarget, linkName, force Performs the system action ln -s with the parameters linkTarget being the source-file, targetDir is the directory where the symbolic link will be created, and linkName is the name of the resulting link in the targetDir. The force parameter is a boolean in string form (i.e. "true"/"false") and indicates if an existing link with the same name should be removed before the new link is created. If the parameter targetDir is set to the special value @artifact, the source is the file specified by the first artifact key in the IU.
the parameter names are quite confusing
chmod targetDir, targetFile, permissions Changes permission on a file using the system chmod command. The targetDir parameter is either a path, or the special @artifact which is a reference to the directory where the first artifact included in the installable unit is located. The parameter targetFile is the name of a file, and permissions is written like for the chmod system command.
checkTrust - collects the set of bundle files on which the signature trust check should be performed. The checkTrust action is not meant to be user callable and is done as part of the CheckTrust phase.
addRepository location, type, enabled Adds the repository at location of type type to the list of known repositories. The repository will then be available when installing or updating the profile in the future. The enabled parameter takes a boolean value ("true" or "false") indicating whether the add repository should be enabled. The value of the location parameter must be a well-formed URI. The type parameter value must be the value of one of the IRepository.TYPE_* constants, Specifically, type "0" indicates a metadata repository, and type "1" indicates an artifact repository.
removeRepository location, type Removes the repository at location of type type from the list of known

repositories. The value of the location parameter must be a well-formed URI. The type parameter value must be the value of one of the IRepository.TYPE_* constants, Specifically, type "0" indicates a metadata repository, and type "1" indicates an artifact repository.

Action Format

The Touchpoint Data Element has a Map that describes the actions to execute in the various p2 engine phases (e.g. "install", "uninstall", "configure", "unconfigure", "collect" and "checktrust"). The key of the Map entry is the name of a phase (i.e. when the actions should be executed), and the value is a statement-sequence:

  statement-sequence :
      | statement ';'
      | statement-sequence statement
      ;

Where a statement is of the format:

  statement :
      | actionName '(' parameters ')'
      ;
  parameters :
      | // empty
      | parameter
      | parameters ',' parameter
      ;
   parameter : 
      | paramName ':' paramValue
      ;

 actionName, paramName, paramValue :
      | String 
      ;

In the p2 engine, the Phase will lookup the "actionName" using it's own phase specific actions (e.g. "collect") and also those made available by the associated touchpoint (e.g. "mkdir" in the native touchpoint, and "installBundle" in the Eclipse touchpoint) .

As an example - an "install" instruction for a bundle might consist of the following statement:

  installBundle(bundle:${artifact});
  • installBundle is the action name
  • bundle is the parameter name
  • ${artifact} is the parameter value. The value ${artifact} signifies the use of a pre-defined variable named "artifact".

Built-in Action Variables

What follows is a catalog of the variables made available by the phases and touchpoints. Many of these are mostly useful to the implementor of new actions and touchpoint types.

Variables Available in all phases

variable description
#nnnn the unicode value of a character.

Note: This is especially important for the six characters that require escaping.

  1. $ = ${#36}
  2. , = ${#44}
  3.  : = ${#58}
  4.  ; = ${#59}
  5. { = ${#123}
  6. } = ${#125}
profile the profile being modified.
phaseId the name of the phase e.g. collect, install, etc.
operand the actions operand (e.g. IU pair)
touchpoint the touchpoint associated with the IUs in the operand

Collect Phase Variables

variable description
artifactRequests A list that a touchpoints "collect" action will use to add mirroring requests to.

Unconfigure Phase Variables

variable description
iu The IU being unconfigured. This is set from the first IU of the operand pair.
artifact The artifact id of the first artifact listed in the IU.

Uninstall Phase Variables

variable description
iu The IU being uninstalled. This is set from the first IU of the operand pair.
artifact The artifact id of the first artifact listed in the IU.

Install Phase Variables

variable description
iu The IU being installed. This is set from the second IU of the operand pair.
artifact The artifact id of the first artifact listed in the IU.

Configure Phase Variables

variable description
iu The IU being configured. This is set from the second IU of the operand pair.
artifact The artifact id of the first artifact listed in the IU.

Eclipse Touchpoint Variables

variable description
manipulator an instance of the Manipulator class used to alter the configuration of an Eclipse install.
installFolder the root folder for this profile.

Native Touchpoint Variables

variable description
installFolder the root folder for this profile.

Authoring touchpoint data

Touchpoint advice file format

Touchpoint instructions can be added to an installable unit at development time by writing a touchpoint advice file (p2.inf). The format of this file is key=value pairs as follow:

 instructions.<phase> = <raw actions>

Where <phase> is one of the p2 phases (collect, configure, install, uninstall, unconfigure, etc). The <raw actions> will be appended to the end of any instructions already being generated.

As a concrete example chmod/ln would look something like

 instructions.install = \
    ln(targetDir:@artifact,linkTarget:foo/lib.1.so,linkName:lib.so);\
    chmod(targetDir:@artifact,targetFile:lib/lib.so,permissions:755);

Where the touchpoint advice file can be used

In Eclipse 3.4, touchpoint advice files were only supported in bundles. An advice file placed in the bundle at META-INF/p2.inf would be processed at PDE build time to add the instructions to the installable unit corresponding to the bundle. In Eclipse 3.5, touchpoint advice files can be placed:

  • In bundles (META-INF/p2.inf): The instructions are added to the installable unit for the bundle
  • In features (META-INF/p2.inf): The instructions are added to the installable unit for the feature
  • In products (a p2.inf file co-located with the .product file): The instructions are added to the root installable unit for that product.