PLAINBOX_PROVIDER_DATA(7) Plainbox PLAINBOX_PROVIDER_DATA(7)
PLAINBOX_PROVIDER_DATA - per-provider data directory
command: example-command $PLAINBOX_PROVIDER_DATA/data-file.dat
Running an example-command on a provider-specific data file.
Plainbox providers can require arbitrary data files for successful testing. The absolute
path of the provider data/ directory is exposed as the environment variable $PLAIN‐
BOX_PROVIDER_DATA. Job commands can use that variable to refer to the data directory in an
Typical Use Cases
Typically the data file is used by the job command. For example, let's say that an audio
file test.wav is stored in the data/ directory of the provider and the intent is to have a
job definition which plays that file:
summary: play the test.wav file
command: paplay $PLAINBOX_PROVIDER_DATA/test.wav
Plays the test sound file (test.wav)
Did the sound file play correctly?
The job play-audio-file will use the paplay (1) executable to play an audio file shipped
by the provider. Since the actual location of the audio file may vary, depending on envi‐
ronment and installation method, the test definition uses the environment variable $PLAIN‐
BOX_PROVIDER_DATA to access it in an uniform way.
Jobs designed to work with pre-Plainbox-based Checkbox may still refer to the old, some‐
what confusing, environment variable CHECKBOX_SHARE. It points to the same directory.
Zygmunt Krynicki & Checkbox Contributors
2012-2014 Canonical Ltd
0.25 January 05, 2016 PLAINBOX_PROVIDER_DATA(7)