Visual Age for Java is a great Java IDE, but it lacks -decent build support; for creating deliveries. On the other hand, Ant supports -the build process very good, but is (at least at the moment) command line based. -So we decided to write some tasks to access the VAJ repository and a small -visual Ant frontend to make running Ant from VAJ possible. We use the Tool API -to integrate Ant in VisualAge for Java. In combination with the VAJ tasks -(vajload, vajexport, vajimport) you can load defined versions of projects -into your workspace, export the source code, compile it with an external -compiler and build a jar without leaving the IDE. Of course compile messages are -viewed in a logging window. Concluding: This tool provides decent deployment -support VAJ has not (out of the box).
-| 2003/01/16 | -
-
|
| 2001/06/14 | -
-
|
| VAJLoad |
- loads specified versions into the workspace |
| VAJExport |
- exports specified packages into the file system |
| VAJImport |
- imports specified files into the workspace |
These tasks are described in detail below.
- - -Loads a specified VAJ project version into the -workspace.
- -| Attribute | -Description | -Required |
| remote | -
- name and port of a remote tool server. (format:
- |
- no |
| haltonerror | -
- Stop the build process if an error occurs, - (default: "yes") |
- no |
| Attribute | -Description | -Required |
| name | -name of the VAJ project to load into - the workspace | -yes |
| version | -name of the requested version,
- or one of the special qualifiers "*" or "**" |
- yes |
<vajload remote="localhost:32767"> - <vajproject name="My App" version="*"/> - <vajproject name="My Testcases" version="**"/> - <vajproject name="JUnit" version="3.2"/> -</vajload> -- -
Exports Java source files, class files and/or resources from the workspace -to the file system. Exports can be specified by giving the VAJ project -name and package name(s). This works very similar to -FileSets.
- -| Attribute | -Description | -Required |
| destdir | -location to store the exported -files | -yes |
| exportSources | -export source files (default: -"yes") | -no |
| exportResources | -export resource files (default: - "yes") | -no |
| exportClasses | -export class files (default: "no") | -no |
| exportDebugInfo | -include debug info in exported class - files (default: "no") | -no |
| defaultexcludes | -
- use default excludes when exporting (default: "yes"). |
- no |
| overwrite | -overwrite existing files (default: - "yes") | -no |
| remote | -
- name and port of a remote tool server. (format:
- |
- no |
| haltonerror | -
- Stop the build process if an error occurs, - (default: "yes") |
- no |
| Attribute | -Description | -Required |
| name | -name of the VAJ project and package to export. - The first element of the name must be the project name, - then the package name elements - separated by '/'. |
- yes |
| Attribute | -Description | -Required |
| name | -name of the VAJ project/package not to - export | -yes |
<vajexport destdir="${src.dir}" exportResources="no">
- <include name="MyProject/**"/>
- <exclude name="MyProject/test/**"/>
-</vajexport>
-
-This example exports all packages in the VAJ project 'MyProject', except
-packages starting with 'test'.
-IBM*/** - Java class libraries/** - Sun class libraries*/** - JSP Page Compile Generated Code/** - VisualAge*/** --
Imports Java source files, class files and/or resources -from the file system into VAJ. These imports can be specified with a fileset. -
-| Attribute | -Description | -Required |
| project | -imported files are added to this VAJ - project | -yes |
| importSources | -import source files (default: -"yes") | -no |
| importResources | -import resource files (default: - "yes") | -no |
| importClasses | -import class files (default: "no") | -no |
| remote | -
- name and port of a remote tool server. (format:
- |
- no |
| haltonerror | -
- Stop the build process if an error occurs, - (default: "yes") |
- no |
<vajimport project="Test" importClasses="true">
- <fileset dir="${import.dir}">
- <include name="com/sample/**/*.class"/>
- <exclude name="com/sample/test/**"/>
- </fileset>
-</vajimport>
-
-This example imports all class files in the directory ${import.dir}/com/sample
-excluding those in the subdirectory testWe assume C:\IBMVJava as VAJ
-install directory. If You have installed it elsewhere, adapt the pathes below.
-
- C:\IBMVJava\ide\tools\org-apache-tools-ant.
- lib
- directory of your Ant installation.
- default.ini (in
- org\apache\tools\ant\taskdefs\optional\ide) to
- C:\IBMVJava\ide\tools\org-apache-tools-ant\default.ini.
-
- C:\IBMVJava\ide\tools\org-apache-tools-ant\doc
- and copy the files VAJAntTool.html,
- toolmenu.gif and
- anttool1.gif to it.
- C:\IBMVJava\ide\tools\com-ibm-ivj-toolserver\servlets\servlet.properties.
- Typically this file is empty. If not, be careful not to delete the other lines.
-
-servlet.vajload.code=org.apache.tools.ant.taskdefs.optional.ide.VAJLoadServlet -servlet.vajexport.code=org.apache.tools.ant.taskdefs.optional.ide.VAJExportServlet -servlet.vajimport.code=org.apache.tools.ant.taskdefs.optional.ide.VAJImportServletName- |
ant.jar and optional.jar
- contained in the lib directory of your Ant installation) to the directory
- C:\IBMVJava\ide\tools\com-ibm-ivj-toolserver\servlets\.
-
Now you should be able to execute VAJ Tasks from the -command line.
- -
- When the tool is installed correctly and your Ant build
-file is configured, it is really easy to use.
-Go to your Workbench, select the project you want to deploy and
-open its context menu. In the submenu Tools you should find
-the new entry Ant Build. Klick it to start the tool!
-After you have set up your buildprocess you might find it useful
-to save the data you've just entered, so we implemented an option to
-save it to the repository into your selected project. Make sure that you
-have an open edition of your project before selecting
-Save
-BuildInfo To Repository from the File menu.
-Now your information is saved to this edition of your project and will
-be loaded automatically the next time you start Ant Build.
-If you have closed the log window accidentally, it can be reopened
-with the Log item in the File menu, and if you want to
-know who developed this, just select About in the Help menu.
With the servlets installed and the remote access -running you can use Ant from the command line without any restrictions. Just -make sure the remote attribute in your build file is set correctly.
-Q: If I try to load a build
-file, I get the error "Can't load default task list". Why?
-A: Ant not only contains class files, but also resource
-files. This messsage appears if the file
-
.../org/apache/tools/ant/taskdefs/defaults.properties is
-missing. Make sure that you import/export not only java/class files, but also
-all resource files when importing/exporting Ant.
Q: If I try to re-load a build
-file, I get the error "XML parser factory has not been configured correctly". Why?
-A: Make sure the META-INF/services directory of the xercesImpl.jar has also been expanded
-into the C:\IBMVJava\ide\tools\org-apache-tools-ant directory.
Q: I want to load, export
-and build more then one Visual Age project to one jar! How to?
-A: The VA tasks are able to load and export several
-Projects all at once. You can choose whatever project you like for storing the
-tool information, it doesn't really matter
Q: When I load my build
-file, the list of targets is empty. Why?
-A: You
-need to add the optional "description" parameter to the targets you want to come
-up in the list. Then reload the build file in the "ant build" tool. We chose to
-display only targets with description to allow the build file developer to
-distinguish between targets for end users and helper targets.
Q: Is there a sample build
-file available?
-A: Now you can find an example in this manual
Q: Why does it export my
-entire workspace when I've already implicitly selected a project when starting
-the Tool?
-A: This selection does not carry into
-the buildfile you are using. Set the Project name at the beginning of the
-"includes" parameter.
Q: When I import Ant into
-my Workspace, I get Problems reported. Can I ignore them?
-A: It depends on the problems reported, and what you want to do with Ant.
-Problems you can't ignore:
-
Q: I want to use the same
-buildfile both within Visual Age and from the command line using my regular Ant
-environment. What do I need to be aware of?
-A:
-You have to specifie a remote server via the 'remote' attribute. Otherwise the
-three Visual Age tasks won't work when executing Ant from the command line.
Q: I can export packages
-from project 'ABC', but not from project 'XYZ'! Why?
-A: Common reasons are:
Q: How do I control the
-import/export of sourcefiles, compiled files and project resources
-explicity?
-A: Via the Boolean values
-exportClasses (default false) exportSources (default true) and exportResources
-(default true). In some situations, Resources are not exported correctly without
-this being explicity set. VAJ doesn't export resources correctly if a package
-contains only resources (see below).
| 1.0 | -2000/09/11 | -Initial Version |
| 1.1 | -2001/02/14 | -Added Task documentation and more FAQs - (thanks to Richard Bourke for the FAQ additions) |
| 1.2 | -2001/07/02 | -
- Added documentation of new remote feature. |
| 1.2.1 | -2003/01/16 | -
- Added documentation for haltonerror, "*" and "**" version qualifiers. |
-Instruments Java classes with iContract
- DBC preprocessor.
- The task can generate a properties file for iControl,
- a graphical user interface that lets you turn on/off assertions. iControl generates a control file that you can refer to
- from this task using the controlfile attribute.
-
| Attribute | -Description | -Required | -
| srcdir | -Location of the java files. | -Yes | -
| instrumentdir | -Indicates where the instrumented source files should go. | -Yes | -
| repositorydir | -Indicates where the repository source files should go. | -Yes | -
| builddir | -Indicates where the compiled instrumented classes should go. - Defaults to the value of instrumentdir. - NOTE: Don't use the same directory for compiled instrumented classes - and uninstrumented classes. It will break the dependency checking. (Classes will - not be reinstrumented if you change them). | -No | -
| repbuilddir | -Indicates where the compiled repository classes should go. - Defaults to the value of repositorydir. | -No | -
| pre | -Indicates whether or not to instrument for preconditions.
- Defaults to true unless controlfile is specified, in which case it
- defaults to false. |
- No | -
| post | -Indicates whether or not to instrument for postconditions.
- Defaults to true unless controlfile is specified, in which case it
- defaults to false. |
- No | -
| invariant | -Indicates whether or not to instrument for invariants.
- Defaults to true unless controlfile is specified, in which case it
- defaults to false. |
- No | -
| failthrowable | -The full name of the Throwable (Exception) that should be
- thrown when an assertion is violated. Defaults to java.lang.Error |
- No | -
| verbosity | -Indicates the verbosity level of iContract. Any combination
- of error*,warning*,note*,info*,progress*,debug* (comma separated) can be
- used. Defaults to error* |
- No | -
| quiet | -Indicates if iContract should be quiet. Turn it off if many your classes extend uninstrumented classes
- and you don't want warnings about this. Defaults to false |
- No | -
| updateicontrol | -If set to true, it indicates that the properties file for
- iControl in the current directory should be updated (or created if it doesn't exist).
- Defaults to false. |
- No | -
| controlfile | -The name of the control file to pass to iContract. Consider using iControl to generate the file. - Default is not to pass a file. | -Only if updateicontrol=true |
-
| classdir | -Indicates where compiled (uninstrumented) classes are located. - This is required in order to properly update the icontrol.properties file, not - for instrumentation. | -Only if updateicontrol=true |
-
| targets | -Name of the file that will be generated by this task, which lists all the - classes that iContract will instrument. If specified, the file will not be deleted after execution. - If not specified, a file will still be created, but it will be deleted after execution. | -No | -
- Note: iContract will use the java compiler indicated by the project's
- build.compiler property. See documentation of the Javac task for
- more information. Nested includes and excludes are also supported.
Example:
- -
- Note: iContract will use the java compiler indicated by the project's
- build.compiler property. See documentation of the Javac task for
- more information.
- Nested includes and excludes can be done very much the same way as any subclass - of MatchingTask.
- -Example:
- -
- <icontract
- srcdir="${build.src}"
- instrumentdir="${build.instrument}"
- repositorydir="${build.repository}"
- builddir="${build.instrclasses}"
- updateicontrol="true"
- classdir="${build.classes}"
- controlfile="control"
- targets="targets"
- verbosity="error*,warning*"
- quiet="true">
- <classpath refid="compile-classpath"/>
- </icontract>
-
-
-Copyright © 2001-2002,2004-2005 The Apache Software Foundation. All rights -Reserved.
- - - - diff --git a/docs/manual/OptionalTasks/test.html b/docs/manual/OptionalTasks/test.html deleted file mode 100644 index abcc27b53..000000000 --- a/docs/manual/OptionalTasks/test.html +++ /dev/null @@ -1,79 +0,0 @@ - - - - - -This is a primitive task to execute a unit test in the org.apache.testlet framework.
-This task is deprecated as the Testlet framework has been -abandoned in favor of JUnit by the Avalon community.
-Note: This task depends on external libraries not included -in the Ant distribution. See -Library Dependencies for more information. -
- -| Attribute | -Description | -Required | -
| showSuccess | -a boolean value indicating whether tests should display a - message on success - | -No | -
| showBanner | -a boolean value indicating whether a banner should be displayed - when starting testlet engine - | -No | -
| forceShowTrace | -a boolean indicating that a stack trace is displayed on any failure - | -No | -
| showTrace | -a boolean indicating that a stack trace is displayed on - error (but not normal failure) - | -No | -
-The user can also specify the nested <classpath> element which defines classpath
-in which the task is executed. The user also specifies a subelement per testlet executed
-which has content that specifies tasklet classname.
--The above will run the testlets org.foo.MyTestlet and org.foo.MyOtherTestlet - --<test showSuccess="false" showBanner="false" showTrace="true" forceShowTrace="true"> - <classpath refid="test.classpath"/> - <testlet>org.foo.MyTestlet</testlet> - <testlet>org.foo.MyOtherTestlet</testlet> -</test> --
Copyright © 2001-2005 The Apache Software Foundation. All rights -Reserved.
- - - - diff --git a/docs/manual/dirtasks.html b/docs/manual/dirtasks.html index 38b17d7e5..f335a6fd3 100644 --- a/docs/manual/dirtasks.html +++ b/docs/manual/dirtasks.html @@ -50,6 +50,7 @@ either:<includesfile> and <excludesfile>.
+When dealing with an external file, each line of the file is taken as a pattern that is added to the list of include or exclude patterns.
@@ -128,8 +129,9 @@ For example,mypackage/test/ is interpreted as if it were
But not:
org/apache/CVS/foo/bar/Entries (foo/bar/
- part does not match)
+ part does not match)
+
org/apache/jakarta/**<ejbjar><ejbc><cab><icontract><native2ascii><netrexxc><csc><vbc><translate><vajexport>
- <image><image><jlink> (deprecated)<jspc><wljspc>Copyright © 2000-2005 The Apache Software Foundation. All +
Copyright © 2000-2006 The Apache Software Foundation. All rights Reserved.