Skip to content
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.

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

CI(debug): Print full stdout/stderr when command fails #1660

Merged
merged 2 commits into from
Aug 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 13 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -149,14 +149,21 @@ clean-js: FORCE
SUB_FILE:=
PYTEST_BROWSERS:= --browser webkit --browser firefox --browser chromium
PYTEST_DEPLOYS_BROWSERS:= --browser chromium

# Full test path to playwright tests
TEST_FILE:=tests/playwright/$(SUB_FILE)
# Default `make` values that shouldn't be directly used; (Use `TEST_FILE` instead!)
DEPLOYS_TEST_FILE:=tests/playwright/deploys$(SUB_FILE)
SHINY_TEST_FILE:=tests/playwright/shiny/$(SUB_FILE)
EXAMPLES_TEST_FILE:=tests/playwright/examples/$(SUB_FILE)

install-playwright: FORCE
playwright install --with-deps

install-rsconnect: FORCE
pip install git+https://github.com/rstudio/rsconnect-python.git#egg=rsconnect-python

# Full test path to playwright tests
TEST_FILE:="tests/playwright/$(SUB_FILE)"

# All end-to-end tests with playwright
playwright: install-playwright ## All end-to-end tests with playwright; (TEST_FILE="" from root of repo)
pytest $(TEST_FILE) $(PYTEST_BROWSERS)
Expand All @@ -169,20 +176,18 @@ playwright-show-trace: ## Show trace of failed tests

# end-to-end tests with playwright; (SUB_FILE="" within tests/playwright/shiny/)
playwright-shiny: FORCE
$(MAKE) playwright TEST_FILE="tests/playwright/shiny/$(SUB_FILE)"
$(MAKE) playwright TEST_FILE="$(SHINY_TEST_FILE)"

# end-to-end tests on deployed apps with playwright; (SUB_FILE="" within tests/playwright/deploys/)
playwright-deploys: FORCE
$(MAKE) playwright PYTEST_BROWSERS="$(PYTEST_DEPLOYS_BROWSERS)" TEST_FILE="$(TEST_FILE)"
playwright-deploys-legacy: FORCE
$(MAKE) playwright TEST_FILE="tests/playwright/deploys/$(SUB_FILE)" PYTEST_BROWSERS="$(PYTEST_DEPLOYS_BROWSERS)"
$(MAKE) playwright PYTEST_BROWSERS="$(PYTEST_DEPLOYS_BROWSERS)" TEST_FILE="$(DEPLOYS_TEST_FILE)"

# end-to-end tests on all py-shiny examples with playwright; (SUB_FILE="" within tests/playwright/examples/)
playwright-examples: FORCE
$(MAKE) playwright TEST_FILE="tests/playwright/examples/$(SUB_FILE)"
$(MAKE) playwright TEST_FILE="$(EXAMPLES_TEST_FILE)"

coverage: FORCE ## check combined code coverage (must run e2e last)
pytest --cov-report term-missing --cov=shiny tests/pytest/ tests/playwright/shiny/$(SUB_FILE) $(PYTEST_BROWSERS)
pytest --cov-report term-missing --cov=shiny tests/pytest/ $(SHINY_TEST_FILE) $(PYTEST_BROWSERS)
coverage html
$(BROWSER) htmlcov/index.html

Expand Down
22 changes: 21 additions & 1 deletion tests/playwright/utils/deploy_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import json
import os
import re
import shutil
import subprocess
import sys
Expand Down Expand Up @@ -70,14 +71,33 @@ def skip_on_webkit(fn: CallableT) -> CallableT:
def run_command(cmd: str) -> str:
output = subprocess.run(
cmd,
check=True,
check=False,
capture_output=True,
text=True,
shell=True,
)
if output.returncode != 0:
print(
"Failed to run command!",
"\nstdout:",
output.stdout,
"\nstderr:",
output.stderr,
file=sys.stderr,
sep="\n",
)
raise RuntimeError(f"Failed to run command: {redact_api_key(cmd)}")
return output.stdout


def redact_api_key(cmd: str) -> str:
# Redact the value of the `--api-key` CLI argument, replace it with `***`
# Create a regex that replaces the argument following `--api-key`
# with `***` (e.g. `--api-key my-api-key` -> `--api-key ***`)

return re.sub(r"(--api-key\s+)(\S+)", r"\1***", cmd)


def deploy_to_connect(app_name: str, app_dir: str) -> str:
if not api_key:
raise RuntimeError("No api key found. Cannot deploy.")
Expand Down
Loading