start.py

# helper file of droidbot
# it parses command arguments and send the options to droidbot

__author__ = 'liyc'
import argparse
import logging
from argparse import RawTextHelpFormatter
from droidbot.droidbot import DroidBot

def parse_args():
    """
    parse command line input
    generate options including host name, port number
    """
    parser = argparse.ArgumentParser(description="start a robot to interact with Android app",
                                     formatter_class=RawTextHelpFormatter)
    parser.add_argument("-d", action="store", dest="device_serial", nargs='?',
                        help="serial number of target device")
    parser.add_argument("-p", action="store", dest="package_name", nargs='?',
                        help="package name of a pre-installed app, otherwise use -a option")
    parser.add_argument("-a", action="store", dest="app_path", nargs='?',
                        help="file path of target app, necessary for static analysis")
    parser.add_argument("-c", action="store", dest="event_count", nargs='?',
                        type=int, help="number of events to generate during testing")
    parser.add_argument("-env", action="store", dest="env_policy", nargs='?',
                        help="policy to set up environment. Supported policies:\n"
                        "none\tno environment will be set. App will run in default environment of device; \n"
                        "dummy\tadd some fake contacts, SMS log, call log; \n"
                        "static\tset environment based on static analysis result; \n"
                        "<file>\tget environment policy from a json file.\n")
    parser.add_argument("-event", action="store", dest="event_policy", nargs='?',
                        help="policy to generate events. Supported policies:\n"
                        "none\tno event will be sent; \n" \
                        "monkey\tpseudo-random events, same as \"adb shell monkey ...\"; \n" \
                        "static\tsend events based on static analysis result; \n" \
                        "dynamic\tsend events based on dynamic app state,"
                        " this policy requires framework instrumented; \n" \
                        "<file>\tget event policy from a json file.\n")
    parser.add_argument("-o", action="store", dest="output_dir", nargs='?',
                        help="directory of output")
    options = parser.parse_args()
    return options


def main():
    """
    the main function
    it starts a droidbot according to the arguments given in cmd line
    """
    logging.basicConfig(level=logging.DEBUG)
    opts = parse_args()

    droidbot = DroidBot(opts)
    droidbot.start()
    return


if __name__ == "__main__":
    main()