Skip to content

[release-notes] Fix tests and make it easy to regenerate output after changes #128781

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

Merged
merged 1 commit into from
Jun 2, 2025
Merged

[release-notes] Fix tests and make it easy to regenerate output after changes #128781

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
19 changes: 17 additions & 2 deletions ...al/src/test/java/org/elasticsearch/gradle/internal/release/ReleaseNotesGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,14 @@

import static org.elasticsearch.gradle.internal.release.GenerateReleaseNotesTask.getSortedBundlesWithUniqueChangelogs;
import static org.hamcrest.Matchers.equalTo;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertThat;

public class ReleaseNotesGeneratorTest {

// Temporarily set this to `true` to regenerate test output files when they need to be updated
private final boolean UPDATE_EXPECTED_OUTPUT = false;

private static final List<String> CHANGE_TYPES = List.of(
"breaking",
"breaking-java",
Expand Down Expand Up @@ -78,8 +82,9 @@ public void testTemplate(String templateFilename, String outputFilename) throws

public void testTemplate(String templateFilename, String outputFilename, List<ChangelogBundle> bundles) throws Exception {
// given:
final String outputFile = "/org/elasticsearch/gradle/internal/release/ReleaseNotesGeneratorTest." + outputFilename;
final String template = getResource("/templates/" + templateFilename);
final String expectedOutput = getResource("/org/elasticsearch/gradle/internal/release/ReleaseNotesGeneratorTest." + outputFilename);
final String expectedOutput = getResource(outputFile);

if (bundles == null) {
bundles = getBundles();
Expand All @@ -91,7 +96,12 @@ public void testTemplate(String templateFilename, String outputFilename, List<Ch
final String actualOutput = ReleaseNotesGenerator.generateFile(template, bundles);

// then:
assertThat(actualOutput, equalTo(expectedOutput));
if (UPDATE_EXPECTED_OUTPUT) {
writeResource(outputFile, actualOutput);
assertFalse("UPDATE_EXPECTED_OUTPUT should be set back to false after updating output", UPDATE_EXPECTED_OUTPUT);
} else {
assertThat(actualOutput, equalTo(expectedOutput));
}
}

private List<ChangelogBundle> getBundles() {
Expand Down Expand Up @@ -176,4 +186,9 @@ private ChangelogEntry makeHighlightsEntry(int pr, boolean notable) {
private String getResource(String name) throws Exception {
return Files.readString(Paths.get(Objects.requireNonNull(this.getClass().getResource(name)).toURI()), StandardCharsets.UTF_8);
}

private void writeResource(String name, String contents) throws Exception {
String path = "src/test/resources" + name;
Files.writeString(Paths.get(path), contents);
}
}
4 changes: 2 additions & 2 deletions ...es/org/elasticsearch/gradle/internal/release/ReleaseNotesGeneratorTest.index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ To check for security updates, go to [Security announcements for the Elastic sta
% ### Fixes [elasticsearch-next-fixes]
% *

## 9.1.0 [elasticsearch-9.1.0-release-notes]
```{applies_to}
stack: coming 9.1.0
```
## 9.1.0 [elasticsearch-9.1.0-release-notes]

### Highlights [elasticsearch-9.1.0-highlights]

Expand All @@ -47,10 +47,10 @@ Search:
* [#52](https://github.com/elastic/elasticsearch/pull/52)


## 9.0.10 [elasticsearch-9.0.10-release-notes]
```{applies_to}
stack: coming 9.0.10
```
## 9.0.10 [elasticsearch-9.0.10-release-notes]

### Features and enhancements [elasticsearch-9.0.10-features-enhancements]

Expand Down
2 changes: 1 addition & 1 deletion ...search/gradle/internal/release/ReleaseNotesGeneratorTest.index.no-highlights.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ To check for security updates, go to [Security announcements for the Elastic sta
% ### Fixes [elasticsearch-next-fixes]
% *

## 9.0.10 [elasticsearch-9.0.10-release-notes]
```{applies_to}
stack: coming 9.0.10
```
## 9.0.10 [elasticsearch-9.0.10-release-notes]

### Features and enhancements [elasticsearch-9.0.10-features-enhancements]

Expand Down
6 changes: 0 additions & 6 deletions muted-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,12 +534,6 @@ tests:
- class: org.elasticsearch.packaging.test.DockerTests
method: test040JavaUsesTheOsProvidedKeystore
issue: https://github.com/elastic/elasticsearch/issues/128230
- class: org.elasticsearch.gradle.internal.release.ReleaseNotesGeneratorTest
method: generateFile_index_rendersCorrectMarkup
issue: https://github.com/elastic/elasticsearch/issues/128772
- class: org.elasticsearch.gradle.internal.release.ReleaseNotesGeneratorTest
method: generateFile_index_noHighlights_rendersCorrectMarkup
issue: https://github.com/elastic/elasticsearch/issues/128773
- class: org.elasticsearch.xpack.rank.rrf.LinearRankClientYamlTestSuiteIT
method: test {yaml=linear/10_linear_retriever/should normalize initial scores with l2_norm}
issue: https://github.com/elastic/elasticsearch/issues/128774
Expand Down