Skip to content

Commit 88deccb

Browse files
Update documentation according to the removal of the python testsuite
1 parent e1edc20 commit 88deccb

File tree

2 files changed

+8
-29
lines changed

2 files changed

+8
-29
lines changed

README.md

-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ Arduino CLI is an all-in-one solution that provides Boards/Library Managers, ske
66
and many other tools needed to use any Arduino compatible board and platform from command line or machine interfaces.
77

88
[![Test Go status](https://github.com/arduino/arduino-cli/actions/workflows/test-go-task.yml/badge.svg)](https://github.com/arduino/arduino-cli/actions/workflows/test-go-task.yml)
9-
[![Test Integration status](https://github.com/arduino/arduino-cli/actions/workflows/test-go-integration-task.yml/badge.svg)](https://github.com/arduino/arduino-cli/actions/workflows/test-go-integration-task.yml)
109
[![Publish Nightly Build status](https://github.com/arduino/arduino-cli/actions/workflows/publish-go-nightly-task.yml/badge.svg)](https://github.com/arduino/arduino-cli/actions/workflows/publish-go-nightly-task.yml)
1110
[![Deploy Website status](https://github.com/arduino/arduino-cli/actions/workflows/deploy-cobra-mkdocs-versioned-poetry.yml/badge.svg)](https://github.com/arduino/arduino-cli/actions/workflows/deploy-cobra-mkdocs-versioned-poetry.yml)
1211
[![Codecov](https://codecov.io/gh/arduino/arduino-cli/branch/main/graph/badge.svg)](https://codecov.io/gh/arduino/arduino-cli)

docs/CONTRIBUTING.md

+8-28
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,6 @@ To build the Arduino CLI from sources you need the following tools to be availab
7676
If you want to run integration tests you will also need:
7777

7878
- A serial port with an Arduino board attached
79-
- A working [Python][3] environment, version 3.8 or later
8079

8180
If you're working on the gRPC interface you will also have to:
8281

@@ -115,7 +114,7 @@ task go:test
115114
To run integration tests (these will take some time and require special setup, see following paragraph):
116115

117116
```shell
118-
task go:test-integration
117+
task go:integration-test
119118
```
120119

121120
#### Running only some tests
@@ -163,48 +162,29 @@ the above requirements.
163162

164163
##### Software requirements for running integration tests:
165164

166-
A working Python environment. Chances are that you already have Python installed in your system, if this is not the case
167-
you can [download][3] the official distribution or use the package manager provided by your Operating System.
168-
169-
Some dependencies need to be installed before running the tests and to avoid polluting your global Python environment
170-
with dependencies that might be only used by the Arduino CLI, to do so we use [Poetry][poetry-website]. First you need
171-
to install it (you might need to `sudo` the following command):
172-
173-
```shell
174-
pip3 install --user poetry
175-
```
176-
177-
For more installation options read the [official documentation][poetry-docs].
165+
A working Go environment. Chances are that you already have Go installed in your system, if this is not the case you can
166+
[download][1] the official distribution or use the package manager provided by your Operating System.
178167

179168
#### Running tests
180169

181170
After the software requirements have been installed you should be able to run the tests with:
182171

183172
```shell
184-
task go:test-integration
173+
task go:integration-test
185174
```
186175

187-
This will automatically install the necessary dependencies, if not already installed, and run the integration tests
188-
automatically.
176+
This will run the integration tests automatically.
189177

190-
To run specific modules you must run `pytest` from the virtual environment created by Poetry.
178+
To run specific packages you must run `go test`.
191179

192180
```shell
193-
poetry run pytest test/test_lib.py
181+
go test -v github.com/arduino/arduino-cli/internal/integrationtest/lib
194182
```
195183

196184
To run very specific test functions:
197185

198186
```shell
199-
poetry run pytest test/test_lib.py::test_list
200-
```
201-
202-
You can avoid writing the `poetry run` prefix each time by creating a new shell inside the virtual environment:
203-
204-
```shell
205-
poetry shell
206-
pytest test_lib.py
207-
pytest test_lib.py::test_list
187+
go test -v github.com/arduino/arduino-cli/internal/integrationtest/lib -run TestLibUpgradeCommand
208188
```
209189

210190
#### Linting and formatting

0 commit comments

Comments
 (0)