make caching simpler and allow to cache steps separately

Author: skudasov

framework/CACHING.md

@@ -8,7 +8,6 @@ You can use an environment variable to skip deployment steps and use cached outp
 
 ```
 export CTF_CONFIGS=smoke-cache.toml
-export CTF_USE_CACHED_OUTPUTS=true
 ```
 
 ### Using remote components
@@ -18,11 +17,13 @@ Because components are decoupled through outputs, you can use a cached config an
 Example:
 ```
 [blockchain_a.out]
+use_cache = true
 chain_id = '31337'
 
 [[blockchain_a.out.nodes]]
 ws_url = 'ws://127.0.0.1:33447'
 http_url = 'http://127.0.0.1:33447'
 docker_internal_ws_url = 'ws://anvil-3716a:8900'
 docker_internal_http_url = 'http://anvil-3716a:8900'
-```
+```
+Set flag `use_cache = true` on any component output and run your test again

framework/COMPONENTS.md

@@ -17,12 +17,13 @@ type Input struct {
 }
 
 type Output struct {
+    UseCache bool             `toml:"use_cache"`
     // outputs that will be dumped to config and cached
 }
 
 
 func NewComponent(input *Input) (*Output, error) {
-	if input.Out != nil && framework.UseCache() {
+	if input.Out.UseCache {
 		return input.Out, nil
 	}
 	
@@ -38,7 +39,7 @@ Each component can define inputs and outputs, following these rules:
 
 - Outputs should be included within inputs.
 - If your component is used for side effects output can be omitted.
-- `if input.Out != nil && framework.UseCache()` should be added if you'd like to use caching
+- `input.Out.UseCache` should be added if you'd like to use caching, see more [here](CACHING.md)
 
 ### Docker components good practices for [testcontainers-go](https://golang.testcontainers.org/):
 

framework/README.md

@@ -15,8 +15,8 @@ This module includes the CTFv2 harness, a lightweight, modular, and data-driven
 - **Component isolation**: Components are decoupled via input/output structs, without exposing internal details.
 - **Modular configuration**: No arcane knowledge of framework settings is required; the config is simply a reflection of the components being used in the test. Components declare their own configuration—'what you see is what you get.'
 - **Replaceability and extensibility**: Since components are decoupled via outputs, any deployment component can be swapped with a real service without altering the test code.
+- **Caching**: any component can use cached configs to skip environment setup for faster test development
 - **Integrated observability stack**: use `ctf obs up` to spin up a local observability stack.
-- **Connectivity**: seamless connection of production-ready components and local components using [testcontainers-go networking](https://golang.testcontainers.org/features/networking/#exposing-host-ports-to-the-container)."
 
 
 ### Environment variables (Tests, when using in Go code)
@@ -28,5 +28,4 @@ This module includes the CTFv2 harness, a lightweight, modular, and data-driven
 |           LOKI_URL           |                                            URL to `Loki` push api, should be like`${host}/loki/api/v1/push`                                            |                      URL |    -    | If you use `Loki` then ✅ |
 |        LOKI_TENANT_ID        |                                                Streams all components logs to `Loki`, see params below                                                 |          `true`, `false` |    -    | If you use `Loki` then ✅ |
 | TESTCONTAINERS_RYUK_DISABLED |                                   Testcontainers-Go reaper container, removes all the containers after the test exit                                   |          `true`, `false` | `false` |            🚫            |
-|    CTF_USE_CACHED_OUTPUTS    |                                                  Use cached `.out` fields from `*-cache.toml` config                                                   |          `true`, `false` | `false` |            🚫            |
 |         RESTY_DEBUG          |                                                            Log all Resty client HTTP calls                                                             |          `true`, `false` | `false` |            🚫            |

framework/components/blockchain/anvil.go

@@ -51,7 +51,8 @@ func deployAnvil(in *Input) (*Output, error) {
 		return nil, err
 	}
 	return &Output{
-		ChainID: in.ChainID,
+		UseCache: true,
+		ChainID:  in.ChainID,
 		Nodes: []*Node{
 			{
 				HostWSUrl:             fmt.Sprintf("ws://%s:%s", host, mp.Port()),

framework/components/blockchain/blockchain.go

@@ -2,7 +2,6 @@ package blockchain
 
 import (
 	"fmt"
-	"github.com/smartcontractkit/chainlink-testing-framework/framework"
 )
 
 // Input is a blockchain network configuration params
@@ -19,8 +18,9 @@ type Input struct {
 
 // Output is a blockchain network output, ChainID and one or more nodes that forms the network
 type Output struct {
-	ChainID string  `toml:"chain_id"`
-	Nodes   []*Node `toml:"nodes"`
+	UseCache bool    `toml:"use_cache"`
+	ChainID  string  `toml:"chain_id"`
+	Nodes    []*Node `toml:"nodes"`
 }
 
 // Node represents blockchain node output, URLs required for connection locally and inside docker network
@@ -34,21 +34,21 @@ type Node struct {
 // NewBlockchainNetwork this is an abstraction that can spin up various blockchain network simulators
 // - Anvil
 // - Geth
-func NewBlockchainNetwork(input *Input) (*Output, error) {
-	if input.Out != nil && framework.UseCache() {
-		return input.Out, nil
+func NewBlockchainNetwork(in *Input) (*Output, error) {
+	if in.Out.UseCache {
+		return in.Out, nil
 	}
 	var out *Output
 	var err error
-	switch input.Type {
+	switch in.Type {
 	case "anvil":
-		out, err = deployAnvil(input)
+		out, err = deployAnvil(in)
 		if err != nil {
 			return nil, err
 		}
 	default:
 		return nil, fmt.Errorf("blockchain type is not supported or empty")
 	}
-	input.Out = out
+	in.Out = out
 	return out, nil
 }

framework/components/clnode/clnode.go

@@ -36,6 +36,7 @@ type NodeInput struct {
 
 // Output represents Chainlink node output, nodes and databases connection URLs
 type Output struct {
+	UseCache   bool             `toml:"use_cache"`
 	Node       *NodeOut         `toml:"node"`
 	PostgreSQL *postgres.Output `toml:"postgresql"`
 }
@@ -49,7 +50,7 @@ type NodeOut struct {
 // NewNode create a new Chainlink node with some image:tag and one or several configs
 // see config params: TestConfigOverrides, UserConfigOverrides, etc
 func NewNode(in *Input) (*Output, error) {
-	if in.Out != nil && framework.UseCache() {
+	if in.Out != nil && in.Out.UseCache {
 		return in.Out, nil
 	}
 	pgOut, err := postgres.NewPostgreSQL(in.DbInput)
@@ -61,6 +62,7 @@ func NewNode(in *Input) (*Output, error) {
 		return nil, err
 	}
 	out := &Output{
+		UseCache:   true,
 		Node:       nodeOut,
 		PostgreSQL: pgOut,
 	}

framework/components/don/don.go

@@ -1,7 +1,6 @@
 package don
 
 import (
-	"github.com/smartcontractkit/chainlink-testing-framework/framework"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/blockchain"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/clnode"
 )
@@ -12,11 +11,12 @@ type Input struct {
 }
 
 type Output struct {
-	Nodes []*clnode.Output `toml:"node"`
+	UseCache bool             `toml:"use_cache"`
+	Nodes    []*clnode.Output `toml:"node"`
 }
 
 func NewBasicDON(in *Input, bcOut *blockchain.Output, fakeUrl string) (*Output, error) {
-	if in.Out != nil && framework.UseCache() {
+	if in.Out.UseCache {
 		return in.Out, nil
 	}
 	nodeOuts := make([]*clnode.Output, 0)
@@ -34,7 +34,8 @@ func NewBasicDON(in *Input, bcOut *blockchain.Output, fakeUrl string) (*Output,
 		nodeOuts = append(nodeOuts, o)
 	}
 	out := &Output{
-		Nodes: nodeOuts,
+		UseCache: true,
+		Nodes:    nodeOuts,
 	}
 	in.Out = out
 	return out, nil

framework/config.go

@@ -182,8 +182,9 @@ func noFieldsWithoutRequiredTag(cfg interface{}) []ValidationError {
 		}
 	}
 
-	// Combine missing "required" tag errors with validation errors
-	validationErrors = append(validationErrors, checkRequiredTag(cfg, "")...)
+	// TODO: need more granular approach
+	//// Combine missing "required" tag errors with validation errors
+	//validationErrors = append(validationErrors, checkRequiredTag(cfg, "")...)
 
 	return validationErrors
 }
@@ -300,10 +301,6 @@ func applyEnvConfig(prefix string, input interface{}) error {
 	return nil
 }
 
-func UseCache() bool {
-	return os.Getenv("CTF_USE_CACHED_OUTPUTS") == "true"
-}
-
 func getBaseConfigPath() (string, error) {
 	configs := os.Getenv("CTF_CONFIGS")
 	if configs == "" {
@@ -313,13 +310,15 @@ func getBaseConfigPath() (string, error) {
 }
 
 func Store[T any](cfg *T) error {
-	if UseCache() {
-		return nil
-	}
 	baseConfigPath, err := getBaseConfigPath()
 	if err != nil {
 		return err
 	}
+	newCacheName := strings.Replace(baseConfigPath, ".toml", "", -1)
+	if strings.Contains(newCacheName, "cache") {
+		L.Info().Str("Cache", baseConfigPath).Msg("Cache file already exists, skipping")
+		return nil
+	}
 	cachedOutName := fmt.Sprintf("%s-cache.toml", strings.Replace(baseConfigPath, ".toml", "", -1))
 	L.Info().Str("OutputFile", cachedOutName).Msg("Storing configuration output")
 	d, err := toml.Marshal(cfg)

framework/promtail.go

@@ -105,9 +105,6 @@ scrape_configs:
 }
 
 func NewLokiStreamer() error {
-	if UseCache() {
-		return nil
-	}
 	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Minute)
 	defer cancel()