329 lines
12 KiB
Python
329 lines
12 KiB
Python
"""
|
|
** mkrec / record / codegen **
|
|
|
|
Creates a new SeleniumBase test file using the Recorder.
|
|
|
|
Usage:
|
|
seleniumbase mkrec [FILE.py] [OPTIONS]
|
|
sbase mkrec [FILE.py] [OPTIONS]
|
|
seleniumbase record [FILE.py] [OPTIONS]
|
|
sbase record [FILE.py] [OPTIONS]
|
|
seleniumbase codegen [FILE.py] [OPTIONS]
|
|
sbase codegen [FILE.py] [OPTIONS]
|
|
|
|
Examples:
|
|
sbase mkrec new_test.py
|
|
sbase mkrec new_test.py --url=seleniumbase.io
|
|
sbase codegen new_test.py
|
|
sbase codegen new_test.py --url=wikipedia.org
|
|
|
|
Options:
|
|
--url=URL (Sets the initial start page URL.)
|
|
--edge (Use Edge browser instead of Chrome.)
|
|
--gui / --headed (Use headed mode on Linux.)
|
|
--uc / --undetected (Use undetectable mode.)
|
|
--overwrite (Overwrite file when it exists.)
|
|
--behave (Also output Behave/Gherkin files.)
|
|
|
|
Output:
|
|
Creates a new SeleniumBase test using the Recorder.
|
|
If the filename already exists, an error is raised.
|
|
"""
|
|
import codecs
|
|
import colorama
|
|
import shutil
|
|
import os
|
|
import sys
|
|
|
|
|
|
def invalid_run_command(msg=None):
|
|
exp = " ** mkrec / record / codegen **\n\n"
|
|
exp += " Usage:\n"
|
|
exp += " seleniumbase mkrec [FILE.py]\n"
|
|
exp += " OR: sbase mkrec [FILE.py]\n"
|
|
exp += " Examples:\n"
|
|
exp += " sbase mkrec new_test.py\n"
|
|
exp += " sbase mkrec new_test.py --url=wikipedia.org\n"
|
|
exp += " Options:\n"
|
|
exp += " --url=URL (Sets the initial start page URL.)\n"
|
|
exp += " --edge (Use Edge browser instead of Chrome.)\n"
|
|
exp += " --gui / --headed (Use headed mode on Linux.)\n"
|
|
exp += " --uc / --undetected (Use undetectable mode.)\n"
|
|
exp += " --overwrite (Overwrite file when it exists.)\n"
|
|
exp += " --behave (Also output Behave/Gherkin files.)\n"
|
|
exp += " Output:\n"
|
|
exp += " Creates a new SeleniumBase test using the Recorder.\n"
|
|
exp += " If the filename already exists, an error is raised.\n"
|
|
if not msg:
|
|
raise Exception("INVALID RUN COMMAND!\n\n%s" % exp)
|
|
elif msg == "help":
|
|
print("\n%s" % exp)
|
|
sys.exit()
|
|
else:
|
|
raise Exception("INVALID RUN COMMAND!\n\n%s\n%s\n" % (exp, msg))
|
|
|
|
|
|
def set_colors(use_colors):
|
|
c0 = ""
|
|
c1 = ""
|
|
c2 = ""
|
|
c5 = ""
|
|
c7 = ""
|
|
cr = ""
|
|
if use_colors:
|
|
if (
|
|
"win32" in sys.platform
|
|
and hasattr(colorama, "just_fix_windows_console")
|
|
):
|
|
colorama.just_fix_windows_console()
|
|
else:
|
|
colorama.init(autoreset=True)
|
|
c0 = colorama.Fore.BLUE + colorama.Back.LIGHTCYAN_EX
|
|
c1 = colorama.Fore.RED + colorama.Back.LIGHTYELLOW_EX
|
|
c2 = colorama.Fore.LIGHTRED_EX + colorama.Back.LIGHTYELLOW_EX
|
|
c5 = colorama.Fore.RED + colorama.Back.LIGHTYELLOW_EX
|
|
c7 = colorama.Fore.BLACK + colorama.Back.MAGENTA
|
|
cr = colorama.Style.RESET_ALL
|
|
return c0, c1, c2, c5, c7, cr
|
|
|
|
|
|
def main():
|
|
help_me = False
|
|
error_msg = None
|
|
invalid_cmd = None
|
|
use_edge = False
|
|
use_uc = False
|
|
esc_end = False
|
|
start_page = None
|
|
next_is_url = False
|
|
use_colors = True
|
|
force_gui = False
|
|
rec_behave = False
|
|
|
|
sys_executable = sys.executable
|
|
if " " in sys_executable:
|
|
sys_executable = "python"
|
|
|
|
if "linux" in sys.platform:
|
|
use_colors = False
|
|
c0, c1, c2, c5, c7, cr = set_colors(use_colors)
|
|
|
|
command_args = sys.argv[2:]
|
|
file_name = command_args[0]
|
|
if file_name == "-h" or file_name == "--help":
|
|
invalid_run_command("help")
|
|
elif not file_name.endswith(".py"):
|
|
error_msg = 'File name must end with ".py"!'
|
|
elif "*" in file_name or len(str(file_name)) < 4:
|
|
error_msg = "Invalid file name!"
|
|
elif file_name.startswith("-"):
|
|
error_msg = 'File name cannot start with "-"!'
|
|
elif "/" in str(file_name) or "\\" in str(file_name):
|
|
error_msg = "File must be created in the current directory!"
|
|
elif file_name == "abc.py":
|
|
error_msg = '"abc.py" is a reserved Python module! Use another name!'
|
|
if error_msg:
|
|
error_msg = c5 + "ERROR: " + error_msg + cr
|
|
invalid_run_command(error_msg)
|
|
|
|
dir_name = os.getcwd()
|
|
file_path = os.path.join(dir_name, file_name)
|
|
|
|
if (
|
|
"--overwrite" in " ".join(command_args).lower()
|
|
and os.path.exists(file_path)
|
|
):
|
|
os.remove(file_path)
|
|
if os.path.exists(file_path):
|
|
error_msg = 'File "%s" already exists in this directory!' % file_name
|
|
error_msg = c5 + "ERROR: " + error_msg + cr
|
|
invalid_run_command(error_msg)
|
|
|
|
if len(command_args) >= 2:
|
|
options = command_args[1:]
|
|
for option in options:
|
|
if option.lower() == "-h" or option.lower() == "--help":
|
|
help_me = True
|
|
elif option.lower() == "--edge":
|
|
use_edge = True
|
|
elif option.lower() == "--ee":
|
|
esc_end = True
|
|
elif option.lower() in ("--gui", "--headed"):
|
|
if "linux" in sys.platform:
|
|
force_gui = True
|
|
elif option.lower() in ("--uc", "--undetected", "--undetectable"):
|
|
use_uc = True
|
|
elif option.lower() in ("--rec-behave", "--behave", "--gherkin"):
|
|
rec_behave = True
|
|
elif option.lower().startswith("--url="):
|
|
start_page = option[len("--url="):]
|
|
elif option.lower() == "--url":
|
|
next_is_url = True
|
|
elif next_is_url:
|
|
start_page = option
|
|
next_is_url = False
|
|
elif option.lower() == "--overwrite":
|
|
pass # Already handled if file existed
|
|
else:
|
|
invalid_cmd = "\n===> INVALID OPTION: >> %s <<\n" % option
|
|
invalid_cmd = invalid_cmd.replace(">> ", ">>" + c5 + " ")
|
|
invalid_cmd = invalid_cmd.replace(" <<", " " + cr + "<<")
|
|
invalid_cmd = invalid_cmd.replace(">>", c7 + ">>" + cr)
|
|
invalid_cmd = invalid_cmd.replace("<<", c7 + "<<" + cr)
|
|
help_me = True
|
|
break
|
|
if help_me:
|
|
invalid_run_command(invalid_cmd)
|
|
|
|
data = []
|
|
data.append("from seleniumbase import BaseCase")
|
|
data.append("")
|
|
data.append("")
|
|
data.append("class RecorderTest(BaseCase):")
|
|
data.append(" def test_recording(self):")
|
|
if use_uc:
|
|
data.append(" if self.undetectable:")
|
|
if (
|
|
start_page
|
|
and (
|
|
start_page.startswith("http:")
|
|
or start_page.startswith("https:")
|
|
or start_page.startswith("file:")
|
|
)
|
|
):
|
|
used_sp = start_page
|
|
if '"' not in start_page:
|
|
used_sp = '"%s"' % start_page
|
|
elif "'" not in start_page:
|
|
used_sp = "'%s'" % start_page
|
|
data.append(
|
|
" self.uc_open_with_disconnect(\n"
|
|
" %s\n"
|
|
" )" % used_sp
|
|
)
|
|
else:
|
|
data.append(" self.disconnect()")
|
|
data.append(" if self.recorder_ext:")
|
|
data.append(" # When done recording actions,")
|
|
data.append(' # type "c", and press [Enter].')
|
|
data.append(" import pdb; pdb.set_trace()")
|
|
data.append("")
|
|
|
|
if esc_end:
|
|
msg = ">>> Use [SHIFT + ESC] in the browser to end recording!"
|
|
d2 = []
|
|
d2.append("from seleniumbase import BaseCase")
|
|
d2.append("")
|
|
d2.append("")
|
|
d2.append("class RecorderTest(BaseCase):")
|
|
d2.append(" def test_recording(self):")
|
|
d2.append(" if self.recorder_ext:")
|
|
d2.append(" print(")
|
|
d2.append(' "\\n\\n%s\\n"' % msg)
|
|
d2.append(" )")
|
|
d2.append(' script = self._get_rec_shift_esc_script()')
|
|
d2.append(' esc = "return document.sb_esc_end;"')
|
|
d2.append(" start_time = self.time()")
|
|
d2.append(" last_handles_num = self._get_num_handles()")
|
|
d2.append(" for i in range(1200):")
|
|
d2.append(" try:")
|
|
d2.append(" self.execute_script(script)")
|
|
d2.append(" handles_num = self._get_num_handles()")
|
|
d2.append(" if handles_num < 1:")
|
|
d2.append(" return")
|
|
d2.append(" elif handles_num != last_handles_num:")
|
|
d2.append(" self.switch_to_window(-1)")
|
|
d2.append(" last_handles_num = handles_num")
|
|
d2.append(' if self.execute_script(esc) == "yes":')
|
|
d2.append(" return")
|
|
d2.append(" elif self.time() - start_time > 600:")
|
|
d2.append(" return")
|
|
d2.append(" self.sleep(0.5)")
|
|
d2.append(" except Exception:")
|
|
d2.append(" return")
|
|
d2.append("")
|
|
data = d2
|
|
|
|
file = codecs.open(file_path, "w+", "utf-8")
|
|
file.writelines("\r\n".join(data))
|
|
file.close()
|
|
success = (
|
|
"\n" + c0 + "* RECORDING initialized:" + cr + " "
|
|
"" + c1 + file_name + "" + cr + "\n"
|
|
)
|
|
print(success)
|
|
run_cmd = None
|
|
if (
|
|
not start_page
|
|
or (
|
|
use_uc
|
|
and (
|
|
start_page.startswith("http:")
|
|
or start_page.startswith("https:")
|
|
or start_page.startswith("file:")
|
|
)
|
|
and not esc_end
|
|
)
|
|
):
|
|
run_cmd = "%s -m pytest %s --rec -q -s" % (sys_executable, file_name)
|
|
else:
|
|
run_cmd = "%s -m pytest %s --rec -q -s --url=%s" % (
|
|
sys_executable, file_name, start_page
|
|
)
|
|
if '"' not in start_page:
|
|
run_cmd = '%s -m pytest %s --rec -q -s --url="%s"' % (
|
|
sys_executable, file_name, start_page
|
|
)
|
|
elif "'" not in start_page:
|
|
run_cmd = "%s -m pytest %s --rec -q -s --url='%s'" % (
|
|
sys_executable, file_name, start_page
|
|
)
|
|
if use_edge:
|
|
run_cmd += " --edge"
|
|
if force_gui:
|
|
run_cmd += " --gui"
|
|
if use_uc:
|
|
run_cmd += " --uc"
|
|
if rec_behave:
|
|
run_cmd += " --rec-behave"
|
|
print(run_cmd)
|
|
os.system(run_cmd)
|
|
if os.path.exists(file_path):
|
|
os.remove(file_path)
|
|
recorded_filename = file_name[:-3] + "_rec.py"
|
|
recordings_dir = os.path.join(dir_name, "recordings")
|
|
recorded_file = os.path.join(recordings_dir, recorded_filename)
|
|
prefix = "%s -m " % sys_executable
|
|
if " " not in recorded_file:
|
|
os.system("%sseleniumbase print %s -n" % (prefix, recorded_file))
|
|
elif '"' not in recorded_file:
|
|
os.system('%sseleniumbase print "%s" -n' % (prefix, recorded_file))
|
|
else:
|
|
os.system("%sseleniumbase print '%s' -n" % (prefix, recorded_file))
|
|
shutil.copy(recorded_file, file_path)
|
|
success = (
|
|
"\n" + c2 + "***" + cr + " RECORDING COPIED to: "
|
|
"" + c1 + file_name + cr + "\n"
|
|
)
|
|
print(success)
|
|
if rec_behave:
|
|
recorded_filename = file_name[:-3] + "_rec.feature"
|
|
recordings_dir = os.path.join(dir_name, "recordings")
|
|
features_dir = os.path.join(recordings_dir, "features")
|
|
recorded_file = os.path.join(features_dir, recorded_filename)
|
|
if " " not in recorded_file:
|
|
os.system("%sseleniumbase print %s -n" % (prefix, recorded_file))
|
|
elif '"' not in recorded_file:
|
|
os.system('%sseleniumbase print "%s" -n' % (prefix, recorded_file))
|
|
else:
|
|
os.system("%sseleniumbase print '%s' -n" % (prefix, recorded_file))
|
|
success = (
|
|
"\n" + c2 + "***" + cr + " BEHAVE RECORDING at: "
|
|
"" + c1 + os.path.relpath(recorded_file) + cr + "\n"
|
|
)
|
|
print(success)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
invalid_run_command()
|