///////////////////////////////////////////////////////////////////////////////////////////////
   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
   // Copyright (C) 2001-2025 the original author or authors.
   //
   // This library is free software; you can redistribute it and/or
   // modify it under the terms of the GNU Lesser General Public
   // License as published by the Free Software Foundation; either
   // version 2.1 of the License, or (at your option) any later version.
   //
  // This library is distributed in the hope that it will be useful,
  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  // Lesser General Public License for more details.
  //
  // You should have received a copy of the GNU Lesser General Public
  // License along with this library; if not, write to the Free Software
  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  ///////////////////////////////////////////////////////////////////////////////////////////////
  
  package org.checkstyle.suppressionxpathfilter.javadoc;
  
  import java.io.File;
  import java.util.Arrays;
  import java.util.List;
  
  import org.checkstyle.suppressionxpathfilter.AbstractXpathTestSupport;
  import org.junit.jupiter.api.Test;
  
  import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
  import com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck;
  
  public class XpathRegressionMissingJavadocPackageTest extends AbstractXpathTestSupport {
  
      private final String checkName = MissingJavadocPackageCheck.class.getSimpleName();
  
      @Override
      protected String getCheckName() {
          return checkName;
      }
  
      @Override
      protected String getPackageLocation() {
          return "org/checkstyle/suppressionxpathfilter/javadoc/missingjavadocpackage";
      }
  
      @Test
      public void testBlockComment() throws Exception {
          final File fileToProcess = new File(getPath(
                  "blockcomment/package-info.java"));
  
          final DefaultConfiguration moduleConfig =
                  createModuleConfig(MissingJavadocPackageCheck.class);
  
          final String[] expectedViolation = {
              "4:1: " + getCheckMessage(MissingJavadocPackageCheck.class,
                  MissingJavadocPackageCheck.MSG_PKG_JAVADOC_MISSING),
          };
          final List<String> expectedXpathQueries = Arrays.asList(
              "/COMPILATION_UNIT", "/COMPILATION_UNIT/PACKAGE_DEF"
          );
  
          runVerifications(moduleConfig, fileToProcess, expectedViolation,
                  expectedXpathQueries);
      }
  
      @Test
      public void testNoJavadoc() throws Exception {
          final File fileToProcess = new File(getPath(
                  "nojavadoc/package-info.java"));
  
          final DefaultConfiguration moduleConfig =
                  createModuleConfig(MissingJavadocPackageCheck.class);
  
          final String[] expectedViolation = {
              "1:1: " + getCheckMessage(MissingJavadocPackageCheck.class,
                  MissingJavadocPackageCheck.MSG_PKG_JAVADOC_MISSING),
          };
  
          final List<String> expectedXpathQueries = Arrays.asList(
              "/COMPILATION_UNIT", "/COMPILATION_UNIT/PACKAGE_DEF"
          );
  
          runVerifications(moduleConfig, fileToProcess, expectedViolation,
                  expectedXpathQueries);
      }
  
  }