renamed generator functions

colonyos · Aug 24, 2022 · 342029a · 342029a
1 parent 8aeb47d
commit 342029a
Show file tree

Hide file tree

Showing 13 changed files with 80 additions and 79 deletions.
diff --git a/bin/colonies b/bin/colonies
diff --git a/docs/Generators.md b/docs/Generators.md
@@ -37,14 +37,14 @@ colonies worker start --name generator_worker --runtimetype cli --timeout 100 -v
 
 ## Send data to the Generator 
 ```console
-colonies generator pack --generatorid f3a433d0a428ddd21fba2b82659db40dfc4e70771a29e2a19743ad80033749d7 --data hello1
-colonies generator pack --generatorid f3a433d0a428ddd21fba2b82659db40dfc4e70771a29e2a19743ad80033749d7 --data hello2
-colonies generator pack --generatorid f3a433d0a428ddd21fba2b82659db40dfc4e70771a29e2a19743ad80033749d7 --data hello3
-colonies generator pack --generatorid f3a433d0a428ddd21fba2b82659db40dfc4e70771a29e2a19743ad80033749d7 --data hello4
-colonies generator pack --generatorid f3a433d0a428ddd21fba2b82659db40dfc4e70771a29e2a19743ad80033749d7 --data hello5
+colonies generator pack --generatorid f3a433d0a428ddd21fba2b82659db40dfc4e70771a29e2a19743ad80033749d7 --arg hello1
+colonies generator pack --generatorid f3a433d0a428ddd21fba2b82659db40dfc4e70771a29e2a19743ad80033749d7 --arg hello2
+colonies generator pack --generatorid f3a433d0a428ddd21fba2b82659db40dfc4e70771a29e2a19743ad80033749d7 --arg hello3
+colonies generator pack --generatorid f3a433d0a428ddd21fba2b82659db40dfc4e70771a29e2a19743ad80033749d7 --arg hello4
+colonies generator pack --generatorid f3a433d0a428ddd21fba2b82659db40dfc4e70771a29e2a19743ad80033749d7 --arg hello5
 ```
 
-Notice that a workflow is spawn after the last pack call. In the worker terminal we can see:
+Notice that a workflow is spawn after the last pack call, as number of pack calls > trigger. In the worker terminal we can see:
 
 ```console
 INFO[0312] Worker was assigned a process                 ProcessID=3806424831e78001fd7157a387ca9ab414ef908f0649eeed7e9fee691438db01

diff --git a/internal/cli/generator.go b/internal/cli/generator.go
@@ -41,8 +41,8 @@ func init() {
 	packGeneratorCmd.Flags().StringVarP(&RuntimePrvKey, "runtimeprvkey", "", "", "Runtime private key")
 	packGeneratorCmd.Flags().StringVarP(&GeneratorID, "generatorid", "", "", "Generator Id")
 	packGeneratorCmd.MarkFlagRequired("generatorid")
-	packGeneratorCmd.Flags().StringVarP(&Data, "data", "", "", "Data to add/pack generator with")
-	packGeneratorCmd.MarkFlagRequired("data")
+	packGeneratorCmd.Flags().StringVarP(&Arg, "arg", "", "", "Arg to pack to generator")
+	packGeneratorCmd.MarkFlagRequired("arg")
 
 	delGeneratorCmd.Flags().StringVarP(&RuntimeID, "runtimeid", "", "", "Runtime Id")
 	delGeneratorCmd.Flags().StringVarP(&RuntimePrvKey, "runtimeprvkey", "", "", "Runtime private key")
@@ -144,8 +144,8 @@ var addGeneratorCmd = &cobra.Command{
 
 var packGeneratorCmd = &cobra.Command{
 	Use:   "pack",
-	Short: "Add data to a generator",
-	Long:  "Add data to a generator",
+	Short: "Pack arg to a generator",
+	Long:  "Pack arg to a generator",
 	Run: func(cmd *cobra.Command, args []string) {
 		parseServerEnv()
 
@@ -171,9 +171,10 @@ var packGeneratorCmd = &cobra.Command{
 			CheckError(errors.New("Generator Id not specified"))
 		}
 
-		err = client.AddArgToGenerator(GeneratorID, Data, RuntimePrvKey)
+		err = client.PackGenerator(GeneratorID, Arg, RuntimePrvKey)
+		CheckError(err)
 
-		log.WithFields(log.Fields{"GeneratorID": GeneratorID, "Data": Data}).Info("Packing generator with data")
+		log.WithFields(log.Fields{"GeneratorID": GeneratorID, "Arg": Arg}).Info("Packing arg to generator")
 	},
 }
 

diff --git a/internal/cli/root.go b/internal/cli/root.go
@@ -69,7 +69,7 @@ var GeneratorName string
 var GeneratorTrigger int
 var GeneratorTimeout int
 var Func string
-var Data string
+var Arg string
 var Args []string
 var Env []string
 var MaxWaitTime int

diff --git a/pkg/client/colonies_client.go b/pkg/client/colonies_client.go
@@ -762,14 +762,14 @@ func (client *ColoniesClient) GetGenerators(colonyID string, count int, prvKey s
 	return core.ConvertJSONToGeneratorArray(respBodyString)
 }
 
-func (client *ColoniesClient) AddArgToGenerator(generatorID string, arg string, prvKey string) error {
-	msg := rpc.CreateAddArgGeneratorMsg(generatorID, arg)
+func (client *ColoniesClient) PackGenerator(generatorID string, arg string, prvKey string) error {
+	msg := rpc.CreatePackGeneratorMsg(generatorID, arg)
 	jsonString, err := msg.ToJSON()
 	if err != nil {
 		return err
 	}
 
-	_, err = client.sendMessage(rpc.AddArgGeneratorPayloadType, jsonString, prvKey, false)
+	_, err = client.sendMessage(rpc.PackGeneratorPayloadType, jsonString, prvKey, false)
 	if err != nil {
 		return err
 	}

diff --git a/pkg/rpc/add_arg_generator_msg_test.go b/pkg/rpc/add_arg_generator_msg_test.go
diff --git a/pkg/rpc/add_arg_generator_msg.go → pkg/rpc/pack_generator.go b/pkg/rpc/add_arg_generator_msg.go → pkg/rpc/pack_generator.go
@@ -4,24 +4,24 @@ import (
 	"encoding/json"
 )
 
-const AddArgGeneratorPayloadType = "addarggeneratormsg"
+const PackGeneratorPayloadType = "packgeneratormsg"
 
-type AddArgGeneratorMsg struct {
+type PackGeneratorMsg struct {
 	GeneratorID string `json:"generatorid"`
 	Arg         string `json:"arg"`
 	MsgType     string `json:"msgtype"`
 }
 
-func CreateAddArgGeneratorMsg(generatorID string, arg string) *AddArgGeneratorMsg {
-	msg := &AddArgGeneratorMsg{}
+func CreatePackGeneratorMsg(generatorID string, arg string) *PackGeneratorMsg {
+	msg := &PackGeneratorMsg{}
 	msg.GeneratorID = generatorID
 	msg.Arg = arg
-	msg.MsgType = AddArgGeneratorPayloadType
+	msg.MsgType = PackGeneratorPayloadType
 
 	return msg
 }
 
-func (msg *AddArgGeneratorMsg) ToJSON() (string, error) {
+func (msg *PackGeneratorMsg) ToJSON() (string, error) {
 	jsonBytes, err := json.Marshal(msg)
 	if err != nil {
 		return "", err
@@ -30,7 +30,7 @@ func (msg *AddArgGeneratorMsg) ToJSON() (string, error) {
 	return string(jsonBytes), nil
 }
 
-func (msg *AddArgGeneratorMsg) ToJSONIndent() (string, error) {
+func (msg *PackGeneratorMsg) ToJSONIndent() (string, error) {
 	jsonBytes, err := json.MarshalIndent(msg, "", "    ")
 	if err != nil {
 		return "", err
@@ -39,7 +39,7 @@ func (msg *AddArgGeneratorMsg) ToJSONIndent() (string, error) {
 	return string(jsonBytes), nil
 }
 
-func (msg *AddArgGeneratorMsg) Equals(msg2 *AddArgGeneratorMsg) bool {
+func (msg *PackGeneratorMsg) Equals(msg2 *PackGeneratorMsg) bool {
 	if msg2 == nil {
 		return false
 	}
@@ -51,8 +51,8 @@ func (msg *AddArgGeneratorMsg) Equals(msg2 *AddArgGeneratorMsg) bool {
 	return false
 }
 
-func CreateAddArgGeneratorMsgFromJSON(jsonString string) (*AddArgGeneratorMsg, error) {
-	var msg *AddArgGeneratorMsg
+func CreatePackGeneratorMsgFromJSON(jsonString string) (*PackGeneratorMsg, error) {
+	var msg *PackGeneratorMsg
 
 	err := json.Unmarshal([]byte(jsonString), &msg)
 	if err != nil {

diff --git a/pkg/rpc/pack_generator_test.go b/pkg/rpc/pack_generator_test.go
@@ -0,0 +1,42 @@
+package rpc
+
+import (
+	"testing"
+
+	"github.com/colonyos/colonies/pkg/core"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestRPCPackGeneratorMsg(t *testing.T) {
+	msg := CreatePackGeneratorMsg(core.GenerateRandomID(), "arg")
+	jsonString, err := msg.ToJSON()
+	assert.Nil(t, err)
+
+	msg2, err := CreatePackGeneratorMsgFromJSON(jsonString + "error")
+	assert.NotNil(t, err)
+
+	msg2, err = CreatePackGeneratorMsgFromJSON(jsonString)
+	assert.Nil(t, err)
+
+	assert.True(t, msg.Equals(msg2))
+}
+
+func TestRPCPackGeneratorMsgIndent(t *testing.T) {
+	msg := CreatePackGeneratorMsg(core.GenerateRandomID(), "arg")
+	jsonString, err := msg.ToJSONIndent()
+	assert.Nil(t, err)
+
+	msg2, err := CreatePackGeneratorMsgFromJSON(jsonString + "error")
+	assert.NotNil(t, err)
+
+	msg2, err = CreatePackGeneratorMsgFromJSON(jsonString)
+	assert.Nil(t, err)
+
+	assert.True(t, msg.Equals(msg2))
+}
+
+func TestRPCPackGeneratorMsgEquals(t *testing.T) {
+	msg := CreatePackGeneratorMsg(core.GenerateRandomID(), "arg")
+	assert.True(t, msg.Equals(msg))
+	assert.False(t, msg.Equals(nil))
+}
diff --git a/pkg/server/colonies_controller.go b/pkg/server/colonies_controller.go
@@ -282,7 +282,7 @@ func (controller *coloniesController) getGenerators(colonyID string, count int)
 	}
 }
 
-func (controller *coloniesController) addGeneratorArg(generatorID string, colonyID, arg string) error {
+func (controller *coloniesController) packGenerator(generatorID string, colonyID, arg string) error {
 	cmd := &command{errorChan: make(chan error, 1),
 		handler: func(cmd *command) {
 			generatorArg := core.CreateGeneratorArg(generatorID, colonyID, arg)

diff --git a/pkg/server/colonies_server.go b/pkg/server/colonies_server.go
@@ -187,8 +187,8 @@ func (server *ColoniesServer) handleAPIRequest(c *gin.Context) {
 		server.handleGetGeneratorHTTPRequest(c, recoveredID, rpcMsg.PayloadType, rpcMsg.DecodePayload())
 	case rpc.GetGeneratorsPayloadType:
 		server.handleGetGeneratorsHTTPRequest(c, recoveredID, rpcMsg.PayloadType, rpcMsg.DecodePayload())
-	case rpc.AddArgGeneratorPayloadType:
-		server.handleAddArgGeneratorHTTPRequest(c, recoveredID, rpcMsg.PayloadType, rpcMsg.DecodePayload())
+	case rpc.PackGeneratorPayloadType:
+		server.handlePackGeneratorHTTPRequest(c, recoveredID, rpcMsg.PayloadType, rpcMsg.DecodePayload())
 	case rpc.DeleteGeneratorPayloadType:
 		server.handleDeleteGeneratorHTTPRequest(c, recoveredID, rpcMsg.PayloadType, rpcMsg.DecodePayload())
 

diff --git a/pkg/server/generator_handlers.go b/pkg/server/generator_handlers.go
@@ -132,8 +132,8 @@ func (server *ColoniesServer) handleGetGeneratorsHTTPRequest(c *gin.Context, rec
 	server.sendHTTPReply(c, payloadType, jsonString)
 }
 
-func (server *ColoniesServer) handleAddArgGeneratorHTTPRequest(c *gin.Context, recoveredID string, payloadType string, jsonString string) {
-	msg, err := rpc.CreateAddArgGeneratorMsgFromJSON(jsonString)
+func (server *ColoniesServer) handlePackGeneratorHTTPRequest(c *gin.Context, recoveredID string, payloadType string, jsonString string) {
+	msg, err := rpc.CreatePackGeneratorMsgFromJSON(jsonString)
 	if err != nil {
 		if server.handleHTTPError(c, errors.New("Failed to inc generator, invalid JSON"), http.StatusBadRequest) {
 			return
@@ -159,7 +159,7 @@ func (server *ColoniesServer) handleAddArgGeneratorHTTPRequest(c *gin.Context, r
 		return
 	}
 
-	err = server.controller.addGeneratorArg(generator.ID, generator.ColonyID, msg.Arg)
+	err = server.controller.packGenerator(generator.ID, generator.ColonyID, msg.Arg)
 	if server.handleHTTPError(c, err, http.StatusInternalServerError) {
 		return
 	}

diff --git a/pkg/server/generator_handlers_security_test.go b/pkg/server/generator_handlers_security_test.go
@@ -94,13 +94,13 @@ func TestAddArgGeneratorSecurity(t *testing.T) {
 	addedGenerator, err := client.AddGenerator(generator, env.runtime1PrvKey)
 	assert.Nil(t, err)
 
-	err = client.AddArgToGenerator(addedGenerator.ID, "arg", env.runtime2PrvKey)
+	err = client.PackGenerator(addedGenerator.ID, "arg", env.runtime2PrvKey)
 	assert.NotNil(t, err)
-	err = client.AddArgToGenerator(addedGenerator.ID, "arg", env.colony1PrvKey)
+	err = client.PackGenerator(addedGenerator.ID, "arg", env.colony1PrvKey)
 	assert.NotNil(t, err)
-	err = client.AddArgToGenerator(addedGenerator.ID, "arg", env.colony2PrvKey)
+	err = client.PackGenerator(addedGenerator.ID, "arg", env.colony2PrvKey)
 	assert.NotNil(t, err)
-	err = client.AddArgToGenerator(addedGenerator.ID, "arg", env.runtime1PrvKey)
+	err = client.PackGenerator(addedGenerator.ID, "arg", env.runtime1PrvKey)
 	assert.Nil(t, err)
 
 	server.Shutdown()

diff --git a/pkg/server/generator_handlers_test.go b/pkg/server/generator_handlers_test.go
@@ -23,7 +23,7 @@ func TestAddGeneratorCounter(t *testing.T) {
 	doneInc := make(chan bool)
 	go func() {
 		for i := 0; i < 73; i++ {
-			err = client.AddArgToGenerator(addedGenerator.ID, "arg"+strconv.Itoa(i), env.runtimePrvKey)
+			err = client.PackGenerator(addedGenerator.ID, "arg"+strconv.Itoa(i), env.runtimePrvKey)
 			assert.Nil(t, err)
 		}
 		doneInc <- true