megaco_binary_term_id_test.erl

OTP是开放电信平台的简称

%% ``The contents of this file are subject to the Erlang Public License,
%% Version 1.1, (the "License"); you may not use this file except in
%% compliance with the License. You should have received a copy of the
%% Erlang Public License along with this software. If not, it can be
%% retrieved via the world wide web at http://www.erlang.org/.
%% 
%% Software distributed under the License is distributed on an "AS IS"
%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
%% the License for the specific language governing rights and limitations
%% under the License.
%% 
%% The Initial Developer of the Original Code is Ericsson Utvecklings AB.
%% Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings
%% AB. All Rights Reserved.''
%% 
%%     $Id$
%%
%%----------------------------------------------------------------------
%% Purpose:
%%----------------------------------------------------------------------

-module(megaco_binary_term_id_test).

%%----------------------------------------------------------------------
%% Include files
%%----------------------------------------------------------------------
-include_lib("megaco/include/megaco.hrl"). 
-include_lib("megaco/src/engine/megaco_message_internal.hrl").


%%----------------------------------------------------------------------
%% External exports
%%----------------------------------------------------------------------
-export([t/0]).

%% Test suite exports
-export([all/1, encode_first/1, decode_first/1,
	init_per_testcase/2, fin_per_testcase/2]).  


%%----------------------------------------------------------------------
%% Internal exports
%%----------------------------------------------------------------------
-export([te01/1,te02/1,te03/1,te04/1,te05/1,
	 te06/1,te07/1,te08/1,te09/1,te10/1,
	 te11/1,te12/1,te13/1,te14/1,te15/1,
	 te16/1,te17/1,te18/1,te19/1]).
-export([td01/1,td02/1,td03/1,td04/1,td05/1,td06/1]).


%% ---------------------------------------------------------------------


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Top test case

all(suite) ->
    [
     encode_first,
     decode_first
    ].

encode_first(suite) ->
    encode_first_cases().

decode_first(suite) ->
    decode_first_cases().


%% Test server callbacks
init_per_testcase(Case, Config) ->
    megaco_test_lib:init_per_testcase(Case, Config).

fin_per_testcase(Case, Config) ->
    megaco_test_lib:fin_per_testcase(Case, Config).


%%======================================================================
%% External functions
%%======================================================================

t() ->
    display([do(Case) || Case <- cases()]),
    ok.


cases() -> encode_first_cases() ++ decode_first_cases().

encode_first_cases() -> [te01,te02,te03,te04,te05,
			 te06,te07,te08,te09,te10,
			 te11,te12,te13,te14,te15,
			 te16,te17,te18,te19].
decode_first_cases() -> [td01,td02,td03,td04,td05,td06].

do(Case) ->
    case doc(Case) of
	{'EXIT',_} ->
	    {Case,error};
	Description ->
	    io:format("test case ~p~n",[Case]),
	    case suite(Case) of
		{'EXIT',Reason} ->
		    Res = check_result(Case,Description,ok,{error,Reason}),
		    {Case,Res};
		{Expected,Result} ->
		    Res = check_result(Case,Description,Expected,Result),
		    {Case,Res}
	    end
    end.

doc(Case)   -> (catch apply(?MODULE,Case,[doc])).
suite(Case) -> (catch apply(?MODULE,Case,[])).

display(R) -> 
    [display(Case,Result) || {Case,Result} <- R].

display(C,error) ->
    io:format("Test case ~p failed~n",[C]);
display(C,warning) ->
    io:format("Test case ~p conspicuous~n",[C]);
display(C,ok) ->
    io:format("Test case ~p succeeded~n",[C]).

check(D,ok,{ok,T1,T2,T3}) ->
    Result = case check_ok_result(T1,T3) of
		 ok -> 
		     ok;
		 {error,Reason} ->
		     io:format("  => inconsistent result"
			       "~n  Start and end record differ"
			       "~n  ~s"
			       "~n  ~s"
			       "~n  ~w"
			       "~n",
			       [D,Reason,T2]),
		     warning
	     end,
    Result;
check(D,error,{ok,T1,T2,T3}) ->
    io:format("  => failed"
	      "~n  ~s"
	      "~n  ~p"
	      "~n  ~p"
	      "~n  ~p"
	      "~n",
	      [D,T1,T2,T3]),
    error;
check(_D,error,{error,_Reason}) ->
    ok;
check(D,ok,{error,Reason}) ->
    io:format("  => failed"
	      "~n  ~s"
	      "~n  Failed for reason"
	      "~n  ~p"
	      "~n",
	      [D,Reason]),
    error.

check_result(_C,D,ok,{ok,T1,T2,T3}) ->
    Result = case check_ok_result(T1,T3) of
		 ok -> 
		     io:format("  => succeeded"
			       "~n  ~s"
			       "~n  ~p"
			       "~n  ~w"
			       "~n  ~p",
			       [D,T1,T2,T3]),
		     ok;
		 {error,Reason} ->
		     io:format("  => inconsistent result"
			       "~n  Start and end record differ"
			       "~n  ~s"
			       "~n  ~s"
			       "~n  ~w",
			       [D,Reason,T2]),
		     warning
	     end,
    io:format("~n~n--------------------~n",[]),
    Result;
check_result(_C,D,error,{ok,T1,T2,T3}) ->
    io:format("  => failed"
	      "~n  ~s"
	      "~n  ~p"
	      "~n  ~p"
	      "~n  ~p"
	      "~n~n--------------------~n",
	      [D,T1,T2,T3]),
    error;
check_result(_C,D,error,{error,Reason}) ->
    io:format("  => succeeded"
	      "~n  ~s"
	      "~n  Operation failed (expectedly) for reason"
	      "~n  ~p"
	      "~n~n--------------------~n",
	      [D,Reason]),
    ok;
check_result(_C,D,ok,{error,Reason}) ->
    io:format("  => failed"
	      "~n  ~s"
	      "~n  Failed for reason"
	      "~n  ~p"
	      "~n~n--------------------~n",
	      [D,Reason]),
    error.

check_ok_result(R,R) when record(R,megaco_term_id) ->
    ok; % Same record type and same record content
check_ok_result(S,E) when record(S,megaco_term_id),
                          record(E,megaco_term_id) ->
    Reason = check_megaco_term_id_record(S,E),
    {error,Reason}; % Same record type but different record content
check_ok_result(R,R) when record(R,'TerminationID') ->
    ok;
check_ok_result(S,E) when record(S,'TerminationID'),
                          record(E,'TerminationID') ->
    Reason = check_TerminationID_record(S,E),
    {error,Reason}; % Same record type but different record content
check_ok_result(_S,_E) ->
    {error,"NOT THE SAME RECORD TYPES"}. % OOPS, Not even the same record type
    
check_megaco_term_id_record(#megaco_term_id{contains_wildcards = Cw1, 
					    id = Id1},
			    #megaco_term_id{contains_wildcards = Cw2, 
					    id = Id2}) ->
    Result = case check_megaco_term_id_cw(Cw1,Cw2) of
		 ok ->
		     check_megaco_term_id_id(Id1,Id2);
		 {error,R1} ->
		     R2 = check_megaco_term_id_id(Id1,Id2),
		     io_lib:format("~s~s",[R1,R2])
    end,
    lists:flatten(Result).
    
check_megaco_term_id_cw(Cw,Cw) ->
    ok;
check_megaco_term_id_cw(Cw1,Cw2) ->
    R = io_lib:format("~n   The 'contains_wildcard' property of the start"
		      "~n   megaco_term_id record "
		      "~n   has value ~w "
		      "~n   but the end record "
		      "~n   has value ~w",
		      [Cw1,Cw2]),
    {error,R}.

check_megaco_term_id_id(Id,Id) ->
    ok;
check_megaco_term_id_id(Id1,Id2) ->
    R = io_lib:format("~n   The 'id' property of the start"
		      "~n   megaco_term_id record "
		      "~n   has value ~w "
		      "~n   but the end record "
		      "~n   has value ~w",
		      [Id1,Id2]),
    {error,R}.


check_TerminationID_record(#'TerminationID'{wildcard = W1, id = Id1},
			   #'TerminationID'{wildcard = W2, id = Id2}) ->
    Result = case check_TerminationID_w(W1,W2) of
		 ok ->
		     check_TerminationID_id(Id1,Id2);
		 {error,R1} ->
		     R2 = check_TerminationID_id(Id1,Id2),
		     io_lib:format("~s~s",[R1,R2])
    end,
    lists:flatten(Result).
    
check_TerminationID_w(W,W) ->
    ok;
check_TerminationID_w(W1,W2) ->
    R = io_lib:format("~n   The 'wildcard' property of the start"
		      "~n   'TerminationID' record "
		      "~n   has value ~w "
		      "~n   but the end record "
		      "~n   has value ~w",
		      [W1,W2]),
    {error,R}.

check_TerminationID_id(Id,Id) ->
    ok;
check_TerminationID_id(Id1,Id2) ->
    R = io_lib:format("~n   The 'id' property of the start"
		      "~n   'TerminationID' record "
		      "~n   has value ~w "
		      "~n   but the end record "
		      "~n   has value ~w",
		      [Id1,Id2]),
    {error,R}.


%% --------------------------------------------------------
%% Start test cases
%% --------------------------------------------------------

%% basic_enc_dec01
te01(doc) ->
    "Basic encoding & then decoding test [1,1]\n  (asn -> binary -> asn)";

te01(suite) ->
    [];

te01(Config) when list(Config) ->
    {Exp,Res} = te01(),
    ok = check(te01(doc),Exp,Res).


te01() ->
    %% put(encode_debug,dbg),
    %% put(decode_debug,dbg),
    Res = encode_decode(config1(),mtid01()),
    erase(encode_debug),
    erase(decode_debug),
    {ok,Res}.


%% --------------------------------------------------------

%% basic_enc_dec02
te02(doc) ->
    "Basic encoding & then decoding test [1,2]";

te02(suite) ->
    [];

te02(Config) when list(Config) ->
    {Exp,Res} = te02(),
    ok = check(te02(doc),Exp,Res).

te02() ->
    %% put(encode_debug,dbg),
    %% put(decode_debug,dbg),
    Res = encode_decode(config1(),mtid02()),
    erase(encode_debug),
    erase(decode_debug),
    {ok,Res}.


%% --------------------------------------------------------

%% basic_enc_dec03
te03(doc) ->
    "Basic encoding & then decoding test [1,3]";

te03(suite) ->
    [];

te03(Config) when list(Config) ->
    {Exp,Res} = te03(),
    ok = check(te03(doc),Exp,Res).

te03() ->
    %% put(encode_debug,dbg),
    %% put(decode_debug,dbg),
    Res = encode_decode(config1(),mtid03()),
    erase(encode_debug),
    erase(decode_debug),
    {ok,Res}.


%% --------------------------------------------------------

%% basic_enc_dec04
te04(doc) ->
    "Basic encoding & then decoding test [1,4]\n  (asn -> binary -> asn)";

te04(suite) ->
    [];

te04(Config) when list(Config) ->
    {Exp,Res} = te04(),
    ok = check(te04(doc),Exp,Res).

te04() ->
    %% put(encode_debug,dbg),
    %% put(decode_debug,dbg),
    Res = encode_decode(config1(),mtid04()),
    erase(encode_debug),
    erase(decode_debug),
    {ok,Res}.


%% --------------------------------------------------------

%% basic_enc_dec05
te05(doc) ->
    "Basic encoding & then decoding test [1,5]\n  (asn -> binary -> asn)";

te05(suite) ->
    [];

te05(Config) when list(Config) ->
    {Exp,Res} = te05(),
    ok = check(te05(doc),Exp,Res).

te05() ->
    %% put(encode_debug,dbg),
    %% put(decode_debug,dbg),
    Res = encode_decode(config1(),mtid05()),
    erase(encode_debug),
    erase(decode_debug),
    {ok,Res}.


%% --------------------------------------------------------

%% no_wildcard_spec_but_fond_some_enc_dec
te06(doc) ->
    "Specified NO wildcards, but found some just the same [1,6]\n  (asn -> binary -> asn)";

te06(suite) ->
    [];

te06(Config) when list(Config) ->
    {Exp,Res} = te06(),
    ok = check(te06(doc),Exp,Res).

te06() ->
    %% put(encode_debug,dbg),
    %% put(decode_debug,dbg),
    Res = encode_decode(config1(),mtid06()),
    erase(encode_debug),
    erase(decode_debug),
    {error,Res}.


%% --------------------------------------------------------

%% invalid_char_enc_dec
te07(doc) ->
    "Invalid character found (2) [1,7]\n  (asn -> binary -> asn)";

te07(suite) ->
    [];

te07(Config) when list(Config) ->
    {Exp,Res} = te07(),
    ok = check(te07(doc),Exp,Res).

te07() ->
    %% put(encode_debug,dbg),
    %% put(decode_debug,dbg),
    Res = encode_decode(config1(),mtid07()),
    erase(encode_debug),
    erase(decode_debug),
    {error,Res}.


%% --------------------------------------------------------

%% erroneous_first_level_length_enc_dec01
te08(doc) ->
    "Erroneous length of first level (a character after wildcard) [1,8]\n  (asn -> binary -> asn)";

te08(suite) ->
    [];

te08(Config) when list(Config) ->
    {Exp,Res} = te08(),
    ok = check(te08(doc),Exp,Res).

te08() ->
    %% put(encode_debug,dbg),
    %% put(decode_debug,dbg),
    Res = encode_decode(config1(),mtid08()),
    erase(encode_debug),
    erase(decode_debug),
    {error,Res}.


%% --------------------------------------------------------

%% erroneous_first_level_length_enc_dec02
te09(doc) ->
    "Erroneous length of first level (a character after last valid) [1,9]\n  (asn -> binary -> asn)";

te09(suite) ->
    [];

te09(Config) when list(Config) ->
    {Exp,Res} = te09(),
    ok = check(te09(doc),Exp,Res).

te09() ->
    %% put(encode_debug,dbg),
    %% put(decode_debug,dbg),
    Res = encode_decode(config1(),mtid09()),
    erase(encode_debug),
    erase(decode_debug),
    {error,Res}.


%% --------------------------------------------------------

%% basic_enc_dec_with_one_rec_wildcard01
te10(doc) ->
    "Basic encode & decode with one recursive wildcard [1,10]\n  (asn -> binary -> asn)\n   (NOTE THAT THIS SHOULD LATER BE A LEVEL WILDCARD)";

te10(suite) ->
    [];

te10(Config) when list(Config) ->
    {Exp,Res} = te10(),
    ok = check(te10(doc),Exp,Res).

te10() ->