Add GET endpoint to Sprinkler workflows (#42)

Add GET endpoint to Sprinkler workflows. To facilitate support use cases
with the GET response payload to be edited for new PUT requests.

Fix typos in service/control.go and README.md

README.md

@@ -33,14 +33,14 @@ Start control service on a new tab, to later post a Sprinkler json workflow
 go run . service control --config .sprinkler.yaml 
 ```
 
-Post to `http://localhost:8080/v1/workflow` a Sprinkler workflow, example payload from [ExampleWorkflow.scala](https://github.com/salesforce/spade/blob/main/spade-examples/src/main/scala/com/salesforce/mce/spade/examples/ExampleWorkflow.scala)
+Put to `http://localhost:8080/v1/workflow` a Sprinkler workflow, example payload from [ExampleWorkflow.scala](https://github.com/salesforce/spade/blob/main/spade-examples/src/main/scala/com/salesforce/mce/spade/examples/ExampleWorkflow.scala)
 ```
 {
     "name": "test-workflow",
     "artifact": "s3://sprinkler-salesforce-bucket/jars/test/spade-example.jar",
     "command":  "[\"java\", \"-cp\", \"spade-example.jar\", \"com.salesforce.mce.spade.examples.ExampleWorkflow\", \"generate\", \"--compact\"]",
     "every": "60.minute",
-    "nextRuntime": "2023-03-22T21:00:00Z",
+    "nextRuntime": "2024-08-22T21:00:00Z",
     "backfill": false,
     "owner": "arn:aws:sns:us-east-2:444455556666:MyTopic",
     "isActive": true

cmd/root.go

@@ -18,10 +18,10 @@ var cfgFile string
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
 	Use:   "sprinkler",
-	Short: "Workflow scheculer built for orchard",
+	Short: "Workflow scheduler built for orchard",
 	Long: `Sprinkler CLI provides all the necessary commands to setup the database, test
 orchard servers and other services to run and manage workflows for orchard
-orchastration server`,
+orchestration server`,
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.

service/control.go

@@ -109,6 +109,31 @@ func (ctrl *Control) deleteWorkflow(c *gin.Context) {
 	}
 }
 
+func (ctrl *Control) getWorkflow(c *gin.Context) {
+	name := c.Param("name")
+	var workflow table.Workflow
+	dbRes := ctrl.db.Model(&table.Workflow{}).
+		Where("name = ?", name).
+		Find(&workflow)
+
+	if dbRes.Error != nil || dbRes.RowsAffected == 0 {
+		c.JSON(http.StatusNotFound, gin.H{"Workflow not found:": fmt.Sprintf("name=%s", name)})
+	} else {
+		resp := postWorkflowReq{
+			Name: workflow.Name, 
+			Artifact: workflow.Artifact, 
+			Command: workflow.Command, 
+			Every: workflow.Every.String(), 
+			NextRuntime: workflow.NextRuntime,
+			Backfill: workflow.Backfill, 
+			Owner: workflow.Owner, 
+			IsActive: workflow.IsActive, 
+			ScheduleDelayMinutes: workflow.ScheduleDelayMinutes}
+
+		c.IndentedJSON(http.StatusOK, resp)
+	}
+}
+
 func APIKeyAuth(key string) gin.HandlerFunc {
 	return func(c *gin.Context) {
 		k := c.GetHeader("x-api-key")
@@ -133,6 +158,7 @@ func (ctrl *Control) Run() {
 	{
 		v1.PUT("/workflow", ctrl.putWorkflow)
 		v1.DELETE("/workflow", ctrl.deleteWorkflow)
+		v1.GET("/workflow/:name", ctrl.getWorkflow)
 	}
 
 	r.GET("__status", func(c *gin.Context) {