Improve automated test coverage

[MarkEWaite]

Increase automated test coverage

Automated test coverage of the embeddable build status plugin is quite low. Improve the automated test coverage by submitting pull requests with new automated tests.

Review current coverage

Review the current test coverage with the commands:

Linux

$ mvn -P enable-jacoco clean install jacoco:report
$ xdg-open target/site/jacoco/index.html

Windows

C:\Users\Yourname > mvn -P enable-jacoco clean install jacoco:report
C:\Users\Yourname > start target\site\jacoco\index.html

More information is in the "code coverage" section of the contributing guide.

Create a new test for a class that is not well covered

Most integrated development environments have tools that will create a test stub that is a good beginning. Apache Netbeans has "Create / Update tests" . JetBrains IntelliJ has "Create tests". Visual Studio Code has the "Extension Pack for Java".

Use the IDE or your own coding to create a test for one of the classes that is not well covered by tests.

Keep the test small so that the pull request is easy to review.

[adamtkac]

Hi @MarkEWaite could you assign me to this issue? Appreciate any initial pointers for working on this as a first time contributor. Thanks in advance.

[MarkEWaite]

@adamtkac I'm delighted that you're willing to contribute. There is enough work on this topic that I don't bother to assign it to a single person. You can start the work and submit a pull request. See the Jenkins gitter Hacktoberfest chat channel for a recent discussion about assessing test coverage of a plugin and writing new unit tests based on that result.

The steps are:

• Identify larger Java classes with very little test coverage from the ci.jenkins.io test coverage report (look at the line coverage report to identify the larger classes with low coverage
• Install the necessary tools (git, Java 11, Apache Maven) as described in "Preparing for plugin development"
• Checkout a local copy of the repository with git clone https://github.com/jenkinsci/embeddable-build-status-plugin.git
• Build and run automated tests locally with mvn -P enable-jacoco clean install jacoco:report
• Review the locally generated coverage report in target/site/jacoco/index.html to identify untested classes and statements
• Use your integrated development environment (Visual Studio Code, Apache Netbeans, IntelliJ, or Eclipse) to generate test stubs for one of the untested classes
• Add test details to one of the stubs, delete the other stubs
• Run the test and confirm that the test compiles and that it passes
• Submit a pull request so that it can be reviewed and improved if necessary

[adamtkac]

Thank you for your answer. It is possible to divide issue to partial issues, depending on parts of code which needs to be covered first? I will start do my best as soon as I can.

[MarkEWaite]

Thank you for your answer. It is possible to divide issue to partial issues, depending on parts of code which needs to be covered first? I will start do my best as soon as I can.

Yes, you're welcome to create additional issues that track specific classes where you are focusing implementation.