feat: Integration tests for ListInstances v2 endpoint (#9452)

internal/api/grpc/instance/v2/integration_test/query_test.go

@@ -7,7 +7,10 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 	"github.com/zitadel/zitadel/internal/integration"
+	filter "github.com/zitadel/zitadel/pkg/grpc/filter/v2beta"
+	instance "github.com/zitadel/zitadel/pkg/grpc/instance/v2beta"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 	"google.golang.org/protobuf/types/known/emptypb"
@@ -57,3 +60,77 @@ func TestGetInstance(t *testing.T) {
 		})
 	}
 }
+
+func TestListInstances(t *testing.T) {
+	// Given
+	inst := integration.NewInstance(CTXWithSysAuthZ)
+	inst2 := integration.NewInstance(CTXWithSysAuthZ)
+
+	orgOwnerCtx := inst.WithAuthorization(context.Background(), integration.UserTypeOrgOwner)
+	tt := []struct {
+		testName          string
+		inputRequest      *instance.ListInstancesRequest
+		inputContext      context.Context
+		expectedErrorMsg  string
+		expectedErrorCode codes.Code
+		expectedInstances []string
+	}{
+		{
+			testName: "when invalid context should return unauthN error",
+			inputRequest: &instance.ListInstancesRequest{
+				Pagination: &filter.PaginationRequest{Offset: 0, Limit: 10},
+			},
+			inputContext:      context.Background(),
+			expectedErrorCode: codes.Unauthenticated,
+			expectedErrorMsg:  "auth header missing",
+		},
+		{
+			testName: "when unauthZ context should return unauthZ error",
+			inputRequest: &instance.ListInstancesRequest{
+				Pagination: &filter.PaginationRequest{Offset: 0, Limit: 10},
+			},
+			inputContext:      orgOwnerCtx,
+			expectedErrorCode: codes.PermissionDenied,
+			expectedErrorMsg:  "No matching permissions found (AUTH-5mWD2)",
+		},
+		{
+			testName: "when valid request with filter should return paginated response",
+			inputRequest: &instance.ListInstancesRequest{
+				Pagination:    &filter.PaginationRequest{Offset: 0, Limit: 10},
+				SortingColumn: instance.FieldName_FIELD_NAME_CREATION_DATE,
+				Queries: []*instance.Query{
+					{
+						Query: &instance.Query_IdQuery{
+							IdQuery: &instance.IdsQuery{
+								Ids: []string{inst.ID(), inst2.ID()},
+							},
+						},
+					},
+				},
+			},
+			inputContext:      CTXWithSysAuthZ,
+			expectedInstances: []string{inst.ID()},
+		},
+	}
+
+	for _, tc := range tt {
+		t.Run(tc.testName, func(t *testing.T) {
+			// Test
+			res, err := inst.Client.InstanceV2Beta.ListInstances(tc.inputContext, tc.inputRequest)
+
+			// Verify
+			assert.Equal(t, tc.expectedErrorCode, status.Code(err))
+			assert.Equal(t, tc.expectedErrorMsg, status.Convert(err).Message())
+
+			if tc.expectedErrorMsg == "" {
+				require.NotNil(t, res)
+
+				instaceIDs := []string{}
+				for _, i := range res.GetInstances() {
+					instaceIDs = append(instaceIDs, i.GetId())
+				}
+				assert.Subset(t, instaceIDs, tc.expectedInstances)
+			}
+		})
+	}
+}