97c01e48ed
Currently we have all our elements and library files in a top-level directory and install them into <root>/share/diskimage-builder/[elements|lib] (where root is either / or the root of a virtualenv). The problem with this is that editable/development installs (pip -e) do *not* install data_files. Thus we have no canonical location to look for elements -- leading to the various odd things we do such as a whole bunch of guessing at the top of disk-image-create and having a special test-loader in tests/test_elements.py so we can run python unit tests on those elements that have it. data_files is really the wrong thing to use for what are essentially assets of the program. data_files install works well for things like config-files, init.d files or dropping documentation files. By moving the elements under the diskimage_builder package, we always know where they are relative to where we import from. In fact, pkg_resources has an api for this which we wrap in the new diskimage_builder/paths.py helper [1]. We use this helper to find the correct path in the couple of places we need to find the base-elements dir, and for the paths to import the library shell functions. Elements such as svc-map and pkg-map include python unit-tests, which we do not need tests/test_elements.py to special-case load any more. They just get found automatically by the normal subunit loader. I have a follow-on change (I69ca3d26fede0506a6353c077c69f735c8d84d28) to move disk-image-create to a regular python entry-point. Unfortunately, this has to move to work with setuptools. You'd think a symlink under diskimage_builder/[elements|lib] would work, but it doesn't. [1] this API handles stuff like getting files out of .zip archive modules, which we don't do. Essentially for us it's returning __file__. Change-Id: I5e3e3c97f385b1a4ff2031a161a55b231895df5b
22 lines
760 B
ReStructuredText
22 lines
760 B
ReStructuredText
=========
|
|
pip-cache
|
|
=========
|
|
# Use a cache for pip
|
|
|
|
Using a download cache speeds up image builds.
|
|
|
|
Including this element in an image build causes
|
|
$HOME/.cache/image-create/pip to be bind mounted as /tmp/pip inside
|
|
the image build chroot. The $PIP_DOWNLOAD_CACHE environment variable
|
|
is then defined as /tmp/pip, which causes pip to cache all downloads
|
|
to the defined location.
|
|
|
|
Note that pip and its use of $PIP_DOWNLOAD_CACHE is not concurrency
|
|
safe. Running multiple instances of diskimage-builder concurrently
|
|
can cause issues. Therefore, it is advised to only have one instance
|
|
of diskimage-builder that includes the pip-cache element running at a
|
|
time.
|
|
|
|
The pip concurrency issue is being tracked upstream at
|
|
https://github.com/pypa/pip/issues/1141
|