View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2017 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle;
21  
22  import static java.util.Locale.ENGLISH;
23  import static org.junit.Assert.assertEquals;
24  
25  import java.io.File;
26  import java.nio.charset.StandardCharsets;
27  import java.nio.file.Files;
28  import java.nio.file.Paths;
29  
30  import org.junit.Test;
31  
32  import com.puppycrawl.tools.checkstyle.api.DetailAST;
33  import com.puppycrawl.tools.checkstyle.internal.utils.TestUtil;
34  
35  public class JavadocDetailNodeParserTest extends AbstractModuleTestSupport {
36  
37      private static final String OS_NAME = System.getProperty("os.name").toLowerCase(ENGLISH);
38  
39      @Override
40      protected String getPackageLocation() {
41          return "com/puppycrawl/tools/checkstyle/javadocdetailnodeparser";
42      }
43  
44      @Test
45      public void testParseJavadocAsDetailNode() throws Exception {
46          final DetailAST ast = TestUtil
47                  .parseFile(new File(getPath("InputJavadocDetailNodeParser.java"))).getNextSibling()
48                  .getFirstChild().getFirstChild();
49          final JavadocDetailNodeParser parser = new JavadocDetailNodeParser();
50          final JavadocDetailNodeParser.ParseStatus status = parser.parseJavadocAsDetailNode(ast);
51          final String actual = DetailNodeTreeStringPrinter.printTree(status.getTree(), "", "");
52          final String expected;
53  
54          // line separators in the input file while running this test on Windows are different,
55          // so when we try to print tree, output also will have different line separators on windows
56          // and linux.
57          if (OS_NAME.startsWith("windows")) {
58              expected = new String(Files.readAllBytes(Paths.get(
59                      getPath("ExpectedJavadocDetailNodeParserWindows.txt"))),
60                      StandardCharsets.UTF_8);
61          }
62          else {
63              expected = new String(Files.readAllBytes(Paths.get(
64                      getPath("ExpectedJavadocDetailNodeParser.txt"))),
65                      StandardCharsets.UTF_8);
66          }
67  
68          assertEquals("Invalid parse result", expected, actual);
69      }
70  
71  }