/* * MinIO Cloud Storage, (C) 2019 MinIO, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package lifecycle import ( "bytes" "encoding/xml" "fmt" "testing" "time" ) func TestParseAndValidateLifecycleConfig(t *testing.T) { // Test for lifecycle config with more than 1000 rules var manyRules []Rule for i := 0; i < 1001; i++ { rule := Rule{ ID: fmt.Sprintf("toManyRule%d", i), Status: "Enabled", Expiration: Expiration{Days: ExpirationDays(i)}, } manyRules = append(manyRules, rule) } manyRuleLcConfig, err := xml.Marshal(Lifecycle{Rules: manyRules}) if err != nil { t.Fatal("Failed to marshal lifecycle config with more than 1000 rules") } // Test for lifecycle config with rules containing overlapping prefixes rule1 := Rule{ ID: "rule1", Status: "Enabled", Expiration: Expiration{Days: ExpirationDays(3)}, Filter: Filter{ Prefix: "/a/b", }, } rule2 := Rule{ ID: "rule2", Status: "Enabled", Expiration: Expiration{Days: ExpirationDays(3)}, Filter: Filter{ And: And{ Prefix: "/a/b/c", }, }, } overlappingRules := []Rule{rule1, rule2} overlappingLcConfig, err := xml.Marshal(Lifecycle{Rules: overlappingRules}) if err != nil { t.Fatal("Failed to marshal lifecycle config with rules having overlapping prefix") } // Test for lifecycle rules with duplicate IDs rule3 := Rule{ ID: "duplicateID", Status: "Enabled", Expiration: Expiration{Days: ExpirationDays(3)}, Filter: Filter{ Prefix: "/a/b", }, } rule4 := Rule{ ID: "duplicateID", Status: "Enabled", Expiration: Expiration{Days: ExpirationDays(4)}, Filter: Filter{ And: And{ Prefix: "/x/z", }, }, } duplicateIDRules := []Rule{rule3, rule4} duplicateIDLcConfig, err := xml.Marshal(Lifecycle{Rules: duplicateIDRules}) if err != nil { t.Fatal("Failed to marshal lifecycle config of rules with duplicate ID.") } testCases := []struct { inputConfig string expectedParsingErr error expectedValidationErr error }{ { // Valid lifecycle config inputConfig: ` testRule1 prefix Enabled 3 testRule2 another-prefix Enabled 3 `, expectedParsingErr: nil, expectedValidationErr: nil, }, { // Valid lifecycle config inputConfig: ` key1val1key2val2 3 `, expectedParsingErr: errDuplicatedXMLTag, expectedValidationErr: nil, }, { // lifecycle config with no rules inputConfig: ` `, expectedParsingErr: nil, expectedValidationErr: errLifecycleNoRule, }, { // lifecycle config with more than 1000 rules inputConfig: string(manyRuleLcConfig), expectedParsingErr: nil, expectedValidationErr: errLifecycleTooManyRules, }, { // lifecycle config with rules having overlapping prefix inputConfig: string(overlappingLcConfig), expectedParsingErr: nil, expectedValidationErr: nil, }, { // lifecycle config with rules having duplicate ID inputConfig: string(duplicateIDLcConfig), expectedParsingErr: nil, expectedValidationErr: errLifecycleDuplicateID, }, } for i, tc := range testCases { t.Run(fmt.Sprintf("Test %d", i+1), func(t *testing.T) { lc, err := ParseLifecycleConfig(bytes.NewReader([]byte(tc.inputConfig))) if err != tc.expectedParsingErr { t.Fatalf("%d: Expected %v during parsing but got %v", i+1, tc.expectedParsingErr, err) } if tc.expectedParsingErr != nil { // We already expect a parsing error, // no need to continue this test. return } err = lc.Validate() if err != tc.expectedValidationErr { t.Fatalf("%d: Expected %v during parsing but got %v", i+1, tc.expectedValidationErr, err) } }) } } // TestMarshalLifecycleConfig checks if lifecycleconfig xml // marshaling/unmarshaling can handle output from each other func TestMarshalLifecycleConfig(t *testing.T) { // Time at midnight UTC midnightTS := ExpirationDate{time.Date(2019, time.April, 20, 0, 0, 0, 0, time.UTC)} lc := Lifecycle{ Rules: []Rule{ { Status: "Enabled", Filter: Filter{Prefix: "prefix-1"}, Expiration: Expiration{Days: ExpirationDays(3)}, }, { Status: "Enabled", Filter: Filter{Prefix: "prefix-1"}, Expiration: Expiration{Date: ExpirationDate(midnightTS)}, }, }, } b, err := xml.MarshalIndent(&lc, "", "\t") if err != nil { t.Fatal(err) } var lc1 Lifecycle err = xml.Unmarshal(b, &lc1) if err != nil { t.Fatal(err) } ruleSet := make(map[string]struct{}) for _, rule := range lc.Rules { ruleBytes, err := xml.Marshal(rule) if err != nil { t.Fatal(err) } ruleSet[string(ruleBytes)] = struct{}{} } for _, rule := range lc1.Rules { ruleBytes, err := xml.Marshal(rule) if err != nil { t.Fatal(err) } if _, ok := ruleSet[string(ruleBytes)]; !ok { t.Fatalf("Expected %v to be equal to %v, %v missing", lc, lc1, rule) } } } func TestExpectedExpiryTime(t *testing.T) { testCases := []struct { modTime time.Time days ExpirationDays expected time.Time }{ { time.Date(2020, time.March, 15, 10, 10, 10, 0, time.UTC), 4, time.Date(2020, time.March, 20, 0, 0, 0, 0, time.UTC), }, { time.Date(2020, time.March, 15, 0, 0, 0, 0, time.UTC), 1, time.Date(2020, time.March, 17, 0, 0, 0, 0, time.UTC), }, } for i, tc := range testCases { t.Run(fmt.Sprintf("Test %d", i+1), func(t *testing.T) { got := expectedExpiryTime(tc.modTime, tc.days) if got != tc.expected { t.Fatalf("Expected %v to be equal to %v", got, tc.expected) } }) } } func TestComputeActions(t *testing.T) { testCases := []struct { inputConfig string objectName string objectTags string objectModTime time.Time expectedAction Action }{ // Empty object name (unexpected case) should always return NoneAction { inputConfig: `prefixEnabled5`, expectedAction: NoneAction, }, // Disabled should always return NoneAction { inputConfig: `foodir/Disabled5`, objectName: "foodir/fooobject", objectModTime: time.Now().UTC().Add(-10 * 24 * time.Hour), // Created 10 days ago expectedAction: NoneAction, }, // No modTime, should be none-action { inputConfig: `foodir/Enabled5`, objectName: "foodir/fooobject", expectedAction: NoneAction, }, // Prefix not matched { inputConfig: `foodir/Enabled5`, objectName: "foxdir/fooobject", objectModTime: time.Now().UTC().Add(-10 * 24 * time.Hour), // Created 10 days ago expectedAction: NoneAction, }, // Test rule with empty prefix e.g. for whole bucket { inputConfig: `Enabled5`, objectName: "foxdir/fooobject/foo.txt", objectModTime: time.Now().UTC().Add(-10 * 24 * time.Hour), // Created 10 days ago expectedAction: DeleteAction, }, // Too early to remove (test Days) { inputConfig: `foodir/Enabled5`, objectName: "foxdir/fooobject", objectModTime: time.Now().UTC().Add(-10 * 24 * time.Hour), // Created 10 days ago expectedAction: NoneAction, }, // Should remove (test Days) { inputConfig: `foodir/Enabled5`, objectName: "foodir/fooobject", objectModTime: time.Now().UTC().Add(-6 * 24 * time.Hour), // Created 6 days ago expectedAction: DeleteAction, }, // Too early to remove (test Date) { inputConfig: `foodir/Enabled` + time.Now().UTC().Truncate(24*time.Hour).Add(24*time.Hour).Format(time.RFC3339) + ``, objectName: "foodir/fooobject", objectModTime: time.Now().UTC().Add(-24 * time.Hour), // Created 1 day ago expectedAction: NoneAction, }, // Should remove (test Days) { inputConfig: `foodir/Enabled` + time.Now().UTC().Truncate(24*time.Hour).Add(-24*time.Hour).Format(time.RFC3339) + ``, objectName: "foodir/fooobject", objectModTime: time.Now().UTC().Add(-24 * time.Hour), // Created 1 day ago expectedAction: DeleteAction, }, // Should remove (Tags match) { inputConfig: `foodir/tag1value1Enabled` + time.Now().UTC().Truncate(24*time.Hour).Add(-24*time.Hour).Format(time.RFC3339) + ``, objectName: "foodir/fooobject", objectTags: "tag1=value1&tag2=value2", objectModTime: time.Now().UTC().Add(-24 * time.Hour), // Created 1 day ago expectedAction: DeleteAction, }, // Should remove (Multiple Rules, Tags match) { inputConfig: `foodir/tag1value1tag2value2Enabled` + time.Now().Truncate(24*time.Hour).UTC().Add(-24*time.Hour).Format(time.RFC3339) + `abc/tag2valueEnabled` + time.Now().Truncate(24*time.Hour).UTC().Add(-24*time.Hour).Format(time.RFC3339) + ``, objectName: "foodir/fooobject", objectTags: "tag1=value1&tag2=value2", objectModTime: time.Now().UTC().Add(-24 * time.Hour), // Created 1 day ago expectedAction: DeleteAction, }, // Should remove (Tags match) { inputConfig: `foodir/tag1value1tag2value2Enabled` + time.Now().Truncate(24*time.Hour).UTC().Add(-24*time.Hour).Format(time.RFC3339) + ``, objectName: "foodir/fooobject", objectTags: "tag1=value1&tag2=value2", objectModTime: time.Now().UTC().Add(-24 * time.Hour), // Created 1 day ago expectedAction: DeleteAction, }, // Should remove (Tags match with inverted order) { inputConfig: `factorytruestoreforeverfalseEnabled` + time.Now().Truncate(24*time.Hour).UTC().Add(-24*time.Hour).Format(time.RFC3339) + ``, objectName: "fooobject", objectTags: "storeforever=false&factory=true", objectModTime: time.Now().UTC().Add(-24 * time.Hour), // Created 1 day ago expectedAction: DeleteAction, }, // Should not remove (Tags don't match) { inputConfig: `foodir/tagvalue1Enabled` + time.Now().UTC().Truncate(24*time.Hour).Add(-24*time.Hour).Format(time.RFC3339) + ``, objectName: "foodir/fooobject", objectTags: "tag1=value1", objectModTime: time.Now().UTC().Add(-24 * time.Hour), // Created 1 day ago expectedAction: NoneAction, }, // Should not remove (Tags match, but prefix doesn't match) { inputConfig: `foodir/tag1value1Enabled` + time.Now().Truncate(24*time.Hour).UTC().Add(-24*time.Hour).Format(time.RFC3339) + ``, objectName: "foxdir/fooobject", objectTags: "tag1=value1", objectModTime: time.Now().UTC().Add(-24 * time.Hour), // Created 1 day ago expectedAction: NoneAction, }, // Should remove - empty prefix, tags match, date expiration kicked in { inputConfig: `tag1value1Enabled` + time.Now().Truncate(24*time.Hour).UTC().Add(-24*time.Hour).Format(time.RFC3339) + ``, objectName: "foxdir/fooobject", objectTags: "tag1=value1", objectModTime: time.Now().UTC().Add(-24 * time.Hour), // Created 1 day ago expectedAction: DeleteAction, }, // Should remove - empty prefix, tags match, object is expired based on specified Days { inputConfig: `tag1value1Enabled1`, objectName: "foxdir/fooobject", objectTags: "tag1=value1", objectModTime: time.Now().UTC().Add(-48 * time.Hour), // Created 2 day ago expectedAction: DeleteAction, }, // Should remove, the second rule has expiration kicked in { inputConfig: `Enabled` + time.Now().Truncate(24*time.Hour).UTC().Add(24*time.Hour).Format(time.RFC3339) + `foxdir/Enabled` + time.Now().Truncate(24*time.Hour).UTC().Add(-24*time.Hour).Format(time.RFC3339) + ``, objectName: "foxdir/fooobject", objectModTime: time.Now().UTC().Add(-24 * time.Hour), // Created 1 day ago expectedAction: DeleteAction, }, } for _, tc := range testCases { tc := tc t.Run("", func(t *testing.T) { lc, err := ParseLifecycleConfig(bytes.NewReader([]byte(tc.inputConfig))) if err != nil { t.Fatalf("Got unexpected error: %v", err) } if resultAction := lc.ComputeAction(ObjectOpts{ Name: tc.objectName, UserTags: tc.objectTags, ModTime: tc.objectModTime, IsLatest: true, }); resultAction != tc.expectedAction { t.Fatalf("Expected action: `%v`, got: `%v`", tc.expectedAction, resultAction) } }) } } func TestHasActiveRules(t *testing.T) { testCases := []struct { inputConfig string prefix string expectedNonRec bool expectedRec bool }{ { inputConfig: `foodir/Enabled5`, prefix: "foodir/foobject", expectedNonRec: true, expectedRec: true, }, { // empty prefix inputConfig: `Enabled5`, prefix: "foodir/foobject/foo.txt", expectedNonRec: true, expectedRec: true, }, { inputConfig: `foodir/Enabled5`, prefix: "zdir/foobject", expectedNonRec: false, expectedRec: false, }, { inputConfig: `foodir/zdir/Enabled5`, prefix: "foodir/", expectedNonRec: false, expectedRec: true, }, { inputConfig: `Disabled5`, prefix: "foodir/", expectedNonRec: false, expectedRec: false, }, { inputConfig: `foodir/Enabled2999-01-01T00:00:00.000Z`, prefix: "foodir/foobject", expectedNonRec: false, expectedRec: false, }, } for i, tc := range testCases { tc := tc t.Run(fmt.Sprintf("Test_%d", i+1), func(t *testing.T) { lc, err := ParseLifecycleConfig(bytes.NewReader([]byte(tc.inputConfig))) if err != nil { t.Fatalf("Got unexpected error: %v", err) } if got := lc.HasActiveRules(tc.prefix, false); got != tc.expectedNonRec { t.Fatalf("Expected result with recursive set to false: `%v`, got: `%v`", tc.expectedNonRec, got) } if got := lc.HasActiveRules(tc.prefix, true); got != tc.expectedRec { t.Fatalf("Expected result with recursive set to true: `%v`, got: `%v`", tc.expectedRec, got) } }) } }