View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2024 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 com.google.common.truth.Truth.assertWithMessage;
23  
24  import java.io.File;
25  import java.nio.file.Files;
26  import java.nio.file.Paths;
27  
28  import org.junit.jupiter.api.Test;
29  
30  import com.puppycrawl.tools.checkstyle.api.DetailAST;
31  
32  public class JavadocDetailNodeParserTest extends AbstractModuleTestSupport {
33  
34      @Override
35      protected String getPackageLocation() {
36          return "com/puppycrawl/tools/checkstyle/javadocdetailnodeparser";
37      }
38  
39      @Test
40      public void testParseJavadocAsDetailNode() throws Exception {
41          final DetailAST ast = JavaParser.parseFile(
42              new File(getPath("InputJavadocDetailNodeParser.java")),
43              JavaParser.Options.WITH_COMMENTS)
44                  .getFirstChild().getNextSibling().getFirstChild().getFirstChild();
45          final JavadocDetailNodeParser parser = new JavadocDetailNodeParser();
46          final JavadocDetailNodeParser.ParseStatus status = parser.parseJavadocAsDetailNode(ast);
47          final String actual = toLfLineEnding(DetailNodeTreeStringPrinter.printTree(status.getTree(),
48                  "", ""));
49          final String expected = toLfLineEnding(Files.readString(Paths.get(
50                  getPath("ExpectedJavadocDetailNodeParser.txt"))));
51          assertWithMessage("Invalid parse result")
52                  .that(actual)
53                  .isEqualTo(expected);
54      }
55  
56  }