Files
tasks/common/persistence/tests/nexus_endpoint_suite.go
Alex ShtinandGitHub 8e8f1b0f7c Remove license header from every file (#7689)
## What changed?
<!-- Describe what has changed in this PR -->
Remove license header from every file. Because it is really hard to
follow in this PR here is the summary:
1. License header is removed from all `.go` and `.proto` files
:fireworks::fireworks:🎆.
2. `LICENSE` file in the root directory has only Temporal and Uber
copyrights.
3. 5 other `LICENSE` files added to the packages which have copyrights
different from Temporal and Uber: Datadog, Xargin, "Mat Ryer, Tyler
Bunnell and contributors".
4. `license_file` flag is removed from all code generation tools.
5. `copyright_file` flag is removed from `go:generate mockgen`
directive.
6. All copyright related targets are removed from `Makefile`.
7. Updated Temporal copyright year to 2025 everywhere.

## Why?
<!-- Tell your future self why have you made these changes -->
I double checked with legal department that it is not needed to have
license header in every file. One file per repo is enough. I put all
copyrights to the root `LICENSE` file and removed header from all other
files. Also updated tools and `Makefile`.
2025-05-01 18:50:21 -07:00

320 lines
12 KiB
Go

package tests
import (
"context"
"sync/atomic"
"testing"
"time"
"github.com/google/uuid"
"github.com/stretchr/testify/require"
commonpb "go.temporal.io/api/common/v1"
enumspb "go.temporal.io/api/enums/v1"
"go.temporal.io/server/common/persistence"
"go.temporal.io/server/common/persistence/sql"
)
func RunNexusEndpointTestSuite(t *testing.T, store persistence.NexusEndpointStore, tableVersion *atomic.Int64) {
// NB: These tests cannot be run in parallel because of concurrent updates to the table version by different tests
t.Run("TestNexusEndpointsSteadyState", func(t *testing.T) {
testNexusEndpointsStoreSteadyState(t, store, tableVersion)
})
t.Run("TestCreateOrUpdateNexusEndpointExpectedErrors", func(t *testing.T) {
testCreateOrUpdateNexusEndpointExpectedErrors(t, store, tableVersion)
})
t.Run("TestListNexusEndpointsExpectedErrors", func(t *testing.T) {
testListNexusEndpointsExpectedErrors(t, store, tableVersion)
})
t.Run("TestDeleteNexusEndpointExpectedErrors", func(t *testing.T) {
testDeleteNexusEndpointExpectedErrors(t, store, tableVersion)
})
}
func RunNexusEndpointTestSuiteForSQL(t *testing.T, factory *sql.Factory) {
tableVersion := atomic.Int64{}
t.Run("Generic", func(t *testing.T) {
store, err := factory.NewNexusEndpointStore()
require.NoError(t, err)
RunNexusEndpointTestSuite(t, store, &tableVersion)
})
}
func testNexusEndpointsStoreSteadyState(t *testing.T, store persistence.NexusEndpointStore, tableVersion *atomic.Int64) {
t.Run("SteadyState", func(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
data := &commonpb.DataBlob{
Data: []byte("dummy endpoint data"),
EncodingType: enumspb.ENCODING_TYPE_PROTO3,
}
// Get endpoint by ID when table is empty
endpoint, err := store.GetNexusEndpoint(ctx, &persistence.GetNexusEndpointRequest{ID: uuid.NewString()})
require.ErrorContains(t, err, "not found")
require.Nil(t, endpoint)
// List when table is empty
resp, err := store.ListNexusEndpoints(ctx, &persistence.ListNexusEndpointsRequest{PageSize: 10})
require.NoError(t, err)
require.Len(t, resp.Endpoints, 0)
require.Equal(t, tableVersion.Load(), resp.TableVersion)
// Create an endpoint
firstEndpoint := persistence.InternalNexusEndpoint{ID: uuid.NewString(), Version: 0, Data: data}
err = store.CreateOrUpdateNexusEndpoint(ctx, &persistence.InternalCreateOrUpdateNexusEndpointRequest{
LastKnownTableVersion: tableVersion.Load(),
Endpoint: firstEndpoint,
})
require.NoError(t, err)
tableVersion.Add(1)
firstEndpoint.Version++
// Get endpoint by ID
endpoint, err = store.GetNexusEndpoint(ctx, &persistence.GetNexusEndpointRequest{ID: firstEndpoint.ID})
require.NoError(t, err)
require.Equal(t, firstEndpoint.ID, endpoint.ID)
require.Equal(t, firstEndpoint.Version, endpoint.Version)
// List one
resp, err = store.ListNexusEndpoints(ctx, &persistence.ListNexusEndpointsRequest{PageSize: 10})
require.NoError(t, err)
require.Contains(t, resp.Endpoints, firstEndpoint)
require.Equal(t, resp.TableVersion, tableVersion.Load())
// Create a second endpoint
secondEndpoint := persistence.InternalNexusEndpoint{ID: uuid.NewString(), Version: 0, Data: data}
err = store.CreateOrUpdateNexusEndpoint(ctx, &persistence.InternalCreateOrUpdateNexusEndpointRequest{
LastKnownTableVersion: tableVersion.Load(),
Endpoint: secondEndpoint,
})
require.NoError(t, err)
tableVersion.Add(1)
secondEndpoint.Version++
// List multiple
resp, err = store.ListNexusEndpoints(ctx, &persistence.ListNexusEndpointsRequest{PageSize: 10})
require.NoError(t, err)
require.Contains(t, resp.Endpoints, firstEndpoint)
require.Contains(t, resp.Endpoints, secondEndpoint)
require.Equal(t, resp.TableVersion, tableVersion.Load())
// Create a third endpoints
thirdEndpointID := uuid.New().String()
err = store.CreateOrUpdateNexusEndpoint(ctx, &persistence.InternalCreateOrUpdateNexusEndpointRequest{
LastKnownTableVersion: tableVersion.Load(),
Endpoint: persistence.InternalNexusEndpoint{ID: thirdEndpointID, Data: data},
})
require.NoError(t, err)
tableVersion.Add(1)
// Update an endpoint
err = store.CreateOrUpdateNexusEndpoint(ctx, &persistence.InternalCreateOrUpdateNexusEndpointRequest{
LastKnownTableVersion: tableVersion.Load(),
Endpoint: persistence.InternalNexusEndpoint{ID: thirdEndpointID, Version: 1, Data: data},
})
require.NoError(t, err)
tableVersion.Add(1)
// List in pages (page 1)
resp, err = store.ListNexusEndpoints(ctx, &persistence.ListNexusEndpointsRequest{PageSize: 2})
require.NoError(t, err)
require.Len(t, resp.Endpoints, 2)
require.Equal(t, resp.TableVersion, tableVersion.Load())
require.NotNil(t, resp.NextPageToken)
// List in pages (page 2)
resp, err = store.ListNexusEndpoints(ctx, &persistence.ListNexusEndpointsRequest{
PageSize: 2,
NextPageToken: resp.NextPageToken,
LastKnownTableVersion: resp.TableVersion,
})
require.NoError(t, err)
require.Len(t, resp.Endpoints, 1)
require.Equal(t, resp.TableVersion, tableVersion.Load())
require.Nil(t, resp.NextPageToken)
// Delete an endpoint
err = store.DeleteNexusEndpoint(ctx, &persistence.DeleteNexusEndpointRequest{
ID: firstEndpoint.ID,
LastKnownTableVersion: tableVersion.Load(),
})
require.NoError(t, err)
tableVersion.Add(1)
// List endpoints with table version
resp, err = store.ListNexusEndpoints(ctx, &persistence.ListNexusEndpointsRequest{
PageSize: 10,
NextPageToken: nil,
LastKnownTableVersion: tableVersion.Load(),
})
require.NoError(t, err)
require.Len(t, resp.Endpoints, 2)
// Delete remaining endpoints
err = store.DeleteNexusEndpoint(ctx, &persistence.DeleteNexusEndpointRequest{
ID: secondEndpoint.ID,
LastKnownTableVersion: tableVersion.Load(),
})
require.NoError(t, err)
tableVersion.Add(1)
err = store.DeleteNexusEndpoint(ctx, &persistence.DeleteNexusEndpointRequest{
ID: thirdEndpointID,
LastKnownTableVersion: tableVersion.Load(),
})
require.NoError(t, err)
tableVersion.Add(1)
// List endpoints when table empty and expected version non-zero
resp, err = store.ListNexusEndpoints(ctx, &persistence.ListNexusEndpointsRequest{
PageSize: 10,
NextPageToken: nil,
LastKnownTableVersion: tableVersion.Load(),
})
require.NoError(t, err)
require.Len(t, resp.Endpoints, 0)
})
}
func testCreateOrUpdateNexusEndpointExpectedErrors(t *testing.T, store persistence.NexusEndpointStore, tableVersion *atomic.Int64) {
t.Run("ExpectedErrors", func(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
data := &commonpb.DataBlob{
Data: []byte("dummy endpoint data"),
EncodingType: enumspb.ENCODING_TYPE_PROTO3,
}
// Valid create
endpointID := uuid.New().String()
err := store.CreateOrUpdateNexusEndpoint(ctx, &persistence.InternalCreateOrUpdateNexusEndpointRequest{
LastKnownTableVersion: tableVersion.Load(),
Endpoint: persistence.InternalNexusEndpoint{ID: endpointID, Version: 0, Data: data},
})
require.NoError(t, err)
tableVersion.Add(1)
// Valid update
err = store.CreateOrUpdateNexusEndpoint(ctx, &persistence.InternalCreateOrUpdateNexusEndpointRequest{
LastKnownTableVersion: tableVersion.Load(),
Endpoint: persistence.InternalNexusEndpoint{ID: endpointID, Version: 1, Data: data},
})
require.NoError(t, err)
tableVersion.Add(1)
// Create request (version=0) when endpoint already exists
err = store.CreateOrUpdateNexusEndpoint(ctx, &persistence.InternalCreateOrUpdateNexusEndpointRequest{
LastKnownTableVersion: tableVersion.Load(),
Endpoint: persistence.InternalNexusEndpoint{ID: endpointID, Version: 0, Data: data},
})
require.ErrorContains(t, err, "nexus endpoint version mismatch")
// Update request version mismatch
err = store.CreateOrUpdateNexusEndpoint(ctx, &persistence.InternalCreateOrUpdateNexusEndpointRequest{
LastKnownTableVersion: tableVersion.Load(),
Endpoint: persistence.InternalNexusEndpoint{ID: endpointID, Version: 10, Data: data},
})
require.ErrorContains(t, err, "nexus endpoint version mismatch")
// Create request table version mismatch
err = store.CreateOrUpdateNexusEndpoint(ctx, &persistence.InternalCreateOrUpdateNexusEndpointRequest{
LastKnownTableVersion: 10,
Endpoint: persistence.InternalNexusEndpoint{ID: uuid.NewString(), Version: 0, Data: data},
})
require.ErrorContains(t, err, "nexus endpoints table version mismatch")
// Update request table version mismatch
err = store.CreateOrUpdateNexusEndpoint(ctx, &persistence.InternalCreateOrUpdateNexusEndpointRequest{
LastKnownTableVersion: 10,
Endpoint: persistence.InternalNexusEndpoint{ID: endpointID, Version: 2, Data: data},
})
require.ErrorContains(t, err, "nexus endpoints table version mismatch")
})
}
func testListNexusEndpointsExpectedErrors(t *testing.T, store persistence.NexusEndpointStore, tableVersion *atomic.Int64) {
t.Run("ExpectedErrors", func(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
data := &commonpb.DataBlob{
Data: []byte("dummy endpoint data"),
EncodingType: enumspb.ENCODING_TYPE_PROTO3,
}
// Create two endpoints
firstEndpoint := persistence.InternalNexusEndpoint{ID: uuid.NewString(), Version: 0, Data: data}
err := store.CreateOrUpdateNexusEndpoint(ctx, &persistence.InternalCreateOrUpdateNexusEndpointRequest{
LastKnownTableVersion: tableVersion.Load(),
Endpoint: firstEndpoint,
})
require.NoError(t, err)
tableVersion.Add(1)
firstEndpoint.Version = 1
secondEndpoint := persistence.InternalNexusEndpoint{ID: uuid.NewString(), Version: 0, Data: data}
err = store.CreateOrUpdateNexusEndpoint(ctx, &persistence.InternalCreateOrUpdateNexusEndpointRequest{
LastKnownTableVersion: tableVersion.Load(),
Endpoint: secondEndpoint,
})
require.NoError(t, err)
tableVersion.Add(1)
secondEndpoint.Version = 1
// Valid list
resp, err := store.ListNexusEndpoints(ctx, &persistence.ListNexusEndpointsRequest{PageSize: 10, LastKnownTableVersion: tableVersion.Load()})
require.NoError(t, err)
require.Contains(t, resp.Endpoints, firstEndpoint)
require.Contains(t, resp.Endpoints, secondEndpoint)
require.Equal(t, resp.TableVersion, tableVersion.Load())
// Table version mismatch
_, err = store.ListNexusEndpoints(ctx, &persistence.ListNexusEndpointsRequest{PageSize: 10, LastKnownTableVersion: 100})
require.ErrorContains(t, err, "nexus endpoints table version mismatch")
})
}
func testDeleteNexusEndpointExpectedErrors(t *testing.T, store persistence.NexusEndpointStore, tableVersion *atomic.Int64) {
t.Run("ExpectedErrors", func(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
data := &commonpb.DataBlob{
Data: []byte("dummy endpoint data"),
EncodingType: enumspb.ENCODING_TYPE_PROTO3,
}
// Create an endpoint
id := uuid.New().String()
err := store.CreateOrUpdateNexusEndpoint(ctx, &persistence.InternalCreateOrUpdateNexusEndpointRequest{
LastKnownTableVersion: tableVersion.Load(),
Endpoint: persistence.InternalNexusEndpoint{ID: id, Version: 0, Data: data},
})
require.NoError(t, err)
tableVersion.Add(1)
// Table version mismatch
err = store.DeleteNexusEndpoint(ctx, &persistence.DeleteNexusEndpointRequest{
ID: id,
LastKnownTableVersion: 100,
})
require.ErrorContains(t, err, "nexus endpoints table version mismatch")
// Delete non-existent endpoint
err = store.DeleteNexusEndpoint(ctx, &persistence.DeleteNexusEndpointRequest{
ID: uuid.NewString(),
LastKnownTableVersion: tableVersion.Load(),
})
require.ErrorContains(t, err, "nexus endpoint not found")
// Valid delete
err = store.DeleteNexusEndpoint(ctx, &persistence.DeleteNexusEndpointRequest{
ID: id,
LastKnownTableVersion: tableVersion.Load(),
})
require.NoError(t, err)
tableVersion.Add(1)
})
}