Add better unit tests to pkg_editor_test.cpp

Past tests did not cover the scenario where the compressed file has a size of 0.

This commit adds randomness to the test (i.e. random file size/name). Additionally, all the unpack tests cover cases with large files (size ~10MB) and empty files.

Author: IlanTruanovsky

lib/pkg_editor/test/CMakeLists.txt

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
 add_executable(pkg_editor_test pkg_editor_test.cpp)
-target_link_libraries(pkg_editor_test PRIVATE CppUTest pkg_editor)
+target_link_libraries(pkg_editor_test PRIVATE CppUTest pkg_editor -lstdc++fs)
 add_test(pkg_editor_test pkg_editor_test -v)
 
 if(ZLIB_FOUND)

lib/pkg_editor/test/pkg_editor_test.cpp

@@ -12,9 +12,14 @@
 #pragma warning(pop)
 #endif
 
+#include <dirent.h>
+#include <experimental/filesystem>
+#include <iterator>
+#include <random>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <sys/stat.h>
 
 #include "pkg_editor/pkg_editor.h"
 #include <assert.h>
@@ -40,13 +45,16 @@
 #define PACK_UNPACK_FILE ".pack_unpack"
 #define PACK_UNPACK_DIR ".pack_unpack_dir"
 
+namespace fs = std::experimental::filesystem::v1;
+
 static void l_remove_file(const char *filename) {
 #ifdef _WIN32
   _unlink(filename);
 #else
   unlink(filename);
 #endif
-}
+} // namespace
+  // fs=std::experimental::filesystem::v1staticvoidl_remove_file(constchar*filename)
 
 static void l_remove_sample_file(void) { l_remove_file(SAMPLE_FILE); }
 
@@ -382,6 +390,8 @@ TEST(package, pack) {
 static bool files_same(const char *f1, const char *f2) {
   std::ifstream file1(f1, std::ifstream::ate | std::ifstream::binary);
   std::ifstream file2(f2, std::ifstream::ate | std::ifstream::binary);
+  file1.exceptions(std::ifstream::failbit | std::ifstream::badbit);
+  file2.exceptions(std::ifstream::failbit | std::ifstream::badbit);
   const std::ifstream::pos_type fileSize = file1.tellg();
 
   if (fileSize != file2.tellg()) {
@@ -396,11 +406,54 @@ static bool files_same(const char *f1, const char *f2) {
   return std::equal(begin1, std::istreambuf_iterator<char>(), begin2);
 }
 
+static void generate_random_file(std::string name, size_t size) {
+  std::mt19937 gen{std::random_device()()};
+  std::uniform_int_distribution<> dis(0, 255);
+  std::ofstream file(name);
+  std::generate_n(std::ostream_iterator<char>(file, ""), size,
+                  [&] { return dis(gen); });
+}
+
+/**
+ * Generates a "tmp" folder in the cwd with num_files files.
+ * Puts their file paths relative to the cwd in generated_files.
+ */
+static void generate_tmp_folder(int num_files, std::string generated_files[]) {
+  fs::remove_all("tmp");
+  fs::create_directory("tmp");
+
+  generated_files[num_files - 1] = "./tmp/empty_file";
+  generate_random_file(generated_files[num_files - 1], 0);
+  if (num_files == 1) {
+    return;
+  }
+
+  generated_files[num_files - 2] = "./tmp/large_file";
+  generate_random_file(generated_files[num_files - 2], 10000000); // ~10MB
+
+  num_files -= 2;
+
+  for (int i = 0; i < num_files; i++) {
+    generated_files[i] = "." + std::string(tmpnam(NULL));
+    generate_random_file(generated_files[i], rand() % 100000);
+  }
+}
+
+static void check_tmp_folder(int num_files, std::string generated_files[],
+                             std::string unpack_dir) {
+  for (int i = 0; i < num_files; i++) { //
+    std::string unpacked_file_path = unpack_dir + "/" + generated_files[i];
+    files_same(generated_files[i].c_str(), unpacked_file_path.c_str());
+  }
+}
+
 TEST(package, unpack) {
   int result;
-
+  int num_rand_files = 10;
+  std::string files[num_rand_files];
+  generate_tmp_folder(num_rand_files, files);
   // Create a known good input.
-  const char *test_input[] = {"include", "src", "test", NULL};
+  const char *test_input[] = {"tmp", NULL};
   result = acl_pkg_pack(PACK_UNPACK_FILE, test_input);
   CHECK_EQUAL(1, result);
 
@@ -409,17 +462,17 @@ TEST(package, unpack) {
   CHECK_EQUAL(1, result);
 
   // Compare some files to be sure that they are the same.
-  CHECK_EQUAL(true,
-              files_same("CMakeLists.txt", PACK_UNPACK_DIR "/CMakeLists.txt"));
-  CHECK_EQUAL(true, files_same("test/pkg_editor_test.cpp",
-                               PACK_UNPACK_DIR "/test/pkg_editor_test.cpp"));
+  check_tmp_folder(num_rand_files, files, PACK_UNPACK_DIR);
 }
 
 TEST(package, unpack_buffer) {
   int result;
+  int num_rand_files = 10;
+  std::string files[num_rand_files];
+  generate_tmp_folder(num_rand_files, files);
 
   // Create a known good input.
-  const char *test_input[] = {"include", "src", "test", NULL};
+  const char *test_input[] = {"include", "src", "test", "tmp", NULL};
   result = acl_pkg_pack(PACK_UNPACK_FILE, test_input);
   CHECK_EQUAL(1, result);
 
@@ -445,13 +498,16 @@ TEST(package, unpack_buffer) {
                                PACK_UNPACK_DIR "/src/pkg_editor.c"));
   CHECK_EQUAL(true, files_same("test/pkg_editor_test.cpp",
                                PACK_UNPACK_DIR "/test/pkg_editor_test.cpp"));
+  check_tmp_folder(num_rand_files, files, PACK_UNPACK_DIR);
 }
 
 TEST(package, unpack_buffer_stdin) {
   int result;
-
+  int num_rand_files = 10;
+  std::string files[num_rand_files];
+  generate_tmp_folder(num_rand_files, files);
   // Create a known good input.
-  const char *test_input[] = {"include", "src", "test", NULL};
+  const char *test_input[] = {"include", "src", "test", "tmp", NULL};
   result = acl_pkg_pack(PACK_UNPACK_FILE, test_input);
   CHECK_EQUAL(1, result);
 
@@ -494,23 +550,6 @@ TEST(package, unpack_buffer_stdin) {
                                PACK_UNPACK_DIR "/src/pkg_editor.c"));
   CHECK_EQUAL(true, files_same("test/pkg_editor_test.cpp",
                                PACK_UNPACK_DIR "/test/pkg_editor_test.cpp"));
+  check_tmp_folder(num_rand_files, files, PACK_UNPACK_DIR);
 }
-
-TEST(package, unpack_empty) {
-  int result;
-
-  // Create a known good input.
-  const char *test_input[] = {"test", NULL};
-  FILE *f = fopen("test/empty", "wb");
-  fclose(f);
-  result = acl_pkg_pack(PACK_UNPACK_FILE, test_input);
-  CHECK_EQUAL(1, result);
-
-  // Now read it back.
-  result = acl_pkg_unpack(PACK_UNPACK_FILE, PACK_UNPACK_DIR);
-  CHECK_EQUAL(1, result);
-
-  CHECK_EQUAL(true, files_same("test/empty", PACK_UNPACK_DIR "/test/empty"));
-}
-
 #endif