1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
|
%global _empty_manifest_terminate_build 0
Name: python-nanaimo
Version: 0.2.5
Release: 1
Summary: Framework for automating tests involving hardware test fixtures.
License: MIT
URL: https://github.com/thirtytwobits/nanaimo
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/c5/44/f491f669c60fa70025d2a3d72f53425cbaf4b95970190bf299321aa7029d/nanaimo-0.2.5.tar.gz
BuildArch: noarch
Requires: python3-pyserial
Requires: python3-pytest
Requires: python3-pytest-asyncio
%description
############################################
Nanaimo: Hardware-In-the-Loop Unit Testing
############################################
|badge_docs|_ |badge_build|_ |badge_github_license|_ |badge_pypi_support|_ |badge_pypi_version|_ \
|badge_sonarcloud_quality|_ |badge_sonarcloud_coverage|_ |badge_sonarcloud_bugs|_
.. note::
Nanaimo is alpha software and will remain so until we bump its version to 1.0.0 or greater.
We will not knowingly break compatibility within a minor revision but we will break compatibility
a few more times between minor revisions until beta is declared. Because of this you should depend
on a minor version explicitly. For example ::
nanaimo ~= 0.1
.. figure:: https://thirtytwobits.github.io/nanaimo/static/images/nanaimo.png
:alt: A delicious Nanaimo bar
A delicious Python treat that makes on-target testing sweet and satisfying.
Nanaimo is a set of utilities and plugins designed to enable integration of hardware test apparatuses
with pytest. This can allow on-target tests to run as part of continuous integration pipelines like
`Buildkite`_, `Bamboo`_, or `Jenkins`_.
.. figure:: https://thirtytwobits.github.io/nanaimo/static/images/pifarm.jpeg
:alt: S32K evaluation boards attached to Raspberry PIs.
Example of S32K dev boards attached to Raspberry PI CI workers running the `Buildkite`_ agent and using Nanaimo.
Nanaimo is designed to enable testing of software-defined, physical components in isolation to
provide pre-integration verification of software interfaces and behavioral contracts. It adapts
asynchronous control and monitoring of these components to fit familiar testing idioms
(e.g. x-unit testing) using the popular python test framework, `pytest`_.
.. figure:: https://thirtytwobits.github.io/nanaimo/static/images/block.png
:alt: Block diagram of Nanaimo's relationship to other components of a typical software build and test pipeline.
Block diagram of Nanaimo's relationship to other components of a typical software build and test pipeline.
Nanaimo is *not* a simulation framework and is not designed to support the complexity of a full hardware-in-the-loop platform.
Instead it's focused on testing small integrations with a few hardware components and instruments using concepts, syntax,
and frameworks familiar to software engineers. Examples of these small integrations might include verifying a SPI driver for a
microcontroller or ensuring the upload time for a serial bootloader meets expected Key-Performance-Indicators (KPIs). To do this
Nanaimo abstractions provide async interfaces to hardware either directly using available communication protocols
(e.g. serial or IP networks) or by invoking a CLI provided by the instrument vendor. Because of this latter use case some
instruments will require additional programs be available in a test environment.
.. figure:: https://thirtytwobits.github.io/nanaimo/static/images/example.png
:alt: Example scenario using Nanaimo to test an I2C driver for a microcontroller.
Example scenario using Nanaimo to test an I2C driver for a microcontroller.
This design is an amalgam of the `TLYF`_ (Test Like You Fly) methodology and the `Swiss cheese`_ model of
failure analysis. Specifically; Nanaimo facilitates testing on actual or representative hardware
for the first integration of software into a part or subassembly. Traditionally software engineers were
responsible only for unit-testing and Software-In-the-Loop (SIL) simulation of their code. Nanaimo encourages
software engineers to also provide hardware integration tests by enabling Hardware-In-the-Loop
`continuous-integration <https://en.wikipedia.org/wiki/Continuous_integration>`_ (HIL-CI, perhaps?).
.. figure:: https://thirtytwobits.github.io/nanaimo/static/images/test_triangle.png
:alt: Hierarchy of system testing.
Hierarchy of system testing. Nanaimo focuses on part and subassembly testing.
.. Note::
Nanaimo is named after `Nanaimo bars`_ which are about the best things humans have ever invented.
.. _`Nanaimo bars`: https://en.wikipedia.org/wiki/Nanaimo_bar
.. _`Buildkite`: https://buildkite.com
.. _`Bamboo`: https://www.atlassian.com/software/bamboo
.. _`Jenkins`: https://jenkins.io/
.. _`pytest`: https://docs.pytest.org/en/latest/
.. _`TLYF`: https://www.youtube.com/watch?v=0BSaI117ITI
.. _`Swiss cheese`: https://en.wikipedia.org/wiki/Swiss_cheese_model
.. |badge_docs| image:: https://readthedocs.org/projects/nanaimo/badge/?version=latest
:alt: Documentation Status
.. _badge_docs: https://nanaimo.readthedocs.io/en/latest/?badge=latest
.. |badge_build| image:: https://badge.buildkite.com/80558e71a357a16151e4b537bfc19527c9b1ac543975b92ed7.svg
:alt: Build status
.. _badge_build: https://buildkite.com/friends-of-scott/nanaimo-release
.. |badge_github_license| image:: https://img.shields.io/badge/license-MIT-blue.svg
:alt: MIT license
.. _badge_github_license: https://github.com/thirtytwobits/nanaimo/blob/master/LICENSE.rst
.. |badge_pypi_support| image:: https://img.shields.io/pypi/pyversions/nanaimo.svg
:alt: Supported Python Versions
.. _badge_pypi_support: https://pypi.org/project/nanaimo/
.. |badge_pypi_version| image:: https://img.shields.io/pypi/v/nanaimo.svg
:alt: Pypi Release Version
.. _badge_pypi_version: https://pypi.org/project/nanaimo/
.. |badge_sonarcloud_quality| image:: https://sonarcloud.io/api/project_badges/measure?project=thirtytwobits_nanaimo&metric=alert_status
:alt: Sonarcloud Quality Gate
.. _badge_sonarcloud_quality: https://sonarcloud.io/dashboard?id=thirtytwobits_nanaimo
.. |badge_sonarcloud_coverage| image:: https://sonarcloud.io/api/project_badges/measure?project=thirtytwobits_nanaimo&metric=coverage
:alt: Sonarcloud coverage
.. _badge_sonarcloud_coverage: https://sonarcloud.io/dashboard?id=thirtytwobits_nanaimo
.. |badge_sonarcloud_bugs| image:: https://sonarcloud.io/api/project_badges/measure?project=thirtytwobits_nanaimo&metric=bugs
:alt: Sonarcloud bugs
.. _badge_sonarcloud_bugs: https://sonarcloud.io/dashboard?id=thirtytwobits_nanaimo
%package -n python3-nanaimo
Summary: Framework for automating tests involving hardware test fixtures.
Provides: python-nanaimo
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-nanaimo
############################################
Nanaimo: Hardware-In-the-Loop Unit Testing
############################################
|badge_docs|_ |badge_build|_ |badge_github_license|_ |badge_pypi_support|_ |badge_pypi_version|_ \
|badge_sonarcloud_quality|_ |badge_sonarcloud_coverage|_ |badge_sonarcloud_bugs|_
.. note::
Nanaimo is alpha software and will remain so until we bump its version to 1.0.0 or greater.
We will not knowingly break compatibility within a minor revision but we will break compatibility
a few more times between minor revisions until beta is declared. Because of this you should depend
on a minor version explicitly. For example ::
nanaimo ~= 0.1
.. figure:: https://thirtytwobits.github.io/nanaimo/static/images/nanaimo.png
:alt: A delicious Nanaimo bar
A delicious Python treat that makes on-target testing sweet and satisfying.
Nanaimo is a set of utilities and plugins designed to enable integration of hardware test apparatuses
with pytest. This can allow on-target tests to run as part of continuous integration pipelines like
`Buildkite`_, `Bamboo`_, or `Jenkins`_.
.. figure:: https://thirtytwobits.github.io/nanaimo/static/images/pifarm.jpeg
:alt: S32K evaluation boards attached to Raspberry PIs.
Example of S32K dev boards attached to Raspberry PI CI workers running the `Buildkite`_ agent and using Nanaimo.
Nanaimo is designed to enable testing of software-defined, physical components in isolation to
provide pre-integration verification of software interfaces and behavioral contracts. It adapts
asynchronous control and monitoring of these components to fit familiar testing idioms
(e.g. x-unit testing) using the popular python test framework, `pytest`_.
.. figure:: https://thirtytwobits.github.io/nanaimo/static/images/block.png
:alt: Block diagram of Nanaimo's relationship to other components of a typical software build and test pipeline.
Block diagram of Nanaimo's relationship to other components of a typical software build and test pipeline.
Nanaimo is *not* a simulation framework and is not designed to support the complexity of a full hardware-in-the-loop platform.
Instead it's focused on testing small integrations with a few hardware components and instruments using concepts, syntax,
and frameworks familiar to software engineers. Examples of these small integrations might include verifying a SPI driver for a
microcontroller or ensuring the upload time for a serial bootloader meets expected Key-Performance-Indicators (KPIs). To do this
Nanaimo abstractions provide async interfaces to hardware either directly using available communication protocols
(e.g. serial or IP networks) or by invoking a CLI provided by the instrument vendor. Because of this latter use case some
instruments will require additional programs be available in a test environment.
.. figure:: https://thirtytwobits.github.io/nanaimo/static/images/example.png
:alt: Example scenario using Nanaimo to test an I2C driver for a microcontroller.
Example scenario using Nanaimo to test an I2C driver for a microcontroller.
This design is an amalgam of the `TLYF`_ (Test Like You Fly) methodology and the `Swiss cheese`_ model of
failure analysis. Specifically; Nanaimo facilitates testing on actual or representative hardware
for the first integration of software into a part or subassembly. Traditionally software engineers were
responsible only for unit-testing and Software-In-the-Loop (SIL) simulation of their code. Nanaimo encourages
software engineers to also provide hardware integration tests by enabling Hardware-In-the-Loop
`continuous-integration <https://en.wikipedia.org/wiki/Continuous_integration>`_ (HIL-CI, perhaps?).
.. figure:: https://thirtytwobits.github.io/nanaimo/static/images/test_triangle.png
:alt: Hierarchy of system testing.
Hierarchy of system testing. Nanaimo focuses on part and subassembly testing.
.. Note::
Nanaimo is named after `Nanaimo bars`_ which are about the best things humans have ever invented.
.. _`Nanaimo bars`: https://en.wikipedia.org/wiki/Nanaimo_bar
.. _`Buildkite`: https://buildkite.com
.. _`Bamboo`: https://www.atlassian.com/software/bamboo
.. _`Jenkins`: https://jenkins.io/
.. _`pytest`: https://docs.pytest.org/en/latest/
.. _`TLYF`: https://www.youtube.com/watch?v=0BSaI117ITI
.. _`Swiss cheese`: https://en.wikipedia.org/wiki/Swiss_cheese_model
.. |badge_docs| image:: https://readthedocs.org/projects/nanaimo/badge/?version=latest
:alt: Documentation Status
.. _badge_docs: https://nanaimo.readthedocs.io/en/latest/?badge=latest
.. |badge_build| image:: https://badge.buildkite.com/80558e71a357a16151e4b537bfc19527c9b1ac543975b92ed7.svg
:alt: Build status
.. _badge_build: https://buildkite.com/friends-of-scott/nanaimo-release
.. |badge_github_license| image:: https://img.shields.io/badge/license-MIT-blue.svg
:alt: MIT license
.. _badge_github_license: https://github.com/thirtytwobits/nanaimo/blob/master/LICENSE.rst
.. |badge_pypi_support| image:: https://img.shields.io/pypi/pyversions/nanaimo.svg
:alt: Supported Python Versions
.. _badge_pypi_support: https://pypi.org/project/nanaimo/
.. |badge_pypi_version| image:: https://img.shields.io/pypi/v/nanaimo.svg
:alt: Pypi Release Version
.. _badge_pypi_version: https://pypi.org/project/nanaimo/
.. |badge_sonarcloud_quality| image:: https://sonarcloud.io/api/project_badges/measure?project=thirtytwobits_nanaimo&metric=alert_status
:alt: Sonarcloud Quality Gate
.. _badge_sonarcloud_quality: https://sonarcloud.io/dashboard?id=thirtytwobits_nanaimo
.. |badge_sonarcloud_coverage| image:: https://sonarcloud.io/api/project_badges/measure?project=thirtytwobits_nanaimo&metric=coverage
:alt: Sonarcloud coverage
.. _badge_sonarcloud_coverage: https://sonarcloud.io/dashboard?id=thirtytwobits_nanaimo
.. |badge_sonarcloud_bugs| image:: https://sonarcloud.io/api/project_badges/measure?project=thirtytwobits_nanaimo&metric=bugs
:alt: Sonarcloud bugs
.. _badge_sonarcloud_bugs: https://sonarcloud.io/dashboard?id=thirtytwobits_nanaimo
%package help
Summary: Development documents and examples for nanaimo
Provides: python3-nanaimo-doc
%description help
############################################
Nanaimo: Hardware-In-the-Loop Unit Testing
############################################
|badge_docs|_ |badge_build|_ |badge_github_license|_ |badge_pypi_support|_ |badge_pypi_version|_ \
|badge_sonarcloud_quality|_ |badge_sonarcloud_coverage|_ |badge_sonarcloud_bugs|_
.. note::
Nanaimo is alpha software and will remain so until we bump its version to 1.0.0 or greater.
We will not knowingly break compatibility within a minor revision but we will break compatibility
a few more times between minor revisions until beta is declared. Because of this you should depend
on a minor version explicitly. For example ::
nanaimo ~= 0.1
.. figure:: https://thirtytwobits.github.io/nanaimo/static/images/nanaimo.png
:alt: A delicious Nanaimo bar
A delicious Python treat that makes on-target testing sweet and satisfying.
Nanaimo is a set of utilities and plugins designed to enable integration of hardware test apparatuses
with pytest. This can allow on-target tests to run as part of continuous integration pipelines like
`Buildkite`_, `Bamboo`_, or `Jenkins`_.
.. figure:: https://thirtytwobits.github.io/nanaimo/static/images/pifarm.jpeg
:alt: S32K evaluation boards attached to Raspberry PIs.
Example of S32K dev boards attached to Raspberry PI CI workers running the `Buildkite`_ agent and using Nanaimo.
Nanaimo is designed to enable testing of software-defined, physical components in isolation to
provide pre-integration verification of software interfaces and behavioral contracts. It adapts
asynchronous control and monitoring of these components to fit familiar testing idioms
(e.g. x-unit testing) using the popular python test framework, `pytest`_.
.. figure:: https://thirtytwobits.github.io/nanaimo/static/images/block.png
:alt: Block diagram of Nanaimo's relationship to other components of a typical software build and test pipeline.
Block diagram of Nanaimo's relationship to other components of a typical software build and test pipeline.
Nanaimo is *not* a simulation framework and is not designed to support the complexity of a full hardware-in-the-loop platform.
Instead it's focused on testing small integrations with a few hardware components and instruments using concepts, syntax,
and frameworks familiar to software engineers. Examples of these small integrations might include verifying a SPI driver for a
microcontroller or ensuring the upload time for a serial bootloader meets expected Key-Performance-Indicators (KPIs). To do this
Nanaimo abstractions provide async interfaces to hardware either directly using available communication protocols
(e.g. serial or IP networks) or by invoking a CLI provided by the instrument vendor. Because of this latter use case some
instruments will require additional programs be available in a test environment.
.. figure:: https://thirtytwobits.github.io/nanaimo/static/images/example.png
:alt: Example scenario using Nanaimo to test an I2C driver for a microcontroller.
Example scenario using Nanaimo to test an I2C driver for a microcontroller.
This design is an amalgam of the `TLYF`_ (Test Like You Fly) methodology and the `Swiss cheese`_ model of
failure analysis. Specifically; Nanaimo facilitates testing on actual or representative hardware
for the first integration of software into a part or subassembly. Traditionally software engineers were
responsible only for unit-testing and Software-In-the-Loop (SIL) simulation of their code. Nanaimo encourages
software engineers to also provide hardware integration tests by enabling Hardware-In-the-Loop
`continuous-integration <https://en.wikipedia.org/wiki/Continuous_integration>`_ (HIL-CI, perhaps?).
.. figure:: https://thirtytwobits.github.io/nanaimo/static/images/test_triangle.png
:alt: Hierarchy of system testing.
Hierarchy of system testing. Nanaimo focuses on part and subassembly testing.
.. Note::
Nanaimo is named after `Nanaimo bars`_ which are about the best things humans have ever invented.
.. _`Nanaimo bars`: https://en.wikipedia.org/wiki/Nanaimo_bar
.. _`Buildkite`: https://buildkite.com
.. _`Bamboo`: https://www.atlassian.com/software/bamboo
.. _`Jenkins`: https://jenkins.io/
.. _`pytest`: https://docs.pytest.org/en/latest/
.. _`TLYF`: https://www.youtube.com/watch?v=0BSaI117ITI
.. _`Swiss cheese`: https://en.wikipedia.org/wiki/Swiss_cheese_model
.. |badge_docs| image:: https://readthedocs.org/projects/nanaimo/badge/?version=latest
:alt: Documentation Status
.. _badge_docs: https://nanaimo.readthedocs.io/en/latest/?badge=latest
.. |badge_build| image:: https://badge.buildkite.com/80558e71a357a16151e4b537bfc19527c9b1ac543975b92ed7.svg
:alt: Build status
.. _badge_build: https://buildkite.com/friends-of-scott/nanaimo-release
.. |badge_github_license| image:: https://img.shields.io/badge/license-MIT-blue.svg
:alt: MIT license
.. _badge_github_license: https://github.com/thirtytwobits/nanaimo/blob/master/LICENSE.rst
.. |badge_pypi_support| image:: https://img.shields.io/pypi/pyversions/nanaimo.svg
:alt: Supported Python Versions
.. _badge_pypi_support: https://pypi.org/project/nanaimo/
.. |badge_pypi_version| image:: https://img.shields.io/pypi/v/nanaimo.svg
:alt: Pypi Release Version
.. _badge_pypi_version: https://pypi.org/project/nanaimo/
.. |badge_sonarcloud_quality| image:: https://sonarcloud.io/api/project_badges/measure?project=thirtytwobits_nanaimo&metric=alert_status
:alt: Sonarcloud Quality Gate
.. _badge_sonarcloud_quality: https://sonarcloud.io/dashboard?id=thirtytwobits_nanaimo
.. |badge_sonarcloud_coverage| image:: https://sonarcloud.io/api/project_badges/measure?project=thirtytwobits_nanaimo&metric=coverage
:alt: Sonarcloud coverage
.. _badge_sonarcloud_coverage: https://sonarcloud.io/dashboard?id=thirtytwobits_nanaimo
.. |badge_sonarcloud_bugs| image:: https://sonarcloud.io/api/project_badges/measure?project=thirtytwobits_nanaimo&metric=bugs
:alt: Sonarcloud bugs
.. _badge_sonarcloud_bugs: https://sonarcloud.io/dashboard?id=thirtytwobits_nanaimo
%prep
%autosetup -n nanaimo-0.2.5
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-nanaimo -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Mon May 29 2023 Python_Bot <Python_Bot@openeuler.org> - 0.2.5-1
- Package Spec generated
|
