espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-18 08:29:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

[coap] add CoAP(s) block-wise transfer support to CoAP(s) client and server (#4247)

Browse Source 
Implemented CoAP/-s block-wise transfer according to RFC 7959. The
implementation includes methods and functions available to the
application layer to add Block1 and Block2 option values to a coap
message and an automatic block-wise transfer enabled by the compile
switch "COAP_BLOCK".
This commit is contained in:
Aurelio Schellenbaum
2021-01-26 13:27:32 -08:00
committed by GitHub
parent a3b5e370be
commit 02d6d49a5e
26 changed files with 2310 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/scripts/thread-cert/Makefile.am
+2
View File
@@ -154,6 +154,7 @@ EXTRA_DIST = \
test_coap.py \
test_coap_observe.py \
test_coaps.py \
test_coap_block.py \
test_common.py \
test_crypto.py \
test_diag.py \
@@ -205,6 +206,7 @@ check_SCRIPTS = \
test_coap.py \
test_coap_observe.py \
test_coaps.py \
test_coap_block.py \
test_common.py \
test_crypto.py \
test_diag.py \
tests/scripts/thread-cert/node.py
+44 -1
View File
@@ -1884,6 +1884,12 @@ class NodeImpl:
"""
return self._coap_rq('get', ipaddr, uri, con, payload)
def coap_get_block(self, ipaddr, uri, size=16, count=0):
"""
Send a GET request via CoAP.
"""
return self._coap_rq_block('get', ipaddr, uri, size, count)
def coap_observe(self, ipaddr, uri, con=False, payload=None):
"""
Send a GET request via CoAP with Observe set.
@@ -1896,12 +1902,24 @@ class NodeImpl:
"""
return self._coap_rq('post', ipaddr, uri, con, payload)
def coap_post_block(self, ipaddr, uri, size=16, count=0):
"""
Send a POST request via CoAP.
"""
return self._coap_rq_block('post', ipaddr, uri, size, count)
def coap_put(self, ipaddr, uri, con=False, payload=None):
"""
Send a PUT request via CoAP.
"""
return self._coap_rq('put', ipaddr, uri, con, payload)
def coap_put_block(self, ipaddr, uri, size=16, count=0):
"""
Send a PUT request via CoAP.
"""
return self._coap_rq_block('put', ipaddr, uri, size, count)
def _coap_rq(self, method, ipaddr, uri, con=False, payload=None):
"""
Issue a GET/POST/PUT/DELETE/GET OBSERVE request.
@@ -1918,6 +1936,20 @@ class NodeImpl:
self.send_command(cmd)
return self.coap_wait_response()
def _coap_rq_block(self, method, ipaddr, uri, size=16, count=0):
"""
Issue a GET/POST/PUT/DELETE/GET OBSERVE BLOCK request.
"""
cmd = 'coap %s %s %s' % (method, ipaddr, uri)
cmd += ' block-%d' % size
if count is not 0:
cmd += ' %d' % count
self.send_command(cmd)
return self.coap_wait_response()
def coap_wait_response(self):
"""
Wait for a CoAP response, and return it.
@@ -1938,7 +1970,10 @@ class NodeImpl:
observe = int(observe, base=10)
if payload is not None:
payload = binascii.a2b_hex(payload).decode('UTF-8')
try:
payload = binascii.a2b_hex(payload).decode('UTF-8')
except UnicodeDecodeError:
pass
# Return the values received
return dict(source=source, observe=observe, payload=payload)
@@ -2004,6 +2039,14 @@ class NodeImpl:
self.send_command(cmd)
self._expect_done()
def coap_set_resource_path_block(self, path, count=0):
"""
Set the path for the CoAP resource and how many blocks can be received from this resource.
"""
cmd = 'coap resource %s %d' % (path, count)
self.send_command(cmd)
self._expect('Done')
def coap_set_content(self, content):
"""
Set the content of the CoAP resource.
tests/scripts/thread-cert/test_coap_block.py
Executable
+134
View File
@@ -0,0 +1,134 @@
#!/usr/bin/env python3
#
# Copyright (c) 2020, The OpenThread Authors.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# 3. Neither the name of the copyright holder nor the
# names of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
import unittest
import pexpect
import config
import thread_cert
LEADER = 1
ROUTER = 2
class TestCoapBlockTransfer(thread_cert.TestCase):
"""
Test suite for CoAP Block-Wise Transfers (RFC7959).
"""
SUPPORT_NCP = False
TOPOLOGY = {
LEADER: {
'mode': 'rdn',
'panid': 0xface,
'whitelist': [ROUTER]
},
ROUTER: {
'mode': 'rdn',
'panid': 0xface,
'router_selection_jitter': 1,
'whitelist': [LEADER]
},
}
def _do_transfer_test(self, method):
self.nodes[LEADER].start()
self.simulator.go(5)
self.assertEqual(self.nodes[LEADER].get_state(), 'leader')
self.nodes[ROUTER].start()
self.simulator.go(5)
self.assertEqual(self.nodes[ROUTER].get_state(), 'router')
mleid = self.nodes[LEADER].get_ip6_address(config.ADDRESS_TYPE.ML_EID)
self.nodes[LEADER].coap_start()
self.nodes[LEADER].coap_set_resource_path_block('test', 10)
self.nodes[ROUTER].coap_start()
if method == 'GET':
response = self.nodes[ROUTER].coap_get_block(mleid, 'test', size=32)
response_payload = response['payload']
self.assertIsNotNone(response_payload)
if method == 'PUT':
self.nodes[ROUTER].coap_put_block(mleid, 'test', size=256, count=2)
request = self.nodes[ROUTER].coap_wait_request()
request_payload = request['payload']
self.assertIsNotNone(request_payload)
if method == 'POST':
self.nodes[ROUTER].coap_post_block(mleid, 'test', size=1024, count=2)
request = self.nodes[ROUTER].coap_wait_request()
request_payload = request['payload']
self.assertIsNotNone(request_payload)
self.simulator.go(10)
self.nodes[ROUTER].coap_stop()
self.nodes[LEADER].coap_stop()
def test_get(self):
"""
Test block-wise transfer using GET method.
"""
for trial in range(0, 3):
try:
self._do_transfer_test(method='GET')
break
except (AssertionError, pexpect.exceptions.TIMEOUT):
continue
def test_put(self):
"""
Test block-wise transfer using PUT method.
"""
for trial in range(0, 3):
try:
self._do_transfer_test(method='PUT')
break
except (AssertionError, pexpect.exceptions.TIMEOUT):
continue
def test_post(self):
"""
Test block-wise transfer using POST method.
"""
for trial in range(0, 3):
try:
self._do_transfer_test(method='POST')
break
except (AssertionError, pexpect.exceptions.TIMEOUT):
continue
if __name__ == '__main__':
unittest.main()