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/10/01 18:39:39 UTC

svn commit: r1392507 - in /incubator/easyant/plugins/trunk/easyant-plugin-documentation: ./ src/ src/main/ src/main/resources/ src/test/ src/test/antunit/ src/test/antunit/src/ src/test/antunit/src/main/ src/test/antunit/src/main/resources/

Author: jlboudart
Date: Mon Oct  1 18:39:38 2012
New Revision: 1392507

URL: http://svn.apache.org/viewvc?rev=1392507&view=rev
Log:
Add easyant-plugin-documentation

Added:
    incubator/easyant/plugins/trunk/easyant-plugin-documentation/
    incubator/easyant/plugins/trunk/easyant-plugin-documentation/module.ivy
    incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/
    incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/main/
    incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/main/resources/
    incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/main/resources/easyant-plugin-documentation.ant
    incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/
    incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/
    incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/easyant-plugin-documentation-test.xml
    incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/sample-module.ivy
    incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/src/
    incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/src/main/
    incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/src/main/resources/
    incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/src/main/resources/tinyplugin.ant

Added: incubator/easyant/plugins/trunk/easyant-plugin-documentation/module.ivy
URL: http://svn.apache.org/viewvc/incubator/easyant/plugins/trunk/easyant-plugin-documentation/module.ivy?rev=1392507&view=auto
==============================================================================
--- incubator/easyant/plugins/trunk/easyant-plugin-documentation/module.ivy (added)
+++ incubator/easyant/plugins/trunk/easyant-plugin-documentation/module.ivy Mon Oct  1 18:39:38 2012
@@ -0,0 +1,31 @@
+<!--
+   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.plugins" module="easyant-plugin-documentation" status="integration" revision="0.9">
+        <ea:build organisation="org.apache.easyant.buildtypes" module="build-std-ant-plugin" revision="0.1"/>
+        <ea:plugin module="antunit" revision="0.9"/>
+    </info>
+    <configurations>
+        <conf name="default" visibility="public" description="runtime dependencies artifact can be used with this conf"/>
+        <conf name="test" visibility="private" 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" visibility="public" 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>
+    <publications>
+                <artifact name="easyant-plugin-documentation" type="ant"/>
+    </publications>
+
+</ivy-module>

Added: incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/main/resources/easyant-plugin-documentation.ant
URL: http://svn.apache.org/viewvc/incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/main/resources/easyant-plugin-documentation.ant?rev=1392507&view=auto
==============================================================================
--- incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/main/resources/easyant-plugin-documentation.ant (added)
+++ incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/main/resources/easyant-plugin-documentation.ant Mon Oct  1 18:39:38 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.
+-->
+<project name="org.apache.easyant.plugins;easyant-plugin-documentation" 
+        xmlns:ivy="antlib:org.apache.ivy.ant" 
+        xmlns:ea="antlib:org.apache.easyant">
+
+    <ea:core-version requiredrevision="[0.9,+]" />
+
+    <target name="easyant-plugin-documentation:report">
+        <ea:parameter property="plugindoc.module.ivy" description="plugin's module ivy used to know dependencies" default="${basedir}/module.ivy"/>
+        <ea:parameter property="plugindoc.source.dir" description="plugin's source dirrectory used to know targets/extensionPoints etc..." required="true"/>
+        <ea:parameter property="plugindoc.main.confs" description="plugin's main conf" default="default"/>
+        <ea:parameter property="plugindoc.todir" description="target directory where plugin doc will be generated" required="true"/>
+        <ea:plugin-report moduleIvy="${plugindoc.module.ivy}" sourceDirectory="${plugindoc.source.dir}" conf="${plugindoc.main.confs}" todir="${plugindoc.todir}"/>
+    </target>
+
+    <target name="easyant-plugin-documentation:register-artifact" depends="easyant-plugin-documentation:report">
+        <ea:parameter property="plugindoc.publish.type" default="html" description="default type for plugin documentation artifacts"/>
+        <ea:parameter property="plugindoc.publish.confs" default="documentation" description="default configurations for plugin documentation artifacts"/>
+
+
+        <ea:registerartifact type="${plugindoc.publish.type}" confs="${publishdoc.publish.confs}" settingsRef="easyant.ivy.instance"/>
+
+    </target>
+
+</project>

Added: incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/easyant-plugin-documentation-test.xml
URL: http://svn.apache.org/viewvc/incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/easyant-plugin-documentation-test.xml?rev=1392507&view=auto
==============================================================================
--- incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/easyant-plugin-documentation-test.xml (added)
+++ incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/easyant-plugin-documentation-test.xml Mon Oct  1 18:39:38 2012
@@ -0,0 +1,67 @@
+<!--
+   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;easyant-plugin-documentation-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">
+        <property name="plugindoc.module.ivy" value="${basedir}/sample-module.ivy"/>
+        <property name="plugindoc.source.dir" value="${basedir}/src/main/resources"/>
+        <property name="plugindoc.todir" value="${target}/artifacts"/>
+
+    </target>
+    <target name="tearDown" depends="clean"/>
+    
+    <target name="test-easyant-plugin-documentation:report" depends="easyant-plugin-documentation:report">
+        <au:assertPropertyEquals name="plugindoc.module.ivy" value="${basedir}/sample-module.ivy"/>
+        <au:assertPropertyEquals name="plugindoc.source.dir" value="${basedir}/src/main/resources"/>
+        <au:assertPropertyEquals name="plugindoc.main.confs" value="default"/>
+        <au:assertPropertyEquals name="plugindoc.todir" value="${target}/artifacts"/>
+        <au:assertFileExists file="${target}/artifacts/org.apache.easyant.plugins-tinyplugin-default.html"/>
+    </target>
+     
+
+    <target name="prepare-register-artifact">
+        <ivy:settings id="easyant.ivy.instance"/>
+        <ivy:resolve file="sample-module.ivy" settingsRef="easyant.ivy.instance"/>
+    </target>
+
+
+
+    <target name="test-easyant-plugin-documentation:register-artifact" depends="prepare-register-artifact,easyant-plugin-documentation:register-artifact">
+        <au:assertPropertyEquals name="plugindoc.publish.type" value="html"/>
+        <au:assertPropertyEquals name="plugindoc.publish.confs" value="documentation"/>
+ 
+    </target>
+
+</project>

Added: incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/sample-module.ivy
URL: http://svn.apache.org/viewvc/incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/sample-module.ivy?rev=1392507&view=auto
==============================================================================
--- incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/sample-module.ivy (added)
+++ incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/sample-module.ivy Mon Oct  1 18:39:38 2012
@@ -0,0 +1,28 @@
+<!--
+   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.plugins" module="tinyplugin" revision="0.9">
+    </info>
+    <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>
+    <publications>
+        <artifact type="ant"/>
+    </publications>
+</ivy-module>

Added: incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/src/main/resources/tinyplugin.ant
URL: http://svn.apache.org/viewvc/incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/src/main/resources/tinyplugin.ant?rev=1392507&view=auto
==============================================================================
--- incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/src/main/resources/tinyplugin.ant (added)
+++ incubator/easyant/plugins/trunk/easyant-plugin-documentation/src/test/antunit/src/main/resources/tinyplugin.ant Mon Oct  1 18:39:38 2012
@@ -0,0 +1,28 @@
+<!--
+   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#clean-std" xmlns:ea="antlib:org.apache.easyant">
+
+    <ea:core-version requiredrevision="[0.9,+]" />
+
+    <ea:parameter property="target" required="true" description="the target directory to clean" />
+
+    <target name="clean-std:clean" description="clean project">
+        <echo message="Cleaning ${target}..." />
+        <delete dir="${target}" />
+    </target>
+
+</project>