/*
* 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.codehaus.groovy.tools.groovydoc;
import groovy.util.CharsetToolkit;
import org.apache.tools.ant.BuildFileTest;
import org.codehaus.groovy.runtime.ResourceGroovyMethods;
import java.io.File;
import java.io.FilenameFilter;
import java.nio.charset.Charset;
import java.util.List;
/**
* @author Andre Steingress
*/
public class GroovyDocTest extends BuildFileTest {
private static final String SRC_TESTFILES;
private File tmpDir;
static{
String groovyDocResourcesPathInSubproject = "src/test/resources/groovydoc/";
String groovyDocResourcesPathFromMainProject = "subprojects/groovy-groovydoc/" + groovyDocResourcesPathInSubproject;
if (new File(groovyDocResourcesPathInSubproject).exists()){
SRC_TESTFILES = groovyDocResourcesPathInSubproject;
}
else if (new File(groovyDocResourcesPathFromMainProject).exists()){
SRC_TESTFILES = groovyDocResourcesPathFromMainProject;
}
else {
fail("Could not identify path to resources dir.");
SRC_TESTFILES = "";
}
}
public GroovyDocTest(String name) {
super(name);
}
@Override
public void setUp() throws Exception {
configureProject(SRC_TESTFILES + "groovyDocTests.xml");
tmpDir = new File(getProject().getProperty("tmpdir"));
}
@Override
protected void tearDown() throws Exception {
ResourceGroovyMethods.deleteDir(tmpDir);
super.tearDown();
}
public void testCustomClassTemplate() throws Exception {
executeTarget("testCustomClassTemplate");
final File testfilesPackageDir = new File(tmpDir, "org/codehaus/groovy/tools/groovydoc/testfiles");
System.err.println("testfilesPackageDir = " + testfilesPackageDir);
final String[] list = testfilesPackageDir.list(new FilenameFilter() {
public boolean accept(File file, String name) {
return name.equals("DocumentedClass.html");
}
});
assertNotNull("Dir not found: " + testfilesPackageDir.getAbsolutePath(), list);
assertEquals(1, list.length);
File documentedClassHtmlDoc = new File(testfilesPackageDir, list[0]);
List<String> lines = ResourceGroovyMethods.readLines(documentedClassHtmlDoc);
assertTrue("\"<title>DocumentedClass</title>\" not in: " + lines, lines.contains("<title>DocumentedClass</title>"));
assertTrue("\"This is a custom class template.\" not in: " + lines, lines.contains("This is a custom class template."));
}
public void testFileEncoding() throws Exception {
executeTarget("testFileEncoding");
final File testfilesPackageDir = new File(tmpDir, "org/codehaus/groovy/tools/groovydoc/testfiles");
System.err.println("testfilesPackageDir = " + testfilesPackageDir);
final String[] list = testfilesPackageDir.list(new FilenameFilter() {
public boolean accept(File file, String name) {
return name.equals("DocumentedClass.html");
}
});
File documentedClassHtmlDoc = new File(testfilesPackageDir, list[0]);
CharsetToolkit charsetToolkit = new CharsetToolkit(documentedClassHtmlDoc);
assertEquals("The generated groovydoc must be in 'UTF-16LE' file encoding.'", Charset.forName("UTF-16LE"), charsetToolkit.getCharset());
}
}