pull.py

Go to the documentation of this file.

"""
The pull command pulls the remote workspace to the local workspace,
making it identical to the workspace on the robot..

Copyright 2015 Fetch Robotics Inc.
Author: Alex Henning

"""

import os
import subprocess
import sys

from ..util import run, add_user, add_robot, add_workspace

name = "pull"
help_text = "Pull the robots workspace onto the current workspace, losing any differences"


def main(args):
    print "Pulling %s@%s:%s/src to %s/src " % (
        args.user, args.robot, args.remote_workspace, args.workspace,
    )

    if not args.no_safety and raw_input("Risk losing local workspace (y/n): ") not in ["y", "yes"]:
        print "Giving up, better luck next time."
        return

    # Synchronize the workspaces
    proc = subprocess.Popen(
        ["rsync",
         # Following line is a trick to magically create the directory
         # if it doesn't exist.
         "--rsync-path", "mkdir -p " + args.remote_workspace + " && rsync",
         "-phErtz",
         "--delete",
         args.user + "@" + args.robot + ":" + args.remote_workspace + "/src",
         args.workspace + "/"]
    )
    proc.wait()
    if proc.returncode != 0:
        print "ERROR: Syncing failed"
        sys.exit(-1)

    # Use rosdep to install all dependencies
    if args.install_deps:
        run("cd "+args.workspace+" && "
            "source devel/setup.bash && "
            "rosdep update && "
            "rosdep install --from-paths src --ignore-src -y")

    # Run the build commands
    if args.build is not None:
        for build in args.build:
            build = build if build is not None else ""
            if args.build_type != "default":
                build += " -DCMAKE_BUILD_TYPE="+args.build_type
            command = "source /opt/ros/" + os.getenv("ROS_DISTRO") + \
                      "/setup.bash && cd " + args.workspace + \
                      " && catkin_make " + build
            if run(command) != 0:
                print "ERROR: Build failed"
                sys.exit(-1)


def add_arguments(parser):
    add_user(parser)
    add_robot(parser)
    add_workspace(parser)
    parser.add_argument("--install-deps", action="store_true",
                        help="Install dependencies using rosdep")
    parser.add_argument("--build", nargs="?", action="append",
                        help="Build after syncing")
    parser.add_argument("--build-type", action="store", default="default",
                        choices=["Debug", "Release", "RelWithDebInfo", "MinSizeRel", "default"],
                        help="Type of build to use `default`, `Debug`, `Release`, and `RelWithDebInfo`")
    parser.add_argument("--no-safety", action="store_true",
                        help="Don't prompt about overwriting the local workspace")