From f88a937d53b76f425ec83dc46f3f1320e98ac6cf Mon Sep 17 00:00:00 2001
From: Shreyas Goenka <shreyas.goenka@databricks.com>
Date: Fri, 6 Dec 2024 03:15:24 +0530
Subject: [PATCH] Add debug logs to diagnose flakyiness in extensions filer
 integration tests

---
 internal/helpers.go | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/internal/helpers.go b/internal/helpers.go
index 596f45537..838bd5c30 100644
--- a/internal/helpers.go
+++ b/internal/helpers.go
@@ -8,6 +8,7 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"io/fs"
 	"math/rand"
 	"net/http"
 	"os"
@@ -36,6 +37,7 @@ import (
 	"github.com/databricks/databricks-sdk-go/service/workspace"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
 	_ "github.com/databricks/cli/cmd/workspace"
@@ -354,9 +356,26 @@ func RequireErrorRun(t *testing.T, args ...string) (bytes.Buffer, bytes.Buffer,
 
 func readFile(t *testing.T, name string) string {
 	b, err := os.ReadFile(name)
-	require.NoError(t, err)
 
-	return string(b)
+	if assert.NoError(t, err) {
+		return string(b)
+	} else {
+		// We have observed flakyness when using this function to read certain notebooks
+		// stored in ./testdata. This are debugging logs to help diagnose the issue
+		// when it occurs again.
+		t.Logf("Error reading file %s: %w", name, err)
+		err := filepath.Walk(".", func(path string, info fs.FileInfo, err error) error {
+			if info.IsDir() {
+				t.Logf("Found directory: %s", path)
+			} else {
+				t.Logf("Found file: %s", path)
+			}
+			return nil
+		})
+		if err != nil {
+			t.Logf("Error walking directory: %w", err)
+		}
+	}
 }
 
 func writeFile(t *testing.T, name string, body string) string {