Skip to content

Latest commit

 

History

History
89 lines (50 loc) · 4.89 KB

development.md

File metadata and controls

89 lines (50 loc) · 4.89 KB
Raw
title description author
Bndtools Developer Guide
Guide to checking out and building Bndtools from source.
Neil Bartlett

This page is a tutorial for developers wishing to customise and enhance Bndtools itself. For general documentation please refer to the Tutorial.

There are two ways you can setup a development environment for contributing to Bnd/Bndtools:

  1. Building Bndtools manually: Clone git, build and setup Eclipse.
  2. or install our Development Setups with a pre-configured Eclipse instance

Building Bndtools

Bndtools is built with Bndtools! If you want to work on the bndtools source code, you have three options:

  • Install the current public release of bndtools from the Eclipse Marketplace and start working straight away.
  • Build Bndtools from the command line, then install the build results into your Eclipse IDE.
  • or install one of the pre-configured development setups

Checking Out from GitHub

First check out the source code from GitHub as follows:

git clone git://github.com/bndtools/bnd.git

If you have Bndtools installed in your Eclipse IDE already (e.g. using Marketplace) then skip to Importing Into Eclipse below. Otherwise read on...

Building from the command-line

Read the document Contribution to Bnd/Bndtools to learn how the build works.

Assuming you have Gradle (version 1.11 or better) installed, you can build bndtools from the command line by changing to the root of your checkout and typing:

gradle build dist

After a a short while, two directories - build/generated/p2 and build/generated/extras/p2 will appear. These contains an Eclipse Update Sites that you can use to install bndtools from the code you have just built.

To install from the generated Update Sites, open the Help menu in Eclipse and select "Install New Software". In the update dialog, click the "Add" button (near the top left) and then click the "Local" button. Browse to the location of the build/generated/p2 directory that you just built. Then set the name of this update site to "Bndtools Local Snapshot" (or whatever you like, it's not really important so long as you enter something). Click "OK". Do the same for the build/generated/extras/p2 directory.

Back in the update dialog, Bndtools will appear in the category list. Place a check next to it and click Next. Drive the rest of the wizard to completion... congratulations, you have just built and installed bndtools!

Importing Into Eclipse

Now you have Bndtools installed in your Eclipse IDE, you can import the bndtools projects into Eclipse to begin working on the source code.

Open the File menu and select "Import" and then "Existing Projects into Workspace" (under the General category). Click "Next". Click the "Browse" button (top right) and select the root directory of the bndtools projects.

Ensure that all projects (sub-directories) are checked.

NB: These projects must all be in the same directory!

Click "Finish"... Eclipse will start to import and build the projects. If you see a dialog during the import prompting you to "Create a Bnd Configuration Project" click CANCEL.

You should now have all the bndtools projects in your workspace, ready to begin hacking!

Development Setups

We also provide pre-configured setups using Eclipse oomph installer, which help you getting started quickly. This way you get a dedicated Eclipse instance with pre-installed bndtools source code with a simple one-click installer.

Find our different setups and P2 Repositories at: https://bndtools.org/bndtools.p2.repo/

Launching Bndtools from Eclipse

To launch bndtools from Eclipse (e.g. to try out a change to debug), use one of the .bndrun files from the bndtools.core project. There are three launchers, one per architecture, i.e.:

  • bndtools.cocoa.macosx.x86_64.bndrun for running on MacOS (64-bit Intel x86)
  • bndtools.cocoa.macosx.aarch64.bndrun for running on MacOS (64-bit Apple Silicon / AArch64)
  • bndtools.gtk.linux.x86_64.bndrun for running on Linux (64-bit Intel x86).
  • bndtools.gtk.linux.x86.bndrun for running on Linux (32-bit Intel x86).
  • bndtools.win32.x86.bndrun for running on Win32 (XP, Vista etc).

Right click on the file that matches your computer's architecture and select "Run As" > "Bnd OSGi Run Launcher". If none of these files matches the architecture you want to run on, then please create a new one and submit it back as a patch.

Running JUnit Tests

The project biz.aQute.tester.test contains the unit tests for biz.aQute.tester and biz.aQute.tester.junit-platform. See this project's README for instructions of how to execute tests in Eclipse.