|
1 | 1 | package strikes |
2 | 2 |
|
3 | 3 | import ( |
4 | | - "errors" |
5 | 4 | "fmt" |
6 | 5 | "log" |
7 | 6 |
|
8 | 7 | hclog "github.com/hashicorp/go-hclog" |
9 | 8 | "github.com/spf13/viper" |
10 | 9 |
|
11 | 10 | "github.com/privateerproj/privateer-sdk/raidengine" |
| 11 | + "github.com/privateerproj/privateer-sdk/utils" |
12 | 12 | ) |
13 | 13 |
|
14 | 14 | type Antijokes struct { |
15 | | - Log hclog.Logger |
| 15 | + Log hclog.Logger // Recommended, allows you to set the log level for each log message |
| 16 | + Results map[string]raidengine.StrikeResult // Optional, allows cross referencing between strikes |
| 17 | +} |
| 18 | + |
| 19 | +func (a *Antijokes) SetLogger(loggerName string) { |
| 20 | + a.Log = raidengine.GetLogger(loggerName, false) |
16 | 21 | } |
17 | 22 |
|
18 | 23 | // KnockKnock is a demo test for dev purposes |
19 | 24 | func (a *Antijokes) KnockKnock() (strikeName string, result raidengine.StrikeResult) { |
20 | 25 | strikeName = "Knock Knock" |
| 26 | + log.Print(strikeName) // Default logs will be set as INFO |
| 27 | + |
21 | 28 | result = raidengine.StrikeResult{ |
22 | | - Passed: false, |
23 | | - Message: "", |
24 | | - DocsURL: "", |
| 29 | + Passed: false, |
| 30 | + Description: "This is a failure of a joke for dev purposes", |
| 31 | + Message: "Strike has not yet started.", |
| 32 | + DocsURL: "https://maintainer.com/docs/raids/wireframe", |
| 33 | + ControlID: "CCC-Taxonomy-1", |
| 34 | + Movements: make(map[string]raidengine.MovementResult), |
25 | 35 | } |
26 | | - log.Printf("Knock Knock") |
27 | | - name, err := getJokeName() |
28 | | - if err != nil { |
| 36 | + |
| 37 | + // run getJokerName() as a movement |
| 38 | + jokerNameMovement := getJokerName() |
| 39 | + result.Movements["JokerName"] = jokerNameMovement |
| 40 | + if !jokerNameMovement.Passed { |
| 41 | + result.Message = jokerNameMovement.Message |
29 | 42 | return |
30 | 43 | } |
31 | | - log.Printf("Me: Knock Knock") |
32 | | - log.Printf(fmt.Sprintf("%s: Who's There?", name)) |
33 | | - // Demo the log timestamp |
34 | | - for i := 1; i < 5000000; i++ { |
35 | | - if i%500000 == 0 { |
36 | | - log.Printf("Me: (stares at %s)", name) |
37 | | - } |
| 44 | + |
| 45 | + // run getJokeeName() as a movement |
| 46 | + jokeeNameMovement := getJokeeName() |
| 47 | + result.Movements["JokeeName"] = jokeeNameMovement |
| 48 | + if !jokeeNameMovement.Passed { |
| 49 | + result.Message = jokeeNameMovement.Message |
| 50 | + return |
38 | 51 | } |
39 | | - log.Printf(fmt.Sprintf("%s: (lost interest and left)", name)) |
| 52 | + |
| 53 | + // Run multiple movements at once by passing the result object as a pointer |
| 54 | + // Previous movement values must be cast to their type from interface{} before being used again |
| 55 | + RunKnockKnock(jokerNameMovement.Value.(string), jokeeNameMovement.Value.(string), &result) |
40 | 56 | return |
41 | 57 | } |
42 | 58 |
|
43 | 59 | // ChickenCrossedRoad is a demo test for dev purposes |
44 | 60 | func (a *Antijokes) ChickenCrossedRoad() (strikeName string, result raidengine.StrikeResult) { |
| 61 | + // If a strike is part of multiple tactics, you can use a map to reference the control ID to the selected tactic |
| 62 | + controlIDs := map[string]string{ |
| 63 | + "CCC-Taxonomy": "CCC-Taxonomy-2", |
| 64 | + "CCC-Hardening": "CCC-Hardening-1", |
| 65 | + "CIS": "CIS-1", |
| 66 | + } |
45 | 67 | strikeName = "Chicken Crossed Road" |
46 | 68 | result = raidengine.StrikeResult{ |
47 | | - Passed: true, |
48 | | - Message: "", |
49 | | - DocsURL: "", |
| 69 | + Passed: false, |
| 70 | + Description: "This is a demo strike for dev purposes", |
| 71 | + Message: "Strike has not yet started.", |
| 72 | + DocsURL: "https://maintainer.com/docs/raids/wireframe", |
| 73 | + ControlID: controlIDs[viper.GetString("raids.wireframe.tactic")], |
| 74 | + Movements: make(map[string]raidengine.MovementResult), |
50 | 75 | } |
51 | 76 |
|
52 | | - name, err := getJokeName() |
53 | | - if err != nil { |
| 77 | + jokerNameMovement := getJokerName() |
| 78 | + result.Movements["JokerName"] = jokerNameMovement |
| 79 | + if !jokerNameMovement.Passed { |
| 80 | + result.Message = jokerNameMovement.Message |
54 | 81 | return |
55 | 82 | } |
56 | | - a.Log.Warn("Me: This joke may offend someone.") |
57 | | - a.Log.Info("Me: Why did the chicken cross the road?") |
58 | | - a.Log.Trace(fmt.Sprintf("Me: (looks to see what %s's expression is)", name)) |
59 | | - a.Log.Info(fmt.Sprintf("%s: I'm busy, leave me alone.", name)) |
| 83 | + |
| 84 | + // Using an hclog logger will allow you to set the log level for each message |
| 85 | + a.Log.Warn(fmt.Sprintf("%s: This joke may offend someone.", jokerNameMovement.Value)) |
| 86 | + a.Log.Info(fmt.Sprintf("%s: Why did the chicken cross the road?", jokerNameMovement.Value)) |
| 87 | + a.Log.Trace(fmt.Sprintf("%s: (looks to see what the stranger's expression is)", jokerNameMovement.Value)) |
| 88 | + a.Log.Info("Stranger: I'm busy, leave me alone.") |
| 89 | + |
| 90 | + result.Passed = true |
| 91 | + result.Message = "We tried, and that's all we really came here for." |
| 92 | + return |
| 93 | +} |
| 94 | + |
| 95 | +// getJokerName is a common movement for the strikes in this raid |
| 96 | +func getJokerName() (result raidengine.MovementResult) { |
| 97 | + result = raidengine.MovementResult{ |
| 98 | + Description: "JokerName must be found in the runtime configuration.", |
| 99 | + Function: utils.CallerPath(0), |
| 100 | + } |
| 101 | + if viper.IsSet("raids.wireframe.JokerName") { |
| 102 | + result.Passed = true |
| 103 | + result.Message = "JokerName is set" |
| 104 | + result.Value = viper.GetString("raids.wireframe.JokerName") |
| 105 | + } else { |
| 106 | + result.Passed = false |
| 107 | + result.Message = "JokerName must be set in the configuration." |
| 108 | + } |
60 | 109 | return |
61 | 110 | } |
62 | 111 |
|
63 | | -func getJokeName() (string, error) { |
64 | | - if viper.IsSet("raids.wireframe.jokename") { |
65 | | - return viper.GetString("raids.wireframe.jokename"), nil |
| 112 | +// getJokerName is a common movement for the strikes in this raid |
| 113 | +func getJokeeName() (result raidengine.MovementResult) { |
| 114 | + result = raidengine.MovementResult{ |
| 115 | + Description: "JokeeName must be found in the runtime configuration.", |
| 116 | + Function: utils.CallerPath(0), |
| 117 | + } |
| 118 | + if viper.IsSet("raids.wireframe.JokeeName") { |
| 119 | + result.Passed = true |
| 120 | + result.Message = "JokeeName is set" |
| 121 | + result.Value = viper.GetString("raids.wireframe.JokeeName") |
| 122 | + } else { |
| 123 | + result.Passed = false |
| 124 | + result.Message = "JokeeName must be set in the configuration." |
| 125 | + } |
| 126 | + return |
| 127 | +} |
| 128 | + |
| 129 | +// RunKnockKnock is a set of movements for the Knock Knock strike, with each movement being added to the provided result |
| 130 | +func RunKnockKnock(jokerName, jokeeName string, result *raidengine.StrikeResult) { |
| 131 | + // say knock knock |
| 132 | + result.Movements["knock knock"] = raidengine.MovementResult{ |
| 133 | + Passed: true, |
| 134 | + Description: "Joke must be started by the joker.", |
| 135 | + Message: fmt.Sprintf("%s: Knock knock.", jokerName), |
| 136 | + Function: utils.CallerPath(0), |
| 137 | + } |
| 138 | + // say who's there |
| 139 | + result.Movements["who's there"] = raidengine.MovementResult{ |
| 140 | + Passed: true, |
| 141 | + Description: "Jokee must respond with 'who's there?'", |
| 142 | + Message: fmt.Sprintf("%s: Who's there?", jokeeName), |
| 143 | + Function: utils.CallerPath(0), |
| 144 | + } |
| 145 | + // say punchline |
| 146 | + result.Movements["punchline"] = raidengine.MovementResult{ |
| 147 | + Passed: true, |
| 148 | + Description: "Jokee must respond with the punchline.", |
| 149 | + Message: fmt.Sprintf("%s: %s", jokerName, jokeeName), |
| 150 | + Function: utils.CallerPath(0), |
66 | 151 | } |
67 | | - return "", errors.New("JokeName must be set in the config file or env vars (PVTR_WIREFRAME_JOKE_NAME)") |
68 | 152 | } |
0 commit comments