xichen01 commented on code in PR #8275: URL: https://github.com/apache/ozone/pull/8275#discussion_r2047300309
########## hadoop-ozone/common/src/test/java/org/apache/hadoop/ozone/om/helpers/TestOmLCExpiration.java: ########## @@ -0,0 +1,165 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.hadoop.ozone.om.helpers; + +import static org.apache.hadoop.ozone.om.exceptions.OMException.ResultCodes.INVALID_REQUEST; +import static org.apache.hadoop.ozone.om.helpers.OMLCUtils.assertOMException; +import static org.apache.hadoop.ozone.om.helpers.OMLCUtils.getFutureDateString; +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; + +import org.junit.jupiter.api.Test; + +/** + * Test OmLCExpiration. + */ +class TestOmLCExpiration { + + @Test + public void testCreateValidOmLCExpiration() { + OmLCExpiration exp1 = new OmLCExpiration.Builder() + .setDays(30) + .build(); + assertDoesNotThrow(exp1::valid); + + OmLCExpiration exp2 = new OmLCExpiration.Builder() + .setDate("2099-10-10T00:00:00Z") + .build(); + assertDoesNotThrow(exp2::valid); + + OmLCExpiration exp3 = new OmLCExpiration.Builder() + .setDays(1) + .build(); + assertDoesNotThrow(exp3::valid); + + OmLCExpiration exp4 = new OmLCExpiration.Builder() + .setDate("2099-12-31T00:00:00Z") + .build(); + assertDoesNotThrow(exp4::valid); + + OmLCExpiration exp5 = new OmLCExpiration.Builder() + .setDate("2099-02-15T00:00:00.000Z") + .build(); + assertDoesNotThrow(exp5::valid); + } + + @Test + public void testCreateInValidOmLCExpiration() { + OmLCExpiration exp1 = new OmLCExpiration.Builder() + .setDays(30) + .setDate(getFutureDateString(100)) + .build(); + assertOMException(exp1::valid, INVALID_REQUEST, + "Either 'days' or 'date' should be specified, but not both or neither."); + + OmLCExpiration exp2 = new OmLCExpiration.Builder() + .setDays(-1) + .build(); + assertOMException(exp2::valid, INVALID_REQUEST, + "'Days' for Expiration action must be a positive integer"); + + OmLCExpiration exp3 = new OmLCExpiration.Builder() + .setDate(null) + .build(); + assertOMException(exp3::valid, INVALID_REQUEST, + "Either 'days' or 'date' should be specified, but not both or neither."); + + OmLCExpiration exp4 = new OmLCExpiration.Builder() + .setDate("") + .build(); + assertOMException(exp4::valid, INVALID_REQUEST, + "Either 'days' or 'date' should be specified, but not both or neither."); + + OmLCExpiration exp5 = new OmLCExpiration.Builder() + .build(); + assertOMException(exp5::valid, INVALID_REQUEST, + "Either 'days' or 'date' should be specified, but not both or neither."); + + OmLCExpiration exp6 = new OmLCExpiration.Builder() + .setDate("10-10-2099") + .build(); + assertOMException(exp6::valid, INVALID_REQUEST, + "'Date' must be in ISO 8601 format"); + + OmLCExpiration exp7 = new OmLCExpiration.Builder() + .setDate("2099-12-31T00:00:00") + .build(); + assertOMException(exp7::valid, INVALID_REQUEST, + "'Date' must be in ISO 8601 format"); + + // Testing for date in the past + OmLCExpiration exp8 = new OmLCExpiration.Builder() + .setDate(getFutureDateString(-1)) + .build(); + assertOMException(exp8::valid, INVALID_REQUEST, + "'Date' must be in the future"); + + OmLCExpiration exp9 = new OmLCExpiration.Builder() + .setDays(0) + .build(); + assertOMException(exp9::valid, INVALID_REQUEST, + "Either 'days' or 'date' should be specified, but not both or neither."); Review Comment: ”0 day“ maybe it is not set or set to 0. We do not clearly distinguish these two cases. So this 0 day be treat as not set ########## hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmLCRule.java: ########## @@ -0,0 +1,238 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.hadoop.ozone.om.helpers; + +import java.util.ArrayList; +import java.util.List; +import org.apache.commons.lang3.RandomStringUtils; +import org.apache.commons.lang3.StringUtils; +import org.apache.hadoop.ozone.om.exceptions.OMException; + +/** + * A class that encapsulates lifecycle rule. + */ +public class OmLCRule { + + public static final int LC_ID_LENGTH = 48; + // Ref: https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html#intro-lifecycle-rule-id + public static final int LC_ID_MAX_LENGTH = 255; + + private String id; + private String prefix; + private boolean enabled; + private boolean isPrefixEnable; + private boolean isTagEnable; + // List of actions for this rule + private List<OmLCAction> actions; + private OmLCFilter filter; + + OmLCRule(String id, String prefix, boolean enabled, + List<OmLCAction> actions, OmLCFilter filter) { + this.id = id; + this.prefix = prefix; + this.enabled = enabled; + this.actions = actions; + this.filter = filter; + + if (StringUtils.isEmpty(this.id)) { + this.id = RandomStringUtils.randomAlphanumeric(LC_ID_LENGTH); + } + + OmLifecycleRuleAndOperator andOperator = filter != null ? filter.getAndOperator() : null; + + if (prefix != null || + (filter != null && filter.getPrefix() != null) || + (andOperator != null && andOperator.getPrefix() != null)) { + isPrefixEnable = true; + } + + if ((filter != null && filter.getTag() != null) || + (andOperator != null && !andOperator.getTags().isEmpty())) { + isTagEnable = true; + } + } + + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public String getPrefix() { + return prefix; + } + + public void setPrefix(String prefix) { + this.prefix = prefix; + } + + public boolean isEnabled() { + return enabled; + } + + public void setEnabled(boolean enabled) { + this.enabled = enabled; + } + + public List<OmLCAction> getActions() { + return actions; + } + + public void setActions(List<OmLCAction> actions) { + this.actions = actions; + } + + /** + * Get the expiration action if present. + * + * @return the expiration action if present, null otherwise + */ + public OmLCExpiration getExpiration() { + if (actions == null || actions.isEmpty()) { + return null; + } + + for (OmLCAction action : actions) { + if (action instanceof OmLCExpiration) { + return (OmLCExpiration) action; + } + } + return null; + } + + public OmLCFilter getFilter() { + return filter; + } + + public boolean isPrefixEnable() { + return isPrefixEnable; + } + + public boolean isTagEnable() { + return isTagEnable; + } + + public void setFilter(OmLCFilter filter) { + this.filter = filter; + } + + /** + * Validates the lifecycle rule. + * - ID length should not exceed the allowed limit + * - At least one action must be specified + * - Filter and Prefix cannot be used together + * - Actions must be valid + * - Filter must be valid + * - There must be at most one Expiration action per rule + * + * @throws OMException if the validation fails + */ + public void valid() throws OMException { + if (id.length() > LC_ID_MAX_LENGTH) { + throw new OMException("ID length should not exceed allowed limit of " + LC_ID_MAX_LENGTH, + OMException.ResultCodes.INVALID_REQUEST); + } + + if (actions == null || actions.isEmpty()) { + throw new OMException("At least one action needs to be specified in a rule.", + OMException.ResultCodes.INVALID_REQUEST); + } + + // Check that there is at most one Expiration action + for (OmLCAction action : actions) { + if (action.getActionType() == OmLCAction.ActionType.EXPIRATION) { + if (actions.size() > 1) { + throw new OMException("A rule can have at most one Expiration action.", + OMException.ResultCodes.INVALID_REQUEST); + } + } + action.valid(); + } + + if (prefix != null && filter != null) { Review Comment: Yes, prefix can be empty (""), this means that all the keys under the bucket will be matched. (the prefix in the AndOperator can be empty ("") too) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
