Clean up log messages, flaky tests on Windows (#1183)

* clean up logs, linting

* also skip rebuild timing checks on windows

* Align `logFilters` comment with upstream

---------

Co-authored-by: Jeremy Tuloup <[email protected]>

Author: bollwyvl

Diff for: .binder/environment.yml

@@ -81,7 +81,7 @@ dependencies:
   - pytest-check-links
   # test
   - ansi2html
-  - pytest-console-scripts
+  - pytest-console-scripts >=1.4.0
   - pytest-cov
   - pytest-html
   - pytest-xdist

Diff for: .yarnrc.yml

@@ -4,3 +4,18 @@ enableTelemetry: false
 httpTimeout: 60000
 nodeLinker: node-modules
 npmRegistryServer: 'https://registry.yarnpkg.com'
+
+# these messages provide no actionable information, and make non-TTY output
+# almost unreadable, masking real dependency-related information
+# see: https://yarnpkg.com/advanced/error-codes
+logFilters:
+  - code: YN0006 # SOFT_LINK_BUILD
+    level: discard
+  - code: YN0007 # MUST_BUILD
+    level: discard
+  - code: YN0008 # MUST_REBUILD
+    level: discard
+  - code: YN0013 # FETCH_NOT_CACHED
+    level: discard
+  - code: YN0019 # UNUSED_CACHE_ENTRY
+    level: discard

Diff for: docs/environment.yml

@@ -38,7 +38,7 @@ dependencies:
   - pytest-check-links
   # test
   - ansi2html
-  - pytest-console-scripts
+  - pytest-console-scripts >=1.4.0
   - pytest-cov
   - pytest-html
   - pytest-xdist

Diff for: docs/reference/cli.ipynb

@@ -944,4 +944,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}

Diff for: examples/pyodide/plotly.ipynb

@@ -151,4 +151,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}

Diff for: py/jupyterlite-core/jupyterlite_core/tests/test_archive.py

@@ -44,7 +44,7 @@ def test_archive_is_reproducible(an_empty_lite_dir, script_runner, source_date_e
     # build once for initial tarball
     before = an_empty_lite_dir / "v1.tgz"
     initial = script_runner.run(
-        *archive_args, "--output-archive", str(before), "--no-libarchive", **cwd
+        [*archive_args, "--output-archive", str(before), "--no-libarchive"], **cwd
     )
     assert initial.success, "failed to build the first tarball"
 
@@ -53,7 +53,7 @@ def test_archive_is_reproducible(an_empty_lite_dir, script_runner, source_date_e
 
     # build another tarball
     after = an_empty_lite_dir / "v2.tgz"
-    subsequent = script_runner.run(*archive_args, "--output-archive", str(after), **cwd)
+    subsequent = script_runner.run([*archive_args, "--output-archive", str(after)], **cwd)
     assert subsequent.success, "failed to build the second tarball"
 
     # check them
@@ -67,17 +67,13 @@ def test_archive_is_idempotent(an_empty_lite_dir, script_runner, source_date_epo
 
     # build once for initial tarball
     before = an_empty_lite_dir / "v1.tgz"
-    initial = script_runner.run(*archive_args, "--output-archive", str(before), **cwd)
+    initial = script_runner.run([*archive_args, "--output-archive", str(before)], **cwd)
     assert initial.success, "failed to build the first tarball"
 
     # build another tarball
     after = an_empty_lite_dir / "v2.tgz"
     subsequent = script_runner.run(
-        *archive_args,
-        "--app-archive",
-        str(before),
-        "--output-archive",
-        str(after),
+        [*archive_args, "--app-archive", str(before), "--output-archive", str(after)],
         **cwd,
     )
     assert subsequent.success, "failed to build the second tarball"
@@ -118,7 +114,7 @@ def _assert_same_tarball(message, script_runner, before, after):  # pragma: no c
             tdp = Path(td)
             print(tdp)
 
-        diffoscope_result = script_runner.run(diffoscope, str(before), str(after))
+        diffoscope_result = script_runner.run([diffoscope, str(before), str(after)])
 
         if not diffoscope_result.success:
             fails += [diffoscope_result.stdout, diffoscope_result.stderr]

Diff for: py/jupyterlite-core/jupyterlite_core/tests/test_cli.py

@@ -9,6 +9,7 @@
 
 PY_IMPL = platform.python_implementation()
 IS_PYPY = "pypy" in PY_IMPL.lower()
+IS_WIN = platform.system() == "Windows"
 
 
 # TODO: others?
@@ -60,7 +61,7 @@
 @mark.parametrize("lite_args", LITE_INVOCATIONS)
 def test_cli_version(lite_args, script_runner):
     """do various invocations work"""
-    returned_version = script_runner.run(*lite_args, "--version")
+    returned_version = script_runner.run([*lite_args, "--version"])
     assert returned_version.success
     assert __version__ in returned_version.stdout
     assert returned_version.stderr == ""
@@ -70,21 +71,21 @@ def test_cli_version(lite_args, script_runner):
 @mark.parametrize("help", ["-h", "--help"])
 def test_cli_help(lite_args, help, script_runner):  # noqa: A002
     """does help work"""
-    returned_version = script_runner.run(*lite_args, help)
+    returned_version = script_runner.run([*lite_args, help])
     assert returned_version.success
     assert returned_version.stderr == ""
 
 
 @mark.parametrize("lite_args", LITE_INVOCATIONS)
 def test_nonzero_rc(lite_args, script_runner):
-    a_step = script_runner.run(*lite_args, "doit", "this-is-not-a-step")
+    a_step = script_runner.run([*lite_args, "doit", "this-is-not-a-step"])
     assert not a_step.success
 
 
 @mark.parametrize("lite_hook", ["list", "status"])
 def test_cli_status_null(lite_hook, an_empty_lite_dir, script_runner):
     """do the "side-effect-free" commands create exactly one file?"""
-    returned_status = script_runner.run("jupyter", "lite", lite_hook, cwd=str(an_empty_lite_dir))
+    returned_status = script_runner.run(["jupyter", "lite", lite_hook], cwd=str(an_empty_lite_dir))
     assert returned_status.success
     files = set(an_empty_lite_dir.rglob("*"))
     # we would expect to see our build cruft sqlite
@@ -103,7 +104,7 @@ def test_cli_any_hook(  # noqa: PLR0915
     """
     expected_files = TRASH if lite_hook in FAST_HOOKS else A_GOOD_BUILD
     started = time.time()
-    returned_status = script_runner.run("jupyter", "lite", lite_hook, cwd=str(an_empty_lite_dir))
+    returned_status = script_runner.run(["jupyter", "lite", lite_hook], cwd=str(an_empty_lite_dir))
     duration_1 = time.time() - started
     assert returned_status.success
     files = set(an_empty_lite_dir.rglob("*"))
@@ -116,11 +117,14 @@ def test_cli_any_hook(  # noqa: PLR0915
 
     # re-run, be faster
     restarted = time.time()
-    rereturned_status = script_runner.run("jupyter", "lite", lite_hook, cwd=str(an_empty_lite_dir))
+    rereturned_status = script_runner.run(
+        ["jupyter", "lite", lite_hook],
+        cwd=str(an_empty_lite_dir),
+    )
     duration_2 = time.time() - restarted
     assert rereturned_status.success
 
-    if not IS_PYPY:
+    if not (IS_PYPY or IS_WIN):
         # some caching doesn't seep to work reliably
         assert duration_1 > duration_2
 
@@ -148,14 +152,16 @@ def test_cli_any_hook(  # noqa: PLR0915
     app_overrides.write_text(AN_OVERRIDES, encoding="utf-8")
 
     forced_status = script_runner.run(
-        "jupyter",
-        "lite",
-        lite_hook,
-        "--force",
-        "--contents",
-        str(readme),
-        "--contents",
-        str(more),
+        [
+            "jupyter",
+            "lite",
+            lite_hook,
+            "--force",
+            "--contents",
+            str(readme),
+            "--contents",
+            str(more),
+        ],
         cwd=str(an_empty_lite_dir),
     )
 
@@ -194,7 +200,7 @@ def test_cli_any_hook(  # noqa: PLR0915
 def test_cli_raw_doit(an_empty_lite_dir, script_runner):
     """does raw doit work"""
     returned_status = script_runner.run(
-        "jupyter", "lite", "doit", "--", "--help", cwd=str(an_empty_lite_dir)
+        ["jupyter", "lite", "doit", "--", "--help"], cwd=str(an_empty_lite_dir)
     )
     assert returned_status.success
     assert "http://pydoit.org" in returned_status.stdout
@@ -205,13 +211,13 @@ def test_build_repl_no_sourcemaps(an_empty_lite_dir, script_runner):
     out = an_empty_lite_dir / "_output"
 
     args = original_args = "jupyter", "lite", "build"
-    status = script_runner.run(*args, cwd=str(an_empty_lite_dir))
+    status = script_runner.run(args, cwd=str(an_empty_lite_dir))
     norm_files = sorted(out.rglob("*"))
     assert status.success
     assert [f for f in norm_files if f.name.endswith(".map")], "expected maps"
 
     args = [*args, "--apps", "repl", "--apps", "foobarbaz"]
-    status = script_runner.run(*args, cwd=str(an_empty_lite_dir))
+    status = script_runner.run(args, cwd=str(an_empty_lite_dir))
     repl_files = sorted(out.rglob("*"))
     repl_bundles = sorted(out.glob("build/*/bundle.js"))
     assert status.success
@@ -221,7 +227,7 @@ def test_build_repl_no_sourcemaps(an_empty_lite_dir, script_runner):
     assert "'foobarbaz' is not one of" in status.stderr
 
     args = [*args, "--no-unused-shared-packages"]
-    status = script_runner.run(*args, cwd=str(an_empty_lite_dir))
+    status = script_runner.run(args, cwd=str(an_empty_lite_dir))
     no_chunk_files = sorted(out.rglob("*"))
     # assert "pruning unused shared package" in status.stderr
 
@@ -230,15 +236,15 @@ def test_build_repl_no_sourcemaps(an_empty_lite_dir, script_runner):
     assert len(no_chunk_files) < len(repl_files), f"unexpected {unexpected}"
 
     args = [*args, "--no-sourcemaps"]
-    status = script_runner.run(*args, cwd=str(an_empty_lite_dir))
+    status = script_runner.run(args, cwd=str(an_empty_lite_dir))
     min_files = sorted(out.rglob("*"))
     assert status.success
 
     assert not [f for f in min_files if f.name.endswith(".map")], "expected no maps"
 
     assert len(min_files) < len(no_chunk_files), "expected fewer files still"
 
-    status = script_runner.run(*original_args, cwd=str(an_empty_lite_dir))
+    status = script_runner.run(original_args, cwd=str(an_empty_lite_dir))
     rebuild_files = sorted(out.rglob("*"))
     assert status.success
 

Diff for: py/jupyterlite-core/jupyterlite_core/tests/test_contents.py

@@ -36,11 +36,7 @@ def test_contents_with_dot(  # noqa: PLR0913
     postbuild.write_text("#!/usr/bin/env bash\necho ok")
 
     result = script_runner.run(
-        "jupyter",
-        "lite",
-        "build",
-        "--contents",
-        ".",
+        ["jupyter", "lite", "build", "--contents", "."],
         cwd=str(an_empty_lite_dir),
     )
     if expect_success:
@@ -80,11 +76,7 @@ def test_contents_with_space(
     contents_file.touch()
 
     result = script_runner.run(
-        "jupyter",
-        "lite",
-        "build",
-        "--contents",
-        "contents",
+        ["jupyter", "lite", "build", "--contents", "contents"],
         cwd=str(an_empty_lite_dir),
     )
     assert result.success

Diff for: py/jupyterlite-core/jupyterlite_core/tests/test_federated.py

@@ -44,15 +44,15 @@ def test_federated_extensions(  # noqa: PLR0913
 
     extra_args = [] if use_libarchive else ["--no-libarchive"]
 
-    build = script_runner.run("jupyter", "lite", "build", *extra_args, cwd=str(an_empty_lite_dir))
+    build = script_runner.run(["jupyter", "lite", "build", *extra_args], cwd=str(an_empty_lite_dir))
 
     if ext_name.endswith(".conda") and not use_libarchive:
         assert not build.success
         return
 
     assert build.success
 
-    check = script_runner.run("jupyter", "lite", "check", *extra_args, cwd=str(an_empty_lite_dir))
+    check = script_runner.run(["jupyter", "lite", "check", *extra_args], cwd=str(an_empty_lite_dir))
     assert check.success
 
     output = an_empty_lite_dir / "_output"

Diff for: py/jupyterlite-core/jupyterlite_core/tests/test_mathjax.py

@@ -31,10 +31,10 @@ def test_mathjax(
     extra_args = extra_args or []
     kwargs = dict(cwd=str(an_empty_lite_dir))
 
-    status = script_runner.run("jupyter", "lite", "status", *extra_args, **kwargs)
+    status = script_runner.run(["jupyter", "lite", "status", *extra_args], **kwargs)
     assert status.success, "the status did NOT succeed"
 
-    build = script_runner.run("jupyter", "lite", "build", *extra_args, **kwargs)
+    build = script_runner.run(["jupyter", "lite", "build", *extra_args], **kwargs)
     assert build.success, "the build did NOT succeed"
 
     mathjax_path = an_empty_lite_dir / "_output/static/jupyter_server_mathjax/MathJax.js"
@@ -44,5 +44,5 @@ def test_mathjax(
     else:
         assert not mathjax_path.exists(), f"{mathjax_path} was NOT expected"
 
-    check = script_runner.run("jupyter", "lite", "check", *extra_args, **kwargs)
+    check = script_runner.run(["jupyter", "lite", "check", *extra_args], **kwargs)
     assert check.success, "the build did NOT check out"

Diff for: requirements-test.txt

@@ -5,7 +5,7 @@
 ansi2html
 diffoscope; sys_platform == 'linux'
 libarchive-c; sys_platform == 'linux'
-pytest-console-scripts
+pytest-console-scripts >=1.4.0
 pytest-cov
 pytest-html
 pytest-xdist