tflog: Additional code comments around caller information in test cases

hashicorp · Mar 9, 2022 · 32c0060 · 32c0060
1 parent bff406a
commit 32c0060
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/tflog/options_test.go b/tflog/options_test.go
@@ -31,6 +31,8 @@ func TestWithAdditionalLocationOffset(t *testing.T) {
 			},
 			expectedOutput: []map[string]interface{}{
 				{
+					// Caller line (number after colon) should match
+					// tflog.SubsystemTrace() line in test case implementation.
 					"@caller":  "/tflog/options_test.go:30",
 					"@level":   hclog.Trace.String(),
 					"@message": "test message",
@@ -45,6 +47,9 @@ func TestWithAdditionalLocationOffset(t *testing.T) {
 			},
 			expectedOutput: []map[string]interface{}{
 				{
+					// Caller line (number after colon) should match
+					// tflog.SubsystemTrace() line in testSubsystemTraceHelper
+					// function implementation.
 					"@caller":  "/tflog/options_test.go:16",
 					"@level":   hclog.Trace.String(),
 					"@message": "test message",
@@ -59,7 +64,10 @@ func TestWithAdditionalLocationOffset(t *testing.T) {
 			},
 			expectedOutput: []map[string]interface{}{
 				{
-					"@caller":  "/tflog/options_test.go:58",
+					// Caller line (number after colon) should match
+					// testSubsystemTraceHelper() line in test case
+					// implementation.
+					"@caller":  "/tflog/options_test.go:63",
 					"@level":   hclog.Trace.String(),
 					"@message": "test message",
 					"@module":  testSubsystemModule,