Getting Started with Polarion Plugin Development – Pre-Setup Guide

Introduction

Welcome to the first post in our new series on Polarion Plugin Development! In this series, we'll walk through everything from setting up your development environment to creating and deploying custom plugins for Polarion ALM. This post covers the essential pre-setup process, including configuring Eclipse, setting up Polarion libraries, and troubleshooting common issues. Whether you're a beginner or an experienced developer, these steps will help ensure a smooth setup experience.

---

1. Setting Up Your Development Environment

Before diving into plugin development, you need to set up your development environment properly. Here’s a step-by-step guide, including compatibility notes and tips to avoid common pitfalls.

1.1 Install Java Development Kit (JDK)

Why? Polarion plugins are developed in Java, so having a proper JDK is crucial.

• Recommended: JDK 11 or later

• Verify installation:

    java -version
  

• Tip: If you're working on Windows, ensure that Java is added to the system PATH.

• Compatibility: Works on Windows 10/11, Linux (Ubuntu, CentOS, Red Hat), and macOS (though some features may vary).

1.2 Install Eclipse IDE

Eclipse is the preferred IDE for Polarion plugin development due to its robust support for Java and plugin integration.

• Download and install Eclipse IDE for Java Developers from Eclipse Official Website

• Choose the right version based on your OS:

  • Windows: Eclipse Installer (EXE)

  • Linux: .tar.gz package (requires manual extraction)

  • macOS: .dmg package

• Tip: Install Eclipse in a folder without spaces (avoid paths like C:\Program Files\ to prevent issues).

1.3 Install Required Polarion Libraries

To interact with Polarion APIs, include the required libraries:

• Locate your Polarion installation directory (e.g., /opt/polarion on Linux or C:\Polarion on Windows)

• Navigate to the Polarion SDK libraries folder: polarion/sdk/lib

• Add the following JAR files to Eclipse’s classpath:

  • polarion-extensions.jar

  • polarion-core.jar

  • polarion-ws.jar

  • Any additional libraries required for your project

• Tip: Keep a backup of the SDK libraries before making any changes.

1.4 Configure Eclipse Project

Once the libraries are added:

• Create a new Java Project in Eclipse.

• Add the downloaded JAR files to the project’s Build Path.

• Set up a Run Configuration if needed for testing.

• Tip: Use Eclipse's built-in Project -> Clean option if facing dependency issues.

---

2. Setting Up Polarion for Plugin Deployment

2.1 Enable Plugin Deployment in Polarion

• Ensure that plugin execution is enabled in the Polarion configuration files.

• Locate polarion/configuration.properties and enable custom plugin execution if required.

• Tip: Always restart Polarion after modifying configuration files.

2.2 Restart Polarion After Configuration

• Any configuration changes require a server restart.

• Use the command:

    sudo systemctl restart polarion
  

  (For Windows: Restart Polarion service from Task Manager or Services)

• Troubleshooting: If Polarion does not restart correctly, check system logs for permission errors or conflicts.

---

3. Troubleshooting Common Issues

3.1 Eclipse Not Detecting Libraries

• Ensure that JAR files are correctly added to Java Build Path.

• Try cleaning and rebuilding the project (Project -> Clean in Eclipse).

• Tip: Restart Eclipse if the problem persists.

3.2 Polarion Not Loading Custom Plugins

• Verify the plugin deployment path.

• Check log files for errors (polarion/logs/polarion.log).

• Ensure that the correct JDK version is being used (older versions may cause compatibility issues).

---

Conclusion

With the pre-setup complete, you are now ready to start developing your first Polarion plugin!

In the next post, we’ll explore creating a simple Polarion plugin, understanding the extension points, and implementing basic functionality. Stay tuned! 🚀

---

Bonus Tip: If you’re working on a corporate network, firewall restrictions might block some connections required by Eclipse. Ensure that necessary ports are open or work with your IT team to resolve network issues.