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 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,
event_policy=None,
no_shuffle=False,
no_textview=False,
script_path=None,
event_count=None,
event_interval=None,
event_duration=None,
keep_app=None,
dont_tear_down=False,
quiet=False,
with_droidbox=False,
use_hierarchy_viewer=False,
profiling_method=None,
grant_perm=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 output_dir is not None:
if not os.path.isdir(output_dir):
os.mkdir(output_dir)
self.dont_tear_down = dont_tear_down
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.event_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.event_manager = AppEventManager(device=self.device,
app=self.app,
event_policy=event_policy,
no_shuffle=no_shuffle,
no_textview=no_textview,
event_count=event_count,
event_interval=event_interval,
event_duration=event_duration,
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:
self.device.set_up()
self.device.connect()
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:
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):
if self.env_manager is not None:
self.env_manager.stop()
if self.event_manager is not None:
self.event_manager.stop()
if self.droidbox is not None:
self.droidbox.stop()
self.device.disconnect()
if not self.dont_tear_down:
self.device.tear_down()
if not self.keep_app:
self.device.uninstall_app(self.app)
self.enabled = False
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 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)