Ensure build works for Windows aws#986

Adding convenience method that allows to replace '\n' characters with the platform-dependent ones and applying it to affected test data.
Supplementing CHANGELOG.MD with changes' description. Clarifying necessity of using the new-change script for such actions.

Author: Alexander Kiselyov

.changes/next-release/bugfix-AWSSDKforJavav2-75385bc.json

@@ -0,0 +1,5 @@
+{
+    "description": "Code Generator test failures on Windows systems were fixed.", 
+    "type": "bugfix", 
+    "category": "AWS SDK for Java v2"
+}

CONTRIBUTING.md

@@ -123,7 +123,7 @@ checklist below:
 * [ ] If the change is related to an existing Bug Report or Feature Request,
   the issue number is referenced
 * [ ] A short description of the change added to
-  [CHANGELOG.md](./CHANGELOG.md). Adding a new entry can be accomplished by
+  [CHANGELOG.md](./CHANGELOG.md). Adding a new entry must be accomplished by
   running the `scripts/new-change` script and following the instructions.
   Commit the new file created by the script in `.changes/next-release` with
   your changes.

codegen/src/test/java/software/amazon/awssdk/codegen/TestStringUtils.java

@@ -0,0 +1,28 @@
+package software.amazon.awssdk.codegen;
+
+import software.amazon.awssdk.codegen.internal.Constant;
+
+/**
+ * Various convenience methods for strings manipulation required in Code Generator tests.
+ */
+public final class TestStringUtils {
+
+    /**
+     * Not intended to be constructed directly.
+     */
+    private TestStringUtils() {
+    }
+
+    /**
+     * Replaces all the newline (line feed/LF) characters ('\u000A' or '\n') with the platform-dependent line separator char
+     * (e.g. "\u000D\u000A" or "\r\n" on Windows systems).
+     *
+     * @param str string, containing '\n' chars to be replaced
+     * @return original string with '\n' chars replaced with platform-dependent line separator chars
+     * @see Constant#LF
+     */
+    public static String toPlatformLfs(String str) {
+        return str.replaceAll("\n", Constant.LF);
+    }
+
+}

codegen/src/test/java/software/amazon/awssdk/codegen/emitters/PoetGeneratorTaskIntegrationTest.java

@@ -20,6 +20,7 @@
 import static org.hamcrest.CoreMatchers.startsWith;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.core.CombinableMatcher.both;
+import static software.amazon.awssdk.codegen.TestStringUtils.toPlatformLfs;
 import static software.amazon.awssdk.utils.FunctionalUtils.safeConsumer;
 
 import com.squareup.javapoet.ClassName;
@@ -43,7 +44,7 @@ public final class PoetGeneratorTaskIntegrationTest {
     public void canGenerateJavaClass() throws Exception {
         String randomBaseDirectory = Files.createTempDirectory(getClass().getSimpleName()).toString();
         tempDirectories.add(randomBaseDirectory);
-        String fileHeader = "/*\n * this is the file header\n */";
+        String fileHeader = toPlatformLfs("/*\n * this is the file header\n */");
         ClassSpec classSpec = dummyClass();
 
         PoetGeneratorTask sut = new PoetGeneratorTask(randomBaseDirectory, fileHeader, classSpec);

codegen/src/test/java/software/amazon/awssdk/codegen/model/intermediate/DocumentationBuilderTest.java

@@ -17,36 +17,36 @@
 
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static software.amazon.awssdk.codegen.TestStringUtils.toPlatformLfs;
 
 import org.junit.Test;
 import software.amazon.awssdk.codegen.docs.DocumentationBuilder;
 
-
 public class DocumentationBuilderTest {
 
     @Test
     public void javadocFormattedCorrectly() {
         String docs = new DocumentationBuilder()
-                .description("Some service docs")
-                .param("paramOne", "param one docs")
-                .param("paramTwo", "param two docs")
-                .returns("This returns something")
-                .syncThrows("FooException", "Thrown when foo happens")
-                .syncThrows("BarException", "Thrown when bar happens")
-                .tag("sample", "FooService.FooOperation")
-                .see("this thing")
-                .see("this other thing")
-                .build();
-        assertThat(docs).isEqualTo("Some service docs\n" +
-                                   "\n" +
-                                   "@param paramOne param one docs\n" +
-                                   "@param paramTwo param two docs\n" +
-                                   "@return This returns something\n" +
-                                   "@throws FooException Thrown when foo happens\n" +
-                                   "@throws BarException Thrown when bar happens\n" +
-                                   "@sample FooService.FooOperation\n" +
-                                   "@see this thing\n" +
-                                   "@see this other thing\n");
+            .description("Some service docs")
+            .param("paramOne", "param one docs")
+            .param("paramTwo", "param two docs")
+            .returns("This returns something")
+            .syncThrows("FooException", "Thrown when foo happens")
+            .syncThrows("BarException", "Thrown when bar happens")
+            .tag("sample", "FooService.FooOperation")
+            .see("this thing")
+            .see("this other thing")
+            .build();
+        assertThat(docs).isEqualTo(toPlatformLfs("Some service docs\n" +
+                                                 "\n" +
+                                                 "@param paramOne param one docs\n" +
+                                                 "@param paramTwo param two docs\n" +
+                                                 "@return This returns something\n" +
+                                                 "@throws FooException Thrown when foo happens\n" +
+                                                 "@throws BarException Thrown when bar happens\n" +
+                                                 "@sample FooService.FooOperation\n" +
+                                                 "@see this thing\n" +
+                                                 "@see this other thing\n"));
     }
 
     /**
@@ -57,55 +57,55 @@ public void javadocFormattedCorrectly() {
     @Test
     public void asyncReturns_FormatsExceptionsInUnorderedList() {
         String docs = new DocumentationBuilder()
-                .description("Some service docs")
-                .param("paramOne", "param one docs")
-                .returns("CompletableFuture of success")
-                .asyncThrows("FooException", "Foo docs")
-                .asyncThrows("BarException", "Bar docs")
-                .build();
-        assertThat(docs).isEqualTo("Some service docs\n" +
-                                   "\n" +
-                                   "@param paramOne param one docs\n" +
-                                   "@return CompletableFuture of success<br/>\n" +
-                                   "The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.\n" +
-                                   "<ul>\n" +
-                                   "<li>FooException Foo docs</li>\n" +
-                                   "<li>BarException Bar docs</li>\n" +
-                                   "</ul>\n");
+            .description("Some service docs")
+            .param("paramOne", "param one docs")
+            .returns("CompletableFuture of success")
+            .asyncThrows("FooException", "Foo docs")
+            .asyncThrows("BarException", "Bar docs")
+            .build();
+        assertThat(docs).isEqualTo(toPlatformLfs("Some service docs\n" +
+                                                 "\n" +
+                                                 "@param paramOne param one docs\n" +
+                                                 "@return CompletableFuture of success<br/>\n" +
+                                                 "The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.\n" +
+                                                 "<ul>\n" +
+                                                 "<li>FooException Foo docs</li>\n" +
+                                                 "<li>BarException Bar docs</li>\n" +
+                                                 "</ul>\n"));
 
     }
 
     @Test
     public void asyncReturnsWithoutDocsForSuccessReturn_FormatsExceptionsInUnorderedList() {
         String docs = new DocumentationBuilder()
-                .description("Some service docs")
-                .param("paramOne", "param one docs")
-                .asyncThrows("FooException", "Foo docs")
-                .asyncThrows("BarException", "Bar docs")
-                .build();
-        assertThat(docs).isEqualTo("Some service docs\n" +
-                                   "\n" +
-                                   "@param paramOne param one docs\n" +
-                                   "@return A CompletableFuture indicating when result will be completed.<br/>\n" +
-                                   "The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.\n" +
-                                   "<ul>\n" +
-                                   "<li>FooException Foo docs</li>\n" +
-                                   "<li>BarException Bar docs</li>\n" +
-                                   "</ul>\n");
+            .description("Some service docs")
+            .param("paramOne", "param one docs")
+            .asyncThrows("FooException", "Foo docs")
+            .asyncThrows("BarException", "Bar docs")
+            .build();
+        assertThat(docs).isEqualTo(toPlatformLfs("Some service docs\n" +
+                                                 "\n" +
+                                                 "@param paramOne param one docs\n" +
+                                                 "@return A CompletableFuture indicating when result will be completed.<br/>\n" +
+                                                 "The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.\n" +
+                                                 "<ul>\n" +
+                                                 "<li>FooException Foo docs</li>\n" +
+                                                 "<li>BarException Bar docs</li>\n" +
+                                                 "</ul>\n"));
     }
 
     @Test
     public void missingValuesAreNotPresent() {
         String docs = new DocumentationBuilder()
-                .description("Some service docs")
-                .build();
-        assertThat(docs).isEqualTo("Some service docs\n\n");
+            .description("Some service docs")
+            .build();
+        assertThat(docs).isEqualTo(toPlatformLfs("Some service docs\n\n"));
     }
 
     @Test
     public void allValuesMissing_ProducesEmptyDocString() {
         String docs = new DocumentationBuilder()
-                .build();
+            .build();
         assertThat(docs).isEqualTo("");
     }