|
| 1 | +/* |
| 2 | +Copyright 2023. |
| 3 | +
|
| 4 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +you may not use this file except in compliance with the License. |
| 6 | +You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | +Unless required by applicable law or agreed to in writing, software |
| 11 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +See the License for the specific language governing permissions and |
| 14 | +limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +package support |
| 18 | + |
| 19 | +import ( |
| 20 | + "bytes" |
| 21 | + "fmt" |
| 22 | + |
| 23 | + "github.com/onsi/gomega" |
| 24 | + corev1 "k8s.io/api/core/v1" |
| 25 | + eventsv1 "k8s.io/api/events/v1" |
| 26 | + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| 27 | +) |
| 28 | + |
| 29 | +// Based on https://github.com/apache/incubator-kie-kogito-operator/blob/28b2d3dc945e48659b199cca33723568b848f72e/test/pkg/framework/logging.go |
| 30 | + |
| 31 | +const ( |
| 32 | + eventLastSeenKey = "LAST_SEEN" |
| 33 | + eventFirstSeenKey = "FIRST_SEEN" |
| 34 | + eventNameKey = "NAME" |
| 35 | + eventSubObjectKey = "SUBOBJECT" |
| 36 | + eventTypeKey = "TYPE" |
| 37 | + eventReasonKey = "REASON" |
| 38 | + eventMessageKey = "MESSAGE" |
| 39 | + |
| 40 | + eventLogFileName = "events" |
| 41 | +) |
| 42 | + |
| 43 | +var eventKeys = []string{ |
| 44 | + eventLastSeenKey, |
| 45 | + eventFirstSeenKey, |
| 46 | + eventNameKey, |
| 47 | + eventSubObjectKey, |
| 48 | + eventTypeKey, |
| 49 | + eventReasonKey, |
| 50 | + eventMessageKey, |
| 51 | +} |
| 52 | + |
| 53 | +func StoreEvents(t Test, namespace *corev1.Namespace) { |
| 54 | + t.T().Helper() |
| 55 | + |
| 56 | + events, err := t.Client().Core().EventsV1().Events(namespace.Name).List(t.Ctx(), metav1.ListOptions{}) |
| 57 | + t.Expect(err).NotTo(gomega.HaveOccurred()) |
| 58 | + |
| 59 | + bytes, err := renderEventContent(eventKeys, mapEventsToKeys(events)) |
| 60 | + t.Expect(err).NotTo(gomega.HaveOccurred()) |
| 61 | + |
| 62 | + WriteToOutputDir(t, eventLogFileName, Log, bytes) |
| 63 | +} |
| 64 | + |
| 65 | +func mapEventsToKeys(eventList *eventsv1.EventList) []map[string]string { |
| 66 | + eventMaps := []map[string]string{} |
| 67 | + |
| 68 | + for _, event := range eventList.Items { |
| 69 | + eventMap := make(map[string]string) |
| 70 | + eventMap[eventLastSeenKey] = getDefaultEventValueIfNull(event.DeprecatedLastTimestamp.Format("2006-01-02 15:04:05")) |
| 71 | + eventMap[eventFirstSeenKey] = getDefaultEventValueIfNull(event.DeprecatedFirstTimestamp.Format("2006-01-02 15:04:05")) |
| 72 | + eventMap[eventNameKey] = getDefaultEventValueIfNull(event.GetName()) |
| 73 | + eventMap[eventSubObjectKey] = getDefaultEventValueIfNull(event.Regarding.FieldPath) |
| 74 | + eventMap[eventTypeKey] = getDefaultEventValueIfNull(event.Type) |
| 75 | + eventMap[eventReasonKey] = getDefaultEventValueIfNull(event.Reason) |
| 76 | + eventMap[eventMessageKey] = getDefaultEventValueIfNull(event.Note) |
| 77 | + |
| 78 | + eventMaps = append(eventMaps, eventMap) |
| 79 | + } |
| 80 | + return eventMaps |
| 81 | +} |
| 82 | + |
| 83 | +func getDefaultEventValueIfNull(value string) string { |
| 84 | + if len(value) <= 0 { |
| 85 | + return "-" |
| 86 | + } |
| 87 | + return value |
| 88 | +} |
| 89 | + |
| 90 | +func renderEventContent(keys []string, dataMaps []map[string]string) ([]byte, error) { |
| 91 | + var content bytes.Buffer |
| 92 | + // Get size of strings to be written, to be able to format correctly |
| 93 | + maxStringSizeMap := make(map[string]int) |
| 94 | + for _, key := range keys { |
| 95 | + maxSize := len(key) |
| 96 | + for _, dataMap := range dataMaps { |
| 97 | + if len(dataMap[key]) > maxSize { |
| 98 | + maxSize = len(dataMap[key]) |
| 99 | + } |
| 100 | + } |
| 101 | + maxStringSizeMap[key] = maxSize |
| 102 | + } |
| 103 | + |
| 104 | + // Write headers |
| 105 | + for _, header := range keys { |
| 106 | + if _, err := content.WriteString(header); err != nil { |
| 107 | + return nil, fmt.Errorf("error in writing the header: %v", err) |
| 108 | + } |
| 109 | + if _, err := content.WriteString(getWhitespaceStr(maxStringSizeMap[header] - len(header) + 1)); err != nil { |
| 110 | + return nil, fmt.Errorf("error in writing headers: %v", err) |
| 111 | + } |
| 112 | + if _, err := content.WriteString(" | "); err != nil { |
| 113 | + return nil, fmt.Errorf("error in writing headers : %v", err) |
| 114 | + } |
| 115 | + } |
| 116 | + if _, err := content.WriteString("\n"); err != nil { |
| 117 | + return nil, fmt.Errorf("error in writing headers '|': %v", err) |
| 118 | + |
| 119 | + } |
| 120 | + |
| 121 | + // Write events |
| 122 | + for _, dataMap := range dataMaps { |
| 123 | + for _, key := range keys { |
| 124 | + if _, err := content.WriteString(dataMap[key]); err != nil { |
| 125 | + return nil, fmt.Errorf("error in writing events: %v", err) |
| 126 | + } |
| 127 | + if _, err := content.WriteString(getWhitespaceStr(maxStringSizeMap[key] - len(dataMap[key]) + 1)); err != nil { |
| 128 | + return nil, fmt.Errorf("error in writing events: %v", err) |
| 129 | + } |
| 130 | + if _, err := content.WriteString(" | "); err != nil { |
| 131 | + return nil, fmt.Errorf("error in writing events: %v", err) |
| 132 | + } |
| 133 | + } |
| 134 | + if _, err := content.WriteString("\n"); err != nil { |
| 135 | + return nil, fmt.Errorf("error in writing events: %v", err) |
| 136 | + } |
| 137 | + } |
| 138 | + return content.Bytes(), nil |
| 139 | +} |
| 140 | + |
| 141 | +func getWhitespaceStr(size int) string { |
| 142 | + whiteSpaceStr := "" |
| 143 | + for i := 0; i < size; i++ { |
| 144 | + whiteSpaceStr += " " |
| 145 | + } |
| 146 | + return whiteSpaceStr |
| 147 | +} |
0 commit comments