fix(Makefile): -lgcov, TOOLS = basen

V1.0.2

.github/workflows/docs.yml

@@ -4,8 +4,6 @@ on:
   push:
     branches: ["main"]
 
-  workflow_dispatch:
-
 permissions:
   contents: read
   pages: write
@@ -24,12 +22,16 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          submodules: 'true'
       - name: Setup Pages
         uses: actions/configure-pages@v5
       - name: Install Doxygen
-        run: sudo apt install doxygen
+        run: |
+          wget https://github.com/doxygen/doxygen/releases/download/Release_1_12_0/doxygen-1.12.0.linux.bin.tar.gz
+          tar -xf doxygen-1.12.0.linux.bin.tar.gz
       - name: Generate docs
-        run: doxygen
+        run: ./doxygen-1.12.0/bin/doxygen
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

.gitignore

@@ -43,6 +43,7 @@ bin
 obj
 lib
 doc
+cov
 
 # IDE
 .vscode

AUTHORS

@@ -1,5 +1,5 @@
 libbasen project authors:
 
 commits | username
-     46 | vSEK1RO
+     70 | vSEK1RO
 

Doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = libbasen
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = v1.0.1
+PROJECT_NUMBER         = v1.0.2
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

Makefile

@@ -5,7 +5,7 @@ DEBUG ?= false
 USRDIR ?= /usr
 
 .PHONY: build i install uni uninstall\
-		tools library tests docs clean
+		tools library tests docs cov clean
 
 LIB = basen
 OBJS =\
@@ -15,7 +15,7 @@ OBJS =\
 	base64\
 	hash/sha256\
 
-TOOLS =\
+TOOLS = ${LIB}
 
 TESTS =\
 	test-hex\
@@ -59,6 +59,8 @@ DIRS =\
 	${OBJDIR}\
 	${OBJDIR}/hash\
 	${LIBDIR}\
+	doc\
+	cov
 
 build: library tools
 
@@ -80,8 +82,19 @@ uninstall:
 docs:
 	doxygen Doxyfile
 
+cover: ${DIRS} ${patsubst %, ${BINDIR}/%${-g}-cov, ${TESTS}}
+	rm -f **/*.gcda
+	${patsubst %, ./${BINDIR}/%${-g}-cov;, ${TESTS}}
+	gcovr --html-nested cov/index.html --txt --exclude-throw-branches
+
+${OBJDIR}/%${-g}-cov.o: ${SRCDIR}/%.cpp ${INCDIR}/${LIB}/%.hpp
+	${CC} -o $@ -c $< -I${INCDIR} ${-l} ${CFLAGS} --coverage
+
+${BINDIR}/%${-g}-cov: ${TESTDIR}/%.cpp ${patsubst %, ${OBJDIR}/%${-g}-cov.o, ${OBJS}}
+	${CC} -o $@ $^ -I${INCDIR} ${-l} -lgtest -lgcov ${CFLAGS}
+
 clean:
-	rm -rf ${OBJDIR}/* ${LIBDIR}/* ${BINDIR}/*
+	rm -rf ${DIRS}
 
 ifneq (${OBJS},)
 

README.md

@@ -30,18 +30,6 @@ Uninstall:
 ```
 sudo make uni USRDIR=(Your installation dir)
 ```
-For build with with debug flags:
-```
-make -j $(nproc) DEBUG=
-```
-For build tests (needed gtest package as dependency):
-```
-make tests -j $(nproc) DEBUG=
-```
-And also flag for dynamic linking (if possible):
-```
-make tools -j $(nproc) SHARED=
-```
 
 ## Documentation
 
@@ -56,4 +44,17 @@ Now we would like to implement the following features:
 - BCH
 - Bech32
 
+For build with with debug flags:
+```
+make -j $(nproc) DEBUG=
+```
+For build tests (needed gtest package as dependency):
+```
+make tests -j $(nproc) DEBUG=
+```
+For generating coverage:
+```
+make cover -j $(nproc) DEBUG=
+```
+
 [⬆️ Contents](#contents)

src/base64.cpp

@@ -74,8 +74,6 @@ namespace base64
             str[i * 4 + 3] = digits[data[i * 3 + 2] & 0x3F];
         }
         uint64_t last_idx = data_size / 3 * 4;
-        if (last_idx + 3 < str_size)
-        {
         switch (data_size % 3)
         {
         case 1:
@@ -94,7 +92,6 @@ namespace base64
             break;
         }
     }
-    }
     std::string encode(std::span<const uint8_t> data) noexcept
     {
         std::string str(base64::sizeEncoded(data), ' ');

src/basen.cpp

@@ -0,0 +1,29 @@
+#include <iostream>
+
+#include <argparse/argparse.hpp>
+
+#include <basen.hpp>
+
+int main(int argc, char *argv[])
+{
+    argparse::ArgumentParser program("basen", "1.1.0");
+    program.add_argument("-t", "--type")
+        .help("encoding type")
+        .metavar("STRING")
+        .choices("base58", "base64", "hex")
+        .default_value("hex");
+    program.add_argument("-d", "--decode")
+        .help("is decode")
+        .flag();
+    try
+    {
+        program.parse_args(argc, argv);
+    }
+    catch (const std::exception &err)
+    {
+        std::cerr << err.what() << '\n';
+        std::cerr << program;
+        return 1;
+    }
+    return 0;
+}

test/test-base64.cpp

@@ -28,6 +28,12 @@ TEST(base64, encode)
 {
     for (auto it : tests)
         EXPECT_EQ(it.first, encode(hex::decode(it.second)));
+
+    std::vector<uint8_t> data = {0x74, 0x65, 0x73, 0x74};
+    std::string str = "";
+    EXPECT_THROW(encode(data.data(), std::numeric_limits<uint64_t>::max(), str.data(), str.size()), std::overflow_error);
+    EXPECT_THROW(encode(data.data(), data.size(), str.data(), str.size()), std::length_error);
+    EXPECT_NO_THROW(encode(data.data(), 0, str.data(), str.size()));
 }
 TEST(base64, encode_1e7)
 {
@@ -38,6 +44,12 @@ TEST(base64, decode)
 {
     for (auto it : tests)
         EXPECT_EQ(hex::encode(decode(it.first)), it.second);
+
+    std::vector<uint8_t> data = {0x61, 0x6e, 0x6f};
+    EXPECT_THROW(decode("FFF", 3, data.data(), data.size()), std::logic_error);
+    EXPECT_THROW(decode("!@#!", 4, data.data(), data.size()), std::logic_error);
+    EXPECT_THROW(decode("FF==", 2, data.data(), 0), std::length_error);
+    EXPECT_NO_THROW(decode(""       , 0, data.data(), 0));
 }
 TEST(base64, decode_1e7)
 {

test/test-hex.cpp

@@ -1,21 +1,28 @@
+#include <utility>
+
 #include <basen/hex.hpp>
 #include <gtest/gtest.h>
 
 using namespace hex;
 
+TEST(hex, isValid)
+{
+    std::vector<std::pair<bool, std::string>> tests = {
+        {true, "1234"},
+        {false, "!@/"},
+    };
+    for (auto it : tests)
+        EXPECT_EQ(it.first, isValid(it.second));
+}
 TEST(hex, encode)
 {
     std::vector<uint8_t> data = {0x74, 0x65, 0x73, 0x74};
     EXPECT_EQ("74657374", encode(data));
-    try
+
-    {
     std::string str = "";
-        encode(data.data(), data.size(), str.data(), str.size());
+    EXPECT_THROW(encode(data.data(), std::numeric_limits<uint64_t>::max(), str.data(), str.size()), std::overflow_error);
-    }
+    EXPECT_THROW(encode(data.data(), data.size(), str.data(), str.size()), std::length_error);
-    catch (const std::exception &e)
+    EXPECT_NO_THROW(encode(data.data(), 0, str.data(), str.size()));
-    {
-        EXPECT_STREQ(e.what(), "hex::encode: not enough allocated length");
-    }
 }
 TEST(hex, encode_1e7)
 {
@@ -26,15 +33,11 @@ TEST(hex, decode)
 {
     std::vector<uint8_t> data = {0x61, 0x6e, 0x6f};
     EXPECT_EQ(decode("616e6f"), data);
-    try
+
-    {
+    EXPECT_THROW(decode("FFF", 3, data.data(), data.size()), std::logic_error);
-        std::string str = "";
+    EXPECT_THROW(decode("!@#!", 4, data.data(), data.size()), std::logic_error);
-        decode("616", 3, data.data(), data.size());
+    EXPECT_THROW(decode("FF", 2, data.data(), 0), std::length_error);
-    }
+    EXPECT_NO_THROW(decode("", 0, data.data(), 0));
-    catch (const std::exception &e)
-    {
-        EXPECT_STREQ(e.what(), "hex::decode: isn't hex");
-    }
 }
 TEST(hex, decode_1e7)
 {