Skip to content

Commit

Permalink
Rough draft of deb-bootstrap-builder
Browse files Browse the repository at this point in the history
Ping #17
  • Loading branch information
mih committed May 20, 2022
1 parent ddddb4b commit 09dfdbd
Show file tree
Hide file tree
Showing 4 changed files with 119 additions and 4 deletions.
6 changes: 6 additions & 0 deletions datalad_debian/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@
'deb-configure-builder',
'deb_configure_builder',
),
(
'datalad_debian.bootstrap_builder',
'BootstrapBuilder',
'deb-bootstrap-builder',
'deb_bootstrap_builder',
),
]
)

Expand Down
106 changes: 106 additions & 0 deletions datalad_debian/bootstrap_builder.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
import logging
from pathlib import Path

from datalad.distribution.dataset import (
EnsureDataset,
datasetmethod,
require_dataset,
)
from datalad.interface.base import (
Interface,
build_doc,
)
from datalad.interface.utils import (
eval_results,
)
from datalad.runner import (
Runner,
StdOutCapture,
)
from datalad.support.constraints import (
EnsureNone,
)
from datalad.support.param import Parameter

lgr = logging.getLogger('datalad.debian.bootstrap_builder')


@build_doc
class BootstrapBuilder(Interface):
"""Bootstrap a build environment
"""
_params_ = dict(
dataset=Parameter(
args=("-d", "--dataset"),
doc="""specify a distribution dataset to add the package to""",
constraints=EnsureDataset() | EnsureNone()),
)

_examples_ = []

@staticmethod
@datasetmethod(name='deb_bootstrap_builder')
@eval_results
def __call__(*, dataset=None):
# TODO this could later by promoted to an option to support more than
# singularity
cfgtype = 'singularity'

builder_ds = require_dataset(dataset)

# figure out which architecture we will be building for
binarch = Runner().run(
['dpkg-architecture', '-q', 'DEB_BUILD_ARCH'],
protocol=StdOutCapture)['stdout'].strip()

buildenv_name = f"{cfgtype}-{binarch}"

recipe = None
for p in (builder_ds.pathobj / 'recipes' / f"{cfgtype}-{binarch}",
builder_ds.pathobj / 'recipes' / f"{cfgtype}-any"):
if p.exists():
recipe = p
break
if recipe is None:
raise RuntimeError(
"Cannot locate build environment recipe for "
f"{cfgtype}({binarch})")

# TODO allow for other types of environments
buildenv = Path('envs', f"{buildenv_name}.sif")

yield from builder_ds.run(
# TODO allow for other means of privilege escalation
# TODO allow for other means to bootstrap
"sudo singularity build {outputs} {inputs}",
inputs=[str(recipe.relative_to(builder_ds.pathobj))],
outputs=[str(buildenv)],
result_renderer='disabled',
return_type='generator',
# give control flow to caller
on_failure='ignore',
)

buildenv_callfmt = \
'singularity run ' \
'--bind builder/cache/var/lib/apt:/var/lib/apt,builder/cache/var/cache/apt:/var/cache/apt,.:/pkg ' \
'--pwd /pkg ' \
'--fakeroot ' \
'--cleanenv ' \
'--containall ' \
'--writable ' \
'--no-home ' \
'{img} {cmd}'

# this is a fresh addition of the build env
yield from builder_ds.containers_add(
buildenv_name,
image=str(buildenv),
call_fmt=buildenv_callfmt,
# tolerate an already existing record
update=True,
result_renderer='disabled',
return_type='generator',
# give control flow to caller
on_failure='ignore',
)
6 changes: 4 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ High-level API commands
:toctree: generated

deb_new_distribution
deb_new_package
deb_configure_builder
deb_bootstrap_builder
deb_new_package


Command line reference
Expand All @@ -24,8 +25,9 @@ Command line reference
:maxdepth: 1

generated/man/datalad-deb-new-distribution
generated/man/datalad-deb-new-package
generated/man/datalad-deb-configure-builder
generated/man/datalad-deb-bootstrap-builder
generated/man/datalad-deb-new-package


Indices and tables
Expand Down
5 changes: 3 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@ classifiers =
Programming Language :: Python :: 3

[options]
python_requires = >= 3.6
python_requires = >= 3.7
install_requires =
datalad >= 0.14.0rc1
datalad >= 0.16
datalad-containers
packages = find:
include_package_data = True

Expand Down

0 comments on commit 09dfdbd

Please sign in to comment.