Skip to content

ssh: add cth_events and event verification for ssh_protocol_SUITE #10320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: maint
Choose a base branch
from
+151 −38
Open

ssh: add cth_events and event verification for ssh_protocol_SUITE #10320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/ssh/test/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ include $(ERL_TOP)/make/$(TARGET)/otp.mk
# ----------------------------------------------------

MODULES= \
cth_events \
ssh_cth \
ssh_algorithms_SUITE \
ssh_options_SUITE \
Expand Down
97 changes: 97 additions & 0 deletions lib/ssh/test/cth_events.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
%%
%% %CopyrightBegin%
%%
%% SPDX-License-Identifier: Apache-2.0
%%
%% Copyright Ericsson AB 2011-2025. 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.
%%
%% %CopyrightEnd%
%%
-module(cth_events).
-moduledoc false.

%%% This module verifies logger events.

%% CTH Callbacks
-export([id/1, init/2,
%% pre_init_per_suite/3, pre_end_per_suite/3, post_end_per_suite/4,
%% pre_init_per_group/4, post_init_per_group/5,
%% pre_end_per_group/4, post_end_per_group/5,
pre_init_per_testcase/4, %post_init_per_testcase/5,
%% pre_end_per_testcase/4,
post_end_per_testcase/5]).

-behaviour(ct_hooks).

id(_Opts) ->
?MODULE.

init(?MODULE, Opts) ->
GetValue =
fun(Property, PropList, Default) ->
case proplists:get_value(Property, PropList) of
undefined -> Default;
V -> V
end
end,

DefaultVerifyFun =
fun(_, 0) ->
ok;
(_, EventNumber) when EventNumber > 0 ->
{fail, lists:flatten(
io_lib:format("unexpected event cnt: ~s",
[integer_to_list(EventNumber)]))}
end,
VerifyFun = GetValue(verify_fun, Opts, DefaultVerifyFun),
SkipTc = GetValue(skip_tc, Opts, []),
ct_util:mark_process(), % ??
{ok, #{verify_fun => VerifyFun, skip_tc => SkipTc}}.

%% FIXME in parallel executions (e.g. ssh_basic_SUITE:p_basic group) this setup does not
%% work log handlers are uniq per testcase, but they all receive same
%% logger events; so if one testcase fails due to logger events, rest
%% of group might fail as well
pre_init_per_testcase(_Suite, TestCase, Config0, State = #{skip_tc := SkipTc}) ->
case lists:member(TestCase, SkipTc) of
false ->
Config = ssh_test_lib:add_log_handler(TestCase, Config0),
{Config, State};
true ->
{Config0, State}
end.

post_end_per_testcase(_Suite, TestCase, Config, Result,
State = #{skip_tc := SkipTc,
verify_fun := VerifyFun}) ->
case lists:member(TestCase, SkipTc) of
false ->
{ok, Events} = ssh_test_lib:get_log_events(
proplists:get_value(log_handler_ref, Config)),
EventCnt = length(Events),
{ok, InterestingEventCnt} = ssh_test_lib:analyze_events(Events, EventCnt),
VerificationResult = VerifyFun(TestCase, InterestingEventCnt),
ssh_test_lib:rm_log_handler(TestCase),
case VerificationResult of
ok ->
{Result, State};
_ ->
{VerificationResult, State}
end;
true ->
{Result, State}
end.


33 changes: 10 additions & 23 deletions lib/ssh/test/ssh_basic_SUITE.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,9 @@
%%--------------------------------------------------------------------

suite() ->
[{ct_hooks,[ts_install_cth]},
[{ct_hooks,[ts_install_cth,
{cth_events,
[{verify_fun, fun verify_events/2}]}]},
{timetrap,{seconds,90}}].

all() ->
Expand Down Expand Up @@ -190,10 +192,9 @@
end_per_group(_, Config) ->
Config.
%%--------------------------------------------------------------------
init_per_testcase(TestCase, Config0)
init_per_testcase(TestCase, Config)
when TestCase==shell_no_unicode;
TestCase==shell_unicode_string ->
Config = ssh_test_lib:add_log_handler(TestCase, Config0),
PrivDir = proplists:get_value(priv_dir, Config),
UserDir = proplists:get_value(priv_dir, Config),
SysDir = proplists:get_value(data_dir, Config),
Expand All @@ -210,8 +211,7 @@
ct:log("file:native_name_encoding() = ~p,~nio:getopts() = ~p",
[file:native_name_encoding(),io:getopts()]),
wait_for_erlang_first_line([{io,IO}, {shell,Shell}, {sftpd, Sftpd} | Config]);
init_per_testcase(TestCase = inet6_option, Config0) ->
Config = ssh_test_lib:add_log_handler(TestCase, Config0),
init_per_testcase(inet6_option, Config) ->
case ssh_test_lib:has_inet6_address() of
true ->
init_per_testcase('__default__', Config);
Expand All @@ -226,26 +226,13 @@
TestCase==shell_unicode_string ->
case proplists:get_value(sftpd, Config) of
{Pid, _, _} ->
catch ssh:stop_daemon(Pid);
catch ssh:stop_daemon(Pid),
ok;
_ ->
ok
end,
process_events(TestCase, Config);
end_per_testcase(TestCase, Config) ->
process_events(TestCase, Config).

%% FIXME in parallel executions (p_basic group) this setup does not
%% work log handlers are uniq per testcase, but they all receive same
%% logger events; so if one testcase fails due to logger events, rest
%% of group might fail as well
process_events(TestCase, Config) ->
{ok, Events} = ssh_test_lib:get_log_events(
proplists:get_value(log_handler_ref, Config)),
EventCnt = length(Events),
{ok, InterestingEventCnt} = ssh_test_lib:analyze_events(Events, EventCnt),
VerificationResult = verify_events(TestCase, InterestingEventCnt),
ssh_test_lib:rm_log_handler(TestCase),
VerificationResult.
end;
end_per_testcase(_TestCase, _Config) ->
ok.

verify_events(_TestCase, 0) ->
ok;
Expand Down Expand Up @@ -1238,7 +1225,7 @@
end || {S,Pid,C} <- Tests].

%%--------------------------------------------------------------------
packet_size(Config) ->

Check warning on line 1228 in lib/ssh/test/ssh_basic_SUITE.erl

View workflow job for this annotation

GitHub Actions / CT Test Results

packet_size failed 

artifacts/Unit Test Results/ssh_junit.xml [took 8s]
Raw output 
Test packet_size in ssh_basic_SUITE failed!
"unexpected event cnt: 4"
SystemDir = proplists:get_value(data_dir, Config),
PrivDir = proplists:get_value(priv_dir, Config),
UserDir = filename:join(PrivDir, nopubkey), % to make sure we don't use public-key-auth
Expand Down
22 changes: 9 additions & 13 deletions lib/ssh/test/ssh_connection_SUITE.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,10 @@
%% [{ct_hooks,[ts_install_cth]}].

suite() ->
[{timetrap,{seconds,40}}].
[{ct_hooks,[ts_install_cth,
{cth_events,
[{verify_fun, fun verify_events/2}]}]},
{timetrap,{seconds,40}}].

all() ->
[
Expand Down Expand Up @@ -235,21 +238,14 @@ end_per_group(_, Config) ->
Config.

%%--------------------------------------------------------------------
init_per_testcase(TestCase, Config) ->
init_per_testcase(_TestCase, Config) ->
ssh:stop(),
ssh:start(),
ssh_test_lib:verify_sanity_check(Config),
ssh_test_lib:add_log_handler(TestCase, Config).

end_per_testcase(TestCase, Config) ->
{ok, Events} = ssh_test_lib:get_log_events(
proplists:get_value(log_handler_ref, Config)),
EventCnt = length(Events),
{ok, InterestingEventCnt} = ssh_test_lib:analyze_events(Events, EventCnt),
VerificationResult = verify_events(TestCase, InterestingEventCnt),
ssh_test_lib:rm_log_handler(TestCase),
ssh:stop(),
VerificationResult.
Config.

end_per_testcase(_TestCase, _Config) ->
ssh:stop().

verify_events(_TestCase, 0) -> ok;
verify_events(no_sensitive_leak, 1) -> ok;
Expand Down
22 changes: 20 additions & 2 deletions lib/ssh/test/ssh_protocol_SUITE.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,25 @@
%% Common Test interface functions -----------------------------------
%%--------------------------------------------------------------------
suite() ->
[{ct_hooks,[ts_install_cth]},
VerifyFun =
fun(_, 0) ->
ok;
(client_close_after_hello, 1) ->
ok;
(extra_ssh_msg_service_request, 1) ->
ok;
(_, EventNumber) when EventNumber > 0 ->
{fail, lists:flatten(
io_lib:format("unexpected event cnt: ~s",
[integer_to_list(EventNumber)]))}
end,
SkipTc = [kex_strict_negotiated,
kex_strict_violation,
kex_strict_violation_2],
[{ct_hooks,[ts_install_cth,
{cth_events,
[{verify_fun, VerifyFun},
{skip_tc, SkipTc}]}]},
{timetrap,{seconds,40}}].

all() ->
Expand Down Expand Up @@ -550,7 +568,7 @@
ct:log("ERROR!~nOp = ~p~nExecResult = ~p~nState =~n~s",
[Op,ExecResult,ssh_trpt_test_lib:format_msg(S)]),
{fail, ExecResult};
X ->
{result, Pid, X} ->
ct:log("¤¤¤¤¤"),
ct:fail(X)
after
Expand All @@ -558,7 +576,7 @@
end.

%%%--------------------------------------------------------------------
gex_client_init_option_groups(Config) ->

Check warning on line 579 in lib/ssh/test/ssh_protocol_SUITE.erl

View workflow job for this annotation

GitHub Actions / CT Test Results

gex_client_init_option_groups failed 

artifacts/Unit Test Results/ssh_junit.xml [took 0s]
Raw output 
Test gex_client_init_option_groups in ssh_protocol_SUITE failed!
"unexpected event cnt: 4"
do_gex_client_init(Config, {512, 2048, 4000},
{5,16#D9277DAA27DB131C03B108D41A76B4DA8ACEECCCAE73D2E48CEDAAA70B09EF9F04FB020DCF36C51B8E485B26FABE0337E24232BE4F4E693548310244937433FB1A5758195DC73B84ADEF8237472C46747D79DC0A2CF8A57CE8DBD8F466A20F8551E7B1B824B2E4987A8816D9BC0741C2798F3EBAD3ADEBCC78FCE6A770E2EC9F}
).
Expand Down Expand Up @@ -606,7 +624,7 @@
).

%%%--------------------------------------------------------------------
gex_client_old_request_exact(Config) ->

Check warning on line 627 in lib/ssh/test/ssh_protocol_SUITE.erl

View workflow job for this annotation

GitHub Actions / CT Test Results

gex_client_old_request_exact failed 

artifacts/Unit Test Results/ssh_junit.xml [took 0s]
Raw output 
Test gex_client_old_request_exact in ssh_protocol_SUITE failed!
"unexpected event cnt: 4"
do_gex_client_init_old(Config, 1023,
{2, 16#D9277DAA27DB131C03B108D41A76B4DA8ACEECCCAE73D2E48CEDAAA70B09EF9F04FB020DCF36C51B8E485B26FABE0337E24232BE4F4E693548310244937433FB1A5758195DC73B84ADEF8237472C46747D79DC0A2CF8A57CE8DBD8F466A20F8551E7B1B824B2E4987A8816D9BC0741C2798F3EBAD3ADEBCC78FCE6A771225323}
).
Expand Down
14 changes: 14 additions & 0 deletions lib/ssh/test/ssh_test_lib.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1426,6 +1426,14 @@ process_event(#{msg := {report,
io_lib:format("[~44s] ~6s ~30s ~20s ~30s ~20s:~10s(~40s)~n",
[io_lib:format("~p", [E]) ||
E <- [Pid, Level, Label, Status, Id, M, F, Args]]);
process_event(#{msg := {report,
#{label := Label,
report := [MsgString]}},
meta := #{pid := Pid},
level := Level}) ->
io_lib:format("[~44s] ~6s ~20s ~s~n",
[io_lib:format("~p", [E]) ||
E <- [Pid, Level, Label]] ++ [MsgString]);
process_event(#{msg := {report,
#{label := Label,
name := Pid,
Expand All @@ -1449,6 +1457,12 @@ process_event(#{msg := {Format, Args},
io_lib:format("[~44s] ~6s~n~s~n",
[io_lib:format("~p", [E]) ||
E <- [Pid, Level]] ++ [io_lib:format(Format, Args)]);
process_event(#{msg := {string, MsgString},
meta := #{pid := Pid},
level := Level}) when is_list(MsgString) ->
io_lib:format("[~44s] ~6s ~s~n",
[io_lib:format("~p", [E]) ||
E <- [Pid, Level]] ++ [MsgString]);
process_event(#{msg := {report,
#{label := Label,
reason := Reason,
Expand Down
Loading