tasks.py

import glob
import os
from invoke import task, Collection, call

THISDIR = os.path.dirname(os.path.realpath(__file__))
MODULE_NAME = os.path.basename(THISDIR)

def get_submodules(c):
    """
    return repository submodule names
    """
    submodules = []
    with c.cd(THISDIR):
        result = c.run("git submodule status", hide=True)
        for line in result.stdout.splitlines():
            submodules.append(line.split()[1])
    return submodules

def get_iname_tag(image_name):
    """
    return tuple with image name and tag
    """
    if ":" in image_name:
        iname, tag = image_name.split(":")
    else:
        iname, tag = image_name, "latest"
    return iname, tag


@task
def init(c):
    """
    Init submodules.
    """
    print("init submodules")
    with c.cd(THISDIR):
        c.run("git submodule init", hide=True)

@task(init)
def clone(c):
    """
    Clone this repository submodules.
    """
    submodules = get_submodules(c)
    with c.cd(THISDIR):
        for sub in submodules:
            c.run("git submodule update --init --recursive %s" %sub)

@task(
    help={'nocache': "do not use cache when building the image",
          'pull': "always attempt to pull a newer version of the image",
          'ros_distro': "ROS distro to use (Available [humble])"}
)
def build_sitl(c, nocache=False, pull=False, ros_distro="humble", image_name=MODULE_NAME):
    """
    Create Docker build environment.
    """
    iname, tag = get_iname_tag(image_name)

    args = []
    args.append("--build-arg VERSION=$(git describe --always --tags --dirty | sed 's/^v//')")
    args.append("-f packaging/Dockerfile.sitl")
    args.append("-t %s_build:%s" % (iname, tag))
    if nocache:
        args.append("--no-cache")
    elif pull:
        args.append("--pull")
    with c.cd(THISDIR):
        c.run("docker build %s ." % " ".join(args))

@task(
    help={'reallyclean': "remove & reload all submodules"}
)
def clean(c, reallyclean=False):
    """
    Clean workspace.
    """
    with c.cd(THISDIR):
        if reallyclean:
            c.run("git submodule deinit -f --all")
            clone(c)
        else:
            c.run("git submodule foreach git clean -xdf")
            c.run("git submodule foreach git checkout .")
        c.run("git clean -xdf")

@task(
    help={'out_dir': "output directory for the generated deb files",
          'ros_distro': "ROS distro to use (Available [humble])"}
)
def create_deb_package(c, out_dir="../bin/", ros_distro="humble", image_name=MODULE_NAME):
    """
    Build debian package
    """
    c.run("./build.sh {0}"
          .format(out_dir))

@task(help={'nocache': "do not use cache when building the image",
          'pull': "always attempt to pull a newer version of the image",
          'image_name': "name of output docker image"}
)
def build_docker(c, nocache=False, pull=False, image_name=MODULE_NAME):
    """
    Build Docker image of this component
    """
    col = Collection()
    col.add_task(build_sitl)
    col['build_sitl'](c, nocache=nocache, pull=pull, image_name=image_name)

    iname, tag = get_iname_tag(image_name)
    args = []
    args.append("--build-arg FROM_ARTIFACTS=%s_build:%s" % (iname, tag))
    args.append("-f packaging/Dockerfile.docker")
    args.append("-t %s:%s" % (iname, tag))
    if nocache:
        args.append("--no-cache")
    elif pull:
        args.append("--pull")
    with c.cd(THISDIR):
        print("docker build %s ." % " ".join(args))
        c.run("docker build %s ." % " ".join(args))