ondc-code-generator 0.7.0 → 0.7.4

package/dist/generator/generators/go/templates/storage-templates/api-save-utils.mustache

@@ -0,0 +1,84 @@
+// Code generated by github.com/ONDC-Official/automation-validation-compiler, DO NOT EDIT.
+
+package storageutils
+
+import (
+	"encoding/json"
+	"fmt"
+	"time"
+	"validationpkg/validationutils"
+)
+
+
+// saveFunction saves extracted data from payload to storage
+func saveFunction(
+	payload interface{},
+	uniquePrefix string,
+	key string,
+	path string,
+	store validationutils.StorageInterface,
+	config StorageConfig,
+	action string,
+) error {
+	if path == "" || key == "_SELF" {
+		return nil
+	}
+
+	// Extract value using JSONPath
+	value := validationutils.GetJsonPath(payload, path, true)
+
+	// Create data structure
+	data := map[string]interface{}{
+		"stored_from": action + "_action",
+		"key_path":    path,
+		"value":       value,
+		"timestamp":   time.Now().UTC().Format(time.RFC3339),
+	}
+
+	// Serialize to JSON
+	dataBytes, err := json.Marshal(data)
+	if err != nil {
+		return fmt.Errorf("failed to marshal data: %w", err)
+	}
+
+	// Save with retry logic
+	return SaveData(uniquePrefix, key, string(dataBytes), store, config)
+}
+
+// loadFunction loads and parses stored data from storage
+func loadFunction(
+	store validationutils.StorageInterface,
+	uniquePrefix string,
+	key string,
+) ([]string, error) {
+	value, err := store.GetKey(uniquePrefix, key)
+	if err != nil {
+		// Return empty slice on error (matches TS behavior)
+		return []string{}, nil
+	}
+
+	if value == "" {
+		return []string{}, nil
+	}
+
+	// Parse JSON
+	var data struct {
+		Value []interface{} `json:"value"`
+	}
+
+	if err := json.Unmarshal([]byte(value), &data); err != nil {
+		return []string{}, nil
+	}
+
+	// Convert to string slice
+	result := make([]string, 0, len(data.Value))
+	for _, v := range data.Value {
+		if v == nil {
+			result = append(result, "null")
+		} else {
+			result = append(result, fmt.Sprintf("%v", v))
+		}
+	}
+
+	return result, nil
+}

package/dist/generator/generators/go/templates/storage-templates/api-save.mustache

@@ -0,0 +1,44 @@
+// Code generated by github.com/ONDC-Official/automation-validation-compiler, DO NOT EDIT.
+
+package storageutils
+
+import (
+	"validationpkg/validationutils"
+	"fmt"
+)
+
+// Store_{{action}} stores data from payload to storage for the {{action}} action
+func Store_{{action}}(
+	uniquePrefix string,
+	payload interface{},
+	store validationutils.StorageInterface,
+	config StorageConfig,
+) error {
+	{{#storeActions}}
+	if err := saveFunction(payload, uniquePrefix, "{{{key}}}", "{{{value}}}", store, config, "{{$action}}"); err != nil {
+		return fmt.Errorf("failed to save key {{{key}}}: %w", err)
+	}
+	{{/storeActions}}
+	fmt.Printf("Stored data for action {{action}} successfully\n")
+	return nil
+}
+
+// LoadFor_{{action}} loads stored data for the {{action}} action
+func LoadFor_{{action}}(
+	uniquePrefix string,
+	store validationutils.StorageInterface,
+) (validationutils.ExternalData, error) {
+	result := validationutils.ExternalData{}
+	
+	{{#loadActions}}
+	{{{key}}}_value, err := loadFunction(store, uniquePrefix, "{{{key}}}")
+	if err != nil {
+		return result, fmt.Errorf("failed to load key {{{key}}}: %w", err)
+	}
+	result.{{{key}}} = {{{key}}}_value
+	{{/loadActions}}
+	
+	fmt.Printf("Loaded external data for action {{action}}: %+v\n", result)
+	return result, nil
+}
+

package/dist/generator/generators/go/templates/storage-templates/index.mustache

@@ -0,0 +1,72 @@
+// Code generated by github.com/ONDC-Official/automation-validation-compiler, DO NOT EDIT.
+package storageutils
+
+import (
+	"fmt"
+	"validationpkg/validationutils"
+)
+
+// Perform{{functionName}}Save saves validation state data for a given action
+//
+// Parameters:
+//   - action: The action name
+//   - uniquePrefix: Unique namespace prefix
+//   - payload: The payload data to extract and save
+//   - store: Storage interface implementation
+//   - config: Optional storage configuration (nil uses defaults)
+//
+// Returns error if the action is not found or save fails
+func Perform{{functionName}}Save(
+	action string,
+	uniquePrefix string,
+	payload interface{},
+	store validationutils.StorageInterface,
+	config *StorageConfig,
+) error {
+	// Set default config if not provided
+	completeConfig := StorageConfig{
+		RetryAttempts: 3,
+		RetryDelayMs:  1000,
+	}
+
+	if config != nil {
+		if config.RetryAttempts > 0 {
+			completeConfig.RetryAttempts = config.RetryAttempts
+		}
+		if config.RetryDelayMs > 0 {
+			completeConfig.RetryDelayMs = config.RetryDelayMs
+		}
+	}
+
+	switch action {
+	{{#actions}}
+	case "{{action}}":
+		return Store_{{{action}}}(uniquePrefix, payload, store, completeConfig)
+	{{/actions}}
+	default:
+		return fmt.Errorf("action not found: %s", action)
+	}
+}
+
+// Perform{{functionName}}Load loads validation state data for a given action
+//
+// Parameters:
+//   - action: The action name
+//   - uniquePrefix: Unique namespace prefix
+//   - store: Storage interface implementation
+//
+// Returns ExternalData with loaded values and error if action not found
+func Perform{{functionName}}Load(
+	action string,
+	uniquePrefix string,
+	store validationutils.StorageInterface,
+) (validationutils.ExternalData, error) {
+	switch action {
+	{{#actions}}
+	case "{{action}}":
+		return LoadFor_{{{action}}}(uniquePrefix, store)
+	{{/actions}}
+	default:
+		return validationutils.ExternalData{}, fmt.Errorf("action not found: %s", action)
+	}
+}

package/dist/generator/generators/go/templates/storage-templates/save-utils.mustache

@@ -0,0 +1,75 @@
+// Code generated by github.com/ONDC-Official/automation-validation-compiler, DO NOT EDIT.
+
+package storageutils
+
+import (
+	"fmt"
+	"time"
+	"validationpkg/validationutils"
+)
+
+// StorageConfig holds configuration for storage operations
+type StorageConfig struct {
+	// RetryAttempts is the number of times to retry a failed operation
+	RetryAttempts int
+	// RetryDelayMs is the delay in milliseconds between retry attempts
+	RetryDelayMs int
+}
+
+// DefaultStorageConfig returns a StorageConfig with sensible defaults
+func DefaultStorageConfig() StorageConfig {
+	return StorageConfig{
+		RetryAttempts: 3,
+		RetryDelayMs:  100,
+	}
+}
+
+// SaveData saves data to storage with retry logic
+//
+// Parameters:
+//   - uniquePrefix: The namespace prefix for the key
+//   - key: The key to store the data under
+//   - saveData: The string data to save
+//   - store: The storage interface implementation
+//   - config: Configuration including retry settings
+//
+// Returns error if all retry attempts fail
+func SaveData(
+	uniquePrefix string,
+	key string,
+	saveData string,
+	store validationutils.StorageInterface,
+	config StorageConfig,
+) error {
+	finalKey := key
+	retryTimes := config.RetryAttempts
+	delayMs := config.RetryDelayMs
+	attempts := 0
+
+	for attempts < retryTimes {
+		err := store.SaveKey(uniquePrefix, finalKey, saveData)
+		if err == nil {
+			return nil
+		}
+
+		attempts++
+		if attempts >= retryTimes {
+			return fmt.Errorf("failed to save data after %d attempts: %w", retryTimes, err)
+		}
+
+		time.Sleep(time.Duration(delayMs) * time.Millisecond)
+	}
+
+	return nil
+}
+
+// CreateKey creates a fully qualified storage key from prefix and key
+//
+// Parameters:
+//   - uniquePrefix: The namespace prefix
+//   - key: The key within the namespace
+//
+// Returns the combined key in format "prefix:key"
+func CreateKey(uniquePrefix string, key string) string {
+	return fmt.Sprintf("%s:%s", uniquePrefix, key)
+}

package/dist/generator/generators/{golang → go}/templates/storage-templates/storage-interface.mustache

@@ -1,14 +1,16 @@
-package interfaces
+// Code generated by github.com/ONDC-Official/automation-validation-compiler, DO NOT EDIT.
+
+package validationutils
 
 // StorageInterface provides a standardized abstraction layer for storage operations
 // that can be implemented by different storage backends (Redis, Memory, File, etc.).
 //
-// All operations return errors for failure cases.
-// Keys are strings and values are stored as strings.
-// Implementations should handle serialization/deserialization as needed.
-// Prefix-based operations allow for namespacing and bulk operations.
+// Implementation Notes:
+//   - Keys should be strings and values are stored as strings
+//   - Implementations should handle serialization/deserialization as needed
+//   - Prefix-based operations allow for namespacing and bulk operations
 //
-// Example implementation:
+// Example:
 //
 //	type RedisStorage struct {
 //	    client *redis.Client
@@ -18,6 +20,10 @@ package interfaces
 //	    fullKey := fmt.Sprintf("%s:%s", uniquePrefix, key)
 //	    return r.client.Set(ctx, fullKey, value, 0).Err()
 //	}
+//
+//	storage := &RedisStorage{client: redisClient}
+//	userData, _ := json.Marshal(user)
+//	storage.SaveKey("app1", "user:123", string(userData))
 type StorageInterface interface {
 	// SaveKey saves a key-value pair to storage with a unique prefix for namespacing.
 	//
@@ -26,11 +32,12 @@ type StorageInterface interface {
 	//   - key: The unique identifier for the stored value within the prefix namespace
 	//   - value: The string value to store
 	//
-	// Returns an error if the operation fails.
+	// Returns error if the operation fails
 	//
 	// Example:
-	//   err := storage.SaveKey("app1", "session:abc123", sessionDataJSON)
-	SaveKey(uniquePrefix, key, value string) error
+	//   sessionData, _ := json.Marshal(session)
+	//   err := storage.SaveKey("app1", "session:abc123", string(sessionData))
+	SaveKey(uniquePrefix string, key string, value string) error
 
 	// GetKey retrieves a value by its key from storage within a specific namespace.
 	//
@@ -38,11 +45,14 @@ type StorageInterface interface {
 	//   - uniquePrefix: The unique identifier/namespace prefix used when storing
 	//   - key: The unique identifier for the value to retrieve within the prefix namespace
 	//
-	// Returns the stored value or an error if the key does not exist.
+	// Returns the stored value and error if the key does not exist
 	//
 	// Example:
 	//   sessionData, err := storage.GetKey("app1", "session:abc123")
-	GetKey(uniquePrefix, key string) (string, error)
+	//   if err != nil {
+	//       // handle key not found
+	//   }
+	GetKey(uniquePrefix string, key string) (string, error)
 
 	// DeleteKey removes a key-value pair from storage within a specific namespace.
 	//
@@ -50,30 +60,31 @@ type StorageInterface interface {
 	//   - uniquePrefix: The unique identifier/namespace prefix used when storing
 	//   - key: The unique identifier for the value to delete within the prefix namespace
 	//
-	// Returns an error if the operation fails.
+	// Returns error if the operation fails
 	//
 	// Example:
 	//   err := storage.DeleteKey("app1", "session:abc123")
-	DeleteKey(uniquePrefix, key string) error
+	DeleteKey(uniquePrefix string, key string) error
 
-	// ListKeys returns all keys within a specific namespace/prefix.
+	// ListKeys lists all keys within a specific namespace/prefix.
 	//
 	// Parameters:
 	//   - uniquePrefix: The unique identifier/namespace prefix to list keys from
 	//
-	// Returns an array of keys within that namespace or an error.
+	// Returns an array of keys within that namespace
 	//
 	// Example:
 	//   app1Keys, err := storage.ListKeys("app1")
-	//   // Returns keys like: ["session:abc123", "user:456", "config:settings"]
+	//   // Returns keys stored under the "app1" namespace
+	//   // e.g., []string{"session:abc123", "user:456", "config:settings"}
 	ListKeys(uniquePrefix string) ([]string, error)
 
-	// ClearStorage removes all stored data from the storage backend.
+	// ClearStorage clears all stored data from the storage backend.
 	//
 	// WARNING: This operation is destructive and cannot be undone.
 	// Use with caution, especially in production environments.
 	//
-	// Returns an error if the operation fails.
+	// Returns error if the operation fails
 	//
 	// Example:
 	//   err := storage.ClearStorage() // All data is now removed
@@ -85,12 +96,12 @@ type StorageInterface interface {
 	//   - uniquePrefix: The unique identifier/namespace prefix to check within
 	//   - key: The unique identifier to check for existence within the prefix namespace
 	//
-	// Returns true if the key exists, false otherwise, or an error.
+	// Returns true if the key exists, false otherwise
 	//
 	// Example:
 	//   exists, err := storage.KeyExists("app1", "user:123")
-	//   if exists {
+	//   if err == nil && exists {
 	//       userData, _ := storage.GetKey("app1", "user:123")
 	//   }
-	KeyExists(uniquePrefix, key string) (bool, error)
-}
+	KeyExists(uniquePrefix string, key string) (bool, error)
+}

package/dist/generator/generators/go/templates/test-config.mustache

@@ -0,0 +1,62 @@
+// Code generated by github.com/ONDC-Official/automation-validation-compiler, DO NOT EDIT.
+
+package validationutils
+
+// ValidationConfig holds configuration options for running validation routines.
+type ValidationConfig struct {
+	// StateFullValidations enables stateful validations that may depend on previous data
+	StateFullValidations bool
+	// UniqueKey is an optional unique key for the validation instance
+	UniqueKey *string
+	// Store is an optional implementation of StorageInterface for persisting data across validations
+	Store StorageInterface
+	// OnlyInvalid if true, only invalid results will be returned
+	OnlyInvalid bool
+	// HideParentErrors hides nested error details if set to true
+	HideParentErrors bool
+	// Debug enables debug mode for additional diagnostic information
+	Debug bool
+}
+
+// ValidationOutput represents the output of a validation run.
+// Each element corresponds to a single validation test result.
+type ValidationOutput struct {
+	// TestName is the name of the validation test
+	TestName string `json:"testName"`
+	// Valid indicates whether the test passed (true) or failed (false)
+	Valid bool `json:"valid"`
+	// Code is a numeric code representing the result or error type
+	Code int `json:"code"`
+	// Description provides additional details about the test result
+	Description string `json:"description,omitempty"`
+	// DebugInfo contains diagnostic information useful for debugging
+	DebugInfo *DebugInfo `json:"_debugInfo,omitempty"`
+}
+
+// DebugInfo contains diagnostic information for validation results
+type DebugInfo struct {
+	// FedConfig is the configuration used to generate the validation
+	FedConfig interface{} `json:"fedConfig"`
+}
+
+// ExternalData holds external data references for validation
+type ExternalData struct {
+	Self interface{} `json:"_SELF,omitempty"`
+    {{#externalData}}
+    {{name}} []string `json:"{{name}},omitempty"`
+    {{/externalData}}
+}
+
+// ValidationInput represents the input data for validation functions
+type ValidationInput struct {
+	Payload      interface{}
+	ExternalData ExternalData
+	Config       ValidationConfig
+}
+
+// TestFunction is a function type that takes ValidationInput and returns a slice of ValidationOutput
+type TestFunction func(input ValidationInput) ([]ValidationOutput, error)
+
+// TestFunctionArray is a slice of test functions
+type TestFunctionArray []TestFunction
+

package/dist/generator/generators/go/templates/test-object.mustache

@@ -0,0 +1,52 @@
+var {{name}} = func (input validationutils.ValidationInput) ([]validationutils.ValidationOutput, error) {
+    scope := validationutils.GetJsonPath(input.Payload,"{{{scopePath}}}",true)
+    
+    subResults := make([]validationutils.ValidationOutput, 0)
+    valid := true
+    configureDebugInfo := ""
+    for _, testObj := range scope {
+        testObjMap, ok := validationutils.DeepCloneJSON(testObj).(map[string]interface{})
+        if !ok {
+            return nil, fmt.Errorf("Invalid object structure in scope for test {{name}}")
+        }
+
+        testObjMap["_EXTERNAL"] = validationutils.DeepCloneJSON(input.ExternalData)
+        
+        {{#variables}}
+        {{name}} := {{{value}}}
+        validationutils.UnusedFunction({{name}})
+        {{/variables}}
+
+        {{#hasContinue}}
+        skipCheck := {{{skipCheckStatement}}}
+        if( skipCheck ) {
+            continue
+        }
+        {{/hasContinue}}
+
+        {{{validationCode}}}
+
+        delete(testObjMap, "_EXTERNAL")
+    }
+    
+    result := validationutils.ValidationOutput{
+        TestName: "{{name}}",
+        Valid: valid,
+        Code: 0,
+        DebugInfo: &validationutils.DebugInfo{
+            FedConfig: configureDebugInfo,
+        },
+    }
+
+    if valid {
+		result.Code = {{successCode}}
+	} else {
+		result.Code = {{errorCode}}
+	}
+
+	results := make([]validationutils.ValidationOutput, 0, len(subResults)+1)
+	results = append(results, result)
+	results = append(results, subResults...)
+
+	return results,nil
+}

package/dist/generator/generators/go/templates/validation-code.mustache

@@ -0,0 +1,66 @@
+
+
+{{#isNested}}
+
+{{{nestedFunctions}}}
+
+var testFunctions = validationutils.TestFunctionArray{
+    {{#names}}
+    {{name}},
+    {{/names}}
+}
+
+allResults := make([]validationutils.ValidationOutput, 0)
+
+for _, testFunc := range testFunctions {
+    results, err := testFunc(input)
+    if err != nil {
+        return nil, err
+    }
+    allResults = append(allResults, results...)
+}
+
+subResults = allResults
+// if all subResults are valid, then valid is true
+valid = true
+for _, res := range subResults {
+    if !res.Valid {
+        valid = false
+        break
+    }
+}
+
+configureDebugInfo = `NESTED_TEST_OBJECT`
+
+{{/isNested}}
+
+{{^isNested}}
+
+{{#isStateFull}}
+    validate := true
+    if( input.Config.StateFullValidations == false ) {
+        validate = {{{returnStatement}}}
+    }
+{{/isStateFull}}
+
+{{^isStateFull}}
+    validate := {{{returnStatement}}}
+{{/isStateFull}}
+
+configureDebugInfo = `{{{TEST_OBJECT}}}`
+
+if(!validate){
+    result := validationutils.ValidationOutput{
+        TestName: "{{testName}}",
+        Valid: false,
+        Code: {{errorCode}},
+        Description: `{{{errorDescription}}}`,
+        DebugInfo: &validationutils.DebugInfo{
+            FedConfig: configureDebugInfo,
+        },
+    }
+    delete(testObjMap, "_EXTERNAL")
+    return []validationutils.ValidationOutput{result},nil
+}
+
+{{/isNested}}