From 7e925c92fb8684dee5608b6695c137bdd23e8428 Mon Sep 17 00:00:00 2001
From: Justin Boswell <boswej@amazon.com>
Date: Wed, 5 May 2021 13:37:47 -0700
Subject: [PATCH] Cleanup pass based on prior PRs (#21)

* Updates to stub generation

* More idiomatic fixes from PHP team

* Moved tests from src/tests -> tests, got rid of extension-only tests

* fixed up test paths, regenerated arginfo
---
 composer.json                                  |  7 +------
 ext/awscrt.stub.php                            |  5 ++++-
 ext/awscrt_arginfo.h                           |  2 +-
 src/AWS/CRT/Auth/AwsCredentials.php            |  5 ++++-
 src/AWS/CRT/Auth/CredentialsProvider.php       |  5 ++++-
 src/AWS/CRT/Auth/StaticCredentialsProvider.php |  5 ++++-
 src/AWS/CRT/CRT.php                            |  7 +++++--
 src/AWS/CRT/HTTP/Headers.php                   |  5 ++++-
 src/AWS/CRT/HTTP/Message.php                   |  6 +++++-
 src/AWS/CRT/HTTP/Request.php                   |  7 +++++--
 src/AWS/CRT/HTTP/Response.php                  |  5 ++++-
 src/AWS/CRT/IO/EventLoopGroup.php              |  5 ++++-
 src/AWS/CRT/IO/InputStream.php                 |  5 ++++-
 src/AWS/CRT/Internal/Encoding.php              |  5 ++++-
 src/AWS/CRT/Internal/Extension.php             |  5 ++++-
 src/AWS/CRT/NativeResource.php                 |  5 ++++-
 src/AWS/CRT/Options.php                        |  5 ++++-
 src/tests/common.inc                           | 12 ------------
 {src/tests => tests}/CredentialsTest.php       |  5 ++++-
 {src/tests => tests}/ErrorTest.php             |  5 ++++-
 {src/tests => tests}/EventLoopGroupTest.php    |  5 ++++-
 {src/tests => tests}/HttpMessageTest.php       |  6 ++++--
 {src/tests => tests}/StreamTest.php            |  5 ++++-
 tests/aws_crt_error_debug_str.phpt             | 14 --------------
 tests/aws_crt_error_name.phpt                  | 14 --------------
 tests/aws_crt_error_str.phpt                   | 14 --------------
 tests/aws_crt_event_loop_group.phpt            | 16 ----------------
 tests/aws_crt_last_error.phpt                  | 14 --------------
 tests/common.inc                               | 16 ++++++++++++++--
 tests/skipif.inc                               |  3 ---
 30 files changed, 99 insertions(+), 119 deletions(-)
 delete mode 100644 src/tests/common.inc
 rename {src/tests => tests}/CredentialsTest.php (93%)
 rename {src/tests => tests}/ErrorTest.php (84%)
 rename {src/tests => tests}/EventLoopGroupTest.php (83%)
 rename {src/tests => tests}/HttpMessageTest.php (96%)
 rename {src/tests => tests}/StreamTest.php (91%)
 delete mode 100644 tests/aws_crt_error_debug_str.phpt
 delete mode 100644 tests/aws_crt_error_name.phpt
 delete mode 100644 tests/aws_crt_error_str.phpt
 delete mode 100644 tests/aws_crt_event_loop_group.phpt
 delete mode 100644 tests/aws_crt_last_error.phpt
 delete mode 100644 tests/skipif.inc

diff --git a/composer.json b/composer.json
index e887136..0d9b878 100644
--- a/composer.json
+++ b/composer.json
@@ -27,13 +27,8 @@
             "src/"
         ]
     },
-    "autoload-dev": {
-        "classmap": [
-            "src/tests/"
-        ]
-    },
     "scripts": {
-        "test": "@php -d extension=modules/awscrt.so vendor/bin/phpunit src/tests"
+        "test": "@php -d extension=modules/awscrt.so vendor/bin/phpunit tests"
     },
     "license": "Apache-2.0"
 }
diff --git a/ext/awscrt.stub.php b/ext/awscrt.stub.php
index d3a79cf..b795083 100644
--- a/ext/awscrt.stub.php
+++ b/ext/awscrt.stub.php
@@ -1,6 +1,9 @@
 <?php
 
-/** @generate-class-entries */
+/**
+ * @generate-class-entries
+ * @generate-function-entries
+*/
 
 function aws_crt_last_error(): int {}
 
diff --git a/ext/awscrt_arginfo.h b/ext/awscrt_arginfo.h
index 7ba89ef..9657da2 100644
--- a/ext/awscrt_arginfo.h
+++ b/ext/awscrt_arginfo.h
@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: bd274f6b280b27aa5fb7d3be2ce85ad065936943 */
+ * Stub hash: 5101b351fa7644a60919f40e09b7877a31a6d3bd */
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_aws_crt_last_error, 0, 0, IS_LONG, 0)
 ZEND_END_ARG_INFO()
diff --git a/src/AWS/CRT/Auth/AwsCredentials.php b/src/AWS/CRT/Auth/AwsCredentials.php
index 87b3606..1e13852 100644
--- a/src/AWS/CRT/Auth/AwsCredentials.php
+++ b/src/AWS/CRT/Auth/AwsCredentials.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 namespace AWS\CRT\Auth;
 
 use AWS\CRT\NativeResource as NativeResource;
diff --git a/src/AWS/CRT/Auth/CredentialsProvider.php b/src/AWS/CRT/Auth/CredentialsProvider.php
index de7409d..e9d3588 100644
--- a/src/AWS/CRT/Auth/CredentialsProvider.php
+++ b/src/AWS/CRT/Auth/CredentialsProvider.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 namespace AWS\CRT\Auth;
 
 use AWS\CRT\NativeResource as NativeResource;
diff --git a/src/AWS/CRT/Auth/StaticCredentialsProvider.php b/src/AWS/CRT/Auth/StaticCredentialsProvider.php
index 9b51cf3..3467e9b 100644
--- a/src/AWS/CRT/Auth/StaticCredentialsProvider.php
+++ b/src/AWS/CRT/Auth/StaticCredentialsProvider.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 namespace AWS\CRT\Auth;
 
 /**
diff --git a/src/AWS/CRT/CRT.php b/src/AWS/CRT/CRT.php
index 58f4a85..5fd2124 100644
--- a/src/AWS/CRT/CRT.php
+++ b/src/AWS/CRT/CRT.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 namespace AWS\CRT;
 
 use AWS\CRT\Internal\Extension;
@@ -102,7 +105,7 @@ final class CRT {
      * @param object $elg Pointer to the event loop group to release
      */
     function event_loop_group_release($elg) {
-        return self::$impl->aws_crt_event_loop_group_release($elg);
+        self::$impl->aws_crt_event_loop_group_release($elg);
     }
 
     /**
diff --git a/src/AWS/CRT/HTTP/Headers.php b/src/AWS/CRT/HTTP/Headers.php
index 4744182..8d1457c 100644
--- a/src/AWS/CRT/HTTP/Headers.php
+++ b/src/AWS/CRT/HTTP/Headers.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 namespace AWS\CRT\HTTP;
 
 use AWS\CRT\Internal\Encoding;
diff --git a/src/AWS/CRT/HTTP/Message.php b/src/AWS/CRT/HTTP/Message.php
index a148f16..a21bd85 100644
--- a/src/AWS/CRT/HTTP/Message.php
+++ b/src/AWS/CRT/HTTP/Message.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 namespace AWS\CRT\HTTP;
 
 use AWS\CRT\NativeResource;
@@ -12,6 +15,7 @@ abstract class Message extends NativeResource {
     private $headers;
 
     public function __construct($method, $path, $query = [], $headers = []) {
+        parent::__construct();
         $this->method = $method;
         $this->path = $path;
         $this->query = $query;
diff --git a/src/AWS/CRT/HTTP/Request.php b/src/AWS/CRT/HTTP/Request.php
index 302b7c0..9b4f07c 100644
--- a/src/AWS/CRT/HTTP/Request.php
+++ b/src/AWS/CRT/HTTP/Request.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 namespace AWS\CRT\HTTP;
 
 use AWS\CRT\IO\InputStream;
@@ -10,7 +13,7 @@ class Request extends Message {
     public function __construct($method, $path, $query = [], $headers = [], $body_stream = null) {
         parent::__construct($method, $path, $query, $headers);
         if (!is_null($body_stream) && !($body_stream instanceof InputStream)) {
-            throw \InvalidArgumentException('body_stream must be an ' . InputStream::class);
+            throw InvalidArgumentException('body_stream must be an instance of ' . InputStream::class);
         }
         $this->body_stream = $body_stream;
     }
diff --git a/src/AWS/CRT/HTTP/Response.php b/src/AWS/CRT/HTTP/Response.php
index a0f97e4..526edc3 100644
--- a/src/AWS/CRT/HTTP/Response.php
+++ b/src/AWS/CRT/HTTP/Response.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 namespace AWS\CRT\HTTP;
 
 class Response extends Message {
diff --git a/src/AWS/CRT/IO/EventLoopGroup.php b/src/AWS/CRT/IO/EventLoopGroup.php
index b6e38bc..b1c297b 100644
--- a/src/AWS/CRT/IO/EventLoopGroup.php
+++ b/src/AWS/CRT/IO/EventLoopGroup.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 namespace AWS\CRT\IO;
 
 use AWS\CRT\NativeResource as NativeResource;
diff --git a/src/AWS/CRT/IO/InputStream.php b/src/AWS/CRT/IO/InputStream.php
index 02a57eb..ae5fd46 100644
--- a/src/AWS/CRT/IO/InputStream.php
+++ b/src/AWS/CRT/IO/InputStream.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 namespace AWS\CRT\IO;
 
 use AWS\CRT\NativeResource as NativeResource;
diff --git a/src/AWS/CRT/Internal/Encoding.php b/src/AWS/CRT/Internal/Encoding.php
index 87e07ac..7fc93f4 100644
--- a/src/AWS/CRT/Internal/Encoding.php
+++ b/src/AWS/CRT/Internal/Encoding.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 namespace AWS\CRT\Internal;
 
 final class Encoding {
diff --git a/src/AWS/CRT/Internal/Extension.php b/src/AWS/CRT/Internal/Extension.php
index 78a5f59..7801788 100644
--- a/src/AWS/CRT/Internal/Extension.php
+++ b/src/AWS/CRT/Internal/Extension.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 namespace AWS\CRT\Internal;
 
 use \RuntimeException;
diff --git a/src/AWS/CRT/NativeResource.php b/src/AWS/CRT/NativeResource.php
index 6fc5bb4..f1f8815 100644
--- a/src/AWS/CRT/NativeResource.php
+++ b/src/AWS/CRT/NativeResource.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 namespace AWS\CRT;
 
 use AWS\CRT\CRT as CRT;
diff --git a/src/AWS/CRT/Options.php b/src/AWS/CRT/Options.php
index 56f2366..dcb7776 100644
--- a/src/AWS/CRT/Options.php
+++ b/src/AWS/CRT/Options.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 namespace AWS\CRT;
 
 final class Options {
diff --git a/src/tests/common.inc b/src/tests/common.inc
deleted file mode 100644
index 588850d..0000000
--- a/src/tests/common.inc
+++ /dev/null
@@ -1,12 +0,0 @@
-<?php
-
-use AWS\CRT\CRT as CRT;
-
-abstract class CrtTestCase extends PHPUnit_Framework_TestCase {
-    // Ensure that after every test there are no errors in the CRT itself
-    protected function assertPostConditions() {
-        if (CRT::last_error()) {
-            $this->fail("Test left an error on the stack: " . CRT::error_name(CRT::last_error()));
-        }
-    }
-}
diff --git a/src/tests/CredentialsTest.php b/tests/CredentialsTest.php
similarity index 93%
rename from src/tests/CredentialsTest.php
rename to tests/CredentialsTest.php
index f645e1b..32a9c42 100644
--- a/src/tests/CredentialsTest.php
+++ b/tests/CredentialsTest.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 use AWS\CRT\Auth\AwsCredentials as AwsCredentials;
 use AWS\CRT\Auth\StaticCredentialsProvider as StaticCredentialsProvider;
 
diff --git a/src/tests/ErrorTest.php b/tests/ErrorTest.php
similarity index 84%
rename from src/tests/ErrorTest.php
rename to tests/ErrorTest.php
index 5027987..a9920ae 100644
--- a/src/tests/ErrorTest.php
+++ b/tests/ErrorTest.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 use AWS\CRT\CRT;
 
 final class ErrorTest extends PHPUnit_Framework_TestCase {
diff --git a/src/tests/EventLoopGroupTest.php b/tests/EventLoopGroupTest.php
similarity index 83%
rename from src/tests/EventLoopGroupTest.php
rename to tests/EventLoopGroupTest.php
index 8328e70..6a52c69 100644
--- a/src/tests/EventLoopGroupTest.php
+++ b/tests/EventLoopGroupTest.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 use AWS\CRT\IO\EventLoopGroup as EventLoopGroup;
 
 require_once('common.inc');
diff --git a/src/tests/HttpMessageTest.php b/tests/HttpMessageTest.php
similarity index 96%
rename from src/tests/HttpMessageTest.php
rename to tests/HttpMessageTest.php
index 4928e90..eec18b6 100644
--- a/src/tests/HttpMessageTest.php
+++ b/tests/HttpMessageTest.php
@@ -1,6 +1,8 @@
 <?php
-
-use AWS\CRT\HTTP\Message;
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 use AWS\CRT\HTTP\Headers;
 use AWS\CRT\HTTP\Request;
 use AWS\CRT\HTTP\Response;
diff --git a/src/tests/StreamTest.php b/tests/StreamTest.php
similarity index 91%
rename from src/tests/StreamTest.php
rename to tests/StreamTest.php
index f7e8c7d..f8a116a 100644
--- a/src/tests/StreamTest.php
+++ b/tests/StreamTest.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
 use AWS\CRT\IO\InputStream as InputStream;
 
 require_once('common.inc');
diff --git a/tests/aws_crt_error_debug_str.phpt b/tests/aws_crt_error_debug_str.phpt
deleted file mode 100644
index 15fb5df..0000000
--- a/tests/aws_crt_error_debug_str.phpt
+++ /dev/null
@@ -1,14 +0,0 @@
---TEST--
-aws_crt_error_debug_str
---SKIPIF--
-<?php
-require_once(dirname(__FILE__) . '/skipif.inc');
-?>
---FILE--
-<?php
-require_once(dirname(__FILE__) . '/common.inc');
-
-echo aws_crt_error_debug_str(0);
-?>
---EXPECT--
-aws-c-common: AWS_ERROR_SUCCESS, Success.
diff --git a/tests/aws_crt_error_name.phpt b/tests/aws_crt_error_name.phpt
deleted file mode 100644
index 1d1c779..0000000
--- a/tests/aws_crt_error_name.phpt
+++ /dev/null
@@ -1,14 +0,0 @@
---TEST--
-aws_crt_error_name
---SKIPIF--
-<?php
-require_once(dirname(__FILE__) . '/skipif.inc');
-?>
---FILE--
-<?php
-require_once(dirname(__FILE__) . '/common.inc');
-
-echo aws_crt_error_name(0);
-?>
---EXPECT--
-AWS_ERROR_SUCCESS
diff --git a/tests/aws_crt_error_str.phpt b/tests/aws_crt_error_str.phpt
deleted file mode 100644
index ba9703f..0000000
--- a/tests/aws_crt_error_str.phpt
+++ /dev/null
@@ -1,14 +0,0 @@
---TEST--
-aws_crt_error_str
---SKIPIF--
-<?php
-require_once(dirname(__FILE__) . '/skipif.inc');
-?>
---FILE--
-<?php
-require_once(dirname(__FILE__) . '/common.inc');
-
-echo aws_crt_error_str(0);
-?>
---EXPECT--
-Success.
diff --git a/tests/aws_crt_event_loop_group.phpt b/tests/aws_crt_event_loop_group.phpt
deleted file mode 100644
index a549a23..0000000
--- a/tests/aws_crt_event_loop_group.phpt
+++ /dev/null
@@ -1,16 +0,0 @@
---TEST--
-aws_crt_event_loop_group
---SKIPIF--
-<?php
-require_once(dirname(__FILE__) . '/skipif.inc');
-?>
---FILE--
-<?php
-require_once(dirname(__FILE__) . '/common.inc');
-
-$elg = aws_crt_event_loop_group_new(1);
-var_dump($elg);
-aws_crt_event_loop_group_release($elg);
-?>
---EXPECTREGEX--
-int\(\d+\)
diff --git a/tests/aws_crt_last_error.phpt b/tests/aws_crt_last_error.phpt
deleted file mode 100644
index 144e073..0000000
--- a/tests/aws_crt_last_error.phpt
+++ /dev/null
@@ -1,14 +0,0 @@
---TEST--
-aws_crt_last_error
---SKIPIF--
-<?php
-require_once(dirname(__FILE__) . '/skipif.inc');
-?>
---FILE--
-<?php
-require_once(dirname(__FILE__) . '/common.inc');
-
-echo aws_crt_last_error();
-?>
---EXPECT--
-0
diff --git a/tests/common.inc b/tests/common.inc
index de45b95..4156715 100644
--- a/tests/common.inc
+++ b/tests/common.inc
@@ -1,3 +1,15 @@
 <?php
-// Common setup for tests:
-?>
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+use AWS\CRT\CRT as CRT;
+
+abstract class CrtTestCase extends PHPUnit_Framework_TestCase {
+    // Ensure that after every test there are no errors in the CRT itself
+    protected function assertPostConditions() {
+        if (CRT::last_error()) {
+            $this->fail("Test left an error on the stack: " . CRT::error_name(CRT::last_error()));
+        }
+    }
+}
diff --git a/tests/skipif.inc b/tests/skipif.inc
deleted file mode 100644
index f0ac746..0000000
--- a/tests/skipif.inc
+++ /dev/null
@@ -1,3 +0,0 @@
-<?php
-    extension_loaded('awscrt') or die('awscrt is not available in this build');
-?>