add proposal loader utils (#251)

smartcontractkit · Jan 27, 2025 · a7fddd4 · a7fddd4
1 parent a11a0ee
commit a7fddd4
Show file tree

Hide file tree

Showing 4 changed files with 156 additions and 49 deletions.
diff --git a/proposal.go b/proposal.go
@@ -2,9 +2,11 @@ package mcms
 
 import (
 	"encoding/json"
+	"errors"
 	"fmt"
 	"io"
 	"maps"
+	"os"
 	"slices"
 	"strings"
 	"time"
@@ -22,6 +24,40 @@ import (
 
 const SignMsgABI = `[{"type":"bytes32"},{"type":"uint32"}]`
 
+type ProposalInterface interface {
+	AppendSignature(signature types.Signature)
+	Validate() error
+}
+
+func LoadProposal(proposalType types.ProposalKind, filePath string) (ProposalInterface, error) {
+	switch proposalType {
+	case types.KindProposal:
+		// Open the file
+		file, err := os.Open(filePath)
+		if err != nil {
+			return nil, err
+		}
+
+		// Ensure the file is closed when done
+		defer file.Close()
+
+		return NewProposal(file)
+	case types.KindTimelockProposal:
+		// Open the file
+		file, err := os.Open(filePath)
+		if err != nil {
+			return nil, err
+		}
+
+		// Ensure the file is closed when done
+		defer file.Close()
+
+		return NewTimelockProposal(file)
+	default:
+		return nil, errors.New("unknown proposal type")
+	}
+}
+
 // BaseProposal is the base struct for all MCMS proposals, contains shared fields for all proposal types.
 type BaseProposal struct {
 	Version              string                                      `json:"version" validate:"required,oneof=v1"`

diff --git a/proposal_test.go b/proposal_test.go
@@ -5,6 +5,7 @@ import (
 	"errors"
 	"io"
 	"math"
+	"os"
 	"strings"
 	"testing"
 
@@ -20,7 +21,25 @@ import (
 )
 
 var (
-	TestAddress = "0x1234567890abcdef"
+	TestAddress   = "0x1234567890abcdef"
+	ValidProposal = `{
+		"version": "v1",
+		"kind": "Proposal",
+		"validUntil": 2004259681,
+		"chainMetadata": {
+			"3379446385462418246": {}
+		},
+		"operations": [
+			{
+				"chainSelector": 3379446385462418246,
+				"transaction": {
+					"to": "0xsomeaddress",
+					"data": "EjM=",
+					"additionalFields": {"value": 0}
+				}
+			}
+		]
+	}`
 )
 
 func Test_BaseProposal_AppendSignature(t *testing.T) {
@@ -48,24 +67,7 @@ func Test_NewProposal(t *testing.T) {
 	}{
 		{
 			name: "success: initializes a proposal from an io.Reader",
-			give: `{
-				"version": "v1",
-				"kind": "Proposal",
-				"validUntil": 2004259681,
-				"chainMetadata": {
-					"3379446385462418246": {}
-				},
-				"operations": [
-					{
-						"chainSelector": 3379446385462418246,
-						"transaction": {
-							"to": "0xsomeaddress",
-							"data": "EjM=",
-							"additionalFields": {"value": 0}
-						}
-					}
-				]
-			}`,
+			give: ValidProposal,
 			want: Proposal{
 				BaseProposal: BaseProposal{
 					Version:    "v1",
@@ -211,6 +213,67 @@ func Test_WriteProposal(t *testing.T) {
 	}
 }
 
+func TestLoadProposal(t *testing.T) {
+	t.Parallel()
+	t.Run("valid file path with KindProposal", func(t *testing.T) {
+		t.Parallel()
+
+		tempFile, err := os.CreateTemp("", "valid_proposal.txt")
+		require.NoError(t, err)
+
+		err = os.WriteFile(tempFile.Name(), []byte(ValidProposal), 0600)
+		require.NoError(t, err)
+		defer os.Remove(tempFile.Name())
+
+		proposal, err := LoadProposal(types.KindProposal, tempFile.Name())
+
+		require.NoError(t, err)
+		assert.NotNil(t, proposal)
+	})
+
+	t.Run("valid file path with KindTimelockProposal", func(t *testing.T) {
+		t.Parallel()
+
+		tempFile, err := os.CreateTemp("", "valid_timelock_proposal.txt")
+		require.NoError(t, err)
+
+		err = os.WriteFile(tempFile.Name(), []byte(ValidTimelockProposal), 0600)
+		require.NoError(t, err)
+		defer os.Remove(tempFile.Name())
+
+		proposal, err := LoadProposal(types.KindTimelockProposal, tempFile.Name())
+
+		require.NoError(t, err)
+		assert.NotNil(t, proposal)
+	})
+
+	t.Run("unknown proposal type", func(t *testing.T) {
+		t.Parallel()
+
+		filePath := "testdata/valid_proposal.txt"
+		err := os.WriteFile(filePath, []byte(ValidProposal), 0600)
+		require.Error(t, err)
+		defer os.Remove(filePath)
+
+		proposal, err := LoadProposal(types.ProposalKind("unknown"), filePath)
+
+		require.Error(t, err)
+		assert.Nil(t, proposal)
+		assert.Equal(t, "unknown proposal type", err.Error())
+	})
+
+	t.Run("invalid file path", func(t *testing.T) {
+		t.Parallel()
+
+		filePath := "invalid_path.txt"
+
+		proposal, err := LoadProposal(types.KindProposal, filePath)
+
+		require.Error(t, err)
+		assert.Nil(t, proposal)
+	})
+}
+
 func Test_Proposal_Validate(t *testing.T) {
 	t.Parallel()
 

diff --git a/timelock_proposal_test.go b/timelock_proposal_test.go
@@ -19,6 +19,37 @@ import (
 	"github.com/smartcontractkit/mcms/types"
 )
 
+var ValidTimelockProposal = `{
+	"version": "v1",
+	"kind": "TimelockProposal",
+	"validUntil": 2004259681,
+	"chainMetadata": {
+		"16015286601757825753": {
+			"mcmAddress": "0x0000000000000000000000000000000000000000",
+			"startingOpCount": 0
+		}
+	},
+	"description": "Test proposal",
+	"overridePreviousRoot": false,
+	"action": "schedule",
+	"delay": "1h",
+	"timelockAddresses": {
+		"16015286601757825753": "0x01"
+	},
+	"operations": [
+		{
+			"chainSelector": 16015286601757825753,
+			"transactions": [
+				{
+					"to": "0x0000000000000000000000000000000000000000",
+					"additionalFields": {"value": 0},
+					"data": "ZGF0YQ=="
+				}
+			]
+		}
+	]
+}`
+
 func Test_NewTimelockProposal(t *testing.T) {
 	t.Parallel()
 
@@ -30,36 +61,7 @@ func Test_NewTimelockProposal(t *testing.T) {
 	}{
 		{
 			name: "success: initializes a proposal from an io.Reader",
-			give: `{
-				"version": "v1",
-				"kind": "TimelockProposal",
-				"validUntil": 2004259681,
-				"chainMetadata": {
-					"16015286601757825753": {
-						"mcmAddress": "0x0000000000000000000000000000000000000000",
-						"startingOpCount": 0
-					}
-				},
-				"description": "Test proposal",
-				"overridePreviousRoot": false,
-				"action": "schedule",
-				"delay": "1h",
-				"timelockAddresses": {
-					"16015286601757825753": "0x01"
-				},
-				"operations": [
-					{
-						"chainSelector": 16015286601757825753,
-						"transactions": [
-							{
-								"to": "0x0000000000000000000000000000000000000000",
-								"additionalFields": {"value": 0},
-								"data": "ZGF0YQ=="
-							}
-						]
-					}
-				]
-			}`,
+			give: ValidTimelockProposal,
 			want: TimelockProposal{
 				BaseProposal: BaseProposal{
 					Version:     "v1",

diff --git a/types/proposal_kind.go b/types/proposal_kind.go
@@ -8,3 +8,9 @@ const (
 	// KindTimelockProposal is a proposal type for the MCMS contract with RBACTimelock.
 	KindTimelockProposal ProposalKind = "TimelockProposal"
 )
+
+// StringToProposalKind converts a string to a ProposalKind.
+var StringToProposalKind = map[string]ProposalKind{
+	"Proposal":         KindProposal,
+	"TimelockProposal": KindTimelockProposal,
+}