Merge pull request #140 from Flamefire/coverage

 Increase test coverage

Author: Flamefire

.github/codecov.sh

@@ -39,13 +39,15 @@ else
     : "${LCOV_BRANCH_COVERAGE:=1}" # Set default
 
     lcov --gcov-tool="$GCOV" --rc lcov_branch_coverage=${LCOV_BRANCH_COVERAGE} --base-directory "$BOOST_ROOT/libs/$LIBRARY" --directory "$BOOST_ROOT" --capture --output-file all.info
+    # dump a summary on the console
+    lcov --gcov-tool="$GCOV" --rc lcov_branch_coverage=${LCOV_BRANCH_COVERAGE} --list all.info
 
     # all.info contains all the coverage info for all projects - limit to ours
     # first we extract the interesting headers for our project then we use that list to extract the right things
     for f in $(for f2 in include/boost/*; do echo "$f2"; done | cut -f2- -d/); do echo "*/$f*"; done > /tmp/interesting
     echo headers that matter:
     cat /tmp/interesting
-    xargs -L 999999 -a /tmp/interesting lcov --gcov-tool="$GCOV" --rc lcov_branch_coverage=${LCOV_BRANCH_COVERAGE} --extract all.info {} "*/libs/$LIBRARY/src/*" --output-file coverage.info
+    xargs -L 999999 -a /tmp/interesting lcov --gcov-tool="$GCOV" --rc lcov_branch_coverage=${LCOV_BRANCH_COVERAGE} --extract all.info {} "*/libs/$LIBRARY/*" --output-file coverage.info
 
     # dump a summary on the console - helps us identify problems in pathing
     lcov --gcov-tool="$GCOV" --rc lcov_branch_coverage=${LCOV_BRANCH_COVERAGE} --list coverage.info

.github/workflows/posix.yml

@@ -13,6 +13,7 @@ env:
   UBSAN_OPTIONS: print_stacktrace=1
   B2_VARIANT: debug,release
   B2_LINK: shared,static
+  LCOV_BRANCH_COVERAGE: 0
 
 jobs:
   CI:
@@ -123,6 +124,11 @@ jobs:
         working-directory: ${{env.BOOST_ROOT}}
         run: ./b2 -j3 libs/$LIBRARY/test toolset=$B2_TOOLSET cxxstd=$B2_CXXSTD variant=$B2_VARIANT link=$B2_LINK $B2_ASAN $B2_UBSAN $B2_LINKFLAGS $B2_FLAGS
 
+      - name: Run tests with simulated no LFS support
+        if: matrix.coverage
+        working-directory: ${{env.BOOST_ROOT}}
+        run: ./b2 -j3 libs/$LIBRARY/test toolset=$B2_TOOLSET cxxstd=$B2_CXXSTD variant=$B2_VARIANT link=$B2_LINK $B2_ASAN $B2_UBSAN $B2_LINKFLAGS $B2_FLAGS boost.nowide.lfs=no
+
       - name: Collect coverage
         if: matrix.coverage
         run: ${{github.workspace}}/.github/codecov.sh collect

build/Jamfile.v2

@@ -2,13 +2,17 @@
 
 # Copyright (c) 2002, 2006 Beman Dawes
 # Copyright (c) 2012 Artyom Beilis (Tonkikh)
-# Copyright (c) 2020 Alexander Grund
+# Copyright (c) 2020-2021 Alexander Grund
 # 
 # Distributed under the Boost Software License, Version 1.0.
 # (See accompanying file LICENSE or www.boost.org/LICENSE_1_0.txt)
 # See library home page at http://www.boost.org/libs/nowide
 
 import ../../config/checks/config : requires ;
+import configure ;
+import feature ;
+
+feature.feature boost.nowide.lfs : auto no : optional propagated ;
 
 local requirements =
   <link>shared:<define>BOOST_NOWIDE_DYN_LINK=1
@@ -24,7 +28,7 @@ project boost/nowide
       cxx11_static_assert
     ]
     [ check-target-builds ../config//cxx11_moveable_fstreams "std::fstream is moveable and swappable" : : <build>no ]
-    [ check-target-builds ../config//lfs_support "Has Large File Support" : : <define>BOOST_NOWIDE_NO_LFS ]
+    [ check-target-builds ../config//lfs_support "Has Large File Support" : : <define>BOOST_NOWIDE_NO_LFS ] <boost.nowide.lfs>no:<define>BOOST_NOWIDE_NO_LFS
     [ check-target-builds ../config//attribute_init_priority "Has attribute init_priority" : <define>BOOST_NOWIDE_HAS_INIT_PRIORITY ]
   : usage-requirements $(requirements)
   ;

codecov.yml

@@ -8,3 +8,4 @@ comment:
   layout: "diff, files"
 ignore:
   - "test/test.hpp"
+  - "test/file_test_helpers.cpp"

doc/changelog.dox

@@ -10,6 +10,11 @@
 
 \section changelog Changelog
 
+\subsection changelog_next Next release
+
+- Fix possible double-free when setting a custom buffer (`setbuf`) after filebuf already allocated an internal buffer
+- Handle some warnings (mostly on MSVC)
+
 \subsection changelog_11_1_3 Nowide 11.1.3
 
 - Fix missing config file in release

include/boost/nowide/filebuf.hpp

@@ -213,7 +213,10 @@ namespace nowide {
             setg(NULL, NULL, NULL);
             setp(NULL, NULL);
             if(owns_buffer_)
+            {
                 delete[] buffer_;
+                owns_buffer_ = false;
+            }
             buffer_ = s;
             buffer_size_ = (n >= 0) ? static_cast<size_t>(n) : 0;
             return this;

include/boost/nowide/utf8_codecvt.hpp

@@ -11,6 +11,7 @@
 
 #include <boost/nowide/replacement.hpp>
 #include <boost/nowide/utf/utf.hpp>
+#include <cassert>
 #include <cstdint>
 #include <locale>
 
@@ -48,6 +49,11 @@ namespace nowide {
     template<typename CharType, int CharSize = sizeof(CharType)>
     class utf8_codecvt;
 
+#ifdef BOOST_MSVC
+#pragma warning(push)
+#pragma warning(disable : 4996) // Disable deprecation warning for std::codecvt<char16_t, char, ...>
+#endif
+
     /// Specialization for the UTF-8 <-> UTF-16 variant of the std::codecvt implementation
     template<typename CharType>
     class BOOST_SYMBOL_VISIBLE utf8_codecvt<CharType, 2> : public std::codecvt<CharType, char, std::mbstate_t>
@@ -58,6 +64,10 @@ namespace nowide {
         utf8_codecvt(size_t refs = 0) : std::codecvt<CharType, char, std::mbstate_t>(refs)
         {}
 
+#ifdef BOOST_MSVC
+#pragma warning(pop)
+#endif
+
     protected:
         using uchar = CharType;
 
@@ -81,8 +91,10 @@ namespace nowide {
             return false;
         }
 
+        // LCOV_EXCL_START
         int do_length(std::mbstate_t& std_state, const char* from, const char* from_end, size_t max) const override
         {
+            // LCOV_EXCL_STOP
             using utf16_traits = utf::utf_traits<uchar, 2>;
             std::uint16_t state = detail::read_state(std_state);
             const char* save_from = from;
@@ -225,11 +237,7 @@ namespace nowide {
                         ch = BOOST_NOWIDE_REPLACEMENT_CHARACTER;
                     }
                 }
-                if(!utf::is_valid_codepoint(ch))
-                {
-                    r = std::codecvt_base::error;
-                    break;
-                }
+                assert(utf::is_valid_codepoint(ch)); // Any valid UTF16 sequence is a valid codepoint
                 int len = utf::utf_traits<char>::width(ch);
                 if(to_end - to < len)
                 {
@@ -248,6 +256,11 @@ namespace nowide {
         }
     };
 
+#ifdef BOOST_MSVC
+#pragma warning(push)
+#pragma warning(disable : 4996) // Disable deprecation warning for std::codecvt<char32_t, char, ...>
+#endif
+
     /// Specialization for the UTF-8 <-> UTF-32 variant of the std::codecvt implementation
     template<typename CharType>
     class BOOST_SYMBOL_VISIBLE utf8_codecvt<CharType, 4> : public std::codecvt<CharType, char, std::mbstate_t>
@@ -256,6 +269,10 @@ namespace nowide {
         utf8_codecvt(size_t refs = 0) : std::codecvt<CharType, char, std::mbstate_t>(refs)
         {}
 
+#ifdef BOOST_MSVC
+#pragma warning(pop)
+#endif
+
     protected:
         using uchar = CharType;
 
@@ -296,7 +313,7 @@ namespace nowide {
                 }
                 max--;
             }
-            return from - start_from;
+            return static_cast<int>(from - start_from);
         }
 
         std::codecvt_base::result do_in(std::mbstate_t& /*state*/,

test/benchmark_fstream.cpp

@@ -94,11 +94,11 @@ class io_stdio
     }
     void write(const char* buf, int size)
     {
-        TEST(std::fwrite(buf, 1, size, f_) == static_cast<size_t>(size));
+        TEST_EQ(std::fwrite(buf, 1, size, f_), static_cast<size_t>(size));
     }
     void read(char* buf, int size)
     {
-        TEST(std::fread(buf, 1, size, f_) == static_cast<size_t>(size));
+        TEST_EQ(std::fread(buf, 1, size, f_), static_cast<size_t>(size));
     }
     void rewind()
     {
@@ -202,7 +202,7 @@ perf_data test_io(const char* file, bool binary)
         std::cout << "  read block size " << std::setw(8) << block_size << " " << std::fixed << std::setprecision(3)
                   << speed << " MB/s" << std::endl;
     }
-    TEST(std::remove(file) == 0);
+    TEST_EQ(std::remove(file), 0);
     return results;
 }
 

test/file_test_helpers.cpp

@@ -18,13 +18,6 @@ namespace boost {
 namespace nowide {
     namespace test {
 
-        void create_empty_file(const std::string& filepath)
-        {
-            auto* f = fopen(filepath.c_str(), "w");
-            TEST(f);
-            std::fclose(f);
-        }
-
         void create_file(const std::string& filepath, const std::string& contents, data_type type /*= data_type::text*/)
         {
             auto* f = fopen(filepath.c_str(), (type == data_type::binary) ? "wb" : "w");

test/test.hpp

@@ -88,6 +88,21 @@ inline void test_equal_impl(const T& lhs, const U& rhs, const char* file, const
         DISABLE_CONST_EXPR_DETECTED                                      \
     } while(0) DISABLE_CONST_EXPR_DETECTED_POP
 
+#define TEST_THROW(expr, error)                                                  \
+    do                                                                           \
+    {                                                                            \
+        test_mon();                                                              \
+        try                                                                      \
+        {                                                                        \
+            expr;                                                                \
+            test_failed(#error " not thrown", __FILE__, __LINE__, __FUNCTION__); \
+        } catch(const error&)                                                    \
+        { /* OK */                                                               \
+        }                                                                        \
+        break;                                                                   \
+        DISABLE_CONST_EXPR_DETECTED                                              \
+    } while(0) DISABLE_CONST_EXPR_DETECTED_POP
+
 #ifndef BOOST_NOWIDE_TEST_NO_MAIN
 // Tests should implement this
 void test_main(int argc, char** argv, char** env);
@@ -100,6 +115,9 @@ int main(int argc, char** argv, char** env)
     } catch(const std::exception& e)
     {
         std::cerr << "Failed " << e.what() << std::endl;
+#ifdef _MSC_VER
+        std::cerr << "MSVC version " << _MSC_VER << std::endl;
+#endif
         return 1;
     }
     return 0;