Test coverage (#406)

- add test coverage
- Updated the localhost for http/2 to be setup from builder instead.
- trivial updates for the localhost port to avoid conflict with other local server.

Author: TingDaoK

.builder/action/aws-c-http-test.py

@@ -33,5 +33,7 @@ def run(self, env):
             os.chdir('../../aws-c-http')
 
         actions.append(['ctest', '--output-on-failure'])
+        # generate the test coverage report whenever possible, will be ignored by ctest if there is no test coverage data available.
+        actions.append(['ctest', '-T', 'coverage'])
 
         return Builder.Script(actions, name='aws-c-http-test')

.builder/action/local-server-setup.py

@@ -0,0 +1,46 @@
+"""
+Setup local server for tests
+"""
+
+import Builder
+
+import os
+import sys
+import subprocess
+import atexit
+
+
+class LocalServerSetup(Builder.Action):
+    """
+    Set up this machine for running the local h2 server test.
+    To run the local server related test, use `--cmake-extra=-DENABLE_LOCALHOST_INTEGRATION_TESTS=ON` from builder.
+    Not running local server tests for every CI as it takes a while.
+
+    This action should be run in the 'pre_build_steps' or 'build_steps' stage.
+    """
+
+    def run(self, env):
+        self.env = env
+        python_path = sys.executable
+        # Install dependency for mock server.
+        # Okay to fail, and if it fails, you will know when you enable the localhost tests.
+        # We don't need it to succeed on every platform we have.
+        result = self.env.shell.exec(python_path,
+                                     '-m', 'pip', 'install', 'h2')
+        if result.returncode != 0:
+            print(
+                "Could not install python HTTP/2 server." +
+                " The localhost integration tests will fail if you run them.", file=sys.stderr)
+            return
+
+        base_dir = os.path.dirname(os.path.realpath(__file__))
+        dir = os.path.join(base_dir, "..", "..", "tests", "py_localhost")
+        os.chdir(dir)
+
+        p_server = subprocess.Popen([python_path, "server.py"])
+        p_non_tls_server = subprocess.Popen([python_path, "non_tls_server.py"])
+
+        @atexit.register
+        def close_local_server():
+            p_server.terminate()
+            p_non_tls_server.terminate()

.github/workflows/ci.yml

@@ -6,7 +6,7 @@ on:
       - 'main'
 
 env:
-  BUILDER_VERSION: v0.9.26
+  BUILDER_VERSION: v0.9.29
   BUILDER_SOURCE: releases
   BUILDER_HOST: https://d19elf31gohf1l.cloudfront.net
   PACKAGE_NAME: aws-c-http
@@ -155,12 +155,6 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v3
-    - name: Configure local host
-      run: |
-        python3 -m pip install h2
-        cd ./tests/py_localhost/
-        python3 server.py &
-        python3 non_tls_server.py &
     - name: Build and test
       run: |
         python3 -c "from urllib.request import urlretrieve; urlretrieve('${{ env.BUILDER_HOST }}/${{ env.BUILDER_SOURCE }}/${{ env.BUILDER_VERSION }}/builder.pyz?run=${{ env.RUN }}', 'builder.pyz')"
@@ -171,12 +165,6 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v3
-    - name: Configure local host
-      run: |
-        python3 -m pip install h2
-        cd ./tests/py_localhost/
-        python3 server.py &
-        python3 non_tls_server.py &
     - name: Build and test
       run: |
         python3 -c "from urllib.request import urlretrieve; urlretrieve('${{ env.BUILDER_HOST }}/${{ env.BUILDER_SOURCE }}/${{ env.BUILDER_VERSION }}/builder.pyz?run=${{ env.RUN }}', 'builder.pyz')"
@@ -187,13 +175,7 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v3
-    - name: Configure local host
-      run: |
-        python -m pip install h2
     - name: Build and test
       run: |
-        cd ./tests/py_localhost/
-        Start-Process -NoNewWindow python .\server.py
-        Start-Process -NoNewWindow python .\non_tls_server.py
         python -c "from urllib.request import urlretrieve; urlretrieve('${{ env.BUILDER_HOST }}/${{ env.BUILDER_SOURCE }}/${{ env.BUILDER_VERSION }}/builder.pyz?run=${{ env.RUN }}', 'builder.pyz')"
         python builder.pyz build -p aws-c-http --cmake-extra=-DENABLE_LOCALHOST_INTEGRATION_TESTS=ON

builder.json

@@ -15,6 +15,7 @@
         { "name": "aws-c-mqtt" },
         { "name": "aws-c-s3" }
     ],
+    "pre_build_steps": ["local-server-setup"],
     "test_steps": [
         "aws-c-http-test",
         ["{python}", "{source_dir}/integration-testing/http_client_test.py", "{install_dir}/bin/elasticurl{exe}"]

codebuild/linux-integration-tests.yml

@@ -10,7 +10,7 @@ phases:
   pre_build:
     commands:
       - export CC=gcc-7
-      - export BUILDER_VERSION=v0.9.12
+      - export BUILDER_VERSION=v0.9.29
       - export BUILDER_SOURCE=releases
       - export BUILDER_HOST=https://d19elf31gohf1l.cloudfront.net
   build:
@@ -19,7 +19,7 @@ phases:
       - aws s3 cp s3://aws-crt-test-stuff/setup_proxy_test_env_h2.sh /tmp/setup_proxy_test_env.sh
       - chmod a+xr /tmp/setup_proxy_test_env.sh
       - python3 -c "from urllib.request import urlretrieve; urlretrieve('$BUILDER_HOST/$BUILDER_SOURCE/$BUILDER_VERSION/builder.pyz', 'builder.pyz')"
-      - python3 builder.pyz build -p aws-c-http --cmake-extra=-DENABLE_PROXY_INTEGRATION_TESTS=ON
+      - python3 builder.pyz build -p aws-c-http --cmake-extra=-DENABLE_PROXY_INTEGRATION_TESTS=ON --cmake-extra=-DENABLE_LOCALHOST_INTEGRATION_TESTS=ON --coverage
   post_build:
     commands:
       - echo Build completed on `date`

tests/h2_test_helper.c

@@ -27,6 +27,9 @@ static void s_frame_init(
 }
 
 static void s_frame_clean_up(struct h2_decoded_frame *frame) {
+    if (!frame) {
+        return;
+    }
     aws_http_headers_release(frame->headers);
     aws_array_list_clean_up(&frame->settings);
     aws_byte_buf_clean_up(&frame->data);

tests/py_localhost/README.md

@@ -17,12 +17,12 @@ Python 3.5+ required.
 #### Echo
 
 - Minor changed based on the example to response the headers of requests back within the headers from `/echo`.
-- To test the server runs correctly, you can do `curl -k -v -H "foo:bar" https://localhost:8443/echo` and check the result.
+- To test the server runs correctly, you can do `curl -k -v -H "foo:bar" https://localhost:3443/echo` and check the result.
 
 #### Download test
 
 - To test download, when `:path` is `/downloadTest`, server will response a repeated string with length `self.download_test_length`, which is 2,500,000,000 now. It will be repeats of sting "This is CRT HTTP test."
-- To test the server runs correctly, you can do `curl -k -v -H "foo:bar" https://localhost:8443/downloadTest` and check the result.
+- To test the server runs correctly, you can do `curl -k -v -H "foo:bar" https://localhost:3443/downloadTest` and check the result.
 
 #### Slow Connection Test
 
@@ -31,10 +31,10 @@ Python 3.5+ required.
 #### Upload test
 
 - To test upload, when `:method` is `POST` or `PUT`, server will response the length received from response body
-- To test the server runs correctly, you can do `curl -k -X POST -F'data=@upload_test.txt' https://localhost:8443/upload_test` where `upload_test.txt` is file to upload.
+- To test the server runs correctly, you can do `curl -k -X POST -F'data=@upload_test.txt' https://localhost:3443/upload_test` where `upload_test.txt` is file to upload.
 
 ### Non-TLS server
 
 - The code is based the non-tls [example](http://python-hyper.org/projects/h2/en/stable/basic-usage.html) from hyper h2 server.
 - Run python. `python3 ./non_tls_server.py`.
-- To test the server runs correctly, you can do `curl -v --http2-prior-knowledge http://localhost:8080` and check the result.
+- To test the server runs correctly, you can do `curl -v --http2-prior-knowledge http://localhost:3280` and check the result.

tests/py_localhost/non_tls_server.py

@@ -49,7 +49,7 @@ def handle(sock):
 
 sock = socket.socket()
 sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
-sock.bind(('0.0.0.0', 8080))
+sock.bind(('0.0.0.0', 3280))
 sock.listen(5)
 
 while True:

tests/py_localhost/server.py

@@ -313,7 +313,7 @@ def window_updated(self, stream_id, delta):
 
 loop = asyncio.new_event_loop()
 # Each client connection will create a new protocol instance
-coro = loop.create_server(H2Protocol, '127.0.0.1', 8443, ssl=ssl_context)
+coro = loop.create_server(H2Protocol, '127.0.0.1', 3443, ssl=ssl_context)
 server = loop.run_until_complete(coro)
 
 # Serve requests until Ctrl+C is pressed

tests/test_connection_manager.c

@@ -119,8 +119,8 @@ static void s_cm_tester_on_cm_shutdown_complete(void *user_data) {
 
     aws_mutex_lock(&tester->lock);
     tester->is_shutdown_complete = true;
-    aws_mutex_unlock(&tester->lock);
     aws_condition_variable_notify_one(&tester->signal);
+    aws_mutex_unlock(&tester->lock);
 }
 
 static struct aws_event_loop *s_new_event_loop(
@@ -872,7 +872,7 @@ static int s_test_connection_manager_proxy_setup_shutdown(struct aws_allocator *
 
     struct aws_http_proxy_options proxy_options = {
         .host = aws_byte_cursor_from_c_str("127.0.0.1"),
-        .port = 8080,
+        .port = 3280,
     };
 
     struct cm_tester_options options = {
@@ -1367,8 +1367,8 @@ static void s_aws_http_on_stream_complete_proxy_test(struct aws_http_stream *str
 
     aws_mutex_lock(&tester->lock);
     tester->proxy_request_complete = true;
-    aws_mutex_unlock(&tester->lock);
     aws_condition_variable_notify_one(&tester->signal);
+    aws_mutex_unlock(&tester->lock);
 }
 
 static struct aws_byte_cursor s_get_proxy_host_for_test(