deploy_test.go

package deploy

import (
	"errors"
	"math/big"
	"testing"

	"github.com/ethereum/go-ethereum/common"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"

	workflow_registry_v2_wrapper "github.com/smartcontractkit/chainlink-evm/gethwrappers/workflow/generated/workflow_registry_wrapper_v2"

	"github.com/smartcontractkit/cre-cli/internal/testutil/chainsim"
	"github.com/smartcontractkit/cre-cli/internal/validation"
)

func TestWorkflowDeployCommand(t *testing.T) {
	t.Run("validation errors", func(t *testing.T) {
		t.Parallel()

		tests := []struct {
			name       string
			inputs     Inputs
			wantErr    bool
			wantKey    string
			wantDetail string
		}{
			{
				name: "Empty Workflow Name",
				inputs: Inputs{
					WorkflowName:  "",
					WorkflowOwner: "0x4c0883a69102937d6234146e38a6aefbf95944c6e4d4013a6d287e4d739e7f9b",
					DonFamily:     "test_label",
				},
				wantErr:    true,
				wantKey:    "Inputs.WorkflowName",
				wantDetail: "WorkflowName must be non-empty, no longer than 64 characters, and contain only letters (a-z, A-Z), numbers (0-9), dashes (-), and underscores (_): ",
			},
			{
				name: "Workflow Name Too Long",
				inputs: Inputs{
					WorkflowName:  "this_is_a_really_long_workflow_name_that_exceeds_the_maximum_allowed_length_of_64_chars",
					WorkflowOwner: "0x4c0883a69102937d6234146e38a6aefbf95944c6e4d4013a6d287e4d739e7f9b",
					DonFamily:     "test_label",
				},
				wantErr:    true,
				wantKey:    "Inputs.WorkflowName",
				wantDetail: "WorkflowName must be non-empty, no longer than 64 characters, and contain only letters (a-z, A-Z), numbers (0-9), dashes (-), and underscores (_): this_is_a_really_long_workflow_name_that_exceeds_the_maximum_allowed_length_of_64_chars",
			},
			{
				name: "Invalid Workflow Owner - Missing 0x Prefix",
				inputs: Inputs{
					WorkflowName:  "valid_workflow",
					WorkflowOwner: "4c0883a69102937d6234146e38a6aefbf95944c6e4d4013a6d287e4d739e7f9b",
					DonFamily:     "test_label",
				},
				wantErr:    true,
				wantKey:    "Inputs.WorkflowOwner",
				wantDetail: "WorkflowOwner must be a valid Ethereum address starting with 0x: 4c0883a69102937d6234146e38a6aefbf95944c6e4d4013a6d287e4d739e7f9b",
			},
			{
				name: "Invalid Workflow Owner - Wrong Length",
				inputs: Inputs{
					WorkflowName:  "valid_workflow",
					WorkflowOwner: "0x12345",
					DonFamily:     "test_label",
				},
				wantErr:    true,
				wantKey:    "Inputs.WorkflowOwner",
				wantDetail: "WorkflowOwner must be a valid Ethereum address starting with 0x: 0x12345",
			},
			{
				name: "Empty Workflow Owner",
				inputs: Inputs{
					WorkflowName:  "valid_workflow",
					WorkflowOwner: "",
					DonFamily:     "test_label",
				},
				wantErr:    true,
				wantKey:    "Inputs.WorkflowOwner",
				wantDetail: "WorkflowOwner must be a valid Ethereum address starting with 0x: ",
			},
			{
				name: "Missing DonFamily",
				inputs: Inputs{
					WorkflowName:  "valid_workflow",
					WorkflowOwner: chainsim.TestAddress,
				},
				wantErr:    true,
				wantKey:    "Inputs.DonFamily",
				wantDetail: "DonFamily is a required field",
			},
			{
				name: "Invalid Binary URL",
				inputs: Inputs{
					WorkflowName:  "valid_workflow",
					WorkflowOwner: chainsim.TestAddress,
					BinaryURL:     "htp://invalid-url",
					DonFamily:     "test_label",
				},
				wantErr:    true,
				wantKey:    "Inputs.BinaryURL",
				wantDetail: "BinaryURL must be empty or a valid HTTP URL: htp://invalid-url",
			},
			{
				name: "Invalid Config URL",
				inputs: Inputs{
					WorkflowName:  "valid_workflow",
					WorkflowOwner: chainsim.TestAddress,
					BinaryURL:     "https://valid-url.com/binary",
					ConfigURL:     stringPtr("htp://invalid-url"),
					DonFamily:     "test_label",
				},
				wantErr:    true,
				wantKey:    "Inputs.ConfigURL",
				wantDetail: "ConfigURL must be empty or a valid HTTP URL: htp://invalid-url",
			},
		}

		for _, tt := range tests {
			t.Run(tt.name, func(t *testing.T) {
				simulatedEnvironment := chainsim.NewSimulatedEnvironment(t)
				defer simulatedEnvironment.Close()

				ctx, buf := simulatedEnvironment.NewRuntimeContextWithBufferedOutput()
				handler := newHandler(ctx, buf)

				ctx.Settings = createTestSettings(
					chainsim.TestAddress,
					"eoa",
					"test_workflow",
					"testdata/basic_workflow/main.go",
					"",
				)
				handler.settings = ctx.Settings

				handler.inputs = tt.inputs
				err := handler.ValidateInputs()

				if tt.wantErr {
					require.Error(t, err)
					// Ensure the error is wrapped and of type ValidationErrors
					var verrs validation.ValidationErrors
					assert.True(t, errors.As(err, &verrs), "Expected error to wrap validator.ValidationErrors")

					validation.AssertValidationErrs(t, verrs, tt.wantKey, tt.wantDetail)
					assert.False(t, handler.validated)
				}
			})
		}
	})
}

func TestResolveInputs_TagTruncation(t *testing.T) {
	t.Parallel()

	tests := []struct {
		name           string
		workflowName   string
		expectedTag    string
		expectedTagLen int
		shouldTruncate bool
	}{
		{
			name:           "short name is not truncated",
			workflowName:   "my-workflow",
			expectedTag:    "my-workflow",
			expectedTagLen: 11,
			shouldTruncate: false,
		},
		{
			name:           "exactly 32 char name is not truncated",
			workflowName:   "exactly-32-characters-long-name1",
			expectedTag:    "exactly-32-characters-long-name1",
			expectedTagLen: 32,
			shouldTruncate: false,
		},
		{
			name:           "33 char name is truncated to 32",
			workflowName:   "exactly-33-characters-long-name12",
			expectedTag:    "exactly-33-characters-long-name1",
			expectedTagLen: 32,
			shouldTruncate: true,
		},
		{
			name:           "64 char name is truncated to 32",
			workflowName:   "this-is-a-maximum-length-workflow-name-with-exactly-64-character",
			expectedTag:    "this-is-a-maximum-length-workflo",
			expectedTagLen: 32,
			shouldTruncate: true,
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			t.Parallel()

			simulatedEnvironment := chainsim.NewSimulatedEnvironment(t)
			defer simulatedEnvironment.Close()

			ctx, buf := simulatedEnvironment.NewRuntimeContextWithBufferedOutput()
			handler := newHandler(ctx, buf)

			ctx.Settings = createTestSettings(
				chainsim.TestAddress,
				"eoa",
				tt.workflowName,
				"testdata/basic_workflow/main.go",
				"",
			)
			handler.settings = ctx.Settings

			inputs, err := handler.ResolveInputs(ctx.Viper)
			require.NoError(t, err)

			assert.Equal(t, tt.workflowName, inputs.WorkflowName, "WorkflowName should always be the full name")
			assert.Equal(t, tt.expectedTag, inputs.WorkflowTag, "WorkflowTag should be truncated to 32 bytes when name exceeds limit")
			assert.Equal(t, tt.expectedTagLen, len(inputs.WorkflowTag), "WorkflowTag length mismatch")

			if tt.shouldTruncate {
				assert.NotEqual(t, inputs.WorkflowName, inputs.WorkflowTag, "tag should differ from name when truncated")
				assert.True(t, len(inputs.WorkflowName) > 32, "original name should be longer than 32")
			} else {
				assert.Equal(t, inputs.WorkflowName, inputs.WorkflowTag, "tag should equal name when not truncated")
			}
		})
	}
}

func TestValidateInputs_SecretRequiresConfidential(t *testing.T) {
	t.Parallel()
	simulatedEnvironment := chainsim.NewSimulatedEnvironment(t)
	defer simulatedEnvironment.Close()

	ctx, buf := simulatedEnvironment.NewRuntimeContextWithBufferedOutput()
	h := newHandler(ctx, buf)

	h.inputs = Inputs{
		WorkflowName:                      "test_workflow",
		WorkflowOwner:                     chainsim.TestAddress,
		WorkflowPath:                      "testdata/basic_workflow/main.go",
		DonFamily:                         "zone-a",
		WorkflowRegistryContractChainName: "ethereum-testnet-sepolia",
		WorkflowRegistryContractAddress:   simulatedEnvironment.Contracts.WorkflowRegistry.Contract.Hex(),
		Secrets:                           []string{"API_KEY"},
		Confidential:                      false,
	}

	err := h.ValidateInputs()
	require.Error(t, err)
	assert.Contains(t, err.Error(), "--secret requires --confidential flag")
	assert.False(t, h.validated)
}

func stringPtr(s string) *string {
	return &s
}

type fakeUserDonLimitClient struct {
	maxAllowed           uint32
	workflowsByOwner     []workflow_registry_v2_wrapper.WorkflowRegistryWorkflowMetadataView
	workflowsByOwnerName []workflow_registry_v2_wrapper.WorkflowRegistryWorkflowMetadataView
}

func (f fakeUserDonLimitClient) CheckUserDonLimit(owner common.Address, donFamily string, pending uint32) error {
	var currentActive uint32
	for _, workflow := range f.workflowsByOwner {
		if workflow.Owner == owner && workflow.Status == workflowStatusActive && workflow.DonFamily == donFamily {
			currentActive++
		}
	}

	if currentActive+pending > f.maxAllowed {
		return errors.New("workflow limit reached")
	}
	return nil
}

func (f fakeUserDonLimitClient) GetWorkflowListByOwnerAndName(common.Address, string, *big.Int, *big.Int) ([]workflow_registry_v2_wrapper.WorkflowRegistryWorkflowMetadataView, error) {
	return f.workflowsByOwnerName, nil
}

func TestCheckUserDonLimitBeforeDeploy(t *testing.T) {
	owner := common.HexToAddress(chainsim.TestAddress)
	donFamily := "test-don"
	workflowName := "test-workflow"

	t.Run("errors when limit reached", func(t *testing.T) {
		client := fakeUserDonLimitClient{
			maxAllowed: 2,
			workflowsByOwner: []workflow_registry_v2_wrapper.WorkflowRegistryWorkflowMetadataView{
				{Owner: owner, Status: workflowStatusActive, DonFamily: donFamily},
				{Owner: owner, Status: workflowStatusActive, DonFamily: donFamily},
			},
		}
		nameLookup := fakeUserDonLimitClient{}

		err := checkUserDonLimitBeforeDeploy(client, nameLookup, owner, donFamily, workflowName, true, nil)
		require.Error(t, err)
		assert.Contains(t, err.Error(), "workflow limit reached")
	})

	t.Run("accounts for keepAlive false pausing same-name workflows", func(t *testing.T) {
		client := fakeUserDonLimitClient{
			maxAllowed: 2,
			workflowsByOwner: []workflow_registry_v2_wrapper.WorkflowRegistryWorkflowMetadataView{
				{Owner: owner, Status: workflowStatusActive, DonFamily: donFamily},
				{Owner: owner, Status: workflowStatusActive, DonFamily: donFamily},
			},
		}
		nameLookup := fakeUserDonLimitClient{
			workflowsByOwnerName: []workflow_registry_v2_wrapper.WorkflowRegistryWorkflowMetadataView{
				{Owner: owner, Status: workflowStatusActive, DonFamily: donFamily},
			},
		}

		err := checkUserDonLimitBeforeDeploy(client, nameLookup, owner, donFamily, workflowName, false, nil)
		require.NoError(t, err)
	})

	t.Run("skips check when updating existing workflow", func(t *testing.T) {
		client := fakeUserDonLimitClient{
			maxAllowed: 1,
			workflowsByOwner: []workflow_registry_v2_wrapper.WorkflowRegistryWorkflowMetadataView{
				{Owner: owner, Status: workflowStatusActive, DonFamily: donFamily},
			},
		}
		nameLookup := fakeUserDonLimitClient{}
		existingStatus := uint8(0)

		err := checkUserDonLimitBeforeDeploy(client, nameLookup, owner, donFamily, workflowName, true, &existingStatus)
		require.NoError(t, err)
	})
}