move setup_directory_skip to bf.c

Author: calccrypto

include/utils.h

@@ -73,7 +73,6 @@ OF SUCH DAMAGE.
 #include "config.h"
 #include "descend.h"
 #include "plugin.h"
-#include "trie.h"
 #include "xattrs.h"
 
 #ifdef __cplusplus
@@ -131,9 +130,6 @@ size_t trailing_non_match_index(const char *str, size_t len,
  */
 size_t dirname_len(const char *path, size_t len);
 
-/* add contents of filename into skip */
-ssize_t setup_directory_skip(trie_t *skip, const char *filename);
-
 /* strstr/strtok replacement */
 char *split(char *src, const char *delim, const size_t delim_len, const char *end);
 

src/bf.c

@@ -194,6 +194,46 @@ static int load_plugin_library(struct input *in, char *plugin_name) {
     return 0;
 }
 
+/*
+ * create a trie of directory names to skip from a file
+ *
+ * not static to allow for testing
+ */
+ssize_t setup_directory_skip(trie_t *skip, const char *filename) {
+    if (!skip || !filename) {
+        return -1;
+    }
+
+    /* add user defined directory names to skip */
+    FILE *skipfile = fopen(filename, "r");
+    if (!skipfile) {
+        fprintf(stderr, "Error: Cannot open skip file \"%s\"\n", filename);
+        return -1;
+    }
+
+    ssize_t count = 0;
+
+    char *line = NULL;
+    size_t n = 0;
+    ssize_t len = 0;
+    while ((len = getline(&line, &n, skipfile)) > -1) {
+        len = trailing_non_match_index(line, len, "\r\n", 2);
+        if (len == 0) {
+            continue;
+        }
+
+        if (!trie_search(skip, line, len, NULL)) {
+            trie_insert(skip, line, len, NULL, NULL);
+            count++;
+        }
+    }
+    free(line);
+
+    fclose(skipfile);
+
+    return count;
+}
+
 void print_help(const char* prog_name,
                 const struct option* options,
                 const char* positional_args_help_str) {

src/utils.c

@@ -493,42 +493,6 @@ size_t dirname_len(const char *path, size_t len) {
     return trailing_match_index(path, len, "/", 1);
 }
 
-/* create a trie of directory names to skip from a file */
-ssize_t setup_directory_skip(trie_t *skip, const char *filename) {
-    if (!skip || !filename) {
-        return -1;
-    }
-
-    /* add user defined directory names to skip */
-    FILE *skipfile = fopen(filename, "r");
-    if (!skipfile) {
-        fprintf(stderr, "Error: Cannot open skip file \"%s\"\n", filename);
-        return -1;
-    }
-
-    ssize_t count = 0;
-
-    char *line = NULL;
-    size_t n = 0;
-    ssize_t len = 0;
-    while ((len = getline(&line, &n, skipfile)) > -1) {
-        len = trailing_non_match_index(line, len, "\r\n", 2);
-        if (len == 0) {
-            continue;
-        }
-
-        if (!trie_search(skip, line, len, NULL)) {
-            trie_insert(skip, line, len, NULL, NULL);
-            count++;
-        }
-    }
-    free(line);
-
-    fclose(skipfile);
-
-    return count;
-}
-
 /* strstr/strtok replacement */
 /* does not terminate on NULL character */
 /* does not skip to the next non-empty column */

test/unit/googletest/bf.cpp

@@ -62,6 +62,7 @@ OF SUCH DAMAGE.
 
 
 
+#include <fstream>
 #include <unistd.h>
 
 #include <gtest/gtest.h>
@@ -792,3 +793,63 @@ TEST(INSTALL, UINT64) {
                                     1, 1024,
                                     123, 0, 1234);
 }
+
+extern "C" {
+
+// not declared in bf.h
+ssize_t setup_directory_skip(trie_t *skip, const char *filename);
+
+}
+
+TEST(setup_directory_skip, file) {
+    const std::string skip_dirs[] = {
+        "skip0",
+        "skip1",
+        "s p a c e s",
+    };
+
+    char skip_name[] = "XXXXXX";
+    const int skip_fd = mkstemp(skip_name);
+    ASSERT_NE(skip_fd, -1);
+    EXPECT_EQ(close(skip_fd), 0);
+
+    {
+        std::ofstream skip_stream(skip_name);
+        EXPECT_TRUE(skip_stream);
+
+        skip_stream << std::endl; // start with empty line
+        for(std::string const & skip_dir : skip_dirs) {
+            skip_stream << skip_dir <<         std::endl;
+            skip_stream << skip_dir << "\r" << std::endl; // duplicates
+        }
+    }
+
+    trie_t *skip = trie_alloc();
+    ASSERT_NE(skip, nullptr);
+    EXPECT_EQ(setup_directory_skip(skip, skip_name), (ssize_t) (sizeof(skip_dirs) / sizeof(skip_dirs[0])));
+    for(std::string const & skip_dir : skip_dirs) {
+        EXPECT_EQ(trie_search(skip, skip_dir.c_str(), skip_dir.size(), nullptr), 1);
+    }
+    trie_free(skip);
+
+    EXPECT_EQ(remove(skip_name), 0);
+}
+
+TEST(setup_directory_skip, bad) {
+    trie_t *skip = trie_alloc();
+    ASSERT_NE(skip, nullptr);
+
+    char name[] = "XXXXXX";
+    const int fd = mkstemp(name);
+    ASSERT_GT(fd, -1);
+    EXPECT_EQ(setup_directory_skip(skip, name), 0);
+    EXPECT_EQ(close(fd), 0);
+    EXPECT_EQ(remove(name), 0);
+
+    EXPECT_EQ(setup_directory_skip(skip, ""), -1);
+    EXPECT_EQ(setup_directory_skip(skip, nullptr), -1);
+
+    trie_free(skip);
+
+    EXPECT_EQ(setup_directory_skip(nullptr, ""), -1);
+}

test/unit/googletest/utils.cpp.in

@@ -66,7 +66,6 @@ OF SUCH DAMAGE.
 #include <cstdio>
 #include <cstring>
 #include <fcntl.h>
-#include <fstream>
 #include <random>
 #include <sys/resource.h>
 #include <sys/stat.h>
@@ -797,59 +796,6 @@ TEST(trailing_non_match_index, paths) {
     EXPECT_EQ(trailing_non_match_index(nullptr, 10,              match, match_len), (size_t) 0);
 }
 
-TEST(setup_directory_skip, file) {
-    const std::string skip_dirs[] = {
-        "skip0",
-        "skip1",
-        "s p a c e s",
-    };
-
-    char skip_name[] = "XXXXXX";
-    const int skip_fd = mkstemp(skip_name);
-    ASSERT_NE(skip_fd, -1);
-    EXPECT_EQ(close(skip_fd), 0);
-
-    {
-        std::ofstream skip_stream(skip_name);
-        EXPECT_TRUE(skip_stream);
-
-        skip_stream << std::endl; // start with empty line
-        for(std::string const & skip_dir : skip_dirs) {
-            skip_stream << skip_dir <<         std::endl;
-            skip_stream << skip_dir << "\r" << std::endl; // duplicates
-        }
-    }
-
-    trie_t *skip = trie_alloc();
-    ASSERT_NE(skip, nullptr);
-    EXPECT_EQ(setup_directory_skip(skip, skip_name), (ssize_t) (sizeof(skip_dirs) / sizeof(skip_dirs[0])));
-    for(std::string const & skip_dir : skip_dirs) {
-        EXPECT_EQ(trie_search(skip, skip_dir.c_str(), skip_dir.size(), nullptr), 1);
-    }
-    trie_free(skip);
-
-    EXPECT_EQ(remove(skip_name), 0);
-}
-
-TEST(setup_directory_skip, bad) {
-    trie_t *skip = trie_alloc();
-    ASSERT_NE(skip, nullptr);
-
-    char name[] = "XXXXXX";
-    const int fd = mkstemp(name);
-    ASSERT_GT(fd, -1);
-    EXPECT_EQ(setup_directory_skip(skip, name), 0);
-    EXPECT_EQ(close(fd), 0);
-    EXPECT_EQ(remove(name), 0);
-
-    EXPECT_EQ(setup_directory_skip(skip, ""), -1);
-    EXPECT_EQ(setup_directory_skip(skip, nullptr), -1);
-
-    trie_free(skip);
-
-    EXPECT_EQ(setup_directory_skip(nullptr, ""), -1);
-}
-
 TEST(split, delims) {
     const char delims[] = "\xfe\xff";
     char line[MAXPATH];