@@ -42,14 +42,16 @@ type xychart struct {
4242}
4343
4444type githubSummary struct {
45- client api.Client
46- Pods []string
45+ client api.Client
46+ Pods []string
47+ alertsFiring bool
4748}
4849
4950func NewSummary (c api.Client , pods ... string ) githubSummary {
5051 return githubSummary {
51- client : c ,
52- Pods : pods ,
52+ client : c ,
53+ Pods : pods ,
54+ alertsFiring : false ,
5355 }
5456}
5557
@@ -60,7 +62,7 @@ func NewSummary(c api.Client, pods ...string) githubSummary {
6062// yLabel - Label of the Y axis i.e. "KB/s", "MB", etc.
6163// scaler - Constant by which to scale the results. For instance, cpu usage is more human-readable
6264// as "mCPU" vs "CPU", so we scale the results by a factor of 1,000.
63- func (s githubSummary ) PerformanceQuery (title , pod , query string , yLabel string , scaler float64 ) (string , error ) {
65+ func (s * githubSummary ) PerformanceQuery (title , pod , query , yLabel string , scaler float64 ) (string , error ) {
6466 v1api := v1 .NewAPI (s .client )
6567 ctx , cancel := context .WithTimeout (context .Background (), 10 * time .Second )
6668 defer cancel ()
@@ -90,8 +92,9 @@ func (s githubSummary) PerformanceQuery(title, pod, query string, yLabel string,
9092 formattedData := make ([]string , 0 )
9193 // matrix does not allow [] access, so we just do one iteration for the single result
9294 for _ , metric := range matrix {
93- if len (metric .Values ) < 1 {
94- return "" , fmt .Errorf ("expected at least one data point; got: %d" , len (metric .Values ))
95+ if len (metric .Values ) < 2 {
96+ // A graph with one data point means something with the collection was wrong
97+ return "" , fmt .Errorf ("expected at least two data points; got: %d" , len (metric .Values ))
9598 }
9699 for _ , sample := range metric .Values {
97100 floatSample := float64 (sample .Value ) * scaler
@@ -115,7 +118,7 @@ func (s githubSummary) PerformanceQuery(title, pod, query string, yLabel string,
115118
116119// Alerts queries the prometheus server for alerts and generates markdown output for anything found.
117120// If no alerts are found, the alerts section will contain only "None." in the final output.
118- func (s githubSummary ) Alerts () (string , error ) {
121+ func (s * githubSummary ) Alerts () (string , error ) {
119122 v1api := v1 .NewAPI (s .client )
120123 ctx , cancel := context .WithTimeout (context .Background (), 10 * time .Second )
121124 defer cancel ()
@@ -136,6 +139,7 @@ func (s githubSummary) Alerts() (string, error) {
136139 switch a .State {
137140 case v1 .AlertStateFiring :
138141 firingAlerts = append (firingAlerts , aConv )
142+ s .alertsFiring = true
139143 case v1 .AlertStatePending :
140144 pendingAlerts = append (pendingAlerts , aConv )
141145 // Ignore AlertStateInactive; the alerts endpoint doesn't return them
@@ -172,28 +176,34 @@ func executeTemplate(templateFile string, obj any) (string, error) {
172176// The markdown is template-driven; the summary methods are called from within the
173177// template. This allows us to add or change queries (hopefully) without needing to
174178// touch code. The summary will be output to a file supplied by the env target.
175- func PrintSummary (envTarget string ) error {
179+ func PrintSummary (path string ) error {
180+ if path == "" {
181+ fmt .Printf ("No summary output path specified; skipping" )
182+ return nil
183+ }
184+
176185 client , err := api .NewClient (api.Config {
177186 Address : defaultPromUrl ,
178187 })
179188 if err != nil {
180- fmt .Printf ("Error creating prometheus client: %v\n " , err )
181- os . Exit ( 1 )
189+ fmt .Printf ("warning: failed to initialize promQL client: %v" , err )
190+ return nil
182191 }
183192
184193 summary := NewSummary (client , "operator-controller" , "catalogd" )
185- summaryMarkdown , err := executeTemplate (summaryTemplate , summary )
194+ summaryMarkdown , err := executeTemplate (summaryTemplate , & summary )
186195 if err != nil {
187- return err
196+ fmt .Printf ("warning: failed to generate e2e test summary: %v" , err )
197+ return nil
188198 }
189- if path : =os .Getenv ( envTarget ); path != "" {
190- err = os . WriteFile ( path , [] byte ( summaryMarkdown ), 0o600 )
191- if err != nil {
192- return err
193- }
194- fmt .Printf ("Test summary output to %s successful\n " , envTarget )
195- } else {
196- fmt .Printf ( "No summary output specified; skipping "
199+ err = os .WriteFile ( path , [] byte ( summaryMarkdown ), 0o600 )
200+ if err != nil {
201+ fmt . Printf ( "warning: failed to write e2e test summary output to %s: %v" , path , err )
202+ return nil
203+ }
204+ fmt .Printf ("Test summary output to %s successful\n " , path )
205+ if summary . alertsFiring {
206+ return fmt .Errorf ( "performance alerts encountered during test run; please check e2e test summary for details "
197207 }
198208 return nil
199209}
0 commit comments