def __init__(self,
app_path,
device_serial,
output_dir=None,
env_policy=None,
event_policy=None,
with_droidbox=False,
event_count=None,
event_interval=None,
event_duration=None,
quiet=False):
"""
initiate droidbot with configurations
:return:
"""
logging.basicConfig(level=logging.WARNING if quiet else logging.INFO)
self.logger = logging.getLogger('DroidBot')
DroidBot.instance = self
self.output_dir = output_dir
if self.output_dir is None:
self.output_dir = os.path.abspath("droidbot_out")
if not os.path.exists(self.output_dir):
os.mkdir(self.output_dir)
# if device_serial is None:
# # Dirty Workaround: Set device_serial to Default='.*', because com/dtmilano/android/viewclient.py
# # set serial to an arbitrary argument. IN connectToDeviceOrExit(..) line 2539f.
# # FIXED by requiring device_serial in cmd
# device_serial = '.*'
self.device = Device(device_serial, output_dir=self.output_dir)
self.app = App(app_path, output_dir=self.output_dir)
self.droidbox = None
self.env_manager = None
self.event_manager = None
self.enabled = True
try:
if with_droidbox:
self.droidbox = DroidBox(droidbot=self,
output_dir=self.output_dir)
self.env_manager = AppEnvManager(self.device, self.app, env_policy)
self.event_manager = AppEventManager(self.device, self.app,
event_policy, event_count,
event_interval,
event_duration)
except Exception as e:
import traceback
traceback.print_exc()
self.stop()
print e
def default_mode(self):
"""
just start droidbox and do nothing
:return:
"""
if not self.enabled:
return
self.droidbox = DroidBox(output_dir=None) #Set output_dir=None -> no DroidBox Result Files are created
self.droidbox.set_apk(self.apk_path)
self.droidbox.start_blocked(self.event_duration)
def __init__(self, app_path, device_serial, output_dir=None,
env_policy=None, event_policy=None, with_droidbox=False,
event_count=None, event_interval=None, event_duration=None, quiet=False):
"""
initiate droidbot with configurations
:return:
"""
logging.basicConfig(level=logging.WARNING if quiet else logging.INFO)
self.logger = logging.getLogger('DroidBot')
DroidBot.instance = self
self.output_dir = output_dir
if self.output_dir is None:
self.output_dir = os.path.abspath("droidbot_out")
if not os.path.exists(self.output_dir):
os.mkdir(self.output_dir)
# if device_serial is None:
# # Dirty Workaround: Set device_serial to Default='.*', because com/dtmilano/android/viewclient.py
# # set serial to an arbitrary argument. IN connectToDeviceOrExit(..) line 2539f.
# # FIXED by requiring device_serial in cmd
# device_serial = '.*'
self.device = Device(device_serial, output_dir=self.output_dir)
self.app = App(app_path, output_dir=self.output_dir)
self.droidbox = None
if with_droidbox:
self.droidbox = DroidBox(output_dir=self.output_dir)
self.env_manager = AppEnvManager(self.device, self.app, env_policy)
self.event_manager = AppEventManager(self.device, self.app, event_policy,
event_count, event_interval,
event_duration)
def default_mode(self):
"""
just start droidbox and do nothing
:return:
"""
if not self.enabled:
return
self.droidbox = DroidBox(output_dir=None) #Set output_dir=None -> no DroidBox Result Files are created
self.droidbox.set_apk(self.apk_path)
self.droidbox.start_blocked(self.event_duration)
class DroidBot(object):
"""
The main class of droidbot
A robot which interact with Android automatically
"""
# this is a single instance class
instance = None
def __init__(self, app_path, device_serial, output_dir=None,
env_policy=None, event_policy=None, with_droidbox=False,
event_count=None, event_interval=None, event_duration=None,
quiet=False):
"""
initiate droidbot with configurations
:return:
"""
logging.basicConfig(level=logging.WARNING if quiet else logging.INFO)
self.logger = logging.getLogger('DroidBot')
DroidBot.instance = self
self.output_dir = output_dir
if self.output_dir is None:
self.output_dir = os.path.abspath("droidbot_out")
if not os.path.exists(self.output_dir):
os.mkdir(self.output_dir)
# if device_serial is None:
# # Dirty Workaround: Set device_serial to Default='.*', because com/dtmilano/android/viewclient.py
# # set serial to an arbitrary argument. IN connectToDeviceOrExit(..) line 2539f.
# # FIXED by requiring device_serial in cmd
# device_serial = '.*'
self.device = Device(device_serial, output_dir=self.output_dir)
self.app = App(app_path, output_dir=self.output_dir)
self.droidbox = None
if with_droidbox:
self.droidbox = DroidBox(droidbot=self, output_dir=self.output_dir)
self.env_manager = AppEnvManager(self.device, self.app, env_policy)
self.event_manager = AppEventManager(self.device, self.app, event_policy,
event_count, event_interval,
event_duration)
@staticmethod
def get_instance():
if DroidBot.instance is None:
print "Error: DroidBot is not initiated!"
sys.exit(-1)
return DroidBot.instance
def start(self):
"""
start interacting
:return:
"""
self.logger.info("Starting DroidBot")
try:
self.device.install_app(self.app)
self.env_manager.deploy()
if self.droidbox is not None:
self.droidbox.set_apk(self.app.app_path)
self.droidbox.start_unblocked()
self.event_manager.start()
self.droidbox.stop()
self.droidbox.get_output()
else:
self.event_manager.start()
except KeyboardInterrupt:
pass
self.stop()
self.logger.info("DroidBot Stopped")
def stop(self):
self.env_manager.stop()
self.event_manager.stop()
if self.droidbox is not None:
self.droidbox.stop()
self.device.uninstall_app(self.app)
self.device.disconnect()
class DroidboxEvaluator(object):
"""
evaluate test tool with DroidBox
make sure you have started droidbox emulator before evaluating
"""
MODE_DEFAULT = "1.default"
MODE_MONKEY = "2.monkey"
MODE_RANDOM = "3.random"
MODE_STATIC = "4.static"
MODE_DYNAMIC = "5.dynamic"
def __init__(self, device_serial, apk_path, event_duration, event_count, event_interval, output_dir):
self.logger = logging.getLogger(self.__class__.__name__)
self.device_serial = device_serial,
self.apk_path = os.path.abspath(apk_path)
if output_dir is None:
output_dir = "evaluation_reports/"
now = datetime.now()
self.report_title = now.strftime("Evaluation_Report_%Y-%m-%d_%H%M")
result_file_name = self.report_title + ".md"
self.result_file_path = os.path.abspath(os.path.join(output_dir, result_file_name))
self.event_duration = event_duration
if self.event_duration is None:
self.event_duration = 200
self.event_count = event_count
if self.event_count is None:
self.event_count = 200
self.event_interval = event_interval
if self.event_interval is None:
self.event_interval = 2
self.record_interval = self.event_duration / 20
if self.record_interval < 2:
self.record_interval = 2
self.droidbot = None
self.droidbox = None
self.result = {}
self.logger.info("Evaluator initialized")
self.logger.info("apk_path:%s\n"
"duration:%d\ncount:%d\ninteval:%d\nreport title:%s" %
(self.apk_path, self.event_duration,
self.event_count, self.event_interval, self.report_title))
self.enabled = True
def start_evaluate(self):
"""
start droidbox testing
:return:
"""
if not self.enabled:
return
self.evaluate_mode(DroidboxEvaluator.MODE_DEFAULT,
self.default_mode)
self.evaluate_mode(DroidboxEvaluator.MODE_MONKEY,
self.adb_monkey)
self.evaluate_mode(DroidboxEvaluator.MODE_RANDOM,
self.droidbot_random)
self.evaluate_mode(DroidboxEvaluator.MODE_STATIC,
self.droidbot_static)
self.evaluate_mode(DroidboxEvaluator.MODE_DYNAMIC,
self.droidbot_dynamic)
self.dump(sys.stdout)
if not self.enabled:
return
result_file = open(self.result_file_path, "w")
self.dump(result_file)
result_file.close()
def evaluate_mode(self, mode, target):
"""
evaluate a particular mode
:param mode: str of mode
:param target: the target function to run
:return:
"""
if not self.enabled:
return
self.logger.info("evaluating [%s] mode" % mode)
self.droidbot = None
self.droidbox = None
target_thread = threading.Thread(target=target)
target_thread.start()
self.wait_for_droidbox()
self.monitor_and_record(mode)
self.stop_modules()
self.logger.info("finished evaluating [%s] mode" % mode)
def stop_modules(self):
if self.droidbox is not None:
self.droidbox.stop()
if self.droidbot is not None:
self.droidbot.stop()
def wait_for_droidbox(self):
# wait until droidbox starts counting
while self.enabled and self.droidbox is None:
time.sleep(2)
while self.enabled and not self.droidbox.is_counting_logs:
time.sleep(2)
def monitor_and_record(self, mode):
if not self.enabled:
return
self.result[mode] = {}
t = 0
self.logger.info("start monitoring")
try:
while True:
log_counts = self.droidbox.get_counts()
self.result[mode][t] = log_counts
time.sleep(self.record_interval)
t += self.record_interval
if t > self.event_duration:
return
except KeyboardInterrupt:
self.stop()
self.logger.info("stop monitoring")
self.logger.debug(self.result)
def stop(self):
self.enabled = False
def default_mode(self):
"""
just start droidbox and do nothing
:return:
"""
if not self.enabled:
return
self.droidbox = DroidBox(output_dir=None) #Set output_dir=None -> no DroidBox Result Files are created
self.droidbox.set_apk(self.apk_path)
self.droidbox.start_blocked(self.event_duration)
def start_droidbot(self, env_policy, event_policy):
"""
start droidbot with given arguments
:param env_policy: policy to deploy environment
:param event_policy: policy to send events
:return:
"""
if not self.enabled:
return
self.logger.info("starting droidbot")
self.droidbot = DroidBot(device_serial=self.device_serial,
app_path=self.apk_path,
env_policy=env_policy,
event_policy=event_policy,
event_count=self.event_count,
event_duration=self.event_duration,
event_interval=self.event_interval,
with_droidbox=True,
quiet=True)
self.droidbox = self.droidbot.droidbox
self.droidbot.start()
def adb_monkey(self):
"""
try droidbot "monkey" mode
:return:
"""
self.start_droidbot(env_policy="none", event_policy="monkey")
def droidbot_random(self):
"""
try droidbot "random" mode
:return:
"""
self.start_droidbot(env_policy="none", event_policy="random")
def droidbot_static(self):
"""
try droidbot "static" mode
:return:
"""
self.start_droidbot(env_policy="none", event_policy="static")
def droidbot_dynamic(self):
"""
try droidbot "dynamic" mode
:return:
"""
self.start_droidbot(env_policy="none", event_policy="dynamic")
def result_safe_get(self, mode_tag=None, time_tag=None, item_tag=None):
"""
get an item from result
"""
if mode_tag is None:
return self.result
if mode_tag in self.result.keys() and isinstance(self.result[mode_tag], dict):
result_mode = self.result[mode_tag]
if time_tag is None:
return result_mode
if time_tag in result_mode.keys() and isinstance(result_mode[time_tag], dict):
result_item = result_mode[time_tag]
if item_tag is None:
return result_item
if item_tag in result_item.keys():
return result_item[item_tag]
return None
def dump(self, out_file):
modes = self.result_safe_get()
if modes is None or not modes:
return
else:
modes = list(modes.keys())
modes.sort()
out_file.write("# %s\n\n" % self.report_title)
out_file.write("## About\n\n")
out_file.write("This report is generated automatically by %s "
"with options:\n\n"
"+ apk_path=%s\n"
"+ event_duration=%s\n"
"+ event_interval=%s\n"
"+ event_count=%s\n\n"
% (self.__class__.__name__, os.path.basename(self.apk_path),
self.event_duration, self.event_interval, self.event_count))
out_file.write("## Apk Info\n\n")
out_file.write("|Item|Value|\n")
out_file.write("|----|----|\n")
out_file.write("|Package Name|%s|\n" % self.droidbox.application.getPackage())
out_file.write("|Main Activity|%s|\n" % self.droidbox.application.getMainActivity())
out_file.write("|Hash (md5)|%s|\n" % self.droidbox.apk_hashes[0])
out_file.write("|Hash (sha1)|%s|\n" % self.droidbox.apk_hashes[1])
out_file.write("|Hash (sha256)|%s|\n\n" % self.droidbox.apk_hashes[2])
out_file.write("### Permissions\n\n")
for permission in self.droidbox.application.getPermissions():
out_file.write("+ %s\n" % permission)
out_file.write("\n## Data\n\n")
out_file.write("### Summary\n\n")
# gen head lines
th1 = "|\tcategory\t|"
th2 = "|----|"
for mode in modes:
th1 += "\t%s\t|" % mode
th2 += "----|"
th1 += "\n"
th2 += "\n"
out_file.write(th1)
out_file.write(th2)
# gen content
categories = self.result_safe_get(modes[0], 0)
if categories is None:
categories = []
else:
categories = list(categories.keys())
categories.sort()
for category in categories:
tl = "|\t%s\t|" % category
for mode in modes:
time_tags = self.result_safe_get(mode)
if time_tags is None:
tl += "\t0\t|"
continue
time_tag = max(time_tags.keys())
count = self.result_safe_get(mode, time_tag, category)
tl += "\t%d\t|" % count
tl += "\n"
out_file.write(tl)
out_file.write("\n### Tendency\n\n")
# gen head lines
th1 = "|\ttime\t|"
th2 = "|----|"
for mode in modes:
th1 += "\t%s\t|" % mode
th2 += "----|"
th1 += "\n"
th2 += "\n"
out_file.write(th1)
out_file.write(th2)
# gen content
time_tags = self.result_safe_get(modes[0])
if time_tags is None:
time_tags = []
else:
time_tags = list(time_tags.keys())
time_tags.sort()
for time_tag in time_tags:
tl = "|\t%d\t|" % time_tag
for mode in modes:
tl += "\t%s\t|" % self.result_safe_get(mode, time_tag, "sum")
tl += "\n"
out_file.write(tl)
def __init__(self,
app_path=None,
device_serial=None,
output_dir=None,
env_policy=None,
policy_name=None,
random_input=False,
script_path=None,
event_count=None,
event_interval=None,
timeout=None,
keep_app=None,
keep_env=False,
debug_mode=False,
with_droidbox=False,
use_hierarchy_viewer=False,
profiling_method=None,
grant_perm=False):
"""
initiate droidbot with configurations
:return:
"""
logging.basicConfig(
level=logging.DEBUG if debug_mode else logging.INFO)
self.logger = logging.getLogger('DroidBot')
DroidBot.instance = self
self.output_dir = output_dir
if output_dir is not None:
if not os.path.isdir(output_dir):
os.mkdir(output_dir)
import pkg_resources, shutil
html_index_path = pkg_resources.resource_filename(
"droidbot", "resources/index.html")
stylesheets_path = pkg_resources.resource_filename(
"droidbot", "resources/stylesheets")
target_stylesheets_dir = os.path.join(output_dir, "stylesheets")
if os.path.exists(target_stylesheets_dir):
shutil.rmtree(target_stylesheets_dir)
shutil.copy(html_index_path, output_dir)
shutil.copytree(stylesheets_path, target_stylesheets_dir)
self.timeout = timeout
self.timer = None
self.keep_env = keep_env
self.keep_app = keep_app
# if device_serial is None:
# # Dirty Workaround: Set device_serial to Default='.*', because com/dtmilano/android/viewclient.py
# # set serial to an arbitrary argument. IN connectToDeviceOrExit(..) line 2539f.
# # FIXED by requiring device_serial in cmd
# device_serial = '.*'
self.device = None
self.app = None
self.droidbox = None
self.env_manager = None
self.input_manager = None
self.enabled = True
try:
self.device = Device(device_serial=device_serial,
output_dir=self.output_dir,
use_hierarchy_viewer=use_hierarchy_viewer,
grant_perm=grant_perm)
self.app = App(app_path, output_dir=self.output_dir)
if with_droidbox:
self.droidbox = DroidBox(droidbot=self,
output_dir=self.output_dir)
self.env_manager = AppEnvManager(device=self.device,
app=self.app,
env_policy=env_policy)
self.input_manager = InputManager(
device=self.device,
app=self.app,
policy_name=policy_name,
random_input=random_input,
event_count=event_count,
event_interval=event_interval,
script_path=script_path,
profiling_method=profiling_method)
except Exception as e:
self.logger.warning("Something went wrong: " + e.message)
import traceback
traceback.print_exc()
self.stop()
sys.exit(-1)
class DroidBot(object):
"""
The main class of droidbot
"""
# this is a single instance class
instance = None
def __init__(self,
app_path=None,
device_serial=None,
output_dir=None,
env_policy=None,
policy_name=None,
random_input=False,
script_path=None,
event_count=None,
event_interval=None,
timeout=None,
keep_app=None,
keep_env=False,
debug_mode=False,
with_droidbox=False,
use_hierarchy_viewer=False,
profiling_method=None,
grant_perm=False):
"""
initiate droidbot with configurations
:return:
"""
logging.basicConfig(
level=logging.DEBUG if debug_mode else logging.INFO)
self.logger = logging.getLogger('DroidBot')
DroidBot.instance = self
self.output_dir = output_dir
if output_dir is not None:
if not os.path.isdir(output_dir):
os.mkdir(output_dir)
import pkg_resources, shutil
html_index_path = pkg_resources.resource_filename(
"droidbot", "resources/index.html")
stylesheets_path = pkg_resources.resource_filename(
"droidbot", "resources/stylesheets")
target_stylesheets_dir = os.path.join(output_dir, "stylesheets")
if os.path.exists(target_stylesheets_dir):
shutil.rmtree(target_stylesheets_dir)
shutil.copy(html_index_path, output_dir)
shutil.copytree(stylesheets_path, target_stylesheets_dir)
self.timeout = timeout
self.timer = None
self.keep_env = keep_env
self.keep_app = keep_app
# if device_serial is None:
# # Dirty Workaround: Set device_serial to Default='.*', because com/dtmilano/android/viewclient.py
# # set serial to an arbitrary argument. IN connectToDeviceOrExit(..) line 2539f.
# # FIXED by requiring device_serial in cmd
# device_serial = '.*'
self.device = None
self.app = None
self.droidbox = None
self.env_manager = None
self.input_manager = None
self.enabled = True
try:
self.device = Device(device_serial=device_serial,
output_dir=self.output_dir,
use_hierarchy_viewer=use_hierarchy_viewer,
grant_perm=grant_perm)
self.app = App(app_path, output_dir=self.output_dir)
if with_droidbox:
self.droidbox = DroidBox(droidbot=self,
output_dir=self.output_dir)
self.env_manager = AppEnvManager(device=self.device,
app=self.app,
env_policy=env_policy)
self.input_manager = InputManager(
device=self.device,
app=self.app,
policy_name=policy_name,
random_input=random_input,
event_count=event_count,
event_interval=event_interval,
script_path=script_path,
profiling_method=profiling_method)
except Exception as e:
self.logger.warning("Something went wrong: " + e.message)
import traceback
traceback.print_exc()
self.stop()
sys.exit(-1)
@staticmethod
def get_instance():
if DroidBot.instance is None:
print "Error: DroidBot is not initiated!"
sys.exit(-1)
return DroidBot.instance
def start(self):
"""
start interacting
:return:
"""
if not self.enabled:
return
self.logger.info("Starting DroidBot")
try:
if self.timeout > 0:
self.timer = Timer(self.timeout, self.stop)
self.timer.start()
self.device.set_up()
if not self.enabled:
return
self.device.connect()
if not self.enabled:
return
self.device.install_app(self.app)
if not self.enabled:
return
self.env_manager.deploy()
if not self.enabled:
return
if self.droidbox is not None:
self.droidbox.set_apk(self.app.app_path)
self.droidbox.start_unblocked()
self.input_manager.start()
self.droidbox.stop()
self.droidbox.get_output()
else:
self.input_manager.start()
except KeyboardInterrupt:
self.logger.info("Keyboard interrupt.")
pass
except Exception as e:
self.logger.warning("Something went wrong: " + e.message)
import traceback
traceback.print_exc()
self.stop()
sys.exit(-1)
self.stop()
self.logger.info("DroidBot Stopped")
def stop(self):
self.enabled = False
if self.timer and self.timer.isAlive():
self.timer.cancel()
if self.env_manager:
self.env_manager.stop()
if self.input_manager:
self.input_manager.stop()
if self.droidbox:
self.droidbox.stop()
if self.device:
self.device.disconnect()
if not self.keep_env:
self.device.tear_down()
if not self.keep_app:
self.device.uninstall_app(self.app)