brotli_test.go

package archives

import (
	"bytes"
	"context"
	"fmt"
	"testing"
)

func TestBrotli_Match_Stream(t *testing.T) {
	testTxt := []byte("this is text, but it has to be long enough to match brotli which doesn't have a magic number")
	type testcase struct {
		name    string
		input   []byte
		matches bool
	}

	testCases := []testcase{
		{
			name:    "uncompressed yaml",
			input:   []byte("---\nthis-is-not-brotli: \"it is actually yaml\""),
			matches: false,
		},
		{
			name:    "uncompressed text",
			input:   testTxt,
			matches: false,
		},
	}

	// Test all quality levels (0-11)
	for quality := 0; quality <= 11; quality++ {
		testCases = append(testCases, testcase{
			name:    fmt.Sprintf("text compressed with brotli quality %d", quality),
			input:   compress(t, ".br", testTxt, Brotli{Quality: quality}.OpenWriter),
			matches: true,
		})
	}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			r := bytes.NewBuffer(tc.input)

			mr, err := Brotli{}.Match(context.Background(), "", r)
			if err != nil {
				t.Errorf("Brotli.Match() error = %v", err)
				return
			}

			if mr.ByStream != tc.matches {
				t.Logf("input: %s", tc.input)
				t.Error("Brotli.Match() expected ByStream to be", tc.matches, "but got", mr.ByStream)
			}
		})
	}
}

func TestBrotli_Fuzzy_Both(t *testing.T) {
	// Use a deterministic seed for reproducible tests
	seed := int64(42)
	rng := &deterministicRNG{seed: seed}

	// Test both uncompressed ASCII and actual brotli compressed data
	numTests := 500
	for i := 0; i < numTests; i++ {
		// Generate random ASCII string of varying lengths
		length := rng.Intn(200) + 16
		asciiData := generateRandomASCII(rng, length)

		// Test uncompressed ASCII data (should not match)
		t.Run(fmt.Sprintf("ascii_%d", i), func(t *testing.T) {
			r := bytes.NewBuffer(asciiData)

			mr, err := Brotli{}.Match(context.Background(), "", r)
			if err != nil {
				t.Errorf("Brotli.Match() error = %v", err)
				return
			}

			if mr.ByStream {
				t.Errorf("Random ASCII data incorrectly detected as brotli compressed")
				t.Logf("Data: %q", string(asciiData))
				t.Logf("Length: %d", len(asciiData))
				t.Logf("Data bytes: %v", asciiData)
			}
		})

		// Test actual brotli compressed data (should match) - test all quality levels
		for quality := 0; quality <= 11; quality++ {
			t.Run(fmt.Sprintf("br_%d_q%d", i, quality), func(t *testing.T) {
				compressedData := compress(t, ".br", asciiData, Brotli{Quality: quality}.OpenWriter)

				r := bytes.NewBuffer(compressedData)

				mr, err := Brotli{}.Match(context.Background(), "", r)
				if err != nil {
					t.Errorf("Brotli.Match() error = %v", err)
					return
				}

				if !mr.ByStream {
					t.Errorf("Actual brotli compressed data not detected as compressed")
					t.Logf("Original data: %q", string(asciiData))
					t.Logf("Compressed length: %d", len(compressedData))
					t.Logf("Quality used: %d", quality)
					t.Logf("Compressed bytes: %v", compressedData[:min(32, len(compressedData))])
				}
			})
		}
	}
}

// min returns the minimum of two integers
func min(a, b int) int {
	if a < b {
		return a
	}
	return b
}

// deterministicRNG provides deterministic random numbers for testing
type deterministicRNG struct {
	seed int64
}

func (r *deterministicRNG) Intn(n int) int {
	r.seed = (r.seed*1103515245 + 12345) & 0x7fffffff
	return int(r.seed % int64(n))
}

// generateRandomASCII creates a random ASCII string with common whitespace characters
func generateRandomASCII(rng *deterministicRNG, length int) []byte {
	// ASCII printable chars + whitespace: tab, newline, space, etc.
	chars := []byte(" \t\n\r\v\fabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#$%^&*()_+-=[]{}|;':\",./<>?")

	result := make([]byte, length)
	for i := 0; i < length; i++ {
		result[i] = chars[rng.Intn(len(chars))]
	}
	return result
}

func TestBrotli_Match_SmallStreams(t *testing.T) {
	// Test very small streams that the original logic was designed to handle
	type smallStream struct {
		name string
		data []byte
	}

	smallStreams := []smallStream{
		{
			name: "empty stream",
			data: []byte{},
		},
		{
			name: "single byte",
			data: []byte{'A'},
		},
		{
			name: "two bytes",
			data: []byte{'A', 'B'},
		},
		{
			name: "three bytes",
			data: []byte{'A', 'B', 'C'},
		},
		{
			name: "four bytes",
			data: []byte{'A', 'B', 'C', 'D'},
		},
		{
			name: "small ASCII text (8 bytes)",
			data: []byte("Hello123"),
		},
		{
			name: "small ASCII text (16 bytes)",
			data: []byte("Hello world test"),
		},
		{
			name: "small mixed whitespace (8 bytes)",
			data: []byte("Hi\t\n\r\vx"),
		},
		{
			name: "small binary-like data (4 bytes)",
			data: []byte{0x00, 0x01, 0x02, 0x03},
		},
		{
			name: "small binary-like data (8 bytes)",
			data: []byte{0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07},
		},
		{
			name: "small binary-like data (16 bytes)",
			data: []byte{0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F},
		},
	}

	for _, ss := range smallStreams {
		// Test uncompressed version (should not match)
		t.Run(ss.name+"_uncompressed", func(t *testing.T) {
			r := bytes.NewBuffer(ss.data)

			mr, err := Brotli{}.Match(context.Background(), "", r)
			if err != nil {
				t.Errorf("Brotli.Match() error = %v", err)
				return
			}

			if mr.ByStream {
				t.Errorf("Uncompressed small stream incorrectly detected as brotli compressed")
				t.Logf("Input length: %d", len(ss.data))
				t.Logf("Input bytes: %v", ss.data)
				if len(ss.data) > 0 && len(ss.data) <= 32 {
					t.Logf("Input string: %q", string(ss.data))
				}
			}
		})

		// Test compressed versions across all quality levels (should match)
		// Skip empty stream compression as it's not meaningful
		if len(ss.data) > 0 {
			for quality := 0; quality <= 11; quality++ {
				t.Run(fmt.Sprintf("%s_brotli_q%d", ss.name, quality), func(t *testing.T) {
					compressedData := compress(t, ".br", ss.data, Brotli{Quality: quality}.OpenWriter)
					r := bytes.NewBuffer(compressedData)

					mr, err := Brotli{}.Match(context.Background(), "", r)
					if err != nil {
						t.Errorf("Brotli.Match() error = %v", err)
						return
					}

					if !mr.ByStream {
						t.Errorf("Compressed small stream not detected as brotli compressed")
						t.Logf("Original data length: %d", len(ss.data))
						t.Logf("Compressed data length: %d", len(compressedData))
						t.Logf("Quality: %d", quality)
						t.Logf("Original data: %v", ss.data)
						t.Logf("Compressed data: %v", compressedData[:min(32, len(compressedData))])
					}
				})
			}
		}
	}
}

func TestBrotli_Fuzzy_Binary(t *testing.T) {
	// Use a deterministic seed for reproducible tests
	seed := int64(123)
	rng := &deterministicRNG{seed: seed}

	// Test random binary data (should not match)
	numTests := 300
	for i := 0; i < numTests; i++ {
		// Generate random binary data of varying lengths
		length := rng.Intn(500) + 500
		binaryData := generateRandomBinary(rng, length)

		// Test uncompressed binary data (should not match)
		t.Run(fmt.Sprintf("binary_%d", i), func(t *testing.T) {
			r := bytes.NewBuffer(binaryData)

			mr, err := Brotli{}.Match(context.Background(), "", r)
			if err != nil {
				t.Errorf("Brotli.Match() error = %v", err)
				return
			}

			if mr.ByStream {
				t.Errorf("Random binary data incorrectly detected as brotli compressed")
				t.Logf("Data length: %d", len(binaryData))
				t.Logf("First 32 bytes: %v", binaryData[:min(32, len(binaryData))])
			}
		})

		// Test actual brotli compressed binary data (should match) - test all quality levels
		for quality := 0; quality <= 11; quality++ {
			t.Run(fmt.Sprintf("binary_br_%d_q%d", i, quality), func(t *testing.T) {
				compressedData := compress(t, ".br", binaryData, Brotli{Quality: quality}.OpenWriter)

				r := bytes.NewBuffer(compressedData)

				mr, err := Brotli{}.Match(context.Background(), "", r)
				if err != nil {
					t.Errorf("Brotli.Match() error = %v", err)
					return
				}

				if !mr.ByStream {
					t.Errorf("Actual brotli compressed binary data not detected as compressed")
					t.Logf("Original binary length: %d", len(binaryData))
					t.Logf("Compressed length: %d", len(compressedData))
					t.Logf("Quality used: %d", quality)
					t.Logf("Original first 32 bytes: %v", binaryData[:min(32, len(binaryData))])
					t.Logf("Compressed first 32 bytes: %v", compressedData[:min(32, len(compressedData))])
				}
			})
		}
	}
}

// generateRandomBinary creates random binary data with all possible byte values
func generateRandomBinary(rng *deterministicRNG, length int) []byte {
	result := make([]byte, length)
	for i := 0; i < length; i++ {
		// Generate all possible byte values (0-255)
		result[i] = byte(rng.Intn(256))
	}
	return result
}

// test case for https://github.com/mholt/archives/issues/36
// fetch file with:
// `curl https://github.com/bufbuild/buf/releases/download/v1.54.0/buf-Darwin-arm64 -o testdata/buf-Darwin-arm64`
// func TestBrotliDetection(t *testing.T) {
// 	testFile := "testdata/buf-Darwin-arm64"

// 	// Open the test file
// 	file, err := os.Open(testFile)
// 	if err != nil {
// 		t.Fatalf("failed to open test file %s: %v", testFile, err)
// 	}
// 	defer file.Close()

// 	// Create a brotli format instance
// 	br := Brotli{Quality: 6}

// 	// Test matching by stream
// 	matchResult, err := br.Match(context.Background(), testFile, file)
// 	if err != nil {
// 		t.Fatalf("Match failed: %v", err)
// 	}

// 	// The file should not be detected as brotli by name (no .br extension)
// 	if matchResult.ByName {
// 		t.Error("File should not be detected as brotli by name (no .br extension)")
// 	}

// 	// The file should not be detected as brotli by stream content
// 	if matchResult.ByStream {
// 		t.Error("File should not be detected as brotli by stream content")
// 	}
// }