Skip to content

NIFI-8356: Add unit test for LongRunningTaskMonitor.#4925

Closed
turcsanyip wants to merge 1 commit intoapache:mainfrom
turcsanyip:NIFI-8356
Closed

NIFI-8356: Add unit test for LongRunningTaskMonitor.#4925
turcsanyip wants to merge 1 commit intoapache:mainfrom
turcsanyip:NIFI-8356

Conversation

@turcsanyip
Copy link
Contributor

@turcsanyip turcsanyip commented Mar 23, 2021

https://issues.apache.org/jira/browse/NIFI-8356

Thank you for submitting a contribution to Apache NiFi.

Please provide a short description of the PR here:

Description of PR

Enables X functionality; fixes bug NIFI-YYYY.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there a JIRA ticket associated with this PR? Is it referenced
    in the commit message?

  • Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.

  • Has your PR been rebased against the latest commit within the target branch (typically main)?

  • Is your initial contribution a single, squashed commit? Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not squash or use --force when pushing to allow for clean monitoring of changes.

For code changes:

  • Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
  • Have you written or updated unit tests to verify your changes?
  • Have you verified that the full build is successful on JDK 8?
  • Have you verified that the full build is successful on JDK 11?
  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
  • If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
  • If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
  • If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?

For documentation related changes:

  • Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check GitHub Actions CI for build issues and submit an update to your PR as soon as possible.

Copy link
Contributor

@exceptionfactory exceptionfactory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the unit test @turcsanyip! This covers all the bases, but what do you think about simplifying it to verify calling EventReporter and leave out verification of logging? That seems to be a good balance of verification without expecting specific logging statements.

getLogger().info("Active threads: {}; Long running threads: {}", activeThreadCount, longRunningThreadCount);
}

@VisibleForTesting
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it necessary to introduce testing for log statements? Testing the invocation of EventReport.reportEvent() seems sufficient since that is the primary purpose of the monitor. Avoiding evaluating of logging in the unit test removes the need for exposing these methods for testing purposes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The main purpose of this class to log info about long running (possible stuck) tasks in the nifi log file to make troubleshooting easier. The nifi log is the only persistent storage of these messages because the bulletins disappear after a while. That's why I would assert these statements.

Additionally, the messages are shown on the UI in two places: controller and processor level bulletins. EventReport.reportEvent() handles the controller level bulletin but the processor level bulletin is triggered by log items written by the processors logger. That's why we need assert that log call.

Asserting the last "Active threads:" summary log may be unnecessary but after checking the other logs I added it too.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the explanation @turcsanyip, that makes sense.

Copy link
Contributor

@exceptionfactory exceptionfactory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 Thanks @turcsanyip!

@asfgit asfgit closed this in 4473d23 Mar 24, 2021
krisztina-zsihovszki pushed a commit to krisztina-zsihovszki/nifi that referenced this pull request Jun 28, 2022
This closes apache#4925

Signed-off-by: David Handermann <exceptionfactory@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants