Custom load tests allow the greatest degree of freedom and flexibility on our platform.\u00a0 Some things that are shared between any of our supported language-specific load tests are:<\/p>\n
Each language is documented independently and can be found on the corresponding page using the links below:<\/p>\n
There are several factors which will drive your decision on which supported language to use for your custom load test (e.g.<\/em>, PHP, NodeJS, or Python).\u00a0 One of the primary reasons you may choose to write a custom load test in the first place is to have ultimate control and flexibility over your test.\u00a0 You can achieve this with any of the supported languages.\u00a0 However, no matter which one you select the next factor would be your relative familiarity with each of these languages.\u00a0 In this post we will focus on writing a custom NodeJS test, but the concepts on our platform will generally carry over into the other supported languages.<\/p>\n Each Language supports a packaging mechanism to install more packages.\u00a0 For NodeJS, NPM<\/a> is built into the test, so you just need to include your own <\/span> Using the Node Version Manger (NVM<\/a>), our Node Version Manager Plugin<\/a> supports all version of NodeJS.<\/p>\n A Test Harness is available for all languages, including examples for the NodeJS Harness<\/a>.\u00a0 If you are writing a custom test in a different language (such as PHP or Python), you will want to select the appropriate test harness as described above.<\/p>\n To write a custom load test in Node.js, you need to create a Node.js file named You can\u00a0include the helper class You will need to define a function constructor with the arguments \u00a0 An explanation of the corresponding constructor arguments above are as follows:<\/p>\n The test does not start when the constructor is called. \u00a0However, here we can setup variables for this instance of the test and read configuration. \u00a0Here is an example which accomplishes this:<\/p>\n As such, the test starts when Inside your test, it’s all your code and work. \u00a0You can use the This file should export a class using An instance of this class will be started for each user specified in the \u201cNumber of User<\/em>\u201d form field. To save CPU usage on the load agents, each Node.js process will run multiple tests (i.e.<\/em>, will instantiate multiple instances of your class).\u00a0 This is important if you are using any global variables as they could be shared, best to keep things at the scope of the instance.<\/p>\n A test can be just uploaded for quick testing, however you should create a The RedLine13 API<\/a> contains the following methods:<\/p>\n You may wish to use the included You can find an example CustomTestSimple.js<\/a>, which performs a Simple URL test with echo.<\/p>\n","protected":false},"excerpt":{"rendered":"Submitting\u00a0Performance Tests<\/h3>\n
\n
\n
[ANY_NAME].js<\/code>) in the language specified.<\/li>\n.tar<\/code>, tar.gz<\/code>, or .tgz<\/code>) with the custom file specifically named.\u00a0 For NodeJS<\/a> tests this is “CustomTest.js<\/code>“.<\/li>\n<\/ul>\n<\/li>\n\n
Package Support in Load Tests<\/h3>\n
package.json<\/code>\u00a0and we will run <\/span>npm install<\/code>.<\/span><\/p>\nVersioning<\/h3>\n
Test Harness for local testing<\/h3>\n
NodeJS\u00a0Test<\/h2>\n
CustomTest.js<\/code>\u00a0if packaged in compressed file, otherwise it can be any name.<\/p>\nloadTestingSession<\/code> for testing HTTP requests. \u00a0This class helps to manage cookies and track performance data.\u00a0 The following code snippet illustrates how to add this:<\/p>\nvar LoadTestingSession = require(\".\/loadTestingSession.js\");<\/pre>\n
(redlineApi, testNum, rand, config)<\/code>.\u00a0 Here is an example constructor definition:<\/p>\n\/**\n * Build a custom test by creating a constructor\n * @param redlineAPI - redline metric calls\n * @param testNum - when simulating many users, this is the user number\n * @param rand - a test identifier, same across all users within test\n * @param config - hashmap for your config variables passed through\n *\/\nfunction MyCustomTest(redlineApi, testNum, rand, config)\n{\n ...\n}<\/pre>\n\n
redlineApi<\/code> \u2013 This variable will let you access Redline API methods to report back data.<\/li>\ntestNum<\/code> \u2013 This is the test number that is being run.<\/li>\nrand<\/code> \u2013 This is a random string associated with the test that typically is unused.<\/li>\nconfig<\/code> \u2013 This is the parsed result of ini.parse<\/code><\/a>. config.load_resources<\/code> will be set to \"1\"<\/code> if you enabled the associated setting when starting the test.<\/li>\n<\/ul>\nfunction MyCustomTest(redlineApi, testNum, rand, config)\n{\n \/\/ We need Redline API to report results, errors, requests.\n this.redlineApi = redlineApi;\n\n \/\/ Keep track of test information.\n this.testNum = testNum;\n this.rand = rand;\n\n \/\/ This is the test configuration file (loadtest.ini)\n this.config = config;\n\n \/\/ Hardcode endpoint, requires plugin to customize.\n this.url = this.config.url;\n if ( !this.url )\n this.url = \"https:\/\/httpbin.org\/status\/200\";\n\n \/\/ This is just example, you might need build a redline plugin to add these parameters.\n this.minDelayMs = this.config.min | 500;\n this.maxDelayMs = this.config.max | 10000;\n}<\/pre>\nrunTest<\/code> is called on the class. \u00a0This method accepts a callback function that expects a single parameter that is true<\/code> if the test failed and false<\/code> otherwise.\u00a0 The callback can be called using callback.call(that, failed);<\/code>.\u00a0 Here is an example of that:<\/p>\n\/** \n * Run test \n * @param redlineCallback as tests are asynch callback is used to tell runner that test is complete (success or failure) \n *\/\nMyCustomTest.prototype.runTest = function( redlineCallback )\n{\n ...\n}<\/pre>\nredlineApi<\/code> class to tell RedLine13 the performance data to track:<\/p>\nMyCustomTest.prototype.runTest = function( redlineCallback )\n{\n var that = this;\n\n \/\/ Set delay\n var delay = 1;\n if (this.delayRangeMs != 0)\n delay = Math.floor((Math.random()*this.delayRangeMs)+this.minDelayMs);\n \/\/ delay = 1;\n\n \/\/ Make request after timeout\n console.log(\"Making request to \" + that.url + \" in \" + delay + \"ms.\");\n setTimeout(function() {\n try\n {\n \/\/ Helper function make HTTP Request., source @ https:\/\/github.com\/redline13\/harness-custom-test-nodejs\/blob\/master\/CustomTestSimple.js#L78\n that.loadPage(that.url, function( failed ) {\n \/\/ Iteration complete\n that.remainingIterations--;\n\n \/\/ Another iteration?\n if (!failed && that.remainingIterations > 0)\n that.runTest(redlineCallback);\n else\n \/\/ Callback\n redlineCallback(failed, 'on-load-page' );\n });\n } catch (e) {\n \/\/ Callback\n console.log(e);\n that.redlineApi.recordError(\"\"+e + (e.stack ? \"\\n\" + e.stack : \"\"));\n redlineCallback(true, 'on-exception' );\n }\n }, delay);\n};<\/pre>\nmodule.exports = YourCustomTestClassName;<\/code>.<\/p>\n\/\/ Required Export for Test to be loaded and executed.\nmodule.exports = MyCustomTest;\n<\/pre>\n
Packaging your test<\/h3>\n
.tar<\/code> or .tgz<\/code> file that contains CustomTest.js<\/code> and optionally package.json<\/code> in the root directory.\u00a0 This is the file that should be uploaded to start the test.\u00a0 The package.json<\/code> file will be used prior to the test with npm install package.json<\/code> to install any extra libraries you may need.\u00a0 You can also include other helper classes in the tar file.<\/p>\nRecording methods\u00a0available<\/h3>\n
\n
redlineApi.recordPageTime(ts, time)<\/code> – This records and aggregates the total page load time for a request, with ts<\/code> being the UNIX timestamp when the request started and time<\/code> being the time to complete the request. This function is used in the UI to report the overall average response time. The goToUrl<\/code> method of LoadTestingSession<\/code> calls this for you.<\/li>\nredlineApi.recordURLPageLoad(url, ts, time, err, kb, rc, user)<\/code> – This records and aggregates the total page load time for a request to a specific URL, with ts<\/code> being the UNIX timestamp when the request started and time<\/code> being the time to complete the request.\u00a0 You can also pass in err<\/code> to record an error and kb<\/code> to record the number of kilobytes downloaded.\u00a0 The response code can be specified using rc<\/code>, and the user identifier can be passed as user<\/code>. \u00a0This function is used in the UI to report the per page average response time but does not affect the overall response time that is calculated.\u00a0 The goToUrl<\/code> and loadResources<\/code> methods ofLoadTestingSession<\/code> calls this for you.<\/li>\nredlineApi.recordDownloadSize(kb)<\/code> – This records the number of kilobytes downloaded for a request. The goToUrl<\/code> and loadResources<\/code> methods of LoadTestingSession<\/code> calls this for you.<\/li>\nredlineApi.recordError(error)<\/code> – This records an error that will be displayed in the UI.<\/li>\nredlineApi.recordProgress(testNum, percent)<\/code> – This records the progress (between 0<\/code> and 100<\/code>) of a single test. This allows you to enable more accurate progress than the default, which is based only on the number completed vs<\/em>. the test size.<\/li>\n<\/ul>\nLoadTestingSession Helper Class<\/h4>\n
LoadTestingSession(testNum, redlineApi, loadResources)<\/code> class.\u00a0 Simply call the constructor and then call loadPage<\/code>, passing in a callback function.\u00a0 The callback will receive a single parameter of true<\/code> if the test failed and false<\/code> otherwise.<\/p>\nTips<\/h3>\n
\n
setTimeout<\/code> call, as shown in the example above.<\/span><\/li>\nCustomTest<\/code> constructor to append to URLs.\u00a0 This can help you to easily identify load testing requests in your server logs.<\/li>\n.tgz<\/code> file) with the resources in the CustomTest<\/code> constructor.\u00a0 You should include code to ensure that only one test per server downloads the files.\u00a0 If you know the number of tests per server, you can use the test number to decide which test should download the files.\u00a0 Alternatively, you can attempt to create a lock file, with the first process successfully creating the lock file doing the file download.<\/li>\n<\/ul>\nComplete Examples<\/h3>\n