all product-agnostic boilerplate

Author: skudasov

book/src/SUMMARY.md

@@ -4,15 +4,11 @@
 - [Framework](./framework/overview.md)
 - [Basic Usage](./framework/getting_started.md)
   - [Getting Started](./framework/getting_started.md)
-  - [Your First Test](./framework/first_test.md)
-  - [NodeSet Environment](./framework/nodeset_environment.md)
-  - [NodeSet (Capabilities)](./framework/nodeset_capabilities.md)
-  - [NodeSet (Local Docker builds)](./framework/nodeset_docker_rebuild.md)
+  - [Generating Developer Environment](./framework/generate.md)
 - [Advanced Usage](./framework/configuration.md)
   - [CLI](./framework/cli.md)
   - [Configuration](./framework/configuration.md)
   - [Debugging Tests](framework/components/debug.md)
-  - [Generating Tests](framework/generate.md)
   - [Creating your own components](./developing/developing_components.md)
   - [Exposing Components](framework/components/state.md)
   - [Asserting Logs](./developing/asserting_logs.md)

book/src/framework/generate.md

@@ -1,7 +1,21 @@
-# Generating Tests
+# Generating Chainlink Environment
 
-Some types of tests may require a lot of boilerplate and configurability, for example load and chaos tests.
+Our code generation tools automatically build complete Chainlink environments and test templates, which minimizes documentation and provides a framework that is both structured and easily extensible.
 
-We provide code generation tool that help you to start with best practes in such cases.
+Let's read `help` first and then build an environment for a single EVM network:
+```bash
+ctf gen -h
+# generate a new Chainlink environment in "devenv" directory with 4 Chainlink nodes and one EVM network. Generate CLI called "pcli" and enter the shell
+ctf gen env --cli pcli --product-name MyProduct --output-dir devenv --nodes 4
+```
 
-All generators have `-h` or `--help` flag, please read the docs!
+Follow further instructions in `devenv/README.md`
+
+# Generating Infrastructure Testing Template
+
+If you have Chainlink infrastructure already deployed it's useful to generate a workload + chaos suite template.
+```bash
+ctf gen load -h
+# generate test suite named ChaosGen, with workload + default chaos experiments (fail + latency) for all the pods that have app.kubernetes.io/instance annotation
+ctf gen load -w -n ChaosGen default
+```

framework/cmd/main.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"os/exec"
 	"path/filepath"
 	"strings"
 
@@ -32,25 +33,16 @@ func main() {
 						Description: `🔗 Chainlink's Developer Environment Generator 🔗
 
 Prerequisites:
-	We are using Just, please install it first -  https://github.com/casey/just
+	We are using Just, please install it first - https://github.com/casey/just
 
 Usage:
 
 	⚙️ Generate basic environment:
-		ctf gen env --cli myenv --product-name Knilniahc --nodes 4
+		ctf gen env --cli myenv --output-dir devenv --product-name Knilniahc --nodes 4
+	
+	📜 Read the docs in devenv/README.md
 
-	🔧 Address all TODO comments and customize it if needed
-
-	💻 Enter the shell and spin up the environment:
-		cd devenv && just cli && myenv sh
-		
-	🔍 Implement system-level smoke tests (tests/smoke_test.go) and run them:
-		myenv test smoke
-		
-	📈 Implement load/chaos tests (tests/load_test.go) and run them:
-		myenv test load
-		
-	🔄 Enforce quality standards in CI: copy .github/workflows to your CI folder and commit
+	🔧 Address all TODO comments and customize it
 `,
 						ArgsUsage: "",
 						Flags: []cli.Flag{
@@ -59,6 +51,12 @@ Usage:
 								Aliases: []string{"c"},
 								Usage:   "Your devenv CLI binary name",
 							},
+							&cli.StringFlag{
+								Name:    "output-dir",
+								Aliases: []string{"o"},
+								Value:   "devenv",
+								Usage:   "Your devenv directory",
+							},
 							&cli.StringFlag{
 								Name:    "product-name",
 								Aliases: []string{"r"},
@@ -78,6 +76,7 @@ Usage:
 							},
 						},
 						Action: func(c *cli.Context) error {
+							outputDir := c.String("output-dir")
 							productConfType := c.String("product-configuration-type")
 							nodes := c.Int("nodes")
 							cliName := c.String("cli")
@@ -89,18 +88,47 @@ Usage:
 								return fmt.Errorf("Product name must be specified, call your product somehow, any name")
 							}
 							framework.L.Info().
+								Str("OutputDir", outputDir).
 								Str("Name", cliName).
 								Int("CLNodes", nodes).
 								Str("ProductConfigurationType", productConfType).
 								Msg("Generating developer environment")
 
-							cg, err := framework.NewEnvBuilder(cliName, nodes, productConfType, productName).Build()
+							cg, err := framework.NewEnvBuilder(cliName, nodes, productConfType, productName).
+								OutputDir(outputDir).
+								Build()
 							if err != nil {
 								return fmt.Errorf("failed to create codegen: %w", err)
 							}
 							if err := cg.Write(); err != nil {
 								return fmt.Errorf("failed to generate module: %w", err)
 							}
+							
+							fmt.Println()
+							fmt.Printf("📁 Your environment directory is: %s\n", outputDir)
+							fmt.Printf("💻 Your CLI name is: %s\n", cliName)
+							fmt.Printf("📜 More docs can be found in %s/README.md\n", outputDir)
+							fmt.Println()
+							
+							cmd := exec.Command("just", "cli")
+							cmd.Env = os.Environ()
+							cmd.Dir = outputDir
+							out, err := cmd.CombinedOutput()
+							if err != nil {
+								return fmt.Errorf("failed to build CLI via Justfile: %w, output: %s", err, string(out))
+							}
+							if err := os.Chdir(outputDir); err != nil {
+								return err
+							}
+							cmd = exec.Command(cliName, "sh")
+							cmd.Env = os.Environ()
+							cmd.Stdin = os.Stdin
+							cmd.Stdout = os.Stdout
+							cmd.Stderr = os.Stderr
+							err = cmd.Run()
+							if err != nil {
+								return fmt.Errorf("failed to enter devenv shell: %w", err)
+							}
 							return nil
 						},
 					},