robot functional tests added

Todo: add more test

Author: baranyaib90

.github/workflows/cmake.yml

@@ -21,7 +21,10 @@ 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 }}
+      run: sudo apt-get install cmake libc-ares-dev libcurl4-openssl-dev libev-dev build-essential clang-tidy-12 ${{ matrix.compiler }} dnsutils python3-pip
+
+    - name: Setup Robot Framework
+      run: sudo pip3 install robotframework
 
     - name: Set clang-tidy
       run: sudo update-alternatives --install /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-12 100
@@ -36,3 +39,12 @@ jobs:
         CC: ${{ matrix.compiler }}
       # Build your program with the given configuration
       run: make -C ${{github.workspace}}/
+
+    - name: Test
+      run: make -C ${{github.workspace}}/ test ARGS="--verbose"
+
+    - uses: actions/upload-artifact@v2
+      if: ${{ success() || failure() }}
+      with:
+        name: robot-logs-${{ matrix.compiler }}
+        path: ${{github.workspace}}/tests/robot/*.html

.gitignore

@@ -13,3 +13,6 @@ install_manifest.txt
 .ninja_log
 build.ninja
 rules.ninja
+log.html
+output.xml
+report.html

CMakeLists.txt

@@ -1,6 +1,8 @@
 project(HttpsDnsProxy C)
 cmake_minimum_required(VERSION 3.7)
 
+# FUNCTIONS
+
 # source: https://stackoverflow.com/a/27990434
 function(define_file_basename_for_sources targetname)
   get_target_property(source_files "${targetname}" SOURCES)
@@ -12,6 +14,8 @@ function(define_file_basename_for_sources targetname)
   endforeach()
 endfunction()
 
+# CONFIG
+
 set(CMAKE_BUILD_TYPE "Debug")
 #set(CMAKE_BUILD_TYPE "Release")
 
@@ -24,6 +28,8 @@ if ((CMAKE_C_COMPILER_ID MATCHES GNU   AND CMAKE_C_COMPILER_VERSION VERSION_GREA
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-gnu-zero-variadic-macro-arguments -Wno-gnu-folding-constant")
 endif()
 
+# VERSION
+
 find_package(Git)
 if(Git_FOUND)
   execute_process(
@@ -42,13 +48,17 @@ else()
   message(WARNING "Could not find git command! Version is set to: ${GIT_VERSION}")
 endif()
 
+# LIBRARY DEPENDENCIES
+
 find_path(LIBCARES_INCLUDE_DIR ares.h)
 find_path(LIBCURL_INCLUDE_DIR curl/curl.h)
 find_path(LIBEV_INCLUDE_DIR ev.h)
 include_directories(
   ${LIBCARES_INCLUDE_DIR} ${LIBCURL_INCLUDE_DIR}
   ${LIBEV_INCLUDE_DIR} src)
 
+# CLANG TIDY
+
 find_program(
   CLANG_TIDY_EXE
   NAMES "clang-tidy"
@@ -61,6 +71,8 @@ else()
   set(DO_CLANG_TIDY "${CLANG_TIDY_EXE}" "-fix" "-checks=*,-clang-analyzer-alpha.*,-misc-unused-parameters,-cert-err34-c,-google-readability-todo,-hicpp-signed-bitwise,-cppcoreguidelines-avoid-magic-numbers,-readability-magic-numbers,-gnu-folding-constant,-gnu-zero-variadic-macro-arguments,-readability-function-cognitive-complexity,-concurrency-mt-unsafe")
 endif()
 
+# BUILD
+
 # The main binary
 set(TARGET_NAME "https_dns_proxy")
 aux_source_directory(src SRC_LIST)
@@ -82,6 +94,8 @@ if(CLANG_TIDY_EXE)
   )
 endif()
 
+# INSTALL
+
 install(TARGETS ${TARGET_NAME} DESTINATION bin)
 
 set(SERVICE_EXTRA_OPTIONS "")
@@ -100,3 +114,20 @@ configure_file(${TARGET_NAME}.service.in ${TARGET_NAME}.service)
 
 install(FILES ${TARGET_NAME}.service
         DESTINATION ${CMAKE_INSTALL_PREFIX}/lib/systemd/system/)
+
+# TESTING
+
+find_program(
+  PYTHON3_EXE
+  NAMES "python3"
+  DOC "Path to python3 executable"
+  )
+if(NOT PYTHON3_EXE)
+  message(STATUS "python3 not found, robot testing not possible")
+else()
+  message(STATUS "python3 found: ${PYTHON3_EXE}")
+
+  enable_testing()
+  add_test(NAME robot COMMAND ${PYTHON3_EXE} -m robot.run functional_tests.robot
+           WORKING_DIRECTORY tests/robot)
+endif()

README.md

@@ -183,6 +183,17 @@ Usage: ./https_dns_proxy [-a <listen_addr>] [-p <listen_port>]
   -h                     Print help and exit.
 ```
 
+## Testing
+
+Functional tests can be executed using [Robot Framework](https://robotframework.org/).
+
+dig command is expected to be available.
+
+```
+pip3 install robotframework
+python3 -m robot.run tests/robot/functional_tests.robot
+```
+
 ## TODO
 
 * Add some tests.

tests/robot/functional_tests.robot

@@ -0,0 +1,85 @@
+*** Settings ***
+Documentation  Simple functional tests for https_dns_proxy
+Library        OperatingSystem
+Library        Process
+Library        Collections
+
+
+*** Variables ***
+${BINARY_PATH}  ${CURDIR}/../../https_dns_proxy
+${PORT}  55353
+
+
+*** Settings ***
+Test Setup     Start Proxy
+Test Teardown  Stop Proxy
+
+
+*** Keywords ***
+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
+  Sleep  0.5
+
+Stop Proxy
+  Send Signal To Process  SIGINT  ${proxy}
+  ${result} =  Wait For Process  ${proxy}  timeout=15 secs
+  Log  ${result.stdout}
+  FOR  ${log}  ${times}  IN  &{expected_logs}
+    Should Contain X Times  ${result.stdout}  ${log}  ${times}
+  END
+  FOR  ${log}  IN  @{error_logs}
+    Run Keyword And Expect Error  not found
+    ...  Should Contain  ${result.stdout}  ${log}  msg=not found  values=False
+  END
+  Should Be Equal As Integers  ${result.rc}  0
+
+
+Start Dig
+  [Arguments]  ${domain}=google.com
+  ${handle} =  Start Process  dig  +timeout\=2  +retry\=0  @127.0.0.1  -p  ${PORT}  ${domain}
+  ...  stderr=STDOUT  alias=dig
+  [Return]  ${handle}
+
+Stop Dig
+  [Arguments]  ${handle}
+  ${result} =  Wait For Process  ${handle}  timeout=10 secs
+  Log  ${result.stdout}
+  Should Be Equal As Integers  ${result.rc}  0
+  Should Contain  ${result.stdout}  ANSWER SECTION
+
+Run Dig
+  [Arguments]  ${domain}=google.com
+  ${handle} =  Start Dig  ${domain}
+  Stop Dig  ${handle}
+
+
+*** Test Cases ***
+Simple smoke test
+  Run Dig
+
+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
+  Set To Dictionary  ${expected_logs}  curl opened socket=1  # curl must not open more sockets then 1