fix(bq_driver): Fix log file output issue during Git-based test runs and stderr issue

Author: NeerajDwivedii

ci/cloudbuild/dockerfiles/ubuntu-22.04-install.Dockerfile

@@ -261,6 +261,7 @@ ENV PATH=${CLOUD_SDK_LOCATION}/bin:${PATH}
 COPY ./gha/builds/lib/odbc.ini /opt/odbc-driver/odbc.ini
 COPY ./gha/builds/lib/odbcinst.ini /opt/odbc-driver/odbcinst.ini
 COPY ./gha/builds/lib/lsan.supp /opt/odbc-driver/lsan.supp
+COPY ./gha/builds/lib/google.googlebigqueryodbc.ini /opt/odbc-driver/google.googlebigqueryodbc.ini
 
 # glibc 2.17 or later
 RUN echo 'Installing glibc...'

ci/dependencies/driver-manager-setup-google-driver.sh

@@ -50,7 +50,7 @@ export LD_LIBRARY_PATH=${LD_LIBRARY_PATH:-}:/usr/local/lib/
 export ODBCSYSINI=/opt/odbc-driver
 export ODBCINI=/opt/odbc-driver/odbc.ini
 export CPP_BIGQUERY_ODBC_TEST_SERVICE_ACCOUNT_AUTH_KEY=/opt/odbc-driver/connection/key.json
-
+export GOOGLEBIGQUERYODBCINI=/opt/odbc-driver/google.googlebigqueryodbc.ini
 cd "$CPP_GOOGLE_BIGQUERY_ODBC_DRIVER_MANAGER_SETUP_CURR_DIR"
 
 echo '**** ODBC Driver installation END****'

ci/gha/builds/lib/google.googlebigqueryodbc.ini

@@ -0,0 +1,3 @@
+[Driver]
+LogLevel=0
+LogPath=

ci/gha/builds/lib/system_dsn_setup_32.reg

@@ -55,5 +55,5 @@ REGEDIT4
 "LogFile"="C:\\b\\trace.log"
 
 [HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Google\ODBC Driver for Google BigQuery\Driver]
-"LogLevel"="1"
-"LogFile"="C:\\b\\trace.log"
+"LogLevel"="0"
+"LogFile"=

ci/gha/builds/lib/system_dsn_setup_64.reg

@@ -55,5 +55,5 @@ REGEDIT4
 "LogFile"="C:\\b\\trace.log"
 
 [HKEY_LOCAL_MACHINE\SOFTWARE\Google\ODBC Driver for Google BigQuery\Driver]
-"LogLevel"="1"
-"LogFile"="C:\\b\\trace.log"
+"LogLevel"="0"
+"LogFile"=

ci/gha/builds/macos-cmake.sh

@@ -22,8 +22,10 @@ source module ci/gha/builds/lib/cmake.sh
 
 cp ci/gha/builds/lib/odbc_osx.ini /Users/runner/work/connection/odbc-driver/odbc.ini
 cp ci/gha/builds/lib/odbcinst_osx.ini /Users/runner/work/connection/odbc-driver/odbcinst.ini
+cp ci/gha/builds/lib/google.googlebigqueryodbc.ini /Users/runner/work/connection/google.googlebigqueryodbc.ini
 export ODBCINI=/Users/runner/work/connection/odbc-driver/odbc.ini
 export ODBCINSTINI=/Users/runner/work/connection/odbc-driver/odbcinst.ini
+export GOOGLEBIGQUERYODBCINI=/Users/runner/work/connection/google.googlebigqueryodbc.ini
 export ODBC_TESTS_DSN="SampleDSNGoogleDriver"
 export CPP_BIGQUERY_ODBC_TEST_SERVICE_ACCOUNT_AUTH_KEY=/Users/runner/work/connection/key.json
 

google/cloud/odbc/bq_driver/internal/trace_utils.cc

@@ -33,7 +33,6 @@ static std::once_flag absl_log_init_flag;
 std::shared_ptr<TraceOptions> TraceOptions::options_console_ = nullptr;
 std::shared_ptr<TraceOptions> TraceOptions::options_file_ = nullptr;
 std::mutex TraceOptions::mu_;
-static std::mutex sink_mutex;  // Global for the file
 
 #ifdef _WIN32
 constexpr char kPathSeparator = '\\';
@@ -54,10 +53,10 @@ FileLogSink::FileLogSink(std::shared_ptr<TraceOptions> opts)
 }
 
 FileLogSink::~FileLogSink() {
-  std::lock_guard<std::mutex> lock(sink_mutex);
-  if (file_sink_ && file_sink_.get() == this) {
-    absl::log_internal::RemoveLogSink(this);
-    file_sink_ = nullptr;
+  // Close the file pointer if it was opened
+  if (fp_ != nullptr) {
+    fclose(fp_);
+    fp_ = nullptr;
   }
 }
 // Required for custom log formatting and writing to the driver's default log
@@ -152,9 +151,13 @@ std::string GetLogFileWithIndex(std::string const& log_path) {
 
 void FileLogSink::InitializeFileLog(
     std::shared_ptr<TraceOptions> const& trace_opts) {
-  std::lock_guard<std::mutex> lock(sink_mutex);
   if (file_sink_ || !trace_opts) return;
 
+  if (file_sink_) {
+    absl::log_internal::RemoveLogSink(file_sink_.get());
+    file_sink_ = nullptr;
+  }
+
   file_sink_ = std::make_unique<FileLogSink>(trace_opts);
   absl::log_internal::AddLogSink(file_sink_.get());
 }
@@ -170,9 +173,19 @@ bool CanWriteToFile(std::string const& log_file, std::size_t new_log_size,
 }
 
 bool TraceOptions::InitializeLogging(bool is_trace_override) {
+  // suppress all stderr output
+  std::call_once(absl_log_init_flag, []() { absl::InitializeLog(); });
+  absl::SetStderrThreshold(absl::LogSeverityAtLeast::kInfinity);
+
   if (!kTraceOptsFile.Ok()) return false;
   auto const& trace_opts = kTraceOptsFile.GetValue();
 
+  // If logging is disabled, return false
+  if (trace_opts->log_level <= 0) {
+    trace_opts->logging_enabled = false;
+    return false;
+  }
+
   // Logging already initialized and no override requested
   if (trace_opts->logging_enabled && !is_trace_override) {
     return true;
@@ -186,23 +199,14 @@ bool TraceOptions::InitializeLogging(bool is_trace_override) {
     FileLogSink::InitializeFileLog(trace_opts);
     return true;
   }
-  // If logging is disabled, suppress all stderr output
-  if (trace_opts->log_level <= 0) {
-    absl::SetStderrThreshold(absl::LogSeverityAtLeast::kInfinity);
-    return false;
-  }
 
   // Initialize Abseil logging and custom file sink
-  std::call_once(absl_log_init_flag, []() { absl::InitializeLog(); });
   auto log_severity =
       GetAbslSeverity(static_cast<LogLevel>(trace_opts->log_level));
   absl::SetMinLogLevel(static_cast<absl::LogSeverityAtLeast>(log_severity));
 
   FileLogSink::InitializeFileLog(trace_opts);
   trace_opts->logging_enabled = true;
-
-  // Disable Abseil's stderr logging
-  absl::SetStderrThreshold(absl::LogSeverityAtLeast::kInfinity);
   return true;
 }
 

google/cloud/odbc/bq_driver/internal/utils.cc

@@ -480,14 +480,8 @@ std::string GetOdbcTraceConfigPath() {
   if (path) {
     return *path;
   }
-  absl::optional<std::string> home = google::cloud::internal::GetEnv("HOME");
-  if (home) {
-    home = *home +
-           "/GoogleODBCDriverForBigQuery/lib/google.googlebigqueryodbc.ini";
-    return *home;
-  }
-  // Default to using ~ path directly if HOME is not set.
-  return "~/GoogleODBCDriverForBigQuery/lib/google.googlebigqueryodbc.ini";
+  // Default to using ~ path directly
+  return "/etc/google.googlebigqueryodbc.ini";
 #else
   return k_trace_reg_path;
 #endif  // _WIN32

google/cloud/odbc/bq_driver/internal/utils_test.cc

@@ -239,14 +239,8 @@ TEST(GetPathToOdbcIni, GetEmptyPath) {
 }
 
 TEST(GetOdbcTraceConfigPath, GetDefaultPath) {
-  auto home = ::google::cloud::internal::GetEnv("HOME");
-  google::cloud::odbc_bigquery_client_interface::UnsetEnv("HOME");
-
   std::string actual = GetOdbcTraceConfigPath();
-  EXPECT_EQ(actual,
-            "~/GoogleODBCDriverForBigQuery/lib/google.googlebigqueryodbc.ini");
-
-  google::cloud::odbc_bigquery_client_interface::SetEnv("HOME", home);
+  EXPECT_EQ(actual, "/etc/google.googlebigqueryodbc.ini");
 }
 
 TEST(GetOdbcTraceConfigPath, GetGoogleODBCIniPath) {

google/cloud/odbc/integration_tests/odbc_driver_tests/connection_test.cc

@@ -1556,6 +1556,32 @@ TEST(SQLGetFunctionsInternal,
             SQLGetFunctions(conn->hdbc, SQL_API_ODBC3_ALL_FUNCTIONS, nullptr));
 }
 
+TEST(ConnectionTest, CheckTraceLogFileExist) {
+#ifdef _WIN32
+  std::string log_path = "C:\\b";
+  std::string log_file = log_path + "\\googleodbcdriverforbigquery_0.log";
+#else
+  std::string log_path = "/tmp";
+  std::string log_file = log_path + "/googleodbcdriverforbigquery_0.log";
+#endif  // _WIN32
+  auto conn_str =
+      kDefaultConnectionString + ";LogPath=" + log_path + ";LogLevel=3";
+
+  auto conn = std::make_shared<ODBCHandles>();
+  EXPECT_EQ(Connect(conn_str, conn), SQL_SUCCESS);
+  EXPECT_EQ(Disconnect(conn), SQL_SUCCESS);
+  // check if the file exists
+  EXPECT_TRUE(std::filesystem::exists(log_file));
+  // Check that the file is not empty
+  std::ifstream file(log_file, std::ios::binary);
+  ASSERT_TRUE(file.is_open());
+
+  file.seekg(0, std::ios::end);
+  auto size = file.tellg();
+  EXPECT_GT(size, 0);
+  file.close();
+}
+
 #endif  // BQ_DRIVER_INTEGRATION_TESTS
 
 }  // namespace google::cloud::odbc_tests