Difference between revisions of "Ant/Developers"
(→Get the Source)
m (→Using Gerrit: Fixing broken link)
|Line 98:||Line 98:|
*HTTP - <code>https://<userid>@git.eclipse.org/r/platform/eclipse.platform</code>
*HTTP - <code>https://<userid>@git.eclipse.org/r/platform/eclipse.platform</code>
Once you have Gerrit configured for the Ant repositories and are ready to commit your fix, make sure you read and follow the [[#
Once you have Gerrit configured for the Ant repositories and are ready to commit your fix, make sure you read and follow the [[#|Commit Messages]] section '''before''' you commit / push your change.
== Testing the Fix ==
== Testing the Fix ==
Latest revision as of 16:11, 29 June 2014
|Mailing List • Forums • IRC • mattermost|
|Open • Help Wanted • Bug Day|
- 1 Overview
- 2 Contributing to Platform Ant
- 3 Creating Bug Reports
- 4 Make a Contribution
There are many ways that you as a member of the community can get involved and contribute to the Platform Ant project.
The first step is to let us know you are out there. Sign up for our mailing lists and chat with us about your problems and interests. You should also sign up for a Bugzilla account and add firstname.lastname@example.org to your watch list.
Here are some ways you can contribute:
- Participate in Bug Day.
- Write code, developing source artifacts and patches for the Ant projects.
- File bug reports in Bugzilla for defects you find.
- Participate in a milestone test pass.
- Assist in bug triage by checking if reports are duplicates, out of date, missing fields, etc. Read up on filing bugs and then take a peek at our Inbox.
Contributing to Platform Ant
Platform Ant is driven by a small development group with limited resources. ANY serious developers or contributors will be enthusiastically welcomed. For more information on how to become a committer, check the standard Eclipse process (see New Committer Election). For more information about contributing to Platform Ant in general, or for questions about its internals, contact email@example.com.
Creating Bug Reports
When filing bugs against the Platform Ant project, we ask that you use your better judgment, and most importantly common sense before filing a bug.
- Search bugzilla for existing bugs like yours BEFORE you file it. Resolving duplicates is time consuming.
- Be sure that what happened is really a bug. For example if all you see is an entry in the log files that mentions Ant try to reproduce it, find out how it happened, or better yet come up with a test case. Some log entries are NOT bugs, and can be caused by incorrect workspace configuration, etc.
- Bugzilla is not a forum. Do not ask questions on bugzilla like "how do I create a HelloWorld buildfile?". This is not a bug.
- Bugs should be filed against the PLATFORM-ANT component. New feature requests should be filed with a severity of "enhancement".
- Understand what the different severities mean and choose accordingly. Setting a trivial bug to critical will not get it fixed any sooner (but will have its severity changed immediately).
- Do not assign a bug to a committer unless they have already agreed to work on it.
By default, bugs filed against a Ant component will be assigned to an inbox account. Interested parties watch this inbox user to see incoming bugs. Committers or the Ant team lead will move bugs from the inbox account when someone is actively working on a bug.
Make a Contribution
Before starting to develop an enhancement or fix for Platform Ant, it is important that you get in touch with the project. We track ideas for enhancements and bug reports in the Eclipse bugzilla (Platform Ant), so this is a good place to present your ideas for a patch and to make sure it's going in the right direction.
If you want to do an enhancement but don't know where to start, you can also just ask on firstname.lastname@example.org.
Get the Source
Platform Ant is hosted in Git and can be viewed online: Platform Ant.
To be able to make a fix or provide an enhancement, you will want to create an Eclipse workspace and import this source. The best resource for setting up a repository in Eclipse and importing project can be found on the EGit howto page.
Once your repository is set up in Eclipse the projects you want to import are:
org.eclipse.ant.core org.eclipse.ant.launching org.eclipse.ant.ui org.eclipse.ant.tests.core org.eclipse.ant.tests.ui
Your workspace setup is now complete. You do not have to import all of the dependencies for the Ant bundles (unless you really want to) - those will be satisfied using the plug-ins running in or installed in the version of Eclipse you are using. Even when you upgrade your Eclipse install, the Ant projects will automatically compile against the new plugins.
It is good practice to develop the latest versions of the Ant plug-ins using the latest version of Eclipse. For example, as of this writing, Eclipse 4.4 would be used to develop Ant code from the master branch. The reason being that as the code evolves it might have changes that would not compile against an older version, which in turn would greatly complicate your workspace setup.
- Follow the Eclipse Platform's Development Conventions and Guidelines.
- Every file must contain a copyright header, as described in Development Conventions and Guidelines. The copyright header goes before the package declaration, starting in the very first line. For new files, list "yourself and others" instead of "IBM and others" in the first line. For changed files, add a contribution comment in the copyright header with your name and affiliation, and a bug id.
/******************************************************************************* * Copyright (c) 2014 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * IBM Corporation - initial API and implementation * John Doe <John.Doe@eclipse.org> - Bug 429728 *******************************************************************************/
- Platform Ant comes preconfigured to use project-specific settings for compiler warnings/errors, code formatting etc. These settings must not be changed, unless the bug you are fixing is to propose a new default value for one of them.
- It is considered good practice to write code that does not have warnings. If possible, fix warnings existing whenever you see them.
- Non-externalized strings are considered errors, do not ship non-externalized strings or use the NON-NLS tag to indicate that you are not relevant for translation
- Use Unix line delimiters (In Eclipse select Window-> Properties -> Workspace and set the file delimiter to Unix
- Write/update Javadoc for all classes / interfaces / methods / fields you introduce/change.
So you have the code to fix a bug in your host workspace, have tested it in your target workspace and ensured all of the [#Unit_tests|JUnit tests pass]. The next step is to get that code committed to the git repository. Platform Ant accepts contributions using patches attached to the corresponding bugzilla or Gerrit review requests (as we will discuss in the next section).
To create a patch, follow the simple steps on the EGit wiki. After you have successfully created the patch, have verified it contains all of the changes you would like to make, attach it to the bugzilla with a brief comment about what the changes it contains do. For bonus points you can edit the title of the bugzilla to start with '[patch]'.
In due time one of the project committers will review your patch and either apply it to the git repository or comment on the patch stating what is wrong and request changes.
Just like creating a patch, you have a code fix, have tested it in your target workspace and ensured all of the [#Unit_tests|JUnit tests pass], but you would rather not submit a patch. In that case you can use Gerrit. A great resource for getting started using Gerrit, is Lars Vogel's tutorial for contributing via Gerrit.
If you have not already done so, you will have to configure the repository you want to contribute back to to use Gerrit. Instructions for this configuration can be found on the EGit Gerrit set up wiki.
The Platform Ant Gerrit respositories are:
- Anonymous git -
- Anonymous HTTP -
- SSH -
- HTTP -
Once you have Gerrit configured for the Ant repositories and are ready to commit your fix, make sure you read and follow the Commit Messages section before you commit / push your change.
Testing the Fix
Platform Ant has JUnit tests that we use to help prevent regressions and other problems from creeping in from bug fixes. These tests must be run prior to submitting a patch or a Gerrit request. The very first thing a committer will do is run these tests, and if any fail your contribution will be immediately rejected.
Luckily though, there are shared test configurations that you can use to run these tests exactly as the committers do. They are found in:
To run these shared configurations simply open the launch configuration dialog, look under the JUnit Plug-in Test type to find the
Ant Core Test Suite and the
Ant UI Test Suite configurations.
After you've run the JUnit tests, you will want to see / debug how your fix behaves in Eclipse. The simplest way to do that is to launch what is called a target workspace and run through a bunch of manual testing.
To start a target workspace simply open the launch configuration dialog and create a new Eclipse Application launch configuration. You can customize where on disk the workspace will live, etc., but right out of the box the new configuration will launch a target Eclipse that will contain all of the changes from your workspace.
When you work on your fix the most common way to verify it is working is to run the JUnit tests and launch a target workspace. Sometimes though you might want to test how the fix works in you host Eclipse. There are two main ways to perform this testing:
- You can build Eclipse from scratch yourself, using the steps from the platform build wiki. This is by far the most difficult way to get a host Eclipse with your change in it.
- You can use the export feature from PDE to install your change as a feature patch in your host. There is a wizard to help you with the export, but you can read more about it in the Eclipse help doc and in a good blog post from EclipseScource.
Smoke testing can be done following the manual test script. Find the section that best covers your fix and run through the steps, this will give you an extra level of confidence that the changes you are proposing are of high quality.
This kind of testing is good to do regardless of how you test your fix, whether you do target testing or host testing.
When working on a Gerrit-contributed fix it is mandatory to provide a commit message.
In Ant there is a specific form we allow for that message:
- Copy the bug title from the bugzilla and paste it in as the first line of the commit message
- Add "Change-id: <id>"
- Add "Signed-off-by: <your_name> <your_email_adress>" (see "Legal Paperwork" below).
For a bit more information committing from within Eclipse give the EGit section on committing from the staging view a read.
Before every milestone release the Ant team does an intense one-day test pass where we test all of the functionality of the Ant components. We try to check everything to make sure 100% of the functionality is available in every major release. In addition, we try odd use cases and unusual code to ensure our code is as robust as possible.
To organize the test pass, we follow a test script. The script defines a basic overview of what must be tested in each section.
If you would like to help out during a test pass, contact us via our mailing lists. Before the test pass, let us know what platform you are going to test on and what sections you are planning to test. If you have any questions about how to test some area, we would be happy to help explain.
The Platform Ant support relies on Apache Ant. Unfortunately, platform Ant does not directly consume Apache Ant, but instead uses a version from Orbit. The version in Orbit needs to be updated as each new version of Apache Ant is released.
Instructions for updating Apache Ant in Orbit can be found on the how-to page.
Apache Ant Source
You can bring the Orbit version of Apache Ant into your workspace if you need for debugging (but it should be fine to debug through the version installed in Eclipse). The version that is pre-installed in Eclipse comes from Orbit, so to get the source you have to check out the corresponding branch (as of this writing that is v1_9_2).