FPM (Fantom Pod Manager)User Guide
FPM (Fantom Pod Manager) is a support library that aids Alien-Factory in the development of other libraries, frameworks and applications. Though you are welcome to use it, you may find features are missing and the documentation incomplete.
Fantom Pod Manager (FPM) provides a targeted environment for building, testing, and running Fantom applications.
It provides tools to:
- query repositories for pod versions
- install / uninstall pod versions
- update dependencies for applications
It is one of those boring system libraries you quickly find you can't do without!
A typical Fantom installation only allows one version of any given pod. This works fine if you're just developing and running the one application. But if you're developing multiple applications, each requiring different versions of the same pod; then you either need multiple Fantom environments, one for each application, ... or you need FPM.
FPM maintains a local fanr file repository of Fantom pods, where it keeps multiple versions of the same pod. When a Fantom application is built, test, or run via FPM; then from that repository, FPM cherry picks just the pod versions you need.
Install FPM via
fanr, then run the setup command:
C:\> fan afFpm setup Fantom Pod Manager 0.0.8 ======================== Setting up FPM... Creating: C:\Apps\fantom-1.0.68\bin\fpm.bat Creating: C:\Apps\fantom-1.0.68\etc\afFpm\fpm.props Publishing pods from C:\Apps\fantom-1.0.68\lib\fan into repo 'default'... Publishing afBedSheet 1.5.0 to default Publishing afBeanUtils 1.0.8 to default Publishing afIoc 3.0.0 to default ... Current Configuration Home Dir : C:\Apps\fantom-1.0.68 Work Dirs : C:\Apps\fantom-1.0.68 Pod Dirs : (none) Temp Dir : C:\Apps\fantom-1.0.68\temp Config Files : C:\Apps\fantom-1.0.68\etc\afFpm\fpm.props File Repos : default = C:\Apps\fantom-1.0.68\fpmRepo-default Fanr Repos : fantomFactory = http://eggbox.fantomfactory.org/fanr/ status302 = http://repo.status302.com/fanr/ fantom = http://fantom.org/fanr/ FPM setup complete. Have fun! :)
setup command creates an
fpm.bat file, an
fpm.props file, and publishes any non-core pods to a local repository.
You can now use
fpm from the command line to download, install, and run Fantom apps:
To install a library:
C:\> fpm install afIoc
To run an app:
C:\> fpm run myApp
To update dependencies for an app:
C:\> fpm update myApp
update command in particular is very helpful. If no pod or app is given, it looks for a
build.fan in the current directory and parses that for dependencies.
If you've just cloned a code repository from BitBucket or GitHub, then a quick
fpm update from the project directory is all you need to download all the required dependencies!
FPM needs to know where it can find different pod versions. This is the FPM Environment and is highly configurable to suit many needs.
Pods may be found in:
- Pod Directories - arbitrary directories that contain pods. By default the relative paths
lib/fan/are used, which are relative to the current working directory
- File Repositories - named local fanr repositories, like
- Work Directories - includes the Fantom home directory. Also taken from the
- Fanr Repositories - named remote fanr repositories, like
To see how the FPM environment is configured on your system, type
fpm on it's own:
C:\> fpm Fantom Pod Manager ================== FPM Environment: Home Dir : C:\Apps\fantom-1.0.68 Work Dirs : C:\Repositories\Fantom C:\Apps\fantom-1.0.68 Pod Dirs : (none) ... ... ...
FPM gathers config for its environment from a series of
fpm.props files. These files are looked for in the following locations:
Note that the config files are additive but the values are not. If all 3 files exist, then all 3 files are merged together, with config values from a more specific file replacing (or overriding) values found in less specific one.
<WORK_DIR> may be specified with the
FPM_ENV_PATH environment variable. This means that ALL the config for FPM may live outside of the Fantom installation. The only FPM file that needs to live in the Fantom installation is the
afFpm.pod file itself.
To build, test, or run a fantom application (or script), FPM needs to know which pod or application it should provide dependencies for. This is known as the target pod.
It is possible to use environment variables to set this up (See Behind the scenes), but it is far easier to launch your application using
fpm itself. See
run commands for details. Note these commands spawn extra processes that launch your Fantom build / program / test.
Sets up FPM in the current Fantom environment.
C:\> fan afFpm setup
setup performs the following operations:
bin/directory of the current Fantom installation. Or creates an
fpmexecutable script on nix systems.
- Creates a default
fpm.propsconfig file in the
- Publishes all non-core pods found in any Fantom work or home directory. Note, this oprertation is non-destructive; pod files are left intact and are just copied to the local default repository.
Builds a Fantom application.
Runs build tasks from
build.fan within an FPM environment.
The targeted environment is derived from the
depends pod list defined in
build.fan should be in the current directory.
If (and only if) a repository is specified, then any pod built is installed into it.
C:\> fpm build C:\> fpm build -repo default compile
Tests a Fantom application.
Executes tests via
fant within an FPM environment.
target option is not specified, then the targeted environment is derived from the containing pod of the first test.
C:\> fpm test myPod C:\> fpm test -js -target myPod myPod::TestClass
Runs a Fantom application.
Executes a pod / method, within an FPM environment.
target option is not specified, then the targeted environment is derived from the containing pod.
C:\> fpm run myPod C:\> fpm run -js -target myPod myPod::MyClass
Queries repositories for versions of a named pod.
The whole FPM environment is queried, including all local file and remote fanr repositories.
C:\> fpm query myPod C:\> fpm query myPod 2.0+
Installs a pod to a repository.
The repository may be:
- a named local repository (e.g.
- a named remote repository (e.g.
- the directory of a local repository (e.g.
- the URL of a remote repository (e.g.
The pod may be:
- a file location, absolute or relative. Example,
- a directory of pods, absolute or relative. Example,
- a simple search query. Example,
All the above makes the
install command very versatile. Some examples:
To download and install the latest pod from a remote repository:
C:\> fpm install myPod
To download and install a specific pod version to a local repository:
C:\> fpm install -r release myPod 2.0.10
To upload and publish a pod to the Fantom-Factory repository:
C:\> fpm install -r fantomFactory lib/myGame.pod
Un-installs a pod from a local repository.
The repository may be:
- a named local repository (e.g.
- the directory of a local repository (e.g.
C:\> fpm uninstall myPod 2.0.10 C:\> fpm uninstall -r default myPod 2.0.10
Updates and installs dependencies for a named pod / build file.
Queries remote repositories looking for newer pod versions that match the targeted FPM environment.
C:\> fpm update C:\> fpm update -r default build.fan C:\> fpm update -r release myPod 2.0.10
Prints help on a given command.
-js option available in the
C:\> fpm run -js myPod C:\> fpm test -js myPod
Behind the Scenes
For FPM to do its thing, Fantom programs need have
afFpm::FpmEnv as their current environment. This can only be configured at boot time via the
FPM_ENV environment variable.
C:\> set FAN_ENV=afFpm::FpmEnv
To build, test, or run a Fantom application, FPM needs to know which pod it should resolve dependencies for. This is known as the target pod.
In most common cases FPM is able to infer the target pod from what is being run, usually from inspecting Env.mainMethod(). In other cases you can set the
FPM_TARGET environment variable.
C:\> set FPM_TARGET=myPod
FPM will always use the
FPM_TARGET environment variable if it is set.
You can then run your Fantom program as normal.
C:\> fan myPod
If FPM fails to resolve a target pod then it falls back to providing the latest versions of all pods.
Continually setting up environment variables can be tiresome. That is why FPM comes bundled with the helper commands
run. These commands don't need env vars to be set up, because they parse and inspect the command line, and spawn a new Fantom process with all the required env vars pre-set.
Providing a targeted environment is a tricky business and sometimes doesn't herald the results you expect - especially if you have a couple of
fpm.props files and / or multiple local repositories. To combat this, you can turn FPM debugging for any command by using the
C:\> fpm build -debug
Then when invoked, FPM dumps a full trace of the resolved environment. The resolved pods section is great for seeing where pod versions are loaded from.
C:\Projects>fpm run -d flux FPM: Running flux ================= Running flux [debug] [afFpm] Fantom Pod Manager 0.0.8 [debug] [afFpm] ======================== [debug] [afFpm] Resolving pods for flux 0+ [debug] [afFpm] Found 16 versions of 6 different pods [debug] [afFpm] Calculated 10 dependency pod permutation [debug] [afFpm] Collapsed to 1 dependency group permutation [debug] [afFpm] Stated problem space in 126ms [debug] [afFpm] Solving... [debug] [afFpm] ...Done [debug] [afFpm] Cached 0 bad dependency groups [debug] [afFpm] Found 1 solution in 9ms [debug] [afFpm] FPM Environment: Target Pod : flux 0+ Home Dir : C:\Apps\fantom-1.0.68 Work Dirs : C:\Repositories\Fantom C:\Apps\fantom-1.0.68 Pod Dirs : (none) Temp Dir : C:\Repositories\Fantom\temp Config Files : C:\Repositories\Fantom\etc\afFpm\fpm.props File Repos : default = C:\Repositories\Fantom\repo-default release = C:\Repositories\Fantom\repo-release Fanr Repos : fantomFactory = http://eggbox.fantomfactory.org/fanr/ status302 = http://repo.status302.com/fanr/ fantom = http://fantom.org/fanr/ Resolved 6 pods: compiler 1.0.67 - C:\Apps\fantom-1.0.68\lib\fan\compiler.pod concurrent 1.0.68 - C:\Apps\fantom-1.0.68\lib\fan\concurrent.pod flux 1.0.67 - C:\Apps\fantom-1.0.68\lib\fan\flux.pod fwt 1.0.68 - C:\Apps\fantom-1.0.68\lib\fan\fwt.pod gfx 1.0.68 - C:\Apps\fantom-1.0.68\lib\fan\gfx.pod sys 1.0.68 - C:\Apps\fantom-1.0.68\lib\fan\sys.pod
Debug may also be turned on all the time by adding this line to