You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ozone.apache.org by GitBox <gi...@apache.org> on 2020/10/07 05:43:13 UTC
[GitHub] [hadoop-ozone] adoroszlai commented on a change in pull request #1425: HDDS-2981 Add unit tests for Proto [de]serialization
adoroszlai commented on a change in pull request #1425:
URL: https://github.com/apache/hadoop-ozone/pull/1425#discussion_r499007546
##########
File path: hadoop-ozone/common/src/test/java/org/apache/hadoop/ozone/om/helpers/TestInstanceHelper.java
##########
@@ -0,0 +1,67 @@
+/**
+ * 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.helpers;
+
+import com.google.protobuf.ByteString;
+import org.apache.hadoop.hdds.protocol.proto.HddsProtos;
+import org.apache.hadoop.ozone.OzoneAcl;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos;
+
+
+/**
+ * Test TestInstanceHelper.
+ *
+ * Utility methods to create test instances of protobuf related classes
+ */
+public final class TestInstanceHelper {
+
+ private TestInstanceHelper(){
+ super();
+ }
+
+ public static OzoneManagerProtocolProtos.OzoneAclInfo buildTestOzoneAclInfo(
+ String aclString){
+ OzoneAcl oacl = OzoneAcl.parseAcl(aclString);
+ ByteString rights = ByteString.copyFrom(oacl.getAclBitSet().toByteArray());
+ return OzoneManagerProtocolProtos.OzoneAclInfo.newBuilder()
+ .setType(OzoneManagerProtocolProtos.OzoneAclInfo.OzoneAclType.USER)
+ .setName(oacl.getName())
+ .setRights(rights)
+ .setAclScope(OzoneManagerProtocolProtos.
+ OzoneAclInfo.OzoneAclScope.ACCESS)
+ .build();
+ }
+
+ public static HddsProtos.KeyValue getDefaultTestMetadata(
+ String key, String value) {
+ return HddsProtos.KeyValue.newBuilder()
+ .setKey(key)
+ .setValue(value)
+ .build();
+ }
+
+ public static OzoneManagerProtocolProtos.PrefixInfo getDefaultTestPrefixInfo(
Review comment:
I don't think there is much "default" in these `getDefaultTest...` methods, as (most) data still has to be provided. They are just factory methods wrapping the builders, trading flexibility and readability for slightly shorter code. (Builder is more flexible since it can accept eg. multiple ACLs, and more readable because each argument is passed to a named method instead of a bunch of arguments to a single constructor.)
Instead of such generic factory methods, I suggest adding:
* ones that create objects with specific properties relevant for the tests
* ones that fill irrelevant properties with random data (eg. for the metadata key-value pair)
##########
File path: hadoop-ozone/common/src/test/java/org/apache/hadoop/ozone/om/helpers/TestInstanceHelper.java
##########
@@ -0,0 +1,67 @@
+/**
+ * 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.helpers;
+
+import com.google.protobuf.ByteString;
+import org.apache.hadoop.hdds.protocol.proto.HddsProtos;
+import org.apache.hadoop.ozone.OzoneAcl;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos;
+
+
+/**
+ * Test TestInstanceHelper.
+ *
+ * Utility methods to create test instances of protobuf related classes
+ */
+public final class TestInstanceHelper {
+
+ private TestInstanceHelper(){
+ super();
+ }
+
+ public static OzoneManagerProtocolProtos.OzoneAclInfo buildTestOzoneAclInfo(
+ String aclString){
+ OzoneAcl oacl = OzoneAcl.parseAcl(aclString);
+ ByteString rights = ByteString.copyFrom(oacl.getAclBitSet().toByteArray());
+ return OzoneManagerProtocolProtos.OzoneAclInfo.newBuilder()
+ .setType(OzoneManagerProtocolProtos.OzoneAclInfo.OzoneAclType.USER)
+ .setName(oacl.getName())
+ .setRights(rights)
+ .setAclScope(OzoneManagerProtocolProtos.
+ OzoneAclInfo.OzoneAclScope.ACCESS)
+ .build();
Review comment:
I think using `OzoneAcl.toProtobuf` for testing protobuf conversion of objects other than `OzoneAcl` is valid. `TestOzoneAcl` of course needs to avoid that.
Note: this would also fix the problem that `buildTestOzoneAclInfo` currently ignores identity type (user/group) in the input and returns a user ACL even for `"group:..."`.
```suggestion
return OzoneAcl.toProtobuf(oacl);
```
##########
File path: hadoop-ozone/common/src/test/java/org/apache/hadoop/ozone/om/helpers/TestOmPrefixInfo.java
##########
@@ -18,39 +18,91 @@
package org.apache.hadoop.ozone.om.helpers;
+import org.apache.hadoop.hdds.protocol.proto.HddsProtos;
import org.apache.hadoop.ozone.OzoneAcl;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos;
import org.apache.hadoop.ozone.security.acl.IAccessAuthorizer;
import org.junit.Assert;
import org.junit.Test;
import java.util.Collections;
import java.util.HashMap;
+
import static org.apache.hadoop.ozone.OzoneAcl.AclScope.ACCESS;
/**
* Class to test OmPrefixInfo.
*/
public class TestOmPrefixInfo {
- @Test
- public void testCopyObject() {
- OmPrefixInfo omPrefixInfo = new OmPrefixInfo("/path",
+ public OmPrefixInfo getOmPrefixInfoForTest(String path,
+ IAccessAuthorizer.ACLIdentityType identityType,
+ String identityString,
+ IAccessAuthorizer.ACLType aclType,
+ OzoneAcl.AclScope scope) {
Review comment:
It could be improved by accepting an `OzoneAcl` instead of a group ACL-related parameters.
##########
File path: hadoop-ozone/common/src/test/java/org/apache/hadoop/ozone/om/helpers/TestOmPrefixInfo.java
##########
@@ -18,39 +18,91 @@
package org.apache.hadoop.ozone.om.helpers;
+import org.apache.hadoop.hdds.protocol.proto.HddsProtos;
import org.apache.hadoop.ozone.OzoneAcl;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos;
import org.apache.hadoop.ozone.security.acl.IAccessAuthorizer;
import org.junit.Assert;
import org.junit.Test;
import java.util.Collections;
import java.util.HashMap;
+
Review comment:
Nit: unnecessary new empty line.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: ozone-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: ozone-issues-help@hadoop.apache.org