Polarion ALM extension to analyze WI quality

This Extension provides the possibility to inspect WI descriptions and writes the feedback to the Custom Field "Smell Description" of each inspected WI.
The inspector is implemented in scripts.

Important

Only latest version of Polarion is supported.
Right now it is Polarion 2512.

Quick start

The latest version of the extension can be downloaded from the releases page and installed to Polarion instance without necessity to be compiled from the sources.
The extension should be copied to <polarion_home>/polarion/extensions/ch.sbb.polarion.extension.requirements-inspector/eclipse/plugins and changes will take effect after Polarion restart.

Important

Don't forget to clear <polarion_home>/data/workspace/.config folder after extension installation/update to make it work properly.

Polarion configuration

Scheduler

This Extension must be added as Job to the Scheduler like this:

<job cronExpression="0 0 0 * * ?" id="requirementsInspection" name="[your task name]" scope="project:[your project]">
    <types>[WI Type ID], [WI Type ID], ...</types>
    <addMissingLanguage>[true/false]</addMissingLanguage>
    <filter>[additional filter query]</filter>
    <inspectTitle>[true/false]</inspectTitle>
    <inspectFields>[field ID], [field ID], ...</inspectFields>
</job>

All values in brackets needs to be changed to your use case.

The following Parameters are available:

types: Comma-seperated type ids of workitems to be inspected.
addMissingLanguage (Optional): If set to true it updates the language field if it wasn't set and the plugin could detect the language. default false.
filter (Optional): An filter query that will be added with AND to the existing query to filter for specific workitems.
inspectTitle (Optional): If set to true the plugin will inspect the title (currently only Processword check) and doesn't check if set to false. If not defined the default value is true.
inspectFields (Optional): Comma-seperated ids of customfields that should be inspected. If not defined the default is empty.

Requirements-Inspector Configuration

python_requirements_inspector as Service

This extension supports using python_requirements_inspector as a service. More details can be found here.
This feature can be used by setting the following property in file <POLARION_HOME>/etc/polarion.properties:

ch.sbb.polarion.extension.requirements-inspector.requirements.inspector.service=http://localhost:9081

NOTE: If the requirements inspector service is running on the host machine's localhost and docker compose is not used, the following option can be added to docker polarion run:

docker run ... --add-host host.docker.internal:host-gateway ...

The service will be available under http://host.docker.internal:9081 in the container as shown in the property above.

Debug option

Debug logging can be switched on (true value) and off (false value) with help of following property in file polarion.properties:

ch.sbb.polarion.extension.requirements-inspector.debug=true

Usage

Custom Fields

The Workitems types that shall be inspected need Custom Fields for the results. If not defined beforehand they will be added as String Fields after inspection and can be defined with the correct types afterward. Following Custom Fields can
be added:

ID	Name	Type
smellDescription	Smell Description	Text
smellPassive	Smell Passive	Integer
smellComplex	Smell Complex	Integer
smellComparative	Smell Comparative	Integer
smellWeakword	Smell Weakword	Integer
missingProcessword	Missing Processword	Boolean

Also, the Language field should exist.

Wait for your scheduled time or start it manually by:

Open Monitor
Select the Task with [your task name]
Press Button "Execute now"