Unit Testing of plugin code

RE: Unit Testing of plugin code

Justin Scott — Wed, 20 Mar 2019 06:29:59 GMT

As a senior developer responsible for creating a plugin standard across all projects, I struggle with this.
Some developers will use and pass Appian specific services into nearly every important or critical method in most classes.

When asked to rebrand an altered plugin, it's practically impossible, within a reasonable amount of time, to decouple the Appian specific code and the actual workhorses of the plugin. This is generally due to downloaded plugins and plugins developed in-house due, specifically, to the lack of standards.

Carlos is right, plugins are a two piece project. The plugin code itself, the pom, and you should be using Maven, would call a separate library to do the actual heavy lifting and the Plugin project is simply an integration wrapper.

With ConfigurationLoader.initializeConfiguration being deprecated, we need a way to mock Appian services to support legacy or upgraded plugins without the need to spend an inordinate amount of time trying to split it apart.

RE: Unit Testing of plugin code

Philip Snyman — Thu, 11 Jan 2018 14:58:14 GMT

Yes, I am actually looking for a way to run automated regression testing for the Appian plugins we are implementing. Integration testing with other systems is not an issue at this point. Thanks.

RE: Unit Testing of plugin code

Carlos Santander — Thu, 11 Jan 2018 13:47:39 GMT

Ok, I thought you were still asking about unit testing, whereas you're now asking about a different approach to using the deprecated initializeConfigurations. The documentation states that using the service API from a standalone application is no longer supported, so you could still create unittests for logic that doesn't depend on Appian services. Alternatively, you could create mocks for the Appian services that you would use in the tests.

RE: Unit Testing of plugin code

Philip Snyman — Thu, 11 Jan 2018 13:09:23 GMT

Hi Carlos. Thank you for the reply but that is not going to achieve what I have in mind. I will continue my search. Thanks!

RE: Unit Testing of plugin code

Carlos Santander — Mon, 08 Jan 2018 14:45:21 GMT

This might not be sufficient for your case, but one way to think about a plugin is as a two-piece component: the actual functionality and an integration layer. You can create jUnit tests for the functionality piece of the plugin (for example, communicating with an external service), but the integration layer would be tested by writing test rules/test process models in Appian.

RE: Unit Testing of plugin code

Philip Snyman — Mon, 08 Jan 2018 14:11:38 GMT

Hi Eduardo,
Is there are a recommended alternative to the approach you described? The ConfigurationLoader.initializeConfigurations() method is currently marked as Deprecated.
Regards,
Philip

RE: Unit Testing of plugin code

chetany — Fri, 02 Dec 2016 11:40:52 GMT

Thanks Eduardo. Will try it out.

RE: Unit Testing of plugin code

Eduardo Fuentes — Fri, 02 Dec 2016 11:02:01 GMT

You can do that the same way you test any plug-in, all you need is:

1. A local Appian installation
2. Add <APPIAN_HOME>\\_admin\\_scripts\\classpath.jar to the build path
3. When initializing the unit testing invoke

ConfigurationLoader.initializeConfigurations();

For example

@Before
public void setUp() throws Exception {
ConfigurationLoader.initializeConfigurations();
}

then start from there.