fix: exclude XML document header when saving events via StaX driver

Author: vlsi

bin/testfiles/BUG_62847.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <testResults version="1.2">
-<sample s="true" lb="SuccessLoop" rc="200" rm="OK" tn="TG 1-1"/>
-<sample s="true" lb="DS_after_loop" rc="200" rm="OK" tn="TG 1-1"/>
-<sample s="true" lb="SuccessWhile" rc="200" rm="OK" tn="TG 2-1"/>
-<sample s="true" lb="DS_after_while" rc="200" rm="OK" tn="TG 2-1"/>
-<sample s="true" lb="Success_FEC" rc="200" rm="OK" tn="TG 3-1"/>
-<sample s="true" lb="DS_after_fec" rc="200" rm="OK" tn="TG 3-1"/>
+<sample s="true" lb="SuccessLoop" rc="200" rm="OK" tn="TG 1-1"></sample>
+<sample s="true" lb="DS_after_loop" rc="200" rm="OK" tn="TG 1-1"></sample>
+<sample s="true" lb="SuccessWhile" rc="200" rm="OK" tn="TG 2-1"></sample>
+<sample s="true" lb="DS_after_while" rc="200" rm="OK" tn="TG 2-1"></sample>
+<sample s="true" lb="Success_FEC" rc="200" rm="OK" tn="TG 3-1"></sample>
+<sample s="true" lb="DS_after_fec" rc="200" rm="OK" tn="TG 3-1"></sample>
 
 </testResults>

src/core/src/main/java/org/apache/jmeter/save/SaveService.java

@@ -58,7 +58,6 @@
 import com.thoughtworks.xstream.converters.reflection.ReflectionProvider;
 import com.thoughtworks.xstream.io.HierarchicalStreamDriver;
 import com.thoughtworks.xstream.io.xml.StaxDriver;
-import com.thoughtworks.xstream.io.xml.XppDriver;
 import com.thoughtworks.xstream.mapper.CannotResolveClassException;
 import com.thoughtworks.xstream.mapper.Mapper;
 import com.thoughtworks.xstream.mapper.MapperWrapper;
@@ -114,6 +113,7 @@ public String serializedClass(@SuppressWarnings("rawtypes") // superclass does n
 
     private static final XStream JMXSAVER = new XStreamWrapper(new PureJavaReflectionProvider(), new StaxDriver());
     private static final XStream JTLSAVER = new XStreamWrapper(new PureJavaReflectionProvider(), new StaxDriver());
+    private static final StaxDriverSkipHeader STAXDRIVER_SKIP_HEADER = new StaxDriverSkipHeader();
     static {
         JTLSAVER.setMode(XStream.NO_REFERENCES); // This is needed to stop XStream keeping copies of each class
         JMeterUtils.setupXStreamSecurityPolicy(JMXSAVER);
@@ -346,7 +346,7 @@ public static synchronized void saveSampleResult(SampleEvent evt, Writer writer)
         // This is effectively the same as saver.toXML(Object, Writer) except we get to provide the DataHolder
         // Don't know why there is no method for this in the XStream class
         try {
-            JTLSAVER.marshal(evt.getResult(), new XppDriver().createWriter(writer), dh);
+            JTLSAVER.marshal(evt.getResult(), STAXDRIVER_SKIP_HEADER.createWriter(writer), dh);
         } catch(RuntimeException e) {
             throw new IllegalArgumentException("Failed marshalling:"+(evt.getResult() != null ? showDebuggingInfo(evt.getResult()) : "null"), e);
         }
@@ -413,7 +413,7 @@ public static void loadTestResults(InputStream reader, ResultCollectorHelper res
         dh.put(RESULTCOLLECTOR_HELPER_OBJECT, resultCollectorHelper); // Allow TestResultWrapper to feed back the samples
         // This is effectively the same as saver.fromXML(InputStream) except we get to provide the DataHolder
         // Don't know why there is no method for this in the XStream class
-        JTLSAVER.unmarshal(new XppDriver().createReader(reader), null, dh);
+        JTLSAVER.unmarshal(STAXDRIVER_SKIP_HEADER.createReader(reader), null, dh);
         inputStreamReader.close();
     }
 

src/core/src/main/kotlin/org/apache/jmeter/save/StaxDriverSkipHeader.kt

@@ -0,0 +1,27 @@
+/*
+ * 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.save
+
+import com.thoughtworks.xstream.io.xml.StaxDriver
+import javax.xml.stream.XMLOutputFactory
+
+public class StaxDriverSkipHeader : StaxDriver() {
+    override fun createOutputFactory(): XMLOutputFactory {
+        return XMLOutputFactoryDelegate(super.createOutputFactory())
+    }
+}

src/core/src/main/kotlin/org/apache/jmeter/save/XMLOutputFactoryDelegate.kt

@@ -0,0 +1,77 @@
+/*
+ * 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.save
+
+import java.io.OutputStream
+import java.io.Writer
+import javax.xml.stream.XMLEventWriter
+import javax.xml.stream.XMLOutputFactory
+import javax.xml.stream.XMLStreamWriter
+import javax.xml.transform.Result
+
+public class XMLOutputFactoryDelegate(private val delegate: XMLOutputFactory) : XMLOutputFactory() {
+    override fun createXMLStreamWriter(stream: Writer): XMLStreamWriter {
+        return XMLStreamWriterSkipHeader(delegate.createXMLStreamWriter(stream))
+    }
+
+    override fun createXMLStreamWriter(stream: OutputStream): XMLStreamWriter {
+        return XMLStreamWriterSkipHeader(delegate.createXMLStreamWriter(stream))
+    }
+
+    override fun createXMLStreamWriter(
+        stream: OutputStream,
+        encoding: String?
+    ): XMLStreamWriter {
+        return XMLStreamWriterSkipHeader(delegate.createXMLStreamWriter(stream, encoding))
+    }
+
+    override fun createXMLStreamWriter(result: Result): XMLStreamWriter {
+        return XMLStreamWriterSkipHeader(delegate.createXMLStreamWriter(result))
+    }
+
+    override fun createXMLEventWriter(result: Result): XMLEventWriter {
+        return delegate.createXMLEventWriter(result)
+    }
+
+    override fun createXMLEventWriter(stream: OutputStream): XMLEventWriter {
+        return delegate.createXMLEventWriter(stream)
+    }
+
+    override fun createXMLEventWriter(
+        stream: OutputStream,
+        encoding: String?
+    ): XMLEventWriter {
+        return delegate.createXMLEventWriter(stream, encoding)
+    }
+
+    override fun createXMLEventWriter(stream: Writer): XMLEventWriter {
+        return delegate.createXMLEventWriter(stream)
+    }
+
+    override fun setProperty(name: String, value: Any?) {
+        return delegate.setProperty(name, value)
+    }
+
+    override fun getProperty(name: String): Any {
+        return delegate.getProperty(name)
+    }
+
+    override fun isPropertySupported(name: String): Boolean {
+        return delegate.isPropertySupported(name)
+    }
+}

src/core/src/main/kotlin/org/apache/jmeter/save/XMLStreamWriterSkipHeader.kt

@@ -0,0 +1,31 @@
+/*
+ * 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.save
+
+import javax.xml.stream.XMLStreamWriter
+
+public class XMLStreamWriterSkipHeader(private val delegate: XMLStreamWriter) : XMLStreamWriter by delegate {
+    override fun writeStartDocument() {
+    }
+
+    override fun writeStartDocument(version: String?) {
+    }
+
+    override fun writeStartDocument(encoding: String?, version: String?) {
+    }
+}

src/dist/src/dist/expected_release_jars.csv

@@ -109,7 +109,6 @@
 519087,mail-1.5.0-b01.jar
 120438,miglayout-core-11.4.2.jar
 23287,miglayout-swing-11.4.2.jar
-29680,mxparser-1.2.2.jar
 99796,neo4j-bolt-connection-10.1.0.jar
 320489,neo4j-bolt-connection-netty-10.1.0.jar
 27442,neo4j-bolt-connection-pooled-10.1.0.jar
@@ -157,7 +156,6 @@
 220536,xml-apis-1.4.01.jar
 85686,xml-apis-ext-1.3.04.jar
 686441,xmlgraphics-commons-2.11.jar
-7188,xmlpull-1.1.3.1.jar
 1033122,xmlresolver-5.3.3-data.jar
 167889,xmlresolver-5.3.3.jar
 646504,xstream-1.4.21.jar