|
| 1 | +package state |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "os" |
| 6 | + "path/filepath" |
| 7 | + "slices" |
| 8 | + "testing" |
| 9 | + "time" |
| 10 | +) |
| 11 | + |
| 12 | +func unreadableBucket(at time.Time, v float64) metricBucket { |
| 13 | + return metricBucket{Driver: "meter", Metric: "grid_w", BucketSummary: BucketSummary{StartMS: at.UnixMilli(), ResolutionMS: ArchiveResolutionMS, FirstMS: at.UnixMilli(), LastMS: at.UnixMilli() + 1000, N: 1, Sum: v, Min: v, Max: v, Last: v}} |
| 14 | +} |
| 15 | + |
| 16 | +// unreadableColdFixture opens a store the way main.go does, with the same |
| 17 | +// cold folder for reads and for the boot import, so runtime readers see |
| 18 | +// whatever the import leaves behind. |
| 19 | +func unreadableColdFixture(t *testing.T) (*Store, string, time.Time) { |
| 20 | + t.Helper() |
| 21 | + s := freshStore(t) |
| 22 | + if err := s.EnableHistoryAggregation(); err != nil { |
| 23 | + t.Fatal(err) |
| 24 | + } |
| 25 | + cold := t.TempDir() |
| 26 | + s.coldDir = cold |
| 27 | + return s, cold, time.Now().UTC().Add(-40 * 24 * time.Hour).Truncate(24 * time.Hour) |
| 28 | +} |
| 29 | + |
| 30 | +func dayFile(t *testing.T, cold string, day time.Time, suffix string) string { |
| 31 | + t.Helper() |
| 32 | + path := filepath.Join(cold, day.Format("2006/01"), day.Format("02")+suffix) |
| 33 | + if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil { |
| 34 | + t.Fatal(err) |
| 35 | + } |
| 36 | + return path |
| 37 | +} |
| 38 | + |
| 39 | +func assertFile(t *testing.T, path string, want bool) { |
| 40 | + t.Helper() |
| 41 | + _, err := os.Stat(path) |
| 42 | + if want && err != nil { |
| 43 | + t.Fatalf("%s must stay: %v", path, err) |
| 44 | + } |
| 45 | + if !want && !os.IsNotExist(err) { |
| 46 | + t.Fatalf("%s must be gone: %v", path, err) |
| 47 | + } |
| 48 | +} |
| 49 | + |
| 50 | +func listedUnreadable(s *Store) []string { |
| 51 | + listed, _ := s.HistoryBackend()["unreadable_cold_files"].([]string) |
| 52 | + return listed |
| 53 | +} |
| 54 | + |
| 55 | +// One damaged bucket day must not stop boot-time absorb of the other days. |
| 56 | +// main.go exits on an AbsorbColdHistory error, and the file would stay, so |
| 57 | +// every restart would fail the same way. The kept file must also leave the |
| 58 | +// day's history reads working. |
| 59 | +func TestAbsorbColdHistorySkipsUnreadableBucketFile(t *testing.T) { |
| 60 | + damage := map[string]func(t *testing.T, path string){ |
| 61 | + "truncated": func(t *testing.T, path string) { |
| 62 | + info, err := os.Stat(path) |
| 63 | + if err != nil { |
| 64 | + t.Fatal(err) |
| 65 | + } |
| 66 | + if err := os.Truncate(path, info.Size()/2); err != nil { |
| 67 | + t.Fatal(err) |
| 68 | + } |
| 69 | + }, |
| 70 | + "no read permission": func(t *testing.T, path string) { |
| 71 | + if os.Geteuid() == 0 { |
| 72 | + t.Skip("root reads files without permission") |
| 73 | + } |
| 74 | + if err := os.Chmod(path, 0); err != nil { |
| 75 | + t.Fatal(err) |
| 76 | + } |
| 77 | + t.Cleanup(func() { _ = os.Chmod(path, 0o644); _ = os.Chmod(path+unreadableColdSuffix, 0o644) }) |
| 78 | + }, |
| 79 | + } |
| 80 | + for name, spoil := range damage { |
| 81 | + t.Run(name, func(t *testing.T) { |
| 82 | + s, cold, good := unreadableColdFixture(t) |
| 83 | + bad := good.Add(24 * time.Hour) |
| 84 | + hour := good.Add(3 * time.Hour) |
| 85 | + badHour := bad.Add(5 * time.Hour) |
| 86 | + goodPath := dayFile(t, cold, good, ".buckets.parquet") |
| 87 | + badPath := dayFile(t, cold, bad, ".buckets.parquet") |
| 88 | + legacyPath := dayFile(t, cold, bad, ".legacy-buckets.parquet") |
| 89 | + if err := writeTestBuckets(goodPath, []metricBucket{unreadableBucket(hour, 10)}); err != nil { |
| 90 | + t.Fatal(err) |
| 91 | + } |
| 92 | + if err := writeTestBuckets(badPath, []metricBucket{unreadableBucket(bad, 5)}); err != nil { |
| 93 | + t.Fatal(err) |
| 94 | + } |
| 95 | + spoil(t, badPath) |
| 96 | + // The older copy of the damaged day is readable and serves it. |
| 97 | + if err := writeTestBuckets(legacyPath, []metricBucket{unreadableBucket(badHour, 7)}); err != nil { |
| 98 | + t.Fatal(err) |
| 99 | + } |
| 100 | + |
| 101 | + for boot := 1; boot <= 2; boot++ { |
| 102 | + if err := s.AbsorbColdHistory(context.Background(), cold); err != nil { |
| 103 | + t.Fatalf("boot %d: AbsorbColdHistory: %v", boot, err) |
| 104 | + } |
| 105 | + assertFile(t, goodPath, false) |
| 106 | + assertFile(t, badPath, false) |
| 107 | + assertFile(t, badPath+unreadableColdSuffix, true) |
| 108 | + assertFile(t, legacyPath, true) |
| 109 | + if want := bad.Format("2006/01/02") + ".buckets.parquet" + unreadableColdSuffix; !slices.Equal(listedUnreadable(s), []string{want}) { |
| 110 | + t.Fatalf("boot %d: unreadable_cold_files = %v, want [%s]", boot, listedUnreadable(s), want) |
| 111 | + } |
| 112 | + for _, want := range []struct { |
| 113 | + at time.Time |
| 114 | + v float64 |
| 115 | + }{{hour, 10}, {badHour, 7}} { |
| 116 | + points, err := s.LoadSeriesBucketsOrRaw("meter", "grid_w", want.at.UnixMilli(), want.at.UnixMilli()+HistoryHourResolutionMS-1, 0) |
| 117 | + if err != nil || len(points) != 1 || points[0].V != want.v { |
| 118 | + t.Fatalf("boot %d: hour %s = %+v, %v; want one point of %v", boot, want.at, points, err, want.v) |
| 119 | + } |
| 120 | + } |
| 121 | + from, to := good.UnixMilli(), bad.Add(48*time.Hour).UnixMilli() |
| 122 | + for _, maxPoints := range []int{0, 200} { |
| 123 | + for _, metric := range []string{"grid_w", "other_w"} { |
| 124 | + if _, err := s.LoadSeriesBucketsOrRaw("meter", metric, from, to, maxPoints); err != nil { |
| 125 | + t.Fatalf("boot %d: %s range over the damaged day, maxPoints=%d: %v", boot, metric, maxPoints, err) |
| 126 | + } |
| 127 | + } |
| 128 | + } |
| 129 | + now := time.Now() |
| 130 | + if _, err := s.LoadSeriesBuckets("meter", "grid_w", now.Add(-365*24*time.Hour).UnixMilli(), now.UnixMilli(), 365); err != nil { |
| 131 | + t.Fatalf("boot %d: year chart: %v", boot, err) |
| 132 | + } |
| 133 | + } |
| 134 | + }) |
| 135 | + } |
| 136 | +} |
| 137 | + |
| 138 | +// An operator who puts back a good copy of the damaged file must get a |
| 139 | +// clean boot. Had the legacy copy imported the same hour, the restored file |
| 140 | +// would conflict with it and stop boot again. |
| 141 | +func TestAbsorbColdHistoryImportsRestoredBucketFile(t *testing.T) { |
| 142 | + s, cold, day := unreadableColdFixture(t) |
| 143 | + at := day.Add(2 * time.Hour) |
| 144 | + orig := dayFile(t, cold, day, ".buckets.parquet") |
| 145 | + legacy := dayFile(t, cold, day, ".legacy-buckets.parquet") |
| 146 | + full := []metricBucket{unreadableBucket(at, 3), unreadableBucket(at.Add(time.Minute), 4)} |
| 147 | + if err := writeTestBuckets(orig, full); err != nil { |
| 148 | + t.Fatal(err) |
| 149 | + } |
| 150 | + good, err := os.ReadFile(orig) |
| 151 | + if err != nil { |
| 152 | + t.Fatal(err) |
| 153 | + } |
| 154 | + if err := os.Truncate(orig, int64(len(good)/2)); err != nil { |
| 155 | + t.Fatal(err) |
| 156 | + } |
| 157 | + if err := writeTestBuckets(legacy, full[:1]); err != nil { |
| 158 | + t.Fatal(err) |
| 159 | + } |
| 160 | + if err := s.AbsorbColdHistory(context.Background(), cold); err != nil { |
| 161 | + t.Fatalf("first boot: %v", err) |
| 162 | + } |
| 163 | + if err := os.Remove(orig + unreadableColdSuffix); err != nil { |
| 164 | + t.Fatal(err) |
| 165 | + } |
| 166 | + if err := os.WriteFile(orig, good, 0o644); err != nil { |
| 167 | + t.Fatal(err) |
| 168 | + } |
| 169 | + if err := s.AbsorbColdHistory(context.Background(), cold); err != nil { |
| 170 | + t.Fatalf("boot after restoring the file: %v", err) |
| 171 | + } |
| 172 | + assertFile(t, orig, false) |
| 173 | + assertFile(t, legacy, false) |
| 174 | + if listed := listedUnreadable(s); len(listed) != 0 { |
| 175 | + t.Fatalf("unreadable_cold_files = %v after recovery", listed) |
| 176 | + } |
| 177 | + points, err := s.LoadSeriesBucketsOrRaw("meter", "grid_w", at.UnixMilli(), at.UnixMilli()+HistoryHourResolutionMS-1, 0) |
| 178 | + if err != nil || len(points) != 1 || points[0].N != 2 { |
| 179 | + t.Fatalf("restored hour = %+v, %v; want one point from both minutes", points, err) |
| 180 | + } |
| 181 | +} |
0 commit comments