emqx/apps/emqx_gateway_coap/test/emqx_coap_api_SUITE.erl

264 lines
8.4 KiB
Erlang

%%--------------------------------------------------------------------
%% Copyright (c) 2020-2023 EMQ Technologies Co., Ltd. All Rights Reserved.
%%
%% 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.
%%--------------------------------------------------------------------
-module(emqx_coap_api_SUITE).
-compile(export_all).
-compile(nowarn_export_all).
-include("emqx_coap.hrl").
-include_lib("eunit/include/eunit.hrl").
-include_lib("common_test/include/ct.hrl").
-define(CONF_DEFAULT, <<
"\n"
"gateway.coap {\n"
" idle_timeout = 30s\n"
" enable_stats = false\n"
" mountpoint = \"\"\n"
" notify_type = qos\n"
" connection_required = true\n"
" subscribe_qos = qos1\n"
" publish_qos = qos1\n"
" listeners.udp.default {\n"
" bind = 5683\n"
" }\n"
"}\n"
>>).
-define(HOST, "127.0.0.1").
-define(PORT, 5683).
-define(CONN_URI,
"coap://127.0.0.1/mqtt/connection?clientid=client1&"
"username=admin&password=public"
).
-define(LOGT(Format, Args), ct:pal("TEST_SUITE: " ++ Format, Args)).
%%--------------------------------------------------------------------
%% Setups
%%--------------------------------------------------------------------
all() ->
emqx_common_test_helpers:all(?MODULE).
init_per_suite(Config) ->
application:load(emqx_gateway_coap),
Apps = emqx_cth_suite:start(
[
{emqx_conf, ?CONF_DEFAULT},
emqx_gateway,
emqx_auth,
emqx_management,
{emqx_dashboard, "dashboard.listeners.http { enable = true, bind = 18083 }"}
],
#{work_dir => emqx_cth_suite:work_dir(Config)}
),
_ = emqx_common_test_http:create_default_app(),
[{suite_apps, Apps} | Config].
end_per_suite(Config) ->
emqx_cth_suite:stop(?config(suite_apps, Config)),
emqx_config:delete_override_conf_files().
%%--------------------------------------------------------------------
%% Cases
%%--------------------------------------------------------------------
t_send_request_api(_) ->
ClientId = start_client(),
timer:sleep(200),
Test = fun(API) ->
Path = emqx_mgmt_api_test_util:api_path([API]),
Token = <<"atoken">>,
Payload = <<"simple echo this">>,
Req = #{
token => Token,
payload => Payload,
timeout => <<"10s">>,
content_type => <<"text/plain">>,
method => <<"get">>
},
Auth = emqx_mgmt_api_test_util:auth_header_(),
{ok, Response} = emqx_mgmt_api_test_util:request_api(
post,
Path,
"method=get",
Auth,
Req
),
#{<<"token">> := RToken, <<"payload">> := RPayload} =
emqx_utils_json:decode(Response, [return_maps]),
?assertEqual(Token, RToken),
?assertEqual(Payload, RPayload)
end,
Test("gateways/coap/clients/client1/request"),
erlang:exit(ClientId, kill),
ok.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Internal Functions
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
start_client() ->
spawn(fun coap_client/0).
coap_client() ->
{ok, CSock} = gen_udp:open(0, [binary, {active, false}]),
test_send_coap_request(CSock, post, <<>>, [], 1),
Response = test_recv_coap_response(CSock),
?assertEqual({ok, created}, Response#coap_message.method),
echo_loop(CSock).
echo_loop(CSock) ->
#coap_message{payload = Payload} = Req = test_recv_coap_request(CSock),
test_send_coap_response(CSock, ?HOST, ?PORT, {ok, content}, Payload, Req),
echo_loop(CSock).
test_send_coap_request(UdpSock, Method, Content, Options, MsgId) ->
is_list(Options) orelse error("Options must be a list"),
case resolve_uri(?CONN_URI) of
{coap, {IpAddr, Port}, Path, Query} ->
Request0 = emqx_coap_message:request(
con,
Method,
Content,
[
{uri_path, Path},
{uri_query, Query}
| Options
]
),
Request = Request0#coap_message{id = MsgId},
?LOGT("send_coap_request Request=~p", [Request]),
RequestBinary = emqx_coap_frame:serialize_pkt(Request, undefined),
?LOGT(
"test udp socket send to ~p:~p, data=~p",
[IpAddr, Port, RequestBinary]
),
ok = gen_udp:send(UdpSock, IpAddr, Port, RequestBinary);
{SchemeDiff, ChIdDiff, _, _} ->
error(
lists:flatten(
io_lib:format(
"scheme ~ts or ChId ~ts does not match with socket",
[SchemeDiff, ChIdDiff]
)
)
)
end.
test_recv_coap_response(UdpSock) ->
{ok, {Address, Port, Packet}} = gen_udp:recv(UdpSock, 0, 2000),
{ok, Response, _, _} = emqx_coap_frame:parse(Packet, undefined),
?LOGT(
"test udp receive from ~p:~p, data1=~p, Response=~p",
[Address, Port, Packet, Response]
),
#coap_message{
type = ack,
method = Method,
id = Id,
token = Token,
options = Options,
payload = Payload
} = Response,
?LOGT(
"receive coap response Method=~p, Id=~p, Token=~p, "
"Options=~p, Payload=~p",
[Method, Id, Token, Options, Payload]
),
Response.
test_recv_coap_request(UdpSock) ->
case gen_udp:recv(UdpSock, 0) of
{ok, {_Address, _Port, Packet}} ->
{ok, Request, _, _} = emqx_coap_frame:parse(Packet, undefined),
#coap_message{
type = con,
method = Method,
id = Id,
token = Token,
payload = Payload,
options = Options
} = Request,
?LOGT(
"receive coap request Method=~p, Id=~p, "
"Token=~p, Options=~p, Payload=~p",
[Method, Id, Token, Options, Payload]
),
Request;
{error, Reason} ->
?LOGT("test_recv_coap_request failed, Reason=~p", [Reason]),
timeout_test_recv_coap_request
end.
test_send_coap_response(UdpSock, Host, Port, Code, Content, Request) ->
is_list(Host) orelse error("Host is not a string"),
{ok, IpAddr} = inet:getaddr(Host, inet),
Response = emqx_coap_message:piggyback(Code, Content, Request),
?LOGT("test_send_coap_response Response=~p", [Response]),
Binary = emqx_coap_frame:serialize_pkt(Response, undefined),
ok = gen_udp:send(UdpSock, IpAddr, Port, Binary).
resolve_uri(Uri) ->
{ok,
#{
scheme := Scheme,
host := Host,
port := PortNo,
path := Path
} = URIMap} = emqx_http_lib:uri_parse(Uri),
Query = maps:get(query, URIMap, undefined),
{ok, PeerIP} = inet:getaddr(Host, inet),
{Scheme, {PeerIP, PortNo}, split_path(Path), split_query(Query)}.
split_path([]) -> [];
split_path([$/]) -> [];
split_path([$/ | Path]) -> split_segments(Path, $/, []).
split_query(undefined) -> #{};
split_query(Path) -> split_segments(Path, $&, []).
split_segments(Path, Char, Acc) ->
case string:rchr(Path, Char) of
0 ->
[make_segment(Path) | Acc];
N when N > 0 ->
split_segments(
string:substr(Path, 1, N - 1),
Char,
[make_segment(string:substr(Path, N + 1)) | Acc]
)
end.
make_segment(Seg) ->
list_to_binary(emqx_http_lib:uri_decode(Seg)).
get_path([], Acc) ->
%?LOGT("get_path Acc=~p", [Acc]),
Acc;
get_path([{uri_path, Path1} | T], Acc) ->
%?LOGT("Path=~p, Acc=~p", [Path1, Acc]),
get_path(T, join_path(Path1, Acc));
get_path([{_, _} | T], Acc) ->
get_path(T, Acc).
join_path([], Acc) -> Acc;
join_path([<<"/">> | T], Acc) -> join_path(T, Acc);
join_path([H | T], Acc) -> join_path(T, <<Acc/binary, $/, H/binary>>).
sprintf(Format, Args) ->
lists:flatten(io_lib:format(Format, Args)).