plantuml/docs/TESTING.md

Testing PlantUML

Prerequisites

See the Building page and especilay the paragraph Building PlantUML with Gradle.

Running Tests

Run all tests, for all licences

To run the tests included with the project, use the following command:

gradle test

Run a specific test, for only one licence

Comment those lines on settings.gradle.kts:

a327d636a7/settings.gradle.kts (L12-L16)

Then you can run a specific test (e.g. the aTestClass Class):

gradle test --tests aTestClass

Contributing

After successfully building and testing the project, you are ready to start contributing to PlantUML! If you have any changes to contribute, please submit a pull request through the PlantUML GitHub repository.

Test Directory Architecture

• test/
  • com/plantuml/wasm
  • net/sourceforge/plantuml
  • nonreg

%%{ init : { "flowchart" : { "curve" : "stepBefore" }}}%%
graph LR
T["test/"]
T -->|"Unit Test\n(of src/com/plantuml/api/cheerpj)"| W["com/plantuml/wasm"]
T -->|"Unit Test\n(of src/net/sourceforge/plantuml)"| U["net/sourceforge/plantuml"]
T -->|"Non-regression Test"| N[nonreg]

Additional Resources

Gradle

• site: Gradle
• doc: Gradle User Guide
• src: :octocat:Gradle

Gradle Plugins

• site: Gradle Plugins Search
• A "gradle test logger plugin"
  • src: :octocat:radarsh/gradle-test-logger-plugin

JUnit

• site: JUnit5
• doc: JUnit User Guide
• src: :octocat:JUnit-team

JUnit extensions

• doc: JUnit extensions
• The "Glytching" JUnit extensions
  • doc: Glytching JUnit extensions
  • doc: randomBeans doc
  • src: :octocat:glytching/junit-extensions

AssertJ

• doc: AssertJ
• src: :octocat:AssertJ

Mockito

• site: Mockito
• doc: Mockito doc.
• src: :octocat:Mockito