Document unit testing for plugin authors

[gaben]

I developed a plugin for JOSM some time ago. It's written in Kotlin and utilizes ​TestNG. However, I recently realized it might not work at all because everything was prepared with JUnit in mind.

Can someone help me figure out how it's possible to test plugins, possibly with TestNG? I'm not committed to TestNG; it would just be nice to have so I wouldn't need to rewrite what I currently have.

After all, I couldn't find documentation for plugin authors on writing unit tests, let it be TestNG or JUnit. I'm happy to create the pages, but I currently lack the knowledge. Just today, I discovered that there is a josm-unittest.jar lib for this purpose...

[taylor.smock]

The josm-unittest.jar is specifically distributed for that purpose, yes.

The following classes should be used in order:

• source:trunk/test/unit/org/openstreetmap/josm/testutils/annotations/ (JUnit 5, most everything should be able to be done with these, some are automatically registered if you run tests with -Djunit.jupiter.extensions.autodetection.enabled=true -- just annotate the class with them)
• source:trunk/test/unit/org/openstreetmap/josm/testutils/JOSMTestRules.java​ (JUnit 4 and 5, with JUnit 5 use @RegisterExtension, don't remember what to do with JUnit 4, but don't use JUnit 4 for new projects)
• source:trunk/test/unit/org/openstreetmap/josm/JOSMFixture.java​ (JUnit 3, don't know how to use it, don't use JUnit 3 for new projects)

[gaben]

I moved the project to JUnit 5. It took me a day, but it was worth it. Now automagically everything started working :D Thank you!

[taylor.smock]

We have a short section on wiki:DevelopersGuide/DevelopingPlugins#Automatedtesting about automated testing, which pretty much comes down to "look at these examples".

[gaben]

Hmm, I missed that section. Anyway, I added a sentence about my findings.