1 Plugin Framework

This section provides an overview of the client-side plugin framework users can use to extend their build and test procedures. A recipe is also provided for users wanting to create their own plugins.

1.1 Overview

The plugin framework provides the ability for common actions to be performed during build and test execution, without putting the burden on the user for selecting which build actions should take place and when. In other words, the framework provides a clean separation between specific build and test execution, analysis and metrics collection. This section provides a high-level description of the plugin framework architecture and guiding principals.

The reason for exposing the framework to users is that the framework also provides the ability for the ETICS client to be extended dynamically, without having to modify the core client functionality. Further, ETICS users can leverage the extensibility, such that they can better reuse investments in home grown and/or commercial tools and techniques valuable to them during build and test.

In order to even better leverage the work performed by existing plugins, the plugin framework also allow plugins to contribute to other plugins, without having the plugin being contributed to needing intimate knowledge from the contributing plugins. For example, a plugin calculating code coverage during execution can contribute to a testing plugin, without the testing plugin requiring intimate knowledge about how code coverage is calculated.

The goal of the plugin framework can be summarised as follows:

  • Provide an extendible framework for common actions to be performed during build and test execution
  • Provide natural separation between specific build and test execution, analysis and metrics collection
  • Provide open interface for users to register their own plugins to be executed during build and test
  • Provide raw data for build and test and repository services

To guide the definition of the framework, here are examples of actions that could map to plugins, to be executed by the framework:

  • Static Analysis
    • Single line of code count (SLOC)
    • Cyclomatic complexity
    • Depth of inheritance
    • IPv6 compliance
    • Check style
    • FindBugs
    • CCCC
  • Dynamic analysis
    • Code coverage
    • Memory leaks
  • Test execution
    • Java: JUnit
    • Python: PyUnit
    • Script/Executable

The guiding principal in the examples above is that none of these actions related to the specifics of the modules on which these actions are performed.

The framework is implemented as an extension to the ETICS command-line client. In this respect the framework is totally transparent to the user. The framework also leverages the property processing already performed by the client. Raw data can be generated and should be placed in the reports directory in order for these generated outputs being available after the remote execution.

When a command is executed, the plugin framework first loads and registers all plugins. The registration process requires for each plugin to provide information regarding the profile for which they should be activated, as well as which ETICS target of which command they apply to (i.e. VCS Command, Build Command and/or Test Command). In other words, the following combination dictates the execution of each plugin: profile+command+target.

To add an extra level of flexibility, wild-cards can be used by plugins during the registration. For example, the generic SystemCallPlugin responsible for executing as a system call the string value of each command might register for: profiles=“*”, commands=“*” and target=“*”.

The next section provides an overview of the specification of plugins.

1.2 Plugin specification

In order to qualify as a valid plugin, plugin implementations must comply with a few basic rules. The plugin must be provided in the form of a Python module or package. The module must be dropped in the plugins directory. If a plugin is implemented as a Python module (e.g. applicable for very simple plugins), it must following this naming convention:

  • “*plugin.py”
  • “plugin*.py”

On the other hand, if a plugin is implemented as Python package, the package directory must follow this naming convention:

  • “*plugin”
  • “plugin*”

Note: these conventions is case insensitive.

The module or the "__init__.py" module in the case of a package must implement the method getPluginInstance, which returns an instance of the plugin.

Python doesn’t support natively the concept of interface, like Java or C#. Instead, each plugin must provide a class that implements the following methods:

  • register: defines which profile, command and target it registers for. A helper class is available to the plugin for implementing this easily.
  • contribute: defines which plugin it contributes to. A helper class is available to the plugin for implementing this easily.
  • init: initialise the plugin and its environment
  • execute: execute the plugin
  • stopExecute: stop the execution of the plugin
  • publish: harvest and publish to a known location the results of the execution
  • finalise: executed once at the end of the processing, gives a chance to the plugin to clean its resources and perform any final actions, if any.

The first two methods are called as part of the registration process, in two distinct passes, which guarantees that all plugins have being registered before contributions can be made.

During each target execution (e.g. init, checkstyle, compile, etc in the case of the BuildCommand), the following methods are called for the plugins matching the current processing state: init, execute, stopExecute and publish. Each plugin is expected to call its contributors in each method. A helper class is provided by the plugin framework to easily execute the contributors.

The plugins are also provided with an instance of the PropertyManager class (providing full access to the property space of the current module being executed) and the BuildStatus class (providing access to the build and test status XML document).

2 Plugin installation

  1. The ETICS client determines which plugins to install based on the plugin-list.xml. By default it looks in the registered repository, but a volatile repository can be specified while specifying the plugin-list xml file. More on specifying the plugin-list xml in the Plugin testing section.
  2. Downloads all the plugin source packages.
  3. Extracts the packages.
  4. Installs the files using the include setup.py with the install commands from the plugin-list.xml.
  5. Registers the plugin with a profile and a target.
  6. The plugin will now execute in the given target if the profile is triggered by one of the three options mentioned in the "How to run a plugin" section under Plugin testing.

3 Other resources

Plugin development

Plugin release

Plugin testing

4 Plugin documentation

The JFindBugs plugin

The JUnit plugin

The CKJM Plugin

The Rpmlint Plugin

The Pylint Plugin

The Cppcheck Plugin

-- FabioCapannini - 05-Sep-2011

Edit | Attach | Watch | Print version | History: r12 < r11 < r10 < r9 < r8 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r12 - 2011-11-16 - DuarteMeneses
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    EMI All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright &© 2008-2023 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
or Ideas, requests, problems regarding TWiki? use Discourse or Send feedback