Skip to contentSkip to conversation

Create class for building rust unit test

PATCH Superseded [email protected] 2 participants 11 messages Apr 22, 2023 – Apr 24, 2023 1 message not in the archive

v1 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

cover Create class for building rust unit test

From: Frederic Martinsons <[email protected]>

This brings the possibility to use this class to build and ship unit tests of rust projects, the class also create (or modified) standard run-ptest script to run the generated rust test suite.

It has been tested successfully with core-image-sato under qemu for zvariant-ptest and python3-bcrypt-ptest (though the last one didn't define any unit tests).

Note that I tried to do the same with python3-cryptography but fail to build the test suite and I don't know how to do it with the rust extension module build by python setuptools. There must be some kind of way for doing that so maybe someone will put some work in it ( because python3-cryptography rust extension do have unit tests).

Moreover, in the class, I didn't manage to share data between do_compile_ptest_base and do_install_ptest_base cleanly (I tried to d.setVar in compile and d.getVar in install but it seems that the data store doens't recognize my new variable) so I used a file for that. I'm sure there is a clever way for doing that, so feel free to tell me.

The following changes since commit 45a8bb6e4676899d40525e7d5ad1c1ddefee3185:

apt-util: Fix ptest on musl (2023-04-20 11:56:03 +0100)

are available in the Git repository at:

https://gitlab.com/fmartinsons/openembedded-core cargo-add-ptest

Frederic Martinsons (3):
ptest-cargo.bbclass: create class
python3-bcrypt: enable build of unit tests
zvariant: add ptest feature for zvariant test suite

 .../zvariant/zvariant_3.12.0.bb               |  11 +-
 meta/classes-recipe/ptest-cargo.bbclass       | 108 ++++++++++++++++++
 .../python/python3-bcrypt_4.0.1.bb            |   4 +-
 3 files changed, 121 insertions(+), 2 deletions(-)
 create mode 100644 meta/classes-recipe/ptest-cargo.bbclass
Signature · 1 line
2.34.1
#1 lore raw

PATCH 1/3 ptest-cargo.bbclass: create class

From: Frederic Martinsons <[email protected]>

This new class offer the capbility to build rust tests and find them correctly.
Due to non deterministic name of generated binaries, a custom parsing of build result must be performed.
See https://github.com/rust-lang/cargo/issues/1924

All rust project will generate a test binary even if there are not test defined in source code (the binary will just output that it ran 0 tests)

---
 meta/classes-recipe/ptest-cargo.bbclass | 108 ++++++++++++++++++++++++
 1 file changed, 108 insertions(+)
 create mode 100644 meta/classes-recipe/ptest-cargo.bbclass
meta/classes-recipe/ptest-cargo.bbclass new file +108 -0
new file mode 100644
index 0000000000..a76b06b46a
@@ -0,0 +1,108 @@
+inherit cargo ptest
+
+CARGO_TEST_BINARIES_FILES ?= "${B}/test_binaries_list"
+
+# sadly generated test binary have no deterministic names (https://github.com/rust-lang/cargo/issues/1924)
+# which force us to parse the cargo output in json format to find those test binaries
+python do_compile_ptest_base() {
+    import subprocess
+    import json
+
+    cargo = bb.utils.which(d.getVar("PATH"), d.getVar("CARGO", True))
+    cargo_build_flags = d.getVar("CARGO_BUILD_FLAGS", True)
+    rust_flags = d.getVar("RUSTFLAGS", True)
+    manifest_path = d.getVar("MANIFEST_PATH", True)
+
+    env = os.environ.copy()
+    env['RUSTFLAGS'] = rust_flags
+    cmd = f"{cargo} build --tests --message-format json {cargo_build_flags}"
+    bb.note(f"Building tests with cargo ({cmd})")
+
+    try:
+        proc = subprocess.Popen(cmd, shell=True, env=env, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
+    except subprocess.CalledProcessError as e:
+        bb.fatal(f"Cannot build test with cargo: {e}")
+
+    lines = []
+    for line in proc.stdout:
+        data = line.decode('utf-8').strip('\n')
+        lines.append(data)
+        bb.note(data)
+    proc.communicate()
+    if proc.returncode != 0:
+        bb.fatal(f"Unable to compile test with cargo, '{cmd}' failed")
+
+    # Definition of the format: https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages
+    test_bins = []
+    for line in lines:
+        try:
+            data = json.loads(line)
+        except json.JSONDecodeError:
+            # skip lines that are not a json
+            pass
+        else:
+            try:
+                # Filter the test packages coming from the current manifest
+                current_manifest_path = os.path.normpath(data['manifest_path'])
+                project_manifest_path = os.path.normpath(manifest_path)
+                if current_manifest_path == project_manifest_path:
+                    if data['target']['test'] or data['target']['doctest'] and data['executable']:
+                        test_bins.append(data['executable'])
+            except KeyError as e:
+                # skip lines that do not meet the requirements
+                pass
+
+    # All rust project will genrate at least one unit test binary
+    # It will just run a test suite with 0 tests if the project didn't define some
+    # So it is not expected to have an empty list here
+    if not test_bins:
+        bb.fatal("Unable to find any test binaries")
+
+    cargo_test_binaries_file = d.getVar('CARGO_TEST_BINARIES_FILES', True)
+    bb.note(f"Found {len(test_bins)} tests, write their path into {cargo_test_binaries_file}")
+    with open(cargo_test_binaries_file, "w") as f:
+        for test_bin in test_bins:
+            f.write(f"{test_bin}\n")
+
+}
+
+python do_install_ptest_base() {
+    import shutil
+
+    dest_dir = d.getVar("D", True)
+    pn = d.getVar("PN", True)
+    ptest_path = d.getVar("PTEST_PATH", True)
+    cargo_test_binaries_file = d.getVar('CARGO_TEST_BINARIES_FILES', True)
+
+    ptest_dir = os.path.join(dest_dir, ptest_path.lstrip('/'))
+    os.makedirs(ptest_dir, exist_ok=True)
+
+    test_bins = []
+    with open(cargo_test_binaries_file, "r") as f:
+        for line in f.readlines():
+            test_bins.append(line.strip('\n'))
+
+    test_paths = []
+    for test_bin in test_bins:
+        shutil.copy2(test_bin, ptest_dir)
+        test_paths.append(os.path.join(ptest_path, os.path.basename(test_bin)))
+
+    ptest_script = os.path.join(ptest_dir, "run-ptest")
+    if os.path.exists(ptest_script):
+        with open(ptest_script, "a") as f:
+            for test_path in test_paths:
+                f.write(f"{test_path}\n")
+    else:
+        with open(ptest_script, "a") as f:
+            f.write("#!/bin/sh\n")
+            for test_path in test_paths:
+                f.write(f"{test_path}\n")
+    os.chmod(ptest_script, 0o755)
+
+    # this is chown -R root:root ${D}${PTEST_PATH}
+    for root, dirs, files in os.walk(ptest_dir):
+        for d in dirs:
+            shutil.chown(os.path.join(root, d), "root", "root")
+        for f in files:
+            shutil.chown(os.path.join(root, f), "root", "root")
+}
Signature · 1 line
2.34.1
#2 lore raw

PATCH 2/3 python3-bcrypt: enable build of unit tests

In reply to [email protected]

From: Frederic Martinsons <[email protected]>

The source code of bcrypt extension doesn't define any tests but it is to show the ptest-cargo usage

---
 meta/recipes-devtools/python/python3-bcrypt_4.0.1.bb | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
meta/recipes-devtools/python/python3-bcrypt_4.0.1.bb +3 -1
index 21f2eb6ba4..b4f245530d 100644
@@ -7,12 +7,14 @@ DEPENDS += "${PYTHON_PN}-cffi-native"
 
 SRC_URI[sha256sum] = "27d375903ac8261cfe4047f6709d16f7d18d39b1ec92aaf72af989552a650ebd"
 
-inherit pypi python_setuptools3_rust ptest cargo-update-recipe-crates
+inherit pypi python_setuptools3_rust ptest-cargo cargo-update-recipe-crates
 
 SRC_URI += " \
 	file://run-ptest \
 "
 
+CARGO_SRC_DIR = "src/_bcrypt"
+
 require ${BPN}-crates.inc
 
 RDEPENDS:${PN}-ptest += " \
Signature · 1 line
2.34.1
#3 lore raw

PATCH 3/3 zvariant: add ptest feature for zvariant test suite

In reply to [email protected]

From: Frederic Martinsons <[email protected]>

---
 .../recipes-extended/zvariant/zvariant_3.12.0.bb      | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)
meta-selftest/recipes-extended/zvariant/zvariant_3.12.0.bb +10 -1
index 4285d11b72..6c69c80940 100644
@@ -7,6 +7,8 @@ HOMEPAGE = "https://gitlab.freedesktop.org/dbus/zbus/"
 LICENSE = "MIT"
 LIC_FILES_CHKSUM = "file://LICENSE;md5=b377b220f43d747efdec40d69fcaa69d"
 
+DEPENDS += "${@bb.utils.contains('DISTRO_FEATURES', 'ptest', 'glib-2.0', '', d)}"
+
 SRC_URI = " \
     git://gitlab.freedesktop.org/dbus/zbus;protocol=https;branch=main;subpath=zvariant \
     file://0001-Tweak-zvariant-crate-config.patch;striplevel=2 \
@@ -21,10 +23,17 @@ python do_clean_lic_file_symlink() {
 
 addtask clean_lic_file_symlink after do_unpack before do_patch
 
-inherit cargo cargo-update-recipe-crates
+inherit ptest-cargo pkgconfig cargo-update-recipe-crates
 
 # Remove this when the recipe is reproducible
 EXCLUDE_FROM_WORLD = "1"
 
 require ${BPN}-crates.inc
 require ${BPN}-git-crates.inc
+
+# zvariant is an indermediate product for the zbus project
+# and so, it provided only a static lib (rlib) which fall only
+# in -dev package
+ALLOW_EMPTY:${PN} = "1"
+RDEPENDS:${PN}-ptest:remove = "${PN}"
+
Signature · 1 line
2.34.1
#4 lore raw

Re: [OE-core] [PATCH 3/3] zvariant: add ptest feature for zvariant test suite

meta-selftest/recipes-extended/zvariant/zvariant_3.12.0.bb python do_clean_lic_file_symlink() { · line 38

Quoted 5 lines · Frederic Martinsons
meta-selftest/recipes-extended/zvariant/zvariant_3.12.0.bb +5 -0
+# zvariant is an indermediate product for the zbus project
+# and so, it provided only a static lib (rlib) which fall only
+# in -dev package
+ALLOW_EMPTY:${PN} = "1"
+RDEPENDS:${PN}-ptest:remove = "${PN}"

Only the first should be enough, why also the second? We generally try to avoid :remove, as issues can be usually solved in better ways.

Alex

#6 lore raw
In reply to [email protected]

If you add ptests, please also add them to appropriate lists in meta/conf/distro/include/ptest-packagelists.inc, so they will be actually built and executed in yocto CI.

Can you include a sample output of the tests you added into commit messages?

Alex

Quoted 55 lines · Frederic Martinsons

From: Frederic Martinsons <[email protected]>

This brings the possibility to use this class to build and ship unit tests of rust projects, the class also create (or modified) standard run-ptest script to run the generated rust test suite.

It has been tested successfully with core-image-sato under qemu for zvariant-ptest and python3-bcrypt-ptest (though the last one didn't define any unit tests).

Note that I tried to do the same with python3-cryptography but fail to build the test suite and I don't know how to do it with the rust extension module build by python setuptools. There must be some kind of way for doing that so maybe someone will put some work in it ( because python3-cryptography rust extension do have unit tests).

Moreover, in the class, I didn't manage to share data between do_compile_ptest_base and do_install_ptest_base cleanly (I tried to d.setVar in compile and d.getVar in install but it seems that the data store doens't recognize my new variable) so I used a file for that. I'm sure there is a clever way for doing that, so feel free to tell me.

The following changes since commit 45a8bb6e4676899d40525e7d5ad1c1ddefee3185:

apt-util: Fix ptest on musl (2023-04-20 11:56:03 +0100)

are available in the Git repository at:

https://gitlab.com/fmartinsons/openembedded-core cargo-add-ptest

Frederic Martinsons (3):
ptest-cargo.bbclass: create class
python3-bcrypt: enable build of unit tests
zvariant: add ptest feature for zvariant test suite

 .../zvariant/zvariant_3.12.0.bb               |  11 +-
 meta/classes-recipe/ptest-cargo.bbclass       | 108 ++++++++++++++++++
 .../python/python3-bcrypt_4.0.1.bb            |   4 +-
 3 files changed, 121 insertions(+), 2 deletions(-)
 create mode 100644 meta/classes-recipe/ptest-cargo.bbclass

--
2.34.1

-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#180319): https://lists.openembedded.org/g/openembedded-core/message/180319
Mute This Topic: https://lists.openembedded.org/mt/98436057/1686489
Group Owner: [email protected]
Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-

#7 lore raw
Quoted 9 lines · Alexander Kanavin

If you add ptests, please also add them to appropriate lists in meta/conf/distro/include/ptest-packagelists.inc, so they will be actually built and executed in yocto CI.

Can you include a sample output of the tests you added into commit messages?

Alex

Ok I will issue a V2 with the modifications asked.

Quoted 61 lines
Quoted 17 lines · Frederic Martinsons

From: Frederic Martinsons <[email protected]>

This brings the possibility to use this class to build and ship unit tests of rust projects, the class also create (or modified) standard run-ptest script to run the generated rust test suite.

It has been tested successfully with core-image-sato under qemu for zvariant-ptest and python3-bcrypt-ptest (though the last one didn't define any unit tests).

Note that I tried to do the same with python3-cryptography but fail to build the test suite and I don't know how to do it with the rust extension module build by python setuptools. There must be some kind of way for doing that so maybe someone will put some work in it ( because python3-cryptography rust extension do have unit tests).

Quoted 8 lines

Moreover, in the class, I didn't manage to share data between do_compile_ptest_base and do_install_ptest_base cleanly (I tried to d.setVar in compile and d.getVar in install but it seems that the data store doens't recognize my new variable) so I used a file for that. I'm sure there is a clever way for doing that, so feel free to tell me.

The following changes since commit

45a8bb6e4676899d40525e7d5ad1c1ddefee3185:

Quoted 18 lines

apt-util: Fix ptest on musl (2023-04-20 11:56:03 +0100)

are available in the Git repository at:

https://gitlab.com/fmartinsons/openembedded-core cargo-add-ptest

Frederic Martinsons (3):
ptest-cargo.bbclass: create class
python3-bcrypt: enable build of unit tests
zvariant: add ptest feature for zvariant test suite

 .../zvariant/zvariant_3.12.0.bb               |  11 +-
 meta/classes-recipe/ptest-cargo.bbclass       | 108 ++++++++++++++++++
 .../python/python3-bcrypt_4.0.1.bb            |   4 +-
 3 files changed, 121 insertions(+), 2 deletions(-)
 create mode 100644 meta/classes-recipe/ptest-cargo.bbclass
Quoted 7 lines

--
2.34.1

-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group. View/Reply Online (#180319):

https://lists.openembedded.org/g/openembedded-core/message/180319

Quoted 3 lines

Mute This Topic: https://lists.openembedded.org/mt/98436057/1686489
Group Owner: [email protected]
Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [

[email protected]]

Quoted 2 lines

-=-=-=-=-=-=-=-=-=-=-=-

#5 lore raw

Re: [OE-core] [PATCH 3/3] zvariant: add ptest feature for zvariant test suite

In reply to Alexander Kanavin
Quoted 12 lines · Alexander Kanavin

meta-selftest/recipes-extended/zvariant/zvariant_3.12.0.bb python do_clean_lic_file_symlink() { · line 38

Quoted 5 lines · Frederic Martinsons
meta-selftest/recipes-extended/zvariant/zvariant_3.12.0.bb +5 -0
+# zvariant is an indermediate product for the zbus project
+# and so, it provided only a static lib (rlib) which fall only
+# in -dev package
+ALLOW_EMPTY:${PN} = "1"
+RDEPENDS:${PN}-ptest:remove = "${PN}"

Only the first should be enough, why also the second? We generally try to avoid :remove, as issues can be usually solved in better ways.

Quoted 2 lines

Alex

Ok will remove it in a V2. It seems that I had a wrong state if I must had add this line, but I did
a "bitbake -c cleanall zvariant && bitbake core-image-sato" and I didn't have any rootfs
issue.

#9 lore raw
In reply to a message not in the archive
Quoted 8 lines · Frederic Martinsons via lists.openembedded.org
Quoted 4 lines · Alexander Kanavin

If you add ptests, please also add them to appropriate lists in meta/conf/distro/include/ptest-packagelists.inc, so they will be actually built and executed in yocto CI.

Quoted 9 lines
Quoted 5 lines

Can you include a sample output of the tests you added into commit messages?

Alex

Ok I will issue a V2 with the modifications asked.

I looked again and python3-bcrypt is already in PTESTS_FAST , for zvariant , the recipe is in meta-selftest
so this layer is not always included, is this will be a problem to add zvariant into PTESTS_FAST ?

On Sat, 22 Apr 2023 at 17:59, Frederic Martinsons

Quoted 64 lines
Quoted 25 lines
Quoted 24 lines · <[email protected]> wrote:

From: Frederic Martinsons <[email protected]>

This brings the possibility to use this class to build and ship unit tests of rust projects, the class also create (or modified) standard run-ptest script to run the generated rust test suite.

It has been tested successfully with core-image-sato under qemu for zvariant-ptest and python3-bcrypt-ptest (though the last one didn't define any unit tests).

Note that I tried to do the same with python3-cryptography but fail to build the test suite and I don't know how to do it with the rust extension module build by python setuptools. There must be some kind of way for doing that so maybe someone will put some work in it ( because python3-cryptography rust extension do have unit tests).

Moreover, in the class, I didn't manage to share data between do_compile_ptest_base and do_install_ptest_base cleanly (I tried to d.setVar in compile and d.getVar in install but it seems that the data store doens't recognize my new variable) so I used a file for that. I'm sure there is a clever way for doing that, so feel free to tell me.

Quoted 27 lines
Quoted 1 line

The following changes since commit

45a8bb6e4676899d40525e7d5ad1c1ddefee3185:

Quoted 24 lines

apt-util: Fix ptest on musl (2023-04-20 11:56:03 +0100)

are available in the Git repository at:

https://gitlab.com/fmartinsons/openembedded-core cargo-add-ptest

Frederic Martinsons (3):
ptest-cargo.bbclass: create class
python3-bcrypt: enable build of unit tests
zvariant: add ptest feature for zvariant test suite

 .../zvariant/zvariant_3.12.0.bb               |  11 +-
 meta/classes-recipe/ptest-cargo.bbclass       | 108 ++++++++++++++++++
 .../python/python3-bcrypt_4.0.1.bb            |   4 +-
 3 files changed, 121 insertions(+), 2 deletions(-)
 create mode 100644 meta/classes-recipe/ptest-cargo.bbclass

--
2.34.1

-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group. View/Reply Online (#180341):
https://lists.openembedded.org/g/openembedded-core/message/180341
Mute This Topic: https://lists.openembedded.org/mt/98436057/6213388
Group Owner: [email protected]
Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [ [email protected]]
-=-=-=-=-=-=-=-=-=-=-=-

#10 lore raw
Quoted 2 lines · Frédéric Martinsons

I looked again and python3-bcrypt is already in PTESTS_FAST , for zvariant , the recipe is in meta-selftest so this layer is not always included, is this will be a problem to add zvariant into PTESTS_FAST ?

zvariant could be skipped for now then. Are the newly expanded bcrypt tests still quick (under kvm)?

Alex

#11 lore raw

Le lun. 24 avr. 2023, 11:53, Alexander Kanavin <[email protected]> a écrit :

Quoted 12 lines
Quoted 1 line · Frédéric Martinsons

I looked again and python3-bcrypt is already in PTESTS_FAST , for

zvariant , the recipe is in meta-selftest

Quoted 1 line

so this layer is not always included, is this will be a problem to add

zvariant into PTESTS_FAST ?

zvariant could be skipped for now then. Are the newly expanded bcrypt tests still quick (under kvm)?

Alex

Really quick since there are 0 test in the rust code ;)
But a test binary is guaranteed to be generated anyway.
I'll take another look to see if why python3-bcrypt was already in the test suite and if I didn't overwrite something there.