data_test.go

// Copyright 2013 The imageproxy authors.
// SPDX-License-Identifier: Apache-2.0

package imageproxy

import (
	"fmt"
	"net/http"
	"net/url"
	"testing"
)

var emptyOptions = Options{}

func TestOptions_String(t *testing.T) {
	tests := []struct {
		Options Options
		String  string
	}{
		{
			emptyOptions,
			"0x0",
		},
		{
			Options{Width: 1, Height: 2, Fit: true, Rotate: 90, FlipVertical: true, FlipHorizontal: true, Quality: 80},
			"1x2,fh,fit,fv,q80,r90",
		},
		{
			Options{Width: 0.15, Height: 1.3, Rotate: 45, Quality: 95, Signature: "c0ffee", Format: "png"},
			"0.15x1.3,png,q95,r45,sc0ffee",
		},
		{
			Options{Width: 0.15, Height: 1.3, CropX: 100, CropY: 200},
			"0.15x1.3,cx100,cy200",
		},
		{
			Options{ScaleUp: true, CropX: 100, CropY: 200, CropWidth: 300, CropHeight: 400, SmartCrop: true},
			"0x0,ch400,cw300,cx100,cy200,sc,scaleUp",
		},
	}

	for i, tt := range tests {
		if got, want := tt.Options.String(), tt.String; got != want {
			t.Errorf("%d. Options.String returned %v, want %v", i, got, want)
		}
	}
}

func TestParseOptions(t *testing.T) {
	tests := []struct {
		Input   string
		Options Options
	}{
		{"", emptyOptions},
		{"x", emptyOptions},
		{"r", emptyOptions},
		{"0", emptyOptions},
		{",,,,", emptyOptions},

		// size variations
		{"1x", Options{Width: 1}},
		{"x1", Options{Height: 1}},
		{"1x2", Options{Width: 1, Height: 2}},
		{"-1x-2", Options{Width: -1, Height: -2}},
		{"0.1x0.2", Options{Width: 0.1, Height: 0.2}},
		{"1", Options{Width: 1, Height: 1}},
		{"0.1", Options{Width: 0.1, Height: 0.1}},

		// additional flags
		{"fit", Options{Fit: true}},
		{"r90", Options{Rotate: 90}},
		{"fv", Options{FlipVertical: true}},
		{"fh", Options{FlipHorizontal: true}},
		{"jpeg", Options{Format: "jpeg"}},

		// duplicate flags (last one wins)
		{"1x2,3x4", Options{Width: 3, Height: 4}},
		{"1x2,3", Options{Width: 3, Height: 3}},
		{"1x2,0x3", Options{Width: 0, Height: 3}},
		{"1x,x2", Options{Width: 1, Height: 2}},
		{"r90,r270", Options{Rotate: 270}},
		{"jpeg,png", Options{Format: "png"}},

		// mix of valid and invalid flags
		{"FOO,1,BAR,r90,BAZ", Options{Width: 1, Height: 1, Rotate: 90}},

		// flags, in different orders
		{"q70,1x2,fit,r90,fv,fh,sc0ffee,png", Options{Width: 1, Height: 2, Fit: true, Rotate: 90, FlipVertical: true, FlipHorizontal: true, Quality: 70, Signature: "c0ffee", Format: "png"}},
		{"r90,fh,sc0ffee,png,q90,1x2,fv,fit", Options{Width: 1, Height: 2, Fit: true, Rotate: 90, FlipVertical: true, FlipHorizontal: true, Quality: 90, Signature: "c0ffee", Format: "png"}},
		{"cx100,cw300,1x2,cy200,ch400,sc,scaleUp", Options{Width: 1, Height: 2, ScaleUp: true, CropX: 100, CropY: 200, CropWidth: 300, CropHeight: 400, SmartCrop: true}},
	}

	for _, tt := range tests {
		if got, want := ParseOptions(tt.Input), tt.Options; got != want {
			t.Errorf("ParseOptions(%q) returned %#v, want %#v", tt.Input, got, want)
		}
	}
}

// Test that request URLs are properly parsed into Options and RemoteURL.  This
// test verifies that invalid remote URLs throw errors, and that valid
// combinations of Options and URL are accept.  This does not exhaustively test
// the various Options that can be specified; see TestParseOptions for that.
func TestNewRequest(t *testing.T) {
	tests := []struct {
		URL         string  // input URL to parse as an imageproxy request
		RemoteURL   string  // expected URL of remote image parsed from input
		Options     Options // expected options parsed from input
		ExpectError bool    // whether an error is expected from NewRequest
	}{
		// invalid URLs
		{"http://localhost/", "", emptyOptions, true},
		{"http://localhost/1/", "", emptyOptions, true},
		{"http://localhost//example.com/foo", "", emptyOptions, true},
		{"http://localhost//ftp://example.com/foo", "", emptyOptions, true},

		// invalid options.  These won't return errors, but will not fully parse the options
		{
			"http://localhost/s/http://example.com/",
			"http://example.com/", emptyOptions, false,
		},
		{
			"http://localhost/1xs/http://example.com/",
			"http://example.com/", Options{Width: 1}, false,
		},

		// valid URLs
		{
			"http://localhost/http://example.com/foo",
			"http://example.com/foo", emptyOptions, false,
		},
		{
			"http://localhost//http://example.com/foo",
			"http://example.com/foo", emptyOptions, false,
		},
		{
			"http://localhost//https://example.com/foo",
			"https://example.com/foo", emptyOptions, false,
		},
		{
			"http://localhost/1x2/http://example.com/foo",
			"http://example.com/foo", Options{Width: 1, Height: 2}, false,
		},
		{
			"http://localhost//http://example.com/foo?bar",
			"http://example.com/foo?bar", emptyOptions, false,
		},
		{
			"http://localhost/http:/example.com/foo",
			"http://example.com/foo", emptyOptions, false,
		},
		{
			"http://localhost/http:///example.com/foo",
			"http://example.com/foo", emptyOptions, false,
		},
		{ // escaped path
			"http://localhost/http://example.com/%2C",
			"http://example.com/%2C", emptyOptions, false,
		},
		{ // fix http:// has escaped
			"http://localhost/http%3A//example.com/foo",
			"http://example.com/foo", emptyOptions, false,
		},
	}

	for _, tt := range tests {
		req, err := http.NewRequest("GET", tt.URL, nil)
		if err != nil {
			t.Errorf("http.NewRequest(%q) returned error: %v", tt.URL, err)
			continue
		}

		r, err := NewRequest(req, nil, nil, "")
		if tt.ExpectError {
			if err == nil {
				t.Errorf("NewRequest(%v) did not return expected error", req)
			}
			continue
		} else if err != nil {
			t.Errorf("NewRequest(%v) return unexpected error: %v", req, err)
			continue
		}

		if got, want := r.URL.String(), tt.RemoteURL; got != want {
			t.Errorf("NewRequest(%q) request URL = %v, want %v", tt.URL, got, want)
		}
		if got, want := r.Options, tt.Options; got != want {
			t.Errorf("NewRequest(%q) request options = %v, want %v", tt.URL, got, want)
		}
	}
}

func TestNewRequest_BaseURL(t *testing.T) {
	req, _ := http.NewRequest("GET", "/x/path", nil)
	base, _ := url.Parse("https://example.com/")

	r, err := NewRequest(req, base, nil, "")
	if err != nil {
		t.Errorf("NewRequest(%v, %v) returned unexpected error: %v", req, base, err)
	}

	want := "https://example.com/path#0x0"
	if got := r.String(); got != want {
		t.Errorf("NewRequest(%v, %v) returned %q, want %q", req, base, got, want)
	}
}

func TestNewRequest_DefaultTransform(t *testing.T) {
	var defaultOptions = Options{
		Width:  640,
		Height: 480,
	}
	tests := []struct {
		URL         string  // input URL to parse as an imageproxy request
		RemoteURL   string  // expected URL of remote image parsed from input
		Options     Options // expected options parsed from input
		ExpectError bool    // whether an error is expected from NewRequest
	}{
		// invalid URLs
		{"http://localhost/", "", emptyOptions, true},
		{"http://localhost/1/", "", emptyOptions, true},
		{"http://localhost//example.com/foo", "", emptyOptions, true},
		{"http://localhost//ftp://example.com/foo", "", emptyOptions, true},

		// invalid options.  These won't return errors, but will not fully parse the options
		{
			"http://localhost/s/http://example.com/",
			"http://example.com/", emptyOptions, false,
		},
		{
			"http://localhost/1xs/http://example.com/",
			"http://example.com/", Options{Width: 1}, false,
		},

		// valid URLs
		{
			"http://localhost/http://example.com/foo",
			"http://example.com/foo", defaultOptions, false,
		},
		{
			"http://localhost//http://example.com/foo",
			"http://example.com/foo", defaultOptions, false,
		},
		{
			"http://localhost//https://example.com/foo",
			"https://example.com/foo", defaultOptions, false,
		},
		{
			"http://localhost/1x2/http://example.com/foo",
			"http://example.com/foo", Options{Width: 1, Height: 2}, false,
		},
	}

	for _, tt := range tests {
		req, err := http.NewRequest("GET", tt.URL, nil)
		if err != nil {
			t.Errorf("http.NewRequest(%q) returned error: %v", tt.URL, err)
			continue
		}

		r, err := NewRequest(req, nil, nil, "640x480")
		if tt.ExpectError {
			if err == nil {
				t.Errorf("NewRequest(%v) did not return expected error", req)
			}
			continue
		} else if err != nil {
			t.Errorf("NewRequest(%v) return unexpected error: %v", req, err)
			continue
		}

		if got, want := r.URL.String(), tt.RemoteURL; got != want {
			t.Errorf("NewRequest(%q) request URL = %v, want %v", tt.URL, got, want)
		}
		if got, want := r.Options, tt.Options; got != want {
			t.Errorf("NewRequest(%q) request options = %v, want %v", tt.URL, got, want)
		}
	}
}

func TestNewRequest_AllowTransforms(t *testing.T) {
	var allowTransforms = []string{"200x", "100x150"}
	base, _ := url.Parse("https://example.com/")

	for _, transform := range allowTransforms {
		req, _ := http.NewRequest("GET", fmt.Sprintf("/%s/path", transform), nil)

		_, err := NewRequest(req, base, allowTransforms, "")
		if err != nil {
			t.Errorf("NewRequest(%v, %v) returned unexpected error: %v", req, base, err)
		}
	}

	req, _ := http.NewRequest("GET", "/300/path", nil)
	_, err := NewRequest(req, base, allowTransforms, "")
	if err == nil {
		t.Errorf("NewRequest(%v, %v) returned expect error", req, base)
	}

	req, _ = http.NewRequest("GET", "/200x200/path", nil)
	_, err = NewRequest(req, base, allowTransforms, "")
	if err == nil {
		t.Errorf("NewRequest(%v, %v) returned expect error", req, base)
	}
}

func Test_base64DecodeRawQuery(t *testing.T) {
	newPath, _, changed := base64DecodeRawQuery("/foo/bar.jpg?a=1")
	if changed {
		t.Errorf("Expect no change")
	}
	if newPath != "/foo/bar.jpg?a=1" {
		t.Errorf("Expect return same")
	}

	newPath, _, changed = base64DecodeRawQuery("https://google.com/foo/bar.jpg?a=1")
	if changed {
		t.Errorf("Expect no change")
	}
	if newPath != "https://google.com/foo/bar.jpg?a=1" {
		t.Errorf("Expect return same")
	}

	path := "https://foo.com/image/Z2V0P2NvZGU9TkRRME9UYzNPR00yTWpWaE5HRTNNR0psTVRobU5tTTRPREJtWldKbU1tSXNNVFl5T1RVek5UTTFPVEkzTXclM0QlM0Q="
	newPath, _, changed = base64DecodeRawQuery(path)
	if changed {
		t.Errorf("Expect no change")
	}
	if path != newPath {
		t.Errorf("Expect return same")
	}

	path = "https://foo.com/2021/07/16/e47ae22d9d558b2e149a33f95d5c98af.png/query-aW1hZ2VWaWV3Mi8yL3cvMTEyMC9xLzkwL2ludGVybGFjZS8xL2lnbm9yZS1lcnJvci8x"
	out, rawQuery, changed := base64DecodeRawQuery(path)
	if !changed {
		t.Errorf("Expect change")
	}
	if out != "https://foo.com/2021/07/16/e47ae22d9d558b2e149a33f95d5c98af.png" {
		t.Errorf("Error got %s", out)
	}
	if rawQuery != "imageView2/2/w/1120/q/90/interlace/1/ignore-error/1" {
		t.Errorf("Error got %s", rawQuery)
	}

	path = "https://p1-tt.byteimg.com/origin/pgc-image/75c0212c48374e93809ed2b6f58994a3/query-ZnJvbT1wYw"
	out, rawQuery, changed = base64DecodeRawQuery(path)
	if !changed {
		t.Errorf("Expect change")
	}
	if out != "https://p1-tt.byteimg.com/origin/pgc-image/75c0212c48374e93809ed2b6f58994a3" {
		t.Errorf("Error got %s", out)
	}
	if rawQuery != "from=pc" {
		t.Errorf("Error got %s", rawQuery)
	}
}