Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

validating the date format, add test case, since NumberFormatException extends IllegalArgumentException, it is only necessary to write IllegalArgumentException. #2529

Closed
wants to merge 8 commits into from
Closed

validating the date format, add test case, since NumberFormatException extends IllegalArgumentException, it is only necessary to write IllegalArgumentException. #2529

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
11281be
issue 2472 throw exception if it is an invalid date format and since …
Nov 6, 2023
04c04d2
add test
Nov 6, 2023
48e6e99
Merge branch 'main' into main
Carpe-Wang Nov 6, 2023
3bd2e14
add test
Nov 6, 2023
75278c8
Merge remote-tracking branch 'origin/main'
Nov 6, 2023
26e04d0
add a blank line before each of test methods
Nov 6, 2023
8ac0ffb
add if pattern != null
Nov 7, 2023
1a671b2
Merge branch 'main' into main
Carpe-Wang Nov 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion gson/src/main/java/com/google/gson/GsonBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Collections;
Expand Down Expand Up @@ -595,7 +596,12 @@ public GsonBuilder disableHtmlEscaping() {
*/
@CanIgnoreReturnValue
public GsonBuilder setDateFormat(String pattern) {
// TODO(Joel): Make this fail fast if it is an invalid date format
try {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It appears null might actually be a valid pattern value to clear any custom pattern previously set for the builder. The changes here would not support that anymore.

@eamonnmcmanus, should null be supported?

Apparently no unit test is covering that yet, might be good to add one (or I can add one in a separate PR if desired).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if pattern is null, here will throw null point exception.

new SimpleDateFormat(pattern);
} catch (IllegalArgumentException e) {
// throw exception if it is an invalid date format
throw new IllegalArgumentException("The date pattern '" + pattern + "' is not valid", e);
}
this.datePattern = pattern;
return this;
}
Expand Down
6 changes: 1 addition & 5 deletions gson/src/main/java/com/google/gson/internal/bind/util/ISO8601Utils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,11 +280,7 @@ public static Date parse(String date, ParsePosition pos) throws ParseException {
return calendar.getTime();
// If we get a ParseException it'll already have the right message/offset.
// Other exception types can convert here.
} catch (IndexOutOfBoundsException e) {
fail = e;
} catch (NumberFormatException e) {
fail = e;
} catch (IllegalArgumentException e) {
} catch (IndexOutOfBoundsException | IllegalArgumentException e) {
fail = e;
}
String input = (date == null) ? null : ('"' + date + '"');
Expand Down
16 changes: 16 additions & 0 deletions gson/src/test/java/com/google/gson/functional/DefaultTypeAdaptersTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
package com.google.gson.functional;

import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertThrows;
import static org.junit.Assert.fail;

import com.google.gson.Gson;
Expand Down Expand Up @@ -710,6 +711,21 @@ public void testStringBufferDeserialization() {
StringBuffer sb = gson.fromJson("'abc'", StringBuffer.class);
assertThat(sb.toString()).isEqualTo("abc");
}
@Test
public void testSetDateFormatWithInvalidPattern() {
GsonBuilder builder = new GsonBuilder();
String invalidPattern = "This is a invalid Pattern";
assertThrows(IllegalArgumentException.class, () -> {
builder.setDateFormat(invalidPattern);
});
}

@Test
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one tiny thing: could you add a blank line before each of these new test methods?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I am sorry about that.

public void testSetDateFormatWithValidPattern() {
GsonBuilder builder = new GsonBuilder();
String validPattern = "yyyy-MM-dd";
builder.setDateFormat(validPattern);
}

private static class MyClassTypeAdapter extends TypeAdapter<Class<?>> {
@Override
Expand Down