Cleanup

Author: srahul3

agent/consul/state/session_ce.go

@@ -152,6 +152,7 @@ func validateSessionChecksTxn(tx ReadTxn, session *structs.Session) error {
 
 		// Verify that the check is not in critical state
 		healthCheck := check.(*structs.HealthCheck)
+		// we are discounting the health check for session checks since they are expected to be in critical state without session and this flow is expected to be used for session checks
 		if healthCheck.Status == api.HealthCritical && healthCheck.Type != "session" {
 			return fmt.Errorf("Check '%s' is in %s state", checkID, healthCheck.Status)
 		}

agent/consul/state/session_test.go

@@ -962,6 +962,7 @@ func TestStateStore_Session_Invalidate_PreparedQuery_Delete(t *testing.T) {
 	}
 }
 
+// the goal of this test is to verify if the system is blocking the session registration when a check is in critical state.
 func TestHealthCheck_SessionRegistrationFail(t *testing.T) {
 	s := testStateStore(t)
 
@@ -1041,6 +1042,7 @@ func TestHealthCheck_SessionRegistrationAllow(t *testing.T) {
 	}
 }
 
+// test the session health check when session status is changed
 func TestHealthCheck_Session(t *testing.T) {
 	s := testStateStore(t)