You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-issues@hadoop.apache.org by GitBox <gi...@apache.org> on 2020/07/17 14:16:48 UTC
[GitHub] [hadoop] steveloughran commented on a change in pull request #2143: HADOOP-17126. implement un-guava Precondition checkNotNull
steveloughran commented on a change in pull request #2143:
URL: https://github.com/apache/hadoop/pull/2143#discussion_r456469544
##########
File path: hadoop-common-project/hadoop-common/src/test/java/org/apache/hadoop/util/unguava/TestValidate.java
##########
@@ -0,0 +1,154 @@
+/**
+ * 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.util.unguava;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class TestValidate {
+ public static final Logger LOG =
+ LoggerFactory.getLogger(TestValidate.class);
+
+ private static final String NON_NULL_STRING = "NON_NULL_OBJECT";
+ private static final String NON_INT_STRING = "NOT_INT";
+ private static final String EXPECTED_ERROR_MSG = "Expected-Error-MSG";
+ private static final String EXPECTED_ERROR_MSG_ARGS =
+ EXPECTED_ERROR_MSG + "%s number %d";
+ private static final String NULL_FORMATTER = null;
+ @Rule
+ public ExpectedException exceptionRule = ExpectedException.none();
+
+ private String errorMessage;
+
+ @Test
+ public void testCheckNotNullSuccess() {
+ Validate.checkNotNull(NON_NULL_STRING);
+ // null supplier
+ Validate.checkNotNull(NON_NULL_STRING, null);
+ // exception in string supplier
+ Validate.checkNotNull(NON_NULL_STRING, ()-> String.format("%d",
+ NON_INT_STRING));
+ // null pattern to string formatter
+ Validate.checkNotNull(NON_NULL_STRING, NULL_FORMATTER, null, 1);
+ // null arguments to string formatter
+ Validate.checkNotNull(NON_NULL_STRING, EXPECTED_ERROR_MSG_ARGS,
+ null, null);
+ // illegal format exception
+ Validate.checkNotNull(NON_NULL_STRING, "message %d %d",
+ NON_INT_STRING, 1);
+ // insufficient arguments
+ Validate.checkNotNull(NON_NULL_STRING, EXPECTED_ERROR_MSG_ARGS,
+ NON_INT_STRING);
+ // null format in string supplier
+ Validate.checkNotNull(NON_NULL_STRING,
+ () -> String.format(NULL_FORMATTER, NON_INT_STRING));
+ }
+
+ @Test
+ public void testCheckNotNullFailure() {
+ exceptionRule.expect(NullPointerException.class);
+ exceptionRule.expectMessage(Validate.VALIDATE_IS_NOT_NULL_EX_MESSAGE);
+ Validate.checkNotNull(null);
+ }
+
+ @Test
+ public void testCheckNotNullFailureWithMSG() {
+ exceptionRule.expect(NullPointerException.class);
Review comment:
Can you use LambdaTestUtils.intercept instead? It's a java 8 friendly version and, if the exception isn't raised, it includes the toString() result of the lambda-expression in the error for better debugging
##########
File path: hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/unguava/Validate.java
##########
@@ -0,0 +1,123 @@
+/**
+ * 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.util.unguava;
+
+import java.util.Objects;
+import java.util.function.Supplier;
+import org.apache.hadoop.classification.InterfaceAudience;
+import org.apache.hadoop.classification.InterfaceStability;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * <p>This class replaces {@code guava.Preconditions} which provides helpers
+ * to validate the following conditions:
+ * <ul>
+ * <li>An invalid {@code null} obj causes a {@link NullPointerException}.</li>
+ * <li>An invalid argument causes an {@link IllegalArgumentException}.</li>
+ * <li>An invalid state causes an {@link IllegalStateException}.</li>
+ * <li>An invalid index causes an {@link IndexOutOfBoundsException}.</li>
+ * </ul>
+ */
+@InterfaceAudience.Private
+@InterfaceStability.Unstable
+public final class Validate {
+ public static final Logger LOG =
+ LoggerFactory.getLogger(Validate.class);
+
+ public static final String VALIDATE_IS_NOT_NULL_EX_MESSAGE =
+ "The validated object is null";
+
+ private Validate() {
+ }
+
+ /**
+ * <p>Validate that the specified argument is not {@code null},
+ * throwing a NPE exception otherwise.
+ *
+ * <p>The message of the exception is
+ * "The validated object is null".</p>
+ *
+ * @param <T> the object type
+ * @param obj the object to check
+ * @return the validated object
+ * @throws NullPointerException if the object is {@code null}
+ * @see #checkNotNull(Object, String, Object...)
+ */
+ public static <T> T checkNotNull(final T obj) {
+ return checkNotNull(obj, VALIDATE_IS_NOT_NULL_EX_MESSAGE);
+ }
+
+ public static <T> T checkNotNull(final T reference,
+ final Object errorMessage) {
+ return Objects.requireNonNull(reference, String.valueOf(errorMessage));
+ }
+
+ /**
+ * <p>Validate that the specified argument is not {@code null},
+ * throwing a NPE exception otherwise.
+ *
+ * <p>The message of the exception is
+ * "The validated object is null".</p>
+ *
+ * @param <T> the object type
+ * @param obj the object to check
+ * @param message the {@link String#format(String, Object...)}
+ * exception message if valid. Otherwise,
+ * the message is {@link #VALIDATE_IS_NOT_NULL_EX_MESSAGE}
+ * @param values the optional values for the formatted exception message
+ * @return the validated object
+ * @throws NullPointerException if the object is {@code null}
+ * @see #checkNotNull(Object, Supplier<String>)
+ */
+ public static <T> T checkNotNull(final T obj, final String message,
+ final Object... values) {
+ return checkNotNull(obj, () -> String.format(message, values));
+ }
+
+ /**
+ * <p>Validate that the specified argument is not {@code null},
+ * throwing a NPE exception otherwise.
+ *
+ * <p>The message of the exception is
+ * "The validated object is null".</p>
+ *
+ * @param <T> the object type
+ * @param obj the object to check
+ * @param msgSupplier the {@link Supplier#get()} set the
+ * exception message if valid. Otherwise,
+ * the message is {@link #VALIDATE_IS_NOT_NULL_EX_MESSAGE}
+ * @return the validated object (never {@code null} for method chaining)
+ * @throws NullPointerException if the object is {@code null}
+ * @see #checkNotNull(Object, Supplier<String>)
+ */
+ public static <T> T checkNotNull(final T obj,
+ final Supplier<String> msgSupplier) {
+ if (obj == null) {
Review comment:
There's an `Objects.requireNonNull(T obj, Supplier<String> messageSupplier)` which you could forward to, but your implementation is actually more robust, so I think it should stay
##########
File path: hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/unguava/Validate.java
##########
@@ -0,0 +1,123 @@
+/**
+ * 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.util.unguava;
+
+import java.util.Objects;
Review comment:
import ordering/splilts
java.*
non apache
org.apache
static *
----------------------------------------------------------------
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: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org