rakeshadr commented on code in PR #3265: URL: https://github.com/apache/ozone/pull/3265#discussion_r843548373
########## hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/BucketLayoutAwareOMKeyRequestFactory.java: ########## @@ -0,0 +1,304 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.request; + +import org.apache.hadoop.ozone.om.OzoneManager; +import org.apache.hadoop.ozone.om.exceptions.OMException; +import org.apache.hadoop.ozone.om.helpers.BucketLayout; +import org.apache.hadoop.ozone.om.request.file.OMDirectoryCreateRequest; +import org.apache.hadoop.ozone.om.request.file.OMDirectoryCreateRequestWithFSO; +import org.apache.hadoop.ozone.om.request.file.OMFileCreateRequest; +import org.apache.hadoop.ozone.om.request.file.OMFileCreateRequestWithFSO; +import org.apache.hadoop.ozone.om.request.key.OMKeyCreateRequest; +import org.apache.hadoop.ozone.om.request.key.OMKeyCreateRequestWithFSO; +import org.apache.hadoop.ozone.om.request.key.OMKeyDeleteRequest; +import org.apache.hadoop.ozone.om.request.key.OMKeyDeleteRequestWithFSO; +import org.apache.hadoop.ozone.om.request.key.OMKeyRenameRequest; +import org.apache.hadoop.ozone.om.request.key.OMKeyRenameRequestWithFSO; +import org.apache.hadoop.ozone.om.request.key.OMKeyRequest; +import org.apache.hadoop.ozone.om.request.key.OMAllocateBlockRequest; +import org.apache.hadoop.ozone.om.request.key.OMAllocateBlockRequestWithFSO; +import org.apache.hadoop.ozone.om.request.key.OMKeyCommitRequest; +import org.apache.hadoop.ozone.om.request.key.OMKeyCommitRequestWithFSO; +import org.apache.hadoop.ozone.om.request.key.OMKeysDeleteRequest; +import org.apache.hadoop.ozone.om.request.key.OMKeysRenameRequest; +import org.apache.hadoop.ozone.om.request.key.OmKeysDeleteRequestWithFSO; +import org.apache.hadoop.ozone.om.request.s3.multipart.S3MultipartUploadCompleteRequest; +import org.apache.hadoop.ozone.om.request.s3.multipart.S3MultipartUploadCompleteRequestWithFSO; +import org.apache.hadoop.ozone.om.request.s3.multipart.S3InitiateMultipartUploadRequest; +import org.apache.hadoop.ozone.om.request.s3.multipart.S3InitiateMultipartUploadRequestWithFSO; +import org.apache.hadoop.ozone.om.request.s3.multipart.S3MultipartUploadCommitPartRequest; +import org.apache.hadoop.ozone.om.request.s3.multipart.S3MultipartUploadCommitPartRequestWithFSO; +import org.apache.hadoop.ozone.om.request.s3.multipart.S3MultipartUploadAbortRequest; +import org.apache.hadoop.ozone.om.request.s3.multipart.S3MultipartUploadAbortRequestWithFSO; +import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest; +import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.Type; +import org.jetbrains.annotations.NotNull; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.lang.reflect.Constructor; +import java.lang.reflect.InvocationTargetException; +import java.util.HashMap; +import java.util.HashSet; + +import static org.apache.hadoop.ozone.om.OzoneManagerUtils.getBucketLayout; + + +/** + * Factory class to instantiate bucket layout aware request classes. + */ +public final class BucketLayoutAwareOMKeyRequestFactory { + private static final Logger LOG = + LoggerFactory.getLogger(BucketLayoutAwareOMKeyRequestFactory.class); + + static final HashMap<String, Class<? extends OMKeyRequest>> + OM_KEY_REQUEST_CLASSES = new HashMap<>(); + + static { + // CreateDirectory + addRequestClass(Type.CreateDirectory, + OMDirectoryCreateRequest.class, + BucketLayout.OBJECT_STORE + ); + addRequestClass(Type.CreateDirectory, + OMDirectoryCreateRequestWithFSO.class, + BucketLayout.FILE_SYSTEM_OPTIMIZED); + + // CreateFile + addRequestClass(Type.CreateFile, + OMFileCreateRequest.class, + BucketLayout.OBJECT_STORE + ); + addRequestClass(Type.CreateFile, + OMFileCreateRequestWithFSO.class, + BucketLayout.FILE_SYSTEM_OPTIMIZED + ); + + // CreateKey + addRequestClass(Type.CreateKey, + OMKeyCreateRequest.class, + BucketLayout.OBJECT_STORE + ); + addRequestClass(Type.CreateKey, + OMKeyCreateRequestWithFSO.class, + BucketLayout.FILE_SYSTEM_OPTIMIZED); + + // AllocateBlock + addRequestClass(Type.AllocateBlock, + OMAllocateBlockRequest.class, + BucketLayout.OBJECT_STORE + ); + addRequestClass(Type.AllocateBlock, + OMAllocateBlockRequestWithFSO.class, + BucketLayout.FILE_SYSTEM_OPTIMIZED + ); + + // CommitKey + addRequestClass(Type.CommitKey, + OMKeyCommitRequest.class, + BucketLayout.OBJECT_STORE + ); + addRequestClass(Type.CommitKey, + OMKeyCommitRequestWithFSO.class, + BucketLayout.FILE_SYSTEM_OPTIMIZED + ); + + // DeleteKey + addRequestClass(Type.DeleteKey, + OMKeyDeleteRequest.class, + BucketLayout.OBJECT_STORE); + addRequestClass(Type.DeleteKey, + OMKeyDeleteRequestWithFSO.class, + BucketLayout.FILE_SYSTEM_OPTIMIZED); + + // DeleteKeys + addRequestClass(Type.DeleteKeys, + OMKeysDeleteRequest.class, + BucketLayout.OBJECT_STORE); + addRequestClass(Type.DeleteKeys, + OmKeysDeleteRequestWithFSO.class, + BucketLayout.FILE_SYSTEM_OPTIMIZED); + + // RenameKey + addRequestClass(Type.RenameKey, + OMKeyRenameRequest.class, + BucketLayout.OBJECT_STORE); + addRequestClass(Type.RenameKey, + OMKeyRenameRequestWithFSO.class, + BucketLayout.FILE_SYSTEM_OPTIMIZED); + + // RenameKeys + addRequestClass(Type.RenameKeys, + OMKeysRenameRequest.class, + BucketLayout.OBJECT_STORE); + + // InitiateMultiPartUpload + addRequestClass(Type.InitiateMultiPartUpload, + S3InitiateMultipartUploadRequest.class, + BucketLayout.OBJECT_STORE); + addRequestClass(Type.InitiateMultiPartUpload, + S3InitiateMultipartUploadRequestWithFSO.class, + BucketLayout.FILE_SYSTEM_OPTIMIZED); + + // CommitMultiPartUpload + addRequestClass(Type.CommitMultiPartUpload, + S3MultipartUploadCommitPartRequest.class, + BucketLayout.OBJECT_STORE); + addRequestClass(Type.CommitMultiPartUpload, + S3MultipartUploadCommitPartRequestWithFSO.class, + BucketLayout.FILE_SYSTEM_OPTIMIZED); + + // AbortMultiPartUpload + addRequestClass(Type.AbortMultiPartUpload, + S3MultipartUploadAbortRequest.class, + BucketLayout.OBJECT_STORE); + addRequestClass(Type.AbortMultiPartUpload, + S3MultipartUploadAbortRequestWithFSO.class, + BucketLayout.FILE_SYSTEM_OPTIMIZED); + + // CompleteMultiPartUpload + addRequestClass(Type.CompleteMultiPartUpload, + S3MultipartUploadCompleteRequest.class, + BucketLayout.OBJECT_STORE); + addRequestClass(Type.CompleteMultiPartUpload, + S3MultipartUploadCompleteRequestWithFSO.class, + BucketLayout.FILE_SYSTEM_OPTIMIZED); + } + + private BucketLayoutAwareOMKeyRequestFactory() { + // Utility class. + } + + /** + * Generates a request object for the given request based on the bucket + * layout. + * + * @param volumeName volume name + * @param bucketName bucket name + * @param omRequest OMRequest object + * @param ozoneManager ozone manager instance + * @return OMKeyRequest object + * @throws IOException if the request type is not supported. + */ + public static OMKeyRequest createRequest(String volumeName, String bucketName, + OMRequest omRequest, + OzoneManager ozoneManager) + + throws IOException { + // Get the bucket layout of the bucket being accessed by this request. + // While doing this we make sure we are resolving the real bucket in case of + // link buckets. + BucketLayout bucketLayout = Review Comment: Please add an assertion as this is kinda utility and in future if someone modifies will validate this. ``` if(StringUtils.isBlank(volumeName)){ throw new OMException("Invalid, volume name is empty", OMException.ResultCodes.INVALID_VOLUME_NAME); } if(StringUtils.isBlank(bucketName)){ throw new OMException("Invalid, Bucket name is empty", OMException.ResultCodes.INVALID_BUCKET_NAME); ``` ########## hadoop-ozone/ozone-manager/src/test/java/org/apache/hadoop/ozone/om/request/TestBucketLayoutAwareOMKeyFactory.java: ########## @@ -0,0 +1,94 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.request; + +import org.apache.hadoop.ozone.om.helpers.BucketLayout; +import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest; +import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.Type; +import org.junit.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.lang.reflect.InvocationTargetException; + +import static org.junit.Assert.fail; + +/** + * Validates functionality of {@link BucketLayoutAwareOMKeyRequestFactory}. + */ +public class TestBucketLayoutAwareOMKeyFactory { + private static final Logger LOG = + LoggerFactory.getLogger(TestBucketLayoutAwareOMKeyFactory.class); + + /** + * Validates instantiation of each OMKeyRequest present inside the + * (CmdType + BucketLayout) -> RequestClass Mapping. + */ + @Test + public void testGetRequestInstanceFromMap() { + // Iterate over each OMKeyRequest present in the mapping. + BucketLayoutAwareOMKeyRequestFactory.OM_KEY_REQUEST_CLASSES.forEach( Review Comment: Please do more assertions like below: ``` List<OMKeyRequest> omKeyReqsFSO = new ArrayList<>(); List<OMKeyRequest> omKeyReqsLegacy = new ArrayList<>(); List<OMKeyRequest> omKeyReqsOBS = new ArrayList<>(); ``` .... .... ``` OMKeyRequest omKeyRequest = BucketLayoutAwareOMKeyRequestFactory .getRequestInstanceFromMap( getDummyOMRequest(), k, BucketLayout.FILE_SYSTEM_OPTIMIZED); Assert.assertEquals(BucketLayout.FILE_SYSTEM_OPTIMIZED, omKeyRequest.getBucketLayout()); omKeyReqsFSO.add(omKeyRequest); ``` ..... .... .... ``` OMKeyRequest omKeyRequest1 = BucketLayoutAwareOMKeyRequestFactory .getRequestInstanceFromMap( getDummyOMRequest(), k, BucketLayout.LEGACY); Assert.assertEquals(BucketLayout.LEGACY, omKeyRequest1.getBucketLayout()); omKeyReqsLegacy.add(omKeyRequest1); OMKeyRequest omKeyRequest2 = BucketLayoutAwareOMKeyRequestFactory .getRequestInstanceFromMap( getDummyOMRequest(), k, BucketLayout.OBJECT_STORE); Assert.assertEquals(BucketLayout.OBJECT_STORE, omKeyRequest2.getBucketLayout()); omKeyReqsOBS.add(omKeyRequest2); ``` ...... ...... ``` Assert.assertEquals(12, omKeyReqsFSO.size()); Assert.assertEquals(13, omKeyReqsLegacy.size()); Assert.assertEquals(13, omKeyReqsOBS.size()); ``` -- 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]
