/har-to-jmeter-convertor

Convert a HAR file to JMX script file and record XML

Primary LanguageJava

har to jmeter convertor tool logo

Convert a HAR file to a JMeter script and a Record XML file.

Link to github project har-to-jmeter-convertor

har-to-jmeter-convertor

Convert a HAR file to a JMeter script and a Record XML file.

An article about motivations to create this tool: https://dzone.com/articles/convert-a-har-file-to-jmeter-script

Creating a har file and run the tool har-to-jmx-convertor to simulate recording from the JMeter recording template

This tool har-to-jmx-convertor try to simulate a script JMeter and a record xml file recording from the JMeter recording template.

JMeter recording template and HTTP(S) Test Script Recorder - The standard way to record

The JMeter recording template :
JMeter recording template start

The result of recording with JMeter "HTTP(S) Test Script Recorder" :
JMeter script and record

HAR created on a Browser (e.g. Firefox) - The new way with the convertor tool

Record the navigation in the web application with Developper tool : Network and save exchanges in HAR file format :
Browser save HAR file

Launch the "Convertor tool" :
Step to create script and record from HAR file

Tool results : Open the script created and the record.xml in a View Results Tree
Open the script created

HAR created in Chrome Browser with the LoadRunner Web Recorder Chrome Extension

This tool is compatible with Har file generated with the LoadRunner Web Recorder Chrome Extension.

The main advantage is to declare Transaction Names when recording and navigate to the web site. This transactions will be Page Names (Transaction Controllers names) in the JMeter script.

Step to create script and record from HAR file from LoadRunner Web Recorder

The LoadRunner Web Recorder Chrome Extension is available at this url :
Download the Recorder extension for Chrome : "HarGeneratorChrome"

You need to add the parameter and value : -use_lrwr_infos transaction_name to indicate that is a HAR file generated with LoadRunner Web Recorder (lrwr).

Standard HAR file created with Firefox, Chrome, Edge with external csv file for transaction information

You could add an external file that contains information about transaction name start and end.

Step to create script and record from HAR file and external csv file

The CSV format is :

  • Timestamp iso format GMT;TRANSACTION;transaction name;start for starting a new transaction
  • Timestamp iso format GMT;TRANSACTION;transaction name;stop for ending transaction the precedent transaction
  • Separator ";"
  • Charset UTF-8

E.g :

2024-05-06T12:39:58.711Z;TRANSACTION;login;start
2024-05-06T12:40:08.643Z;TRANSACTION;login;stop
2024-05-06T12:40:20.880Z;TRANSACTION;home;start
2024-05-06T12:40:37.634Z;TRANSACTION;home;stop

A simple tool named "create-external-file-for-har" create easily this csv file. https://github.com/vdaburon/create-external-file-for-har

You need to add the parameter and value : -external_file_infos c:/Temp/jpetstore.csv to set the csv file to read

HAR created with BrowserMob Proxy

This tool is compatible with Har file generated with BrowserMob Proxy.

The BrowserMob Proxy create a har and could filter url or content (no binary).

The proxy client could be a browser or a client http in an application.

BrowserMob Proxy could be embedded in a java application or in Selenium java code application.

Step to create script and record from HAR file from BrowserMob

The BrowserMob Proxy is available at this url :
Download the BrowserMob Proxy

Parameters

Parameters are :

  • har_in the HAR file to read (exported HAR from Web Browser : Chrome, Firefox, Edge ...)
  • jmx_out the file JMeter script generated
  • record_out create the record xml file from the har file (could be open with the Listener View Results Tree)
    e.g. record_out = record.xml
  • add_result_tree_record, add a View Result Tree to view the Recording XML File Generated (default true), the record_out must be not empty
  • filter_include, the regular expression matches the URL to Include (first filter)
  • filter_exclude, the regular expression matches the URL to Exclude (second filter)
    • default all = empty (no filter)
    • e.g. filter_exclude=https://notmysite.com/.*
    • or filter statics, filter_exclude=(?i).*.(bmp|css|js|gif|ico|jpe?g|png|swf|eot|otf|ttf|mp4|woff|woff2|svg)
  • add_pause boolean, use with parameter new_tc_pause (default true), add Flow Control Action Pause
  • new_tc_pause time between 2 urls to create a new page (Transaction Controller)
    • e.g. 5000 for 5 sec between 2 urls
  • remove_cookie, remove header with cookie because use a Cookie Manager (default true)
  • remove_cache_request, remove request cache header because use a Cache Manager (default true)
  • page_start_number, set the start page number for partial recording (default 1, must be an integer > 0)
  • sampler_start_number, set the start sampler number for partial recording (default 1, must be an integer > 0)
  • use_lrwr_infos, the har file has been generated with LoadRunner Web Recorder Chrome extension and contains Transaction Name, expected values : 'transaction_name' or don't add this parameter
  • external_file_infos, external csv file contains information about Timestamp, Transaction Name, date start or end.

Command line tool (CLI)

This tool could be use with script shell Windows or Linux.

Help to see all parameters :

C:\apache-jmeter\bin>java -jar har-to-jmeter-convertor-6.0-jar-with-dependencies.jar -help

INFOS: Start main
usage: io.github.vdaburon.jmeter.har.HarForJMeter [-add_pause <add_pause>] [-add_result_tree_record
       <add_result_tree_record>] [-external_file_infos <external_file_infos>] [-filter_exclude <filter_exclude>]
       [-filter_include <filter_include>] -har_in <har_in> [-help] -jmx_out <jmx_out> [-new_tc_pause <new_tc_pause>]
       [-page_start_number <page_start_number>] [-record_out <record_out>] [-remove_cache_request
       <remove_cache_request>] [-remove_cookie <remove_cookie>] [-sampler_start_number <sampler_start_number>]
       [-use_lrwr_infos <use_lrwr_infos>]
io.github.vdaburon.jmeter.har.HarForJMeter
 -add_pause <add_pause>                             Optional boolean, add Flow Control Action Pause after Transaction
                                                    Controller (default true)
 -add_result_tree_record <add_result_tree_record>   Optional boolean, add 'View Result Tree' to view the record.xml file
                                                    created (default true), record_out must be not empty
 -external_file_infos <external_file_infos>         Optional, csv file contains external infos : timestamp transaction
                                                    name and start or end
 -filter_exclude <filter_exclude>                   Optional, regular expression to exclude url
 -filter_include <filter_include>                   Optional, regular expression to include url
 -har_in <har_in>                                   Har file to read (e.g : my_file.har)
 -help                                              Help and show parameters
 -jmx_out <jmx_out>                                 JMeter file created to write (e.g : script.jmx)
 -new_tc_pause <new_tc_pause>                       Optional, create new Transaction Controller after request ms, same
                                                    as jmeter property : proxy.pause, need to be > 0 if set. Usefully
                                                    for Har created by Firefox or Single Page Application (Angular,
                                                    ReactJS, VuesJS ...)
 -page_start_number <page_start_number>             Optional, the start page number for partial recording (default 1)
 -record_out <record_out>                           Optional, file xml contains exchanges likes recorded by JMeter
 -remove_cache_request <remove_cache_request>       Optional boolean, remove cache header in the http request (default
                                                    true because add a Cache Manager)
 -remove_cookie <remove_cookie>                     Optional boolean, remove cookie in http header (default true because
                                                    add a Cookie Manager)
 -sampler_start_number <sampler_start_number>       Optional, the start sampler number for partial recording (default 1)
 -use_lrwr_infos <use_lrwr_infos>                   Optional, the har file has been generated with LoadRunner Web
                                                    Recorder and contains Transaction Name, expected value :
                                                    'transaction_name' or don't add this parameter
E.g : java -jar har-for-jmeter-<version>-jar-with-dependencies.jar -har_in myhar.har -jmx_out scriptout.jmx -record_out
recording.xml -add_result_tree_record true -new_tc_pause 5000 -add_pause true -filter_include "https://mysite/.*"
-filter_exclude "https://notmysite/*" -page_start_number 50 -sampler_start_number 250

C:\apache-jmeter\bin>java -jar har-to-jmeter-convertor-6.0-jar-with-dependencies.jar -har_in "myhar.har" -jmx_out "script_out.jmx" -filter_include "https://mysite.com/.*" -filter_exclude "https://notmysite.com/.*" -add_pause true -new_tc_pause 5000
/var/opt/apache-jmeter/bin>java -jar har-to-jmeter-convertor-6.0-jar-with-dependencies.jar -har_in "myhar.har" -jmx_out "script_out.jmx" -record_out "record.xml" -add_pause true -new_tc_pause 5000

Usage Maven

The maven groupId, artifactId and version, this plugin is in the Maven Central Repository Maven Central har-convertor-jmeter-plugin

<groupId>io.github.vdaburon</groupId>
<artifactId>har-to-jmeter-convertor</artifactId>
<version>6.0</version>

License

Licensed under the Apache License, Version 2.0

Versions

Version 6.0 date 2024-09-19, add 'HTTP(S) Test Script Recorder' and 'View Results Tree' to view the Record.xml file created. Correct save file no url encoded name.

Version 5.3 date 2024-09-13, correct PUT with no parameter, no content and mime-type == null

Version 5.2 date 2024-06-20, correct extract parameters for mime type "form-urlencoded" ended with charset likes "application/x-www-form-urlencoded; charset=xxx"

Version 5.1 date 2024-05-15, compatible with har generated by browsermob-proxy tool (https://github.com/lightbody/browsermob-proxy) and csv external_file_infos contains transaction infos.

Version 5.0 date 2024-05-10, add an external csv file with transaction information for JMeter Transaction Controller Name. New parameter : -external_file_infos transaction_infos.csv. Correct Filter Include first filter and Filter Exclude second filter.

Version 4.0 date 2024-05-06, could read har file generated with the LoadRunner Web Recorder Chrome Extension that contains transaction name for JMeter Transaction Controller Name. New parameter -use_lrwr_infos transaction_name

Version 2.3 date 2024-03-30, encode value for x-www-form-urlencoded when value contains space ' ' or equal '=' or slash '/' or plus '+' characters. Correct add the content for body data for POST, PUT or PATCH if not x-www-form-urlencoded in the Record.xml file.

Version 2.2 date 2024-03-29, remove the header 'Content-length' because the length is computed by JMeter when the request is created. POST or PUT could have query string and body with content so add query string to the path. Set Content Encoding to UFT-8 for POST or PUT method and request Content-Type : application/json. Add body data content in Record.xml for PUT and PATCH methods.

Version 2.1 date 2024-03-13, change the version in the code and the comment for the test plan. Use the extension to find is response is text or bin.

Version 2.0 date 2024-03-12, for POST multipart/form-data don't put the content of the file in the Record.xml file because binary content could be large and not XML compatible, add parameters : page_start_number and sampler_start_number to facilitate partial recording of website navigation.

Version 1.0 date 2024-03-11, First Release.