Skip to content

Fixed misleading expansion variable log message in ci.common #532

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
venmanyarun merged 4 commits into from
Aug 24, 2026
Merged

Fixed misleading expansion variable log message in ci.common #532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e3e819b
Updated the environment variable resolution log message
sajeerzeji Aug 13, 2026
f007a6c
Tests added
sajeerzeji Aug 13, 2026
39339bc
Fixed the log message to report each variable's individual resolved v…
sajeerzeji Aug 20, 2026
faa5d9e
Added one full line log to show which one got replaced with what
sajeerzeji Aug 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/main/java/io/openliberty/tools/common/plugins/config/ServerConfigDocument.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,9 @@ private String resolveExpansionProperties(Properties props, String value, String
Pattern pattern = OSUtil.isWindows() ? WINDOWS_EXPANSION_VAR_PATTERN : LINUX_EXPANSION_VAR_PATTERN;
Matcher matcher = pattern.matcher(value);
StringBuffer sb = new StringBuffer();
boolean anyMatched = false;
while (matcher.find()) {
anyMatched = true;
String finalReplacement;
String varName = matcher.group(1);
// 2. Circular Reference Guard
Expand All @@ -381,10 +383,14 @@ private String resolveExpansionProperties(Properties props, String value, String
finalReplacement = matcher.group(0); // Keep original
}
matcher.appendReplacement(sb, Matcher.quoteReplacement(finalReplacement));
log.info(String.format("Resolving Property %s for expression %s. Resolved expression value is %s", varName , value , sb));
log.info(String.format("Resolved environment variable \"%s\" in path \"%s\" to \"%s\"", varName, value, finalReplacement));
Comment thread
venmanyarun marked this conversation as resolved.
}
// 4. Finalize the string
matcher.appendTail(sb);
// Log the complete resolved value once, only when at least one variable was expanded
if (anyMatched) {
log.info(String.format("Resolved path \"%s\" to \"%s\"", value, sb));
}
return sb.toString();
}

Expand Down
153 changes: 153 additions & 0 deletions src/test/java/io/openliberty/tools/common/config/ExpansionVariableLogMessageTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
/**
* (C) Copyright IBM Corporation 2026.
*
* 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 io.openliberty.tools.common.config;

import static org.junit.Assert.assertTrue;

import java.io.File;
import java.nio.file.Files;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.junit.Assume;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;

import io.openliberty.tools.common.TestLogger;
import io.openliberty.tools.common.plugins.config.ServerConfigDocument;
import io.openliberty.tools.common.plugins.util.OSUtil;
import io.openliberty.tools.common.plugins.util.ServerFeatureUtil;

// Verifies the log message format produced by resolveExpansionProperties() after the fix for issue #2076
public class ExpansionVariableLogMessageTest {

@Rule
public TemporaryFolder tmp = new TemporaryFolder();

// Captures info() calls for assertion; all other methods delegate to TestLogger
private static class CapturingLogger extends TestLogger {
final List<String> infoMessages = new ArrayList<>();

@Override
public void info(String msg) { infoMessages.add(msg); }
}

// server.env is placed in serverDir because SERVER_CONFIG_DIR maps there, making it visible to processServerEnv()
private ServerConfigDocument buildDoc(CapturingLogger log, File serverDir, String serverEnvContent) throws Exception {
Files.write(new File(serverDir, "server.env").toPath(), serverEnvContent.getBytes());

Map<String, File> dirMap = new HashMap<>();
dirMap.put(ServerFeatureUtil.WLP_INSTALL_DIR, serverDir);
dirMap.put(ServerFeatureUtil.WLP_USER_DIR, serverDir);
dirMap.put(ServerFeatureUtil.SERVER_CONFIG_DIR, serverDir);
dirMap.put(ServerFeatureUtil.SERVER_OUTPUT_DIR, serverDir);
return new ServerConfigDocument(log, null, dirMap);
}

@Test
public void testUnixStyleLogMessageFormat() throws Exception {
Assume.assumeFalse("Skipped on Windows: Unix ${VAR} pattern not active", OSUtil.isWindows());

CapturingLogger log = new CapturingLogger();
File serverDir = tmp.newFolder("server-unix");

String envContent = "BASE=TEST\nDERIVED=${BASE}_SUFFIX\n";
buildDoc(log, serverDir, envContent).processServerEnv();

String expectedMsg = "Resolved environment variable \"BASE\" in path \"${BASE}_SUFFIX\" to \"TEST\"";
String expectedSummary = "Resolved path \"${BASE}_SUFFIX\" to \"TEST_SUFFIX\"";
assertTrue("Expected log message not found.\nActual info messages: " + log.infoMessages,
log.infoMessages.stream().anyMatch(m -> m.equals(expectedMsg)));
assertTrue("Expected summary log message not found.\nActual: " + log.infoMessages,
log.infoMessages.stream().anyMatch(m -> m.equals(expectedSummary)));
}

@Test
public void testUnixStyleMultipleVarsLogsBothVarNames() throws Exception {
Assume.assumeFalse("Skipped on Windows: Unix ${VAR} pattern not active", OSUtil.isWindows());

CapturingLogger log = new CapturingLogger();
File serverDir = tmp.newFolder("server-unix-multi");

String envContent = "EXP_VAR=TEST\nEXP_VAR2=UNIX\nCOMBINED=${EXP_VAR}_${EXP_VAR2}\n";
buildDoc(log, serverDir, envContent).processServerEnv();

String expectedMsg1 = "Resolved environment variable \"EXP_VAR\" in path \"${EXP_VAR}_${EXP_VAR2}\" to \"TEST\"";
String expectedMsg2 = "Resolved environment variable \"EXP_VAR2\" in path \"${EXP_VAR}_${EXP_VAR2}\" to \"UNIX\"";
String expectedSummary = "Resolved path \"${EXP_VAR}_${EXP_VAR2}\" to \"TEST_UNIX\"";
assertTrue("Expected first log message not found.\nActual: " + log.infoMessages,
log.infoMessages.stream().anyMatch(m -> m.equals(expectedMsg1)));
assertTrue("Expected second log message not found.\nActual: " + log.infoMessages,
log.infoMessages.stream().anyMatch(m -> m.equals(expectedMsg2)));
assertTrue("Expected summary log message not found.\nActual: " + log.infoMessages,
log.infoMessages.stream().anyMatch(m -> m.equals(expectedSummary)));
}

@Test
public void testNoExpansionReferenceNoLogEmitted() throws Exception {
CapturingLogger log = new CapturingLogger();
File serverDir = tmp.newFolder("server-no-expansion");

String envContent = "PLAIN_VAR=just_a_value\n";
buildDoc(log, serverDir, envContent).processServerEnv();

assertTrue("No info log message should be emitted for plain values, but found: " + log.infoMessages,
log.infoMessages.isEmpty());
}

@Test
public void testWindowsStyleBackslashesPreservedInLog() throws Exception {
Assume.assumeTrue("Skipped on non-Windows: !VAR! pattern only active on Windows", OSUtil.isWindows());

CapturingLogger log = new CapturingLogger();
File serverDir = tmp.newFolder("server-win");

// Reproduces the exact scenario from issue #2076
String envContent = "IBM_JAVA_SEMERU_HOME=C:\\MyData\\java\\ibm-semeru-certified\nJAVA_HOME=!IBM_JAVA_SEMERU_HOME!\\jdk-21.0.10+7\n";
buildDoc(log, serverDir, envContent).processServerEnv();

String expectedMsg = "Resolved environment variable \"IBM_JAVA_SEMERU_HOME\" in path \"!IBM_JAVA_SEMERU_HOME!\\jdk-21.0.10+7\" to \"C:\\MyData\\java\\ibm-semeru-certified\\jdk-21.0.10+7\"";
String expectedSummary = "Resolved path \"!IBM_JAVA_SEMERU_HOME!\\jdk-21.0.10+7\" to \"C:\\MyData\\java\\ibm-semeru-certified\\jdk-21.0.10+7\"";
assertTrue("Log message with backslashes not found — backslashes may have been dropped.\nActual: " + log.infoMessages,
log.infoMessages.stream().anyMatch(m -> m.equals(expectedMsg)));
assertTrue("Expected summary log message not found.\nActual: " + log.infoMessages,
log.infoMessages.stream().anyMatch(m -> m.equals(expectedSummary)));
}

@Test
public void testWindowsStyleMultipleVarsOneLogPerExpression() throws Exception {
Assume.assumeTrue("Skipped on non-Windows: !VAR! pattern only active on Windows", OSUtil.isWindows());

CapturingLogger log = new CapturingLogger();
File serverDir = tmp.newFolder("server-win-multi");

String envContent = "EXP_VAR=TEST\nEXP_VAR3=WINDOWS\nCOMBINED=!EXP_VAR!_!EXP_VAR3!\n";
buildDoc(log, serverDir, envContent).processServerEnv();

String expectedMsg1 = "Resolved environment variable \"EXP_VAR\" in path \"!EXP_VAR!_!EXP_VAR3!\" to \"TEST\"";
String expectedMsg2 = "Resolved environment variable \"EXP_VAR3\" in path \"!EXP_VAR!_!EXP_VAR3!\" to \"WINDOWS\"";
String expectedSummary = "Resolved path \"!EXP_VAR!_!EXP_VAR3!\" to \"TEST_WINDOWS\"";
assertTrue("Expected first log message not found.\nActual: " + log.infoMessages,
log.infoMessages.stream().anyMatch(m -> m.equals(expectedMsg1)));
assertTrue("Expected second log message not found.\nActual: " + log.infoMessages,
log.infoMessages.stream().anyMatch(m -> m.equals(expectedMsg2)));
assertTrue("Expected summary log message not found.\nActual: " + log.infoMessages,
log.infoMessages.stream().anyMatch(m -> m.equals(expectedSummary)));
}
}