|
| 1 | +package runner |
| 2 | + |
| 3 | +import ( |
| 4 | + "encoding/json" |
| 5 | + "fmt" |
| 6 | +) |
| 7 | + |
| 8 | +// stateMutatingMethods contains methods that mutate internal state. |
| 9 | +// Tests using these methods are assumed to affect all subsequent tests |
| 10 | +// and are included in dependency chains printed in verbose mode. |
| 11 | +var stateMutatingMethods = map[string]bool{ |
| 12 | + "btck_chainstate_manager_process_block": true, |
| 13 | +} |
| 14 | + |
| 15 | +// DependencyTracker manages test dependencies and builds request chains for verbose output. |
| 16 | +// It tracks both explicit ref dependencies and implicit state dependencies. |
| 17 | +type DependencyTracker struct { |
| 18 | + // refCreators maps reference names to the test index that created them |
| 19 | + refCreators map[string]int |
| 20 | + |
| 21 | + // statefulRefs tracks refs created by stateful methods (btck_context_create, btck_chainstate_manager_create). |
| 22 | + // Tests using these refs depend on mutable state. |
| 23 | + statefulRefs map[string]bool |
| 24 | + |
| 25 | + // depChains maps test index to its dependency chain (tests it depends on via ref usage) |
| 26 | + depChains map[int][]int |
| 27 | + |
| 28 | + // stateDependencies is a cumulative list of all tests affecting state (state-mutating |
| 29 | + // tests and their complete dependency chains) |
| 30 | + stateDependencies []int |
| 31 | +} |
| 32 | + |
| 33 | +// NewDependencyTracker creates a new dependency tracker |
| 34 | +func NewDependencyTracker() *DependencyTracker { |
| 35 | + return &DependencyTracker{ |
| 36 | + refCreators: make(map[string]int), |
| 37 | + statefulRefs: make(map[string]bool), |
| 38 | + depChains: make(map[int][]int), |
| 39 | + stateDependencies: []int{}, |
| 40 | + } |
| 41 | +} |
| 42 | + |
| 43 | +// BuildDependenciesForTest analyzes a test's parameters to build its complete transitive |
| 44 | +// dependency chain. When a test uses refs created by earlier tests, this records all direct |
| 45 | +// dependencies (tests that created those refs) and indirect dependencies (their dependencies). |
| 46 | +// Must be called after all previous tests have been processed. |
| 47 | +func (dt *DependencyTracker) BuildDependenciesForTest(testIndex int, test *TestCase) { |
| 48 | + // Build dependency chain for current test based on refs it uses |
| 49 | + var parentChains [][]int |
| 50 | + for _, ref := range extractRefsFromParams(test.Request.Params) { |
| 51 | + if creatorIdx, exists := dt.refCreators[ref]; exists { |
| 52 | + // Add the creator as a direct dependency |
| 53 | + parentChains = append(parentChains, []int{creatorIdx}) |
| 54 | + // Add transitive dependencies (creator's dependencies) |
| 55 | + if chain, hasChain := dt.depChains[creatorIdx]; hasChain { |
| 56 | + parentChains = append(parentChains, chain) |
| 57 | + } |
| 58 | + } else { |
| 59 | + panic(fmt.Sprintf("test %d (%s) uses undefined reference %s - no prior test created this ref", |
| 60 | + testIndex, test.Request.ID, ref)) |
| 61 | + } |
| 62 | + } |
| 63 | + dt.depChains[testIndex] = mergeSortedUnique(parentChains...) |
| 64 | +} |
| 65 | + |
| 66 | +// OnTestExecuted is called after a test executes successfully. It tracks the ref |
| 67 | +// created by the test, marks it as stateful if needed, and updates state dependencies |
| 68 | +// for state-mutating methods. |
| 69 | +func (dt *DependencyTracker) OnTestExecuted(testIndex int, test *TestCase) { |
| 70 | + if ref := extractRefFromExpected(test.ExpectedResponse); ref != "" { |
| 71 | + dt.refCreators[ref] = testIndex |
| 72 | + |
| 73 | + // Mark refs from stateful methods |
| 74 | + if test.Request.Method == "btck_context_create" || test.Request.Method == "btck_chainstate_manager_create" { |
| 75 | + dt.statefulRefs[ref] = true |
| 76 | + } |
| 77 | + } |
| 78 | + |
| 79 | + // Track state-mutating tests and their dependencies |
| 80 | + if stateMutatingMethods[test.Request.Method] { |
| 81 | + mutatorChain := append(dt.depChains[testIndex], testIndex) |
| 82 | + dt.stateDependencies = mergeSortedUnique(dt.stateDependencies, mutatorChain) |
| 83 | + } |
| 84 | +} |
| 85 | + |
| 86 | +// BuildRequestChain builds the complete dependency chain for a test |
| 87 | +func (dt *DependencyTracker) BuildRequestChain(testIndex int, allTests []TestCase) []int { |
| 88 | + refDepChain := dt.depChains[testIndex] |
| 89 | + |
| 90 | + // Only include state dependencies if the test's dep chain contains any stateful refs |
| 91 | + if dt.testUsesStatefulRefs(testIndex, allTests) { |
| 92 | + return mergeSortedUnique(refDepChain, dt.stateDependencies) |
| 93 | + } |
| 94 | + |
| 95 | + return refDepChain |
| 96 | +} |
| 97 | + |
| 98 | +// testUsesStatefulRefs checks if a test's dependency chain includes any stateful refs |
| 99 | +func (dt *DependencyTracker) testUsesStatefulRefs(testIndex int, allTests []TestCase) bool { |
| 100 | + // Check all tests in the dependency chain |
| 101 | + for _, depIdx := range dt.depChains[testIndex] { |
| 102 | + for _, ref := range extractRefsFromParams(allTests[depIdx].Request.Params) { |
| 103 | + if dt.statefulRefs[ref] { |
| 104 | + return true |
| 105 | + } |
| 106 | + } |
| 107 | + } |
| 108 | + |
| 109 | + // Check the test itself |
| 110 | + for _, ref := range extractRefsFromParams(allTests[testIndex].Request.Params) { |
| 111 | + if dt.statefulRefs[ref] { |
| 112 | + return true |
| 113 | + } |
| 114 | + } |
| 115 | + return false |
| 116 | +} |
| 117 | + |
| 118 | +// extractRefFromExpected extracts a reference name from the expected result if it's a |
| 119 | +// string starting with "$". Returns empty string if not a reference. |
| 120 | +func extractRefFromExpected(expected Response) string { |
| 121 | + var resultStr string |
| 122 | + if err := json.Unmarshal(expected.Result, &resultStr); err != nil { |
| 123 | + return "" |
| 124 | + } |
| 125 | + if len(resultStr) > 1 && resultStr[0] == '$' { |
| 126 | + return resultStr |
| 127 | + } |
| 128 | + return "" |
| 129 | +} |
| 130 | + |
| 131 | +// extractRefsFromParams extracts all reference names from params JSON. |
| 132 | +func extractRefsFromParams(params json.RawMessage) []string { |
| 133 | + var refs []string |
| 134 | + |
| 135 | + // Parse params as a generic structure |
| 136 | + var paramsMap map[string]interface{} |
| 137 | + if err := json.Unmarshal(params, ¶msMap); err != nil { |
| 138 | + return refs |
| 139 | + } |
| 140 | + |
| 141 | + // Find all string values starting with "$" (assumes refs are at first level only) |
| 142 | + for _, value := range paramsMap { |
| 143 | + if str, ok := value.(string); ok && len(str) > 1 && str[0] == '$' { |
| 144 | + refs = append(refs, str) |
| 145 | + } |
| 146 | + } |
| 147 | + return refs |
| 148 | +} |
0 commit comments