[nifi] branch main updated: NIFI-9331 Corrected ThreadUtils using Objects.equals() for LockedStackFrame

[pv...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

pvillard pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi.git


The following commit(s) were added to refs/heads/main by this push:
     new 7b2f364  NIFI-9331 Corrected ThreadUtils using Objects.equals() for LockedStackFrame
7b2f364 is described below

commit 7b2f364cf556bc90a34622d90bc3f5ffd02a0c81
Author: exceptionfactory <ex...@apache.org>
AuthorDate: Mon Oct 25 17:13:34 2021 -0500

    NIFI-9331 Corrected ThreadUtils using Objects.equals() for LockedStackFrame
    
    - Removed unused arguments from ThreadUtils.createStackTrace()
    
    Signed-off-by: Pierre Villard <pi...@gmail.com>
    
    This closes #5480.
---
 .../nifi/controller/StandardProcessorNode.java     |  2 +-
 .../java/org/apache/nifi/util/ThreadUtils.java     |  5 +-
 .../java/org/apache/nifi/util/ThreadUtilsTest.java | 99 ++++++++++++++++++++++
 3 files changed, 103 insertions(+), 3 deletions(-)

diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-components/src/main/java/org/apache/nifi/controller/StandardProcessorNode.java b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-components/src/main/java/org/apache/nifi/controller/StandardProcessorNode.java
index cd55032..875cbbd 100644
--- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-components/src/main/java/org/apache/nifi/controller/StandardProcessorNode.java
+++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-components/src/main/java/org/apache/nifi/controller/StandardProcessorNode.java
@@ -1538,7 +1538,7 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable
             final long activeMillis = now - timestamp;
             final ThreadInfo threadInfo = threadInfoMap.get(thread.getId());
 
-            final String stackTrace = ThreadUtils.createStackTrace(thread, threadInfo, threadDetails.getDeadlockedThreadIds(), threadDetails.getMonitorDeadlockThreadIds(), activeMillis);
+            final String stackTrace = ThreadUtils.createStackTrace(threadInfo, threadDetails.getDeadlockedThreadIds(), threadDetails.getMonitorDeadlockThreadIds());
 
             final ActiveThreadInfo activeThreadInfo = new ActiveThreadInfo(thread.getName(), stackTrace, activeMillis, activeTask.isTerminated());
             threadList.add(activeThreadInfo);
diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-components/src/main/java/org/apache/nifi/util/ThreadUtils.java b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-components/src/main/java/org/apache/nifi/util/ThreadUtils.java
index 780c907..b6d6e3a 100644
--- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-components/src/main/java/org/apache/nifi/util/ThreadUtils.java
+++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-components/src/main/java/org/apache/nifi/util/ThreadUtils.java
@@ -20,10 +20,11 @@ package org.apache.nifi.util;
 import java.lang.management.LockInfo;
 import java.lang.management.MonitorInfo;
 import java.lang.management.ThreadInfo;
+import java.util.Objects;
 
 public class ThreadUtils {
 
-    public static String createStackTrace(final Thread thread, final ThreadInfo threadInfo, final long[] deadlockedThreadIds, final long[] monitorDeadlockThreadIds, final long activeMillis) {
+    public static String createStackTrace(final ThreadInfo threadInfo, final long[] deadlockedThreadIds, final long[] monitorDeadlockThreadIds) {
         final StringBuilder sb = new StringBuilder();
         sb.append("\"").append(threadInfo.getThreadName()).append("\" Id=");
         sb.append(threadInfo.getThreadId()).append(" ");
@@ -69,7 +70,7 @@ public class ThreadUtils {
 
             final MonitorInfo[] monitors = threadInfo.getLockedMonitors();
             for (final MonitorInfo monitor : monitors) {
-                if (monitor.getLockedStackFrame().equals(element)) {
+                if (Objects.equals(monitor.getLockedStackFrame(), element)) {
                     sb.append("\n\t- waiting on ").append(monitor);
                 }
             }
diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-components/src/test/java/org/apache/nifi/util/ThreadUtilsTest.java b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-components/src/test/java/org/apache/nifi/util/ThreadUtilsTest.java
new file mode 100644
index 0000000..5e916b2
--- /dev/null
+++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-components/src/test/java/org/apache/nifi/util/ThreadUtilsTest.java
@@ -0,0 +1,99 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.nifi.util;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+
+import java.lang.management.LockInfo;
+import java.lang.management.MonitorInfo;
+import java.lang.management.ThreadInfo;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.mockito.Mockito.when;
+
+@ExtendWith(MockitoExtension.class)
+public class ThreadUtilsTest {
+    private static final String THREAD_NAME = "TestThread";
+
+    private static final String DECLARING_CLASS = ThreadUtilsTest.class.getName();
+
+    private static final String METHOD = "createStackTrace";
+
+    private static final String FILE_NAME = ThreadUtilsTest.class.getSimpleName();
+
+    private static final String MONITOR_CLASS = String.class.getName();
+
+    private static final int LINE_NUMBER = 100;
+
+    private static final int IDENTITY_HASH_CODE = 1024;
+
+    private static final int STACK_DEPTH = 1;
+
+    private static final int NULL_STACK_DEPTH = -1;
+
+    @Mock
+    private ThreadInfo threadInfo;
+
+    @Test
+    public void testCreateStackTrace() {
+        final Thread.State threadState = Thread.State.BLOCKED;
+        setThreadInfo(threadState, getStackTraceElement(MONITOR_CLASS));
+
+        final String stackTrace = ThreadUtils.createStackTrace(threadInfo, null, null);
+        assertThreadInfoFound(stackTrace, threadState);
+    }
+
+    @Test
+    public void testCreateStackTraceNullLockedStackFrame() {
+        final Thread.State threadState = Thread.State.RUNNABLE;
+        setThreadInfo(threadState, null);
+
+        final String stackTrace = ThreadUtils.createStackTrace(threadInfo, null, null);
+        assertThreadInfoFound(stackTrace, threadState);
+    }
+
+    private void setThreadInfo(final Thread.State threadState, final StackTraceElement lockedStackFrame) {
+        when(threadInfo.getThreadName()).thenReturn(THREAD_NAME);
+
+        when(threadInfo.getThreadState()).thenReturn(threadState);
+
+        final StackTraceElement stackTraceElement = getStackTraceElement(DECLARING_CLASS);
+        when(threadInfo.getStackTrace()).thenReturn(new StackTraceElement[]{stackTraceElement});
+
+        final int stackDepth = lockedStackFrame == null ? NULL_STACK_DEPTH : STACK_DEPTH;
+        final MonitorInfo monitorInfo = new MonitorInfo(MONITOR_CLASS, IDENTITY_HASH_CODE, stackDepth, lockedStackFrame);
+        when(threadInfo.getLockedMonitors()).thenReturn(new MonitorInfo[]{monitorInfo});
+
+        when(threadInfo.getLockedSynchronizers()).thenReturn(new LockInfo[]{});
+    }
+
+    private void assertThreadInfoFound(final String stackTrace, final Thread.State threadState) {
+        assertNotNull(stackTrace);
+        assertTrue(stackTrace.contains(THREAD_NAME), "Thread Name not found");
+        assertTrue(stackTrace.contains(threadState.toString()), "Thread State not found");
+        assertTrue(stackTrace.contains(DECLARING_CLASS), "Stack Trace declaring class not found");
+        assertTrue(stackTrace.contains(METHOD), "Stack Trace method not found");
+    }
+
+    private StackTraceElement getStackTraceElement(final String declaringClass) {
+        return new StackTraceElement(declaringClass, METHOD, FILE_NAME, LINE_NUMBER);
+    }
+}