Add JuliaRunner to support Dash.jl integration tests#1239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rpkyle merged 16 commits into from
May 19, 2020
Merged

Add JuliaRunner to support Dash.jl integration tests #1239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
afd5e4e
Apply WC insertion fix to .Rd also (#1234)
rpkyle May 7, 2020
6bd6f03
:sparkles: add Julia application runner
May 9, 2020
b166f41
update browser timeout
May 13, 2020
95c06e8
reduce startup timeout
May 13, 2020
e90be19
longer timeout, slow start
May 13, 2020
92cd6fe
Merge branch 'dev' into add-julia-runner
rpkyle May 13, 2020
ecd7ba6
:hammer: remove unnecessary prop_keys_wc
May 13, 2020
fd961e8
:necktie: satisfy linter
May 13, 2020
1bc7181
Merge branch 'add-julia-runner' of github.com:plotly/dash into add-ju…
May 13, 2020
62600db
:hocho: self.tmp_app_path
May 13, 2020
46a0cb8
add debug message
May 13, 2020
c931b65
May 13, 2020
3f520ee
May 13, 2020
76fc7ee
check if tmp_app_path
May 16, 2020
6d29c15
Merge branch 'dev' into add-julia-runner
rpkyle May 18, 2020
4c4d089
relocate assets blocks within if cwd
May 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions dash/development/_r_components_generation.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -185,7 +185,6 @@ def generate_class_string(name, props, project_shortname, prefix):
props = reorder_props(props=props)

prop_keys = list(props.keys())
prop_keys_wc = list(props.keys())

wildcards = ""
wildcard_declaration = ""
Expand All@@ -194,8 +193,8 @@ def generate_class_string(name, props, project_shortname, prefix):
default_argtext = ""
accepted_wildcards = ""

if any(key.endswith("-*") for key in prop_keys_wc):
accepted_wildcards = get_wildcards_r(prop_keys_wc)
if any(key.endswith("-*") for key in prop_keys):
accepted_wildcards = get_wildcards_r(prop_keys)
wildcards = ", ..."
wildcard_declaration = wildcard_template.format(
accepted_wildcards.replace("-*", "")
Expand All@@ -222,6 +221,9 @@ def generate_class_string(name, props, project_shortname, prefix):

default_argtext += ", ".join("{}=NULL".format(p) for p in prop_keys)

if wildcards == ", ...":
default_argtext += ", ..."

# pylint: disable=C0301
default_paramtext += ", ".join(
"{0}={0}".format(p) if p != "children" else "{}=children".format(p)
Expand DownExpand Up@@ -380,15 +382,20 @@ def write_help_file(name, props, description, prefix, rpkg_data):
funcname = format_fn_name(prefix, name)
file_name = funcname + ".Rd"

wildcards = ""
default_argtext = ""
item_text = ""
accepted_wildcards = ""

# the return value of all Dash components should be the same,
# in an abstract sense -- they produce a list
value_text = "named list of JSON elements corresponding to React.js properties and their values" # noqa:E501

prop_keys = list(props.keys())
prop_keys_wc = list(props.keys())

if any(key.endswith("-*") for key in prop_keys):
accepted_wildcards = get_wildcards_r(prop_keys)
wildcards = ", ..."

# Filter props to remove those we don't want to expose
for item in prop_keys[:]:
Expand All@@ -413,9 +420,9 @@ def write_help_file(name, props, description, prefix, rpkg_data):
if "**Example Usage**" in description:
description = description.split("**Example Usage**")[0].rstrip()

if any(key.endswith("-*") for key in prop_keys_wc):
default_argtext += ", ..."
item_text += wildcard_help_template.format(get_wildcards_r(prop_keys_wc))
if wildcards == ", ...":
default_argtext += wildcards
item_text += wildcard_help_template.format(accepted_wildcards)

# in R, the online help viewer does not properly wrap lines for
# the usage string -- we will hard wrap at 60 characters using
Expand Down
136 changes: 119 additions & 17 deletions dash/testing/application_runners.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -221,6 +221,10 @@ def stop(self):
try:
logger.info("proc.terminate with pid %s", self.proc.pid)
self.proc.terminate()
if self.tmp_app_path and os.path.exists(self.tmp_app_path):
logger.debug("removing temporary app path %s",
self.tmp_app_path)
shutil.rmtree(self.tmp_app_path)
if utils.PY3:
# pylint:disable=no-member
_except = subprocess.TimeoutExpired
Expand DownExpand Up@@ -285,6 +289,24 @@ def start(self, app, start_timeout=2, cwd=None):
break
if cwd:
logger.info("RRunner inferred cwd from the Python call stack: %s", cwd)

# try copying all valid sub folders (i.e. assets) in cwd to tmp
# note that the R assets folder name can be any valid folder name
assets = [
os.path.join(cwd, _)
for _ in os.listdir(cwd)
if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
]

for asset in assets:
target = os.path.join(self.tmp_app_path, os.path.basename(asset))
if os.path.exists(target):
logger.debug("delete existing target %s", target)
shutil.rmtree(target)
logger.debug("copying %s => %s", asset, self.tmp_app_path)
shutil.copytree(asset, target)
logger.debug("copied with %s", os.listdir(target))

else:
logger.warning(
"RRunner found no cwd in the Python call stack. "
Expand All@@ -293,23 +315,6 @@ def start(self, app, start_timeout=2, cwd=None):
"dashr.run_server(app, cwd=os.path.dirname(__file__))"
)

# try copying all valid sub folders (i.e. assets) in cwd to tmp
# note that the R assets folder name can be any valid folder name
assets = [
os.path.join(cwd, _)
for _ in os.listdir(cwd)
if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
]

for asset in assets:
target = os.path.join(self.tmp_app_path, os.path.basename(asset))
if os.path.exists(target):
logger.debug("delete existing target %s", target)
shutil.rmtree(target)
logger.debug("copying %s => %s", asset, self.tmp_app_path)
shutil.copytree(asset, target)
logger.debug("copied with %s", os.listdir(target))

logger.info("Run dashR app with Rscript => %s", app)

args = shlex.split(
Expand All@@ -334,3 +339,100 @@ def start(self, app, start_timeout=2, cwd=None):
return

self.started = True


class JuliaRunner(ProcessRunner):
def __init__(self, keep_open=False, stop_timeout=3):
super(JuliaRunner, self).__init__(keep_open=keep_open, stop_timeout=stop_timeout)
self.proc = None

# pylint: disable=arguments-differ
def start(self, app, start_timeout=30, cwd=None):
"""Start the server with subprocess and julia."""

if os.path.isfile(app) and os.path.exists(app):
# app is already a file in a dir - use that as cwd
if not cwd:
cwd = os.path.dirname(app)
logger.info("JuliaRunner inferred cwd from app path: %s", cwd)
else:
# app is a string chunk, we make a temporary folder to store app.jl
# and its relevants assets
self._tmp_app_path = os.path.join(
"/tmp" if not self.is_windows else os.getenv("TEMP"), uuid.uuid4().hex
)
try:
os.mkdir(self.tmp_app_path)
except OSError:
logger.exception("cannot make temporary folder %s", self.tmp_app_path)
path = os.path.join(self.tmp_app_path, "app.jl")

logger.info("JuliaRunner start => app is Julia code chunk")
logger.info("make a temporary Julia file for execution => %s", path)
logger.debug("content of the Dash.jl app")
logger.debug("%s", app)

with open(path, "w") as fp:
fp.write(app)

app = path

# try to find the path to the calling script to use as cwd
if not cwd:
for entry in inspect.stack():
if "/dash/testing/" not in entry[1].replace("\\", "/"):
cwd = os.path.dirname(os.path.realpath(entry[1]))
logger.warning("get cwd from inspect => %s", cwd)
break
if cwd:
logger.info("JuliaRunner inferred cwd from the Python call stack: %s", cwd)

# try copying all valid sub folders (i.e. assets) in cwd to tmp
# note that the R assets folder name can be any valid folder name
assets = [
os.path.join(cwd, _)
for _ in os.listdir(cwd)
if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
]

for asset in assets:
target = os.path.join(self.tmp_app_path, os.path.basename(asset))
if os.path.exists(target):
logger.debug("delete existing target %s", target)
shutil.rmtree(target)
logger.debug("copying %s => %s", asset, self.tmp_app_path)
shutil.copytree(asset, target)
logger.debug("copied with %s", os.listdir(target))

else:
logger.warning(
"JuliaRunner found no cwd in the Python call stack. "
"You may wish to specify an explicit working directory "
"using something like: "
"dashjl.run_server(app, cwd=os.path.dirname(__file__))"
)

logger.info("Run Dash.jl app with julia => %s", app)

args = shlex.split(
"julia {}".format(os.path.realpath(app)),
posix=not self.is_windows,
)
logger.debug("start Dash.jl process with %s", args)

try:
self.proc = subprocess.Popen(
args,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
cwd=self.tmp_app_path if self.tmp_app_path else cwd,
)
# wait until server is able to answer http request
wait.until(lambda: self.accessible(self.url), timeout=start_timeout)

except (OSError, ValueError):
logger.exception("process server has encountered an error")
self.started = False
return

self.started = True
14 changes: 14 additions & 0 deletions dash/testing/composite.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,3 +29,17 @@ def start_server(self, app, cwd=None):

# set the default server_url, it implicitly call wait_for_page
self.server_url = self.server.url


class DashJuliaComposite(Browser):
def __init__(self, server, **kwargs):
super(DashJuliaComposite, self).__init__(**kwargs)
self.server = server

def start_server(self, app, cwd=None):
# start server with Dash.jl app. The app sets its own run_server args
# on the Julia side, but we support overriding the automatic cwd
self.server(app, cwd=cwd)

# set the default server_url, it implicitly call wait_for_page
self.server_url = self.server.url
29 changes: 26 additions & 3 deletions dash/testing/plugin.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,9 @@


try:
from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner
from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner, JuliaRunner
from dash.testing.browser import Browser
from dash.testing.composite import DashComposite, DashRComposite
from dash.testing.composite import DashComposite, DashRComposite, DashJuliaComposite
except ImportError:
pass

Expand DownExpand Up@@ -78,7 +78,7 @@ def pytest_runtest_makereport(item, call): # pylint: disable=unused-argument
if rep.when == "call" and rep.failed and hasattr(item, "funcargs"):
for name, fixture in item.funcargs.items():
try:
if name in {"dash_duo", "dash_br", "dashr"}:
if name in {"dash_duo", "dash_br", "dashr", "dashjl"}:
fixture.take_snapshot(item.name)
except Exception as e: # pylint: disable=broad-except
print(e)
Expand DownExpand Up@@ -109,6 +109,12 @@ def dashr_server():
yield starter


@pytest.fixture
def dashjl_server():
with JuliaRunner() as starter:
yield starter


@pytest.fixture
def dash_br(request, tmpdir):
with Browser(
Expand DownExpand Up@@ -157,3 +163,20 @@ def dashr(request, dashr_server, tmpdir):
pause=request.config.getoption("pause"),
) as dc:
yield dc


@pytest.fixture
def dashjl(request, dashjl_server, tmpdir):
with DashJuliaComposite(
dashjl_server,
browser=request.config.getoption("webdriver"),
remote=request.config.getoption("remote"),
remote_url=request.config.getoption("remote_url"),
headless=request.config.getoption("headless"),
options=request.config.hook.pytest_setup_options(),
download_path=tmpdir.mkdir("download").strpath,
percy_assets_root=request.config.getoption("percy_assets"),
percy_finalize=request.config.getoption("nopercyfinalize"),
pause=request.config.getoption("pause"),
) as dc:
yield dc
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add JuliaRunner to support Dash.jl integration tests#1239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 16 commits into

from

May 19, 2020
 Merged


Add JuliaRunner to support Dash.jl integration tests
#1239
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
afd5e4e

Apply WC insertion fix to .Rd also (#1234)


rpkyle May 7, 2020
6bd6f03

:sparkles: add Julia application runner

May 9, 2020
b166f41

update browser timeout

May 13, 2020
95c06e8

reduce startup timeout

May 13, 2020
e90be19

longer timeout, slow start

May 13, 2020
92cd6fe

Merge branch 'dev' into add-julia-runner


rpkyle May 13, 2020
ecd7ba6

:hammer: remove unnecessary prop_keys_wc

May 13, 2020
fd961e8

:necktie: satisfy linter

May 13, 2020
1bc7181

Merge branch 'add-julia-runner' of github.com:plotly/dash into add-ju…

May 13, 2020
62600db

:hocho: self.tmp_app_path

May 13, 2020
46a0cb8

add debug message

May 13, 2020
c931b65
May 13, 2020
3f520ee
May 13, 2020
76fc7ee

check if tmp_app_path

May 16, 2020
6d29c15

Merge branch 'dev' into add-julia-runner


rpkyle May 18, 2020
4c4d089

relocate assets blocks within if cwd

May 19, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 14 additions & 7 deletions
dash/development/_r_components_generation.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -185,7 +185,6 @@ def generate_class_string(name, props, project_shortname, prefix):
 props = reorder_props(props=props)

 prop_keys = list(props.keys())
 prop_keys_wc = list(props.keys())

 wildcards = ""
 wildcard_declaration = ""
Expand All@@ -194,8 +193,8 @@ def generate_class_string(name, props, project_shortname, prefix):
 default_argtext = ""
 accepted_wildcards = ""

 if any(key.endswith("-*") for key in prop_keys_wc):
 accepted_wildcards = get_wildcards_r(prop_keys_wc)
 if any(key.endswith("-*") for key in prop_keys):
 accepted_wildcards = get_wildcards_r(prop_keys)
 wildcards = ", ..."
 wildcard_declaration = wildcard_template.format(
 accepted_wildcards.replace("-*", "")
Expand All@@ -222,6 +221,9 @@ def generate_class_string(name, props, project_shortname, prefix):

 default_argtext += ", ".join("{}=NULL".format(p) for p in prop_keys)

 if wildcards == ", ...":
 default_argtext += ", ..."

 # pylint: disable=C0301
 default_paramtext += ", ".join(
 "{0}={0}".format(p) if p != "children" else "{}=children".format(p)
Expand DownExpand Up@@ -380,15 +382,20 @@ def write_help_file(name, props, description, prefix, rpkg_data):
 funcname = format_fn_name(prefix, name)
 file_name = funcname + ".Rd"

 wildcards = ""
 default_argtext = ""
 item_text = ""
 accepted_wildcards = ""

 # the return value of all Dash components should be the same,
 # in an abstract sense -- they produce a list
 value_text = "named list of JSON elements corresponding to React.js properties and their values" # noqa:E501

 prop_keys = list(props.keys())
 prop_keys_wc = list(props.keys())

 if any(key.endswith("-*") for key in prop_keys):
 accepted_wildcards = get_wildcards_r(prop_keys)
 wildcards = ", ..."

 # Filter props to remove those we don't want to expose
 for item in prop_keys[:]:
Expand All@@ -413,9 +420,9 @@ def write_help_file(name, props, description, prefix, rpkg_data):
 if "**Example Usage**" in description:
 description = description.split("**Example Usage**")[0].rstrip()

 if any(key.endswith("-*") for key in prop_keys_wc):
 default_argtext += ", ..."
 item_text += wildcard_help_template.format(get_wildcards_r(prop_keys_wc))
 if wildcards == ", ...":
 default_argtext += wildcards
 item_text += wildcard_help_template.format(accepted_wildcards)

 # in R, the online help viewer does not properly wrap lines for
 # the usage string -- we will hard wrap at 60 characters using
Expand Down

136 changes: 119 additions & 17 deletions
dash/testing/application_runners.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -221,6 +221,10 @@ def stop(self):
 try:
 logger.info("proc.terminate with pid %s", self.proc.pid)
 self.proc.terminate()
 if self.tmp_app_path and os.path.exists(self.tmp_app_path):
 logger.debug("removing temporary app path %s",
 self.tmp_app_path)
 shutil.rmtree(self.tmp_app_path)
 if utils.PY3:
 # pylint:disable=no-member
 _except = subprocess.TimeoutExpired
Expand DownExpand Up@@ -285,6 +289,24 @@ def start(self, app, start_timeout=2, cwd=None):
 break
 if cwd:
 logger.info("RRunner inferred cwd from the Python call stack: %s", cwd)

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 else:
 logger.warning(
 "RRunner found no cwd in the Python call stack. "
Expand All@@ -293,23 +315,6 @@ def start(self, app, start_timeout=2, cwd=None):
 "dashr.run_server(app, cwd=os.path.dirname(__file__))"
 )

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 logger.info("Run dashR app with Rscript => %s", app)

 args = shlex.split(
Expand All@@ -334,3 +339,100 @@ def start(self, app, start_timeout=2, cwd=None):
 return

 self.started = True


class JuliaRunner(ProcessRunner):
 def __init__(self, keep_open=False, stop_timeout=3):
 super(JuliaRunner, self).__init__(keep_open=keep_open, stop_timeout=stop_timeout)
 self.proc = None

 # pylint: disable=arguments-differ
 def start(self, app, start_timeout=30, cwd=None):
 """Start the server with subprocess and julia."""

 if os.path.isfile(app) and os.path.exists(app):
 # app is already a file in a dir - use that as cwd
 if not cwd:
 cwd = os.path.dirname(app)
 logger.info("JuliaRunner inferred cwd from app path: %s", cwd)
 else:
 # app is a string chunk, we make a temporary folder to store app.jl
 # and its relevants assets
 self._tmp_app_path = os.path.join(
 "/tmp" if not self.is_windows else os.getenv("TEMP"), uuid.uuid4().hex
 )
 try:
 os.mkdir(self.tmp_app_path)
 except OSError:
 logger.exception("cannot make temporary folder %s", self.tmp_app_path)
 path = os.path.join(self.tmp_app_path, "app.jl")

 logger.info("JuliaRunner start => app is Julia code chunk")
 logger.info("make a temporary Julia file for execution => %s", path)
 logger.debug("content of the Dash.jl app")
 logger.debug("%s", app)

 with open(path, "w") as fp:
 fp.write(app)

 app = path

 # try to find the path to the calling script to use as cwd
 if not cwd:
 for entry in inspect.stack():
 if "/dash/testing/" not in entry[1].replace("\\", "/"):
 cwd = os.path.dirname(os.path.realpath(entry[1]))
 logger.warning("get cwd from inspect => %s", cwd)
 break
 if cwd:
 logger.info("JuliaRunner inferred cwd from the Python call stack: %s", cwd)

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 else:
 logger.warning(
 "JuliaRunner found no cwd in the Python call stack. "
 "You may wish to specify an explicit working directory "
 "using something like: "
 "dashjl.run_server(app, cwd=os.path.dirname(__file__))"
 )

 logger.info("Run Dash.jl app with julia => %s", app)

 args = shlex.split(
 "julia {}".format(os.path.realpath(app)),
 posix=not self.is_windows,
 )
 logger.debug("start Dash.jl process with %s", args)

 try:
 self.proc = subprocess.Popen(
 args,
 stdout=subprocess.PIPE,
 stderr=subprocess.PIPE,
 cwd=self.tmp_app_path if self.tmp_app_path else cwd,
 )
 # wait until server is able to answer http request
 wait.until(lambda: self.accessible(self.url), timeout=start_timeout)

 except (OSError, ValueError):
 logger.exception("process server has encountered an error")
 self.started = False
 return

 self.started = True

14 changes: 14 additions & 0 deletions
dash/testing/composite.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,3 +29,17 @@ def start_server(self, app, cwd=None):

 # set the default server_url, it implicitly call wait_for_page
 self.server_url = self.server.url


class DashJuliaComposite(Browser):
 def __init__(self, server, **kwargs):
 super(DashJuliaComposite, self).__init__(**kwargs)
 self.server = server

 def start_server(self, app, cwd=None):
 # start server with Dash.jl app. The app sets its own run_server args
 # on the Julia side, but we support overriding the automatic cwd
 self.server(app, cwd=cwd)

 # set the default server_url, it implicitly call wait_for_page
 self.server_url = self.server.url

29 changes: 26 additions & 3 deletions
dash/testing/plugin.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,9 @@


try:
 from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner
 from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner, JuliaRunner
 from dash.testing.browser import Browser
 from dash.testing.composite import DashComposite, DashRComposite
 from dash.testing.composite import DashComposite, DashRComposite, DashJuliaComposite
except ImportError:
 pass

Expand DownExpand Up@@ -78,7 +78,7 @@ def pytest_runtest_makereport(item, call): # pylint: disable=unused-argument
 if rep.when == "call" and rep.failed and hasattr(item, "funcargs"):
 for name, fixture in item.funcargs.items():
 try:
 if name in {"dash_duo", "dash_br", "dashr"}:
 if name in {"dash_duo", "dash_br", "dashr", "dashjl"}:
 fixture.take_snapshot(item.name)
 except Exception as e: # pylint: disable=broad-except
 print(e)
Expand DownExpand Up@@ -109,6 +109,12 @@ def dashr_server():
 yield starter


@pytest.fixture
def dashjl_server():
 with JuliaRunner() as starter:
 yield starter


@pytest.fixture
def dash_br(request, tmpdir):
 with Browser(
Expand DownExpand Up@@ -157,3 +163,20 @@ def dashr(request, dashr_server, tmpdir):
 pause=request.config.getoption("pause"),
 ) as dc:
 yield dc


@pytest.fixture
def dashjl(request, dashjl_server, tmpdir):
 with DashJuliaComposite(
 dashjl_server,
 browser=request.config.getoption("webdriver"),
 remote=request.config.getoption("remote"),
 remote_url=request.config.getoption("remote_url"),
 headless=request.config.getoption("headless"),
 options=request.config.hook.pytest_setup_options(),
 download_path=tmpdir.mkdir("download").strpath,
 percy_assets_root=request.config.getoption("percy_assets"),
 percy_finalize=request.config.getoption("nopercyfinalize"),
 pause=request.config.getoption("pause"),
 ) as dc:
 yield dc

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add JuliaRunner to support Dash.jl integration tests#1239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 16 commits into

from

May 19, 2020
 Merged


Add JuliaRunner to support Dash.jl integration tests
#1239
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
afd5e4e

Apply WC insertion fix to .Rd also (#1234)


rpkyle May 7, 2020
6bd6f03

:sparkles: add Julia application runner

May 9, 2020
b166f41

update browser timeout

May 13, 2020
95c06e8

reduce startup timeout

May 13, 2020
e90be19

longer timeout, slow start

May 13, 2020
92cd6fe

Merge branch 'dev' into add-julia-runner


rpkyle May 13, 2020
ecd7ba6

:hammer: remove unnecessary prop_keys_wc

May 13, 2020
fd961e8

:necktie: satisfy linter

May 13, 2020
1bc7181

Merge branch 'add-julia-runner' of github.com:plotly/dash into add-ju…

May 13, 2020
62600db

:hocho: self.tmp_app_path

May 13, 2020
46a0cb8

add debug message

May 13, 2020
c931b65
May 13, 2020
3f520ee
May 13, 2020
76fc7ee

check if tmp_app_path

May 16, 2020
6d29c15

Merge branch 'dev' into add-julia-runner


rpkyle May 18, 2020
4c4d089

relocate assets blocks within if cwd

May 19, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 14 additions & 7 deletions
dash/development/_r_components_generation.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -185,7 +185,6 @@ def generate_class_string(name, props, project_shortname, prefix):
 props = reorder_props(props=props)

 prop_keys = list(props.keys())
 prop_keys_wc = list(props.keys())

 wildcards = ""
 wildcard_declaration = ""
Expand All@@ -194,8 +193,8 @@ def generate_class_string(name, props, project_shortname, prefix):
 default_argtext = ""
 accepted_wildcards = ""

 if any(key.endswith("-*") for key in prop_keys_wc):
 accepted_wildcards = get_wildcards_r(prop_keys_wc)
 if any(key.endswith("-*") for key in prop_keys):
 accepted_wildcards = get_wildcards_r(prop_keys)
 wildcards = ", ..."
 wildcard_declaration = wildcard_template.format(
 accepted_wildcards.replace("-*", "")
Expand All@@ -222,6 +221,9 @@ def generate_class_string(name, props, project_shortname, prefix):

 default_argtext += ", ".join("{}=NULL".format(p) for p in prop_keys)

 if wildcards == ", ...":
 default_argtext += ", ..."

 # pylint: disable=C0301
 default_paramtext += ", ".join(
 "{0}={0}".format(p) if p != "children" else "{}=children".format(p)
Expand DownExpand Up@@ -380,15 +382,20 @@ def write_help_file(name, props, description, prefix, rpkg_data):
 funcname = format_fn_name(prefix, name)
 file_name = funcname + ".Rd"

 wildcards = ""
 default_argtext = ""
 item_text = ""
 accepted_wildcards = ""

 # the return value of all Dash components should be the same,
 # in an abstract sense -- they produce a list
 value_text = "named list of JSON elements corresponding to React.js properties and their values" # noqa:E501

 prop_keys = list(props.keys())
 prop_keys_wc = list(props.keys())

 if any(key.endswith("-*") for key in prop_keys):
 accepted_wildcards = get_wildcards_r(prop_keys)
 wildcards = ", ..."

 # Filter props to remove those we don't want to expose
 for item in prop_keys[:]:
Expand All@@ -413,9 +420,9 @@ def write_help_file(name, props, description, prefix, rpkg_data):
 if "**Example Usage**" in description:
 description = description.split("**Example Usage**")[0].rstrip()

 if any(key.endswith("-*") for key in prop_keys_wc):
 default_argtext += ", ..."
 item_text += wildcard_help_template.format(get_wildcards_r(prop_keys_wc))
 if wildcards == ", ...":
 default_argtext += wildcards
 item_text += wildcard_help_template.format(accepted_wildcards)

 # in R, the online help viewer does not properly wrap lines for
 # the usage string -- we will hard wrap at 60 characters using
Expand Down

136 changes: 119 additions & 17 deletions
dash/testing/application_runners.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -221,6 +221,10 @@ def stop(self):
 try:
 logger.info("proc.terminate with pid %s", self.proc.pid)
 self.proc.terminate()
 if self.tmp_app_path and os.path.exists(self.tmp_app_path):
 logger.debug("removing temporary app path %s",
 self.tmp_app_path)
 shutil.rmtree(self.tmp_app_path)
 if utils.PY3:
 # pylint:disable=no-member
 _except = subprocess.TimeoutExpired
Expand DownExpand Up@@ -285,6 +289,24 @@ def start(self, app, start_timeout=2, cwd=None):
 break
 if cwd:
 logger.info("RRunner inferred cwd from the Python call stack: %s", cwd)

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 else:
 logger.warning(
 "RRunner found no cwd in the Python call stack. "
Expand All@@ -293,23 +315,6 @@ def start(self, app, start_timeout=2, cwd=None):
 "dashr.run_server(app, cwd=os.path.dirname(__file__))"
 )

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 logger.info("Run dashR app with Rscript => %s", app)

 args = shlex.split(
Expand All@@ -334,3 +339,100 @@ def start(self, app, start_timeout=2, cwd=None):
 return

 self.started = True


class JuliaRunner(ProcessRunner):
 def __init__(self, keep_open=False, stop_timeout=3):
 super(JuliaRunner, self).__init__(keep_open=keep_open, stop_timeout=stop_timeout)
 self.proc = None

 # pylint: disable=arguments-differ
 def start(self, app, start_timeout=30, cwd=None):
 """Start the server with subprocess and julia."""

 if os.path.isfile(app) and os.path.exists(app):
 # app is already a file in a dir - use that as cwd
 if not cwd:
 cwd = os.path.dirname(app)
 logger.info("JuliaRunner inferred cwd from app path: %s", cwd)
 else:
 # app is a string chunk, we make a temporary folder to store app.jl
 # and its relevants assets
 self._tmp_app_path = os.path.join(
 "/tmp" if not self.is_windows else os.getenv("TEMP"), uuid.uuid4().hex
 )
 try:
 os.mkdir(self.tmp_app_path)
 except OSError:
 logger.exception("cannot make temporary folder %s", self.tmp_app_path)
 path = os.path.join(self.tmp_app_path, "app.jl")

 logger.info("JuliaRunner start => app is Julia code chunk")
 logger.info("make a temporary Julia file for execution => %s", path)
 logger.debug("content of the Dash.jl app")
 logger.debug("%s", app)

 with open(path, "w") as fp:
 fp.write(app)

 app = path

 # try to find the path to the calling script to use as cwd
 if not cwd:
 for entry in inspect.stack():
 if "/dash/testing/" not in entry[1].replace("\\", "/"):
 cwd = os.path.dirname(os.path.realpath(entry[1]))
 logger.warning("get cwd from inspect => %s", cwd)
 break
 if cwd:
 logger.info("JuliaRunner inferred cwd from the Python call stack: %s", cwd)

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 else:
 logger.warning(
 "JuliaRunner found no cwd in the Python call stack. "
 "You may wish to specify an explicit working directory "
 "using something like: "
 "dashjl.run_server(app, cwd=os.path.dirname(__file__))"
 )

 logger.info("Run Dash.jl app with julia => %s", app)

 args = shlex.split(
 "julia {}".format(os.path.realpath(app)),
 posix=not self.is_windows,
 )
 logger.debug("start Dash.jl process with %s", args)

 try:
 self.proc = subprocess.Popen(
 args,
 stdout=subprocess.PIPE,
 stderr=subprocess.PIPE,
 cwd=self.tmp_app_path if self.tmp_app_path else cwd,
 )
 # wait until server is able to answer http request
 wait.until(lambda: self.accessible(self.url), timeout=start_timeout)

 except (OSError, ValueError):
 logger.exception("process server has encountered an error")
 self.started = False
 return

 self.started = True

14 changes: 14 additions & 0 deletions
dash/testing/composite.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,3 +29,17 @@ def start_server(self, app, cwd=None):

 # set the default server_url, it implicitly call wait_for_page
 self.server_url = self.server.url


class DashJuliaComposite(Browser):
 def __init__(self, server, **kwargs):
 super(DashJuliaComposite, self).__init__(**kwargs)
 self.server = server

 def start_server(self, app, cwd=None):
 # start server with Dash.jl app. The app sets its own run_server args
 # on the Julia side, but we support overriding the automatic cwd
 self.server(app, cwd=cwd)

 # set the default server_url, it implicitly call wait_for_page
 self.server_url = self.server.url

29 changes: 26 additions & 3 deletions
dash/testing/plugin.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,9 @@


try:
 from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner
 from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner, JuliaRunner
 from dash.testing.browser import Browser
 from dash.testing.composite import DashComposite, DashRComposite
 from dash.testing.composite import DashComposite, DashRComposite, DashJuliaComposite
except ImportError:
 pass

Expand DownExpand Up@@ -78,7 +78,7 @@ def pytest_runtest_makereport(item, call): # pylint: disable=unused-argument
 if rep.when == "call" and rep.failed and hasattr(item, "funcargs"):
 for name, fixture in item.funcargs.items():
 try:
 if name in {"dash_duo", "dash_br", "dashr"}:
 if name in {"dash_duo", "dash_br", "dashr", "dashjl"}:
 fixture.take_snapshot(item.name)
 except Exception as e: # pylint: disable=broad-except
 print(e)
Expand DownExpand Up@@ -109,6 +109,12 @@ def dashr_server():
 yield starter


@pytest.fixture
def dashjl_server():
 with JuliaRunner() as starter:
 yield starter


@pytest.fixture
def dash_br(request, tmpdir):
 with Browser(
Expand DownExpand Up@@ -157,3 +163,20 @@ def dashr(request, dashr_server, tmpdir):
 pause=request.config.getoption("pause"),
 ) as dc:
 yield dc


@pytest.fixture
def dashjl(request, dashjl_server, tmpdir):
 with DashJuliaComposite(
 dashjl_server,
 browser=request.config.getoption("webdriver"),
 remote=request.config.getoption("remote"),
 remote_url=request.config.getoption("remote_url"),
 headless=request.config.getoption("headless"),
 options=request.config.hook.pytest_setup_options(),
 download_path=tmpdir.mkdir("download").strpath,
 percy_assets_root=request.config.getoption("percy_assets"),
 percy_finalize=request.config.getoption("nopercyfinalize"),
 pause=request.config.getoption("pause"),
 ) as dc:
 yield dc

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add JuliaRunner to support Dash.jl integration tests#1239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 16 commits into

from

May 19, 2020
 Merged


Add JuliaRunner to support Dash.jl integration tests
#1239
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
afd5e4e

Apply WC insertion fix to .Rd also (#1234)


rpkyle May 7, 2020
6bd6f03

:sparkles: add Julia application runner

May 9, 2020
b166f41

update browser timeout

May 13, 2020
95c06e8

reduce startup timeout

May 13, 2020
e90be19

longer timeout, slow start

May 13, 2020
92cd6fe

Merge branch 'dev' into add-julia-runner


rpkyle May 13, 2020
ecd7ba6

:hammer: remove unnecessary prop_keys_wc

May 13, 2020
fd961e8

:necktie: satisfy linter

May 13, 2020
1bc7181

Merge branch 'add-julia-runner' of github.com:plotly/dash into add-ju…

May 13, 2020
62600db

:hocho: self.tmp_app_path

May 13, 2020
46a0cb8

add debug message

May 13, 2020
c931b65
May 13, 2020
3f520ee
May 13, 2020
76fc7ee

check if tmp_app_path

May 16, 2020
6d29c15

Merge branch 'dev' into add-julia-runner


rpkyle May 18, 2020
4c4d089

relocate assets blocks within if cwd

May 19, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 14 additions & 7 deletions
dash/development/_r_components_generation.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -185,7 +185,6 @@ def generate_class_string(name, props, project_shortname, prefix):
 props = reorder_props(props=props)

 prop_keys = list(props.keys())
 prop_keys_wc = list(props.keys())

 wildcards = ""
 wildcard_declaration = ""
Expand All@@ -194,8 +193,8 @@ def generate_class_string(name, props, project_shortname, prefix):
 default_argtext = ""
 accepted_wildcards = ""

 if any(key.endswith("-*") for key in prop_keys_wc):
 accepted_wildcards = get_wildcards_r(prop_keys_wc)
 if any(key.endswith("-*") for key in prop_keys):
 accepted_wildcards = get_wildcards_r(prop_keys)
 wildcards = ", ..."
 wildcard_declaration = wildcard_template.format(
 accepted_wildcards.replace("-*", "")
Expand All@@ -222,6 +221,9 @@ def generate_class_string(name, props, project_shortname, prefix):

 default_argtext += ", ".join("{}=NULL".format(p) for p in prop_keys)

 if wildcards == ", ...":
 default_argtext += ", ..."

 # pylint: disable=C0301
 default_paramtext += ", ".join(
 "{0}={0}".format(p) if p != "children" else "{}=children".format(p)
Expand DownExpand Up@@ -380,15 +382,20 @@ def write_help_file(name, props, description, prefix, rpkg_data):
 funcname = format_fn_name(prefix, name)
 file_name = funcname + ".Rd"

 wildcards = ""
 default_argtext = ""
 item_text = ""
 accepted_wildcards = ""

 # the return value of all Dash components should be the same,
 # in an abstract sense -- they produce a list
 value_text = "named list of JSON elements corresponding to React.js properties and their values" # noqa:E501

 prop_keys = list(props.keys())
 prop_keys_wc = list(props.keys())

 if any(key.endswith("-*") for key in prop_keys):
 accepted_wildcards = get_wildcards_r(prop_keys)
 wildcards = ", ..."

 # Filter props to remove those we don't want to expose
 for item in prop_keys[:]:
Expand All@@ -413,9 +420,9 @@ def write_help_file(name, props, description, prefix, rpkg_data):
 if "**Example Usage**" in description:
 description = description.split("**Example Usage**")[0].rstrip()

 if any(key.endswith("-*") for key in prop_keys_wc):
 default_argtext += ", ..."
 item_text += wildcard_help_template.format(get_wildcards_r(prop_keys_wc))
 if wildcards == ", ...":
 default_argtext += wildcards
 item_text += wildcard_help_template.format(accepted_wildcards)

 # in R, the online help viewer does not properly wrap lines for
 # the usage string -- we will hard wrap at 60 characters using
Expand Down

136 changes: 119 additions & 17 deletions
dash/testing/application_runners.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -221,6 +221,10 @@ def stop(self):
 try:
 logger.info("proc.terminate with pid %s", self.proc.pid)
 self.proc.terminate()
 if self.tmp_app_path and os.path.exists(self.tmp_app_path):
 logger.debug("removing temporary app path %s",
 self.tmp_app_path)
 shutil.rmtree(self.tmp_app_path)
 if utils.PY3:
 # pylint:disable=no-member
 _except = subprocess.TimeoutExpired
Expand DownExpand Up@@ -285,6 +289,24 @@ def start(self, app, start_timeout=2, cwd=None):
 break
 if cwd:
 logger.info("RRunner inferred cwd from the Python call stack: %s", cwd)

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 else:
 logger.warning(
 "RRunner found no cwd in the Python call stack. "
Expand All@@ -293,23 +315,6 @@ def start(self, app, start_timeout=2, cwd=None):
 "dashr.run_server(app, cwd=os.path.dirname(__file__))"
 )

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 logger.info("Run dashR app with Rscript => %s", app)

 args = shlex.split(
Expand All@@ -334,3 +339,100 @@ def start(self, app, start_timeout=2, cwd=None):
 return

 self.started = True


class JuliaRunner(ProcessRunner):
 def __init__(self, keep_open=False, stop_timeout=3):
 super(JuliaRunner, self).__init__(keep_open=keep_open, stop_timeout=stop_timeout)
 self.proc = None

 # pylint: disable=arguments-differ
 def start(self, app, start_timeout=30, cwd=None):
 """Start the server with subprocess and julia."""

 if os.path.isfile(app) and os.path.exists(app):
 # app is already a file in a dir - use that as cwd
 if not cwd:
 cwd = os.path.dirname(app)
 logger.info("JuliaRunner inferred cwd from app path: %s", cwd)
 else:
 # app is a string chunk, we make a temporary folder to store app.jl
 # and its relevants assets
 self._tmp_app_path = os.path.join(
 "/tmp" if not self.is_windows else os.getenv("TEMP"), uuid.uuid4().hex
 )
 try:
 os.mkdir(self.tmp_app_path)
 except OSError:
 logger.exception("cannot make temporary folder %s", self.tmp_app_path)
 path = os.path.join(self.tmp_app_path, "app.jl")

 logger.info("JuliaRunner start => app is Julia code chunk")
 logger.info("make a temporary Julia file for execution => %s", path)
 logger.debug("content of the Dash.jl app")
 logger.debug("%s", app)

 with open(path, "w") as fp:
 fp.write(app)

 app = path

 # try to find the path to the calling script to use as cwd
 if not cwd:
 for entry in inspect.stack():
 if "/dash/testing/" not in entry[1].replace("\\", "/"):
 cwd = os.path.dirname(os.path.realpath(entry[1]))
 logger.warning("get cwd from inspect => %s", cwd)
 break
 if cwd:
 logger.info("JuliaRunner inferred cwd from the Python call stack: %s", cwd)

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 else:
 logger.warning(
 "JuliaRunner found no cwd in the Python call stack. "
 "You may wish to specify an explicit working directory "
 "using something like: "
 "dashjl.run_server(app, cwd=os.path.dirname(__file__))"
 )

 logger.info("Run Dash.jl app with julia => %s", app)

 args = shlex.split(
 "julia {}".format(os.path.realpath(app)),
 posix=not self.is_windows,
 )
 logger.debug("start Dash.jl process with %s", args)

 try:
 self.proc = subprocess.Popen(
 args,
 stdout=subprocess.PIPE,
 stderr=subprocess.PIPE,
 cwd=self.tmp_app_path if self.tmp_app_path else cwd,
 )
 # wait until server is able to answer http request
 wait.until(lambda: self.accessible(self.url), timeout=start_timeout)

 except (OSError, ValueError):
 logger.exception("process server has encountered an error")
 self.started = False
 return

 self.started = True

14 changes: 14 additions & 0 deletions
dash/testing/composite.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,3 +29,17 @@ def start_server(self, app, cwd=None):

 # set the default server_url, it implicitly call wait_for_page
 self.server_url = self.server.url


class DashJuliaComposite(Browser):
 def __init__(self, server, **kwargs):
 super(DashJuliaComposite, self).__init__(**kwargs)
 self.server = server

 def start_server(self, app, cwd=None):
 # start server with Dash.jl app. The app sets its own run_server args
 # on the Julia side, but we support overriding the automatic cwd
 self.server(app, cwd=cwd)

 # set the default server_url, it implicitly call wait_for_page
 self.server_url = self.server.url

29 changes: 26 additions & 3 deletions
dash/testing/plugin.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,9 @@


try:
 from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner
 from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner, JuliaRunner
 from dash.testing.browser import Browser
 from dash.testing.composite import DashComposite, DashRComposite
 from dash.testing.composite import DashComposite, DashRComposite, DashJuliaComposite
except ImportError:
 pass

Expand DownExpand Up@@ -78,7 +78,7 @@ def pytest_runtest_makereport(item, call): # pylint: disable=unused-argument
 if rep.when == "call" and rep.failed and hasattr(item, "funcargs"):
 for name, fixture in item.funcargs.items():
 try:
 if name in {"dash_duo", "dash_br", "dashr"}:
 if name in {"dash_duo", "dash_br", "dashr", "dashjl"}:
 fixture.take_snapshot(item.name)
 except Exception as e: # pylint: disable=broad-except
 print(e)
Expand DownExpand Up@@ -109,6 +109,12 @@ def dashr_server():
 yield starter


@pytest.fixture
def dashjl_server():
 with JuliaRunner() as starter:
 yield starter


@pytest.fixture
def dash_br(request, tmpdir):
 with Browser(
Expand DownExpand Up@@ -157,3 +163,20 @@ def dashr(request, dashr_server, tmpdir):
 pause=request.config.getoption("pause"),
 ) as dc:
 yield dc


@pytest.fixture
def dashjl(request, dashjl_server, tmpdir):
 with DashJuliaComposite(
 dashjl_server,
 browser=request.config.getoption("webdriver"),
 remote=request.config.getoption("remote"),
 remote_url=request.config.getoption("remote_url"),
 headless=request.config.getoption("headless"),
 options=request.config.hook.pytest_setup_options(),
 download_path=tmpdir.mkdir("download").strpath,
 percy_assets_root=request.config.getoption("percy_assets"),
 percy_finalize=request.config.getoption("nopercyfinalize"),
 pause=request.config.getoption("pause"),
 ) as dc:
 yield dc

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add JuliaRunner to support Dash.jl integration tests#1239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 16 commits into

from

May 19, 2020
 Merged


Add JuliaRunner to support Dash.jl integration tests
#1239
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
afd5e4e

Apply WC insertion fix to .Rd also (#1234)


rpkyle May 7, 2020
6bd6f03

:sparkles: add Julia application runner

May 9, 2020
b166f41

update browser timeout

May 13, 2020
95c06e8

reduce startup timeout

May 13, 2020
e90be19

longer timeout, slow start

May 13, 2020
92cd6fe

Merge branch 'dev' into add-julia-runner


rpkyle May 13, 2020
ecd7ba6

:hammer: remove unnecessary prop_keys_wc

May 13, 2020
fd961e8

:necktie: satisfy linter

May 13, 2020
1bc7181

Merge branch 'add-julia-runner' of github.com:plotly/dash into add-ju…

May 13, 2020
62600db

:hocho: self.tmp_app_path

May 13, 2020
46a0cb8

add debug message

May 13, 2020
c931b65
May 13, 2020
3f520ee
May 13, 2020
76fc7ee

check if tmp_app_path

May 16, 2020
6d29c15

Merge branch 'dev' into add-julia-runner


rpkyle May 18, 2020
4c4d089

relocate assets blocks within if cwd

May 19, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 14 additions & 7 deletions
dash/development/_r_components_generation.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -185,7 +185,6 @@ def generate_class_string(name, props, project_shortname, prefix):
 props = reorder_props(props=props)

 prop_keys = list(props.keys())
 prop_keys_wc = list(props.keys())

 wildcards = ""
 wildcard_declaration = ""
Expand All@@ -194,8 +193,8 @@ def generate_class_string(name, props, project_shortname, prefix):
 default_argtext = ""
 accepted_wildcards = ""

 if any(key.endswith("-*") for key in prop_keys_wc):
 accepted_wildcards = get_wildcards_r(prop_keys_wc)
 if any(key.endswith("-*") for key in prop_keys):
 accepted_wildcards = get_wildcards_r(prop_keys)
 wildcards = ", ..."
 wildcard_declaration = wildcard_template.format(
 accepted_wildcards.replace("-*", "")
Expand All@@ -222,6 +221,9 @@ def generate_class_string(name, props, project_shortname, prefix):

 default_argtext += ", ".join("{}=NULL".format(p) for p in prop_keys)

 if wildcards == ", ...":
 default_argtext += ", ..."

 # pylint: disable=C0301
 default_paramtext += ", ".join(
 "{0}={0}".format(p) if p != "children" else "{}=children".format(p)
Expand DownExpand Up@@ -380,15 +382,20 @@ def write_help_file(name, props, description, prefix, rpkg_data):
 funcname = format_fn_name(prefix, name)
 file_name = funcname + ".Rd"

 wildcards = ""
 default_argtext = ""
 item_text = ""
 accepted_wildcards = ""

 # the return value of all Dash components should be the same,
 # in an abstract sense -- they produce a list
 value_text = "named list of JSON elements corresponding to React.js properties and their values" # noqa:E501

 prop_keys = list(props.keys())
 prop_keys_wc = list(props.keys())

 if any(key.endswith("-*") for key in prop_keys):
 accepted_wildcards = get_wildcards_r(prop_keys)
 wildcards = ", ..."

 # Filter props to remove those we don't want to expose
 for item in prop_keys[:]:
Expand All@@ -413,9 +420,9 @@ def write_help_file(name, props, description, prefix, rpkg_data):
 if "**Example Usage**" in description:
 description = description.split("**Example Usage**")[0].rstrip()

 if any(key.endswith("-*") for key in prop_keys_wc):
 default_argtext += ", ..."
 item_text += wildcard_help_template.format(get_wildcards_r(prop_keys_wc))
 if wildcards == ", ...":
 default_argtext += wildcards
 item_text += wildcard_help_template.format(accepted_wildcards)

 # in R, the online help viewer does not properly wrap lines for
 # the usage string -- we will hard wrap at 60 characters using
Expand Down

136 changes: 119 additions & 17 deletions
dash/testing/application_runners.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -221,6 +221,10 @@ def stop(self):
 try:
 logger.info("proc.terminate with pid %s", self.proc.pid)
 self.proc.terminate()
 if self.tmp_app_path and os.path.exists(self.tmp_app_path):
 logger.debug("removing temporary app path %s",
 self.tmp_app_path)
 shutil.rmtree(self.tmp_app_path)
 if utils.PY3:
 # pylint:disable=no-member
 _except = subprocess.TimeoutExpired
Expand DownExpand Up@@ -285,6 +289,24 @@ def start(self, app, start_timeout=2, cwd=None):
 break
 if cwd:
 logger.info("RRunner inferred cwd from the Python call stack: %s", cwd)

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 else:
 logger.warning(
 "RRunner found no cwd in the Python call stack. "
Expand All@@ -293,23 +315,6 @@ def start(self, app, start_timeout=2, cwd=None):
 "dashr.run_server(app, cwd=os.path.dirname(__file__))"
 )

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 logger.info("Run dashR app with Rscript => %s", app)

 args = shlex.split(
Expand All@@ -334,3 +339,100 @@ def start(self, app, start_timeout=2, cwd=None):
 return

 self.started = True


class JuliaRunner(ProcessRunner):
 def __init__(self, keep_open=False, stop_timeout=3):
 super(JuliaRunner, self).__init__(keep_open=keep_open, stop_timeout=stop_timeout)
 self.proc = None

 # pylint: disable=arguments-differ
 def start(self, app, start_timeout=30, cwd=None):
 """Start the server with subprocess and julia."""

 if os.path.isfile(app) and os.path.exists(app):
 # app is already a file in a dir - use that as cwd
 if not cwd:
 cwd = os.path.dirname(app)
 logger.info("JuliaRunner inferred cwd from app path: %s", cwd)
 else:
 # app is a string chunk, we make a temporary folder to store app.jl
 # and its relevants assets
 self._tmp_app_path = os.path.join(
 "/tmp" if not self.is_windows else os.getenv("TEMP"), uuid.uuid4().hex
 )
 try:
 os.mkdir(self.tmp_app_path)
 except OSError:
 logger.exception("cannot make temporary folder %s", self.tmp_app_path)
 path = os.path.join(self.tmp_app_path, "app.jl")

 logger.info("JuliaRunner start => app is Julia code chunk")
 logger.info("make a temporary Julia file for execution => %s", path)
 logger.debug("content of the Dash.jl app")
 logger.debug("%s", app)

 with open(path, "w") as fp:
 fp.write(app)

 app = path

 # try to find the path to the calling script to use as cwd
 if not cwd:
 for entry in inspect.stack():
 if "/dash/testing/" not in entry[1].replace("\\", "/"):
 cwd = os.path.dirname(os.path.realpath(entry[1]))
 logger.warning("get cwd from inspect => %s", cwd)
 break
 if cwd:
 logger.info("JuliaRunner inferred cwd from the Python call stack: %s", cwd)

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 else:
 logger.warning(
 "JuliaRunner found no cwd in the Python call stack. "
 "You may wish to specify an explicit working directory "
 "using something like: "
 "dashjl.run_server(app, cwd=os.path.dirname(__file__))"
 )

 logger.info("Run Dash.jl app with julia => %s", app)

 args = shlex.split(
 "julia {}".format(os.path.realpath(app)),
 posix=not self.is_windows,
 )
 logger.debug("start Dash.jl process with %s", args)

 try:
 self.proc = subprocess.Popen(
 args,
 stdout=subprocess.PIPE,
 stderr=subprocess.PIPE,
 cwd=self.tmp_app_path if self.tmp_app_path else cwd,
 )
 # wait until server is able to answer http request
 wait.until(lambda: self.accessible(self.url), timeout=start_timeout)

 except (OSError, ValueError):
 logger.exception("process server has encountered an error")
 self.started = False
 return

 self.started = True

14 changes: 14 additions & 0 deletions
dash/testing/composite.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,3 +29,17 @@ def start_server(self, app, cwd=None):

 # set the default server_url, it implicitly call wait_for_page
 self.server_url = self.server.url


class DashJuliaComposite(Browser):
 def __init__(self, server, **kwargs):
 super(DashJuliaComposite, self).__init__(**kwargs)
 self.server = server

 def start_server(self, app, cwd=None):
 # start server with Dash.jl app. The app sets its own run_server args
 # on the Julia side, but we support overriding the automatic cwd
 self.server(app, cwd=cwd)

 # set the default server_url, it implicitly call wait_for_page
 self.server_url = self.server.url

29 changes: 26 additions & 3 deletions
dash/testing/plugin.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,9 @@


try:
 from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner
 from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner, JuliaRunner
 from dash.testing.browser import Browser
 from dash.testing.composite import DashComposite, DashRComposite
 from dash.testing.composite import DashComposite, DashRComposite, DashJuliaComposite
except ImportError:
 pass

Expand DownExpand Up@@ -78,7 +78,7 @@ def pytest_runtest_makereport(item, call): # pylint: disable=unused-argument
 if rep.when == "call" and rep.failed and hasattr(item, "funcargs"):
 for name, fixture in item.funcargs.items():
 try:
 if name in {"dash_duo", "dash_br", "dashr"}:
 if name in {"dash_duo", "dash_br", "dashr", "dashjl"}:
 fixture.take_snapshot(item.name)
 except Exception as e: # pylint: disable=broad-except
 print(e)
Expand DownExpand Up@@ -109,6 +109,12 @@ def dashr_server():
 yield starter


@pytest.fixture
def dashjl_server():
 with JuliaRunner() as starter:
 yield starter


@pytest.fixture
def dash_br(request, tmpdir):
 with Browser(
Expand DownExpand Up@@ -157,3 +163,20 @@ def dashr(request, dashr_server, tmpdir):
 pause=request.config.getoption("pause"),
 ) as dc:
 yield dc


@pytest.fixture
def dashjl(request, dashjl_server, tmpdir):
 with DashJuliaComposite(
 dashjl_server,
 browser=request.config.getoption("webdriver"),
 remote=request.config.getoption("remote"),
 remote_url=request.config.getoption("remote_url"),
 headless=request.config.getoption("headless"),
 options=request.config.hook.pytest_setup_options(),
 download_path=tmpdir.mkdir("download").strpath,
 percy_assets_root=request.config.getoption("percy_assets"),
 percy_finalize=request.config.getoption("nopercyfinalize"),
 pause=request.config.getoption("pause"),
 ) as dc:
 yield dc

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add JuliaRunner to support Dash.jl integration tests#1239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 16 commits into

from

May 19, 2020
 Merged


Add JuliaRunner to support Dash.jl integration tests
#1239
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
afd5e4e

Apply WC insertion fix to .Rd also (#1234)


rpkyle May 7, 2020
6bd6f03

:sparkles: add Julia application runner

May 9, 2020
b166f41

update browser timeout

May 13, 2020
95c06e8

reduce startup timeout

May 13, 2020
e90be19

longer timeout, slow start

May 13, 2020
92cd6fe

Merge branch 'dev' into add-julia-runner


rpkyle May 13, 2020
ecd7ba6

:hammer: remove unnecessary prop_keys_wc

May 13, 2020
fd961e8

:necktie: satisfy linter

May 13, 2020
1bc7181

Merge branch 'add-julia-runner' of github.com:plotly/dash into add-ju…

May 13, 2020
62600db

:hocho: self.tmp_app_path

May 13, 2020
46a0cb8

add debug message

May 13, 2020
c931b65
May 13, 2020
3f520ee
May 13, 2020
76fc7ee

check if tmp_app_path

May 16, 2020
6d29c15

Merge branch 'dev' into add-julia-runner


rpkyle May 18, 2020
4c4d089

relocate assets blocks within if cwd

May 19, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 14 additions & 7 deletions
dash/development/_r_components_generation.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -185,7 +185,6 @@ def generate_class_string(name, props, project_shortname, prefix):
 props = reorder_props(props=props)

 prop_keys = list(props.keys())
 prop_keys_wc = list(props.keys())

 wildcards = ""
 wildcard_declaration = ""
Expand All@@ -194,8 +193,8 @@ def generate_class_string(name, props, project_shortname, prefix):
 default_argtext = ""
 accepted_wildcards = ""

 if any(key.endswith("-*") for key in prop_keys_wc):
 accepted_wildcards = get_wildcards_r(prop_keys_wc)
 if any(key.endswith("-*") for key in prop_keys):
 accepted_wildcards = get_wildcards_r(prop_keys)
 wildcards = ", ..."
 wildcard_declaration = wildcard_template.format(
 accepted_wildcards.replace("-*", "")
Expand All@@ -222,6 +221,9 @@ def generate_class_string(name, props, project_shortname, prefix):

 default_argtext += ", ".join("{}=NULL".format(p) for p in prop_keys)

 if wildcards == ", ...":
 default_argtext += ", ..."

 # pylint: disable=C0301
 default_paramtext += ", ".join(
 "{0}={0}".format(p) if p != "children" else "{}=children".format(p)
Expand DownExpand Up@@ -380,15 +382,20 @@ def write_help_file(name, props, description, prefix, rpkg_data):
 funcname = format_fn_name(prefix, name)
 file_name = funcname + ".Rd"

 wildcards = ""
 default_argtext = ""
 item_text = ""
 accepted_wildcards = ""

 # the return value of all Dash components should be the same,
 # in an abstract sense -- they produce a list
 value_text = "named list of JSON elements corresponding to React.js properties and their values" # noqa:E501

 prop_keys = list(props.keys())
 prop_keys_wc = list(props.keys())

 if any(key.endswith("-*") for key in prop_keys):
 accepted_wildcards = get_wildcards_r(prop_keys)
 wildcards = ", ..."

 # Filter props to remove those we don't want to expose
 for item in prop_keys[:]:
Expand All@@ -413,9 +420,9 @@ def write_help_file(name, props, description, prefix, rpkg_data):
 if "**Example Usage**" in description:
 description = description.split("**Example Usage**")[0].rstrip()

 if any(key.endswith("-*") for key in prop_keys_wc):
 default_argtext += ", ..."
 item_text += wildcard_help_template.format(get_wildcards_r(prop_keys_wc))
 if wildcards == ", ...":
 default_argtext += wildcards
 item_text += wildcard_help_template.format(accepted_wildcards)

 # in R, the online help viewer does not properly wrap lines for
 # the usage string -- we will hard wrap at 60 characters using
Expand Down

136 changes: 119 additions & 17 deletions
dash/testing/application_runners.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -221,6 +221,10 @@ def stop(self):
 try:
 logger.info("proc.terminate with pid %s", self.proc.pid)
 self.proc.terminate()
 if self.tmp_app_path and os.path.exists(self.tmp_app_path):
 logger.debug("removing temporary app path %s",
 self.tmp_app_path)
 shutil.rmtree(self.tmp_app_path)
 if utils.PY3:
 # pylint:disable=no-member
 _except = subprocess.TimeoutExpired
Expand DownExpand Up@@ -285,6 +289,24 @@ def start(self, app, start_timeout=2, cwd=None):
 break
 if cwd:
 logger.info("RRunner inferred cwd from the Python call stack: %s", cwd)

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 else:
 logger.warning(
 "RRunner found no cwd in the Python call stack. "
Expand All@@ -293,23 +315,6 @@ def start(self, app, start_timeout=2, cwd=None):
 "dashr.run_server(app, cwd=os.path.dirname(__file__))"
 )

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 logger.info("Run dashR app with Rscript => %s", app)

 args = shlex.split(
Expand All@@ -334,3 +339,100 @@ def start(self, app, start_timeout=2, cwd=None):
 return

 self.started = True


class JuliaRunner(ProcessRunner):
 def __init__(self, keep_open=False, stop_timeout=3):
 super(JuliaRunner, self).__init__(keep_open=keep_open, stop_timeout=stop_timeout)
 self.proc = None

 # pylint: disable=arguments-differ
 def start(self, app, start_timeout=30, cwd=None):
 """Start the server with subprocess and julia."""

 if os.path.isfile(app) and os.path.exists(app):
 # app is already a file in a dir - use that as cwd
 if not cwd:
 cwd = os.path.dirname(app)
 logger.info("JuliaRunner inferred cwd from app path: %s", cwd)
 else:
 # app is a string chunk, we make a temporary folder to store app.jl
 # and its relevants assets
 self._tmp_app_path = os.path.join(
 "/tmp" if not self.is_windows else os.getenv("TEMP"), uuid.uuid4().hex
 )
 try:
 os.mkdir(self.tmp_app_path)
 except OSError:
 logger.exception("cannot make temporary folder %s", self.tmp_app_path)
 path = os.path.join(self.tmp_app_path, "app.jl")

 logger.info("JuliaRunner start => app is Julia code chunk")
 logger.info("make a temporary Julia file for execution => %s", path)
 logger.debug("content of the Dash.jl app")
 logger.debug("%s", app)

 with open(path, "w") as fp:
 fp.write(app)

 app = path

 # try to find the path to the calling script to use as cwd
 if not cwd:
 for entry in inspect.stack():
 if "/dash/testing/" not in entry[1].replace("\\", "/"):
 cwd = os.path.dirname(os.path.realpath(entry[1]))
 logger.warning("get cwd from inspect => %s", cwd)
 break
 if cwd:
 logger.info("JuliaRunner inferred cwd from the Python call stack: %s", cwd)

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 else:
 logger.warning(
 "JuliaRunner found no cwd in the Python call stack. "
 "You may wish to specify an explicit working directory "
 "using something like: "
 "dashjl.run_server(app, cwd=os.path.dirname(__file__))"
 )

 logger.info("Run Dash.jl app with julia => %s", app)

 args = shlex.split(
 "julia {}".format(os.path.realpath(app)),
 posix=not self.is_windows,
 )
 logger.debug("start Dash.jl process with %s", args)

 try:
 self.proc = subprocess.Popen(
 args,
 stdout=subprocess.PIPE,
 stderr=subprocess.PIPE,
 cwd=self.tmp_app_path if self.tmp_app_path else cwd,
 )
 # wait until server is able to answer http request
 wait.until(lambda: self.accessible(self.url), timeout=start_timeout)

 except (OSError, ValueError):
 logger.exception("process server has encountered an error")
 self.started = False
 return

 self.started = True

14 changes: 14 additions & 0 deletions
dash/testing/composite.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,3 +29,17 @@ def start_server(self, app, cwd=None):

 # set the default server_url, it implicitly call wait_for_page
 self.server_url = self.server.url


class DashJuliaComposite(Browser):
 def __init__(self, server, **kwargs):
 super(DashJuliaComposite, self).__init__(**kwargs)
 self.server = server

 def start_server(self, app, cwd=None):
 # start server with Dash.jl app. The app sets its own run_server args
 # on the Julia side, but we support overriding the automatic cwd
 self.server(app, cwd=cwd)

 # set the default server_url, it implicitly call wait_for_page
 self.server_url = self.server.url

29 changes: 26 additions & 3 deletions
dash/testing/plugin.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,9 @@


try:
 from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner
 from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner, JuliaRunner
 from dash.testing.browser import Browser
 from dash.testing.composite import DashComposite, DashRComposite
 from dash.testing.composite import DashComposite, DashRComposite, DashJuliaComposite
except ImportError:
 pass

Expand DownExpand Up@@ -78,7 +78,7 @@ def pytest_runtest_makereport(item, call): # pylint: disable=unused-argument
 if rep.when == "call" and rep.failed and hasattr(item, "funcargs"):
 for name, fixture in item.funcargs.items():
 try:
 if name in {"dash_duo", "dash_br", "dashr"}:
 if name in {"dash_duo", "dash_br", "dashr", "dashjl"}:
 fixture.take_snapshot(item.name)
 except Exception as e: # pylint: disable=broad-except
 print(e)
Expand DownExpand Up@@ -109,6 +109,12 @@ def dashr_server():
 yield starter


@pytest.fixture
def dashjl_server():
 with JuliaRunner() as starter:
 yield starter


@pytest.fixture
def dash_br(request, tmpdir):
 with Browser(
Expand DownExpand Up@@ -157,3 +163,20 @@ def dashr(request, dashr_server, tmpdir):
 pause=request.config.getoption("pause"),
 ) as dc:
 yield dc


@pytest.fixture
def dashjl(request, dashjl_server, tmpdir):
 with DashJuliaComposite(
 dashjl_server,
 browser=request.config.getoption("webdriver"),
 remote=request.config.getoption("remote"),
 remote_url=request.config.getoption("remote_url"),
 headless=request.config.getoption("headless"),
 options=request.config.hook.pytest_setup_options(),
 download_path=tmpdir.mkdir("download").strpath,
 percy_assets_root=request.config.getoption("percy_assets"),
 percy_finalize=request.config.getoption("nopercyfinalize"),
 pause=request.config.getoption("pause"),
 ) as dc:
 yield dc

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add JuliaRunner to support Dash.jl integration tests#1239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 16 commits into

from

May 19, 2020
 Merged


Add JuliaRunner to support Dash.jl integration tests
#1239
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
afd5e4e

Apply WC insertion fix to .Rd also (#1234)


rpkyle May 7, 2020
6bd6f03

:sparkles: add Julia application runner

May 9, 2020
b166f41

update browser timeout

May 13, 2020
95c06e8

reduce startup timeout

May 13, 2020
e90be19

longer timeout, slow start

May 13, 2020
92cd6fe

Merge branch 'dev' into add-julia-runner


rpkyle May 13, 2020
ecd7ba6

:hammer: remove unnecessary prop_keys_wc

May 13, 2020
fd961e8

:necktie: satisfy linter

May 13, 2020
1bc7181

Merge branch 'add-julia-runner' of github.com:plotly/dash into add-ju…

May 13, 2020
62600db

:hocho: self.tmp_app_path

May 13, 2020
46a0cb8

add debug message

May 13, 2020
c931b65
May 13, 2020
3f520ee
May 13, 2020
76fc7ee

check if tmp_app_path

May 16, 2020
6d29c15

Merge branch 'dev' into add-julia-runner


rpkyle May 18, 2020
4c4d089

relocate assets blocks within if cwd

May 19, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 14 additions & 7 deletions
dash/development/_r_components_generation.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -185,7 +185,6 @@ def generate_class_string(name, props, project_shortname, prefix):
 props = reorder_props(props=props)

 prop_keys = list(props.keys())
 prop_keys_wc = list(props.keys())

 wildcards = ""
 wildcard_declaration = ""
Expand All@@ -194,8 +193,8 @@ def generate_class_string(name, props, project_shortname, prefix):
 default_argtext = ""
 accepted_wildcards = ""

 if any(key.endswith("-*") for key in prop_keys_wc):
 accepted_wildcards = get_wildcards_r(prop_keys_wc)
 if any(key.endswith("-*") for key in prop_keys):
 accepted_wildcards = get_wildcards_r(prop_keys)
 wildcards = ", ..."
 wildcard_declaration = wildcard_template.format(
 accepted_wildcards.replace("-*", "")
Expand All@@ -222,6 +221,9 @@ def generate_class_string(name, props, project_shortname, prefix):

 default_argtext += ", ".join("{}=NULL".format(p) for p in prop_keys)

 if wildcards == ", ...":
 default_argtext += ", ..."

 # pylint: disable=C0301
 default_paramtext += ", ".join(
 "{0}={0}".format(p) if p != "children" else "{}=children".format(p)
Expand DownExpand Up@@ -380,15 +382,20 @@ def write_help_file(name, props, description, prefix, rpkg_data):
 funcname = format_fn_name(prefix, name)
 file_name = funcname + ".Rd"

 wildcards = ""
 default_argtext = ""
 item_text = ""
 accepted_wildcards = ""

 # the return value of all Dash components should be the same,
 # in an abstract sense -- they produce a list
 value_text = "named list of JSON elements corresponding to React.js properties and their values" # noqa:E501

 prop_keys = list(props.keys())
 prop_keys_wc = list(props.keys())

 if any(key.endswith("-*") for key in prop_keys):
 accepted_wildcards = get_wildcards_r(prop_keys)
 wildcards = ", ..."

 # Filter props to remove those we don't want to expose
 for item in prop_keys[:]:
Expand All@@ -413,9 +420,9 @@ def write_help_file(name, props, description, prefix, rpkg_data):
 if "**Example Usage**" in description:
 description = description.split("**Example Usage**")[0].rstrip()

 if any(key.endswith("-*") for key in prop_keys_wc):
 default_argtext += ", ..."
 item_text += wildcard_help_template.format(get_wildcards_r(prop_keys_wc))
 if wildcards == ", ...":
 default_argtext += wildcards
 item_text += wildcard_help_template.format(accepted_wildcards)

 # in R, the online help viewer does not properly wrap lines for
 # the usage string -- we will hard wrap at 60 characters using
Expand Down

136 changes: 119 additions & 17 deletions
dash/testing/application_runners.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -221,6 +221,10 @@ def stop(self):
 try:
 logger.info("proc.terminate with pid %s", self.proc.pid)
 self.proc.terminate()
 if self.tmp_app_path and os.path.exists(self.tmp_app_path):
 logger.debug("removing temporary app path %s",
 self.tmp_app_path)
 shutil.rmtree(self.tmp_app_path)
 if utils.PY3:
 # pylint:disable=no-member
 _except = subprocess.TimeoutExpired
Expand DownExpand Up@@ -285,6 +289,24 @@ def start(self, app, start_timeout=2, cwd=None):
 break
 if cwd:
 logger.info("RRunner inferred cwd from the Python call stack: %s", cwd)

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 else:
 logger.warning(
 "RRunner found no cwd in the Python call stack. "
Expand All@@ -293,23 +315,6 @@ def start(self, app, start_timeout=2, cwd=None):
 "dashr.run_server(app, cwd=os.path.dirname(__file__))"
 )

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 logger.info("Run dashR app with Rscript => %s", app)

 args = shlex.split(
Expand All@@ -334,3 +339,100 @@ def start(self, app, start_timeout=2, cwd=None):
 return

 self.started = True


class JuliaRunner(ProcessRunner):
 def __init__(self, keep_open=False, stop_timeout=3):
 super(JuliaRunner, self).__init__(keep_open=keep_open, stop_timeout=stop_timeout)
 self.proc = None

 # pylint: disable=arguments-differ
 def start(self, app, start_timeout=30, cwd=None):
 """Start the server with subprocess and julia."""

 if os.path.isfile(app) and os.path.exists(app):
 # app is already a file in a dir - use that as cwd
 if not cwd:
 cwd = os.path.dirname(app)
 logger.info("JuliaRunner inferred cwd from app path: %s", cwd)
 else:
 # app is a string chunk, we make a temporary folder to store app.jl
 # and its relevants assets
 self._tmp_app_path = os.path.join(
 "/tmp" if not self.is_windows else os.getenv("TEMP"), uuid.uuid4().hex
 )
 try:
 os.mkdir(self.tmp_app_path)
 except OSError:
 logger.exception("cannot make temporary folder %s", self.tmp_app_path)
 path = os.path.join(self.tmp_app_path, "app.jl")

 logger.info("JuliaRunner start => app is Julia code chunk")
 logger.info("make a temporary Julia file for execution => %s", path)
 logger.debug("content of the Dash.jl app")
 logger.debug("%s", app)

 with open(path, "w") as fp:
 fp.write(app)

 app = path

 # try to find the path to the calling script to use as cwd
 if not cwd:
 for entry in inspect.stack():
 if "/dash/testing/" not in entry[1].replace("\\", "/"):
 cwd = os.path.dirname(os.path.realpath(entry[1]))
 logger.warning("get cwd from inspect => %s", cwd)
 break
 if cwd:
 logger.info("JuliaRunner inferred cwd from the Python call stack: %s", cwd)

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 else:
 logger.warning(
 "JuliaRunner found no cwd in the Python call stack. "
 "You may wish to specify an explicit working directory "
 "using something like: "
 "dashjl.run_server(app, cwd=os.path.dirname(__file__))"
 )

 logger.info("Run Dash.jl app with julia => %s", app)

 args = shlex.split(
 "julia {}".format(os.path.realpath(app)),
 posix=not self.is_windows,
 )
 logger.debug("start Dash.jl process with %s", args)

 try:
 self.proc = subprocess.Popen(
 args,
 stdout=subprocess.PIPE,
 stderr=subprocess.PIPE,
 cwd=self.tmp_app_path if self.tmp_app_path else cwd,
 )
 # wait until server is able to answer http request
 wait.until(lambda: self.accessible(self.url), timeout=start_timeout)

 except (OSError, ValueError):
 logger.exception("process server has encountered an error")
 self.started = False
 return

 self.started = True

14 changes: 14 additions & 0 deletions
dash/testing/composite.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,3 +29,17 @@ def start_server(self, app, cwd=None):

 # set the default server_url, it implicitly call wait_for_page
 self.server_url = self.server.url


class DashJuliaComposite(Browser):
 def __init__(self, server, **kwargs):
 super(DashJuliaComposite, self).__init__(**kwargs)
 self.server = server

 def start_server(self, app, cwd=None):
 # start server with Dash.jl app. The app sets its own run_server args
 # on the Julia side, but we support overriding the automatic cwd
 self.server(app, cwd=cwd)

 # set the default server_url, it implicitly call wait_for_page
 self.server_url = self.server.url

29 changes: 26 additions & 3 deletions
dash/testing/plugin.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,9 @@


try:
 from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner
 from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner, JuliaRunner
 from dash.testing.browser import Browser
 from dash.testing.composite import DashComposite, DashRComposite
 from dash.testing.composite import DashComposite, DashRComposite, DashJuliaComposite
except ImportError:
 pass

Expand DownExpand Up@@ -78,7 +78,7 @@ def pytest_runtest_makereport(item, call): # pylint: disable=unused-argument
 if rep.when == "call" and rep.failed and hasattr(item, "funcargs"):
 for name, fixture in item.funcargs.items():
 try:
 if name in {"dash_duo", "dash_br", "dashr"}:
 if name in {"dash_duo", "dash_br", "dashr", "dashjl"}:
 fixture.take_snapshot(item.name)
 except Exception as e: # pylint: disable=broad-except
 print(e)
Expand DownExpand Up@@ -109,6 +109,12 @@ def dashr_server():
 yield starter


@pytest.fixture
def dashjl_server():
 with JuliaRunner() as starter:
 yield starter


@pytest.fixture
def dash_br(request, tmpdir):
 with Browser(
Expand DownExpand Up@@ -157,3 +163,20 @@ def dashr(request, dashr_server, tmpdir):
 pause=request.config.getoption("pause"),
 ) as dc:
 yield dc


@pytest.fixture
def dashjl(request, dashjl_server, tmpdir):
 with DashJuliaComposite(
 dashjl_server,
 browser=request.config.getoption("webdriver"),
 remote=request.config.getoption("remote"),
 remote_url=request.config.getoption("remote_url"),
 headless=request.config.getoption("headless"),
 options=request.config.hook.pytest_setup_options(),
 download_path=tmpdir.mkdir("download").strpath,
 percy_assets_root=request.config.getoption("percy_assets"),
 percy_finalize=request.config.getoption("nopercyfinalize"),
 pause=request.config.getoption("pause"),
 ) as dc:
 yield dc

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add JuliaRunner to support Dash.jl integration tests#1239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 16 commits into

from

May 19, 2020
 Merged


Add JuliaRunner to support Dash.jl integration tests
#1239
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
afd5e4e

Apply WC insertion fix to .Rd also (#1234)


rpkyle May 7, 2020
6bd6f03

:sparkles: add Julia application runner

May 9, 2020
b166f41

update browser timeout

May 13, 2020
95c06e8

reduce startup timeout

May 13, 2020
e90be19

longer timeout, slow start

May 13, 2020
92cd6fe

Merge branch 'dev' into add-julia-runner


rpkyle May 13, 2020
ecd7ba6

:hammer: remove unnecessary prop_keys_wc

May 13, 2020
fd961e8

:necktie: satisfy linter

May 13, 2020
1bc7181

Merge branch 'add-julia-runner' of github.com:plotly/dash into add-ju…

May 13, 2020
62600db

:hocho: self.tmp_app_path

May 13, 2020
46a0cb8

add debug message

May 13, 2020
c931b65
May 13, 2020
3f520ee
May 13, 2020
76fc7ee

check if tmp_app_path

May 16, 2020
6d29c15

Merge branch 'dev' into add-julia-runner


rpkyle May 18, 2020
4c4d089

relocate assets blocks within if cwd

May 19, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 14 additions & 7 deletions
dash/development/_r_components_generation.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -185,7 +185,6 @@ def generate_class_string(name, props, project_shortname, prefix):
 props = reorder_props(props=props)

 prop_keys = list(props.keys())
 prop_keys_wc = list(props.keys())

 wildcards = ""
 wildcard_declaration = ""
Expand All@@ -194,8 +193,8 @@ def generate_class_string(name, props, project_shortname, prefix):
 default_argtext = ""
 accepted_wildcards = ""

 if any(key.endswith("-*") for key in prop_keys_wc):
 accepted_wildcards = get_wildcards_r(prop_keys_wc)
 if any(key.endswith("-*") for key in prop_keys):
 accepted_wildcards = get_wildcards_r(prop_keys)
 wildcards = ", ..."
 wildcard_declaration = wildcard_template.format(
 accepted_wildcards.replace("-*", "")
Expand All@@ -222,6 +221,9 @@ def generate_class_string(name, props, project_shortname, prefix):

 default_argtext += ", ".join("{}=NULL".format(p) for p in prop_keys)

 if wildcards == ", ...":
 default_argtext += ", ..."

 # pylint: disable=C0301
 default_paramtext += ", ".join(
 "{0}={0}".format(p) if p != "children" else "{}=children".format(p)
Expand DownExpand Up@@ -380,15 +382,20 @@ def write_help_file(name, props, description, prefix, rpkg_data):
 funcname = format_fn_name(prefix, name)
 file_name = funcname + ".Rd"

 wildcards = ""
 default_argtext = ""
 item_text = ""
 accepted_wildcards = ""

 # the return value of all Dash components should be the same,
 # in an abstract sense -- they produce a list
 value_text = "named list of JSON elements corresponding to React.js properties and their values" # noqa:E501

 prop_keys = list(props.keys())
 prop_keys_wc = list(props.keys())

 if any(key.endswith("-*") for key in prop_keys):
 accepted_wildcards = get_wildcards_r(prop_keys)
 wildcards = ", ..."

 # Filter props to remove those we don't want to expose
 for item in prop_keys[:]:
Expand All@@ -413,9 +420,9 @@ def write_help_file(name, props, description, prefix, rpkg_data):
 if "**Example Usage**" in description:
 description = description.split("**Example Usage**")[0].rstrip()

 if any(key.endswith("-*") for key in prop_keys_wc):
 default_argtext += ", ..."
 item_text += wildcard_help_template.format(get_wildcards_r(prop_keys_wc))
 if wildcards == ", ...":
 default_argtext += wildcards
 item_text += wildcard_help_template.format(accepted_wildcards)

 # in R, the online help viewer does not properly wrap lines for
 # the usage string -- we will hard wrap at 60 characters using
Expand Down

136 changes: 119 additions & 17 deletions
dash/testing/application_runners.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -221,6 +221,10 @@ def stop(self):
 try:
 logger.info("proc.terminate with pid %s", self.proc.pid)
 self.proc.terminate()
 if self.tmp_app_path and os.path.exists(self.tmp_app_path):
 logger.debug("removing temporary app path %s",
 self.tmp_app_path)
 shutil.rmtree(self.tmp_app_path)
 if utils.PY3:
 # pylint:disable=no-member
 _except = subprocess.TimeoutExpired
Expand DownExpand Up@@ -285,6 +289,24 @@ def start(self, app, start_timeout=2, cwd=None):
 break
 if cwd:
 logger.info("RRunner inferred cwd from the Python call stack: %s", cwd)

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 else:
 logger.warning(
 "RRunner found no cwd in the Python call stack. "
Expand All@@ -293,23 +315,6 @@ def start(self, app, start_timeout=2, cwd=None):
 "dashr.run_server(app, cwd=os.path.dirname(__file__))"
 )

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 logger.info("Run dashR app with Rscript => %s", app)

 args = shlex.split(
Expand All@@ -334,3 +339,100 @@ def start(self, app, start_timeout=2, cwd=None):
 return

 self.started = True


class JuliaRunner(ProcessRunner):
 def __init__(self, keep_open=False, stop_timeout=3):
 super(JuliaRunner, self).__init__(keep_open=keep_open, stop_timeout=stop_timeout)
 self.proc = None

 # pylint: disable=arguments-differ
 def start(self, app, start_timeout=30, cwd=None):
 """Start the server with subprocess and julia."""

 if os.path.isfile(app) and os.path.exists(app):
 # app is already a file in a dir - use that as cwd
 if not cwd:
 cwd = os.path.dirname(app)
 logger.info("JuliaRunner inferred cwd from app path: %s", cwd)
 else:
 # app is a string chunk, we make a temporary folder to store app.jl
 # and its relevants assets
 self._tmp_app_path = os.path.join(
 "/tmp" if not self.is_windows else os.getenv("TEMP"), uuid.uuid4().hex
 )
 try:
 os.mkdir(self.tmp_app_path)
 except OSError:
 logger.exception("cannot make temporary folder %s", self.tmp_app_path)
 path = os.path.join(self.tmp_app_path, "app.jl")

 logger.info("JuliaRunner start => app is Julia code chunk")
 logger.info("make a temporary Julia file for execution => %s", path)
 logger.debug("content of the Dash.jl app")
 logger.debug("%s", app)

 with open(path, "w") as fp:
 fp.write(app)

 app = path

 # try to find the path to the calling script to use as cwd
 if not cwd:
 for entry in inspect.stack():
 if "/dash/testing/" not in entry[1].replace("\\", "/"):
 cwd = os.path.dirname(os.path.realpath(entry[1]))
 logger.warning("get cwd from inspect => %s", cwd)
 break
 if cwd:
 logger.info("JuliaRunner inferred cwd from the Python call stack: %s", cwd)

 # try copying all valid sub folders (i.e. assets) in cwd to tmp
 # note that the R assets folder name can be any valid folder name
 assets = [
 os.path.join(cwd, _)
 for _ in os.listdir(cwd)
 if not _.startswith("__") and os.path.isdir(os.path.join(cwd, _))
 ]

 for asset in assets:
 target = os.path.join(self.tmp_app_path, os.path.basename(asset))
 if os.path.exists(target):
 logger.debug("delete existing target %s", target)
 shutil.rmtree(target)
 logger.debug("copying %s => %s", asset, self.tmp_app_path)
 shutil.copytree(asset, target)
 logger.debug("copied with %s", os.listdir(target))

 else:
 logger.warning(
 "JuliaRunner found no cwd in the Python call stack. "
 "You may wish to specify an explicit working directory "
 "using something like: "
 "dashjl.run_server(app, cwd=os.path.dirname(__file__))"
 )

 logger.info("Run Dash.jl app with julia => %s", app)

 args = shlex.split(
 "julia {}".format(os.path.realpath(app)),
 posix=not self.is_windows,
 )
 logger.debug("start Dash.jl process with %s", args)

 try:
 self.proc = subprocess.Popen(
 args,
 stdout=subprocess.PIPE,
 stderr=subprocess.PIPE,
 cwd=self.tmp_app_path if self.tmp_app_path else cwd,
 )
 # wait until server is able to answer http request
 wait.until(lambda: self.accessible(self.url), timeout=start_timeout)

 except (OSError, ValueError):
 logger.exception("process server has encountered an error")
 self.started = False
 return

 self.started = True

14 changes: 14 additions & 0 deletions
dash/testing/composite.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,3 +29,17 @@ def start_server(self, app, cwd=None):

 # set the default server_url, it implicitly call wait_for_page
 self.server_url = self.server.url


class DashJuliaComposite(Browser):
 def __init__(self, server, **kwargs):
 super(DashJuliaComposite, self).__init__(**kwargs)
 self.server = server

 def start_server(self, app, cwd=None):
 # start server with Dash.jl app. The app sets its own run_server args
 # on the Julia side, but we support overriding the automatic cwd
 self.server(app, cwd=cwd)

 # set the default server_url, it implicitly call wait_for_page
 self.server_url = self.server.url

29 changes: 26 additions & 3 deletions
dash/testing/plugin.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,9 +4,9 @@


try:
 from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner
 from dash.testing.application_runners import ThreadedRunner, ProcessRunner, RRunner, JuliaRunner
 from dash.testing.browser import Browser
 from dash.testing.composite import DashComposite, DashRComposite
 from dash.testing.composite import DashComposite, DashRComposite, DashJuliaComposite
except ImportError:
 pass

Expand DownExpand Up@@ -78,7 +78,7 @@ def pytest_runtest_makereport(item, call): # pylint: disable=unused-argument
 if rep.when == "call" and rep.failed and hasattr(item, "funcargs"):
 for name, fixture in item.funcargs.items():
 try:
 if name in {"dash_duo", "dash_br", "dashr"}:
 if name in {"dash_duo", "dash_br", "dashr", "dashjl"}:
 fixture.take_snapshot(item.name)
 except Exception as e: # pylint: disable=broad-except
 print(e)
Expand DownExpand Up@@ -109,6 +109,12 @@ def dashr_server():
 yield starter


@pytest.fixture
def dashjl_server():
 with JuliaRunner() as starter:
 yield starter


@pytest.fixture
def dash_br(request, tmpdir):
 with Browser(
Expand DownExpand Up@@ -157,3 +163,20 @@ def dashr(request, dashr_server, tmpdir):
 pause=request.config.getoption("pause"),
 ) as dc:
 yield dc


@pytest.fixture
def dashjl(request, dashjl_server, tmpdir):
 with DashJuliaComposite(
 dashjl_server,
 browser=request.config.getoption("webdriver"),
 remote=request.config.getoption("remote"),
 remote_url=request.config.getoption("remote_url"),
 headless=request.config.getoption("headless"),
 options=request.config.hook.pytest_setup_options(),
 download_path=tmpdir.mkdir("download").strpath,
 percy_assets_root=request.config.getoption("percy_assets"),
 percy_finalize=request.config.getoption("nopercyfinalize"),
 pause=request.config.getoption("pause"),
 ) as dc:
 yield dc