Add and refactor unittests for ParaGlobal

Author: Cstandardlib

source/source_base/parallel_global.cpp

@@ -328,7 +328,7 @@ void Parallel_Global::divide_pools(const int& NPROC,
     //       and MY_BNDGROUP will be the same as well.
     if(BNDPAR > 1 && NPROC %(BNDPAR * KPAR) != 0)
     {
-        std::cout << "Error: When BNDPAR = " << BNDPAR << " > 1, number of processes (" << NPROC << ") must be divisible by the number of groups ("
+        std::cerr << "Error: When BNDPAR = " << BNDPAR << " > 1, number of processes (" << NPROC << ") must be divisible by the number of groups ("
                   << BNDPAR * KPAR << ")." << std::endl;
         exit(1);
     }
@@ -385,14 +385,16 @@ void Parallel_Global::divide_mpi_groups(const int& procs,
 {
     if (num_groups == 0)
     {
+        std::cerr << "Error: Number of groups must be greater than 0." << std::endl;
+        // note that WARNING_QUIT writes to stdout
         ModuleBase::WARNING_QUIT(
             "Parallel_Global::divide_mpi_groups",
             "Number of groups must be greater than 0."
         );
     }
     if (procs < num_groups)
     {
-        std::cout << "Error: Number of processes (" << procs << ") must be greater than the number of groups ("
+        std::cerr << "Error: Number of processes (" << procs << ") must be greater than the number of groups ("
                   << num_groups << ")." << std::endl;
         ModuleBase::WARNING_QUIT(
             "Parallel_Global::divide_mpi_groups",

source/source_base/test_parallel/parallel_global_test.cpp

@@ -9,7 +9,7 @@
 #include <cstring>
 #include <string>
 
-#include "source_base/tool_quit.h"
+#include "source_base/global_variable.h"
 
 /************************************************
  *  unit test of functions in parallel_global.cpp
@@ -66,6 +66,7 @@ class MPIContext
     int _size;
 };
 
+// --- Normal Test ---
 class ParaGlobal : public ::testing::Test
 {
   protected:
@@ -162,8 +163,58 @@ TEST_F(ParaGlobal, MyProd)
     EXPECT_EQ(inout[1], std::complex<double>(-3.0, -3.0));
 }
 
-TEST_F(ParaGlobal, InitPools)
+
+
+TEST_F(ParaGlobal, DivideMPIPools)
+{
+    this->nproc = 12;
+    mpi.kpar = 3;
+    this->my_rank = 5;
+    Parallel_Global::divide_mpi_groups(this->nproc,
+                                       mpi.kpar,
+                                       this->my_rank,
+                                       mpi.nproc_in_pool,
+                                       mpi.my_pool,
+                                       mpi.rank_in_pool);
+    EXPECT_EQ(mpi.nproc_in_pool, 4);
+    EXPECT_EQ(mpi.my_pool, 1);
+    EXPECT_EQ(mpi.rank_in_pool, 1);
+}
+
+
+// --- DeathTest: Single thread ---
+class ParaGlobalDeathTest : public ::testing::Test
+{
+  protected:
+    MPIContext mpi;
+    int nproc;
+    int my_rank;
+
+    // DeathTest SetUp:
+    // Init variable, single thread
+    void SetUp() override
+    {
+        // Only master process runs death test (avoid multi-process conflict)
+        if (mpi.GetRank() != 0) {return;}
+
+        // init log file
+        GlobalV::ofs_warning.open("warning.log");
+        // needed by WARNING_QUIT
+    }
+
+    // clean log file
+    void TearDown() override
+    {
+        if (mpi.GetRank() != 0) {return;}
+
+        GlobalV::ofs_warning.close();
+        remove("warning.log");
+    }
+};
+
+TEST_F(ParaGlobalDeathTest, InitPools)
 {
+    GTEST_FLAG_SET(death_test_style, "threadsafe");
     nproc = 12;
     mpi.kpar = 3;
     mpi.nstogroup = 3;
@@ -178,26 +229,67 @@ TEST_F(ParaGlobal, InitPools)
                                 mpi.MY_BNDGROUP,
                                 mpi.nproc_in_pool,
                                 mpi.rank_in_pool,
-                                mpi.my_pool), ::testing::ExitedWithCode(1), "");
-    std::string output = testing::internal::GetCapturedStdout();
-    EXPECT_THAT(output, testing::HasSubstr("Error:"));
+                                mpi.my_pool), ::testing::ExitedWithCode(1), "Error:");
 }
 
-
-TEST_F(ParaGlobal, DivideMPIPools)
+TEST_F(ParaGlobalDeathTest, DivideMPIPoolsNgEqZero)
 {
+    GTEST_FLAG_SET(death_test_style, "threadsafe");
+    // test for num_groups == 0,
+    // Num_group Equals 0
+    // WARNING_QUIT
     this->nproc = 12;
-    mpi.kpar = 3;
+    mpi.kpar = 0;
     this->my_rank = 5;
-    Parallel_Global::divide_mpi_groups(this->nproc,
+    EXPECT_EXIT(
+        Parallel_Global::divide_mpi_groups(this->nproc,
                                        mpi.kpar,
                                        this->my_rank,
                                        mpi.nproc_in_pool,
                                        mpi.my_pool,
-                                       mpi.rank_in_pool);
-    EXPECT_EQ(mpi.nproc_in_pool, 4);
-    EXPECT_EQ(mpi.my_pool, 1);
-    EXPECT_EQ(mpi.rank_in_pool, 1);
+                                       mpi.rank_in_pool),
+        ::testing::ExitedWithCode(1),
+        "Number of groups must be greater than 0."
+    );
+    // should WARNING_QUIT inside!
+    std::string output;
+    std::ifstream ifs;
+    ifs.open("warning.log");
+    getline(ifs,output);
+	// test output in warning.log file
+	EXPECT_THAT(output,testing::HasSubstr("warning"));
+	EXPECT_THAT(output,testing::HasSubstr("Number of groups must be greater than 0."));
+    ifs.close();
+}
+
+TEST_F(ParaGlobalDeathTest, DivideMPIPoolsNgGtProc)
+{
+    GTEST_FLAG_SET(death_test_style, "threadsafe");
+    // test for procs < num_groups
+    // Num_group GreaterThan Processors
+    // WARNING_QUIT
+    this->nproc = 12;
+    mpi.kpar = 24;
+    this->my_rank = 5;
+    EXPECT_EXIT(
+        Parallel_Global::divide_mpi_groups(this->nproc,
+                                        mpi.kpar,
+                                        this->my_rank,
+                                        mpi.nproc_in_pool,
+                                        mpi.my_pool,
+                                        mpi.rank_in_pool)
+        ,testing::ExitedWithCode(1),
+        "Error: Number of processes.*must be greater than the number of groups"
+    );
+    // should WARNING_QUIT inside!
+    std::string output;
+    std::ifstream ifs;
+    ifs.open("warning.log");
+    getline(ifs,output);
+	// test output in warning.log file
+	EXPECT_THAT(output,testing::HasSubstr("warning"));
+	EXPECT_THAT(output,testing::HasSubstr("Number of processes must be greater than the number of groups."));
+    ifs.close();
 }
 
 int main(int argc, char** argv)