Add YWIU checks to travis (etr#208)

Adds the YWIU checks to travis.
Fixed the include statements to pass the tests.
Forces code to be tested on appveyor too (in order to have this tested) - more generally this is useful because apparent travis-only change might affect windows too (like in this case).

Author: etr

.travis.yml

@@ -11,6 +11,28 @@ env:
  - LINKING="static"
 before_install:
  - eval "${MATRIX_EVAL}"
+ # Installing iwyu manually because clang and iwyu paths won't match on Ubuntu otherwise.
+ - if [ "$IWYU" = "iwyu" ]; then
+     CLANG_VERSION=`clang --version | grep version | cut -f3 -d' ' | cut -f1 -d'-'` ;
+     CLANG_PKG_VERSION=`echo $CLANG_VERSION | cut -f1,2 -d'.'`
+     CLANG_PREFIX_PATH="/usr/local/clang-${CLANG_VERSION}/lib/clang/${CLANG_VERSION}" ;
+     CLANG_BIN_PATH="/usr/local/clang-${CLANG_VERSION}/bin" ;
+     git clone https://github.com/include-what-you-use/include-what-you-use.git ;
+     cd include-what-you-use ;
+     echo "$CLANG_PKG_VERSION" | grep '\.[0-9]$' ;
+     if [ $? -eq 0 ]; then
+       git checkout clang_${CLANG_PKG_VERSION} ;
+     else
+       git checkout clang_${CLANG_PKG_VERSION}.0 ;
+     fi;
+     cd .. ;
+     mkdir build_iwyu ;
+     cd build_iwyu ;
+     cmake -G "Unix Makefiles" -DCMAKE_PREFIX_PATH=$CLANG_PREFIX_PATH -DCMAKE_C_COMPILER=$CLANG_BIN_PATH/clang -DCMAKE_CXX_COMPILER=$CLANG_BIN_PATH/clang++ ../include-what-you-use ;
+     make ;
+     sudo make install ;
+     cd .. ;
+   fi
  - export LDFLAGS="$LDFLAGS -L/usr/local/lib -L/usr/lib"
  - export PATH=$PATH:/usr/local/lib
  - export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib
@@ -37,21 +59,32 @@ install:
  - ./bootstrap
  - mkdir build
  - cd build
- - if [ "$LINKING" = "static" ]; then
+ - |
+   if [ "$LINKING" = "static" ]; then
      ../configure --enable-static --disable-fastopen;
    elif [ "$DEBUG" = "debug" ] && [ "$COVERAGE" = "coverage" ]; then
      ../configure --enable-debug --enable-coverage --disable-shared --disable-fastopen;
    elif [ "$DEBUG" = "debug" ]; then
      ../configure --enable-debug --disable-shared --disable-fastopen;
    elif [ "$VALGRIND" = "valgrind" ]; then
      ../configure --enable-debug --disable-fastopen --disable-valgrind-helgrind --disable-valgrind-drd --disable-valgrind-sgcheck;
+   elif [ "$IWYU" = "iwyu" ]; then
+     ../configure --disable-examples;
    else
      ../configure --disable-fastopen;
    fi
- - make
+ # Make or run iwyu. If running iwyu, check for the result code to be 2 (IWYU always returns an error code, if it is 2, no corrections are necessary).
+ - |
+   if [ "$IWYU" = "iwyu" ]; then
+     make -k CXX='/usr/local/bin/include-what-you-use -Xiwyu --mapping_file=${top_builddir}/../custom_iwyu.imp' CXXFLAGS="-isystem ${CLANG_PREFIX_PATH}/include -std=c++11 -DHTTPSERVER_COMPILATION -D_REENTRANT $CXXFLAGS" ;
+     if [ $? -ne 2 ]; then 
+       return 1;
+     fi
+   else
+     make;
+   fi
 script:
- - make check
- - cat test/test-suite.log
+ - if [ "$IWYU" != "iwyu" ]; then make check; cat test/test-suite.log; fi
  - if [ "$VALGRIND" = "valgrind" ]; then make check-valgrind; fi;
  - if [ "$VALGRIND" = "valgrind" ]; then cat test/test-suite-memcheck.log; fi;
  - if [ "$TRAVIS_OS_NAME" = "linux" ]; then cd ../src/; cppcheck --error-exitcode=1 .; cd ../build; fi
@@ -309,3 +342,17 @@ matrix:
             - clang-9
       env:
         - MATRIX_EVAL="CC=clang-9 && CXX=clang++-9"
+    - os: linux
+      compiler: clang
+      addons:
+        apt:
+          sources:
+            - llvm-toolchain-xenial-7
+            - ubuntu-toolchain-r-test
+          packages:
+            - iwyu
+            - cmake
+            - llvm-dev
+            - libclang-dev
+      env:
+        - MATRIX_EVAL="IWYU=iwyu"

appveyor.yml

@@ -1,13 +1,5 @@
 platform: x64
 
-branches:
-  except:
-    - /.*travis.*/
-skip_commits:
-  message: /travis/
-  files:
-    - .travis.yml
-
 environment:
   matrix:
     - compiler: msys2

custom_iwyu.imp

@@ -0,0 +1,17 @@
+[
+  { include: ["\"microhttpd.h\"", "private", "<microhttpd.h>", "public"] },
+  { include: ["<ext/alloc_traits.h>", "private", "<memory>", "public"] },
+  
+  { symbol: ["std::exception",     "private", "<exception>", "public"]},
+  { symbol: ["std::shared_ptr",    "private", "<memory>",    "public"]},
+  { symbol: ["std::uint16_t",      "private", "<cstdint>",   "public"]},
+  { symbol: ["std::uint64_t",      "private", "<cstdint>",   "public"]},
+  { symbol: ["std::istringstream", "private", "<sstream>",   "public"]},
+  { symbol: ["std::stringstream",  "private", "<sstream>",   "public"]},
+  { symbol: ["std::ifstream",      "private", "<fstream>",   "public"]},
+
+  { symbol: ["uint16_t", "private", "<stdint.h>", "public"]},
+  { symbol: ["uint64_t", "private", "<stdint.h>", "public"]},
+
+  { symbol: ["MHD_Connection", "private", "<microhttpd.h>", "public"]},
+]

src/basic_auth_fail_response.cpp

@@ -19,6 +19,10 @@
 */
 
 #include "httpserver/basic_auth_fail_response.hpp"
+#include <microhttpd.h>
+
+struct MHD_Connection;
+struct MHD_Response;
 
 using namespace std;
 

src/deferred_response.cpp

@@ -19,6 +19,9 @@
 */
 
 #include "httpserver/deferred_response.hpp"
+#include <microhttpd.h>
+
+struct MHD_Response;
 
 using namespace std;
 

src/details/http_endpoint.cpp

@@ -18,12 +18,18 @@
      USA
 */
 
+#include <ctype.h>
+#include <map>
+#include <memory>
+#include <regex>
+#include <sstream>
 #include <stdexcept>
+#include <string>
+#include <utility>
+#include <vector>
 
 #include "httpserver/details/http_endpoint.hpp"
-
 #include "httpserver/http_utils.hpp"
-#include "httpserver/string_utilities.hpp"
 
 using namespace std;
 

src/digest_auth_fail_response.cpp

@@ -19,6 +19,10 @@
 */
 
 #include "httpserver/digest_auth_fail_response.hpp"
+#include <microhttpd.h>
+
+struct MHD_Connection;
+struct MHD_Response;
 
 using namespace std;
 

src/file_response.cpp

@@ -19,8 +19,12 @@
 */
 
 #include "httpserver/file_response.hpp"
-
 #include <fcntl.h>
+#include <microhttpd.h>
+#include <stddef.h>
+#include <unistd.h>
+
+struct MHD_Response;
 
 using namespace std;
 

src/http_request.cpp

@@ -20,9 +20,9 @@
 */
 
 #include "httpserver/http_request.hpp"
-
+#include <stdio.h>
+#include <stdlib.h>
 #include <iostream>
-
 #include "httpserver/http_utils.hpp"
 #include "httpserver/string_utilities.hpp"
 

src/http_resource.cpp

@@ -19,15 +19,10 @@
 */
 
 #include "httpserver/http_resource.hpp"
-
-#include <stdlib.h>
-
-#include "httpserver/http_request.hpp"
-#include "httpserver/http_response.hpp"
-#include "httpserver/http_utils.hpp"
+#include <microhttpd.h>
 #include "httpserver/string_response.hpp"
-#include "httpserver/string_utilities.hpp"
-#include "httpserver/webserver.hpp"
+
+namespace httpserver { class http_response; }
 
 using namespace std;