use assertions in tests

snowflakedb · Oct 27, 2023 · c157c4f · c157c4f
1 parent 9e3556b
commit c157c4f
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 60 deletions.
diff --git a/assert_test.go b/assert_test.go
@@ -10,6 +10,10 @@ import (
 	"testing"
 )
 
+func assertNilE(t *testing.T, actual any, descriptions ...string) {
+	errorOnNonEmpty(t, validateNil(actual, descriptions...))
+}
+
 func assertNilF(t *testing.T, actual any, descriptions ...string) {
 	fatalOnNonEmpty(t, validateNil(actual, descriptions...))
 }

diff --git a/auth_test.go b/auth_test.go
@@ -678,7 +678,7 @@ func TestUnitAuthenticateWithConfigOkta(t *testing.T) {
 	sc.ctx = context.Background()
 
 	err = authenticateWithConfig(sc)
-	assertNilF(t, err, "expected to have no error.")
+	assertNilE(t, err, "expected to have no error.")
 
 	sr.FuncPostAuthSAML = postAuthSAMLError
 	err = authenticateWithConfig(sc)

diff --git a/authokta_test.go b/authokta_test.go
@@ -246,22 +246,16 @@ func TestUnitAuthenticateBySAML(t *testing.T) {
 	_, err = authenticateBySAML(context.Background(), sr, authenticator, application, account, user, password)
 	assertNotNilF(t, err, "should have failed at FuncPostAuthSAML.")
 	driverErr, ok := err.(*SnowflakeError)
-	if !ok {
-		t.Fatalf("should be snowflake error. err: %v", err)
-	}
-	if driverErr.Number != ErrCodeIdpConnectionError {
-		t.Fatalf("unexpected error code. expected: %v, got: %v", ErrCodeIdpConnectionError, driverErr.Number)
-	}
+	assertTrueF(t, ok, "should be a SnowflakeError")
+	assertEqualE(t, driverErr.Number, ErrCodeIdpConnectionError)
+
 	sr.FuncPostAuthSAML = postAuthSAMLAuthSuccessButInvalidURL
 	_, err = authenticateBySAML(context.Background(), sr, authenticator, application, account, user, password)
 	assertNotNilF(t, err, "should have failed at FuncPostAuthSAML.")
 	driverErr, ok = err.(*SnowflakeError)
-	if !ok {
-		t.Fatalf("should be snowflake error. err: %v", err)
-	}
-	if driverErr.Number != ErrCodeIdpConnectionError {
-		t.Fatalf("unexpected error code. expected: %v, got: %v", ErrCodeIdpConnectionError, driverErr.Number)
-	}
+	assertTrueF(t, ok, "should be a SnowflakeError")
+	assertEqualE(t, driverErr.Number, ErrCodeIdpConnectionError)
+
 	sr.FuncPostAuthSAML = postAuthSAMLAuthSuccessButInvalidTokenURL
 	_, err = authenticateBySAML(context.Background(), sr, authenticator, application, account, user, password)
 	assertNotNilF(t, err, "should have failed at FuncPostAuthSAML.")
@@ -297,10 +291,6 @@ func TestUnitAuthenticateBySAML(t *testing.T) {
 	_, err = authenticateBySAML(context.Background(), sr, authenticator, application, account, user, password)
 	assertNotNilF(t, err, "should have failed at FuncGetSSO.")
 	driverErr, ok = err.(*SnowflakeError)
-	if !ok {
-		t.Fatalf("should be snowflake error. err: %v", err)
-	}
-	if driverErr.Number != ErrCodeSSOURLNotMatch {
-		t.Fatalf("unexpected error code. expected: %v, got: %v", ErrCodeSSOURLNotMatch, driverErr.Number)
-	}
+	assertTrueF(t, ok, "should be a SnowflakeError")
+	assertEqualE(t, driverErr.Number, ErrCodeSSOURLNotMatch)
 }
diff --git a/connection_util.go b/connection_util.go
@@ -23,10 +23,6 @@ func (sc *snowflakeConn) isClientSessionKeepAliveEnabled() bool {
 	return strings.Compare(*v, "true") == 0
 }
 
-func (sc *snowflakeConn) isHeartbeatNil() bool {
-	return sc.rest == nil || sc.rest.HeartBeat == nil
-}
-
 func (sc *snowflakeConn) startHeartBeat() {
 	if sc.cfg != nil && !sc.isClientSessionKeepAliveEnabled() {
 		return

diff --git a/connector_test.go b/connector_test.go
@@ -61,11 +61,9 @@ func TestConnectorWithMissingConfig(t *testing.T) {
 	connector := NewConnector(&mock, config)
 	_, err := connector.Connect(context.Background())
 	assertNotNilF(t, err, "the connection should have failed due to empty account.")
+
 	driverErr, ok := err.(*SnowflakeError)
-	if !ok {
-		t.Fatalf("Snowflake error is expected. err: %v", err.Error())
-	}
-	if driverErr.Number != expectedErr.Number || driverErr.Message != expectedErr.Message {
-		t.Fatalf("Snowflake error did not match. expected: %v, got: %v", expectedErr, driverErr)
-	}
+	assertTrueF(t, ok, "should be a SnowflakeError")
+	assertEqualE(t, driverErr.Number, expectedErr.Number)
+	assertEqualE(t, driverErr.Message, expectedErr.Message)
 }
diff --git a/dsn_test.go b/dsn_test.go
@@ -706,10 +706,10 @@ func TestParseDSN(t *testing.T) {
 			ocspMode: ocspModeFailOpen,
 			err:      nil,
 		},
-    {
-      dsn: "u:[email protected]:443?authenticator=http%3A%2F%2Fsc.okta.com&ocspFailOpen=true&validateDefaultParameters=true",
-      err: errFailedToParseAuthenticator(),
-    },
+		{
+			dsn: "u:[email protected]:443?authenticator=http%3A%2F%2Fsc.okta.com&ocspFailOpen=true&validateDefaultParameters=true",
+			err: errFailedToParseAuthenticator(),
+		},
 	}
 
 	for _, at := range []AuthType{AuthTypeExternalBrowser, AuthTypeOAuth} {

diff --git a/heartbeat_test.go b/heartbeat_test.go
@@ -20,34 +20,24 @@ func TestUnitPostHeartbeat(t *testing.T) {
 			restful: sr,
 		}
 		err := heartbeat.heartbeatMain()
-		if err != nil {
-			t.Fatalf("failed to heartbeat and renew session. err: %v", err)
-		}
+		assertNilF(t, err, "failed to heartbeat and renew session")
 
 		heartbeat.restful.FuncPost = postTestError
 		err = heartbeat.heartbeatMain()
-		if err == nil {
-			t.Fatal("should have failed")
-		}
+		assertNotNilF(t, err, "should have failed to start heartbeat")
+		assertEqualE(t, err.Error(), "failed to run post method")
 
 		heartbeat.restful.FuncPost = postTestSuccessButInvalidJSON
 		err = heartbeat.heartbeatMain()
-		if err == nil {
-			t.Fatal("should have failed")
-		}
+		assertNotNilF(t, err, "should have failed to start heartbeat")
+		assertHasPrefixE(t, err.Error(), "invalid character")
 
 		heartbeat.restful.FuncPost = postTestAppForbiddenError
 		err = heartbeat.heartbeatMain()
-		if err == nil {
-			t.Fatal("should have failed")
-		}
+		assertNotNilF(t, err, "should have failed to start heartbeat")
 		driverErr, ok := err.(*SnowflakeError)
-		if !ok {
-			t.Fatalf("should be snowflake error. err: %v", err)
-		}
-		if driverErr.Number != ErrFailedToHeartbeat {
-			t.Fatalf("unexpected error code. expected: %v, got: %v", ErrFailedToHeartbeat, driverErr.Number)
-		}
+		assertTrueF(t, ok, "connection should be snowflakeConn")
+		assertEqualE(t, driverErr.Number, ErrFailedToHeartbeat)
 	})
 }
 
@@ -64,15 +54,11 @@ func TestHeartbeatStartAndStop(t *testing.T) {
 	}
 
 	conn, ok := db.(*snowflakeConn)
-	if ok && conn.isHeartbeatNil() {
-		t.Fatalf("heartbeat should not be nil")
-	}
+	assertTrueF(t, ok, "connection should be snowflakeConn")
+	assertNotNilF(t, conn.rest, "heartbeat should not be nil")
+	assertNotNilF(t, conn.rest.HeartBeat, "heartbeat should not be nil")
 
 	err = db.Close()
-	if err != nil {
-		t.Fatalf("should not cause error in Close. err: %v", err)
-	}
-	if ok && !conn.isHeartbeatNil() {
-		t.Fatalf("heartbeat should be nil")
-	}
+	assertNilF(t, err, "should not cause error in Close")
+	assertNilF(t, conn.rest, "heartbeat should be nil")
 }