Merge tag 'OTP-19.0' into sverker/19/binary_to_atom-utf8-crash/ERL-474/OTP-14590

1 files changed, 61 insertions, 231 deletions

diff --git a/lib/eunit/include/eunit.hrl b/lib/eunit/include/eunit.hrl
index 8ebdb6ba16..7fd6c206a4 100644
--- a/lib/eunit/include/eunit.hrl
+++ b/lib/eunit/include/eunit.hrl
@@ -1,4 +1,3 @@
-%% -*- coding: utf-8 -*-
 %% This library is free software; you can redistribute it and/or modify
 %% it under the terms of the GNU Lesser General Public License as
 %% published by the Free Software Foundation; either version 2 of the
@@ -16,11 +15,14 @@
 %%
 %% Copyright (C) 2004-2006 Mickaël Rémond, Richard Carlsson
 
+-ifndef(EUNIT_HRL).
+-define(EUNIT_HRL, true).
+
 %% Including this file turns on testing and defines TEST, unless NOTEST
 %% is defined before the file is included. If both NOTEST and TEST are
 %% already defined, then TEST takes precedence, and NOTEST will become
 %% undefined.
-%% 
+%%
 %% If NODEBUG is defined before this file is included, the debug macros
 %% are disabled, unless DEBUG is also defined, in which case NODEBUG
 %% will become undefined. NODEBUG also implies NOASSERT, unless testing
@@ -32,14 +34,10 @@
 %% even if NODEBUG is defined. If both ASSERT and NOASSERT are defined
 %% before the file is included, then ASSERT takes precedence, and NOASSERT
 %% will become undefined regardless of TEST.
-%% 
+%%
 %% After including this file, EUNIT will be defined if and only if TEST
 %% is defined.
 
--ifndef(EUNIT_HRL).
--define(EUNIT_HRL, true).
-
-
 %% allow defining TEST to override NOTEST
 -ifdef(TEST).
 -undef(NOTEST).
@@ -50,13 +48,6 @@
 -undef(NODEBUG).
 -endif.
 
-%% allow NODEBUG to imply NOASSERT, unless overridden below
--ifdef(NODEBUG).
--ifndef(NOASSERT).
--define(NOASSERT, true).
--endif.
--endif.
-
 %% note that the main switch used within this file is NOTEST; however,
 %% both TEST and EUNIT may be used to check whether testing is enabled
 -ifndef(NOTEST).
@@ -71,10 +62,8 @@
 -undef(EUNIT).
 -endif.
 
-%% allow ASSERT to override NOASSERT (regardless of TEST/NOTEST)
--ifdef(ASSERT).
--undef(NOASSERT).
--endif.
+%% include the assert macros; ASSERT overrides NOASSERT if defined
+-include_lib("stdlib/include/assert.hrl").
 
 %% Parse transforms for automatic exporting/stripping of test functions.
 %% (Note that although automatic stripping is convenient, it will make
@@ -92,7 +81,7 @@
 
 %% All macros should be available even if testing is turned off, and
 %% should preferably not require EUnit to be present at runtime.
-%% 
+%%
 %% We must use fun-call wrappers ((fun () -> ... end)()) to avoid
 %% exporting local variables, and furthermore we only use variable names
 %% prefixed with "__", that hopefully will not be bound outside the fun.
@@ -102,7 +91,7 @@
 %% X gets a new, local binding.
 %% (Note that lowercase 'let' is a reserved word.)
 -ifndef(LET).
--define(LET(X,Y,Z), ((fun(X)->(Z)end)(Y))).
+-define(LET(X,Y,Z), begin ((fun(X)->(Z)end)(Y)) end).
 -endif.
 
 %% It is important that testing code is short and readable.
@@ -110,13 +99,13 @@
 %% Compare:  case f(X) of true->g(X); false->h(X) end
 %%     and:  ?IF(f(X), g(Y), h(Z))
 -ifndef(IF).
--define(IF(B,T,F), (case (B) of true->(T); false->(F) end)).
+-define(IF(B,T,F), begin (case (B) of true->(T); false->(F) end) end).
 -endif.
 
 %% This macro yields 'true' if the value of E matches the guarded
 %% pattern G, otherwise 'false'.
 -ifndef(MATCHES).
--define(MATCHES(G,E), (case (E) of G -> true; _ -> false end)).
+-define(MATCHES(G,E), begin (case (E) of G -> true; _ -> false end) end).
 -endif.
 
 %% This macro can be used at any time to check whether or not the code
@@ -129,195 +118,21 @@
 				      current_function)))).
 -endif.
 
-%% The plain assert macro should be defined to do nothing if this file
-%% is included when debugging/testing is turned off.
--ifdef(NOASSERT).
--ifndef(assert).
--define(assert(BoolExpr),ok).
--endif.
--else.
-%% The assert macro is written the way it is so as not to cause warnings
-%% for clauses that cannot match, even if the expression is a constant.
--undef(assert).
--define(assert(BoolExpr),
-	((fun () ->
-	    case (BoolExpr) of
-		true -> ok;
-		__V -> erlang:error({assertion_failed,
-				     [{module, ?MODULE},
-				      {line, ?LINE},
-				      {expression, (??BoolExpr)},
-				      {expected, true},
-				      {value, case __V of false -> __V;
-						  _ -> {not_a_boolean,__V}
-					      end}]})
-	    end
-	  end)())).
--endif.
--define(assertNot(BoolExpr), ?assert(not (BoolExpr))).
+%% General test macros
 
 -define(_test(Expr), {?LINE, fun () -> (Expr) end}).
-
 -define(_assert(BoolExpr), ?_test(?assert(BoolExpr))).
-
 -define(_assertNot(BoolExpr), ?_assert(not (BoolExpr))).
-
-%% This is mostly a convenience which gives more detailed reports.
-%% Note: Guard is a guarded pattern, and can not be used for value.
--ifdef(NOASSERT).
--define(assertMatch(Guard, Expr), ok).
--else.
--define(assertMatch(Guard, Expr),
-	((fun () ->
-	    case (Expr) of
-		Guard -> ok;
-		__V -> erlang:error({assertMatch_failed,
-				     [{module, ?MODULE},
-				      {line, ?LINE},
-				      {expression, (??Expr)},
-				      {pattern, (??Guard)},
-				      {value, __V}]})
-	    end
-	  end)())).
--endif.
 -define(_assertMatch(Guard, Expr), ?_test(?assertMatch(Guard, Expr))).
-
-%% This is the inverse case of assertMatch, for convenience.
--ifdef(NOASSERT).
--define(assertNotMatch(Guard, Expr), ok).
--else.
--define(assertNotMatch(Guard, Expr),
-	((fun () ->
-	    __V = (Expr),
-	    case __V of
-		Guard -> erlang:error({assertNotMatch_failed,
-				       [{module, ?MODULE},
-					{line, ?LINE},
-					{expression, (??Expr)},
-					{pattern, (??Guard)},
-					{value, __V}]});
-		_ -> ok
-	    end
-	  end)())).
--endif.
 -define(_assertNotMatch(Guard, Expr), ?_test(?assertNotMatch(Guard, Expr))).
-
-%% This is a convenience macro which gives more detailed reports when
-%% the expected LHS value is not a pattern, but a computed value
--ifdef(NOASSERT).
--define(assertEqual(Expect, Expr), ok).
--else.
--define(assertEqual(Expect, Expr),
-	((fun (__X) ->
-	    case (Expr) of
-		__X -> ok;
-		__V -> erlang:error({assertEqual_failed,
-				     [{module, ?MODULE},
-				      {line, ?LINE},
-				      {expression, (??Expr)},
-				      {expected, __X},
-				      {value, __V}]})
-	    end
-	  end)(Expect))).
--endif.
 -define(_assertEqual(Expect, Expr), ?_test(?assertEqual(Expect, Expr))).
-
-%% This is the inverse case of assertEqual, for convenience.
--ifdef(NOASSERT).
--define(assertNotEqual(Unexpected, Expr), ok).
--else.
--define(assertNotEqual(Unexpected, Expr),
-	((fun (__X) ->
-	    case (Expr) of
-		__X -> erlang:error({assertNotEqual_failed,
-				     [{module, ?MODULE},
-				      {line, ?LINE},
-				      {expression, (??Expr)},
-				      {value, __X}]});
-		_ -> ok
-	    end
-	  end)(Unexpected))).
--endif.
 -define(_assertNotEqual(Unexpected, Expr),
 	?_test(?assertNotEqual(Unexpected, Expr))).
-
-%% Note: Class and Term are patterns, and can not be used for value.
-%% Term can be a guarded pattern, but Class cannot.
--ifdef(NOASSERT).
--define(assertException(Class, Term, Expr), ok).
--else.
--define(assertException(Class, Term, Expr),
-	((fun () ->
-	    try (Expr) of
-	        __V -> erlang:error({assertException_failed,
-				      [{module, ?MODULE},
-				       {line, ?LINE},
-				       {expression, (??Expr)},
-				       {pattern,
-					"{ "++(??Class)++" , "++(??Term)
-					++" , [...] }"},
-				       {unexpected_success, __V}]})
-	    catch
-		Class:Term -> ok;
-	        __C:__T ->
-		    erlang:error({assertException_failed,
-				  [{module, ?MODULE},
-				   {line, ?LINE},
-				   {expression, (??Expr)},
-				   {pattern,
-				    "{ "++(??Class)++" , "++(??Term)
-				    ++" , [...] }"},
-				   {unexpected_exception,
-				    {__C, __T,
-				     erlang:get_stacktrace()}}]})
-	    end
-	  end)())).
--endif.
-
--define(assertError(Term, Expr), ?assertException(error, Term, Expr)).
--define(assertExit(Term, Expr), ?assertException(exit, Term, Expr)).
--define(assertThrow(Term, Expr), ?assertException(throw, Term, Expr)).
-
 -define(_assertException(Class, Term, Expr),
 	?_test(?assertException(Class, Term, Expr))).
 -define(_assertError(Term, Expr), ?_assertException(error, Term, Expr)).
 -define(_assertExit(Term, Expr), ?_assertException(exit, Term, Expr)).
 -define(_assertThrow(Term, Expr), ?_assertException(throw, Term, Expr)).
-
-%% This is the inverse case of assertException, for convenience.
-%% Note: Class and Term are patterns, and can not be used for value.
-%% Both Class and Term can be guarded patterns.
--ifdef(NOASSERT).
--define(assertNotException(Class, Term, Expr), ok).
--else.
--define(assertNotException(Class, Term, Expr),
-	((fun () ->
-	    try (Expr) of
-	        _ -> ok
-	    catch
-		__C:__T ->
-		    case __C of
-			Class ->
-			    case __T of
-				Term ->
-				    erlang:error({assertNotException_failed,
-						  [{module, ?MODULE},
-						   {line, ?LINE},
-						   {expression, (??Expr)},
-						   {pattern,
-						    "{ "++(??Class)++" , "
-						    ++(??Term)++" , [...] }"},
-						   {unexpected_exception,
-						    {__C, __T,
-						     erlang:get_stacktrace()
-						    }}]});
-				_ -> ok
-			    end;
-			_ -> ok
-		    end
-	    end
-	  end)())).
--endif.
 -define(_assertNotException(Class, Term, Expr),
 	?_test(?assertNotException(Class, Term, Expr))).
 
@@ -327,6 +142,7 @@
 %% these can be used for simply running commands in a controlled way
 -define(_cmd_(Cmd), (eunit_lib:command(Cmd))).
 -define(cmdStatus(N, Cmd),
+	begin
 	((fun () ->
 	    case ?_cmd_(Cmd) of
 		{(N), __Out} -> __Out;
@@ -337,7 +153,8 @@
 					   {expected_status,(N)},
 					   {status,__N}]})
 	    end
-	  end)())).
+	  end)())
+	end).
 -define(_cmdStatus(N, Cmd), ?_test(?cmdStatus(N, Cmd))).
 -define(cmd(Cmd), ?cmdStatus(0, Cmd)).
 -define(_cmd(Cmd), ?_test(?cmd(Cmd))).
@@ -348,17 +165,19 @@
 -define(assertCmdStatus(N, Cmd), ok).
 -else.
 -define(assertCmdStatus(N, Cmd),
- 	((fun () ->
-	    case ?_cmd_(Cmd) of
-		{(N), _} -> ok;
-		{__N, _} -> erlang:error({assertCmd_failed,
-					  [{module, ?MODULE},
-					   {line, ?LINE},
-					   {command, (Cmd)},
-					   {expected_status,(N)},
-					   {status,__N}]})
-	    end
-	  end)())).
+	begin
+            ((fun () ->
+                      case ?_cmd_(Cmd) of
+                          {(N), _} -> ok;
+                          {__N, _} -> erlang:error({assertCmd_failed,
+                                                    [{module, ?MODULE},
+                                                     {line, ?LINE},
+                                                     {command, (Cmd)},
+                                                     {expected_status,(N)},
+                                                     {status,__N}]})
+                      end
+              end)())
+        end).
 -endif.
 -define(assertCmd(Cmd), ?assertCmdStatus(0, Cmd)).
 
@@ -366,17 +185,19 @@
 -define(assertCmdOutput(T, Cmd), ok).
 -else.
 -define(assertCmdOutput(T, Cmd),
- 	((fun () ->
-	    case ?_cmd_(Cmd) of
-		{_, (T)} -> ok;
-		{_, __T} -> erlang:error({assertCmdOutput_failed,
-					  [{module, ?MODULE},
-					   {line, ?LINE},
-					   {command,(Cmd)},
-					   {expected_output,(T)},
-					   {output,__T}]})
-	    end
-	  end)())).
+	begin
+            ((fun () ->
+                      case ?_cmd_(Cmd) of
+                          {_, (T)} -> ok;
+                          {_, __T} -> erlang:error({assertCmdOutput_failed,
+                                                    [{module, ?MODULE},
+                                                     {line, ?LINE},
+                                                     {command,(Cmd)},
+                                                     {expected_output,(T)},
+                                                     {output,__T}]})
+                      end
+              end)())
+	end).
 -endif.
 
 -define(_assertCmdStatus(N, Cmd), ?_test(?assertCmdStatus(N, Cmd))).
@@ -391,30 +212,39 @@
 -define(debugHere, ok).
 -define(debugFmt(S, As), ok).
 -define(debugVal(E), (E)).
+-define(debugValAll(E), (E)).
 -define(debugTime(S, E), (E)).
 -else.
 -define(debugMsg(S),
-	(begin
-	     io:fwrite(user, <<"~s:~w:~w: ~s\n">>,
-		       [?FILE, ?LINE, self(), S]),
-	     ok
-	 end)).
+	begin
+	    io:fwrite(user, <<"~ts:~w:~w: ~ts\n">>,
+		      [?FILE, ?LINE, self(), S]),
+	    ok
+	end).
 -define(debugHere, (?debugMsg("<-"))).
 -define(debugFmt(S, As), (?debugMsg(io_lib:format((S), (As))))).
--define(debugVal(E),
+-define(debugVal(E, D),
+	begin
 	((fun (__V) ->
-		  ?debugFmt(<<"~s = ~P">>, [(??E), __V, 15]),
+		  ?debugFmt(<<"~ts = ~tP">>,
+                            [(??E), __V, D]),
 		  __V
-	  end)(E))).
+	  end)(E))
+	end).
+-ifndef(EUNIT_DEBUG_VAL_DEPTH).
+-define(EUNIT_DEBUG_VAL_DEPTH, 15).
+-endif.
+-define(debugVal(E), ?debugVal(E, ?EUNIT_DEBUG_VAL_DEPTH)).
 -define(debugTime(S, E),
+	begin
 	((fun () ->
 		  {__T0, _} = statistics(wall_clock),
 		  __V = (E),
 		  {__T1, _} = statistics(wall_clock),
-		  ?debugFmt(<<"~s: ~.3f s">>, [(S), (__T1-__T0)/1000]),
+		  ?debugFmt(<<"~ts: ~.3f s">>, [(S), (__T1-__T0)/1000]),
 		  __V
-	  end)())).
+	  end)())
+	end).
 -endif.
 
-
 -endif. % EUNIT_HRL