Improved assert() according to expectations RFC.

See https://wiki.php.net/rfc/expectations

Squashed commit of the following:

commit 3f3651a
Author: Dmitry Stogov <[email protected]>
Date:   Mon Mar 2 11:56:33 2015 +0300

    opcode 137 is used for ZEND_OP_DATA and con't be reused for ZEND_ASSERT_CHECK

commit ca8ecab
Merge: 24328ac 9dac923
Author: Dmitry Stogov <[email protected]>
Date:   Mon Mar 2 10:49:23 2015 +0300

    Merge branch 'master' into assert

    * master:
      Update NEWS
      Fixed bug #69139 (Crash in gc_zval_possible_root on unserialize)
      windows only test
      Align entries format
      Align entries format for 5.6.7
      Align entries format for 5.5.23
      Bump header year
      Fixed bug #69144 (strtr not replacing with partly matching replace pairs)
      Fixed test?
      Revert mktime()/gmmktime()'s arginfo
      Update NEWS
      Fixed bug #69141 Missing arguments in reflection info for some builtin functions
      Add NEWS entry
      Remove useless date warning
      Fix ARG_INFO for levenshtein
      Fix ARG_INFO for levenshtein
      fix dir separator in tests
      Update NEWS
      Fixed bug #69085 (SoapClient's __call() type confusion through unserialize()).

commit 24328ac
Merge: 021fd94 1cdee9a
Author: Dmitry Stogov <[email protected]>
Date:   Fri Feb 27 15:57:13 2015 +0300

    Merge branch 'master' into assert

    * master:
      Fixed C++ support
      Fixed bug #69115 crash in mail
      Reorder
      Update NEWs
      Fixed bug #69121 (Segfault in get_current_user when script owner is not in passwd with ZTS build)
      Update News
      Fixed bug #69125 (Array numeric string as key)
      fix bug#68942's patch
      Fixed ability to build unspecialized executor
      Fixed bug #69124 (method name could not be used when by ref)
      Fixed a bug that header value is not terminated by '\0' when accessed through getenv().
      Fixed a bug that header value is not terminated by '\0' when accessed through getenv().

commit 021fd94
Merge: 49963eb ace1f82
Author: Dmitry Stogov <[email protected]>
Date:   Thu Feb 26 11:26:03 2015 +0300

    Merge branch 'master' into assert

    * master: (59 commits)
      Improved ASSIGN_DIM handler
      Don't inline slow path
      Revert a part committted by mistake
      Fixed compilation warnings
      Fixed a bug that header value is not terminated by '\0' when accessed through getenv().
      better name
      Improve fix for #69038
      Update NEWs
      Fixed bug #69108 ("Segmentation fault" when (de)serializing SplObjectStorage)
      Added specialized versions of DO_FCALL handler:   DO_ICALL - for internal functions   DO_UCALL - for user functions   DO_FCALL_BY_NAME - plain, most probably user, funcstions (not methods)
      Use cache_slot offsets instead of indexes (simplify run-time instructions)
      Split INIT_FCALL_BY_NAME inti INIT_FCALL_BY_NAME(CONST+STRING) and INIT_DYNAMIC_CALL(CONST-STRING|TMPVAR|CV)
      Support list($a, $b) = $a
      Avoid unnecassary check
      Make zend_array_destroy() to free the corresponding zend_array
      Eliminate check on the fast path
      Make current() and key() receive argument by value.
      Use Firebird default home folder, replace Interbase with Firebird
      Updated NEWS
      updated NEWS
      ...

    Conflicts:
    	Zend/zend_vm_execute.h
    	Zend/zend_vm_opcodes.c
    	Zend/zend_vm_opcodes.h

commit 49963eb
Merge: 07b1f92 6b77959
Author: Dmitry Stogov <[email protected]>
Date:   Thu Feb 19 11:13:08 2015 +0300

    Merge branch 'master' into assert

    * master:
      Implemented AST pretty-printer
      update NEWS to match the actual stuff in 5.6.6
      update NEWS to match the actual stuff in 5.5.22
      update NEWS(add missing entry for the enchant fix, and reorder the entries a bit)
      fix typo in bug#
      update NEWS
      fix email format
      update NEWS
      update 5.6.6 release date in NEWS
      Fix bug #69033 (Request may get env. variables from previous requests if PHP works as FastCGI)
      BFN
      fix test
      fix test
      fix test
      Fixed bug #65593 (Segfault when calling ob_start from output buffering callback)
      Updated NEWS
      add CVE
      5.4.39 next
      Fix associativity to match Perl
      Blast off to space.

    Conflicts:
    	Zend/zend_ast.c

commit 07b1f92
Author: Dmitry Stogov <[email protected]>
Date:   Wed Feb 18 23:06:32 2015 +0300

    fixed pretty-printer (support for "elseif")

commit 5a976c8
Author: Dmitry Stogov <[email protected]>
Date:   Wed Feb 18 19:50:08 2015 +0300

    Fixed vaeious ptetty-printer issues

commit 69491e8
Merge: 8473157 3ddc246
Author: Dmitry Stogov <[email protected]>
Date:   Wed Feb 18 10:18:32 2015 +0300

    Merge branch 'master' into assert

    * master:
      Set PHP_JSON_VERSION to 1.4.0
      Remove unnecessary resource checks in openssl ext
      JSON is now maintained

commit 8473157
Author: Dmitry Stogov <[email protected]>
Date:   Wed Feb 18 10:17:26 2015 +0300

    Fixed typo and white spaces

commit 96de5ff
Author: Dmitry Stogov <[email protected]>
Date:   Wed Feb 18 00:28:39 2015 +0300

    Fixed assert() in namesapaces

commit 5eba069
Merge: 4a2d9c0 d428bf2
Author: Dmitry Stogov <[email protected]>
Date:   Tue Feb 17 22:45:55 2015 +0300

    Merge branch 'master' into assert

    * master: (25 commits)
      improve debugability in TS debug builds
      More UPGRADING, in particular on foreach
      Fixed bug #69038 (switch(SOMECONSTANT) misbehaves) for master
      Replace var is introduced
      abstain from using xmlCleanupParser
      fix TS build
      Fix bug #68942 (Use after free vulnerability in unserialize() with DateTimeZone)
      update news
      Fix bug #68942 (Use after free vulnerability in unserialize() with DateTimeZone)
      Port for for bug #68552
      Fix bug #68942 (Use after free vulnerability in unserialize() with DateTimeZone)
      Update NEWS
      Fixed bug #69038 (switch(SOMECONSTANT) misbehaves)
      - BFN
      Don't read the local php.ini when Generating Phar When building phar shared, you can end up loading a previous phar.so that isn't compatible with the php cli being used to generate Phar here.
      - Fixed bug #67827 (broken detection of system crypt sha256/sha512 support)
      Delete json outdated package.xml
      made ZEND_TSRMLS_CACHE_* macros look like function calls
      - Fix merge
      - Fixed bug #67427 (SoapServer cannot handle large messages) patch by: brandt at docoloc dot de
      ...

commit 4a2d9c0
Author: Dmitry Stogov <[email protected]>
Date:   Tue Feb 17 22:45:10 2015 +0300

    Implemented AST pretty-printer to capture expression passed to assert()

commit 7a059b6
Merge: 9973df7 3892eba
Author: Dmitry Stogov <[email protected]>
Date:   Mon Feb 16 18:42:28 2015 +0300

    Merge branch 'expect' of github.com:krakjoe/php-src into assert

    * 'expect' of github.com:krakjoe/php-src:
      import expect

    Conflicts:
    	Zend/zend_compile.c
    	Zend/zend_execute_API.c
    	Zend/zend_globals.h
    	Zend/zend_vm_def.h
    	Zend/zend_vm_execute.h
    	Zend/zend_vm_opcodes.c
    	Zend/zend_vm_opcodes.h
    	ext/opcache/Optimizer/block_pass.c
    	ext/opcache/Optimizer/pass1_5.c
    	ext/standard/assert.c
    	ext/standard/tests/assert/assert_error3.phpt

commit 3892eba
Author: krakjoe <[email protected]>
Date:   Sun Feb 2 12:49:35 2014 +0000

    import expect

Author: dstogov

Zend/tests/assert/expect_001.phpt

@@ -0,0 +1,12 @@
+--TEST--
+test passing assertion
+--INI--
+zend.assertions=1
+assert.exception=1
+--FILE--
+<?php
+assert(true);
+var_dump(true);
+?>
+--EXPECTF--
+bool(true)

Zend/tests/assert/expect_002.phpt

@@ -0,0 +1,16 @@
+--TEST--
+test failing assertion
+--INI--
+zend.assertions=1
+assert.exception=1
+--FILE--
+<?php
+assert(false);
+var_dump(true);
+?>
+--EXPECTF--
+Fatal error: Uncaught exception 'AssertionException' with message 'assert(false)' in %sexpect_002.php:%d
+Stack trace:
+#0 %sexpect_002.php(%d): assert(false, 'assert(false)')
+#1 {main}
+  thrown in %sexpect_002.php on line %d

Zend/tests/assert/expect_003.phpt

@@ -0,0 +1,15 @@
+--TEST--
+test catching failed assertion
+--INI--
+zend.assertions=1
+assert.exception=1
+--FILE--
+<?php
+try {
+    assert(false);
+} catch (AssertionException $ex) {
+    var_dump($ex->getMessage());
+}
+?>
+--EXPECT--
+string(13) "assert(false)"

Zend/tests/assert/expect_004.phpt

@@ -0,0 +1,15 @@
+--TEST--
+test providing reason (fail)
+--INI--
+zend.assertions=1
+assert.exception=1
+--FILE--
+<?php
+try {
+    assert(false, "I require this to succeed");
+} catch (AssertionException $ex) {
+    var_dump($ex->getMessage());
+}
+?>
+--EXPECT--
+string(25) "I require this to succeed"

Zend/tests/assert/expect_005.phpt

@@ -0,0 +1,17 @@
+--TEST--
+test providing reason (pass)
+--INI--
+zend.assertions=1
+assert.exception=1
+--FILE--
+<?php
+try {
+    /* by passing we test there are no leaks upon success */
+    assert(true, "I require this to succeed");
+} catch (AssertionException $ex) {
+    var_dump($ex->getMessage());
+}
+var_dump(true);
+?>
+--EXPECT--
+bool(true)

Zend/tests/assert/expect_006.phpt

@@ -0,0 +1,14 @@
+--TEST--
+test looping assert (pass)
+--INI--
+zend.assertions=1
+assert.exception=1
+--FILE--
+<?php
+for($i=0; $i<100000; $i++) {
+    assert ($i < 100000, "The universe should make sense");
+}
+var_dump(true);
+?>
+--EXPECT--
+bool(true)

Zend/tests/assert/expect_007.phpt

@@ -0,0 +1,22 @@
+--TEST--
+test compiled reason
+--INI--
+zend.assertions=1
+assert.exception=1
+--FILE--
+<?php
+$next = 1;
+$data = array(
+    "key" => "X-HTTP ",
+    "value" => "testing"
+);
+
+class HeaderMalfunctionException extends AssertionException {}
+
+assert (preg_match("~^([a-zA-Z0-9-]+)$~", $data["key"]), new HeaderMalfunctionException("malformed key found at {$next} \"{$data["key"]}\""));
+?>
+--EXPECTF--
+Fatal error: Uncaught exception 'HeaderMalfunctionException' with message 'malformed key found at 1 "X-HTTP "' in %sexpect_007.php:10
+Stack trace:
+#0 {main}
+  thrown in %sexpect_007.php on line 10

Zend/tests/assert/expect_008.phpt

@@ -0,0 +1,34 @@
+--TEST--
+test disabled expectations have no ill side effects
+--INI--
+zend.assertions=0
+assert.exception=1
+--FILE--
+<?php
+class One {
+    public function __construct() {
+        assert($this || 0);
+    }
+}
+class Two extends One {}
+
+class OdEar extends AssertionException {}
+
+function blah(){ return 1; }
+
+$variable = 1;
+assert(true, "constant message");
+assert(($variable && $variable) || php_sapi_name(), new OdEar("constant message"));
+assert(false);
+assert(blah(), blah());
+
+new Two();
+new Two();
+new Two();
+
+assert (blah() || blah() || blah(), blah() || blah() || blah() || blah());
+
+var_dump(true);
+?>
+--EXPECT--
+bool(true)

Zend/tests/assert/expect_009.phpt

@@ -0,0 +1,25 @@
+--TEST--
+test stack trace is correct from failed exception in extended class
+--INI--
+zend.assertions=1
+assert.exception=1
+--FILE--
+<?php
+class One {
+    public function __construct() {
+    }
+}
+class Two extends One {
+    public function __construct() {
+        assert(false);
+    }
+}
+new Two();
+?>
+--EXPECTF--
+Fatal error: Uncaught exception 'AssertionException' with message 'assert(false)' in %sexpect_009.php:%d
+Stack trace:
+#0 %sexpect_009.php(%d): assert(false, 'assert(false)')
+#1 %sexpect_009.php(%d): Two->__construct()
+#2 {main}
+  thrown in %sexpect_009.php on line %d

Zend/tests/assert/expect_010.phpt

@@ -0,0 +1,23 @@
+--TEST--
+test stack trace is correct from failed exception in extended class (parent implementing constructor)
+--INI--
+zend.assertions=1
+assert.exception=1
+--FILE--
+<?php
+class One {
+    public function __construct() {
+        assert(false);
+    }
+}
+class Two extends One {}
+
+new Two();
+?>
+--EXPECTF--
+Fatal error: Uncaught exception 'AssertionException' with message 'assert(false)' in %sexpect_010.php:%d
+Stack trace:
+#0 %sexpect_010.php(%d): assert(false, 'assert(false)')
+#1 %sexpect_010.php(%d): One->__construct()
+#2 {main}
+  thrown in %sexpect_010.php on line %d

Zend/tests/assert/expect_011.phpt

@@ -0,0 +1,30 @@
+--TEST--
+test overloaded __toString on custom exception
+--INI--
+zend.assertions=1
+assert.exception=1
+--FILE--
+<?php
+class MyExpectations extends AssertionException {
+    public function __toString() {
+        return sprintf(
+            "[Message]: %s", __CLASS__);
+    }
+}
+
+class One {
+    public function __construct() {
+        assert(false, (string) new MyExpectations());
+    }
+}
+class Two extends One {}
+
+new Two();
+?>
+--EXPECTF--
+Fatal error: Uncaught exception 'AssertionException' with message '[Message]: MyExpectations' in %sexpect_011.php:%d
+Stack trace:
+#0 %sexpect_011.php(%d): assert(false, '[Message]: MyEx...')
+#1 %sexpect_011.php(%d): One->__construct()
+#2 {main}
+  thrown in %sexpect_011.php on line %d

Zend/tests/assert/expect_012.phpt

@@ -0,0 +1,21 @@
+--TEST--
+test enable/disable assertions at runtime
+--INI--
+zend.assertions=1
+assert.exception=1
+--FILE--
+<?php
+var_dump((integer)ini_get("zend.assertions"));
+ini_set("zend.assertions", 0);
+var_dump((integer)ini_get("zend.assertions"));
+assert(false);
+ini_set("zend.assertions", 1);
+var_dump((integer)ini_get("zend.assertions"));
+assert(true);
+var_dump(true);
+?>
+--EXPECT--
+int(1)
+int(0)
+int(1)
+bool(true)

Zend/tests/assert/expect_013.phpt

@@ -0,0 +1,11 @@
+--TEST--
+test failing assertion when disabled (with return value)
+--INI--
+zend.assertions=0
+assert.exception=1
+--FILE--
+<?php
+var_dump(assert(false));
+?>
+--EXPECT--
+bool(true)

Zend/tests/assert/expect_014.phpt

@@ -0,0 +1,12 @@
+--TEST--
+test failing assertion when disabled
+--INI--
+zend.assertions=0
+assert.exception=1
+--FILE--
+<?php
+assert(false);
+var_dump(true);
+?>
+--EXPECT--
+bool(true)