dendi-wang/thingsboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #9073 from ShvaykaD/bugfix/feature-type-handling-for-coap-dtls

Browse Source 
fix CoAP over DTLS feature type handling for server-side rpc response
This commit is contained in:
Andrew Shvayka 2023-08-14 14:52:20 +03:00 committed by GitHub
commit c978ed6748
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 169 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
common/transport/coap/src/main/java/org/thingsboard/server/transport/coap/CoapTransportResource.java
View File

@ -30,6 +30,7 @@ import org.thingsboard.server.coapserver.TbCoapDtlsSessionInfo;
import org.thingsboard.server.common.data.DataConstants;
import org.thingsboard.server.common.data.DeviceProfile;
import org.thingsboard.server.common.data.DeviceTransportType;
import org.thingsboard.server.common.data.StringUtils;
import org.thingsboard.server.common.data.TransportPayloadType;
import org.thingsboard.server.common.data.security.DeviceTokenCredentials;
import org.thingsboard.server.common.msg.session.FeatureType;
@ -379,12 +380,16 @@ public class CoapTransportResource extends AbstractCoapTransportResource {
}
}
private Optional<FeatureType> getFeatureType(Request request) {
protected Optional<FeatureType> getFeatureType(Request request) {
List<String> uriPath = request.getOptions().getUriPath();
try {
if (uriPath.size() >= FEATURE_TYPE_POSITION) {
int size = uriPath.size();
if (size >= FEATURE_TYPE_POSITION) {
if (size == FEATURE_TYPE_POSITION && StringUtils.isNumeric(uriPath.get(size - 1))) {
return Optional.of(FeatureType.valueOf(uriPath.get(FEATURE_TYPE_POSITION - 2).toUpperCase()));
}
return Optional.of(FeatureType.valueOf(uriPath.get(FEATURE_TYPE_POSITION - 1).toUpperCase()));
} else if (uriPath.size() >= FEATURE_TYPE_POSITION_CERTIFICATE_REQUEST) {
} else if (size == FEATURE_TYPE_POSITION_CERTIFICATE_REQUEST) {
if (uriPath.contains(DataConstants.PROVISION)) {
return Optional.of(FeatureType.valueOf(DataConstants.PROVISION.toUpperCase()));
}

161
common/transport/coap/src/test/java/org/thingsboard/server/transport/coap/CoapTransportResourceTest.java Normal file
View File

@ -0,0 +1,161 @@
/**
* Copyright © 2016-2023 The Thingsboard Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.thingsboard.server.transport.coap;
import org.eclipse.californium.core.coap.CoAP;
import org.eclipse.californium.core.coap.OptionSet;
import org.eclipse.californium.core.coap.Request;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.thingsboard.server.coapserver.CoapServerService;
import org.thingsboard.server.common.data.StringUtils;
import org.thingsboard.server.common.msg.session.FeatureType;
import org.thingsboard.server.common.transport.TransportService;
import org.thingsboard.server.queue.scheduler.SchedulerComponent;
import org.thingsboard.server.transport.coap.client.CoapClientContext;
import java.util.Random;
import java.util.stream.Stream;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
class CoapTransportResourceTest {
private static final String V1 = "v1";
private static final String API = "api";
private static final String TELEMETRY = "telemetry";
private static final String ATTRIBUTES = "attributes";
private static final String RPC = "rpc";
private static final String CLAIM = "claim";
private static final String PROVISION = "provision";
private static final String GET_ATTRIBUTES_URI_QUERY = "clientKeys=attribute1,attribute2&sharedKeys=shared1,shared2";
private static final Random RANDOM = new Random();
private static CoapTransportResource coapTransportResource;
@BeforeAll
static void setUp() {
var ctxMock = mock(CoapTransportContext.class);
var coapServerServiceMock = mock(CoapServerService.class);
var transportServiceMock = mock(TransportService.class);
var clientContextMock = mock(CoapClientContext.class);
var schedulerComponentMock = mock(SchedulerComponent.class);
when(ctxMock.getTransportService()).thenReturn(transportServiceMock);
when(ctxMock.getClientContext()).thenReturn(clientContextMock);
when(ctxMock.getSessionReportTimeout()).thenReturn(1L);
when(ctxMock.getScheduler()).thenReturn(schedulerComponentMock);
coapTransportResource = new CoapTransportResource(ctxMock, coapServerServiceMock, V1);
}
@ParameterizedTest
@MethodSource("provideRequestAndFeatureType")
void givenRequest_whenGetFeatureType_thenReturnedExpectedFeatureType(Request request, FeatureType expectedFeatureType) {
var featureTypeOptional = coapTransportResource.getFeatureType(request);
assertTrue(featureTypeOptional.isPresent(), "Optional<FeatureType> is empty");
assertEquals(expectedFeatureType, featureTypeOptional.get(), "Feature type is invalid");
}
static Stream<Arguments> provideRequestAndFeatureType() {
return Stream.of(
// accessToken based tests
Arguments.of(toAccessTokenRequest(CoAP.Code.POST, TELEMETRY), FeatureType.TELEMETRY),
Arguments.of(toAccessTokenRequest(CoAP.Code.POST, ATTRIBUTES), FeatureType.ATTRIBUTES),
Arguments.of(toGetAttributesAccessTokenRequest(), FeatureType.ATTRIBUTES),
Arguments.of(toAccessTokenRequest(CoAP.Code.GET, ATTRIBUTES), FeatureType.ATTRIBUTES),
Arguments.of(toAccessTokenRequest(CoAP.Code.GET, RPC), FeatureType.RPC),
Arguments.of(toRpcResponseAccessTokenRequest(), FeatureType.RPC),
Arguments.of(toAccessTokenRequest(CoAP.Code.POST, RPC), FeatureType.RPC),
Arguments.of(toAccessTokenRequest(CoAP.Code.POST, CLAIM), FeatureType.CLAIM),
// certificate based tests
Arguments.of(toCertificateRequest(CoAP.Code.POST, TELEMETRY), FeatureType.TELEMETRY),
Arguments.of(toCertificateRequest(CoAP.Code.POST, ATTRIBUTES), FeatureType.ATTRIBUTES),
Arguments.of(toGetAttributesCertificateRequest(), FeatureType.ATTRIBUTES),
Arguments.of(toCertificateRequest(CoAP.Code.GET, ATTRIBUTES), FeatureType.ATTRIBUTES),
Arguments.of(toCertificateRequest(CoAP.Code.GET, RPC), FeatureType.RPC),
Arguments.of(toRpcResponseCertificateRequest(), FeatureType.RPC),
Arguments.of(toCertificateRequest(CoAP.Code.POST, RPC), FeatureType.RPC),
Arguments.of(toCertificateRequest(CoAP.Code.POST, CLAIM), FeatureType.CLAIM),
// provision request
Arguments.of(toProvisionRequest(), FeatureType.PROVISION)
);
}
private static Request toAccessTokenRequest(CoAP.Code method, String featureType) {
return getAccessTokenRequest(method, featureType, null, null);
}
private static Request toGetAttributesAccessTokenRequest() {
return getAccessTokenRequest(CoAP.Code.GET, CoapTransportResourceTest.ATTRIBUTES, null, CoapTransportResourceTest.GET_ATTRIBUTES_URI_QUERY);
}
private static Request toRpcResponseAccessTokenRequest() {
return getAccessTokenRequest(CoAP.Code.POST, CoapTransportResourceTest.RPC, RANDOM.nextInt(100), null);
}
private static Request toCertificateRequest(CoAP.Code method, String featureType) {
return getCertificateRequest(method, featureType, null, null);
}
private static Request toGetAttributesCertificateRequest() {
return getCertificateRequest(CoAP.Code.GET, CoapTransportResourceTest.ATTRIBUTES, null, CoapTransportResourceTest.GET_ATTRIBUTES_URI_QUERY);
}
private static Request toRpcResponseCertificateRequest() {
return getCertificateRequest(CoAP.Code.POST, CoapTransportResourceTest.RPC, RANDOM.nextInt(100), null);
}
private static Request getAccessTokenRequest(CoAP.Code method, String featureType, Integer requestId, String uriQuery) {
return getRequest(method, featureType, false, requestId, uriQuery);
}
private static Request getCertificateRequest(CoAP.Code method, String featureType, Integer requestId, String uriQuery) {
return getRequest(method, featureType, true, requestId, uriQuery);
}
private static Request toProvisionRequest() {
return getRequest(CoAP.Code.POST, PROVISION, true, null, null);
}
private static Request getRequest(CoAP.Code method, String featureType, boolean dtls, Integer requestId, String uriQuery) {
var request = new Request(method);
var options = new OptionSet();
options.addUriPath(API);
options.addUriPath(V1);
if (!dtls) {
options.addUriPath(StringUtils.randomAlphanumeric(20));
}
options.addUriPath(featureType);
if (requestId != null) {
options.addUriPath(String.valueOf(requestId));
}
if (uriQuery != null) {
options.setUriQuery(uriQuery);
}
request.setOptions(options);
return request;
}
}