|
| 1 | +package experiment |
| 2 | + |
| 3 | +import ( |
| 4 | + "os" |
| 5 | + |
| 6 | + "github.com/litmuschaos/chaos-operator/api/litmuschaos/v1alpha1" |
| 7 | + litmusLIB "github.com/litmuschaos/litmus-go/chaoslib/litmus/spring-boot-chaos/lib" |
| 8 | + "github.com/litmuschaos/litmus-go/pkg/clients" |
| 9 | + "github.com/litmuschaos/litmus-go/pkg/events" |
| 10 | + "github.com/litmuschaos/litmus-go/pkg/log" |
| 11 | + "github.com/litmuschaos/litmus-go/pkg/probe" |
| 12 | + "github.com/litmuschaos/litmus-go/pkg/result" |
| 13 | + experimentEnv "github.com/litmuschaos/litmus-go/pkg/spring-boot/spring-boot-chaos/environment" |
| 14 | + experimentTypes "github.com/litmuschaos/litmus-go/pkg/spring-boot/spring-boot-chaos/types" |
| 15 | + "github.com/litmuschaos/litmus-go/pkg/status" |
| 16 | + "github.com/litmuschaos/litmus-go/pkg/types" |
| 17 | + "github.com/litmuschaos/litmus-go/pkg/utils/common" |
| 18 | + "github.com/sirupsen/logrus" |
| 19 | +) |
| 20 | + |
| 21 | +// Experiment contains steps to inject chaos |
| 22 | +func Experiment(clients clients.ClientSets) { |
| 23 | + |
| 24 | + experimentsDetails := experimentTypes.ExperimentDetails{} |
| 25 | + resultDetails := types.ResultDetails{} |
| 26 | + eventsDetails := types.EventDetails{} |
| 27 | + chaosDetails := types.ChaosDetails{} |
| 28 | + |
| 29 | + //Fetching all the ENV passed from the runner pod |
| 30 | + log.Infof("[PreReq]: Getting the ENV for the %v experiment", os.Getenv("EXPERIMENT_NAME")) |
| 31 | + experimentEnv.GetENV(&experimentsDetails, "spring-boot-app-kill") |
| 32 | + |
| 33 | + // Initialize the chaos attributes |
| 34 | + types.InitialiseChaosVariables(&chaosDetails) |
| 35 | + |
| 36 | + // Initialize Chaos Result Parameters |
| 37 | + types.SetResultAttributes(&resultDetails, chaosDetails) |
| 38 | + |
| 39 | + if experimentsDetails.EngineName != "" { |
| 40 | + // Initialize the probe details. Bail out upon error, as we haven't entered exp business logic yet |
| 41 | + if err := probe.InitializeProbesInChaosResultDetails(&chaosDetails, clients, &resultDetails); err != nil { |
| 42 | + log.Errorf("Unable to initialize the probes, err: %v", err) |
| 43 | + return |
| 44 | + } |
| 45 | + } |
| 46 | + |
| 47 | + //Updating the chaos result in the beginning of experiment |
| 48 | + log.Infof("[PreReq]: Updating the chaos result of %v experiment (SOT)", experimentsDetails.ExperimentName) |
| 49 | + if err := result.ChaosResult(&chaosDetails, clients, &resultDetails, "SOT"); err != nil { |
| 50 | + log.Errorf("Unable to Create the Chaos Result, err: %v", err) |
| 51 | + failStep := "[pre-chaos]: Failed to update the chaos result of spring-boot-chaos experiment (SOT), err: " + err.Error() |
| 52 | + result.RecordAfterFailure(&chaosDetails, &resultDetails, failStep, clients, &eventsDetails) |
| 53 | + return |
| 54 | + } |
| 55 | + |
| 56 | + // Set the chaos result uid |
| 57 | + _ = result.SetResultUID(&resultDetails, clients, &chaosDetails) |
| 58 | + |
| 59 | + // generating the event in chaosResult to mark the verdict as awaited |
| 60 | + msg := "experiment: " + experimentsDetails.ExperimentName + ", Result: Awaited" |
| 61 | + types.SetResultEventAttributes(&eventsDetails, types.AwaitedVerdict, msg, "Normal", &resultDetails) |
| 62 | + _ = events.GenerateEvents(&eventsDetails, clients, &chaosDetails, "ChaosResult") |
| 63 | + |
| 64 | + //DISPLAY THE APP INFORMATION |
| 65 | + log.InfoWithValues("[Info]: The application information is as follows", logrus.Fields{ |
| 66 | + "Namespace": experimentsDetails.AppNS, |
| 67 | + "Label": experimentsDetails.AppLabel, |
| 68 | + "Chaos Duration": experimentsDetails.ChaosDuration, |
| 69 | + }) |
| 70 | + |
| 71 | + // Calling AbortWatcher go routine, it will continuously watch for the abort signal and generate the required events and result |
| 72 | + go common.AbortWatcherWithoutExit(experimentsDetails.ExperimentName, clients, &resultDetails, &chaosDetails, &eventsDetails) |
| 73 | + |
| 74 | + // Select targeted pods |
| 75 | + log.Infof("[PreCheck]: Geting targeted pods list") |
| 76 | + if err := litmusLIB.SetTargetPodList(&experimentsDetails, clients, &chaosDetails); err != nil { |
| 77 | + log.Errorf("Failed to get target pod list, err: %v", err) |
| 78 | + failStep := "[pre-chaos]: Failed to get pod list, err: " + err.Error() |
| 79 | + types.SetEngineEventAttributes(&eventsDetails, types.PreChaosCheck, "Pods: Not Found", "Warning", &chaosDetails) |
| 80 | + _ = events.GenerateEvents(&eventsDetails, clients, &chaosDetails, "ChaosEngine") |
| 81 | + result.RecordAfterFailure(&chaosDetails, &resultDetails, failStep, clients, &eventsDetails) |
| 82 | + return |
| 83 | + } |
| 84 | + podNames := make([]string, 0, 1) |
| 85 | + for _, pod := range experimentsDetails.TargetPodList.Items { |
| 86 | + podNames = append(podNames, pod.Name) |
| 87 | + } |
| 88 | + log.Infof("[PreCheck]: Target pods list for chaos, %v", podNames) |
| 89 | + |
| 90 | + // Check if the targeted pods have the chaos monkey endpoint |
| 91 | + log.Infof("[PreCheck]: Checking for ChaosMonkey endpoint in target pods") |
| 92 | + if _, err := litmusLIB.CheckChaosMonkey(experimentsDetails.ChaosMonkeyPort, experimentsDetails.ChaosMonkeyPath, experimentsDetails.TargetPodList); err != nil { |
| 93 | + log.Errorf("Some target pods don't have the chaos monkey endpoint, err: %v", err) |
| 94 | + failStep := "[pre-chaos]: Some target pods don't have the chaos monkey endpoint, err: " + err.Error() |
| 95 | + types.SetEngineEventAttributes(&eventsDetails, types.PreChaosCheck, "ChaosMonkey: Not Found", "Warning", &chaosDetails) |
| 96 | + _ = events.GenerateEvents(&eventsDetails, clients, &chaosDetails, "ChaosEngine") |
| 97 | + result.RecordAfterFailure(&chaosDetails, &resultDetails, failStep, clients, &eventsDetails) |
| 98 | + return |
| 99 | + } |
| 100 | + |
| 101 | + //PRE-CHAOS APPLICATION STATUS CHECK |
| 102 | + if chaosDetails.DefaultHealthCheck { |
| 103 | + log.Info("[Status]: Verify that the AUT (Application Under Test) is running (pre-chaos)") |
| 104 | + if err := status.AUTStatusCheck(experimentsDetails.AppNS, experimentsDetails.AppLabel, experimentsDetails.TargetContainer, experimentsDetails.Timeout, experimentsDetails.Delay, clients, &chaosDetails); err != nil { |
| 105 | + log.Errorf("Application status check failed, err: %v", err) |
| 106 | + failStep := "[pre-chaos]: Failed to verify that the AUT (Application Under Test) is in running state, err: " + err.Error() |
| 107 | + types.SetEngineEventAttributes(&eventsDetails, types.PreChaosCheck, "AUT: Not Running", "Warning", &chaosDetails) |
| 108 | + _ = events.GenerateEvents(&eventsDetails, clients, &chaosDetails, "ChaosEngine") |
| 109 | + result.RecordAfterFailure(&chaosDetails, &resultDetails, failStep, clients, &eventsDetails) |
| 110 | + return |
| 111 | + } |
| 112 | + } |
| 113 | + |
| 114 | + if experimentsDetails.EngineName != "" { |
| 115 | + // marking AUT as running, as we already checked the status of application under test |
| 116 | + msg := "AUT: Running" |
| 117 | + |
| 118 | + // run the probes in the pre-chaos check |
| 119 | + if len(resultDetails.ProbeDetails) != 0 { |
| 120 | + if err := probe.RunProbes(&chaosDetails, clients, &resultDetails, "PreChaos", &eventsDetails); err != nil { |
| 121 | + log.Errorf("Probe Failed, err: %v", err) |
| 122 | + failStep := "[pre-chaos]: Failed while running probes, err: " + err.Error() |
| 123 | + msg := "AUT: Running, Probes: Unsuccessful" |
| 124 | + types.SetEngineEventAttributes(&eventsDetails, types.PreChaosCheck, msg, "Warning", &chaosDetails) |
| 125 | + _ = events.GenerateEvents(&eventsDetails, clients, &chaosDetails, "ChaosEngine") |
| 126 | + result.RecordAfterFailure(&chaosDetails, &resultDetails, failStep, clients, &eventsDetails) |
| 127 | + return |
| 128 | + } |
| 129 | + msg = "AUT: Running, Probes: Successful" |
| 130 | + } |
| 131 | + // generating the events for the pre-chaos check |
| 132 | + types.SetEngineEventAttributes(&eventsDetails, types.PreChaosCheck, msg, "Normal", &chaosDetails) |
| 133 | + _ = events.GenerateEvents(&eventsDetails, clients, &chaosDetails, "ChaosEngine") |
| 134 | + } |
| 135 | + |
| 136 | + // Including the litmus lib |
| 137 | + switch experimentsDetails.ChaosLib { |
| 138 | + case "litmus": |
| 139 | + if err := litmusLIB.PrepareChaos(&experimentsDetails, clients, &resultDetails, &eventsDetails, &chaosDetails); err != nil { |
| 140 | + log.Errorf("Chaos injection failed, err: %v", err) |
| 141 | + failStep := "[chaos]: Failed inside the chaoslib, err: " + err.Error() |
| 142 | + result.RecordAfterFailure(&chaosDetails, &resultDetails, failStep, clients, &eventsDetails) |
| 143 | + return |
| 144 | + } |
| 145 | + default: |
| 146 | + log.Error("[Invalid]: Please Provide the correct LIB") |
| 147 | + failStep := "[chaos]: no match found for specified lib" |
| 148 | + result.RecordAfterFailure(&chaosDetails, &resultDetails, failStep, clients, &eventsDetails) |
| 149 | + return |
| 150 | + } |
| 151 | + |
| 152 | + log.Infof("[Confirmation]: %v chaos has been injected successfully", experimentsDetails.ExperimentName) |
| 153 | + resultDetails.Verdict = v1alpha1.ResultVerdictPassed |
| 154 | + |
| 155 | + // POST-CHAOS APPLICATION STATUS CHECK |
| 156 | + if chaosDetails.DefaultHealthCheck { |
| 157 | + log.Info("[Status]: Verify that the AUT (Application Under Test) is running (post-chaos)") |
| 158 | + if err := status.AUTStatusCheck(experimentsDetails.AppNS, experimentsDetails.AppLabel, experimentsDetails.TargetContainer, experimentsDetails.Timeout, experimentsDetails.Delay, clients, &chaosDetails); err != nil { |
| 159 | + log.Errorf("Application status check failed, err: %v", err) |
| 160 | + failStep := "[post-chaos]: Failed to verify that the AUT (Application Under Test) is running, err: " + err.Error() |
| 161 | + types.SetEngineEventAttributes(&eventsDetails, types.PostChaosCheck, "AUT: Not Running", "Warning", &chaosDetails) |
| 162 | + _ = events.GenerateEvents(&eventsDetails, clients, &chaosDetails, "ChaosEngine") |
| 163 | + result.RecordAfterFailure(&chaosDetails, &resultDetails, failStep, clients, &eventsDetails) |
| 164 | + return |
| 165 | + } |
| 166 | + } |
| 167 | + |
| 168 | + if experimentsDetails.EngineName != "" { |
| 169 | + // marking AUT as running, as we already checked the status of application under test |
| 170 | + msg := "AUT: Running" |
| 171 | + |
| 172 | + // run the probes in the post-chaos check |
| 173 | + if len(resultDetails.ProbeDetails) != 0 { |
| 174 | + if err := probe.RunProbes(&chaosDetails, clients, &resultDetails, "PostChaos", &eventsDetails); err != nil { |
| 175 | + log.Errorf("Probes Failed, err: %v", err) |
| 176 | + failStep := "[post-chaos]: Failed while running probes, err: " + err.Error() |
| 177 | + msg := "AUT: Running, Probes: Unsuccessful" |
| 178 | + types.SetEngineEventAttributes(&eventsDetails, types.PostChaosCheck, msg, "Warning", &chaosDetails) |
| 179 | + _ = events.GenerateEvents(&eventsDetails, clients, &chaosDetails, "ChaosEngine") |
| 180 | + result.RecordAfterFailure(&chaosDetails, &resultDetails, failStep, clients, &eventsDetails) |
| 181 | + return |
| 182 | + } |
| 183 | + msg = "AUT: Running, Probes: Successful" |
| 184 | + } |
| 185 | + |
| 186 | + // generating post chaos event |
| 187 | + types.SetEngineEventAttributes(&eventsDetails, types.PostChaosCheck, msg, "Normal", &chaosDetails) |
| 188 | + _ = events.GenerateEvents(&eventsDetails, clients, &chaosDetails, "ChaosEngine") |
| 189 | + } |
| 190 | + |
| 191 | + //Updating the chaosResult in the end of experiment |
| 192 | + log.Infof("[The End]: Updating the chaos result of %v experiment (EOT)", experimentsDetails.ExperimentName) |
| 193 | + if err := result.ChaosResult(&chaosDetails, clients, &resultDetails, "EOT"); err != nil { |
| 194 | + log.Errorf("Unable to Update the Chaos Result, err: %v", err) |
| 195 | + return |
| 196 | + } |
| 197 | + |
| 198 | + // generating the event in chaosResult to mark the verdict as pass/fail |
| 199 | + msg = "experiment: " + experimentsDetails.ExperimentName + ", Result: " + string(resultDetails.Verdict) |
| 200 | + reason := types.PassVerdict |
| 201 | + eventType := "Normal" |
| 202 | + if resultDetails.Verdict != "Pass" { |
| 203 | + reason = types.FailVerdict |
| 204 | + eventType = "Warning" |
| 205 | + } |
| 206 | + types.SetResultEventAttributes(&eventsDetails, reason, msg, eventType, &resultDetails) |
| 207 | + _ = events.GenerateEvents(&eventsDetails, clients, &chaosDetails, "ChaosResult") |
| 208 | + |
| 209 | + if experimentsDetails.EngineName != "" { |
| 210 | + msg := experimentsDetails.ExperimentName + " experiment has been " + string(resultDetails.Verdict) + "ed" |
| 211 | + types.SetEngineEventAttributes(&eventsDetails, types.Summary, msg, "Normal", &chaosDetails) |
| 212 | + _ = events.GenerateEvents(&eventsDetails, clients, &chaosDetails, "ChaosEngine") |
| 213 | + } |
| 214 | +} |
0 commit comments