Merge pull request #1480 from Hccake/fix-linebreak

bnasslahsen · web-flow · commit 9f73f4ec379b · 2022-01-28T11:19:49.000+01:00
Fix the problem that the inconsistent newline characters of different platforms
diff --git a/springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/AbstractCommonTest.java b/springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/AbstractCommonTest.java
@@ -4,6 +4,7 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.List;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -25,8 +26,12 @@ public abstract class AbstractCommonTest {
 	protected String getContent(String fileName) {
 		try {
 			Path path = Paths.get(AbstractCommonTest.class.getClassLoader().getResource(fileName).toURI());
-			byte[] fileBytes = Files.readAllBytes(path);
-			return new String(fileBytes, StandardCharsets.UTF_8);
+			List<String> lines = Files.readAllLines(path, StandardCharsets.UTF_8);
+			StringBuilder sb = new StringBuilder();
+			for (String line : lines) {
+				sb.append(line).append("\n");
+			}
+			return sb.toString();
 		}
 		catch (Exception e) {
 			throw new RuntimeException("Failed to read file: " + fileName, e);
diff --git a/springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/AbstractSpringDocTest.java b/springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/AbstractSpringDocTest.java
@@ -39,8 +39,9 @@ protected void checkHTML(String fileName, String uri)throws Exception {
 		MvcResult mvcResult = mockMvc.perform(get(uri)).andExpect(status().isOk()).andReturn();
 		String transformedIndex = mvcResult.getResponse().getContentAsString();
 		assertTrue(transformedIndex.contains("Swagger UI"));
-		assertEquals(this.getContent(fileName), transformedIndex);
+		assertEquals(this.getContent(fileName), transformedIndex.replace("\r", ""));
 	}
+
 	protected void chekHTML(String fileName) throws Exception {
 		checkHTML( fileName, DEFAULT_SWAGGER_UI_URL);
 	}
@@ -50,4 +51,9 @@ protected void chekHTML() throws Exception {
 		String testNumber = className.replaceAll("[^0-9]", "");
 		checkHTML( "results/app" + testNumber, DEFAULT_SWAGGER_UI_URL);
 	}
+
+	protected void checkHTMLResult(String fileName, String htmlResult)throws Exception {
+		assertTrue(htmlResult.contains("Swagger UI"));
+		assertEquals(this.getContent(fileName), htmlResult.replace("\r", ""));
+	}
 }
diff --git a/springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocConfigPathsTest.java b/springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocConfigPathsTest.java
@@ -50,8 +50,7 @@ public void should_display_swaggerui_page() throws Exception {
 
 		MvcResult mvcResult = mockMvc.perform(get("/context-path/servlet-path/test/swagger-ui/index.html").contextPath("/context-path").servletPath("/servlet-path")).andExpect(status().isOk()).andReturn();
 		String transformedIndex = mvcResult.getResponse().getContentAsString();
-		assertTrue(transformedIndex.contains("Swagger UI"));
-		assertEquals(this.getContent("results/app1-contextpath"), transformedIndex);
+        checkHTMLResult("results/app1-contextpath", transformedIndex);
     }
 
     @SpringBootApplication
diff --git a/springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app5/SpringDocOauthServletPathsTest.java b/springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app5/SpringDocOauthServletPathsTest.java
@@ -47,8 +47,7 @@ public void should_display_oauth2_redirect_page() throws Exception {
 
 		MvcResult mvcResult = mockMvc.perform(get("/context-path/servlet-path/test/swagger-ui/index.html").servletPath("/servlet-path").contextPath("/context-path")).andExpect(status().isOk()).andReturn();
 		String transformedIndex = mvcResult.getResponse().getContentAsString();
-		assertTrue(transformedIndex.contains("Swagger UI"));
-		assertEquals(this.getContent("results/app5-contextpath"), transformedIndex);
+		checkHTMLResult("results/app5-contextpath", transformedIndex);
 	}
 
 	@Test
diff --git a/springdoc-openapi-webflux-ui/src/test/java/test/org/springdoc/ui/AbstractCommonTest.java b/springdoc-openapi-webflux-ui/src/test/java/test/org/springdoc/ui/AbstractCommonTest.java
@@ -4,6 +4,7 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.List;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -25,8 +26,12 @@ public abstract class AbstractCommonTest {
 	protected String getContent(String fileName) {
 		try {
 			Path path = Paths.get(AbstractCommonTest.class.getClassLoader().getResource(fileName).toURI());
-			byte[] fileBytes = Files.readAllBytes(path);
-			return new String(fileBytes, StandardCharsets.UTF_8);
+			List<String> lines = Files.readAllLines(path, StandardCharsets.UTF_8);
+			StringBuilder sb = new StringBuilder();
+			for (String line : lines) {
+				sb.append(line).append("\n");
+			}
+			return sb.toString();
 		}
 		catch (Exception e) {
 			throw new RuntimeException("Failed to read file: " + fileName, e);
diff --git a/springdoc-openapi-webflux-ui/src/test/java/test/org/springdoc/ui/AbstractSpringDocTest.java b/springdoc-openapi-webflux-ui/src/test/java/test/org/springdoc/ui/AbstractSpringDocTest.java
@@ -51,26 +51,18 @@ public abstract class AbstractSpringDocTest extends AbstractCommonTest {
 
 	private static final String DEFAULT_SWAGGER_UI_URL= Constants.DEFAULT_WEB_JARS_PREFIX_URL  + Constants.SWAGGER_UI_URL;
 
-	protected String getContent(String fileName) {
-		try {
-			Path path = Paths.get(AbstractSpringDocTest.class.getClassLoader().getResource(fileName).toURI());
-			byte[] fileBytes = Files.readAllBytes(path);
-			return new String(fileBytes, StandardCharsets.UTF_8);
-		}
-		catch (Exception e) {
-			throw new RuntimeException("Failed to read file: " + fileName, e);
-		}
-	}
-
 	protected void checkHTML(String fileName, String uri) {
 		EntityExchangeResult<byte[]> getResult = webTestClient.get().uri(uri)
 				.exchange()
 				.expectStatus().isOk()
 				.expectBody().returnResult();
-		String result = new String(getResult.getResponseBody());
+		checkHTMLResult(fileName, new String(getResult.getResponseBody()));
+	}
+
+	protected void checkHTMLResult(String fileName, String result) {
 		assertTrue(result.contains("Swagger UI"));
 		String expected = getContent("results/" + fileName);
-		assertEquals(expected, result);
+		assertEquals(expected, result.replace("\r", ""));
 	}
 
 	protected void checkHTML(String fileName) {
diff --git a/springdoc-openapi-webflux-ui/src/test/java/test/org/springdoc/ui/app6/SpringDocApp6Test.java b/springdoc-openapi-webflux-ui/src/test/java/test/org/springdoc/ui/app6/SpringDocApp6Test.java
@@ -42,10 +42,7 @@ public void transformed_index_with_oauth() throws Exception {
 				.exchange()
 				.expectStatus().isOk()
 				.expectBody().returnResult();
-		String result = new String(getResult.getResponseBody());
-		assertTrue(result.contains("Swagger UI"));
-		String expected = getContent("results/index6");
-		assertEquals(expected, result);
+		checkHTMLResult("index6", new String(getResult.getResponseBody()));
 	}
 
 	@SpringBootApplication
diff --git a/springdoc-openapi-webflux-ui/src/test/java/test/org/springdoc/ui/app7/SpringDocApp7Test.java b/springdoc-openapi-webflux-ui/src/test/java/test/org/springdoc/ui/app7/SpringDocApp7Test.java
@@ -42,10 +42,7 @@ public void transformed_index_with_oauth() throws Exception {
 				.exchange()
 				.expectStatus().isOk()
 				.expectBody().returnResult();
-		String result = new String(getResult.getResponseBody());
-		assertTrue(result.contains("Swagger UI"));
-		String expected = getContent("results/index7");
-		assertEquals(expected, result);
+		checkHTMLResult("index7", new String(getResult.getResponseBody()));
 	}
 
 	@SpringBootApplication

Original file line number	Diff line number	Diff line change
`@@ -39,8 +39,9 @@ protected void checkHTML(String fileName, String uri)throws Exception {`
`39`	`39`	`MvcResult mvcResult = mockMvc.perform(get(uri)).andExpect(status().isOk()).andReturn();`
`40`	`40`	`String transformedIndex = mvcResult.getResponse().getContentAsString();`
`41`	`41`	`assertTrue(transformedIndex.contains("Swagger UI"));`
`42`		`- assertEquals(this.getContent(fileName), transformedIndex);`
	`42`	`+ assertEquals(this.getContent(fileName), transformedIndex.replace("\r", ""));`
`43`	`43`	`}`
	`44`	`+`
`44`	`45`	`protected void chekHTML(String fileName) throws Exception {`
`45`	`46`	`checkHTML( fileName, DEFAULT_SWAGGER_UI_URL);`
`46`	`47`	`}`
`@@ -50,4 +51,9 @@ protected void chekHTML() throws Exception {`
`50`	`51`	`String testNumber = className.replaceAll("[^0-9]", "");`
`51`	`52`	`checkHTML( "results/app" + testNumber, DEFAULT_SWAGGER_UI_URL);`
`52`	`53`	`}`
	`54`	`+`
	`55`	`+ protected void checkHTMLResult(String fileName, String htmlResult)throws Exception {`
	`56`	`+ assertTrue(htmlResult.contains("Swagger UI"));`
	`57`	`+ assertEquals(this.getContent(fileName), htmlResult.replace("\r", ""));`
	`58`	`+ }`
`53`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,8 +50,7 @@ public void should_display_swaggerui_page() throws Exception {`
`50`	`50`
`51`	`51`	`MvcResult mvcResult = mockMvc.perform(get("/context-path/servlet-path/test/swagger-ui/index.html").contextPath("/context-path").servletPath("/servlet-path")).andExpect(status().isOk()).andReturn();`
`52`	`52`	`String transformedIndex = mvcResult.getResponse().getContentAsString();`
`53`		`- assertTrue(transformedIndex.contains("Swagger UI"));`
`54`		`- assertEquals(this.getContent("results/app1-contextpath"), transformedIndex);`
	`53`	`+ checkHTMLResult("results/app1-contextpath", transformedIndex);`
`55`	`54`	`}`
`56`	`55`
`57`	`56`	`@SpringBootApplication`
Original file line number	Diff line number	Diff line change
`@@ -47,8 +47,7 @@ public void should_display_oauth2_redirect_page() throws Exception {`
`47`	`47`
`48`	`48`	`MvcResult mvcResult = mockMvc.perform(get("/context-path/servlet-path/test/swagger-ui/index.html").servletPath("/servlet-path").contextPath("/context-path")).andExpect(status().isOk()).andReturn();`
`49`	`49`	`String transformedIndex = mvcResult.getResponse().getContentAsString();`
`50`		`- assertTrue(transformedIndex.contains("Swagger UI"));`
`51`		`- assertEquals(this.getContent("results/app5-contextpath"), transformedIndex);`
	`50`	`+ checkHTMLResult("results/app5-contextpath", transformedIndex);`
`52`	`51`	`}`
`53`	`52`
`54`	`53`	`@Test`