Merge pull request #87 from cljohnso/memoryMonitor

Add memory monitor

Author: chrisdennis

port-chooser/src/main/java/org/terracotta/utilities/test/net/NetStat.java

@@ -498,7 +498,10 @@ private static BusyPort parseWindowsCsv(String line) {
       builder.localEndpoint(BusyPort.IPVersion.IPV4, fields.get(1), fields.get(2));
       builder.remoteEndpoint(BusyPort.IPVersion.IPV4, fields.get(3), fields.get(4));
       builder.state(BusyPort.TcpState.fromMicrosoftString(fields.get(5)));
-      builder.shortCommand(fields.get(6));
+      // The short command may be missing
+      if (fields.size() >= 7) {
+        builder.shortCommand(fields.get(6));
+      }
       // The full command line may be missing ...
       if (fields.size() >= 8) {
         builder.commandLine(fields.get(7));

port-chooser/src/test/java/org/terracotta/utilities/test/net/PortManagerTest.java

@@ -17,14 +17,11 @@
 package org.terracotta.utilities.test.net;
 
 import ch.qos.logback.classic.Level;
-import ch.qos.logback.classic.LoggerContext;
-import ch.qos.logback.classic.filter.ThresholdFilter;
-import ch.qos.logback.classic.spi.ILoggingEvent;
 
 import org.junit.Ignore;
 import org.junit.Test;
-import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.terracotta.utilities.test.logging.ConnectedListAppender;
 
 import java.io.IOException;
 import java.lang.ref.WeakReference;
@@ -40,7 +37,6 @@
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicReference;
 
-import static java.util.Objects.requireNonNull;
 import static org.hamcrest.Matchers.allOf;
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.hasItem;
@@ -323,7 +319,7 @@ public void testReleaseCheckEnabled() throws IOException {
     assertFalse(PortManager.DISABLE_PORT_RELEASE_CHECK_ENV_VARIABLE + " environment variable must be false or not specified",
         Boolean.parseBoolean(System.getenv(PortManager.DISABLE_PORT_RELEASE_CHECK_ENV_VARIABLE)));
 
-    try (ListAppender appender = new ListAppender(LoggerFactory.getLogger(PortManager.class), "WARN")) {
+    try (ConnectedListAppender appender = ConnectedListAppender.newInstance(LoggerFactory.getLogger(PortManager.class), "WARN")) {
       PortManager.PortRef portRef = portManager.reservePort();
       int port = portRef.port();
       try (ServerSocket ignored = new ServerSocket(port)) {
@@ -351,7 +347,7 @@ public void testReleaseCheckDisabled() throws IOException {
     assertFalse(PortManager.DISABLE_PORT_RELEASE_CHECK_ENV_VARIABLE + " environment variable must be false or not specified",
         Boolean.parseBoolean(System.getenv(PortManager.DISABLE_PORT_RELEASE_CHECK_ENV_VARIABLE)));
 
-    try (ListAppender appender = new ListAppender(LoggerFactory.getLogger(PortManager.class), "WARN")) {
+    try (ConnectedListAppender appender = ConnectedListAppender.newInstance(LoggerFactory.getLogger(PortManager.class), "WARN")) {
       PortManager.PortRef portRef = portManager.reservePort();
       int port = portRef.port();
       try (ServerSocket ignored = new ServerSocket(port)) {
@@ -380,7 +376,7 @@ public void testReleaseCheckDisabledEnvironment() throws IOException {
     assumeTrue("Skipped unless " + PortManager.DISABLE_PORT_RELEASE_CHECK_ENV_VARIABLE + " environment variable is true",
         Boolean.parseBoolean(System.getenv(PortManager.DISABLE_PORT_RELEASE_CHECK_ENV_VARIABLE)));
 
-    try (ListAppender appender = new ListAppender(LoggerFactory.getLogger(PortManager.class), "WARN")) {
+    try (ConnectedListAppender appender = ConnectedListAppender.newInstance(LoggerFactory.getLogger(PortManager.class), "WARN")) {
       PortManager.PortRef portRef = portManager.reservePort();
       int port = portRef.port();
       try (ServerSocket ignored = new ServerSocket(port)) {
@@ -439,50 +435,4 @@ public void testSequentialAllocation() {
       ports.clear();
     }
   }
-
-  /**
-   * A {@link ch.qos.logback.core.read.ListAppender} implementation that auto-connects
-   * itself to a designated {@link Logger}.  The {@link #close()} or {@link #stop()} method
-   * should be called after use of the appender is completed to have the appender removed
-   * from the designated {@code Logger}.
-   */
-  private static class ListAppender extends ch.qos.logback.core.read.ListAppender<ILoggingEvent>
-      implements AutoCloseable {
-    private final ch.qos.logback.classic.Logger logbackLogger;
-
-    public ListAppender(Logger logger, String minimumLevel) {
-      super();
-      requireNonNull(logger, "logger");
-      Level minLevel = Level.toLevel(requireNonNull(minimumLevel, "minimumLevel"), Level.DEBUG);
-
-      this.setContext((LoggerContext)LoggerFactory.getILoggerFactory());
-      ThresholdFilter filter = new ThresholdFilter();
-      filter.setLevel(minLevel.levelStr);
-      this.addFilter(filter);
-      this.start();
-
-      this.logbackLogger = (ch.qos.logback.classic.Logger)logger;
-      logbackLogger.addAppender(this);
-    }
-
-    @Override
-    public void stop() {
-      logbackLogger.detachAppender(this);
-      super.stop();
-    }
-
-    @Override
-    public void close() {
-      this.stop();
-    }
-
-    /**
-     * Gets a reference to the {@code List} holding the recorded {@link ILoggingEvent} instances.
-     * This list may be altered, for example, cleared.
-     * @return the mutable list of recorded {@code ILoggingEvent} instances
-     */
-    public List<ILoggingEvent> events() {
-      return this.list;
-    }
-  }
 }

test-tools/src/main/java/org/terracotta/utilities/test/logging/ConnectedListAppender.java

@@ -0,0 +1,116 @@
+/*
+ * Copyright IBM Corp. 2025
+ *
+ * Licensed 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.terracotta.utilities.test.logging;
+
+import ch.qos.logback.classic.Level;
+import ch.qos.logback.classic.LoggerContext;
+import ch.qos.logback.classic.filter.ThresholdFilter;
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.List;
+
+import static java.util.Objects.requireNonNull;
+
+/**
+ * A {@link ch.qos.logback.core.read.ListAppender} implementation that auto-connects
+ * itself to a designated {@link Logger}.  The {@link #close()} or {@link #stop()} method
+ * should be called after use of the appender is completed to have the appender removed
+ * from the designated {@code Logger}.
+ *
+ * <h3>Usage</h3>
+ * The following demonstrates a typical usage pattern:
+ * <pre>{@code
+ *     try (ConnectedListAppender appender = ConnectedListAppender.newInstance(LoggerFactory.getLogger(ObservedLoggerClass.class), "WARN")) {
+ *       ...
+ *       // activity logging against ObservedLoggerClass
+ *       ...
+ *       assertThat(appender.events(), hasItem(allOf(
+ *           hasProperty("level", equalTo(Level.ERROR)),
+ *           hasProperty("formattedMessage", is(stringContainsInOrder("first string ", "second string")))
+ *       )));
+ *     }}</pre>
+ */
+public class ConnectedListAppender extends ch.qos.logback.core.read.ListAppender<ILoggingEvent>
+    implements AutoCloseable {
+  private final ch.qos.logback.classic.Logger logbackLogger;
+
+  /**
+   * Create a new {@code ConnectedListAppender} connected to the specified {@code Logger}.
+   * @param logger the {@code Logger} to which the new appender is added
+   * @param minimumLevel the <i>minimum</i> level of logging events to capture;
+   *                     "ERROR" &gt; "WARN" &gt; "INFO" &gt; "DEBUG" &gt; "TRACE" &gt; "ALL";
+   *                     if the value supplied is not recognized by Logback, "DEBUG" is used
+   * @return a new {@code ConnectedListAppender} instance
+   */
+  public static ConnectedListAppender newInstance(Logger logger, String minimumLevel) {
+    ConnectedListAppender appender = new ConnectedListAppender(logger);
+    appender.setContext((LoggerContext)LoggerFactory.getILoggerFactory());
+
+    Level minLevel = Level.toLevel(requireNonNull(minimumLevel, "minimumLevel"), Level.DEBUG);
+    ThresholdFilter filter = new ThresholdFilter();
+    filter.setLevel(minLevel.levelStr);
+    appender.addFilter(filter);
+
+    appender.start();
+
+    ((ch.qos.logback.classic.Logger)logger).addAppender(appender);
+
+    return appender;
+  }
+
+  /**
+   * Create a new {@code ConnectedListAppender}.
+   * @param logger the {@code Logger} to which the new appender is added
+   */
+  private ConnectedListAppender(Logger logger) {
+    super();
+    this.logbackLogger = (ch.qos.logback.classic.Logger)requireNonNull(logger, "logger");
+  }
+
+  /**
+   * Detaches this appender from the logger and stops this appender.
+   */
+  @Override
+  public void stop() {
+    logbackLogger.detachAppender(this);
+    super.stop();
+  }
+
+  /**
+   * Detaches this appender from the logger and stops this appender.
+   * This method calls {@link #stop()}.
+   */
+  @Override
+  public void close() {
+    this.stop();
+  }
+
+  /**
+   * Gets a reference to the {@code List} holding the recorded {@link ILoggingEvent} instances.
+   * This list may be altered, for example, cleared.
+   * <p>
+   * The returned list is <i>live</i> -- it is the list to which logging events are appended.
+   * Accesses to the returned list while this appender is "active" should synchronize against
+   * this appender.
+   *
+   * @return the mutable list of recorded {@code ILoggingEvent} instances
+   */
+  public List<ILoggingEvent> events() {
+    return this.list;
+  }
+}