-
Notifications
You must be signed in to change notification settings - Fork 25
Do not use sudo FQDN lookups #199
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
base: main
Are you sure you want to change the base?
Changes from all commits
52829d7
ba629bb
8ec93a6
d8a43b6
deddc35
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| """qemu-based tests that are copied into the guest and run there""" | ||
|
|
||
| # Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries. | ||
| # SPDX-License-Identifier: BSD-3-Clause | ||
|
|
||
| # These tests are run inside the qemu guest as root using its own pytest runner | ||
| # invocation. | ||
|
|
||
| import subprocess | ||
| import tempfile | ||
|
|
||
| import pytest | ||
|
|
||
| # Mark this module so that the main test runner can skip it when running from | ||
| # the host. However, the guest test runner does not use this mark but instead | ||
| # explicitly calls this file. Marks require test collection, and the guest test | ||
| # runner isn't going to have dependencies installed that are only needed for | ||
| # host tests, causing guest test collection to fail otherwise. | ||
| pytestmark = pytest.mark.guest | ||
|
|
||
|
|
||
| def test_empty(): | ||
| # The empty test. This is nevertheless useful as its presence ensures that | ||
| # the host is calling the guest test suite in this module correctly. | ||
| pass | ||
|
|
||
|
|
||
| # To keep tests fast for developer iteration, just install all the test | ||
| # dependencies together once for all tests defined here. It is likely that our | ||
| # tests here are not going to interact. If they do, then we can decide whether | ||
| # to compromise on this at that time. | ||
| @pytest.fixture(scope="module") | ||
| def apt_dependencies(): | ||
| # To speed things up, we deliberately skip the apt-get update here on the | ||
| # assumption that it was arranged by whatever is running the test. This is | ||
| # arranged from qemu_test.py::test_using_guest_tests() instead. | ||
| subprocess.run( | ||
| ["apt-get", "install", "-y", "--no-install-recommends", "sudo", "gdb"], | ||
| check=True, | ||
| ) | ||
|
|
||
|
|
||
| def test_sudo_no_fqdn(apt_dependencies): | ||
| """sudo should not call FQDN lookup functions | ||
|
|
||
| See: https://github.com/qualcomm-linux/qcom-deb-images/issues/193 | ||
| """ | ||
| with tempfile.NamedTemporaryFile( | ||
| mode="w", delete_on_close=False | ||
| ) as gdb_commands_file: | ||
| print( | ||
| "catch load", | ||
| "run", | ||
| "del 1", | ||
| sep="\n", | ||
| file=gdb_commands_file, | ||
| ) | ||
| for fn_name in [ | ||
| "gethostbyaddr", | ||
| "getnameinfo", | ||
| "getaddrinfo", | ||
| "gethostbyname", | ||
| ]: | ||
| print( | ||
| f"break {fn_name}", | ||
| f"commands", | ||
| f' print "{fn_name} called\\n"', | ||
| f" quit 1", | ||
| f"end", | ||
| sep="\n", | ||
| file=gdb_commands_file, | ||
| ) | ||
| print("continue", file=gdb_commands_file) | ||
| gdb_commands_file.close() | ||
|
|
||
| subprocess.run( | ||
| [ | ||
| "gdb", | ||
| "--batch", | ||
| "-x", | ||
| gdb_commands_file.name, | ||
| "--args", | ||
| "sudo", | ||
| "true", | ||
| ], | ||
| check=True, | ||
| ) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,15 +8,28 @@ | |
| import subprocess | ||
| import sys | ||
| import tempfile | ||
| import types | ||
|
|
||
| import pexpect | ||
| import pytest | ||
|
|
||
| # Since the first test checks for the mandatory password reset functionality | ||
| # that also prepares the VM for shell-based access, we make the additional | ||
| # optimisation that the fixture for a logged in VM re-uses that VM, so the | ||
| # ordering of [plain VM fixture, password reset test, logged-in VM fixture] | ||
| # matters here. | ||
|
|
||
| @pytest.fixture | ||
|
|
||
| @pytest.fixture(scope="module") | ||
| def vm(): | ||
| """A pexpect.spawn object attached to the serial console of a VM freshly | ||
| booting with a CoW base of disk-ufs.img""" | ||
| # Since qemu booting is slow and we want fast developer iteration, we make the | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. should that comment be a couple of lines higher, near the scope definition for the fixture? |
||
| # optimisation compromise that we will not reset the qemu test fixture from a | ||
| # fresh image for every test. Most tests should not collide with each other. If | ||
| # we think a new test will do that and we want to make the compromise of giving | ||
| # it an isolated environment for a slower test suite, we can deal with that | ||
| # then. | ||
| with tempfile.TemporaryDirectory() as tmpdir: | ||
| qcow_path = os.path.join(tmpdir, "disk1.qcow") | ||
| subprocess.run( | ||
|
|
@@ -33,7 +46,7 @@ def vm(): | |
| ], | ||
| check=True, | ||
| ) | ||
| child = pexpect.spawn( | ||
| spawn = pexpect.spawn( | ||
| "qemu-system-aarch64", | ||
| [ | ||
| "-cpu", | ||
|
|
@@ -51,34 +64,77 @@ def vm(): | |
| "-nographic", | ||
| "-bios", | ||
| "/usr/share/AAVMF/AAVMF_CODE.fd", | ||
| "-fsdev", | ||
| f"local,id=fsdev0,path={os.getcwd()},security_model=none", | ||
| "-device", | ||
| "virtio-9p-pci,fsdev=fsdev0,mount_tag=qcom-deb-images", | ||
| ], | ||
| ) | ||
| child.logfile = sys.stdout.buffer | ||
| yield child | ||
| spawn.logfile = sys.stdout.buffer | ||
| yield types.SimpleNamespace(spawn=spawn, logged_in=False) | ||
|
|
||
| # No need to be nice; that would take time | ||
| child.kill(signal.SIGKILL) | ||
| spawn.kill(signal.SIGKILL) | ||
|
|
||
| # If this blocks then we have a problem. Better to hang than build up | ||
| # excess qemu processes that won't die. | ||
| child.wait() | ||
| spawn.wait() | ||
|
|
||
|
|
||
| def test_password_reset_required(vm): | ||
| """On first login, there should be a mandatory reset password flow""" | ||
| # https://github.com/qualcomm-linux/qcom-deb-images/issues/69 | ||
|
|
||
| # This takes a minute or two on a ThinkPad T14s Gen 6 Snapdragon | ||
| vm.expect_exact("debian login:", timeout=240) | ||
|
|
||
| vm.send("debian\r\n") | ||
| vm.expect_exact("Password:") | ||
| vm.send("debian\r\n") | ||
| vm.expect_exact("You are required to change your password immediately") | ||
| vm.expect_exact("Current password:") | ||
| vm.send("debian\r\n") | ||
| vm.expect_exact("New password:") | ||
| vm.send("new password\r\n") | ||
| vm.expect_exact("Retype new password:") | ||
| vm.send("new password\r\n") | ||
| vm.expect_exact("debian@debian:~$") | ||
| vm.spawn.expect_exact("debian login:", timeout=240) | ||
|
|
||
| vm.spawn.send("debian\r\n") | ||
| vm.spawn.expect_exact("Password:") | ||
| vm.spawn.send("debian\r\n") | ||
| vm.spawn.expect_exact("You are required to change your password immediately") | ||
| vm.spawn.expect_exact("Current password:") | ||
| vm.spawn.send("debian\r\n") | ||
| vm.spawn.expect_exact("New password:") | ||
| vm.spawn.send("new password\r\n") | ||
| vm.spawn.expect_exact("Retype new password:") | ||
| vm.spawn.send("new password\r\n") | ||
| vm.spawn.expect_exact("debian@debian:~$") | ||
|
|
||
| vm.logged_in = True | ||
|
|
||
|
|
||
| @pytest.fixture(scope="module") | ||
| def logged_in_vm(vm): | ||
| if not vm.logged_in: | ||
| pytest.skip("Password reset test did not run or failed") | ||
| return vm | ||
|
|
||
|
|
||
| def test_using_guest_tests(logged_in_vm): | ||
| """Run the tests in qemu_guest_test.py inside the qemu guest""" | ||
| # Statement of test success and failure that are unlikely to appear by | ||
| # accident | ||
| SUCCESS_NOTICE = "All ci/qemu_guest_test.py tests passed" | ||
| FAILURE_NOTICE = "Some ci/qemu_guest_test.py tests failed" | ||
| # We use apt-get -U here and the apt_dependencies fixture in | ||
| # qemu_guest_test.py relies on this. | ||
| SCRIPT = f"""sudo -i sh <<EOT | ||
| apt-get install -Uy --no-install-recommends python3-pytest | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's quite unfortunate to introduce a network dependency :-( I also don't like that we're changing the rootfs, but I guess we need to bring the tests somehow. Should we just add this test runner to the image? |
||
| mkdir qcom-deb-images | ||
| mount -t 9p qcom-deb-images qcom-deb-images | ||
| cd qcom-deb-images | ||
| py.test-3 -vvm guest ci/qemu_guest_test.py && echo "{SUCCESS_NOTICE}" || echo "{FAILURE_NOTICE}" | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hmm tests running as root; I guess we can revisit this when we need a non-root test |
||
| EOT | ||
| """ | ||
| logged_in_vm.spawn.send(SCRIPT.replace("\r", "\r\n")) | ||
|
|
||
| # Match a known string for when pytest starts. Otherwise we catch the echo | ||
| # of our own printing of SUCCESS_NOTICE and FAILURE_NOTICE that appears | ||
| # before, causing us to falsely believe that it was done. The timeout is | ||
| # required to give enough time for the installation of python3-pytest to | ||
| # finish. | ||
| logged_in_vm.spawn.expect_exact("test session starts", timeout=120) | ||
| match = logged_in_vm.spawn.expect_exact( | ||
| [SUCCESS_NOTICE, FAILURE_NOTICE], timeout=120 | ||
| ) | ||
| assert match == 0, "ci/qemu_guest_test.py tests failed" | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| [tool.pytest.ini_options] | ||
| # See ci/qemu_test.py and ci/qemu_test_guest.py for details on arrangements for | ||
| # guest tests. | ||
| addopts = "-m 'not guest'" | ||
| markers = [ | ||
| "guest: Tests that run from inside a built image" | ||
| ] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm a little bit surprized that this works; isn't sudo SUID and losing its SUID bit when run under GDB? I guess all tests run as root and this is sudo without SUID launched from the tests launched from a sudo shell.