/*
    * Licensed to the Apache Software Foundation (ASF) under one   *
    * or more contributor license agreements.  See the NOTICE file *
    * distributed with this work for additional information        *
    * regarding copyright ownership.  The ASF licenses this file   *
    * to you under the Apache License, Version 2.0 (the            *
    * "License"); you may not use this file except in compliance   *
    * with the License.  You may obtain a copy of the License at   *
    *                                                              *
   *   http://www.apache.org/licenses/LICENSE-2.0                 *
   *                                                              *
   * Unless required by applicable law or agreed to in writing,   *
   * software distributed under the License is distributed on an  *
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
   * KIND, either express or implied.  See the License for the    *
   * specific language governing permissions and limitations      *
   * under the License.                                           *
   */
  package org.apache.rat.analysis.generation;
  
  import org.apache.commons.io.IOUtils;
  import org.apache.rat.api.Document;
  import org.apache.rat.document.MockLocation;
  import org.apache.rat.report.claim.impl.xml.MockClaimReporter;
  import org.apache.rat.test.utils.Resources;
  import org.junit.Before;
  import org.junit.Test;
  
  import java.io.BufferedReader;
  import java.io.File;
  import java.io.FileReader;
  
  import static org.junit.Assert.assertFalse;
  import static org.junit.Assert.assertTrue;
  
  public class JavaDocLicenseNotRequiredTest {
  
      private MockClaimReporter reporter;
      private JavaDocLicenseNotRequired license;
  
      @Before
      public void setUp() throws Exception {
          license = new JavaDocLicenseNotRequired();
          reporter = new MockClaimReporter();
      }
  
      @Test
      public void matchIndexDoc() throws Exception {
          boolean result = readAndMatch("index.html");
          assertTrue("Is a javadoc", result);
      }
  
      @Test
      public void matchClassDoc() throws Exception {
          boolean result = readAndMatch("ArchiveElement.html");
          assertTrue("Is a javadoc", result);
      }
  
      @Test
      public void matchNonJavaDoc() throws Exception {
          boolean result = readAndMatch("notjavadoc.html");
          assertFalse("Not javadocs and so should return null", result);
      }
  
      boolean readAndMatch(String name) throws Exception {
          File file = Resources.getResourceFile("javadocs/" + name);
          boolean result = false;
          BufferedReader in = null;
          try {
              in = new BufferedReader(new FileReader(file));
              String line = in.readLine();
              final Document subject = new MockLocation("subject");
              while (line != null && !result) {
                  result = license.match(subject, line);
                  line = in.readLine();
              }
          } finally {
                  IOUtils.closeQuietly(in);
          }
              return result;
          }
      }