Activiti

Review API and build systematic test coverage

Details

  • Type: Improvement Improvement
  • Status: Resolved Resolved
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 5.0.beta2
  • Component/s: Engine
  • Labels:
    None
  • Number of attachments :
    0

Description

The API needs to be reviewed in order to get the stability we need after 5.0.ga.
Systematic test coverage of the API should be created under package org.activiti.test.api
Systematic review of the Javadocs
Joram will manage good coverage over BPMN features in the org.activiti.test.bpmn packages

Specific items to review:

  • Make exceptions and return values consistent in the API
    First define a strategy on when exceptions will be thrown and when null values will be returned.
    Then discuss that strategy and get consensus.
    To be covered in the strategy:
  • null values as parameters in service methods (and more broadly in the whole api)
  • null values are return values. document if it is possible or not.
  • collections as return values, always non null possible?
  • exceptions, when will activiti exceptions be thrown. maybe what other exceptions could be expected.
    Then implement tests to verify this and add explanations to the API javadocs.

See links for other API related issues planned in this release

Issue Links

This issue is related to:
ACT-1 Change init servlet into context listener Major Resolved
ACT-104 Replace findXxx methods returning lists with query API Major Resolved
ACT-103 Consider removing Page from engine interface Major Resolved
ACT-78 move sortorder out of the interface package Major Resolved

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Tom Baeyens added a comment -

I'll start on this and then Frederik can take over to work it out in more depth.

Show
Tom Baeyens added a comment - I'll start on this and then Frederik can take over to work it out in more depth.
Hide
Permalink
Tom Baeyens added a comment -

Frederik, i'm reassigning back to you as i'm done with the basic module restructuring.
Can you if it still fits your schedule for beta2?

Show
Tom Baeyens added a comment - Frederik, i'm reassigning back to you as i'm done with the basic module restructuring. Can you if it still fits your schedule for beta2?
Hide
Permalink
Joram Barrez added a comment - - edited

Conclusions of API meetings :

  • Document in userguide (API section) general way of exception throwing (ie. ActivitiException)
  • Add to that section also a description: most common exceptions (eg. no tables, no db connections, wrong schema version lead to exceptions like VersionMismatchException)
  • Params must be documented if null value is expected (eg. findXXX() or an exception is thrown (eg getActivityIds(executionId))
  • remove runtimeService.signal(executionId, null,null) and switch to .signal(executionId) for everything
  • Change all lowercase javadoc to uppercase
Show
Joram Barrez added a comment - - edited Conclusions of API meetings :
  • Document in userguide (API section) general way of exception throwing (ie. ActivitiException)
  • Add to that section also a description: most common exceptions (eg. no tables, no db connections, wrong schema version lead to exceptions like VersionMismatchException)
  • Params must be documented if null value is expected (eg. findXXX() or an exception is thrown (eg getActivityIds(executionId))
  • remove runtimeService.signal(executionId, null,null) and switch to .signal(executionId) for everything
  • Change all lowercase javadoc to uppercase

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved:
Atlassian JIRA (v4.4.3#663-r165197) | Report a problem
Powered by a free Atlassian JIRA open source license for Codehaus. Try JIRA - bug tracking software for your team.