Skip to contentSkip to conversation

Rust Oe-Selftest implementation

PATCH Superseded [email protected] 1 participant 1 message Sep 4, 2022

v10 of 12 Superseded Latest is v12 →

lore
Share & tools
lore
#0 lore raw

PATCH v10 1/1 Rust Oe-Selftest implementation

From: pgowda <[email protected]>

The patch implements Rust testing framework similar to other selftest, specifically the gcc selftest in OE. It uses the client and server based method to test the binaries for cross-target on the image. The test framework is a wrapper around the Rust build system as ./x.py test. It tests many functionalities of Rust distribution like tools, documentation, libraries, packages, tools, Cargo, Crater etc. Please refer the following link for detailed description of Rust testing:-
https://rustc-dev-guide.rust-lang.org/tests/intro.html#tool-tests

To support the rust tests in oe-core, the following functions were added:-
setup_cargo_environment(): Build bootstrap and some early stage tools. do_rust_setup_snapshot(): Install the snapshot version of rust binaries. do_configure(): To generate config.toml
do_compile(): To build "remote-test-server" for qemu target image.

Approximate Number of Tests Run in the Rust Testsuite :- 18000 Approximate Number of Tests that FAIL in bitbake environment :- 100-150 Normally majority of the testcases are present in major folder "test/" It contributes to more than 80% of the testcases present in Rust test framework. These tests pass as expected on any Rust versions without much fuss. The tests that fail are of less important and contribute to less than 2% of the total testcases. These minor tests are observed to work on some versions and fail on others. They have to be added, ignored or excluded for different versions as per the behavior. These tests have been ignored or excluded in the Rust selftest environment to generate success of completing the testsuite.

These tests work in parallel mode even in the skipped test mode as expected. Although the patch to disable tests is large, it is very simple in that it only disables tests. When updating to a newer version of Rust, the patch can usually be ported in a day.

---
 meta/lib/oeqa/selftest/cases/rust.py          |  63 +++
 meta/recipes-devtools/rust/rust-source.inc    |   3 +-
 meta/recipes-devtools/rust/rust.inc           |   3 +-
 .../rust/rust/rust-oe-selftest.patch          | 508 ++++++++++++++++++
 meta/recipes-devtools/rust/rust_1.63.0.bb     |   5 +
 5 files changed, 580 insertions(+), 2 deletions(-)
 create mode 100644 meta/lib/oeqa/selftest/cases/rust.py
 create mode 100644 meta/recipes-devtools/rust/rust/rust-oe-selftest.patch
meta/lib/oeqa/selftest/cases/rust.py new file +63 -0
new file mode 100644
index 0000000000..274bfc144a
@@ -0,0 +1,63 @@
+# SPDX-License-Identifier: MIT
+import os
+import subprocess
+from oeqa.core.decorator import OETestTag
+from oeqa.core.case import OEPTestResultTestCase
+from oeqa.selftest.case import OESelftestTestCase
+from oeqa.utils.commands import runCmd, bitbake, get_bb_var, get_bb_vars, runqemu, Command
+from oeqa.utils.sshcontrol import SSHControl
+
+# Total time taken for testing is of about 2hr 20min, with PARALLEL_MAKE set to 40 number of jobs.
+class RustSelfTestBase(OESelftestTestCase, OEPTestResultTestCase):
+
+	def run_check_emulated(self, *args, **kwargs):
+		# build remote-test-server before image build
+		recipe = "rust"
+		bitbake("{} -c test_compile".format(recipe))
+		builddir = get_bb_var("RUSTSRC", "rust")
+		# build core-image-minimal with required packages
+		default_installed_packages = ["libgcc", "libstdc++", "libatomic", "libgomp"]
+		features = []
+		features.append('IMAGE_FEATURES += "ssh-server-openssh"')
+		features.append('CORE_IMAGE_EXTRA_INSTALL += "{0}"'.format(" ".join(default_installed_packages)))
+		self.write_config("\n".join(features))
+		bitbake("core-image-minimal")
+		# wrap the execution with a qemu instance.
+                # Tests are run with 512 tasks in parallel to execute all tests very quickly
+		with runqemu("core-image-minimal", runqemuparams = "nographic", qemuparams = "-m 512") as qemu:
+			# Copy remote-test-server to image through scp
+			ssh = SSHControl(ip=qemu.ip, logfile=qemu.sshlog, user="root")
+			ssh.copy_to(builddir + "/" + "build/x86_64-unknown-linux-gnu/stage1-tools-bin/remote-test-server","~/")
+			# Execute remote-test-server on image through background ssh
+			command = '~/remote-test-server -v remote'
+			sshrun=subprocess.Popen(("ssh", '-o',  'UserKnownHostsFile=/dev/null', '-o',  'StrictHostKeyChecking=no', '-f', "root@%s" % qemu.ip, command),
+                                shell=False,
+                                stdout=subprocess.PIPE,
+                                stderr=subprocess.PIPE)
+			# Get the values of variables.
+			tcpath = get_bb_var("TARGET_SYS", "rust")
+			targetsys = get_bb_var("RUST_TARGET_SYS", "rust")
+			rustlibpath = get_bb_var("WORKDIR", "rust")
+			tmpdir = get_bb_var("TMPDIR", "rust")
+
+			# Exclude the test folders that error out while building
+                        # TODO: Fix the errors and include them for testing
+                        # no-fail-fast: Run all tests regardless of failure.
+                        # bless: First runs rustfmt to format the codebase,
+                        # then runs tidy checks.
+			testargs = "--exclude src/test/rustdoc --exclude src/test/rustdoc-json  --exclude src/test/run-make-fulldeps --exclude src/tools/tidy --exclude src/tools/rustdoc-themes --exclude src/rustdoc-json-types --exclude src/librustdoc --exclude src/doc/unstable-book --exclude src/doc/rustdoc --exclude src/doc/rustc --exclude compiler/rustc --exclude library/panic_abort --exclude library/panic_unwind --exclude src/test/rustdoc --no-doc --no-fail-fast --bless"
+
+			# Set path for target-poky-linux-gcc, RUST_TARGET_PATH and hosttools.
+			cmd = " export PATH=%s/recipe-sysroot-native/usr/bin:$PATH;" % rustlibpath
+			cmd = cmd + " export TARGET_VENDOR=\"-poky\";"
+			cmd = cmd + " export PATH=%s/recipe-sysroot-native/usr/bin/%s:%s/hosttools:$PATH;" % (rustlibpath, tcpath, tmpdir)
+			cmd = cmd + " export RUST_TARGET_PATH=%s/rust-targets;" % rustlibpath
+			# Trigger testing.
+			cmd = cmd + " export TEST_DEVICE_ADDR=\"%s:12345\";" % qemu.ip
+			cmd = cmd + " cd %s;  python3 src/bootstrap/bootstrap.py test %s --target %s ;" % (builddir, testargs, targetsys)
+			result = runCmd(cmd)
+
+@OETestTag("toolchain-system")
+class RustSelfTestSystemEmulated(RustSelfTestBase):
+	def test_rust(self):
+		self.run_check_emulated("rust")
meta/recipes-devtools/rust/rust-source.inc +2 -1
index ce6c983fc0..7386d7a3ea 100644
@@ -4,7 +4,8 @@ SRC_URI[rust.sha256sum] = "8f44af6dc44cc4146634a4dd5e4cc5470b3052a2337019b870c0e
 SRC_URI:append:class-target:pn-rust = " \
     file://hardcodepaths.patch \
     file://crossbeam_atomic.patch \
-    file://0001-Add-ENOTSUP-constant-for-riscv32-musl.patch"
+    file://0001-Add-ENOTSUP-constant-for-riscv32-musl.patch \
+    file://rust-oe-selftest.patch;striplevel=1"
 SRC_URI:append:class-nativesdk:pn-nativesdk-rust = " file://hardcodepaths.patch"
 
 RUSTSRC = "${WORKDIR}/rustc-${PV}-src"
meta/recipes-devtools/rust/rust.inc +2 -1
index 284347dedc..70f4d01808 100644
@@ -18,7 +18,7 @@ export FORCE_CRATE_HASH="${BB_TASKHASH}"
 RUST_ALTERNATE_EXE_PATH ?= "${STAGING_LIBDIR}/llvm-rust/bin/llvm-config"
 RUST_ALTERNATE_EXE_PATH_NATIVE = "${STAGING_LIBDIR_NATIVE}/llvm-rust/bin/llvm-config"
 
-# We don't want to use bitbakes vendoring because the rust sources do their
+# We don't want to use bitbake's vendoring because the rust sources do their
 # own vendoring.
 CARGO_DISABLE_BITBAKE_VENDORING = "1"
 
@@ -55,6 +55,7 @@ do_rust_setup_snapshot () {
 addtask rust_setup_snapshot after do_unpack before do_configure
 do_rust_setup_snapshot[dirs] += "${WORKDIR}/rust-snapshot"
 do_rust_setup_snapshot[vardepsexclude] += "UNINATIVE_LOADER"
+addtask do_test_compile after do_configure do_rust_gen_targets
 
 python do_configure() {
     import json
meta/recipes-devtools/rust/rust/rust-oe-selftest.patch new file +508 -0

508 lines not on this page · raw message

meta/recipes-devtools/rust/rust_1.63.0.bb +5 -0
index 401d51041e..fa0aae972f 100644
@@ -14,6 +14,11 @@ do_compile () {
     rust_runx build --stage 2
 }
 
+do_test_compile[dirs] = "${B}"
+do_test_compile () {
+    rust_runx build src/tools/remote-test-server --target "${RUST_TARGET_SYS}"
+}
+
 do_compile:append:class-target () {
     rust_runx build --stage 2 src/tools/clippy
     rust_runx build --stage 2 src/tools/rustfmt
Signature · 1 line
2.25.1