session_manager

Reviewed on: 2020-02-04

session_manager is the component which runs and manages sessions.

Building

Add the session_manager component to builds by including --with-base //src/session in the fx set invocation followed by rebuilding and re-paving the device.

Product configurations built on Session Framework (such as fx set workstation.x64) include //src/session by default.

Running

session_manager is launched in one of two ways: manually or automatically on system boot.

In general, running on boot is desirable for production configuration, while running manually is useful during development.

Running manually

Manually run session_manager from the command line on your workstation:

$ fx shell run fuchsia-pkg://fuchsia.com/component_manager_sfw#meta/component_manager_sfw.cmx fuchsia-pkg://fuchsia.com/session_manager#meta/session_manager.cm

Use the session_control tool to run a specific session. For example:

$ fx shell 'session_control -s "fuchsia-pkg://fuchsia.com/your_session#meta/your_session.cm"'

Running on boot

In the general case, running session_manager on boot is done in order to launch a specific session on boot. In the event you wish to run session_manager on boot without also launching a specific session, see “Alternative: run on boot without a session” below.

Create a configuration file with the URL to your session as follows:

{
  "session_url": "fuchsia-pkg://fuchsia.com/your_package#meta/your_session.cm"
}

Add to your BUILD.gn file:

import("//src/session/build/session_config.gni")

session_config("your_session_config") {
  config = "path/to/config.json"
}

And ensure that the target :your_session_config is included in the base image (for example, using --with-base, or as a direct dependency of a product build group).

Re-build, re-pave, and restart your device and it will boot into session_manager and launch your session.

Alternative: run on boot without a session

Configure your build to also include the sysmgr configuration file session_manager.config:

$ fx set core.x64 --with-base=//src/session,//src/session/bin/session_manager:session_manager.config

Rebuild and re-pave the device and session_manager will start automatically.

Testing

Unit tests for session_manager are included in the session_manager_tests package, and integration tests are included in the session_manager_integration_tests package.

Both can be included in your build by adding --with //src/session:tests to your fx set.

$ fx run-test session_manager_tests
$ fx run-test session_manager_integration_tests

Source layout

The entrypoint for session_manager is in src/main.rs with implementation details in other files within src/.

Unit tests are co-located with the code, while integration tests are in //src/session/tests.