[windows] Increase test coverage

Author: amotl

postroj/winrunner.py

@@ -219,9 +219,9 @@ def docker_context_online(self):
         return port_is_up(address.hostname, address.port)
 
 
-def hcmd(command, cwd=None, silent=False):
+def hcmd(command, cwd=None,  use_stderr=True, silent=False):
     logger.debug(f"Running command: {command}")
-    return cmd(command, cwd=cwd, use_stderr=True)
+    return cmd(command, cwd=cwd, use_stderr=use_stderr)
 
 
 def hshell(command, cwd=None):
@@ -230,9 +230,10 @@ def hshell(command, cwd=None):
     return subprocess.check_output(command, shell=True, cwd=cwd).decode()
 
 
-def ccmd(command, use_pty=False):
+def ccmd(command, use_pty=False, capture=False):
     logger.debug(f"Running command: {command}")
-    p = cmd(command=command, use_pty=use_pty)
+    p = cmd(command=command, use_pty=use_pty, capture=capture)
     stdout = p.stdout
-    fix_tty()
+    if use_pty:
+        fix_tty()
     return stdout

testing/postroj/test_winrunner.py

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+# (c) 2022 Andreas Motl <[email protected]>
+import pytest
+
+from postroj.winrunner import ccmd, hshell, hcmd
+
+
+def test_hcmd_echo_newline(capfd):
+    process = hcmd("/bin/echo foo", use_stderr=False)
+    assert process.stdout is None
+    assert process.stderr is None
+
+    result = capfd.readouterr()
+    assert result.out == "foo\n"
+    assert result.err == ""
+
+
+def test_hcmd_echo_no_newline(capfd):
+    hcmd("/bin/echo -n foo", use_stderr=False)
+    result = capfd.readouterr()
+    assert result.out == "foo"
+
+
+def test_hshell_echo_newline():
+    output = hshell("/bin/echo foo")
+    assert output == "foo\n"
+
+
+def test_hshell_echo_no_newline():
+    output = hshell("/bin/echo -n foo")
+    assert output == "foo"
+
+
+def test_ccmd_echo_newline():
+    output = ccmd("/bin/echo foo", capture=True)
+    assert output == "foo\n"
+
+
+def test_ccmd_echo_newline_pty(capfd):
+    output = ccmd("/bin/echo foo", capture=True, use_pty=True)
+    assert output is None
+
+    result = capfd.readouterr()
+    assert result.out == "foo\n"
+    assert result.err == ""
+
+
+@pytest.mark.xfail
+def test_ccmd_echo_no_newline():
+    output = ccmd("/bin/echo -n foo", capture=True)
+    assert output == "foo"
+
+
+def test_ccmd_echo_no_newline_pty(capfd):
+    output = ccmd("/bin/echo -n foo", capture=True, use_pty=True)
+    assert output is None
+
+    result = capfd.readouterr()
+    assert result.out == "foo"
+    assert result.err == ""

testing/racker/test_run.py

@@ -1,9 +1,11 @@
 # -*- coding: utf-8 -*-
 # (c) 2022 Andreas Motl <[email protected]>
+import re
 import shlex
 import subprocess
 import sys
 from pathlib import Path
+from unittest import mock
 
 import pytest
 from click._compat import strip_ansi
@@ -12,6 +14,9 @@
 from racker.cli import cli
 
 
+# Currently, this test module effectively runs well on Linux,
+# because it invokes machinery based on `systemd-nspawn`.
+
 if sys.platform != "linux":
     pytest.skip("Skipping Linux-only tests", allow_module_level=True)
 
@@ -104,6 +109,73 @@ def test_run_stdin_stdout(monkeypatch, capsys, delay):
     assert process.stdout == b"foo"
 
 
+@pytest.mark.xfail(reason="Not working within Linux VM on macOS. Reason: "
+                          "Cannot enable nested VT-x/AMD-V without nested-paging and unrestricted guest execution!")
+def test_run_windows_valid_image(capfd, delay):
+    """
+    Request a valid Windows container image.
+
+    Note: This is currently not possible, because somehow VT-x does not work
+          well enough to support this scenario, at least not on macOS Catalina.
+    """
+    runner = CliRunner()
+
+    result = runner.invoke(cli, "run --rm --platform=windows/amd64 mcr.microsoft.com/windows/nanoserver:ltsc2022 -- cmd /C ver", catch_exceptions=False)
+    assert result.exit_code == 0
+
+    captured = capfd.readouterr()
+    assert "Microsoft Windows [Version 10.0.20348.707]" in captured.out
+
+
+def test_run_windows_invalid_image(caplog, delay):
+    """
+    Request an invalid Windows container image and make sure it croaks correctly.
+    """
+    runner = CliRunner()
+
+    result = runner.invoke(cli, "run --rm --platform=windows/amd64 images.example.org/foo/bar:special -- cmd /C ver", catch_exceptions=False)
+    assert result.exit_code == 1
+
+    assert re.match(".*Inquiring information about OCI image .+ failed.*", caplog.text)
+    assert re.match(".*Reason:.*Error parsing image name .* (error )?pinging (container|docker) registry images.example.org.*", caplog.text)
+
+
+def test_run_windows_mocked_noninteractive():
+    """
+    Pretend to launch a Windows container, but don't.
+    Reason: The `WinRunner` machinery has been mocked completely.
+    """
+    runner = CliRunner()
+
+    with mock.patch("racker.cli.WinRunner") as winrunner:
+        result = runner.invoke(cli, "run --rm --platform=windows/amd64 images.example.org/foo/bar:special -- cmd /C ver", catch_exceptions=False)
+    assert result.exit_code == 0
+    assert winrunner.mock_calls == [
+        mock.call(image='images.example.org/foo/bar:special'),
+        mock.call().setup(),
+        mock.call().start(),
+        mock.call().run('cmd /C ver', interactive=False, tty=False),
+    ]
+
+
+def test_run_windows_mocked_interactive():
+    """
+    Pretend to launch a Windows container, but don't.
+    Reason: The `WinRunner` machinery has been mocked completely.
+    """
+    runner = CliRunner()
+
+    with mock.patch("racker.cli.WinRunner") as winrunner:
+        result = runner.invoke(cli, "run -it --rm --platform=windows/amd64 images.example.org/foo/bar:special -- cmd /C ver", catch_exceptions=False)
+    assert result.exit_code == 0
+    assert winrunner.mock_calls == [
+        mock.call(image='images.example.org/foo/bar:special'),
+        mock.call().setup(),
+        mock.call().start(),
+        mock.call().run('cmd /C ver', interactive=True, tty=True),
+    ]
+
+
 # Unfortunately, this fails.
 """
 def test_run_stdin_stdout_original(capfd):

testing/racker/test_run_windows.py

@@ -11,8 +11,13 @@
 import pytest
 
 
+# Currently, this test module effectively runs well on macOS.
+# The following snippet skips invocation on both VirtualBox
+# and GitHub Actions.
+
 if "rackerhost-debian11" in socket.gethostname():
-    pytest.skip("Nested virtualization with VT-x fails on developer's macOS workstation", allow_module_level=True)
+    pytest.skip("Nested virtualization with VT-x fails within "
+                "VirtualBox environment on developer's macOS workstation", allow_module_level=True)
 
 if "GITHUB_ACTIONS" in os.environ:
     pytest.skip("Installing the Vagrant filesystem image for Windows "