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

fix(spring-yaml-properties): preserve order of an existing property when updating its value #10911

Merged
merged 1 commit into from
Sep 20, 2024
Merged

fix(spring-yaml-properties): preserve order of an existing property when updating its value #10911

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
48 changes: 19 additions & 29 deletions ...a/tech/jhipster/lite/module/infrastructure/secondary/YamlFileSpringPropertiesHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,21 @@
package tech.jhipster.lite.module.infrastructure.secondary;

import static org.yaml.snakeyaml.comments.CommentType.*;
import static org.yaml.snakeyaml.comments.CommentType.BLOCK;

import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.Writer;
import java.io.*;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import java.util.*;
import java.util.function.Function;
import java.util.function.Predicate;
import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.*;
import org.yaml.snakeyaml.DumperOptions.FlowStyle;
import org.yaml.snakeyaml.LoaderOptions;
import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.comments.CommentLine;
import org.yaml.snakeyaml.constructor.Constructor;
import org.yaml.snakeyaml.nodes.MappingNode;
import org.yaml.snakeyaml.nodes.Node;
import org.yaml.snakeyaml.nodes.NodeTuple;
import org.yaml.snakeyaml.nodes.ScalarNode;
import org.yaml.snakeyaml.nodes.SequenceNode;
import org.yaml.snakeyaml.nodes.Tag;
import org.yaml.snakeyaml.nodes.*;
import org.yaml.snakeyaml.representer.Representer;
import tech.jhipster.lite.module.domain.Indentation;
import tech.jhipster.lite.module.domain.javaproperties.Comment;
import tech.jhipster.lite.module.domain.javaproperties.PropertyKey;
import tech.jhipster.lite.module.domain.javaproperties.PropertyValue;
import tech.jhipster.lite.module.domain.javaproperties.*;
import tech.jhipster.lite.shared.error.domain.Assert;
import tech.jhipster.lite.shared.error.domain.GeneratorException;
import tech.jhipster.lite.shared.generation.domain.ExcludeFromGeneratedCodeCoverage;
Expand Down Expand Up @@ -91,13 +73,21 @@ private void appendPropertyToConfiguration(PropertyKey key, PropertyValue value,

List<NodeTuple> parentValue = parentPropertyNode(key, configuration).getValue();

parentValue.stream().filter(nodeTupleKeyEquals(localKey)).findFirst().ifPresent(removeNode(parentValue));

parentValue.add(new NodeTuple(buildScalarNode(localKey), buildValueNode(value)));
NodeTuple nodeProperty = new NodeTuple(buildScalarNode(localKey), buildValueNode(value));
indexInCollection(parentValue, localKey).ifPresentOrElse(
index -> parentValue.set(index, nodeProperty),
() -> parentValue.add(nodeProperty)
);
}

private Consumer<NodeTuple> removeNode(List<NodeTuple> parentValue) {
return parentValue::remove;
private Optional<Integer> indexInCollection(List<NodeTuple> nodesTuples, String key) {
Predicate<NodeTuple> matchesKey = nodeTupleKeyEquals(key);
for (int i = 0; i < nodesTuples.size(); i++) {
if (matchesKey.test(nodesTuples.get(i))) {
return Optional.of(i);
}
}
return Optional.empty();
}

private Node buildValueNode(PropertyValue value) {
Expand Down
31 changes: 31 additions & 0 deletions ...ch/jhipster/lite/module/infrastructure/secondary/YamlFileSpringPropertiesHandlerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,37 @@ void shouldAppendPropertyToFileWithProperties() {
);
}

@Test
void shouldKeepExistingOrderWhenReplacingAProperty() {
Path yamlFile = Paths.get(TestFileUtils.tmpDirForTest(), "src/main/resources/application.yml");
loadDefaultProperties(
Paths.get("src/test/resources/projects/project-with-spring-application-yaml/more-complex-application.yml"),
yamlFile
);
YamlFileSpringPropertiesHandler handler = new YamlFileSpringPropertiesHandler(yamlFile, Indentation.DEFAULT);

handler.setValue(propertyKey("spring.datasource.driver-class-name"), propertyValue("org.postgresql.Driver"));

assertThat(content(yamlFile)).contains(
"""
spring:
data:
jpa:
repositories:
bootstrap-mode: deferred
datasource:
driver-class-name: org.postgresql.Driver
hikari:
auto-commit: false
poolName: Hikari
password: ''
type: com.zaxxer.hikari.HikariDataSource
url: jdbc:postgresql://localhost:5432/myapp
username: myapp
"""
);
}

@Test
void shouldRespectProjectIndentation() {
Path yamlFile = Paths.get(TestFileUtils.tmpDirForTest(), "src/main/resources/application.yml");
Expand Down
14 changes: 14 additions & 0 deletions ...test/resources/projects/project-with-spring-application-yaml/more-complex-application.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
spring:
data:
jpa:
repositories:
bootstrap-mode: deferred
datasource:
driver-class-name: org.postgresql.Driver
hikari:
auto-commit: false
poolName: Hikari
password: ''
type: com.zaxxer.hikari.HikariDataSource
url: jdbc:postgresql://localhost:5432/myapp
username: myapp