Skip to content

Commit b5c6634

Browse files
per1234Roberto Sora
and
Roberto Sora
authored
[skip changelog] Document full hardware requirements and effects of running integration tests (#785)
* Document full hardware requirements and effects of running integration tests Previously, the full hardware requirements of the integration tests were not documented and no mention was made of what the tests do to all hardware meeting those requirements. * Update docs re: Python version for integration tests Co-authored-by: Roberto Sora <r.sora@arduino.cc> Co-authored-by: Roberto Sora <r.sora@arduino.cc>
1 parent 860d1df commit b5c6634

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

docs/CONTRIBUTING.md

+17-4
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ available in your local environment:
4040

4141
If you want to run integration tests you will also need:
4242

43-
* A serial port with an Arduino device attached
44-
* A working [Python][3] environment, version 3.5 or later
43+
* A serial port with an Arduino board attached
44+
* A working [Python][3] environment, version 3.8 or later
4545

4646
If you're working on the gRPC interface you will also have to:
4747

@@ -115,8 +115,21 @@ For these reasons, in addition to regular unit tests the project has a suite of
115115
integration tests that actually run Arduino CLI in a different process and
116116
assess the options are correctly understood and the output is what we expect.
117117

118-
To run the full suite of integration tests you need an Arduino device attached
119-
to a serial port and a working Python environment. Chances are that you already
118+
#### Hardware requirements for running the full suite of integration tests:
119+
120+
An Arduino board attached to a serial port. The board must:
121+
122+
* Use one of the VID/PID pairs used by Arduino or their partners (as is the case
123+
with all modern official Arduino boards except the classic Nano).
124+
* Accept uploads using the FQBN associated with that VID/PID (which will be the
125+
case unless you have installed a custom bootloader or removed the bootloader).
126+
127+
Note that running the integration tests will result in a sketch being uploaded
128+
to every attached Arduino board meeting the above requirements.
129+
130+
#### Software requirements for running integration tests:
131+
132+
A working Python environment. Chances are that you already
120133
have Python installed in your system, if this is not the case you can
121134
[download][3] the official distribution or use the package manager provided by
122135
your Operating System.

0 commit comments

Comments
 (0)