You are viewing a plain text version of this content. The canonical link for it is here.
Posted to easyant-commits@incubator.apache.org by jl...@apache.org on 2012/08/06 21:40:24 UTC

svn commit: r1370031 - in /incubator/easyant/plugins/trunk/javadoc/src/test: ./ antunit/ antunit/src/ antunit/src/main/ antunit/src/main/java/ antunit/src/main/java/org/ antunit/src/main/java/org/apache/ antunit/src/main/java/org/apache/easyant/ antuni...

Author: jlboudart
Date: Mon Aug  6 21:40:23 2012
New Revision: 1370031

URL: http://svn.apache.org/viewvc?rev=1370031&view=rev
Log:
Add missing javadoc test case

Added:
    incubator/easyant/plugins/trunk/javadoc/src/test/
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/javadoc-test.xml
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/sample-module.ivy
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/main/
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/main/java/
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/main/java/org/
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/main/java/org/apache/
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/main/java/org/apache/easyant/
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/main/java/org/apache/easyant/example/
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/main/java/org/apache/easyant/example/Example.java
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/test/
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/test/java/
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/test/java/org/
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/test/java/org/apache/
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/test/java/org/apache/easyant/
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/test/java/org/apache/easyant/example/
    incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/test/java/org/apache/easyant/example/Example2.java

Added: incubator/easyant/plugins/trunk/javadoc/src/test/antunit/javadoc-test.xml
URL: http://svn.apache.org/viewvc/incubator/easyant/plugins/trunk/javadoc/src/test/antunit/javadoc-test.xml?rev=1370031&view=auto
==============================================================================
--- incubator/easyant/plugins/trunk/javadoc/src/test/antunit/javadoc-test.xml (added)
+++ incubator/easyant/plugins/trunk/javadoc/src/test/antunit/javadoc-test.xml Mon Aug  6 21:40:23 2012
@@ -0,0 +1,68 @@
+<!--
+   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.
+-->
+<project name="org.apache.easyant.plugins;javadoc-test" 
+    xmlns:au="antlib:org.apache.ant.antunit" 
+    xmlns:ivy="antlib:org.apache.ivy.ant"
+    xmlns:ea="antlib:org.apache.easyant">
+    
+    <!-- Import your plugin --> 
+    <property name="target" value="${basedir}/target/test-antunit"/>
+    <!-- configure easyant in current project -->
+    <ea:configure-easyant-ivy-instance />
+    <!-- import our local plugin -->
+    <ea:import-test-module moduleIvy="../../../module.ivy" sourceDirectory="../../main/resources"/>
+   
+    <!-- Defines a setUp / tearDown (before each test) that cleans the environnement --> 
+    <target name="clean" description="remove stale build artifacts before / after each test">
+        <delete dir="${basedir}" includeemptydirs="true">
+            <include name="**/target/**"/>
+            <include name="**/lib/**"/>
+        </delete>
+    </target>
+    
+    <target name="setUp" depends="clean">
+       <ivy:settings id="project.ivy.instance"/>
+       <ivy:resolve file="sample-module.ivy" settingsRef="project.ivy.instance"/>
+    </target>
+    <target name="tearDown" depends="clean"/>
+    
+    <target name="test-javadoc:init" depends="javadoc:init">
+        <au:assertPropertyEquals name="src.main.java" value="${basedir}/src/main/java"/>
+        <au:assertPropertyEquals name="src.test.java" value="${basedir}/src/test/java"/>
+        <au:assertPropertyEquals name="javadoc.file.encoding" value="UTF-8"/>
+        <au:assertPropertyEquals name="target.reports" value="${target}/reports"/>
+        <au:assertPropertyEquals name="target.javadoc" value="${target.reports}/javadoc"/>
+        <au:assertPropertyEquals name="target.javadoc.main" value="${target.javadoc}/main"/>
+        <au:assertPropertyEquals name="target.javadoc.test" value="${target.javadoc}/test"/>
+        <au:assertPropertyEquals name="javadoc.publish.conf" value="documentation"/>
+    </target>
+
+    <target name="test-javadoc:main" depends="-javadoc:main">
+       <au:assertReferenceSet refid="java.main.source.path"/>
+       <au:assertFileExists file="${target.javadoc.main}"/>
+    </target>
+
+    <target name="test-javadoc:test" depends="-javadoc:test">
+       <au:assertReferenceSet refid="java.test.source.path"/>
+       <au:assertFileExists file="${target.javadoc.test}"/>
+    </target>
+
+    <target name="test-javadoc:package" depends="javadoc:package">
+        <au:assertFileExists file="${target.artifacts}"/>
+        <au:assertFileExists file="${target.artifacts}/${ivy.module}-javadoc.zip"/>
+    </target>
+</project>

Added: incubator/easyant/plugins/trunk/javadoc/src/test/antunit/sample-module.ivy
URL: http://svn.apache.org/viewvc/incubator/easyant/plugins/trunk/javadoc/src/test/antunit/sample-module.ivy?rev=1370031&view=auto
==============================================================================
--- incubator/easyant/plugins/trunk/javadoc/src/test/antunit/sample-module.ivy (added)
+++ incubator/easyant/plugins/trunk/javadoc/src/test/antunit/sample-module.ivy Mon Aug  6 21:40:23 2012
@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<!--
+   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.
+-->
+<ivy-module version="2.0" xmlns:ea="http://www.easyant.org"> 
+    <info organisation="org.apache.easyant" module="standard-java-app" revision="0.1" status="integration"/>
+    <configurations>
+        <conf name="default" description="runtime dependencies artifact can be used with this conf"/>
+        <conf name="test" description="this scope indicates that the dependency is not required for normal use of the application, and is only available for the test compilation and execution phases."/>
+        <conf name="provided" description="this is much like compile, but indicates you expect the JDK or a container to provide it. It is only available on the compilation classpath, and is not transitive."/>
+    </configurations>
+    <dependencies>
+        <dependency org="junit" name="junit" rev="4.4" conf="*->default"/>
+    </dependencies>
+
+</ivy-module>

Added: incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/main/java/org/apache/easyant/example/Example.java
URL: http://svn.apache.org/viewvc/incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/main/java/org/apache/easyant/example/Example.java?rev=1370031&view=auto
==============================================================================
--- incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/main/java/org/apache/easyant/example/Example.java (added)
+++ incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/main/java/org/apache/easyant/example/Example.java Mon Aug  6 21:40:23 2012
@@ -0,0 +1,36 @@
+/*
+ *  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.easyant.example;
+
+import java.io.IOException;
+import java.util.Properties;
+
+public class Example {
+    public static void main(String[] args) throws IOException {
+        System.out.println(new Example().sayHello("EasyAnt"));
+    }
+
+    /* 
+     * @param who Who says hello
+     */
+    public String sayHello(String who) throws IOException {
+        Properties props = new Properties();
+        props.load(Example.class.getResourceAsStream("/main.properties"));
+        return props.getProperty("example") + " " + who + "!";
+    }
+}

Added: incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/test/java/org/apache/easyant/example/Example2.java
URL: http://svn.apache.org/viewvc/incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/test/java/org/apache/easyant/example/Example2.java?rev=1370031&view=auto
==============================================================================
--- incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/test/java/org/apache/easyant/example/Example2.java (added)
+++ incubator/easyant/plugins/trunk/javadoc/src/test/antunit/src/test/java/org/apache/easyant/example/Example2.java Mon Aug  6 21:40:23 2012
@@ -0,0 +1,40 @@
+/*
+ *  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.easyant.example;
+
+import java.io.IOException;
+import java.util.Properties;
+
+public class Example {
+    public static void main(String[] args) throws IOException {
+        System.out.println(new Example().sayHello("EasyAnt"));
+    }
+
+    /* 
+     * @param who Who says hello
+     */
+    public String sayHello(String who) throws IOException {
+        Properties props = new Properties();
+        props.load(Example.class.getResourceAsStream("/main.properties"));
+        return props.getProperty("example") + " " + who + "!";
+    }
+    public String CheckstyleShouldComplainAboutMethodName() throws IOException {
+        return "CheckstyleShouldComplainAboutMethodName !";
+    }
+
+}