Run test with valgrind

Avoid memory and file descriptor leak.

Author: baranyaib90

.github/workflows/cmake.yml

@@ -21,7 +21,7 @@ jobs:
       run: sudo apt-get update
 
     - name: Setup Dependencies
-      run: sudo apt-get install cmake libc-ares-dev libcurl4-openssl-dev libev-dev build-essential clang-tidy-12 ${{ matrix.compiler }} dnsutils python3-pip
+      run: sudo apt-get install cmake libc-ares-dev libcurl4-openssl-dev libev-dev build-essential clang-tidy-12 ${{ matrix.compiler }} dnsutils python3-pip valgrind
 
     - name: Setup Robot Framework
       run: sudo pip3 install robotframework
@@ -47,4 +47,6 @@ jobs:
       if: ${{ success() || failure() }}
       with:
         name: robot-logs-${{ matrix.compiler }}
-        path: ${{github.workspace}}/tests/robot/*.html
+        path: |
+          ${{github.workspace}}/tests/robot/*.html
+          ${{github.workspace}}/tests/robot/valgrind-*.log

.gitignore

@@ -17,3 +17,4 @@ log.html
 output.xml
 report.html
 custom_curl/
+valgrind-*.log

README.md

@@ -201,7 +201,7 @@ Usage: ./https_dns_proxy [-a <listen_addr>] [-p <listen_port>]
 
 Functional tests can be executed using [Robot Framework](https://robotframework.org/).
 
-dig command is expected to be available.
+dig and valgrind commands are expected to be available.
 
 ```
 pip3 install robotframework

tests/robot/functional_tests.robot

@@ -11,22 +11,40 @@ ${PORT}  55353
 
 
 *** Settings ***
-Test Setup     Start Proxy
 Test Teardown  Stop Proxy
 
 
 *** Keywords ***
+Common Test Setup
+  Set Test Variable  &{expected_logs}  loop destroyed=1  # last log line
+  Set Test Variable  @{error_logs}  [F]  # any fatal error
+
 Start Proxy
   [Arguments]  @{args}
   @{default_args} =  Create List  -v  -v  -v  -4  -p  ${PORT}
   @{proces_args} =  Combine Lists  ${default_args}  ${args}
   ${proxy} =  Start Process  ${BINARY_PATH}  @{proces_args}
-  # ...  stdout=${TEMPDIR}/https_dns_proxy_robot_test_stdout.txt
   ...  stderr=STDOUT  alias=proxy
   Set Test Variable  ${proxy}
-  Set Test Variable  &{expected_logs}  loop destroyed=1  # last log line
-  Set Test Variable  @{error_logs}  [F]  # any fatal error
+  Set Test Variable  ${dig_timeout}  2
+  Set Test Variable  ${dig_retry}  0
   Sleep  0.5
+  Common Test Setup
+
+Start Proxy With Valgrind
+  [Arguments]  @{args}
+  @{default_args} =  Create List  --track-fds=yes  --time-stamp=yes  --log-file=valgrind-%p.log
+  ...  --gen-suppressions=all  --tool=memcheck  --leak-check=full  --leak-resolution=high
+  ...  --show-leak-kinds=all  --track-origins=yes  --keep-stacktraces=alloc-and-free
+  ...  ${BINARY_PATH}  -v  -v  -v  -4  -p  ${PORT}
+  @{proces_args} =  Combine Lists  ${default_args}  ${args}
+  ${proxy} =  Start Process  valgrind  @{proces_args}
+  ...  stderr=STDOUT  alias=proxy
+  Set Test Variable  ${proxy}
+  Set Test Variable  ${dig_timeout}  4
+  Set Test Variable  ${dig_retry}  2
+  Sleep  3  # wait for valgrind to fire up the proxy
+  Common Test Setup
 
 Stop Proxy
   Send Signal To Process  SIGINT  ${proxy}
@@ -44,7 +62,7 @@ Stop Proxy
 
 Start Dig
   [Arguments]  ${domain}=google.com
-  ${handle} =  Start Process  dig  +timeout\=2  +retry\=0  @127.0.0.1  -p  ${PORT}  ${domain}
+  ${handle} =  Start Process  dig  +timeout\=${dig_timeout}  +retry\=${dig_retry}  @127.0.0.1  -p  ${PORT}  ${domain}
   ...  stderr=STDOUT  alias=dig
   [Return]  ${handle}
 
@@ -60,26 +78,31 @@ Run Dig
   ${handle} =  Start Dig  ${domain}
   Stop Dig  ${handle}
 
+Run Dig Parallel
+  ${dig_handles} =  Create List
+  FOR  ${domain}  IN  facebook.com  microsoft.com  youtube.com  maps.google.com  wikipedia.org  amazon.com
+    ${handle} =  Start Dig  ${domain}
+    Append To List  ${dig_handles}  ${handle}
+  END
+  FOR  ${handle}  IN  @{dig_handles}
+    Stop Dig  ${handle}
+  END
 
-*** Test Cases ***
-Simple smoke test
-  Run Dig
 
+*** Test Cases ***
 Handle Unbound Server Does Not Support HTTP/1.1
-  [Setup]  NONE
   Start Proxy  -x  -r  https://doh.mullvad.net/dns-query  # resolver uses Unbound
   Run Keyword And Expect Error  9 != 0  # timeout exit code
   ...  Run Dig
 
 Reuse HTTP/2 Connection
   [Documentation]  After first successful request, further requests should not open new connections
-  Run Dig  # opens first connection
-  ${dig_handles} =  Create List
-  FOR  ${domain}  IN  facebook.com  microsoft.com  youtube.com  maps.google.com  wikipedia.org  amazon.com
-    ${handle} =  Start Dig  ${domain}
-    Append To List  ${dig_handles}  ${handle}
-  END
-  FOR  ${handle}  IN  @{dig_handles}
-    Stop Dig  ${handle}
-  END
+  Start Proxy
+  Run Dig  # Simple smoke test and opens first connection
+  Run Dig Parallel
   Set To Dictionary  ${expected_logs}  curl opened socket=1  # curl must not open more sockets then 1
+
+Valgrind Resource Leak Check
+  Start Proxy With Valgrind
+  Run Dig Parallel
+