vlsi commented on code in PR #6736: URL: https://github.com/apache/jmeter/pull/6736#discussion_r3791675328
########## src/protocol/http/src/main/java/org/apache/jmeter/protocol/http/curl/CurlCommandFormatter.java: ########## @@ -0,0 +1,314 @@ +/* + * 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.jmeter.protocol.http.curl; + +import java.net.URL; +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import java.util.Set; + +import org.apache.jmeter.protocol.http.config.MultipartUrlConfig; +import org.apache.jmeter.protocol.http.sampler.HTTPSampleResult; +import org.apache.jmeter.protocol.http.sampler.PostWriter; +import org.apache.jmeter.protocol.http.util.HTTPArgument; +import org.apache.jmeter.protocol.http.util.HTTPConstants; +import org.apache.jmeter.protocol.http.util.HTTPFileArg; +import org.apache.jmeter.testelement.property.JMeterProperty; +import org.apache.jmeter.util.JMeterUtils; +import org.apache.jorphan.util.StringUtilities; + +/** + * Renders an {@link HTTPSampleResult} as a ready-to-run {@code curl} command, + * the reverse of what {@link BasicCurlParser} does. + * + * <p>The generated command targets a POSIX-compatible shell: arguments are + * single-quoted and lines are continued with a trailing backslash. It is not + * valid {@code cmd.exe} or PowerShell syntax.</p> + * + * <p>The class has no Swing dependency so it can be reused outside the + * View Results Tree (for example by a future "Copy as cURL" sampler action).</p> + */ +public final class CurlCommandFormatter { + + /** Backslash line continuation followed by indentation, for a POSIX shell. */ + private static final String NEWLINE = " \\\n "; //$NON-NLS-1$ + + private static final String ACCEPT_ENCODING = "Accept-Encoding"; //$NON-NLS-1$ + + private static final String BOUNDARY = "boundary="; //$NON-NLS-1$ + + /** {@code HTTPArgument} defaults a part's content type to this; see HTTPArgumentSchema. */ + private static final String DEFAULT_FIELD_CONTENT_TYPE = "text/plain"; //$NON-NLS-1$ + + /** + * Headers that must not be reproduced in the curl command: curl generates + * them itself, they are connection-specific (hop-by-hop) headers that are + * forbidden in HTTP/2 and would make the request fail with a protocol + * error, or they are pseudo-headers JMeter adds only for reporting and that + * never went on the wire (X-LocalAddress). + */ + private static final Set<String> SKIPPED_HEADERS = Set.of( + "content-length", //$NON-NLS-1$ + "connection", //$NON-NLS-1$ + "keep-alive", //$NON-NLS-1$ + "proxy-connection", //$NON-NLS-1$ + "transfer-encoding", //$NON-NLS-1$ + "upgrade", //$NON-NLS-1$ + HTTPConstants.HEADER_LOCAL_ADDRESS.toLowerCase(Locale.ROOT)); + + /** + * Markers JMeter writes into the rendered request body in place of content + * it did not keep (a file sent as the body, or a non-repeatable entity). + * When present, the body is not the real wire body and cannot be reproduced. + * + * @see org.apache.jmeter.protocol.http.sampler.PostWriter + */ + private static final String[] BODY_PLACEHOLDERS = { + PostWriter.FILE_CONTENT_PLACEHOLDER, + PostWriter.NON_REPEATABLE_ENTITY_PLACEHOLDER + }; + + private CurlCommandFormatter() { + } + + /** + * Build a {@code curl} command line that reproduces the given HTTP request. + * + * @param sampleResult the sampled HTTP request + * @return the curl command as a string + */ + public static String format(HTTPSampleResult sampleResult) { + StringBuilder sb = new StringBuilder(256); + sb.append("curl"); //$NON-NLS-1$ + + String method = sampleResult.getHTTPMethod(); + boolean isHead = HTTPConstants.HEAD.equalsIgnoreCase(method); + boolean isGet = StringUtilities.isBlank(method) || HTTPConstants.GET.equalsIgnoreCase(method); + + // Split by line (not via JMeterUtils.parseHeaders) so repeated header + // names such as several Accept values are all preserved. + List<String[]> headers = new ArrayList<>(); + String contentType = null; + boolean acceptsEncoding = false; + String requestHeaders = sampleResult.getRequestHeaders(); + if (StringUtilities.isNotEmpty(requestHeaders)) { + for (String header : requestHeaders.split("\n")) { //$NON-NLS-1$ + int colon = header.indexOf(':'); + if (colon <= 0) { + continue; + } + String name = header.substring(0, colon).trim(); + String value = header.substring(colon + 1).trim(); + String lower = name.toLowerCase(Locale.ROOT); + if (SKIPPED_HEADERS.contains(lower)) { + continue; + } + if (HTTPConstants.HEADER_CONTENT_TYPE.equalsIgnoreCase(name)) { + contentType = value; + } + if (ACCEPT_ENCODING.equalsIgnoreCase(name)) { + acceptsEncoding = true; + } + headers.add(new String[] { name, value }); + } + } + + String body = isHead ? "" : sampleResult.getQueryString(); //$NON-NLS-1$ + boolean hasBody = StringUtilities.isNotEmpty(body); + boolean isMultipart = contentType != null + && contentType.toLowerCase(Locale.ROOT).startsWith(HTTPConstants.MULTIPART_FORM_DATA); + // Multipart bodies are rebuilt as -F flags; curl then sets its own + // Content-Type (with its own boundary), so the original one is dropped. + List<String[]> formParts = hasBody && isMultipart ? parseMultipartForm(contentType, body) : List.of(); + boolean emitsForm = !formParts.isEmpty(); + boolean emitsDataRaw = hasBody && !isMultipart && !containsPlaceholder(body); + + // Method: --head for HEAD (plain "-X HEAD" makes curl wait for a body it + // never gets); no -X for a plain GET; -X GET only when a GET carries a + // raw body, otherwise curl would switch it to POST; -X for everything else. + if (isHead) { + sb.append(" --head"); //$NON-NLS-1$ + } else if (!isGet) { + sb.append(" -X ").append(quote(method)); //$NON-NLS-1$ + } else if (emitsDataRaw) { + sb.append(" -X ").append(quote(HTTPConstants.GET)); //$NON-NLS-1$ + } + + URL url = sampleResult.getURL(); + if (url != null) { + sb.append(NEWLINE).append(quote(url.toString())); + } + + boolean hasCookieHeader = false; + for (String[] header : headers) { + if (emitsForm && HTTPConstants.HEADER_CONTENT_TYPE.equalsIgnoreCase(header[0])) { + continue; + } + if (HTTPConstants.HEADER_COOKIE.equalsIgnoreCase(header[0])) { + hasCookieHeader = true; + } + sb.append(NEWLINE).append("-H ").append(quote(header[0] + ": " + header[1])); //$NON-NLS-1$ //$NON-NLS-2$ + } + + // HttpClient disables automatic decompression, so Accept-Encoding is only present + // when explicitly set. --compressed makes curl decode the response; it is kept + // alongside the explicit header rather than replacing it, because curl otherwise + // negotiates its own build-dependent encoding list the test plan never asked for. + if (acceptsEncoding) { + sb.append(NEWLINE).append("--compressed"); //$NON-NLS-1$ + } + + // Cookies normally arrive through getCookies(), but AjpSampler can also leave a + // Cookie header in the list; curl lets the header win and silently drops -b, so + // only add -b when no Cookie header was emitted. + String cookies = sampleResult.getCookies(); + if (!hasCookieHeader && StringUtilities.isNotEmpty(cookies)) { + sb.append(NEWLINE).append("-b ").append(quote(cookies)); //$NON-NLS-1$ + } + + if (emitsForm) { + for (String[] part : formParts) { + sb.append(NEWLINE).append(part[0]).append(' ').append(quote(part[1])); + } + } else if (emitsDataRaw) { + sb.append(NEWLINE).append("--data-raw ").append(quote(body)); //$NON-NLS-1$ + } else if (hasBody) { + // A file sent as the body or a non-repeatable entity: the bytes were + // not kept, so emitting them would produce a silently-wrong command. + sb.append('\n').append("# ") //$NON-NLS-1$ + .append(JMeterUtils.getResString("view_results_table_request_tab_curl_body_omitted")); //$NON-NLS-1$ + } + + return sb.toString(); + } + + /** + * Rebuild the {@code -F} form parts of a multipart request from its rendered + * body. Regular fields become {@code name=value}; file parts become + * {@code name=@filename;type=...}. JMeter does not keep the uploaded bytes, + * so the file name is only a placeholder the user edits to a real path + * before running the command. + * + * @return the form parts, or an empty list if the body cannot be parsed + */ + private static List<String[]> parseMultipartForm(String contentType, String body) { + String boundary = extractBoundary(contentType); + // A quoted boundary is unquoted above; but if the header boundary and the body + // disagree, MultipartUrlConfig would treat the whole body as one field and emit + // garbage, so require the delimiter to be present and fall back to the note otherwise. + if (StringUtilities.isBlank(boundary) || !body.contains("--" + boundary)) { //$NON-NLS-1$ + return List.of(); + } + MultipartUrlConfig multipart = new MultipartUrlConfig(boundary); + try { + multipart.parseArguments(body); + } catch (RuntimeException e) { // NOSONAR malformed body: fall back to the omitted-body note + return List.of(); + } + List<String[]> parts = new ArrayList<>(); + for (JMeterProperty property : multipart.getArguments()) { + parts.add(formField((HTTPArgument) property.getObjectValue())); + } + for (HTTPFileArg file : multipart.getHTTPFileArgs().asArray()) { + parts.add(fileField(file)); + } + return parts; + } + + /** + * A multipart text field. {@code --form-string} keeps the value verbatim (curl would + * otherwise read a leading {@code @} or {@code <} as a file reference), but it cannot + * carry a per-part content type; {@code -F} can, so it is used when the value is safe + * for it (no {@code @}/{@code <} prefix and no {@code ;} that curl would read as an + * option separator). + */ + private static String[] formField(HTTPArgument argument) { + String value = argument.getValue() == null ? "" : argument.getValue(); //$NON-NLS-1$ + String type = argument.getContentType(); + // HTTPArgument defaults content_type to text/plain, which is indistinguishable from + // a part that carried none; only a non-default type is worth reproducing. + boolean hasType = StringUtilities.isNotEmpty(type) && !DEFAULT_FIELD_CONTENT_TYPE.equalsIgnoreCase(type); + boolean safeForF = hasType + && !value.startsWith("@") && !value.startsWith("<") && value.indexOf(';') < 0; //$NON-NLS-1$ //$NON-NLS-2$ + if (safeForF) { + return new String[] { "-F", argument.getName() + "=" + value + ";type=" + type }; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ + } + return new String[] { "--form-string", argument.getName() + "=" + value }; //$NON-NLS-1$ //$NON-NLS-2$ + } + + /** + * A multipart file part. The file name is double-quoted inside the spec so that a name + * containing {@code ;} or {@code ,} is not parsed by curl as an option separator; the + * bytes are not kept by JMeter, so the name is a placeholder to edit to a real path. + */ + private static String[] fileField(HTTPFileArg file) { + StringBuilder spec = new StringBuilder(); + spec.append(file.getParamName()).append("=@\"").append(file.getPath()).append('"'); //$NON-NLS-1$ + if (StringUtilities.isNotEmpty(file.getMimeType())) { + spec.append(";type=").append(file.getMimeType()); //$NON-NLS-1$ + } + return new String[] { "-F", spec.toString() }; //$NON-NLS-1$ + } + + /** + * Extract the {@code boundary} value of a multipart content type, unquoted. + * + * @param contentType a {@code Content-Type} header value + * @return the boundary, or {@code null} if it is absent + */ + public static String extractBoundary(String contentType) { + int index = contentType.toLowerCase(Locale.ROOT).indexOf(BOUNDARY); + if (index < 0) { Review Comment: Deduplicating this was the right call, and `RequestViewHTTP` got better for it. Two things follow from it now being public. It dereferences `contentType` with no null check, which was safe while it was private and reached only through an `isMultipart` guard. As published API it is worth a guard or an `@throws`. `RequestViewHTTP` now depends on `CurlCommandFormatter` to parse a MIME header, which is a strange direction — nothing about a boundary is curl-specific. `MultipartUrlConfig` is the only consumer of the result in both call sites and would be a more natural home. ########## src/protocol/http/src/main/java/org/apache/jmeter/protocol/http/curl/CurlCommandFormatter.java: ########## @@ -0,0 +1,314 @@ +/* + * 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.jmeter.protocol.http.curl; + +import java.net.URL; +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import java.util.Set; + +import org.apache.jmeter.protocol.http.config.MultipartUrlConfig; +import org.apache.jmeter.protocol.http.sampler.HTTPSampleResult; +import org.apache.jmeter.protocol.http.sampler.PostWriter; +import org.apache.jmeter.protocol.http.util.HTTPArgument; +import org.apache.jmeter.protocol.http.util.HTTPConstants; +import org.apache.jmeter.protocol.http.util.HTTPFileArg; +import org.apache.jmeter.testelement.property.JMeterProperty; +import org.apache.jmeter.util.JMeterUtils; +import org.apache.jorphan.util.StringUtilities; + +/** + * Renders an {@link HTTPSampleResult} as a ready-to-run {@code curl} command, + * the reverse of what {@link BasicCurlParser} does. + * + * <p>The generated command targets a POSIX-compatible shell: arguments are + * single-quoted and lines are continued with a trailing backslash. It is not + * valid {@code cmd.exe} or PowerShell syntax.</p> + * + * <p>The class has no Swing dependency so it can be reused outside the + * View Results Tree (for example by a future "Copy as cURL" sampler action).</p> + */ +public final class CurlCommandFormatter { + + /** Backslash line continuation followed by indentation, for a POSIX shell. */ + private static final String NEWLINE = " \\\n "; //$NON-NLS-1$ + + private static final String ACCEPT_ENCODING = "Accept-Encoding"; //$NON-NLS-1$ + + private static final String BOUNDARY = "boundary="; //$NON-NLS-1$ + + /** {@code HTTPArgument} defaults a part's content type to this; see HTTPArgumentSchema. */ + private static final String DEFAULT_FIELD_CONTENT_TYPE = "text/plain"; //$NON-NLS-1$ + + /** + * Headers that must not be reproduced in the curl command: curl generates + * them itself, they are connection-specific (hop-by-hop) headers that are + * forbidden in HTTP/2 and would make the request fail with a protocol + * error, or they are pseudo-headers JMeter adds only for reporting and that + * never went on the wire (X-LocalAddress). + */ + private static final Set<String> SKIPPED_HEADERS = Set.of( + "content-length", //$NON-NLS-1$ + "connection", //$NON-NLS-1$ + "keep-alive", //$NON-NLS-1$ + "proxy-connection", //$NON-NLS-1$ + "transfer-encoding", //$NON-NLS-1$ + "upgrade", //$NON-NLS-1$ + HTTPConstants.HEADER_LOCAL_ADDRESS.toLowerCase(Locale.ROOT)); + + /** + * Markers JMeter writes into the rendered request body in place of content + * it did not keep (a file sent as the body, or a non-repeatable entity). + * When present, the body is not the real wire body and cannot be reproduced. + * + * @see org.apache.jmeter.protocol.http.sampler.PostWriter + */ + private static final String[] BODY_PLACEHOLDERS = { + PostWriter.FILE_CONTENT_PLACEHOLDER, + PostWriter.NON_REPEATABLE_ENTITY_PLACEHOLDER + }; + + private CurlCommandFormatter() { + } + + /** + * Build a {@code curl} command line that reproduces the given HTTP request. + * + * @param sampleResult the sampled HTTP request + * @return the curl command as a string + */ + public static String format(HTTPSampleResult sampleResult) { + StringBuilder sb = new StringBuilder(256); + sb.append("curl"); //$NON-NLS-1$ + + String method = sampleResult.getHTTPMethod(); + boolean isHead = HTTPConstants.HEAD.equalsIgnoreCase(method); + boolean isGet = StringUtilities.isBlank(method) || HTTPConstants.GET.equalsIgnoreCase(method); + + // Split by line (not via JMeterUtils.parseHeaders) so repeated header + // names such as several Accept values are all preserved. + List<String[]> headers = new ArrayList<>(); + String contentType = null; + boolean acceptsEncoding = false; + String requestHeaders = sampleResult.getRequestHeaders(); + if (StringUtilities.isNotEmpty(requestHeaders)) { + for (String header : requestHeaders.split("\n")) { //$NON-NLS-1$ + int colon = header.indexOf(':'); + if (colon <= 0) { + continue; + } + String name = header.substring(0, colon).trim(); + String value = header.substring(colon + 1).trim(); + String lower = name.toLowerCase(Locale.ROOT); + if (SKIPPED_HEADERS.contains(lower)) { + continue; + } + if (HTTPConstants.HEADER_CONTENT_TYPE.equalsIgnoreCase(name)) { + contentType = value; + } + if (ACCEPT_ENCODING.equalsIgnoreCase(name)) { + acceptsEncoding = true; + } + headers.add(new String[] { name, value }); + } + } + + String body = isHead ? "" : sampleResult.getQueryString(); //$NON-NLS-1$ + boolean hasBody = StringUtilities.isNotEmpty(body); + boolean isMultipart = contentType != null + && contentType.toLowerCase(Locale.ROOT).startsWith(HTTPConstants.MULTIPART_FORM_DATA); + // Multipart bodies are rebuilt as -F flags; curl then sets its own + // Content-Type (with its own boundary), so the original one is dropped. + List<String[]> formParts = hasBody && isMultipart ? parseMultipartForm(contentType, body) : List.of(); + boolean emitsForm = !formParts.isEmpty(); + boolean emitsDataRaw = hasBody && !isMultipart && !containsPlaceholder(body); + + // Method: --head for HEAD (plain "-X HEAD" makes curl wait for a body it + // never gets); no -X for a plain GET; -X GET only when a GET carries a + // raw body, otherwise curl would switch it to POST; -X for everything else. + if (isHead) { + sb.append(" --head"); //$NON-NLS-1$ + } else if (!isGet) { + sb.append(" -X ").append(quote(method)); //$NON-NLS-1$ + } else if (emitsDataRaw) { + sb.append(" -X ").append(quote(HTTPConstants.GET)); //$NON-NLS-1$ + } + + URL url = sampleResult.getURL(); + if (url != null) { + sb.append(NEWLINE).append(quote(url.toString())); + } + + boolean hasCookieHeader = false; + for (String[] header : headers) { + if (emitsForm && HTTPConstants.HEADER_CONTENT_TYPE.equalsIgnoreCase(header[0])) { + continue; + } + if (HTTPConstants.HEADER_COOKIE.equalsIgnoreCase(header[0])) { + hasCookieHeader = true; + } + sb.append(NEWLINE).append("-H ").append(quote(header[0] + ": " + header[1])); //$NON-NLS-1$ //$NON-NLS-2$ + } + + // HttpClient disables automatic decompression, so Accept-Encoding is only present + // when explicitly set. --compressed makes curl decode the response; it is kept + // alongside the explicit header rather than replacing it, because curl otherwise + // negotiates its own build-dependent encoding list the test plan never asked for. + if (acceptsEncoding) { + sb.append(NEWLINE).append("--compressed"); //$NON-NLS-1$ + } + + // Cookies normally arrive through getCookies(), but AjpSampler can also leave a + // Cookie header in the list; curl lets the header win and silently drops -b, so + // only add -b when no Cookie header was emitted. + String cookies = sampleResult.getCookies(); + if (!hasCookieHeader && StringUtilities.isNotEmpty(cookies)) { + sb.append(NEWLINE).append("-b ").append(quote(cookies)); //$NON-NLS-1$ + } + + if (emitsForm) { + for (String[] part : formParts) { + sb.append(NEWLINE).append(part[0]).append(' ').append(quote(part[1])); + } + } else if (emitsDataRaw) { + sb.append(NEWLINE).append("--data-raw ").append(quote(body)); //$NON-NLS-1$ + } else if (hasBody) { + // A file sent as the body or a non-repeatable entity: the bytes were + // not kept, so emitting them would produce a silently-wrong command. + sb.append('\n').append("# ") //$NON-NLS-1$ + .append(JMeterUtils.getResString("view_results_table_request_tab_curl_body_omitted")); //$NON-NLS-1$ + } + + return sb.toString(); + } + + /** + * Rebuild the {@code -F} form parts of a multipart request from its rendered + * body. Regular fields become {@code name=value}; file parts become + * {@code name=@filename;type=...}. JMeter does not keep the uploaded bytes, + * so the file name is only a placeholder the user edits to a real path + * before running the command. + * + * @return the form parts, or an empty list if the body cannot be parsed + */ + private static List<String[]> parseMultipartForm(String contentType, String body) { + String boundary = extractBoundary(contentType); + // A quoted boundary is unquoted above; but if the header boundary and the body + // disagree, MultipartUrlConfig would treat the whole body as one field and emit + // garbage, so require the delimiter to be present and fall back to the note otherwise. + if (StringUtilities.isBlank(boundary) || !body.contains("--" + boundary)) { //$NON-NLS-1$ + return List.of(); + } + MultipartUrlConfig multipart = new MultipartUrlConfig(boundary); + try { + multipart.parseArguments(body); + } catch (RuntimeException e) { // NOSONAR malformed body: fall back to the omitted-body note + return List.of(); + } + List<String[]> parts = new ArrayList<>(); + for (JMeterProperty property : multipart.getArguments()) { + parts.add(formField((HTTPArgument) property.getObjectValue())); + } + for (HTTPFileArg file : multipart.getHTTPFileArgs().asArray()) { + parts.add(fileField(file)); + } + return parts; Review Comment: The original interleaving of fields and files is still lost — all `--form-string` parts are emitted, then all `-F` parts, whatever order the body had. Carrying it over from the resolved thread since the content-type half was fixed and this half was not. Rarely load-bearing, and the two-loop shape is a consequence of `MultipartUrlConfig` keeping arguments and files in separate collections, so "won't fix, it is documented" is a fine answer — just not silence. ########## src/protocol/http/src/main/java/org/apache/jmeter/protocol/http/curl/CurlCommandFormatter.java: ########## @@ -0,0 +1,314 @@ +/* + * 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.jmeter.protocol.http.curl; + +import java.net.URL; +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import java.util.Set; + +import org.apache.jmeter.protocol.http.config.MultipartUrlConfig; +import org.apache.jmeter.protocol.http.sampler.HTTPSampleResult; +import org.apache.jmeter.protocol.http.sampler.PostWriter; +import org.apache.jmeter.protocol.http.util.HTTPArgument; +import org.apache.jmeter.protocol.http.util.HTTPConstants; +import org.apache.jmeter.protocol.http.util.HTTPFileArg; +import org.apache.jmeter.testelement.property.JMeterProperty; +import org.apache.jmeter.util.JMeterUtils; +import org.apache.jorphan.util.StringUtilities; + +/** + * Renders an {@link HTTPSampleResult} as a ready-to-run {@code curl} command, + * the reverse of what {@link BasicCurlParser} does. + * + * <p>The generated command targets a POSIX-compatible shell: arguments are + * single-quoted and lines are continued with a trailing backslash. It is not + * valid {@code cmd.exe} or PowerShell syntax.</p> + * + * <p>The class has no Swing dependency so it can be reused outside the + * View Results Tree (for example by a future "Copy as cURL" sampler action).</p> + */ +public final class CurlCommandFormatter { + + /** Backslash line continuation followed by indentation, for a POSIX shell. */ + private static final String NEWLINE = " \\\n "; //$NON-NLS-1$ + + private static final String ACCEPT_ENCODING = "Accept-Encoding"; //$NON-NLS-1$ + + private static final String BOUNDARY = "boundary="; //$NON-NLS-1$ + + /** {@code HTTPArgument} defaults a part's content type to this; see HTTPArgumentSchema. */ + private static final String DEFAULT_FIELD_CONTENT_TYPE = "text/plain"; //$NON-NLS-1$ + + /** + * Headers that must not be reproduced in the curl command: curl generates + * them itself, they are connection-specific (hop-by-hop) headers that are + * forbidden in HTTP/2 and would make the request fail with a protocol + * error, or they are pseudo-headers JMeter adds only for reporting and that + * never went on the wire (X-LocalAddress). + */ + private static final Set<String> SKIPPED_HEADERS = Set.of( + "content-length", //$NON-NLS-1$ + "connection", //$NON-NLS-1$ + "keep-alive", //$NON-NLS-1$ + "proxy-connection", //$NON-NLS-1$ + "transfer-encoding", //$NON-NLS-1$ + "upgrade", //$NON-NLS-1$ + HTTPConstants.HEADER_LOCAL_ADDRESS.toLowerCase(Locale.ROOT)); + + /** + * Markers JMeter writes into the rendered request body in place of content + * it did not keep (a file sent as the body, or a non-repeatable entity). + * When present, the body is not the real wire body and cannot be reproduced. + * + * @see org.apache.jmeter.protocol.http.sampler.PostWriter + */ + private static final String[] BODY_PLACEHOLDERS = { + PostWriter.FILE_CONTENT_PLACEHOLDER, + PostWriter.NON_REPEATABLE_ENTITY_PLACEHOLDER + }; + + private CurlCommandFormatter() { + } + + /** + * Build a {@code curl} command line that reproduces the given HTTP request. + * + * @param sampleResult the sampled HTTP request + * @return the curl command as a string + */ + public static String format(HTTPSampleResult sampleResult) { + StringBuilder sb = new StringBuilder(256); + sb.append("curl"); //$NON-NLS-1$ + + String method = sampleResult.getHTTPMethod(); + boolean isHead = HTTPConstants.HEAD.equalsIgnoreCase(method); + boolean isGet = StringUtilities.isBlank(method) || HTTPConstants.GET.equalsIgnoreCase(method); + + // Split by line (not via JMeterUtils.parseHeaders) so repeated header + // names such as several Accept values are all preserved. + List<String[]> headers = new ArrayList<>(); + String contentType = null; + boolean acceptsEncoding = false; + String requestHeaders = sampleResult.getRequestHeaders(); + if (StringUtilities.isNotEmpty(requestHeaders)) { + for (String header : requestHeaders.split("\n")) { //$NON-NLS-1$ + int colon = header.indexOf(':'); + if (colon <= 0) { + continue; + } + String name = header.substring(0, colon).trim(); + String value = header.substring(colon + 1).trim(); + String lower = name.toLowerCase(Locale.ROOT); + if (SKIPPED_HEADERS.contains(lower)) { + continue; + } + if (HTTPConstants.HEADER_CONTENT_TYPE.equalsIgnoreCase(name)) { + contentType = value; + } + if (ACCEPT_ENCODING.equalsIgnoreCase(name)) { + acceptsEncoding = true; + } + headers.add(new String[] { name, value }); + } + } + + String body = isHead ? "" : sampleResult.getQueryString(); //$NON-NLS-1$ + boolean hasBody = StringUtilities.isNotEmpty(body); + boolean isMultipart = contentType != null + && contentType.toLowerCase(Locale.ROOT).startsWith(HTTPConstants.MULTIPART_FORM_DATA); + // Multipart bodies are rebuilt as -F flags; curl then sets its own + // Content-Type (with its own boundary), so the original one is dropped. + List<String[]> formParts = hasBody && isMultipart ? parseMultipartForm(contentType, body) : List.of(); + boolean emitsForm = !formParts.isEmpty(); + boolean emitsDataRaw = hasBody && !isMultipart && !containsPlaceholder(body); + + // Method: --head for HEAD (plain "-X HEAD" makes curl wait for a body it + // never gets); no -X for a plain GET; -X GET only when a GET carries a + // raw body, otherwise curl would switch it to POST; -X for everything else. + if (isHead) { + sb.append(" --head"); //$NON-NLS-1$ + } else if (!isGet) { + sb.append(" -X ").append(quote(method)); //$NON-NLS-1$ + } else if (emitsDataRaw) { + sb.append(" -X ").append(quote(HTTPConstants.GET)); //$NON-NLS-1$ + } + + URL url = sampleResult.getURL(); + if (url != null) { + sb.append(NEWLINE).append(quote(url.toString())); + } + + boolean hasCookieHeader = false; + for (String[] header : headers) { + if (emitsForm && HTTPConstants.HEADER_CONTENT_TYPE.equalsIgnoreCase(header[0])) { + continue; + } + if (HTTPConstants.HEADER_COOKIE.equalsIgnoreCase(header[0])) { + hasCookieHeader = true; + } + sb.append(NEWLINE).append("-H ").append(quote(header[0] + ": " + header[1])); //$NON-NLS-1$ //$NON-NLS-2$ + } + + // HttpClient disables automatic decompression, so Accept-Encoding is only present + // when explicitly set. --compressed makes curl decode the response; it is kept + // alongside the explicit header rather than replacing it, because curl otherwise + // negotiates its own build-dependent encoding list the test plan never asked for. + if (acceptsEncoding) { + sb.append(NEWLINE).append("--compressed"); //$NON-NLS-1$ + } + + // Cookies normally arrive through getCookies(), but AjpSampler can also leave a + // Cookie header in the list; curl lets the header win and silently drops -b, so + // only add -b when no Cookie header was emitted. + String cookies = sampleResult.getCookies(); + if (!hasCookieHeader && StringUtilities.isNotEmpty(cookies)) { + sb.append(NEWLINE).append("-b ").append(quote(cookies)); //$NON-NLS-1$ + } + + if (emitsForm) { + for (String[] part : formParts) { + sb.append(NEWLINE).append(part[0]).append(' ').append(quote(part[1])); + } + } else if (emitsDataRaw) { + sb.append(NEWLINE).append("--data-raw ").append(quote(body)); //$NON-NLS-1$ + } else if (hasBody) { + // A file sent as the body or a non-repeatable entity: the bytes were + // not kept, so emitting them would produce a silently-wrong command. + sb.append('\n').append("# ") //$NON-NLS-1$ + .append(JMeterUtils.getResString("view_results_table_request_tab_curl_body_omitted")); //$NON-NLS-1$ + } + + return sb.toString(); + } + + /** + * Rebuild the {@code -F} form parts of a multipart request from its rendered + * body. Regular fields become {@code name=value}; file parts become + * {@code name=@filename;type=...}. JMeter does not keep the uploaded bytes, + * so the file name is only a placeholder the user edits to a real path + * before running the command. + * + * @return the form parts, or an empty list if the body cannot be parsed + */ + private static List<String[]> parseMultipartForm(String contentType, String body) { + String boundary = extractBoundary(contentType); + // A quoted boundary is unquoted above; but if the header boundary and the body + // disagree, MultipartUrlConfig would treat the whole body as one field and emit + // garbage, so require the delimiter to be present and fall back to the note otherwise. + if (StringUtilities.isBlank(boundary) || !body.contains("--" + boundary)) { //$NON-NLS-1$ + return List.of(); + } + MultipartUrlConfig multipart = new MultipartUrlConfig(boundary); + try { + multipart.parseArguments(body); + } catch (RuntimeException e) { // NOSONAR malformed body: fall back to the omitted-body note + return List.of(); + } Review Comment: **A file part with no `Content-Type` discards the whole multipart rendering, fields and all.** `MultipartUrlConfig#162` passes the part's content type straight into `files.addHTTPFileArg(path, name, contentType)`, and `HTTPFileArg#82` rejects a null mime type with `IllegalArgumentException("Parameters must not be null")`. A file part that carries no `Content-Type` header therefore throws mid-parse, this catch swallows it, and everything already parsed — every plain text field in the body — is dropped along with it. Observed on this branch: ``` body: --xyz Content-Disposition: form-data; name="upload"; filename="report.pdf" <actual file content, not shown here> --xyz-- curl -X 'POST' \ 'http://example.com/upload' \ -H 'Content-Type: multipart/form-data; boundary=xyz' # Request body cannot be reproduced: … ``` The file name and every field were recoverable; the note claims otherwise. Defaulting the mime type to `""` before constructing the arg is enough, and narrowing the catch would stop the next such case hiding the same way — a blanket `RuntimeException` around a parser is what turned this into a silent degradation rather than a visible one. Not this PR's bug, but adjacent and worth knowing: `RequestViewHTTP#219` runs the same `parseArguments` call with no catch at all, so the same body makes the HTTP tab throw instead. ########## src/protocol/http/src/test/java/org/apache/jmeter/protocol/http/curl/CurlCommandFormatterTest.java: ########## @@ -0,0 +1,367 @@ +/* + * 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.jmeter.protocol.http.curl; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.net.MalformedURLException; +import java.net.URL; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; + +import org.apache.jmeter.protocol.http.sampler.HTTPSampleResult; +import org.junit.jupiter.api.Test; + +class CurlCommandFormatterTest { + + private static HTTPSampleResult result(String method, String url) throws MalformedURLException { + HTTPSampleResult res = new HTTPSampleResult(); + res.setHTTPMethod(method); + if (url != null) { + res.setURL(new URL(url)); + } + return res; + } + + @Test + void testSimpleGetOmitsMethodFlag() throws Exception { + HTTPSampleResult res = result("GET", "http://example.com/path?a=1";); + + assertEquals( + "curl \\\n 'http://example.com/path?a=1'", + CurlCommandFormatter.format(res)); + } + + @Test + void testPostWithHeaderAndBody() throws Exception { + HTTPSampleResult res = result("POST", "http://example.com/submit";); + res.setRequestHeaders("Content-Type: application/json"); + res.setQueryString("{\"name\":\"value\"}"); + + assertEquals( + "curl -X 'POST' \\\n" + + " 'http://example.com/submit' \\\n" + + " -H 'Content-Type: application/json' \\\n" + + " --data-raw '{\"name\":\"value\"}'", + CurlCommandFormatter.format(res)); + } + + @Test + void testRepeatedHeadersArePreserved() throws Exception { + HTTPSampleResult res = result("GET", "http://example.com/";); + res.setRequestHeaders("X-Trace: a\nX-Trace: b\nAccept: text/html\nAccept: application/json"); + + assertEquals( + "curl \\\n" + + " 'http://example.com/' \\\n" + + " -H 'X-Trace: a' \\\n" + + " -H 'X-Trace: b' \\\n" + + " -H 'Accept: text/html' \\\n" + + " -H 'Accept: application/json'", + CurlCommandFormatter.format(res)); + } + + @Test + void testConnectionAutoAndPseudoHeadersAreSkipped() throws Exception { + HTTPSampleResult res = result("POST", "http://example.com/";); + res.setRequestHeaders("Connection: keep-alive\n" + + "Content-Length: 5\n" + + "Transfer-Encoding: chunked\n" + + "X-LocalAddress: /10.0.0.5\n" + + "Accept: application/json"); + res.setQueryString("hello"); + + assertEquals( + "curl -X 'POST' \\\n" + + " 'http://example.com/' \\\n" + + " -H 'Accept: application/json' \\\n" + + " --data-raw 'hello'", + CurlCommandFormatter.format(res)); + } + + @Test + void testHeadUsesHeadFlag() throws Exception { + HTTPSampleResult res = result("HEAD", "http://example.com/";); + res.setRequestHeaders("Accept: */*"); + + String curl = CurlCommandFormatter.format(res); + assertTrue(curl.startsWith("curl --head "), curl); + assertFalse(curl.contains("-X "), curl); + assertFalse(curl.contains("--data"), curl); + } + + @Test + void testGetWithBodyKeepsMethodSoCurlDoesNotSwitchToPost() throws Exception { + HTTPSampleResult res = result("GET", "http://example.com/";); + res.setQueryString("q=1"); + + String curl = CurlCommandFormatter.format(res); + assertTrue(curl.contains("-X 'GET'"), curl); + assertTrue(curl.contains("--data-raw 'q=1'"), curl); + } + + @Test + void testMultipartRebuiltAsFormFlagsWithFileName() throws Exception { + HTTPSampleResult res = result("POST", "http://example.com/upload";); + res.setRequestHeaders("Content-Type: multipart/form-data; boundary=xyz"); + // Rendered multipart body as JMeter stores it in the result. + res.setQueryString("--xyz\r\n" + + "Content-Disposition: form-data; name=\"comment\"\r\n" + + "\r\n" + + "hello\r\n" + + "--xyz\r\n" + + "Content-Disposition: form-data; name=\"upload\"; filename=\"report.pdf\"\r\n" + + "Content-Type: application/pdf\r\n" + + "\r\n" + + "<actual file content, not shown here>\r\n" + + "--xyz--\r\n"); + + String curl = CurlCommandFormatter.format(res); + // The file part is rebuilt with the file name as an editable, double-quoted @placeholder. + assertTrue(curl.contains("-F 'upload=@\"report.pdf\";type=application/pdf'"), curl); + // Regular fields use --form-string so the value is never treated as a file. + assertTrue(curl.contains("--form-string 'comment=hello'"), curl); + // No raw dump of the placeholder, and curl sets its own multipart Content-Type. + assertFalse(curl.contains("--data-raw"), curl); + assertFalse(curl.contains("actual file content"), curl); + assertFalse(curl.contains("-H 'Content-Type: multipart/form-data"), curl); + } + + @Test + void testMultipartTextFieldWithAtPrefixUsesFormString() throws Exception { + HTTPSampleResult res = result("POST", "http://example.com/upload";); + res.setRequestHeaders("Content-Type: multipart/form-data; boundary=xyz"); + // A legitimate text field whose value starts with '@' must not be read as a file. + res.setQueryString("--xyz\r\n" + + "Content-Disposition: form-data; name=\"handle\"\r\n" + + "\r\n" + + "@someuser\r\n" + + "--xyz--\r\n"); + + String curl = CurlCommandFormatter.format(res); + assertTrue(curl.contains("--form-string 'handle=@someuser'"), curl); + assertFalse(curl.contains("-F 'handle=@someuser'"), curl); + } + + @Test + void testFileAsBodyPlaceholderIsNotReproduced() throws Exception { + HTTPSampleResult res = result("POST", "http://example.com/upload";); + res.setRequestHeaders("Content-Type: application/octet-stream"); + res.setQueryString("<actual file content, not shown here>"); + + String curl = CurlCommandFormatter.format(res); + assertFalse(curl.contains("--data-raw"), curl); + } + + @Test + void testNonRepeatableBodyPlaceholderIsNotReproduced() throws Exception { + HTTPSampleResult res = result("POST", "http://example.com/";); + res.setQueryString("<Entity was not repeatable, cannot view what was sent>"); + + String curl = CurlCommandFormatter.format(res); + assertFalse(curl.contains("--data-raw"), curl); + } + + @Test + void testWhitespaceOnlyBodyIsKept() throws Exception { + HTTPSampleResult res = result("POST", "http://example.com/";); + res.setQueryString(" "); + + assertTrue(CurlCommandFormatter.format(res).contains("--data-raw ' '")); + } + + @Test + void testCookiesAddedAsFlag() throws Exception { + HTTPSampleResult res = result("GET", "http://example.com/";); + res.setCookies("session=abc; theme=dark"); + + assertTrue(CurlCommandFormatter.format(res).contains("-b 'session=abc; theme=dark'")); + } + + @Test + void testAcceptEncodingAddsCompressed() throws Exception { + HTTPSampleResult res = result("GET", "http://example.com/";); + res.setRequestHeaders("Accept-Encoding: gzip, deflate"); + + String curl = CurlCommandFormatter.format(res); + assertTrue(curl.contains("--compressed"), curl); + // The explicit header is kept alongside --compressed so the request is unchanged + // (curl would otherwise negotiate its own build-dependent encoding list). + assertTrue(curl.contains("-H 'Accept-Encoding: gzip, deflate'"), curl); + } + + @Test + void testSingleQuoteIsEscaped() throws Exception { + HTTPSampleResult res = result("POST", "http://example.com/";); + res.setQueryString("name=O'Brien"); + + // single quote becomes '\'' so the value stays shell-safe + assertTrue(CurlCommandFormatter.format(res).contains("--data-raw 'name=O'\\''Brien'")); + } + + @Test + void testNullUrlDoesNotFail() throws Exception { + HTTPSampleResult res = result("GET", null); + + assertEquals("curl", CurlCommandFormatter.format(res)); + } + + @Test + void testRoundTripThroughParser() throws Exception { + HTTPSampleResult res = result("POST", "http://example.com/submit";); + res.setRequestHeaders("X-A: 1\nX-B: 2"); + res.setQueryString("payload"); + + String curl = CurlCommandFormatter.format(res); + BasicCurlParser.Request parsed = new BasicCurlParser().parse(curl); + + assertEquals("POST", parsed.getMethod()); + assertEquals("http://example.com/submit";, parsed.getUrl()); + assertEquals("payload", parsed.getPostData()); + List<String> headers = parsed.getHeaders().stream() + .map(e -> e.getKey() + ": " + e.getValue()) + .collect(Collectors.toList()); + assertEquals(List.of("X-A: 1", "X-B: 2"), headers); + } + + @Test + void testRoundTripPreservesDuplicateHeaders() throws Exception { + HTTPSampleResult res = result("POST", "http://example.com/";); + res.setRequestHeaders("Accept: text/html\nAccept: application/json"); + res.setQueryString("x"); + + BasicCurlParser.Request parsed = new BasicCurlParser().parse(CurlCommandFormatter.format(res)); + List<String> accept = parsed.getHeaders().stream() + .filter(e -> "Accept".equals(e.getKey())) + .map(Map.Entry::getValue) + .collect(Collectors.toList()); + assertEquals(List.of("text/html", "application/json"), accept); + } + + private static HTTPSampleResult multipart(String boundaryHeader, String body) throws MalformedURLException { + HTTPSampleResult res = result("POST", "http://example.com/upload";); + res.setRequestHeaders("Content-Type: multipart/form-data; boundary=" + boundaryHeader); + res.setQueryString(body); + return res; + } + + @Test + void testQuotedBoundaryIsUnquotedAndParsed() throws Exception { + // RFC 2046 allows a quoted boundary; it must still parse, not swallow the trailer. + HTTPSampleResult res = multipart("\"xyz\"", + "--xyz\r\nContent-Disposition: form-data; name=\"a\"\r\n\r\nb\r\n--xyz--\r\n"); + + String curl = CurlCommandFormatter.format(res); + assertTrue(curl.contains("--form-string 'a=b'"), curl); + assertFalse(curl.contains("--xyz--"), curl); + } + + @Test + void testBoundaryDisagreeingWithBodyFallsBackToNote() throws Exception { + HTTPSampleResult res = multipart("nomatch", + "--other\r\nContent-Disposition: form-data; name=\"a\"\r\n\r\nb\r\n--other--\r\n"); + + String curl = CurlCommandFormatter.format(res); + assertFalse(curl.contains("--form-string"), curl); + assertFalse(curl.contains("-F "), curl); + assertTrue(curl.contains("\n# "), curl); + } + + @Test + void testFileNameWithSemicolonOrCommaIsDoubleQuoted() throws Exception { + HTTPSampleResult res = multipart("xyz", + "--xyz\r\nContent-Disposition: form-data; name=\"up\"; filename=\"a;b,c.txt\"\r\n" + + "Content-Type: text/plain\r\n\r\n<actual file content, not shown here>\r\n--xyz--\r\n"); + + assertTrue(CurlCommandFormatter.format(res).contains("-F 'up=@\"a;b,c.txt\";type=text/plain'"), + CurlCommandFormatter.format(res)); + } + + @Test + void testMultipartFieldContentTypeIsPreservedViaF() throws Exception { + HTTPSampleResult res = multipart("xyz", + "--xyz\r\nContent-Disposition: form-data; name=\"meta\"\r\n" + + "Content-Type: application/json\r\n\r\n{\"a\":1}\r\n--xyz--\r\n"); + + assertTrue(CurlCommandFormatter.format(res).contains("-F 'meta={\"a\":1};type=application/json'"), + CurlCommandFormatter.format(res)); + } + + @Test + void testMultipartFieldWithTypeButUnsafeValueFallsBackToFormString() throws Exception { + // A content type is set, but the value would be read as a file by -F, so the + // verbatim --form-string wins and the (now unrepresentable) type is dropped. + HTTPSampleResult res = multipart("xyz", + "--xyz\r\nContent-Disposition: form-data; name=\"meta\"\r\n" + + "Content-Type: application/json\r\n\r\n@ref\r\n--xyz--\r\n"); + + String curl = CurlCommandFormatter.format(res); + assertTrue(curl.contains("--form-string 'meta=@ref'"), curl); + assertFalse(curl.contains("-F 'meta="), curl); + } + + @Test + void testCookieHeaderSuppressesDashB() throws Exception { + // AjpSampler can leave a Cookie header while getCookies() is also filled; curl lets + // the header win, so -b must not be emitted or its cookies would be silently dropped. + HTTPSampleResult res = result("GET", "http://example.com/";); + res.setRequestHeaders("Cookie: a=1"); + res.setCookies("b=2"); + + String curl = CurlCommandFormatter.format(res); + assertTrue(curl.contains("-H 'Cookie: a=1'"), curl); + assertFalse(curl.contains("-b "), curl); + } + + @Test + void testRoundTripHead() throws Exception { + HTTPSampleResult res = result("HEAD", "http://example.com/";); + + BasicCurlParser.Request parsed = new BasicCurlParser().parse(CurlCommandFormatter.format(res)); + assertEquals("HEAD", parsed.getMethod()); + assertEquals("http://example.com/";, parsed.getUrl()); + } + + @Test + void testRoundTripCompressed() throws Exception { + HTTPSampleResult res = result("GET", "http://example.com/";); + res.setRequestHeaders("Accept-Encoding: gzip, deflate"); + + BasicCurlParser.Request parsed = new BasicCurlParser().parse(CurlCommandFormatter.format(res)); + assertTrue(parsed.isCompressed()); + assertTrue(parsed.getHeaders().stream().anyMatch(e -> "Accept-Encoding".equals(e.getKey()))); + } + + @Test + void testRoundTripMultipartFieldAndFile() throws Exception { + HTTPSampleResult res = multipart("xyz", + "--xyz\r\nContent-Disposition: form-data; name=\"comment\"\r\n\r\nhello\r\n" + + "--xyz\r\nContent-Disposition: form-data; name=\"upload\"; filename=\"report.pdf\"\r\n" + + "Content-Type: application/pdf\r\n\r\n<actual file content, not shown here>\r\n--xyz--\r\n"); + + BasicCurlParser.Request parsed = new BasicCurlParser().parse(CurlCommandFormatter.format(res)); + assertEquals("POST", parsed.getMethod()); + assertTrue(parsed.getFormStringData().stream() + .anyMatch(e -> "comment".equals(e.getKey()) && "hello".equals(e.getValue())), + parsed.getFormStringData().toString()); + assertFalse(parsed.getFormData().isEmpty()); + } Review Comment: **This is the test that should have caught the `-F` quoting problem, and it cannot.** `assertFalse(parsed.getFormData().isEmpty())` passes for any non-empty result, including `FileArgumentHolder(report.pdf", {type=application/pd})`. The field half is checked by name and value; the file half, which is the part the last round changed, is checked only for existence. Asserting the parsed name and type would close it: ```java assertTrue(parsed.getFormData().stream() .anyMatch(e -> "upload".equals(e.getKey()) && "report.pdf".equals(e.getValue().getName())), parsed.getFormData().toString()); ``` Same shape as the assertion you already wrote for `comment`. A round trip asserted only for non-emptiness tests that the parser did not crash, which is a weaker claim than the test name makes. ########## src/protocol/http/src/main/java/org/apache/jmeter/protocol/http/curl/CurlCommandFormatter.java: ########## @@ -0,0 +1,314 @@ +/* + * 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.jmeter.protocol.http.curl; + +import java.net.URL; +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import java.util.Set; + +import org.apache.jmeter.protocol.http.config.MultipartUrlConfig; +import org.apache.jmeter.protocol.http.sampler.HTTPSampleResult; +import org.apache.jmeter.protocol.http.sampler.PostWriter; +import org.apache.jmeter.protocol.http.util.HTTPArgument; +import org.apache.jmeter.protocol.http.util.HTTPConstants; +import org.apache.jmeter.protocol.http.util.HTTPFileArg; +import org.apache.jmeter.testelement.property.JMeterProperty; +import org.apache.jmeter.util.JMeterUtils; +import org.apache.jorphan.util.StringUtilities; + +/** + * Renders an {@link HTTPSampleResult} as a ready-to-run {@code curl} command, + * the reverse of what {@link BasicCurlParser} does. + * + * <p>The generated command targets a POSIX-compatible shell: arguments are + * single-quoted and lines are continued with a trailing backslash. It is not + * valid {@code cmd.exe} or PowerShell syntax.</p> + * + * <p>The class has no Swing dependency so it can be reused outside the + * View Results Tree (for example by a future "Copy as cURL" sampler action).</p> + */ +public final class CurlCommandFormatter { + + /** Backslash line continuation followed by indentation, for a POSIX shell. */ + private static final String NEWLINE = " \\\n "; //$NON-NLS-1$ + + private static final String ACCEPT_ENCODING = "Accept-Encoding"; //$NON-NLS-1$ + + private static final String BOUNDARY = "boundary="; //$NON-NLS-1$ + + /** {@code HTTPArgument} defaults a part's content type to this; see HTTPArgumentSchema. */ + private static final String DEFAULT_FIELD_CONTENT_TYPE = "text/plain"; //$NON-NLS-1$ + + /** + * Headers that must not be reproduced in the curl command: curl generates + * them itself, they are connection-specific (hop-by-hop) headers that are + * forbidden in HTTP/2 and would make the request fail with a protocol + * error, or they are pseudo-headers JMeter adds only for reporting and that + * never went on the wire (X-LocalAddress). + */ + private static final Set<String> SKIPPED_HEADERS = Set.of( + "content-length", //$NON-NLS-1$ + "connection", //$NON-NLS-1$ + "keep-alive", //$NON-NLS-1$ + "proxy-connection", //$NON-NLS-1$ + "transfer-encoding", //$NON-NLS-1$ + "upgrade", //$NON-NLS-1$ + HTTPConstants.HEADER_LOCAL_ADDRESS.toLowerCase(Locale.ROOT)); + + /** + * Markers JMeter writes into the rendered request body in place of content + * it did not keep (a file sent as the body, or a non-repeatable entity). + * When present, the body is not the real wire body and cannot be reproduced. + * + * @see org.apache.jmeter.protocol.http.sampler.PostWriter + */ + private static final String[] BODY_PLACEHOLDERS = { + PostWriter.FILE_CONTENT_PLACEHOLDER, + PostWriter.NON_REPEATABLE_ENTITY_PLACEHOLDER + }; + + private CurlCommandFormatter() { + } + + /** + * Build a {@code curl} command line that reproduces the given HTTP request. + * + * @param sampleResult the sampled HTTP request + * @return the curl command as a string + */ + public static String format(HTTPSampleResult sampleResult) { + StringBuilder sb = new StringBuilder(256); + sb.append("curl"); //$NON-NLS-1$ + + String method = sampleResult.getHTTPMethod(); + boolean isHead = HTTPConstants.HEAD.equalsIgnoreCase(method); + boolean isGet = StringUtilities.isBlank(method) || HTTPConstants.GET.equalsIgnoreCase(method); + + // Split by line (not via JMeterUtils.parseHeaders) so repeated header + // names such as several Accept values are all preserved. + List<String[]> headers = new ArrayList<>(); + String contentType = null; + boolean acceptsEncoding = false; + String requestHeaders = sampleResult.getRequestHeaders(); + if (StringUtilities.isNotEmpty(requestHeaders)) { + for (String header : requestHeaders.split("\n")) { //$NON-NLS-1$ + int colon = header.indexOf(':'); + if (colon <= 0) { + continue; + } + String name = header.substring(0, colon).trim(); + String value = header.substring(colon + 1).trim(); + String lower = name.toLowerCase(Locale.ROOT); + if (SKIPPED_HEADERS.contains(lower)) { + continue; + } + if (HTTPConstants.HEADER_CONTENT_TYPE.equalsIgnoreCase(name)) { + contentType = value; + } + if (ACCEPT_ENCODING.equalsIgnoreCase(name)) { + acceptsEncoding = true; + } + headers.add(new String[] { name, value }); + } + } + + String body = isHead ? "" : sampleResult.getQueryString(); //$NON-NLS-1$ + boolean hasBody = StringUtilities.isNotEmpty(body); + boolean isMultipart = contentType != null + && contentType.toLowerCase(Locale.ROOT).startsWith(HTTPConstants.MULTIPART_FORM_DATA); + // Multipart bodies are rebuilt as -F flags; curl then sets its own + // Content-Type (with its own boundary), so the original one is dropped. + List<String[]> formParts = hasBody && isMultipart ? parseMultipartForm(contentType, body) : List.of(); + boolean emitsForm = !formParts.isEmpty(); + boolean emitsDataRaw = hasBody && !isMultipart && !containsPlaceholder(body); + + // Method: --head for HEAD (plain "-X HEAD" makes curl wait for a body it + // never gets); no -X for a plain GET; -X GET only when a GET carries a + // raw body, otherwise curl would switch it to POST; -X for everything else. + if (isHead) { + sb.append(" --head"); //$NON-NLS-1$ + } else if (!isGet) { + sb.append(" -X ").append(quote(method)); //$NON-NLS-1$ + } else if (emitsDataRaw) { + sb.append(" -X ").append(quote(HTTPConstants.GET)); //$NON-NLS-1$ + } + + URL url = sampleResult.getURL(); + if (url != null) { + sb.append(NEWLINE).append(quote(url.toString())); + } + + boolean hasCookieHeader = false; + for (String[] header : headers) { + if (emitsForm && HTTPConstants.HEADER_CONTENT_TYPE.equalsIgnoreCase(header[0])) { + continue; + } + if (HTTPConstants.HEADER_COOKIE.equalsIgnoreCase(header[0])) { + hasCookieHeader = true; + } + sb.append(NEWLINE).append("-H ").append(quote(header[0] + ": " + header[1])); //$NON-NLS-1$ //$NON-NLS-2$ + } + + // HttpClient disables automatic decompression, so Accept-Encoding is only present + // when explicitly set. --compressed makes curl decode the response; it is kept + // alongside the explicit header rather than replacing it, because curl otherwise + // negotiates its own build-dependent encoding list the test plan never asked for. + if (acceptsEncoding) { + sb.append(NEWLINE).append("--compressed"); //$NON-NLS-1$ + } + + // Cookies normally arrive through getCookies(), but AjpSampler can also leave a + // Cookie header in the list; curl lets the header win and silently drops -b, so + // only add -b when no Cookie header was emitted. + String cookies = sampleResult.getCookies(); + if (!hasCookieHeader && StringUtilities.isNotEmpty(cookies)) { + sb.append(NEWLINE).append("-b ").append(quote(cookies)); //$NON-NLS-1$ + } + + if (emitsForm) { + for (String[] part : formParts) { + sb.append(NEWLINE).append(part[0]).append(' ').append(quote(part[1])); + } + } else if (emitsDataRaw) { + sb.append(NEWLINE).append("--data-raw ").append(quote(body)); //$NON-NLS-1$ + } else if (hasBody) { + // A file sent as the body or a non-repeatable entity: the bytes were + // not kept, so emitting them would produce a silently-wrong command. + sb.append('\n').append("# ") //$NON-NLS-1$ + .append(JMeterUtils.getResString("view_results_table_request_tab_curl_body_omitted")); //$NON-NLS-1$ + } + + return sb.toString(); + } + + /** + * Rebuild the {@code -F} form parts of a multipart request from its rendered + * body. Regular fields become {@code name=value}; file parts become + * {@code name=@filename;type=...}. JMeter does not keep the uploaded bytes, + * so the file name is only a placeholder the user edits to a real path + * before running the command. + * + * @return the form parts, or an empty list if the body cannot be parsed + */ + private static List<String[]> parseMultipartForm(String contentType, String body) { + String boundary = extractBoundary(contentType); + // A quoted boundary is unquoted above; but if the header boundary and the body + // disagree, MultipartUrlConfig would treat the whole body as one field and emit + // garbage, so require the delimiter to be present and fall back to the note otherwise. + if (StringUtilities.isBlank(boundary) || !body.contains("--" + boundary)) { //$NON-NLS-1$ + return List.of(); + } + MultipartUrlConfig multipart = new MultipartUrlConfig(boundary); + try { + multipart.parseArguments(body); + } catch (RuntimeException e) { // NOSONAR malformed body: fall back to the omitted-body note + return List.of(); + } + List<String[]> parts = new ArrayList<>(); + for (JMeterProperty property : multipart.getArguments()) { + parts.add(formField((HTTPArgument) property.getObjectValue())); + } + for (HTTPFileArg file : multipart.getHTTPFileArgs().asArray()) { + parts.add(fileField(file)); + } + return parts; + } + + /** + * A multipart text field. {@code --form-string} keeps the value verbatim (curl would + * otherwise read a leading {@code @} or {@code <} as a file reference), but it cannot + * carry a per-part content type; {@code -F} can, so it is used when the value is safe + * for it (no {@code @}/{@code <} prefix and no {@code ;} that curl would read as an + * option separator). + */ + private static String[] formField(HTTPArgument argument) { + String value = argument.getValue() == null ? "" : argument.getValue(); //$NON-NLS-1$ + String type = argument.getContentType(); + // HTTPArgument defaults content_type to text/plain, which is indistinguishable from + // a part that carried none; only a non-default type is worth reproducing. + boolean hasType = StringUtilities.isNotEmpty(type) && !DEFAULT_FIELD_CONTENT_TYPE.equalsIgnoreCase(type); + boolean safeForF = hasType + && !value.startsWith("@") && !value.startsWith("<") && value.indexOf(';') < 0; //$NON-NLS-1$ //$NON-NLS-2$ + if (safeForF) { + return new String[] { "-F", argument.getName() + "=" + value + ";type=" + type }; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ + } + return new String[] { "--form-string", argument.getName() + "=" + value }; //$NON-NLS-1$ //$NON-NLS-2$ + } + + /** + * A multipart file part. The file name is double-quoted inside the spec so that a name + * containing {@code ;} or {@code ,} is not parsed by curl as an option separator; the + * bytes are not kept by JMeter, so the name is a placeholder to edit to a real path. + */ + private static String[] fileField(HTTPFileArg file) { + StringBuilder spec = new StringBuilder(); + spec.append(file.getParamName()).append("=@\"").append(file.getPath()).append('"'); //$NON-NLS-1$ + if (StringUtilities.isNotEmpty(file.getMimeType())) { + spec.append(";type=").append(file.getMimeType()); //$NON-NLS-1$ + } + return new String[] { "-F", spec.toString() }; //$NON-NLS-1$ + } Review Comment: **The double-quoted path is not readable by `BasicCurlParser`, so the command no longer round-trips.** This closes the curl side of the `;`/`,` problem — I verified curl accepts `-F 'up=@"a;b,c.txt";type=text/plain'`. But this class documents itself as "the reverse of what `BasicCurlParser` does", and the parser cannot read the form it now emits. `BasicCurlParser#729` takes everything after `@` and hands it to `unquote`, which assumes a value starting with `"` also *ends* with `"` (`BasicCurlParser#982`: `value.substring(1, value.length() - 1)`). With a `;type=` suffix after the closing quote it strips the wrong last character, and `ArgumentHolder.parse` then splits what is left. Fed the output of this branch: ``` -F 'upload=@"report.pdf";type=application/pdf' → FileArgumentHolder(report.pdf", {type=application/pd}) ``` A stray quote on the name, and the last character of the MIME type eaten. For the name this quoting was introduced to protect it is worse — `a;b,c.txt` leaves the segment `b,c.txt"` with no `=` in it, and `ArgumentHolder#47-48` reads `typeParts[1]` unconditionally, so the import throws `ArrayIndexOutOfBoundsException`. Two shapes still work, which is why nothing failed: a quoted path with no `;type=` suffix, and any `-F` whose value does not start with `@` (the typed text fields go down that branch and round-trip cleanly). The fix belongs in the parser rather than here: split the `;` options off before unquoting, so `@"name";type=x` reads the way curl reads it. That keeps both directions honest and is in scope given the PR already touches `RequestViewHTTP` and `PostWriter`. Quoting only when the path actually contains `;` or `,` would restore the common case but leave the rare one broken in both tools. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
