Skip to content

Commit

Permalink
Merge branch 'feature/add_ot_CI' into 'master'
Browse files Browse the repository at this point in the history
openthread: add openthread CI

See merge request espressif/esp-idf!19744
  • Loading branch information
chshu committed Sep 19, 2022
2 parents d9d646f + 07ebc52 commit 96b73d3
Show file tree
Hide file tree
Showing 12 changed files with 516 additions and 1 deletion.
8 changes: 8 additions & 0 deletions .gitlab/ci/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,14 @@ build_pytest_examples_esp32c2:
IDF_TARGET: esp32c2
TEST_DIR: examples

build_pytest_examples_esp32h2:
extends:
- .build_pytest_template
- .rules:build:example_test-esp32h2
variables:
IDF_TARGET: esp32h2
TEST_DIR: examples

build_pytest_components_esp32:
extends:
- .build_pytest_template
Expand Down
13 changes: 13 additions & 0 deletions .gitlab/ci/dependencies/dependencies.yml
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,19 @@ build:integration_test:
- "build:example_test"
- build:target_test

# For i154 runners
"test:example_test-i154":
patterns:
- "target_test-i154"
labels:
- target_test
- example_test
included_in:
- "build:example_test-esp32h2"
- "build:example_test-esp32s3"
- "build:example_test"
- build:target_test

# due to the lack of runners, c2 tests will only be triggered by label
"test:{0}-esp32c2":
matrix:
Expand Down
28 changes: 28 additions & 0 deletions .gitlab/ci/rules.yml
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,14 @@

- "components/**/*"

.patterns-target_test-i154: &patterns-target_test-i154
- "components/esp_netif/**/*"
- "components/esp_phy/**/*"
- "components/ieee802154/**/*"
- "components/lwip/**/*"
- "examples/common_components/iperf/**/*"
- "examples/openthread/**/*"

.patterns-integration_test: &patterns-integration_test
- "tools/ci/python_packages/gitlab_api.py"
- "tools/ci/integration_test/**/*"
Expand Down Expand Up @@ -842,6 +850,8 @@
changes: *patterns-example_test-usb
- <<: *if-dev-push
changes: *patterns-example_test-wifi
- <<: *if-dev-push
changes: *patterns-target_test-i154

.rules:build:example_test-esp32:
rules:
Expand Down Expand Up @@ -953,6 +963,8 @@
changes: *patterns-example_test-usb
- <<: *if-dev-push
changes: *patterns-example_test-wifi
- <<: *if-dev-push
changes: *patterns-target_test-i154

.rules:build:example_test-esp32s2:
rules:
Expand Down Expand Up @@ -1009,6 +1021,8 @@
changes: *patterns-example_test-usb
- <<: *if-dev-push
changes: *patterns-example_test-wifi
- <<: *if-dev-push
changes: *patterns-target_test-i154

.rules:build:integration_test:
rules:
Expand Down Expand Up @@ -1104,6 +1118,8 @@
changes: *patterns-example_test-wifi
- <<: *if-dev-push
changes: *patterns-integration_test
- <<: *if-dev-push
changes: *patterns-target_test-i154
- <<: *if-dev-push
changes: *patterns-unit_test
- <<: *if-dev-push
Expand Down Expand Up @@ -3021,6 +3037,18 @@
- <<: *if-dev-push
changes: *patterns-example_test-wifi

.rules:test:example_test-i154:
rules:
- <<: *if-revert-branch
when: never
- <<: *if-protected
- <<: *if-label-build-only
when: never
- <<: *if-label-example_test
- <<: *if-label-target_test
- <<: *if-dev-push
changes: *patterns-target_test-i154

.rules:test:host_test:
rules:
- <<: *if-revert-branch
Expand Down
11 changes: 11 additions & 0 deletions .gitlab/ci/target-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -428,6 +428,17 @@ component_ut_pytest_esp32c3_flash_multi:
- build_pytest_components_esp32c3
tags: [ esp32c3, flash_mutli ]

example_test_pytest_openthread_br:
extends:
- .pytest_examples_dir_template
- .rules:test:example_test-i154
needs:
- build_pytest_examples_esp32s3
- build_pytest_examples_esp32h2
tags:
- esp32h2
- i154_multi_dut

.pytest_test_apps_dir_template:
extends: .pytest_template
variables:
Expand Down
4 changes: 4 additions & 0 deletions examples/openthread/.build-test-rules.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ examples/openthread/ot_br:
- if: IDF_TARGET == "esp32c2"
temporary: true
reason: target esp32c2 is not supported yet
disable_test:
- if: IDF_TARGET in ["esp32", "esp32c3", "esp32s2"]
temporary: true
reason: only test on esp32s3

examples/openthread/ot_cli:
enable:
Expand Down
Empty file.
1 change: 0 additions & 1 deletion examples/openthread/ot_br/sdkconfig.defaults
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ CONFIG_PARTITION_TABLE_MD5=y
#
# mbedTLS
#

CONFIG_MBEDTLS_CMAC_C=y
CONFIG_MBEDTLS_SSL_PROTO_DTLS=y
CONFIG_MBEDTLS_KEY_EXCHANGE_ECJPAKE=y
Expand Down
222 changes: 222 additions & 0 deletions examples/openthread/ot_ci_function.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,222 @@
# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
# SPDX-License-Identifier: Unlicense OR CC0-1.0
# !/usr/bin/env python3
# this file defines some functions for testing cli and br under pytest framework

import re
import subprocess
import time
from typing import Tuple, Union

import netifaces
import pexpect
from pytest_embedded_idf.dut import IdfDut


def reset_thread(dut:IdfDut) -> None:
time.sleep(1)
dut.write('factoryreset')
time.sleep(3)
dut.expect('OpenThread attached to netif', timeout=10)
dut.write(' ')
dut.write('state')


# config thread
def config_thread(dut:IdfDut, model:str, dataset:str='0') -> Union[str, None]:
if model == 'random':
dut.write('dataset init new')
dut.expect('Done', timeout=2)
dut.write('dataset commit active')
dut.expect('Done', timeout=2)
dut.write('ifconfig up')
dut.expect('Done', timeout=2)
dut.write('dataset active -x') # get dataset
dut_data = dut.expect(r'\n(\w{212})\r', timeout=5)[1].decode()
return str(dut_data)
if model == 'appointed':
tmp = 'dataset set active ' + str(dataset)
dut.write(tmp)
dut.expect('Done', timeout=2)
dut.write('ifconfig up')
dut.expect('Done', timeout=2)
return None
return None


# get the mleid address of the thread
def get_mleid_addr(dut:IdfDut) -> str:
dut_adress = ''
clean_buffer(dut)
dut.write('ipaddr mleid')
dut_adress = dut.expect(r'\n((?:\w+:){7}\w+)\r', timeout=5)[1].decode()
return dut_adress


# get the rloc address of the thread
def get_rloc_addr(dut:IdfDut) -> str:
dut_adress = ''
clean_buffer(dut)
dut.write('ipaddr rloc')
dut_adress = dut.expect(r'\n((?:\w+:){7}\w+)\r', timeout=5)[1].decode()
return dut_adress


# get the linklocal address of the thread
def get_linklocal_addr(dut:IdfDut) -> str:
dut_adress = ''
clean_buffer(dut)
dut.write('ipaddr linklocal')
dut_adress = dut.expect(r'\n((?:\w+:){7}\w+)\r', timeout=5)[1].decode()
return dut_adress


# get the global unicast address of the thread:
def get_global_unicast_addr(dut:IdfDut, br:IdfDut) -> str:
dut_adress = ''
clean_buffer(br)
br.write('br omrprefix')
omrprefix = br.expect(r'\n((?:\w+:){4}):/\d+\r', timeout=5)[1].decode()
clean_buffer(dut)
dut.write('ipaddr')
dut_adress = dut.expect(r'(%s(?:\w+:){3}\w+)\r' % str(omrprefix), timeout=5)[1].decode()
return dut_adress


# start thread
def start_thread(dut:IdfDut) -> str:
role = ''
dut.write('thread start')
tmp = dut.expect(r'Role detached -> (\w+)\W', timeout=20)[0]
role = re.findall(r'Role detached -> (\w+)\W', str(tmp))[0]
return role


# config br and cli manually
def form_network_using_manual_configuration(leader:IdfDut, child:IdfDut, leader_name:str, thread_dataset_model:str,
thread_dataset:str, wifi:IdfDut, wifi_ssid:str, wifi_psk:str) -> str:
time.sleep(3)
leader.expect('OpenThread attached to netif', timeout=10)
leader.write(' ')
leader.write('state')
child.expect('OpenThread attached to netif', timeout=10)
child.write(' ')
child.write('state')
reset_thread(leader)
reset_thread(child)
leader.write('channel 12')
leader.expect('Done', timeout=2)
child.write('channel 12')
child.expect('Done', timeout=2)
res = '0000'
if wifi_psk != '0000':
res = connect_wifi(wifi, wifi_ssid, wifi_psk, 10)[0]
leader_data = ''
if thread_dataset_model == 'random':
leader_data = str(config_thread(leader, 'random'))
else:
config_thread(leader, 'appointed', thread_dataset)
if leader_name == 'br':
leader.write('bbr enable')
leader.expect('Done', timeout=2)
role = start_thread(leader)
assert role == 'leader'
if thread_dataset_model == 'random':
config_thread(child, 'appointed', leader_data)
else:
config_thread(child, 'appointed', thread_dataset)
if leader_name != 'br':
child.write('bbr enable')
child.expect('Done', timeout=2)
role = start_thread(child)
assert role == 'child'
return res


# ping of thread
def ot_ping(dut:IdfDut, target:str, times:int) -> Tuple[int, int]:
command = 'ping ' + str(target) + ' 0 ' + str(times)
dut.write(command)
transmitted = dut.expect(r'(\d+) packets transmitted', timeout=30)[1].decode()
tx_count = int(transmitted)
received = dut.expect(r'(\d+) packets received', timeout=30)[1].decode()
rx_count = int(received)
return tx_count, rx_count


# connect Wi-Fi
def connect_wifi(dut:IdfDut, ssid:str, psk:str, nums:int) -> Tuple[str, int]:
clean_buffer(dut)
ip_address = ''
information = ''
for order in range(1, nums):
dut.write('wifi connect -s ' + str(ssid) + ' -p ' + str(psk))
tmp = dut.expect(pexpect.TIMEOUT, timeout=5)
ip_address = re.findall(r'sta ip: (\w+.\w+.\w+.\w+),', str(tmp))[0]
information = dut.expect(r'wifi sta (\w+ \w+ \w+)\W', timeout=5)[1].decode()
if information == 'is connected successfully':
break
assert information == 'is connected successfully'
return ip_address, order


def reset_host_interface() -> None:
interface_name = get_host_interface_name()
flag = False
try:
command = 'ifconfig ' + interface_name + ' down'
subprocess.call(command, shell=True, timeout=5)
time.sleep(10)
command = 'ifconfig ' + interface_name + ' up'
subprocess.call(command, shell=True, timeout=10)
time.sleep(20)
flag = True
finally:
time.sleep(10)
assert flag


def set_interface_sysctl_options() -> None:
interface_name = get_host_interface_name()
flag = False
try:
command = 'sysctl -w net/ipv6/conf/' + interface_name + '/accept_ra=2'
subprocess.call(command, shell=True, timeout=5)
time.sleep(1)
command = 'sysctl -w net/ipv6/conf/' + interface_name + '/accept_ra_rt_info_max_plen=128'
subprocess.call(command, shell=True, timeout=5)
time.sleep(5)
flag = True
finally:
time.sleep(5)
assert flag


def init_interface_ipv6_address() -> None:
interface_name = get_host_interface_name()
flag = False
try:
command = 'ip -6 route | grep ' + interface_name + " | grep ra | awk {'print $1'} | xargs -I {} ip -6 route del {}"
subprocess.call(command, shell=True, timeout=5)
time.sleep(0.5)
subprocess.call(command, shell=True, timeout=5)
time.sleep(1)
command = 'ip -6 address show dev ' + interface_name + \
" scope global | grep 'inet6' | awk {'print $2'} | xargs -I {} ip -6 addr del {} dev " + interface_name
subprocess.call(command, shell=True, timeout=5)
time.sleep(1)
flag = True
finally:
time.sleep(5)
assert flag


def get_host_interface_name() -> str:
interfaces = netifaces.interfaces()
interface_name = [s for s in interfaces if 'wl' in s][0]
return str(interface_name)


def clean_buffer(dut:IdfDut) -> None:
str_length = str(len(dut.expect(pexpect.TIMEOUT, timeout=0.1)))
dut.expect(r'[\s\S]{%s}' % str(str_length), timeout=10)
3 changes: 3 additions & 0 deletions examples/openthread/ot_cli/sdkconfig.ci.cli
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
CONFIG_IDF_TARGET="esp32h2"
CONFIG_IDF_TARGET_ESP32H2=y
CONFIG_IDF_TARGET_ESP32H2_BETA_VERSION_2=y
3 changes: 3 additions & 0 deletions examples/openthread/ot_rcp/sdkconfig.ci.rcp
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
CONFIG_OPENTHREAD_UART_PIN_MANUAL=y
CONFIG_OPENTHREAD_UART_RX_PIN=4
CONFIG_OPENTHREAD_UART_TX_PIN=5

0 comments on commit 96b73d3

Please sign in to comment.