Skip to content
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.

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

CUSTCOM-81 Display port number on start-domain with --debug=true option #4387

Merged
merged 3 commits into from
Jan 8, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2008-2015 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2008-2019 Oracle and/or its affiliates. All rights reserved.
Copy link
Contributor

Choose a reason for hiding this comment

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

Only a question: why you updated this copyright year?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I missed the one already in place, hidden at

// Portions Copyright [2016-2019] [Payara Foundation and/or its affiliates]

Have not revoked OCA, so it's still kind of true 😉 I think.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dmatej I'm going to check my pending open PRs.

*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
Expand Down Expand Up @@ -364,32 +364,41 @@ public final boolean needsManualUpgrade() {
private void parseDebug() {
// look for an option of this form:
// -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=9009
// or
// -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=9009
// and extract the suspend and port values
for (String opt : debugOptions) {
if (!opt.startsWith("-Xrunjdwp:"))
continue;
String[] attrs = opt.substring(10).split(",");
for (String attr : attrs) {
if (attr.startsWith("address=")) {
try {
debugPort = Integer.parseInt(attr.substring(8));
}
catch (NumberFormatException ex) {
debugPort = -1;
}
}
if (attr.startsWith("suspend=")) {
try {
debugSuspend = attr.substring(8).equalsIgnoreCase("y");
}
catch (Exception ex) {
debugSuspend = false;
}
}
if (isJdwpOption(opt)) {
debugPort = extractDebugPort(opt);
debugSuspend = extractDebugSuspend(opt);
}
}
}

static boolean isJdwpOption(String option) {
return option.startsWith("-Xrunjdwp:") || option.startsWith("-agentlib:jdwp");
}

static int extractDebugPort(String option) {
Pattern portRegex = Pattern.compile(".*address=(?<port>\\d*).*");
Matcher m = portRegex.matcher(option);
if (!m.matches()) {
return -1;
}
try {
String addressGroup = m.group("port");
return Integer.parseInt(addressGroup);
} catch (NumberFormatException nfex) {
return -1;
}
}

static boolean extractDebugSuspend(String option) {
Pattern suspendRegex = Pattern.compile(".*suspend=[yY](?:,.*|$)");
Matcher m = suspendRegex.matcher(option);
return m.matches();
}

private void setLogFilename(MiniXmlParser parser) {

// Check if launching an instance to get appropriate logFilename
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2019 Payara Foundation and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://github.com/payara/Payara/blob/master/LICENSE.txt
* See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* The Payara Foundation designates this particular file as subject to the "Classpath"
* exception as provided by the Payara Foundation in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.admin.launcher;

import org.junit.Test;

import static org.junit.Assert.assertEquals;

public class GFLauncherExtractPortTest {
@Test
public void shouldExtractPortNumberFromDebugOption() {
int port = GFLauncher.extractDebugPort("-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=9876");

assertEquals(9876, port);
}

@Test
public void shouldNotFindPortNumberInOption() {
int port = GFLauncher.extractDebugPort("-agentlib:jdwp=transport=dt_socket,server=y,suspend=n");

assertEquals(-1, port);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2019 Payara Foundation and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://github.com/payara/Payara/blob/master/LICENSE.txt
* See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* The Payara Foundation designates this particular file as subject to the "Classpath"
* exception as provided by the Payara Foundation in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.admin.launcher;

import org.junit.Test;

import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

public class GFLauncherExtractSuspendTest {
@Test
public void shouldExtractSuspendDebugNOption() {
boolean suspend = GFLauncher.extractDebugSuspend("-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=9876");

assertFalse(suspend);
}

@Test
public void shouldExtractSuspendDebugYOption() {
boolean suspend = GFLauncher.extractDebugSuspend("-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=9876");

assertTrue(suspend);
}

@Test
public void shouldDefaultToFalseIfNoSuspendOption() {
boolean suspend = GFLauncher.extractDebugSuspend("-agentlib:jdwp=transport=dt_socket,server=y,address=9876");

assertFalse(suspend);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2019 Payara Foundation and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://github.com/payara/Payara/blob/master/LICENSE.txt
* See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* The Payara Foundation designates this particular file as subject to the "Classpath"
* exception as provided by the Payara Foundation in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.admin.launcher;

import org.junit.Test;

import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

public class GFLauncherJdwpCheckerTest {

// Pre-1.5 java option:
// https://download.oracle.com/otn_hosted_doc/jdeveloper/904preview/jdk14doc/docs/tooldocs/solaris/jdb.html
// still supported in OpenJDK 11
@Test
public void shouldRecognizeXOption() {
boolean isJdwp = GFLauncher.isJdwpOption("-Xrunjdwp:transport=dt_socket,server=y,suspend=n");

assertTrue(isJdwp);
}

// Since 1.5 java option:
// https://docs.oracle.com/javase/1.5.0/docs/tooldocs/solaris/java.html
@Test
public void shouldRecognizeAgentlibOption() {
boolean isJdwp = GFLauncher.isJdwpOption("-agentlib:jdwp=transport=dt_socket,server=y,suspend=n");

assertTrue(isJdwp);
}

@Test
public void shouldRecognizeAsNonJdwpOption() {
boolean isJdwp = GFLauncher.isJdwpOption("-agentlib:hprof=transport=dt_socket,server=y,suspend=n");

assertFalse(isJdwp);
}
}