diff options
author | Tim Orling <ticotimo@gmail.com> | 2023-12-16 21:41:33 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-12-17 19:07:22 +0000 |
commit | 7d881f0214f9761990e52595d33246700c4da15c (patch) | |
tree | 8d95533ed07a819499a84f2bcce94d46a1cfd316 /meta/lib/oeqa | |
parent | b2b2e0277509a07a37022caf51f7e536adad898f (diff) | |
download | poky-7d881f0214f9761990e52595d33246700c4da15c.tar.gz |
oeqa: add "maturin develop" SDK test case
'maturin develop' first checks that a virtual environment
has been created, which is a good test for our python3 SDK
environment ;)
Source for guessing-game lifted from https://www.maturin.rs/tutorial
The test case is expected to fetch any necessary crates, build a
development version of the crate and package it as a wheel
Needs at a minimum the following in e.g. local.conf:
TOOLCHAIN_HOST_TASK:append = " nativesdk-python3-maturin"
SDK_INCLUDE_TOOLCHAIN = '1'
SDK_TOOLCHAIN_LANGS += 'rust'
The output of 'maturin develop' should be something like:
...
🔗 Found pyo3 bindings with abi3 support for Python ≥ 3.8
🐍 Not using a specific python interpreter
📡 Using build options features from pyproject.toml
...
Compiling guessing-game v0.1.0 (/path/to/guessing-game)
Finished dev [unoptimized + debuginfo] target(s) in 7.14s
📦 Built wheel for abi3 Python ≥ 3.8 to /path/to/tmpdir/guessing_game-0.1.0-cp38-abi3-linux_x86_64.whl
🛠 Installed guessing-game-0.1.0
(From OE-Core rev: 5265dd0b102cd7f3c6bb2ae1b18e9f625b834b39)
Signed-off-by: Tim Orling <tim.orling@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'meta/lib/oeqa')
-rw-r--r-- | meta/lib/oeqa/files/maturin/guessing-game/Cargo.toml | 20 | ||||
-rw-r--r-- | meta/lib/oeqa/files/maturin/guessing-game/LICENSE-APACHE | 201 | ||||
-rw-r--r-- | meta/lib/oeqa/files/maturin/guessing-game/LICENSE-MIT | 25 | ||||
-rw-r--r-- | meta/lib/oeqa/files/maturin/guessing-game/pyproject.toml | 8 | ||||
-rw-r--r-- | meta/lib/oeqa/files/maturin/guessing-game/src/lib.rs | 48 | ||||
-rw-r--r-- | meta/lib/oeqa/sdk/cases/maturin.py | 48 |
6 files changed, 349 insertions, 1 deletions
diff --git a/meta/lib/oeqa/files/maturin/guessing-game/Cargo.toml b/meta/lib/oeqa/files/maturin/guessing-game/Cargo.toml new file mode 100644 index 0000000000..de95025e86 --- /dev/null +++ b/meta/lib/oeqa/files/maturin/guessing-game/Cargo.toml | |||
@@ -0,0 +1,20 @@ | |||
1 | [package] | ||
2 | name = "guessing-game" | ||
3 | version = "0.1.0" | ||
4 | edition = "2021" | ||
5 | |||
6 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html | ||
7 | |||
8 | [lib] | ||
9 | name = "guessing_game" | ||
10 | # "cdylib" is necessary to produce a shared library for Python to import from. | ||
11 | crate-type = ["cdylib"] | ||
12 | |||
13 | [dependencies] | ||
14 | rand = "0.8.4" | ||
15 | |||
16 | [dependencies.pyo3] | ||
17 | version = "0.19.0" | ||
18 | # "abi3-py38" tells pyo3 (and maturin) to build using the stable ABI with minimum Python version 3.8 | ||
19 | features = ["abi3-py38"] | ||
20 | |||
diff --git a/meta/lib/oeqa/files/maturin/guessing-game/LICENSE-APACHE b/meta/lib/oeqa/files/maturin/guessing-game/LICENSE-APACHE new file mode 100644 index 0000000000..16fe87b06e --- /dev/null +++ b/meta/lib/oeqa/files/maturin/guessing-game/LICENSE-APACHE | |||
@@ -0,0 +1,201 @@ | |||
1 | Apache License | ||
2 | Version 2.0, January 2004 | ||
3 | http://www.apache.org/licenses/ | ||
4 | |||
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
6 | |||
7 | 1. Definitions. | ||
8 | |||
9 | "License" shall mean the terms and conditions for use, reproduction, | ||
10 | and distribution as defined by Sections 1 through 9 of this document. | ||
11 | |||
12 | "Licensor" shall mean the copyright owner or entity authorized by | ||
13 | the copyright owner that is granting the License. | ||
14 | |||
15 | "Legal Entity" shall mean the union of the acting entity and all | ||
16 | other entities that control, are controlled by, or are under common | ||
17 | control with that entity. For the purposes of this definition, | ||
18 | "control" means (i) the power, direct or indirect, to cause the | ||
19 | direction or management of such entity, whether by contract or | ||
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
21 | outstanding shares, or (iii) beneficial ownership of such entity. | ||
22 | |||
23 | "You" (or "Your") shall mean an individual or Legal Entity | ||
24 | exercising permissions granted by this License. | ||
25 | |||
26 | "Source" form shall mean the preferred form for making modifications, | ||
27 | including but not limited to software source code, documentation | ||
28 | source, and configuration files. | ||
29 | |||
30 | "Object" form shall mean any form resulting from mechanical | ||
31 | transformation or translation of a Source form, including but | ||
32 | not limited to compiled object code, generated documentation, | ||
33 | and conversions to other media types. | ||
34 | |||
35 | "Work" shall mean the work of authorship, whether in Source or | ||
36 | Object form, made available under the License, as indicated by a | ||
37 | copyright notice that is included in or attached to the work | ||
38 | (an example is provided in the Appendix below). | ||
39 | |||
40 | "Derivative Works" shall mean any work, whether in Source or Object | ||
41 | form, that is based on (or derived from) the Work and for which the | ||
42 | editorial revisions, annotations, elaborations, or other modifications | ||
43 | represent, as a whole, an original work of authorship. For the purposes | ||
44 | of this License, Derivative Works shall not include works that remain | ||
45 | separable from, or merely link (or bind by name) to the interfaces of, | ||
46 | the Work and Derivative Works thereof. | ||
47 | |||
48 | "Contribution" shall mean any work of authorship, including | ||
49 | the original version of the Work and any modifications or additions | ||
50 | to that Work or Derivative Works thereof, that is intentionally | ||
51 | submitted to Licensor for inclusion in the Work by the copyright owner | ||
52 | or by an individual or Legal Entity authorized to submit on behalf of | ||
53 | the copyright owner. For the purposes of this definition, "submitted" | ||
54 | means any form of electronic, verbal, or written communication sent | ||
55 | to the Licensor or its representatives, including but not limited to | ||
56 | communication on electronic mailing lists, source code control systems, | ||
57 | and issue tracking systems that are managed by, or on behalf of, the | ||
58 | Licensor for the purpose of discussing and improving the Work, but | ||
59 | excluding communication that is conspicuously marked or otherwise | ||
60 | designated in writing by the copyright owner as "Not a Contribution." | ||
61 | |||
62 | "Contributor" shall mean Licensor and any individual or Legal Entity | ||
63 | on behalf of whom a Contribution has been received by Licensor and | ||
64 | subsequently incorporated within the Work. | ||
65 | |||
66 | 2. Grant of Copyright License. Subject to the terms and conditions of | ||
67 | this License, each Contributor hereby grants to You a perpetual, | ||
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
69 | copyright license to reproduce, prepare Derivative Works of, | ||
70 | publicly display, publicly perform, sublicense, and distribute the | ||
71 | Work and such Derivative Works in Source or Object form. | ||
72 | |||
73 | 3. Grant of Patent License. Subject to the terms and conditions of | ||
74 | this License, each Contributor hereby grants to You a perpetual, | ||
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
76 | (except as stated in this section) patent license to make, have made, | ||
77 | use, offer to sell, sell, import, and otherwise transfer the Work, | ||
78 | where such license applies only to those patent claims licensable | ||
79 | by such Contributor that are necessarily infringed by their | ||
80 | Contribution(s) alone or by combination of their Contribution(s) | ||
81 | with the Work to which such Contribution(s) was submitted. If You | ||
82 | institute patent litigation against any entity (including a | ||
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
84 | or a Contribution incorporated within the Work constitutes direct | ||
85 | or contributory patent infringement, then any patent licenses | ||
86 | granted to You under this License for that Work shall terminate | ||
87 | as of the date such litigation is filed. | ||
88 | |||
89 | 4. Redistribution. You may reproduce and distribute copies of the | ||
90 | Work or Derivative Works thereof in any medium, with or without | ||
91 | modifications, and in Source or Object form, provided that You | ||
92 | meet the following conditions: | ||
93 | |||
94 | (a) You must give any other recipients of the Work or | ||
95 | Derivative Works a copy of this License; and | ||
96 | |||
97 | (b) You must cause any modified files to carry prominent notices | ||
98 | stating that You changed the files; and | ||
99 | |||
100 | (c) You must retain, in the Source form of any Derivative Works | ||
101 | that You distribute, all copyright, patent, trademark, and | ||
102 | attribution notices from the Source form of the Work, | ||
103 | excluding those notices that do not pertain to any part of | ||
104 | the Derivative Works; and | ||
105 | |||
106 | (d) If the Work includes a "NOTICE" text file as part of its | ||
107 | distribution, then any Derivative Works that You distribute must | ||
108 | include a readable copy of the attribution notices contained | ||
109 | within such NOTICE file, excluding those notices that do not | ||
110 | pertain to any part of the Derivative Works, in at least one | ||
111 | of the following places: within a NOTICE text file distributed | ||
112 | as part of the Derivative Works; within the Source form or | ||
113 | documentation, if provided along with the Derivative Works; or, | ||
114 | within a display generated by the Derivative Works, if and | ||
115 | wherever such third-party notices normally appear. The contents | ||
116 | of the NOTICE file are for informational purposes only and | ||
117 | do not modify the License. You may add Your own attribution | ||
118 | notices within Derivative Works that You distribute, alongside | ||
119 | or as an addendum to the NOTICE text from the Work, provided | ||
120 | that such additional attribution notices cannot be construed | ||
121 | as modifying the License. | ||
122 | |||
123 | You may add Your own copyright statement to Your modifications and | ||
124 | may provide additional or different license terms and conditions | ||
125 | for use, reproduction, or distribution of Your modifications, or | ||
126 | for any such Derivative Works as a whole, provided Your use, | ||
127 | reproduction, and distribution of the Work otherwise complies with | ||
128 | the conditions stated in this License. | ||
129 | |||
130 | 5. Submission of Contributions. Unless You explicitly state otherwise, | ||
131 | any Contribution intentionally submitted for inclusion in the Work | ||
132 | by You to the Licensor shall be under the terms and conditions of | ||
133 | this License, without any additional terms or conditions. | ||
134 | Notwithstanding the above, nothing herein shall supersede or modify | ||
135 | the terms of any separate license agreement you may have executed | ||
136 | with Licensor regarding such Contributions. | ||
137 | |||
138 | 6. Trademarks. This License does not grant permission to use the trade | ||
139 | names, trademarks, service marks, or product names of the Licensor, | ||
140 | except as required for reasonable and customary use in describing the | ||
141 | origin of the Work and reproducing the content of the NOTICE file. | ||
142 | |||
143 | 7. Disclaimer of Warranty. Unless required by applicable law or | ||
144 | agreed to in writing, Licensor provides the Work (and each | ||
145 | Contributor provides its Contributions) on an "AS IS" BASIS, | ||
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
147 | implied, including, without limitation, any warranties or conditions | ||
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
149 | PARTICULAR PURPOSE. You are solely responsible for determining the | ||
150 | appropriateness of using or redistributing the Work and assume any | ||
151 | risks associated with Your exercise of permissions under this License. | ||
152 | |||
153 | 8. Limitation of Liability. In no event and under no legal theory, | ||
154 | whether in tort (including negligence), contract, or otherwise, | ||
155 | unless required by applicable law (such as deliberate and grossly | ||
156 | negligent acts) or agreed to in writing, shall any Contributor be | ||
157 | liable to You for damages, including any direct, indirect, special, | ||
158 | incidental, or consequential damages of any character arising as a | ||
159 | result of this License or out of the use or inability to use the | ||
160 | Work (including but not limited to damages for loss of goodwill, | ||
161 | work stoppage, computer failure or malfunction, or any and all | ||
162 | other commercial damages or losses), even if such Contributor | ||
163 | has been advised of the possibility of such damages. | ||
164 | |||
165 | 9. Accepting Warranty or Additional Liability. While redistributing | ||
166 | the Work or Derivative Works thereof, You may choose to offer, | ||
167 | and charge a fee for, acceptance of support, warranty, indemnity, | ||
168 | or other liability obligations and/or rights consistent with this | ||
169 | License. However, in accepting such obligations, You may act only | ||
170 | on Your own behalf and on Your sole responsibility, not on behalf | ||
171 | of any other Contributor, and only if You agree to indemnify, | ||
172 | defend, and hold each Contributor harmless for any liability | ||
173 | incurred by, or claims asserted against, such Contributor by reason | ||
174 | of your accepting any such warranty or additional liability. | ||
175 | |||
176 | END OF TERMS AND CONDITIONS | ||
177 | |||
178 | APPENDIX: How to apply the Apache License to your work. | ||
179 | |||
180 | To apply the Apache License to your work, attach the following | ||
181 | boilerplate notice, with the fields enclosed by brackets "[]" | ||
182 | replaced with your own identifying information. (Don't include | ||
183 | the brackets!) The text should be enclosed in the appropriate | ||
184 | comment syntax for the file format. We also recommend that a | ||
185 | file or class name and description of purpose be included on the | ||
186 | same "printed page" as the copyright notice for easier | ||
187 | identification within third-party archives. | ||
188 | |||
189 | Copyright [yyyy] [name of copyright owner] | ||
190 | |||
191 | Licensed under the Apache License, Version 2.0 (the "License"); | ||
192 | you may not use this file except in compliance with the License. | ||
193 | You may obtain a copy of the License at | ||
194 | |||
195 | http://www.apache.org/licenses/LICENSE-2.0 | ||
196 | |||
197 | Unless required by applicable law or agreed to in writing, software | ||
198 | distributed under the License is distributed on an "AS IS" BASIS, | ||
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
200 | See the License for the specific language governing permissions and | ||
201 | limitations under the License. | ||
diff --git a/meta/lib/oeqa/files/maturin/guessing-game/LICENSE-MIT b/meta/lib/oeqa/files/maturin/guessing-game/LICENSE-MIT new file mode 100644 index 0000000000..c4a9a58791 --- /dev/null +++ b/meta/lib/oeqa/files/maturin/guessing-game/LICENSE-MIT | |||
@@ -0,0 +1,25 @@ | |||
1 | Copyright (c) 2018 konstin | ||
2 | |||
3 | Permission is hereby granted, free of charge, to any | ||
4 | person obtaining a copy of this software and associated | ||
5 | documentation files (the "Software"), to deal in the | ||
6 | Software without restriction, including without | ||
7 | limitation the rights to use, copy, modify, merge, | ||
8 | publish, distribute, sublicense, and/or sell copies of | ||
9 | the Software, and to permit persons to whom the Software | ||
10 | is furnished to do so, subject to the following | ||
11 | conditions: | ||
12 | |||
13 | The above copyright notice and this permission notice | ||
14 | shall be included in all copies or substantial portions | ||
15 | of the Software. | ||
16 | |||
17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF | ||
18 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED | ||
19 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A | ||
20 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT | ||
21 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY | ||
22 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | ||
23 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR | ||
24 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | ||
25 | DEALINGS IN THE SOFTWARE. | ||
diff --git a/meta/lib/oeqa/files/maturin/guessing-game/pyproject.toml b/meta/lib/oeqa/files/maturin/guessing-game/pyproject.toml new file mode 100644 index 0000000000..ff35abc472 --- /dev/null +++ b/meta/lib/oeqa/files/maturin/guessing-game/pyproject.toml | |||
@@ -0,0 +1,8 @@ | |||
1 | [build-system] | ||
2 | requires = ["maturin>=1.0,<2.0"] | ||
3 | build-backend = "maturin" | ||
4 | |||
5 | [tool.maturin] | ||
6 | # "extension-module" tells pyo3 we want to build an extension module (skips linking against libpython.so) | ||
7 | features = ["pyo3/extension-module"] | ||
8 | |||
diff --git a/meta/lib/oeqa/files/maturin/guessing-game/src/lib.rs b/meta/lib/oeqa/files/maturin/guessing-game/src/lib.rs new file mode 100644 index 0000000000..6828466ed1 --- /dev/null +++ b/meta/lib/oeqa/files/maturin/guessing-game/src/lib.rs | |||
@@ -0,0 +1,48 @@ | |||
1 | use pyo3::prelude::*; | ||
2 | use rand::Rng; | ||
3 | use std::cmp::Ordering; | ||
4 | use std::io; | ||
5 | |||
6 | #[pyfunction] | ||
7 | fn guess_the_number() { | ||
8 | println!("Guess the number!"); | ||
9 | |||
10 | let secret_number = rand::thread_rng().gen_range(1..101); | ||
11 | |||
12 | loop { | ||
13 | println!("Please input your guess."); | ||
14 | |||
15 | let mut guess = String::new(); | ||
16 | |||
17 | io::stdin() | ||
18 | .read_line(&mut guess) | ||
19 | .expect("Failed to read line"); | ||
20 | |||
21 | let guess: u32 = match guess.trim().parse() { | ||
22 | Ok(num) => num, | ||
23 | Err(_) => continue, | ||
24 | }; | ||
25 | |||
26 | println!("You guessed: {}", guess); | ||
27 | |||
28 | match guess.cmp(&secret_number) { | ||
29 | Ordering::Less => println!("Too small!"), | ||
30 | Ordering::Greater => println!("Too big!"), | ||
31 | Ordering::Equal => { | ||
32 | println!("You win!"); | ||
33 | break; | ||
34 | } | ||
35 | } | ||
36 | } | ||
37 | } | ||
38 | |||
39 | /// A Python module implemented in Rust. The name of this function must match | ||
40 | /// the `lib.name` setting in the `Cargo.toml`, else Python will not be able to | ||
41 | /// import the module. | ||
42 | #[pymodule] | ||
43 | fn guessing_game(_py: Python, m: &PyModule) -> PyResult<()> { | ||
44 | m.add_function(wrap_pyfunction!(guess_the_number, m)?)?; | ||
45 | |||
46 | Ok(()) | ||
47 | } | ||
48 | |||
diff --git a/meta/lib/oeqa/sdk/cases/maturin.py b/meta/lib/oeqa/sdk/cases/maturin.py index 14245bc36e..ea10f568b2 100644 --- a/meta/lib/oeqa/sdk/cases/maturin.py +++ b/meta/lib/oeqa/sdk/cases/maturin.py | |||
@@ -4,9 +4,12 @@ | |||
4 | # SPDX-License-Identifier: MIT | 4 | # SPDX-License-Identifier: MIT |
5 | # | 5 | # |
6 | 6 | ||
7 | import os | ||
8 | import shutil | ||
7 | import unittest | 9 | import unittest |
8 | from oeqa.sdk.case import OESDKTestCase | ||
9 | 10 | ||
11 | from oeqa.core.utils.path import remove_safe | ||
12 | from oeqa.sdk.case import OESDKTestCase | ||
10 | from oeqa.utils.subprocesstweak import errors_have_output | 13 | from oeqa.utils.subprocesstweak import errors_have_output |
11 | 14 | ||
12 | errors_have_output() | 15 | errors_have_output() |
@@ -31,3 +34,46 @@ class MaturinTest(OESDKTestCase): | |||
31 | output, | 34 | output, |
32 | r" - CPython %s (.+)/usr/bin/python%s$" % (python_version, python_version), | 35 | r" - CPython %s (.+)/usr/bin/python%s$" % (python_version, python_version), |
33 | ) | 36 | ) |
37 | |||
38 | |||
39 | class MaturinDevelopTest(OESDKTestCase): | ||
40 | @classmethod | ||
41 | def setUpClass(self): | ||
42 | targetdir = os.path.join(self.tc.sdk_dir, "guessing-game") | ||
43 | try: | ||
44 | shutil.rmtree(targetdir) | ||
45 | except FileNotFoundError: | ||
46 | pass | ||
47 | shutil.copytree( | ||
48 | os.path.join(self.tc.files_dir, "maturin/guessing-game"), targetdir | ||
49 | ) | ||
50 | |||
51 | def setUp(self): | ||
52 | machine = self.td.get("MACHINE") | ||
53 | if not ( | ||
54 | self.tc.hasHostPackage("nativesdk-python3-maturin") | ||
55 | or self.tc.hasHostPackage("python3-maturin-native") | ||
56 | ): | ||
57 | raise unittest.SkipTest("No python3-maturin package in the SDK") | ||
58 | if not ( | ||
59 | self.tc.hasHostPackage("packagegroup-rust-cross-canadian-%s" % machine) | ||
60 | ): | ||
61 | raise unittest.SkipTest( | ||
62 | "Testing 'maturin develop' requires Rust cross-canadian in the SDK" | ||
63 | ) | ||
64 | |||
65 | def test_maturin_develop(self): | ||
66 | """ | ||
67 | This test case requires: | ||
68 | (1) that a .venv can been created. | ||
69 | (2) a functional 'rustc' and 'cargo' | ||
70 | """ | ||
71 | self._run("cd %s/guessing-game; python3 -m venv .venv" % self.tc.sdk_dir) | ||
72 | cmd = "cd %s/guessing-game; maturin develop" % self.tc.sdk_dir | ||
73 | output = self._run(cmd) | ||
74 | self.assertRegex(output, r"🔗 Found pyo3 bindings with abi3 support for Python ≥ 3.8") | ||
75 | self.assertRegex(output, r"🐍 Not using a specific python interpreter") | ||
76 | self.assertRegex(output, r"📡 Using build options features from pyproject.toml") | ||
77 | self.assertRegex(output, r"Compiling guessing-game v0.1.0") | ||
78 | self.assertRegex(output, r"📦 Built wheel for abi3 Python ≥ 3.8") | ||
79 | self.assertRegex(output, r"🛠 Installed guessing-game-0.1.0") | ||