README.md (#2)

* rewrite the README.md

* minor fixes README.md

* fix todo-list README.md

* Update README.md

Co-authored-by: Igor Pečovnik <igorpecovnik@users.noreply.github.com>
This commit is contained in:
Reto
2020-03-22 22:34:25 +01:00
committed by GitHub
parent 7cc7e36894
commit cb613370d5

View File

@@ -2,33 +2,69 @@
Collection of basic auto tests
# How to start?
# TL;DR
Script can be installed on any Debian based Linux device on your network. Adapt the configuration-file to your requirements, start the test procedure and wait until its done. Check the logs/ for errors and summary in /reports
1. Clone sources and go inside folder autotests
## Privacy concerns
It runs locally in your network, no data is sent anywhere. Icons come from the internet.
# Getting started
Clone, edit userconfig/configuration.sh and run the script. Script will scan your local network (if SUBNET is defined) otherwise it will cycle on IPs you have defined in HOSTS variable.
It will create logins based on the configuration file and run different tests/ to see if the board is working properly. You can start with predefined credentials or use your own.
All you need to do is configure the configuration file, hook up the power and network cable and you are ready for running the test.
That's it.
## Prerequisites
Download the latest armbian image for your board(s). We recommend to use .torrent because this does the file integrity check for you automatically. [Write the data to the SDcard](https://docs.armbian.com/User-Guide_Getting-Started/#how-to-prepare-a-sd-card)
Put the SDcard into your device, power it up and let it sit for 1-2 minutes, to do the standard initial setup.
## Prepare your system
1. Go to a folder where you want to store it. The following command will create a folder called 'autotests'. Clone the sources from Github and open the folder autotests:
```
apt install git
git clone https://github.com/armbian/autotests
cd autotests
./go.sh
```
2. Edit `lib/configuration.sh`
- change number of passes (optional)
- change stress time in seconds (optional)
2. Edit userconfig/configuration.sh
What is your device(s) IP-Address or do you have a dedicated subnet for your devices.
To find the device, check your router or use [this tool](http://angryip.org/), to find your boards IP-Address(es).
- set IP-Address (HOSTS) or Subnet (Examle: 192.168.0.1/24)
- set WLAN_SSID and password (2,4 and/or 5,0GHz)
- set BLUEDEV MAC-Address of a Blueooth device (Android phone for example)
- set wlan SSID/password
- set test subnet or IP address(s)
- set MAC address of your BT device (Android phone for example)
- change numer of passes (optional)
- change stress time in seconds (optional)
3. Run:
How to find the Bluetooth MAC-Address on your mobile or Linux device with BT? Put your phone's BT to discoverable mode and run:
`hcitool scan`
on a Linux computer that has a BT-Dongle. On an Android device you find the MAC-Address in the phones settings/about the phone/Status.
3. Run :+1: :
The script will display which board gets tested
```
./go.sh
```
4. Once finished, go to `/autotests/logs` and check latest report.`
# What this tool does?
Connects to host(s) or all Armbian hosts in your subnet and run tests found in tests in alphabetical order.
It Connects to the host(s) or all Armbian hosts in your subnet and runs the tests found in folder tests in alphabetical order.
One test cycle:
Example of one test cycle:
[ o.k. ] Host x.x.x.x found [ Run 1 out of 1 ]
[ o.k. ] 0001-connect-wireless-devices-on-2.4Ghz.bash [ Tinkerboard @ x.x.x.x ]
@@ -36,9 +72,6 @@ One test cycle:
[ o.k. ] ... [ wlxxxxxxxxxxxxx ]
[ o.k. ] ... [ wlxxxxxxxxxxxxx ]
[ o.k. ] ... [ wlxxxxxxxxxxxxx ]
[ o.k. ] ... [ wlxxxxxxxxxxxxx ]
[ o.k. ] ... [ wlxxxxxxxxxxxxx ]
[ o.k. ] ... [ wlxxxxxxxxxxxxx ]
[ o.k. ] 0003-iperf-on-all-interfaces.bash [ Tinkerboard @ x.x.x.x ]
[ o.k. ] ..."eth0" ethernet (rk_gmac-dwmac), hw, mtu 1500 [ ~941 MBits/s ~944 MBits/s ]
[ o.k. ] ..."wlan0" wifi (rtl8723bs), hw, mtu 1500 [ ~50 MBits/s ]
@@ -53,9 +86,6 @@ One test cycle:
[ o.k. ] ... [ wlxxxxxxxxxxxxx ]
[ o.k. ] ... [ wlxxxxxxxxxxxxx ]
[ o.k. ] ... [ wlxxxxxxxxxxxxx ]
[ o.k. ] ... [ wlxxxxxxxxxxxxx ]
[ o.k. ] ... [ wlxxxxxxxxxxxxx ]
[ o.k. ] ... [ wlxxxxxxxxxxxxx ]
[ o.k. ] 0003-iperf-on-all-interfaces.bash [ Tinkerboard @ x.x.x.x ]
[ o.k. ] ..."eth0" ethernet (rk_gmac-dwmac), hw, mtu 1500 [ ~941 MBits/s ~944 MBits/s ]
[ o.k. ] ..."wlan0" wifi (rtl8723bs), hw, mtu 1500 [ ~22 MBits/s ]
@@ -89,11 +119,10 @@ One test cycle:
|9999-reboot.bash|Reboot the board|
To do:
- improve errors catching
- create XML data export for single board and together
- common data collecting
- support custom test board https://forum.armbian.com/topic/10841-the-testing-thread
## To do's:
- [ ] improve errors catching
- [ ] create XML data export for single board and together
- [ ] common data collecting
- [ ] support custom test board https://forum.armbian.com/topic/10841-the-testing-thread
![Semantic description of image](https://forum.armbian.com/uploads/monthly_2019_09/IMG_0031.thumb.JPG.25382da99ba09c22c27cf8d274141b8b.JPG "Image Title")