From d610f3c2ffb51fe539087e971fbcd98c02e0f58c Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Wed, 28 Apr 2021 11:17:17 +0200 Subject: [PATCH] Polish "Fix ordering of metadata entries" See gh-26230 --- .../metadata/JsonConverter.java | 17 ++++++----- .../metadata/JsonMarshallerTests.java | 30 ++++++++++++++++++- 2 files changed, 38 insertions(+), 9 deletions(-) diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/JsonConverter.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/JsonConverter.java index 3991227020..de97b71f32 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/JsonConverter.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/JsonConverter.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-2021 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -160,21 +160,22 @@ class JsonConverter { private static class ItemMetadataComparator implements Comparator { - private final Comparator itemComparator = Comparator.comparing(this::isDeprecated) - .thenComparing(ItemMetadata::getName).thenComparing(ItemMetadata::getSourceType); + private static final Comparator GROUP = Comparator.comparing(ItemMetadata::getName) + .thenComparing(ItemMetadata::getSourceType, Comparator.nullsFirst(Comparator.naturalOrder())); - private final Comparator groupComparator = Comparator.comparing(ItemMetadata::getName) - .thenComparing(ItemMetadata::getSourceType); + private static final Comparator ITEM = Comparator.comparing(ItemMetadataComparator::isDeprecated) + .thenComparing(ItemMetadata::getName) + .thenComparing(ItemMetadata::getSourceType, Comparator.nullsFirst(Comparator.naturalOrder())); @Override public int compare(ItemMetadata o1, ItemMetadata o2) { if (o1.isOfItemType(ItemType.GROUP)) { - return this.groupComparator.compare(o1, o2); + return GROUP.compare(o1, o2); } - return this.itemComparator.compare(o1, o2); + return ITEM.compare(o1, o2); } - private boolean isDeprecated(ItemMetadata item) { + private static boolean isDeprecated(ItemMetadata item) { return item.getDeprecation() != null; } diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/metadata/JsonMarshallerTests.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/metadata/JsonMarshallerTests.java index a4baa758fd..1f9c8d241e 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/metadata/JsonMarshallerTests.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/metadata/JsonMarshallerTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-2021 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -139,4 +139,32 @@ class JsonMarshallerTests { "com.example.Bar", "\"com.example.bravo.aaa\"", "com.example.Foo"); } + @Test + void orderingForSameGroupWithNullSourceType() throws IOException { + ConfigurationMetadata metadata = new ConfigurationMetadata(); + metadata.add(ItemMetadata.newGroup("com.acme.alpha", null, "com.example.Foo", null)); + metadata.add(ItemMetadata.newGroup("com.acme.alpha", null, null, null)); + ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); + JsonMarshaller marshaller = new JsonMarshaller(); + marshaller.write(metadata, outputStream); + String json = outputStream.toString(); + assertThat(json).containsSubsequence("\"groups\"", "\"name\": \"com.acme.alpha\"", + "\"name\": \"com.acme.alpha\"", "\"sourceType\": \"com.example.Foo\""); + } + + @Test + void orderingForSamePropertyNamesWithNullSourceType() throws IOException { + ConfigurationMetadata metadata = new ConfigurationMetadata(); + metadata.add(ItemMetadata.newProperty("com.example.bravo", "aaa", "java.lang.Boolean", null, null, null, null, + null)); + metadata.add(ItemMetadata.newProperty("com.example.bravo", "aaa", "java.lang.Integer", "com.example.Bar", null, + null, null, null)); + ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); + JsonMarshaller marshaller = new JsonMarshaller(); + marshaller.write(metadata, outputStream); + String json = outputStream.toString(); + assertThat(json).containsSubsequence("\"groups\"", "\"properties\"", "\"com.example.bravo.aaa\"", + "\"java.lang.Boolean\"", "\"com.example.bravo.aaa\"", "\"java.lang.Integer\"", "\"com.example.Bar"); + } + }