BeepBeep is an event stream query engine. It can take as input various sources of events, pipe them through various processors, and produce various kinds of output streams from them. For more information about what is BeepBeep (including documentation, examples, etc.), please visit BeepBeep's website.

The repository is separated across the following folders.

• Core: main source files
• CoreTest: test source files. You need to compile these files only if you want to run BeepBeep's unit tests.

Compiling the project contained in the present repository generates the file beepbeep-3.jar, which is the minimal file you need to run BeepBeep on your system.

BeepBeep tries to have as few dependencies as possible. However, the following companion library needs to be installed for BeepBeep to compile and run:

• Azrael, a library for serializing objects in various formats
• Petit Poucet, a library for managing data traceability

BeepBeep's engine contains very few processors. In typical use cases, these basic functionalities are extended by using one or more extra palettes, such as those found in the BeepBeep palette repository.

First make sure you have the following installed:

• The Java Development Kit (JDK) to compile. BeepBeep is developed to comply with Java version 6; it is probably safe to use any later version.
• Ant to automate the compilation and build process

Download the sources for BeepBeep from GitHub or clone the repository using Git:

[email protected]:liflab/beepbeep-3.git

The repository is separated into multiple projects. Each of these projects has the same Ant build script that allows you to compile them (see below).

If the project you want to compile has dependencies, you can automatically download any libraries missing from your system by typing:

ant download-deps

This will put the missing JAR files in the dep folder in the project's root.

Compile the sources by simply typing:

ant

This will produce a file called beepbeep-3.jar (or another library, depending on what you are compiling) in the folder. This file is runnable and stand-alone, or can be used as a library, so it can be moved around to the location of your choice.

In addition, the script generates in the doc folder the Javadoc documentation for using BeepBeep. To show documentation in Eclipse, right-click on the jar, click "Properties", then fill the Javadoc location.

BeepBeep can test itself by running:

ant test

Unit tests are run with jUnit; a detailed report of these tests in HTML format is availble in the folder tests/junit, which is automatically created. Code coverage is also computed with JaCoCo; a detailed report is available in the folder tests/coverage.

BeepBeep uses Coverity Scan for static analysis of its source code and defect detection. Instructions for using Coverity Scan locally are detailed here. In a nutshell, if Coverity Scan is installed, type the following:

cov-build --dir cov-int ant compile

(Make sure to clean up the directory first by launching ant clean, followed by ant download-deps.)

If you wish to develop BeepBeep in Eclipse, please follow the detailed instructions (with screenshots and all) found in the online user guide.

In short:

• Create a new empty workspace (preferably in a new, empty folder).
• Create new projects for each of the folders Core, CoreTest, and optionally, any of the palette folders you with to develop. Note that these projects will not be located in the default location with respect to the workspace; you need to uncheck the "Use default location" option and fetch them manually.

Then, setup the build path for each project:

• Core requires the Bullwinkle library (see above)
• CoreTest depends on Core and requires the JUnit 4 library
• Each of the palette folders depend on Core and require the JUnit 4 library
• In addition, some of the palette projects may have other dependencies; please refer to their individual documentation

The BeepBeep project is under heavy development. The repository may be restructured, the API may change, and so on. This is R&D!

BeepBeep 3 was written by Sylvain Hallé, full professor at Université du Québec à Chicoutimi, Canada. Part of this work has been funded by the Canada Research Chair in Software Specification, Testing and Verification and the Natural Sciences and Engineering Research Council of Canada.