Add API for accessing node logs in test clusters framework (elastic#9…

…7701)
Tim-Brooks · Jul 14, 2023 · 6b6a855 · 6b6a855
1 parent a5a7525
commit 6b6a855
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 0 deletions.
diff --git a/test/test-clusters/src/main/java/org/elasticsearch/test/cluster/ClusterHandle.java b/test/test-clusters/src/main/java/org/elasticsearch/test/cluster/ClusterHandle.java
@@ -11,6 +11,7 @@
 import org.elasticsearch.test.cluster.util.Version;
 
 import java.io.Closeable;
+import java.io.InputStream;
 
 /**
  * A handle to an {@link ElasticsearchCluster}.
@@ -127,4 +128,9 @@ public interface ClusterHandle extends Closeable {
      * Cleans up any resources created by this cluster.
      */
     void close();
+
+    /**
+     * Returns an {@link InputStream} for the given node log.
+     */
+    InputStream getNodeLog(int index, LogType logType);
 }
diff --git a/...st-clusters/src/main/java/org/elasticsearch/test/cluster/DefaultElasticsearchCluster.java b/...st-clusters/src/main/java/org/elasticsearch/test/cluster/DefaultElasticsearchCluster.java
@@ -12,6 +12,7 @@
 import org.junit.runner.Description;
 import org.junit.runners.model.Statement;
 
+import java.io.InputStream;
 import java.util.function.Supplier;
 
 public class DefaultElasticsearchCluster<S extends ClusterSpec, H extends ClusterHandle> implements ElasticsearchCluster {
@@ -137,6 +138,12 @@ public void upgradeToVersion(Version version) {
         handle.upgradeToVersion(version);
     }
 
+    @Override
+    public InputStream getNodeLog(int index, LogType logType) {
+        checkHandle();
+        return handle.getNodeLog(index, logType);
+    }
+
     private void checkHandle() {
         if (handle == null) {
             throw new IllegalStateException("Cluster handle has not been initialized. Did you forget the @ClassRule annotation?");

diff --git a/test/test-clusters/src/main/java/org/elasticsearch/test/cluster/LogType.java b/test/test-clusters/src/main/java/org/elasticsearch/test/cluster/LogType.java
@@ -0,0 +1,24 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+package org.elasticsearch.test.cluster;
+
+public enum LogType {
+    SERVER("%s.log"),
+    SERVER_JSON("%s_server.json");
+
+    private final String filenameFormat;
+
+    LogType(String filenameFormat) {
+        this.filenameFormat = filenameFormat;
+    }
+
+    public String resolveFilename(String clusterName) {
+        return filenameFormat.formatted(clusterName);
+    }
+}
diff --git a/...test-clusters/src/main/java/org/elasticsearch/test/cluster/local/LocalClusterFactory.java b/...test-clusters/src/main/java/org/elasticsearch/test/cluster/local/LocalClusterFactory.java
@@ -13,6 +13,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.elasticsearch.test.cluster.ClusterFactory;
+import org.elasticsearch.test.cluster.LogType;
 import org.elasticsearch.test.cluster.local.LocalClusterSpec.LocalNodeSpec;
 import org.elasticsearch.test.cluster.local.distribution.DistributionDescriptor;
 import org.elasticsearch.test.cluster.local.distribution.DistributionResolver;
@@ -229,6 +230,20 @@ public long getPid() {
             return process.pid();
         }
 
+        public InputStream getLog(LogType logType) {
+            Path logFile = logsDir.resolve(logType.resolveFilename(spec.getCluster().getName()));
+            if (Files.exists(logFile)) {
+                try {
+                    return Files.newInputStream(logFile);
+                } catch (IOException e) {
+                    LOGGER.error("Failed to read log file of type '{}' for node {} at '{}'", logType, this, logFile);
+                    throw new RuntimeException(e);
+                }
+            }
+
+            throw new IllegalArgumentException("Log file " + logFile + " does not exist.");
+        }
+
         public LocalNodeSpec getSpec() {
             return spec;
         }
@@ -354,6 +369,7 @@ private void writeConfiguration() {
             try {
                 // Write settings to elasticsearch.yml
                 Map<String, String> finalSettings = new HashMap<>();
+                finalSettings.put("cluster.name", spec.getCluster().getName());
                 finalSettings.put("node.name", name);
                 finalSettings.put("path.repo", repoDir.toString());
                 finalSettings.put("path.data", dataDir.toString());

diff --git a/.../test-clusters/src/main/java/org/elasticsearch/test/cluster/local/LocalClusterHandle.java b/.../test-clusters/src/main/java/org/elasticsearch/test/cluster/local/LocalClusterHandle.java
@@ -11,12 +11,14 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.elasticsearch.test.cluster.ClusterHandle;
+import org.elasticsearch.test.cluster.LogType;
 import org.elasticsearch.test.cluster.local.LocalClusterFactory.Node;
 import org.elasticsearch.test.cluster.local.model.User;
 import org.elasticsearch.test.cluster.util.ExceptionUtils;
 import org.elasticsearch.test.cluster.util.Version;
 
 import java.io.IOException;
+import java.io.InputStream;
 import java.io.UncheckedIOException;
 import java.net.MalformedURLException;
 import java.nio.file.Files;
@@ -169,6 +171,11 @@ public void stopNode(int index) {
         nodes.get(index).stop(false);
     }
 
+    @Override
+    public InputStream getNodeLog(int index, LogType logType) {
+        return nodes.get(index).getLog(logType);
+    }
+
     protected void waitUntilReady() {
         writeUnicastHostsFile();
         try {