github.com/minio/minio@v0.0.0-20240328213742-3f72439b8a27/internal/bucket/lifecycle/filter_test.go

// Copyright (c) 2015-2021 MinIO, Inc.
//
// This file is part of MinIO Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

package lifecycle

import (
	"encoding/xml"
	"fmt"
	"testing"

	"github.com/dustin/go-humanize"
)

// TestUnsupportedFilters checks if parsing Filter xml with
// unsupported elements returns appropriate errors
func TestUnsupportedFilters(t *testing.T) {
	testCases := []struct {
		inputXML    string
		expectedErr error
	}{
		{ // Filter with And tags
			inputXML: ` <Filter>
						<And>
							<Prefix>key-prefix</Prefix>
						</And>
						</Filter>`,
			expectedErr: errXMLNotWellFormed,
		},
		{ // Filter with Tag tags
			inputXML: ` <Filter>
						<Tag>
							<Key>key1</Key>
							<Value>value1</Value>
						</Tag>
						</Filter>`,
			expectedErr: nil,
		},
		{ // Filter with Prefix tag
			inputXML: ` <Filter>
							<Prefix>key-prefix</Prefix>
						</Filter>`,
			expectedErr: nil,
		},
		{ // Filter without And and multiple Tag tags
			inputXML: ` <Filter>
							<Prefix>key-prefix</Prefix>
							<Tag>
								<Key>key1</Key>
								<Value>value1</Value>
							</Tag>
							<Tag>
								<Key>key2</Key>
								<Value>value2</Value>
							</Tag>
						</Filter>`,
			expectedErr: errInvalidFilter,
		},
		{ // Filter with And, Prefix & multiple Tag tags
			inputXML: ` <Filter>
							<And>
							<Prefix>key-prefix</Prefix>
							<Tag>
								<Key>key1</Key>
								<Value>value1</Value>
							</Tag>
							<Tag>
								<Key>key2</Key>
								<Value>value2</Value>
							</Tag>
							</And>
						</Filter>`,
			expectedErr: nil,
		},
		{ // Filter with And and multiple Tag tags
			inputXML: ` <Filter>
							<And>
							<Prefix></Prefix>
							<Tag>
								<Key>key1</Key>
								<Value>value1</Value>
							</Tag>
							<Tag>
								<Key>key2</Key>
								<Value>value2</Value>
							</Tag>
							</And>
						</Filter>`,
			expectedErr: nil,
		},
		{ // Filter without And and single Tag tag
			inputXML: ` <Filter>
							<Prefix>key-prefix</Prefix>
							<Tag>
								<Key>key1</Key>
								<Value>value1</Value>
							</Tag>
						</Filter>`,
			expectedErr: errInvalidFilter,
		},
	}
	for i, tc := range testCases {
		t.Run(fmt.Sprintf("Test %d", i+1), func(t *testing.T) {
			var filter Filter
			err := xml.Unmarshal([]byte(tc.inputXML), &filter)
			if err != nil {
				t.Fatalf("%d: Expected no error but got %v", i+1, err)
			}
			err = filter.Validate()
			if err != tc.expectedErr {
				t.Fatalf("%d: Expected %v but got %v", i+1, tc.expectedErr, err)
			}
		})
	}
}

func TestObjectSizeFilters(t *testing.T) {
	f1 := Filter{
		set: true,
		Prefix: Prefix{
			string: "doc/",
			set:    true,
			Unused: struct{}{},
		},
		ObjectSizeGreaterThan: 100 * humanize.MiByte,
		ObjectSizeLessThan:    100 * humanize.GiByte,
	}
	b, err := xml.Marshal(f1)
	if err != nil {
		t.Fatalf("Failed to marshal %v", f1)
	}
	var f2 Filter
	err = xml.Unmarshal(b, &f2)
	if err != nil {
		t.Fatalf("Failed to unmarshal %s", string(b))
	}
	if f1.ObjectSizeLessThan != f2.ObjectSizeLessThan {
		t.Fatalf("Expected %v but got %v", f1.ObjectSizeLessThan, f2.And.ObjectSizeLessThan)
	}
	if f1.ObjectSizeGreaterThan != f2.ObjectSizeGreaterThan {
		t.Fatalf("Expected %v but got %v", f1.ObjectSizeGreaterThan, f2.And.ObjectSizeGreaterThan)
	}

	f1 = Filter{
		set: true,
		And: And{
			ObjectSizeGreaterThan: 100 * humanize.MiByte,
			ObjectSizeLessThan:    1 * humanize.GiByte,
			Prefix:                Prefix{},
		},
		andSet: true,
	}
	b, err = xml.Marshal(f1)
	if err != nil {
		t.Fatalf("Failed to marshal %v", f1)
	}
	f2 = Filter{}
	err = xml.Unmarshal(b, &f2)
	if err != nil {
		t.Fatalf("Failed to unmarshal %s", string(b))
	}
	if f1.And.ObjectSizeLessThan != f2.And.ObjectSizeLessThan {
		t.Fatalf("Expected %v but got %v", f1.And.ObjectSizeLessThan, f2.And.ObjectSizeLessThan)
	}
	if f1.And.ObjectSizeGreaterThan != f2.And.ObjectSizeGreaterThan {
		t.Fatalf("Expected %v but got %v", f1.And.ObjectSizeGreaterThan, f2.And.ObjectSizeGreaterThan)
	}

	fiGt := Filter{
		ObjectSizeGreaterThan: 1 * humanize.MiByte,
	}
	fiLt := Filter{
		ObjectSizeLessThan: 100 * humanize.MiByte,
	}
	fiLtAndGt := Filter{
		And: And{
			ObjectSizeGreaterThan: 1 * humanize.MiByte,
			ObjectSizeLessThan:    100 * humanize.MiByte,
		},
	}

	tests := []struct {
		filter  Filter
		objSize int64
		want    bool
	}{
		{
			filter:  fiLt,
			objSize: 101 * humanize.MiByte,
			want:    false,
		},
		{
			filter:  fiLt,
			objSize: 99 * humanize.MiByte,
			want:    true,
		},
		{
			filter:  fiGt,
			objSize: 1*humanize.MiByte - 1,
			want:    false,
		},
		{
			filter:  fiGt,
			objSize: 1*humanize.MiByte + 1,
			want:    true,
		},
		{
			filter:  fiLtAndGt,
			objSize: 1*humanize.MiByte - 1,
			want:    false,
		},
		{
			filter:  fiLtAndGt,
			objSize: 2 * humanize.MiByte,
			want:    true,
		},
		{
			filter:  fiLtAndGt,
			objSize: 100*humanize.MiByte + 1,
			want:    false,
		},
	}
	for i, test := range tests {
		t.Run(fmt.Sprintf("Test %d", i+1), func(t *testing.T) {
			if got := test.filter.BySize(test.objSize); got != test.want {
				t.Fatalf("Expected %v but got %v", test.want, got)
			}
		})
	}
}

func TestTestTags(t *testing.T) {
	noTags := Filter{
		set: true,
		And: And{
			Tags: []Tag{},
		},
		andSet: true,
	}

	oneTag := Filter{
		set: true,
		And: And{
			Tags: []Tag{{Key: "FOO", Value: "1"}},
		},
		andSet: true,
	}

	twoTags := Filter{
		set: true,
		And: And{
			Tags: []Tag{{Key: "FOO", Value: "1"}, {Key: "BAR", Value: "2"}},
		},
		andSet: true,
	}

	tests := []struct {
		filter   Filter
		userTags string
		want     bool
	}{
		{
			filter:   noTags,
			userTags: "",
			want:     true,
		},
		{
			filter:   noTags,
			userTags: "A=3",
			want:     true,
		},
		{
			filter:   oneTag,
			userTags: "A=3",
			want:     false,
		},
		{
			filter:   oneTag,
			userTags: "FOO=1",
			want:     true,
		},
		{
			filter:   oneTag,
			userTags: "A=B&FOO=1",
			want:     true,
		},
		{
			filter:   twoTags,
			userTags: "",
			want:     false,
		},
		{
			filter:   twoTags,
			userTags: "FOO=1",
			want:     false,
		},
		{
			filter:   twoTags,
			userTags: "BAR=2",
			want:     false,
		},
		{
			filter:   twoTags,
			userTags: "FOO=2&BAR=2",
			want:     false,
		},
		{
			filter:   twoTags,
			userTags: "F=1&B=2",
			want:     false,
		},
		{
			filter:   twoTags,
			userTags: "FOO=1&BAR=2",
			want:     true,
		},
		{
			filter:   twoTags,
			userTags: "BAR=2&FOO=1",
			want:     true,
		},
	}
	for i, test := range tests {
		t.Run(fmt.Sprintf("Test %d", i+1), func(t *testing.T) {
			if got := test.filter.TestTags(test.userTags); got != test.want {
				t.Errorf("Expected %v but got %v", test.want, got)
			}
		})
	}
}