175
e2e/internal/testutil/assert.go
Normal file
175
e2e/internal/testutil/assert.go
Normal file
@@ -0,0 +1,175 @@
|
||||
// Copyright (c) 2025 Probo Inc <hello@getprobo.com>.
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
// copyright notice and this permission notice appear in all copies.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||||
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
||||
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||||
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||||
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
// PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
package testutil
|
||||
|
||||
import (
|
||||
"cmp"
|
||||
"slices"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// PageInfo represents GraphQL Relay-style pagination info.
|
||||
// This type can be embedded in result structs to avoid repeating the definition.
|
||||
type PageInfo struct {
|
||||
HasNextPage bool `json:"hasNextPage"`
|
||||
HasPreviousPage bool `json:"hasPreviousPage"`
|
||||
StartCursor *string `json:"startCursor"`
|
||||
EndCursor *string `json:"endCursor"`
|
||||
}
|
||||
|
||||
// AssertFirstPage asserts that the response represents a valid first page of results.
|
||||
// It checks that the edge count matches expected, hasNextPage equals expectMore,
|
||||
// and hasPreviousPage is false.
|
||||
func AssertFirstPage(t *testing.T, edgeCount int, pageInfo PageInfo, expectedCount int, expectMore bool) {
|
||||
t.Helper()
|
||||
assert.Equal(t, expectedCount, edgeCount, "unexpected number of edges")
|
||||
assert.Equal(t, expectMore, pageInfo.HasNextPage, "hasNextPage mismatch")
|
||||
assert.False(t, pageInfo.HasPreviousPage, "first page should not have previous page")
|
||||
}
|
||||
|
||||
// AssertMiddlePage asserts that the response represents a valid middle page of results.
|
||||
// It checks that the edge count matches expected and both hasNextPage and hasPreviousPage are true.
|
||||
func AssertMiddlePage(t *testing.T, edgeCount int, pageInfo PageInfo, expectedCount int) {
|
||||
t.Helper()
|
||||
assert.Equal(t, expectedCount, edgeCount, "unexpected number of edges")
|
||||
assert.True(t, pageInfo.HasNextPage, "middle page should have next page")
|
||||
assert.True(t, pageInfo.HasPreviousPage, "middle page should have previous page")
|
||||
}
|
||||
|
||||
// AssertLastPage asserts that the response represents a valid last page of results.
|
||||
// It checks that the edge count matches expected, hasNextPage is false,
|
||||
// and hasPreviousPage equals expectPrevious.
|
||||
func AssertLastPage(t *testing.T, edgeCount int, pageInfo PageInfo, expectedCount int, expectPrevious bool) {
|
||||
t.Helper()
|
||||
assert.Equal(t, expectedCount, edgeCount, "unexpected number of edges")
|
||||
assert.False(t, pageInfo.HasNextPage, "last page should not have next page")
|
||||
assert.Equal(t, expectPrevious, pageInfo.HasPreviousPage, "hasPreviousPage mismatch")
|
||||
}
|
||||
|
||||
// AssertHasMorePages asserts that there are more pages available after the current one.
|
||||
func AssertHasMorePages(t *testing.T, pageInfo PageInfo) {
|
||||
t.Helper()
|
||||
assert.True(t, pageInfo.HasNextPage, "expected more pages")
|
||||
assert.NotNil(t, pageInfo.EndCursor, "endCursor should be set when there are more pages")
|
||||
}
|
||||
|
||||
// AssertHasPreviousPages asserts that there are previous pages before the current one.
|
||||
func AssertHasPreviousPages(t *testing.T, pageInfo PageInfo) {
|
||||
t.Helper()
|
||||
assert.True(t, pageInfo.HasPreviousPage, "expected previous pages")
|
||||
assert.NotNil(t, pageInfo.StartCursor, "startCursor should be set when there are previous pages")
|
||||
}
|
||||
|
||||
// AssertTimestampsOnCreate validates that createdAt and updatedAt are properly set
|
||||
// after resource creation: both should be after beforeCreate and equal to each other.
|
||||
func AssertTimestampsOnCreate(t *testing.T, createdAt, updatedAt, beforeCreate time.Time) {
|
||||
t.Helper()
|
||||
assert.True(t, createdAt.After(beforeCreate), "createdAt should be after test start")
|
||||
assert.True(t, updatedAt.After(beforeCreate), "updatedAt should be after test start")
|
||||
assert.Equal(t, createdAt, updatedAt, "createdAt and updatedAt should be equal on create")
|
||||
}
|
||||
|
||||
// AssertTimestampsOnUpdate validates that timestamps are properly updated:
|
||||
// createdAt should remain unchanged, updatedAt should be after the previous value.
|
||||
func AssertTimestampsOnUpdate(t *testing.T, createdAt, updatedAt, originalCreatedAt, originalUpdatedAt time.Time) {
|
||||
t.Helper()
|
||||
assert.Equal(t, originalCreatedAt, createdAt, "createdAt should not change on update")
|
||||
assert.True(t, updatedAt.After(originalUpdatedAt) || updatedAt.Equal(originalUpdatedAt),
|
||||
"updatedAt should be >= previous updatedAt")
|
||||
}
|
||||
|
||||
// AssertOptionalStringEqual validates optional string fields (pointers).
|
||||
// If expected is nil, actual must be nil. Otherwise, both must be non-nil and equal.
|
||||
func AssertOptionalStringEqual(t *testing.T, expected, actual *string, fieldName string) {
|
||||
t.Helper()
|
||||
if expected == nil {
|
||||
assert.Nil(t, actual, "%s should be nil", fieldName)
|
||||
} else {
|
||||
require.NotNil(t, actual, "%s should not be nil", fieldName)
|
||||
assert.Equal(t, *expected, *actual, "%s mismatch", fieldName)
|
||||
}
|
||||
}
|
||||
|
||||
// AssertOrderedAscending validates that a slice is sorted in ascending order.
|
||||
func AssertOrderedAscending[T cmp.Ordered](t *testing.T, values []T, fieldName string) {
|
||||
t.Helper()
|
||||
assert.True(t, slices.IsSorted(values), "%s should be in ascending order, got: %v", fieldName, values)
|
||||
}
|
||||
|
||||
// AssertOrderedDescending validates that a slice is sorted in descending order.
|
||||
func AssertOrderedDescending[T cmp.Ordered](t *testing.T, values []T, fieldName string) {
|
||||
t.Helper()
|
||||
reversed := slices.Clone(values)
|
||||
slices.Reverse(reversed)
|
||||
assert.True(t, slices.IsSorted(reversed), "%s should be in descending order, got: %v", fieldName, values)
|
||||
}
|
||||
|
||||
// AssertTimesOrderedAscending validates that times are in ascending order.
|
||||
func AssertTimesOrderedAscending(t *testing.T, times []time.Time, fieldName string) {
|
||||
t.Helper()
|
||||
isSorted := slices.IsSortedFunc(times, func(a, b time.Time) int {
|
||||
return a.Compare(b)
|
||||
})
|
||||
assert.True(t, isSorted, "%s should be in ascending order", fieldName)
|
||||
}
|
||||
|
||||
// AssertTimesOrderedDescending validates that times are in descending order.
|
||||
func AssertTimesOrderedDescending(t *testing.T, times []time.Time, fieldName string) {
|
||||
t.Helper()
|
||||
isSorted := slices.IsSortedFunc(times, func(a, b time.Time) int {
|
||||
return b.Compare(a)
|
||||
})
|
||||
assert.True(t, isSorted, "%s should be in descending order", fieldName)
|
||||
}
|
||||
|
||||
// AssertNodeNotAccessible validates that a node query returns nil or an error
|
||||
// (used for tenant isolation tests).
|
||||
func AssertNodeNotAccessible(t *testing.T, err error, nodeIsNil bool, resourceType string) {
|
||||
t.Helper()
|
||||
if err == nil {
|
||||
assert.True(t, nodeIsNil, "should not be able to access %s from another org", resourceType)
|
||||
}
|
||||
// If there's an error, that's also acceptable (access denied)
|
||||
}
|
||||
|
||||
// RequireForbiddenError asserts that the error is a GraphQL FORBIDDEN error.
|
||||
func RequireForbiddenError(t *testing.T, err error, msgAndArgs ...any) {
|
||||
t.Helper()
|
||||
RequireErrorCode(t, err, "FORBIDDEN", msgAndArgs...)
|
||||
}
|
||||
|
||||
// RequireErrorCode asserts that the error is a GraphQL error with the specified code.
|
||||
func RequireErrorCode(t *testing.T, err error, code string, msgAndArgs ...any) {
|
||||
t.Helper()
|
||||
require.Error(t, err, msgAndArgs...)
|
||||
|
||||
var gqlErrors GraphQLErrors
|
||||
if !assert.ErrorAs(t, err, &gqlErrors) {
|
||||
t.Fatalf("expected GraphQL error, got: %T: %v", err, err)
|
||||
}
|
||||
|
||||
if len(gqlErrors) == 0 {
|
||||
t.Fatalf("expected at least one GraphQL error, got none")
|
||||
}
|
||||
|
||||
if gqlErrors[0].Code() != code {
|
||||
t.Fatalf("expected %s error code, got %q with message: %q",
|
||||
code, gqlErrors[0].Code(), gqlErrors[0].Message)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user