Use templates

Signed-off-by: Ender Demirkaya <[email protected]>

Author: demirkayaender

new_samples/hello_world_generated/README.md

@@ -0,0 +1,98 @@
+# Cadence Samples
+
+These are some samples to demonstrate various capabilities of Cadence client and server.  You can learn more about cadence at:
+
+* The website: https://cadenceworkflow.io
+* Cadence's server: https://github.com/uber/cadence
+* Cadence's Go client: https://github.com/uber-go/cadence-client
+
+## Prerequisite
+
+0. Install Cadence CLI. See instruction [here](https://cadenceworkflow.io/docs/cli/).
+1. Run the Cadence server:
+    1. Clone the [Cadence](https://github.com/cadence-workflow/cadence) repository if you haven't done already: `git clone https://github.com/cadence-workflow/cadence.git`
+    2. Run `docker compose -f docker/docker-compose.yml up` to start Cadence server
+    3. See more details at https://github.com/uber/cadence/blob/master/README.md
+2. Once everything is up and running in Docker, open [localhost:8088](localhost:8088) to view Cadence UI.
+3. Register the `cadence-samples` domain:
+
+```bash
+cadence --env development --domain cadence-samples domain register
+```
+
+Refresh the [domains page](http://localhost:8088/domains) from step 2 to verify `cadence-samples` is registered.
+
+## Steps to run sample
+
+Inside the folder this sample is defined, run the following command:
+
+```bash
+go run .
+```
+
+This will call the main function in main.go which starts the worker, which will be execute the sample workflow code
+
+### Start your workflow
+
+This workflow takes an input message and greet you as response. Try the following CLI
+
+```bash
+cadence --env development \
+  --domain cadence-samples \
+  workflow start \
+  --workflow_type cadence_samples.HelloWorldWorkflow \
+  --tl cadence-samples-worker \
+  --et 60 \
+  --input '{"message":"Cadence"}'
+```
+
+Here are the details to this command:
+
+* `--domain` option describes under which domain to run this workflow
+* `--env development` calls the "local" cadence server
+* `--workflow_type` option describes which workflow to execute
+* `-tl` (or `--tasklist`) tells cadence-server which tasklist to schedule tasks with. This is the same tasklist the worker polls tasks from. See worker.go
+* `--et` (or `--execution_timeout`) tells cadence server how long to wait until timing out the workflow
+* `--input` is the input to your workflow
+
+To see more options run `cadence --help`
+
+### View your workflow
+
+#### Cadence UI (cadence-web)
+
+Click on `cadence-samples` domain in cadence-web to view your workflow.
+
+* In Summary tab, you will see the input and output to your workflow
+* Click on History tab to see individual steps.
+
+#### CLI
+
+List workflows using the following command:
+
+```bash
+ cadence --env development --domain cadence-samples --workflow list
+```
+
+You can view an individual workflow by using the following command:
+
+```bash
+cadence --env development \
+  --domain cadence-samples \
+  --workflow describe \
+ --wid <workflow_id>
+```
+
+* `workflow` is the noun to run commands within workflow scope
+* `describe` is the verb to return the summary of the workflow
+* `--wid` (or `--workflow_id`) is the option to pass the workflow id. If there are multiple "run"s, it will return the latest one.
+* (optional) `--rid` (or `--run_id`) is the option to pass the run id to describe a specific run, instead of the latest.
+
+To view the entire history of the workflow, use the following command:
+
+```bash
+cadence --env development \
+  --domain cadence-samples \
+  --workflow show \
+ --wid <workflow_id>
+```

new_samples/hello_world_generated/generator/README_specific.md

@@ -0,0 +1,64 @@
+### Start your workflow
+
+This workflow takes an input message and greet you as response. Try the following CLI
+
+```bash
+cadence --env development \
+  --domain cadence-samples \
+  workflow start \
+  --workflow_type cadence_samples.HelloWorldWorkflow \
+  --tl cadence-samples-worker \
+  --et 60 \
+  --input '{"message":"Cadence"}'
+```
+
+Here are the details to this command:
+
+* `--domain` option describes under which domain to run this workflow
+* `--env development` calls the "local" cadence server
+* `--workflow_type` option describes which workflow to execute
+* `-tl` (or `--tasklist`) tells cadence-server which tasklist to schedule tasks with. This is the same tasklist the worker polls tasks from. See worker.go
+* `--et` (or `--execution_timeout`) tells cadence server how long to wait until timing out the workflow
+* `--input` is the input to your workflow
+
+To see more options run `cadence --help`
+
+### View your workflow
+
+#### Cadence UI (cadence-web)
+
+Click on `cadence-samples` domain in cadence-web to view your workflow.
+
+* In Summary tab, you will see the input and output to your workflow
+* Click on History tab to see individual steps.
+
+#### CLI
+
+List workflows using the following command:
+
+```bash
+ cadence --env development --domain cadence-samples --workflow list
+```
+
+You can view an individual workflow by using the following command:
+
+```bash
+cadence --env development \
+  --domain cadence-samples \
+  --workflow describe \
+ --wid <workflow_id>
+```
+
+* `workflow` is the noun to run commands within workflow scope
+* `describe` is the verb to return the summary of the workflow
+* `--wid` (or `--workflow_id`) is the option to pass the workflow id. If there are multiple "run"s, it will return the latest one.
+* (optional) `--rid` (or `--run_id`) is the option to pass the run id to describe a specific run, instead of the latest.
+
+To view the entire history of the workflow, use the following command:
+
+```bash
+cadence --env development \
+  --domain cadence-samples \
+  --workflow show \
+ --wid <workflow_id>
+```

new_samples/hello_world_generated/generator/generate.go

@@ -0,0 +1,84 @@
+package main
+
+import (
+	"io"
+	"os"
+	"text/template"
+)
+
+type TemplateData struct {
+	Workflows  []string
+	Activities []string
+}
+
+func main() {
+	// Define the data for HelloWorld
+	data := TemplateData{
+		Workflows:  []string{"HelloWorldWorkflow"},
+		Activities: []string{"HelloWorldActivity"},
+	}
+
+	// Generate worker.go
+	generateFile("../../template/worker.tmpl", "../worker.go", data)
+	println("Generated worker.go")
+
+	// Generate main.go
+	generateFile("../../template/main.tmpl", "../main.go", data)
+	println("Generated main.go")
+
+	// Generate README.md (combine template + specific)
+	generateREADME("../../template/README.tmpl", "README_specific.md", "../README.md", data)
+	println("Generated README.md")
+}
+
+func generateFile(templatePath, outputPath string, data TemplateData) {
+	tmpl, err := template.ParseFiles(templatePath)
+	if err != nil {
+		panic("Failed to parse template " + templatePath + ": " + err.Error())
+	}
+
+	f, err := os.Create(outputPath)
+	if err != nil {
+		panic("Failed to create output file " + outputPath + ": " + err.Error())
+	}
+	defer f.Close()
+
+	err = tmpl.Execute(f, data)
+	if err != nil {
+		panic("Failed to execute template: " + err.Error())
+	}
+}
+
+func generateREADME(templatePath, specificPath, outputPath string, data TemplateData) {
+	// Create output file
+	f, err := os.Create(outputPath)
+	if err != nil {
+		panic("Failed to create README file: " + err.Error())
+	}
+	defer f.Close()
+
+	// First, write the generic template part
+	tmpl, err := template.ParseFiles(templatePath)
+	if err != nil {
+		panic("Failed to parse README template: " + err.Error())
+	}
+
+	err = tmpl.Execute(f, data)
+	if err != nil {
+		panic("Failed to execute README template: " + err.Error())
+	}
+
+	// Then, append the specific content
+	specific, err := os.Open(specificPath)
+	if err != nil {
+		panic("Failed to open specific README content: " + err.Error())
+	}
+	defer specific.Close()
+
+	_, err = io.Copy(f, specific)
+	if err != nil {
+		panic("Failed to append specific README content: " + err.Error())
+	}
+}
+
+

new_samples/hello_world_generated/main.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"os/signal"
+	"syscall"
+)
+
+func main() {
+	StartWorker()
+
+	done := make(chan os.Signal, 1)
+	signal.Notify(done, syscall.SIGINT)
+	fmt.Println("Cadence worker started, press ctrl+c to terminate...")
+	<-done
+}

new_samples/hello_world_generated/worker.go

@@ -0,0 +1,98 @@
+// Package worker implements a Cadence worker with basic configurations.
+package main
+
+import (
+	"github.com/uber-go/tally"
+	apiv1 "github.com/uber/cadence-idl/go/proto/api/v1"
+	"go.uber.org/cadence/.gen/go/cadence/workflowserviceclient"
+	"go.uber.org/cadence/activity"
+	"go.uber.org/cadence/compatibility"
+	"go.uber.org/cadence/worker"
+	"go.uber.org/cadence/workflow"
+	"go.uber.org/yarpc"
+	"go.uber.org/yarpc/peer"
+	yarpchostport "go.uber.org/yarpc/peer/hostport"
+	"go.uber.org/yarpc/transport/grpc"
+	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
+)
+
+const (
+	HostPort = "127.0.0.1:7833"
+	Domain   = "cadence-samples"
+	// TaskListName identifies set of client workflows, activities, and workers.
+	// It could be your group or client or application name.
+	TaskListName   = "cadence-samples-worker"
+	ClientName     = "cadence-samples-worker"
+	CadenceService = "cadence-frontend"
+)
+
+// StartWorker creates and starts a basic Cadence worker.
+func StartWorker() {
+	logger, cadenceClient := BuildLogger(), BuildCadenceClient()
+	workerOptions := worker.Options{
+		Logger:       logger,
+		MetricsScope: tally.NewTestScope(TaskListName, nil),
+	}
+
+	w := worker.New(
+		cadenceClient,
+		Domain,
+		TaskListName,
+		workerOptions)
+	// HelloWorld workflow registration
+	w.RegisterWorkflowWithOptions(HelloWorldWorkflow, workflow.RegisterOptions{Name: "cadence_samples.HelloWorldWorkflow"})
+	w.RegisterActivityWithOptions(HelloWorldActivity, activity.RegisterOptions{Name: "cadence_samples.HelloWorldActivity"})
+
+	err := w.Start()
+	if err != nil {
+		panic("Failed to start worker: " + err.Error())
+	}
+	logger.Info("Started Worker.", zap.String("worker", TaskListName))
+
+}
+
+func BuildCadenceClient(dialOptions ...grpc.DialOption) workflowserviceclient.Interface {
+	grpcTransport := grpc.NewTransport()
+	// Create a single peer chooser that identifies the host/port and configures
+	// a gRPC dialer with TLS credentials
+	myChooser := peer.NewSingle(
+		yarpchostport.Identify(HostPort),
+		grpcTransport.NewDialer(dialOptions...),
+	)
+	outbound := grpcTransport.NewOutbound(myChooser)
+
+	dispatcher := yarpc.NewDispatcher(yarpc.Config{
+		Name: ClientName,
+		Outbounds: yarpc.Outbounds{
+			CadenceService: {Unary: outbound},
+		},
+	})
+	if err := dispatcher.Start(); err != nil {
+		panic("Failed to start dispatcher: " + err.Error())
+	}
+
+	clientConfig := dispatcher.ClientConfig(CadenceService)
+
+	// Create a compatibility adapter that wraps proto-based YARPC clients
+	// to provide a unified interface for domain, workflow, worker, and visibility APIs
+	return compatibility.NewThrift2ProtoAdapter(
+		apiv1.NewDomainAPIYARPCClient(clientConfig),
+		apiv1.NewWorkflowAPIYARPCClient(clientConfig),
+		apiv1.NewWorkerAPIYARPCClient(clientConfig),
+		apiv1.NewVisibilityAPIYARPCClient(clientConfig),
+	)
+}
+
+func BuildLogger() *zap.Logger {
+	config := zap.NewDevelopmentConfig()
+	config.Level.SetLevel(zapcore.InfoLevel)
+
+	var err error
+	logger, err := config.Build()
+	if err != nil {
+		panic("Failed to setup logger: " + err.Error())
+	}
+
+	return logger
+}