src/internal/zstd/zstd_test.go

   1 // Copyright 2023 The Go Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style
   3 // license that can be found in the LICENSE file.
   4
   5 package zstd
   6
   7 import (
   8         "bytes"
   9         "fmt"
  10         "internal/race"
  11         "internal/testenv"
  12         "io"
  13         "os"
  14         "os/exec"
  15         "strings"
  16         "sync"
  17         "testing"
  18 )
  19
  20 // tests holds some simple test cases, including some found by fuzzing.
  21 var tests = []struct {
  22         name, uncompressed, compressed string
  23 }{
  24         {
  25                 "hello",
  26                 "hello, world\n",
  27                 "\x28\xb5\x2f\xfd\x24\x0d\x69\x00\x00\x68\x65\x6c\x6c\x6f\x2c\x20\x77\x6f\x72\x6c\x64\x0a\x4c\x1f\xf9\xf1",
  28         },
  29         {
  30                 // a small compressed .debug_ranges section.
  31                 "ranges",
  32                 "\xcc\x11\x00\x00\x00\x00\x00\x00\xd5\x13\x00\x00\x00\x00\x00\x00" +
  33                         "\x1c\x14\x00\x00\x00\x00\x00\x00\x72\x14\x00\x00\x00\x00\x00\x00" +
  34                         "\x9d\x14\x00\x00\x00\x00\x00\x00\xd5\x14\x00\x00\x00\x00\x00\x00" +
  35                         "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" +
  36                         "\xfb\x12\x00\x00\x00\x00\x00\x00\x09\x13\x00\x00\x00\x00\x00\x00" +
  37                         "\x0c\x13\x00\x00\x00\x00\x00\x00\xcb\x13\x00\x00\x00\x00\x00\x00" +
  38                         "\x29\x14\x00\x00\x00\x00\x00\x00\x4e\x14\x00\x00\x00\x00\x00\x00" +
  39                         "\x9d\x14\x00\x00\x00\x00\x00\x00\xd5\x14\x00\x00\x00\x00\x00\x00" +
  40                         "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" +
  41                         "\xfb\x12\x00\x00\x00\x00\x00\x00\x09\x13\x00\x00\x00\x00\x00\x00" +
  42                         "\x67\x13\x00\x00\x00\x00\x00\x00\xcb\x13\x00\x00\x00\x00\x00\x00" +
  43                         "\x9d\x14\x00\x00\x00\x00\x00\x00\xd5\x14\x00\x00\x00\x00\x00\x00" +
  44                         "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" +
  45                         "\x5f\x0b\x00\x00\x00\x00\x00\x00\x6c\x0b\x00\x00\x00\x00\x00\x00" +
  46                         "\x7d\x0b\x00\x00\x00\x00\x00\x00\x7e\x0c\x00\x00\x00\x00\x00\x00" +
  47                         "\x38\x0f\x00\x00\x00\x00\x00\x00\x5c\x0f\x00\x00\x00\x00\x00\x00" +
  48                         "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" +
  49                         "\x83\x0c\x00\x00\x00\x00\x00\x00\xfa\x0c\x00\x00\x00\x00\x00\x00" +
  50                         "\xfd\x0d\x00\x00\x00\x00\x00\x00\xef\x0e\x00\x00\x00\x00\x00\x00" +
  51                         "\x14\x0f\x00\x00\x00\x00\x00\x00\x38\x0f\x00\x00\x00\x00\x00\x00" +
  52                         "\x9f\x0f\x00\x00\x00\x00\x00\x00\xac\x0f\x00\x00\x00\x00\x00\x00" +
  53                         "\xdb\x0f\x00\x00\x00\x00\x00\x00\xff\x0f\x00\x00\x00\x00\x00\x00" +
  54                         "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" +
  55                         "\xfd\x0d\x00\x00\x00\x00\x00\x00\xd8\x0e\x00\x00\x00\x00\x00\x00" +
  56                         "\x9f\x0f\x00\x00\x00\x00\x00\x00\xac\x0f\x00\x00\x00\x00\x00\x00" +
  57                         "\xdb\x0f\x00\x00\x00\x00\x00\x00\xff\x0f\x00\x00\x00\x00\x00\x00" +
  58                         "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" +
  59                         "\xfa\x0c\x00\x00\x00\x00\x00\x00\xea\x0d\x00\x00\x00\x00\x00\x00" +
  60                         "\xef\x0e\x00\x00\x00\x00\x00\x00\x14\x0f\x00\x00\x00\x00\x00\x00" +
  61                         "\x5c\x0f\x00\x00\x00\x00\x00\x00\x9f\x0f\x00\x00\x00\x00\x00\x00" +
  62                         "\xac\x0f\x00\x00\x00\x00\x00\x00\xdb\x0f\x00\x00\x00\x00\x00\x00" +
  63                         "\xff\x0f\x00\x00\x00\x00\x00\x00\x2c\x10\x00\x00\x00\x00\x00\x00" +
  64                         "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" +
  65                         "\x60\x11\x00\x00\x00\x00\x00\x00\xd1\x16\x00\x00\x00\x00\x00\x00" +
  66                         "\x40\x0b\x00\x00\x00\x00\x00\x00\x2c\x10\x00\x00\x00\x00\x00\x00" +
  67                         "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" +
  68                         "\x7a\x00\x00\x00\x00\x00\x00\x00\xb6\x00\x00\x00\x00\x00\x00\x00" +
  69                         "\x9f\x01\x00\x00\x00\x00\x00\x00\xa7\x01\x00\x00\x00\x00\x00\x00" +
  70                         "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" +
  71                         "\x7a\x00\x00\x00\x00\x00\x00\x00\xa9\x00\x00\x00\x00\x00\x00\x00" +
  72                         "\x9f\x01\x00\x00\x00\x00\x00\x00\xa7\x01\x00\x00\x00\x00\x00\x00" +
  73                         "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00",
  74
  75                 "\x28\xb5\x2f\xfd\x64\xa0\x01\x2d\x05\x00\xc4\x04\xcc\x11\x00\xd5" +
  76                         "\x13\x00\x1c\x14\x00\x72\x9d\xd5\xfb\x12\x00\x09\x0c\x13\xcb\x13" +
  77                         "\x29\x4e\x67\x5f\x0b\x6c\x0b\x7d\x0b\x7e\x0c\x38\x0f\x5c\x0f\x83" +
  78                         "\x0c\xfa\x0c\xfd\x0d\xef\x0e\x14\x38\x9f\x0f\xac\x0f\xdb\x0f\xff" +
  79                         "\x0f\xd8\x9f\xac\xdb\xff\xea\x5c\x2c\x10\x60\xd1\x16\x40\x0b\x7a" +
  80                         "\x00\xb6\x00\x9f\x01\xa7\x01\xa9\x36\x20\xa0\x83\x14\x34\x63\x4a" +
  81                         "\x21\x70\x8c\x07\x46\x03\x4e\x10\x62\x3c\x06\x4e\xc8\x8c\xb0\x32" +
  82                         "\x2a\x59\xad\xb2\xf1\x02\x82\x7c\x33\xcb\x92\x6f\x32\x4f\x9b\xb0" +
  83                         "\xa2\x30\xf0\xc0\x06\x1e\x98\x99\x2c\x06\x1e\xd8\xc0\x03\x56\xd8" +
  84                         "\xc0\x03\x0f\x6c\xe0\x01\xf1\xf0\xee\x9a\xc6\xc8\x97\x99\xd1\x6c" +
  85                         "\xb4\x21\x45\x3b\x10\xe4\x7b\x99\x4d\x8a\x36\x64\x5c\x77\x08\x02" +
  86                         "\xcb\xe0\xce",
  87         },
  88         {
  89                 "fuzz1",
  90                 "0\x00\x00\x00\x00\x000\x00\x00\x00\x00\x001\x00\x00\x00\x00\x000000",
  91                 "(\xb5/\xfd\x04X\x8d\x00\x00P0\x000\x001\x000000\x03T\x02\x00\x01\x01m\xf9\xb7G",
  92         },
  93 }
  94
  95 func TestSamples(t *testing.T) {
  96         for _, test := range tests {
  97                 test := test
  98                 t.Run(test.name, func(t *testing.T) {
  99                         r := NewReader(strings.NewReader(test.compressed))
 100                         got, err := io.ReadAll(r)
 101                         if err != nil {
 102                                 t.Fatal(err)
 103                         }
 104                         gotstr := string(got)
 105                         if gotstr != test.uncompressed {
 106                                 t.Errorf("got %q want %q", gotstr, test.uncompressed)
 107                         }
 108                 })
 109         }
 110 }
 111
 112 var (
 113         bigDataOnce  sync.Once
 114         bigDataBytes []byte
 115         bigDataErr   error
 116 )
 117
 118 // bigData returns the contents of our large test file repeated multiple times.
 119 func bigData(t testing.TB) []byte {
 120         bigDataOnce.Do(func() {
 121                 bigDataBytes, bigDataErr = os.ReadFile("../../testdata/Isaac.Newton-Opticks.txt")
 122                 if bigDataErr == nil {
 123                         bigDataBytes = bytes.Repeat(bigDataBytes, 3)
 124                 }
 125         })
 126         if bigDataErr != nil {
 127                 t.Fatal(bigDataErr)
 128         }
 129         return bigDataBytes
 130 }
 131
 132 var (
 133         zstdBigOnce  sync.Once
 134         zstdBigBytes []byte
 135         zstdBigSkip  bool
 136         zstdBigErr   error
 137 )
 138
 139 // zstdBigData returns the compressed contents of our large test file.
 140 // This will only run on Unix systems with zstd installed.
 141 // That's OK as the package is GOOS-independent.
 142 func zstdBigData(t testing.TB) []byte {
 143         input := bigData(t)
 144
 145         zstdBigOnce.Do(func() {
 146                 if _, err := os.Stat("/usr/bin/zstd"); err != nil {
 147                         zstdBigSkip = true
 148                         return
 149                 }
 150
 151                 cmd := exec.Command("/usr/bin/zstd", "-z")
 152                 cmd.Stdin = bytes.NewReader(input)
 153                 var compressed bytes.Buffer
 154                 cmd.Stdout = &compressed
 155                 cmd.Stderr = os.Stderr
 156                 if err := cmd.Run(); err != nil {
 157                         zstdBigErr = fmt.Errorf("running zstd failed: %v", err)
 158                         return
 159                 }
 160
 161                 zstdBigBytes = compressed.Bytes()
 162         })
 163         if zstdBigSkip {
 164                 t.Skip("skipping because /usr/bin/zstd does not exist")
 165         }
 166         if zstdBigErr != nil {
 167                 t.Fatal(zstdBigErr)
 168         }
 169         return zstdBigBytes
 170 }
 171
 172 // Test decompressing a large file. We don't have a compressor,
 173 // so this test only runs on systems with zstd installed.
 174 func TestLarge(t *testing.T) {
 175         if testing.Short() {
 176                 t.Skip("skipping expensive test in short mode")
 177         }
 178
 179         data := bigData(t)
 180         compressed := zstdBigData(t)
 181
 182         t.Logf("/usr/bin/zstd compressed %d bytes to %d", len(data), len(compressed))
 183
 184         r := NewReader(bytes.NewReader(compressed))
 185         got, err := io.ReadAll(r)
 186         if err != nil {
 187                 t.Fatal(err)
 188         }
 189
 190         if !bytes.Equal(got, data) {
 191                 showDiffs(t, got, data)
 192         }
 193 }
 194
 195 // showDiffs reports the first few differences in two []byte.
 196 func showDiffs(t *testing.T, got, want []byte) {
 197         t.Error("data mismatch")
 198         if len(got) != len(want) {
 199                 t.Errorf("got data length %d, want %d", len(got), len(want))
 200         }
 201         diffs := 0
 202         for i, b := range got {
 203                 if i >= len(want) {
 204                         break
 205                 }
 206                 if b != want[i] {
 207                         diffs++
 208                         if diffs > 20 {
 209                                 break
 210                         }
 211                         t.Logf("%d: %#x != %#x", i, b, want[i])
 212                 }
 213         }
 214 }
 215
 216 func TestAlloc(t *testing.T) {
 217         testenv.SkipIfOptimizationOff(t)
 218         if race.Enabled {
 219                 t.Skip("skipping allocation test under race detector")
 220         }
 221
 222         compressed := zstdBigData(t)
 223         input := bytes.NewReader(compressed)
 224         r := NewReader(input)
 225         c := testing.AllocsPerRun(10, func() {
 226                 input.Reset(compressed)
 227                 r.Reset(input)
 228                 io.Copy(io.Discard, r)
 229         })
 230         if c != 0 {
 231                 t.Errorf("got %v allocs, want 0", c)
 232         }
 233 }
 234
 235 func BenchmarkLarge(b *testing.B) {
 236         b.StopTimer()
 237         b.ReportAllocs()
 238
 239         compressed := zstdBigData(b)
 240
 241         b.SetBytes(int64(len(compressed)))
 242
 243         input := bytes.NewReader(compressed)
 244         r := NewReader(input)
 245
 246         b.StartTimer()
 247         for i := 0; i < b.N; i++ {
 248                 input.Reset(compressed)
 249                 r.Reset(input)
 250                 io.Copy(io.Discard, r)
 251         }
 252 }