tests: Update tests to use the home directory set by connect().

Use the home directory set by `MPRemotePath.connect()` in tests to ensure that
the home directory is consistent across different test runs. We cant assume that
"/" is usable on the unix port (as it is read-only for users).

Author: glenn20

tests/conftest.py

@@ -1,27 +1,26 @@
 import argparse
 import logging.config
 import os
-import shutil
-from contextlib import suppress
 from pathlib import Path
 from typing import Generator
 
 import pytest
 import unix_port
 import yaml
-from mpremote.transport_serial import TransportError
 
 from mpremote_path import MPRemotePath as MPath
 
 # Set the default serial port for the micropython board to use the unix port.
 default_port = "unix"
 default_baud_rate = 115200
 
+# Location of the tests and data directories on the local filesystem.
 tests_dir = Path(__file__).parent  # Base directory for the tests.
 data_dir = tests_dir / "_data"  # Local directory containing test data files.
 logging_config = tests_dir / "logging.yaml"  # Logging configuration file.
 
-board_test_dir = "/_tests"  # Directory to create for tests on the micropython board.
+# Directory to create for tests on the micropython board.
+board_test_dir = "_mpremote_path_tests"
 
 logging.config.dictConfig(yaml.safe_load(logging_config.read_text()))
 
@@ -64,6 +63,7 @@ def pytest_addoption(parser: argparse.Namespace) -> None:
     )
 
 
+# TODO: Make this a function on the board.
 def rm_recursive(path: Path) -> None:
     """Remove a directory and all it's contents recursively."""
     if path.is_file():
@@ -99,12 +99,12 @@ def serial_port(
         tests_dir = Path(__file__).parent  # Base directory for the tests.
         unix_dir = tests_dir / "unix-micropython"
         micropython_path = unix_dir / "micropython"
-        command = str(micropython_path) + " -i -m boot"
+        command = str(micropython_path) + ""  # " -i -m boot"
 
         working_dir = tmp_path_factory.mktemp("unix_micropython")
         unix_fs = working_dir / "fs"
         unix_fs.mkdir()  # Create the filesystem directory
-        shutil.copy(unix_dir / "boot.py", unix_fs)  # Copy boot.py to the fs
+        # shutil.copy(unix_dir / "boot.py", unix_fs)  # Copy boot.py to the fs
 
         with unix_port.run_pty_bridge(
             command, cwd=unix_fs, use_socat=use_socat
@@ -130,36 +130,37 @@ def root(
     # entering and exiting the REPL for every command.
     with MPath.board.raw_repl():
         rm_recursive(MPath(board_test_dir))  # Clean up after previous test runs
-        path, pwd = MPath("/"), MPath.cwd()
-        path.chdir()
-        yield path
-        pwd.chdir()
+        cwd = MPath.cwd()
+        try:
+            yield cwd
+        finally:
+            cwd.chdir()
+    MPath.disconnect()  # Disconnect from the board
 
 
 @pytest.fixture()
 def testdir(root: MPath) -> Generator[MPath, None, None]:
     path, pwd = MPath(board_test_dir), MPath.cwd()
-    yield path
-    if pwd:  # Restore the previous working directory and cleanup
+    try:
+        yield path
+    finally:
         pwd.chdir()
 
 
 @pytest.fixture()
 def testfolder(root: MPath) -> Generator[MPath, None, None]:
     "Create a test folder on the board and cd into it."
-    path, pwd = MPath(board_test_dir), MPath.cwd()
-    if path in (pwd, *pwd.parents):
-        MPath("/").chdir()
+    pwd, path = MPath("~").expanduser(), MPath(board_test_dir)
+    pwd.chdir()
     rm_recursive(path)
-    with suppress(TransportError, OSError):
-        path.mkdir()
+    path = path.resolve()
+    path.mkdir()
     path.chdir()
     try:
         yield path
     finally:
         pwd.chdir()
-    with suppress(TransportError, OSError):
-        rm_recursive(path)
+    # rm_recursive(path)
 
 
 @pytest.fixture()

tests/test_base.py

@@ -19,7 +19,7 @@
 
 def test_root_folder(root: MPath) -> None:
     """Test the RemotePath class."""
-    p = MPath("/")
+    p = root
     assert p.exists() is True
     assert len(list(p.stat())) == 10
     assert stat.S_ISDIR(p.stat().st_mode) is True
@@ -31,10 +31,10 @@ def test_root_folder(root: MPath) -> None:
     assert p.is_char_device() is False
     assert p.is_fifo() is False
     assert p.is_socket() is False
-    assert p.cwd().as_posix() == "/"
-    assert p.home().as_posix() == "/"
-    assert MPath("~").expanduser().as_posix() == "/"
-    assert MPath("~/boot.py").expanduser().as_posix() == "/boot.py"
+    assert MPath.cwd().as_posix() == p.as_posix()
+    assert p.home().as_posix() == p.as_posix()
+    assert MPath("~").expanduser().as_posix() == p.as_posix()
+    assert MPath("~/boot.py").expanduser().as_posix() == (p / "boot.py").as_posix()
 
 
 def test_mkdir(testdir: MPath) -> None:
@@ -74,13 +74,14 @@ def test_mkdir_parents(testdir: MPath) -> None:
 def test_cd(testdir: MPath) -> None:
     "Test changing directories"
     p = testdir
+    resolved = p.resolve()
     assert p.exists() is False
     p.mkdir()
     assert p.exists() is True
     p.chdir()
-    assert p.cwd().as_posix() == testdir.as_posix()
-    MPath("/").chdir()
-    assert p.cwd().as_posix() == "/"
+    assert p.cwd().as_posix() == resolved.as_posix()
+    MPath("~").expanduser().chdir()
+    assert MPath.cwd().as_posix() == p.parent.resolve().as_posix()
     p.rmdir()
     assert p.exists() is False
 
@@ -142,11 +143,16 @@ def test_read_write_text(testfolder: MPath) -> None:
 
 def test_resolve_samefile(root: MPath) -> None:
     "Test resolving paths: absolute(), and resolve()"
-    q = MPath("./lib/mpy")
-    q = q / "../.././main.py"
+    q = MPath("./lib/mpy") / "../.././main.py"
     assert q.as_posix() == "lib/mpy/../../main.py"
-    assert q.absolute().as_posix() == "/lib/mpy/../../main.py"
-    assert q.absolute().resolve().as_posix() == "/main.py"
+    assert (
+        q.absolute().as_posix()
+        == MPath("~").expanduser().as_posix().rstrip("/") + "/lib/mpy/../../main.py"
+    )
+    assert (
+        q.absolute().resolve().as_posix()
+        == MPath("~").expanduser().as_posix().rstrip("/") + "/main.py"
+    )
     assert q.samefile(q.absolute()) is True
     assert q.samefile(q.absolute().resolve()) is True
 
@@ -161,7 +167,7 @@ def test_copy_copyfile(testfolder: MPath) -> None:
     q = p.copyfile("test2.touch")
     assert q.read_text() == msg
     q.unlink()
-    d1 = testfolder / "dir1"
+    d1 = MPath("dir1")
     d1.mkdir()
     q = p.copy(d1)
     assert str(q) == str(d1 / "test1.touch")

tests/unix_port.py

@@ -122,7 +122,7 @@ def pty_bridge_python(
         # Run micropython and forward data to/from `serial_port_name`.
         run_pty_bridge_process(command, bridge_pty)
         log.debug("Bridge process: Exiting.")
-        sys.exit()  # Exit the subprocesses.
+        os._exit(0)  # Exit the subprocesses.
 
     # Parent process - the main process
     try: