Added DisplayName to MarkdownTest

Author: manjarekarsudip

exercises/practice/markdown/src/test/java/MarkdownTest.java

@@ -1,5 +1,6 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -14,6 +15,7 @@ public void setup() {
     }
 
     @Test
+    @DisplayName("Plain text is wrapped in a paragraph")
     public void normalTextAsAParagraph() {
         String input = "This will be a paragraph";
         String expected = "<p>This will be a paragraph</p>";
@@ -23,6 +25,7 @@ public void normalTextAsAParagraph() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Single underscore wraps text in <em> tags")
     public void italics() {
         String input = "_This will be italic_";
         String expected = "<p><em>This will be italic</em></p>";
@@ -32,6 +35,7 @@ public void italics() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Double underscore wraps text in <strong> tags")
     public void boldText() {
         String input = "__This will be bold__";
         String expected = "<p><strong>This will be bold</strong></p>";
@@ -41,6 +45,7 @@ public void boldText() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Mixed italics and bold inline formatting")
     public void normalItalicsAndBoldText() {
         String input = "This will _be_ __mixed__";
         String expected = "<p>This will <em>be</em> <strong>mixed</strong></p>";
@@ -50,6 +55,7 @@ public void normalItalicsAndBoldText() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("H1 header conversion")
     public void withH1HeaderLevel() {
         String input = "# This will be an h1";
         String expected = "<h1>This will be an h1</h1>";
@@ -59,6 +65,7 @@ public void withH1HeaderLevel() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("H2 header conversion")
     public void withH2HeaderLevel() {
         String input = "## This will be an h2";
         String expected = "<h2>This will be an h2</h2>";
@@ -68,6 +75,7 @@ public void withH2HeaderLevel() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("H3 header conversion")
     public void withH3HeaderLevel() {
         String input = "### This will be an h3";
         String expected = "<h3>This will be an h3</h3>";
@@ -77,6 +85,7 @@ public void withH3HeaderLevel() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("H4 header conversion")
     public void withH4HeaderLevel() {
         String input = "#### This will be an h4";
         String expected = "<h4>This will be an h4</h4>";
@@ -86,6 +95,7 @@ public void withH4HeaderLevel() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("H5 header conversion")
     public void withH5HeaderLevel() {
         String input = "##### This will be an h5";
         String expected = "<h5>This will be an h5</h5>";
@@ -95,6 +105,7 @@ public void withH5HeaderLevel() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("H6 header conversion")
     public void withH6HeaderLevel() {
         String input = "###### This will be an h6";
         String expected = "<h6>This will be an h6</h6>";
@@ -104,6 +115,7 @@ public void withH6HeaderLevel() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Line starting with 7 hashes is a paragraph")
     public void h7HeaderLevelIsAParagraph() {
         String input = "####### This will not be an h7";
         String expected = "<p>####### This will not be an h7</p>";
@@ -113,6 +125,7 @@ public void h7HeaderLevelIsAParagraph() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Consecutive lines starting with * become an unordered list")
     public void unorderedLists() {
         String input = "* Item 1\n* Item 2";
         String expected = "<ul><li>Item 1</li><li>Item 2</li></ul>";
@@ -122,6 +135,7 @@ public void unorderedLists() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Combined header and list formatting")
     public void aLittleBitOfEverything() {
         String input = "# Header!\n* __Bold Item__\n* _Italic Item_";
         String expected = "<h1>Header!</h1><ul><li><strong>Bold Item</strong></li><li><em>Italic Item</em></li></ul>";
@@ -131,6 +145,7 @@ public void aLittleBitOfEverything() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Markdown symbols inside headers are treated as text")
     public void markdownSymbolsInTheHeaderShouldNotBeInterpreted() {
         String input = "# This is a header with # and * in the text";
         String expected = "<h1>This is a header with # and * in the text</h1>";
@@ -140,6 +155,7 @@ public void markdownSymbolsInTheHeaderShouldNotBeInterpreted() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Markdown symbols inside list items are treated as text")
     public void markdownSymbolsInTheListItemTextShouldNotBeInterpreted() {
         String input = "* Item 1 with a # in the text\n* Item 2 with * in the text";
         String expected = "<ul><li>Item 1 with a # in the text</li><li>Item 2 with * in the text</li></ul>";
@@ -149,6 +165,7 @@ public void markdownSymbolsInTheListItemTextShouldNotBeInterpreted() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Markdown symbols inside paragraphs are treated as text")
     public void markdownSymbolsInTheParagraphTextShouldNotBeInterpreted() {
         String input = "This is a paragraph with # and * in the text";
         String expected = "<p>This is a paragraph with # and * in the text</p>";
@@ -158,6 +175,7 @@ public void markdownSymbolsInTheParagraphTextShouldNotBeInterpreted() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Lists close properly when surrounded by other blocks")
     public void markdownUnorderedListsCloseProperlyWithPrecedingAndFollowingLines() {
         String input = "# Start a list\n* Item 1\n* Item 2\nEnd a list";
         String expected = "<h1>Start a list</h1><ul><li>Item 1</li><li>Item 2</li></ul><p>End a list</p>";