{"id":33364,"date":"2016-04-26T15:57:34","date_gmt":"2016-04-26T10:27:34","guid":{"rendered":"http:\/\/www.tothenew.com\/blog\/?p=33364"},"modified":"2016-04-27T10:01:06","modified_gmt":"2016-04-27T04:31:06","slug":"how-to-test-google-apps-script-using-qunit","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/how-to-test-google-apps-script-using-qunit\/","title":{"rendered":"How to test Google Apps Script using Qunit"},"content":{"rendered":"

In my previous blog<\/a>, we learnt how to use Google Apps Script in spreadsheets. Now we will take a look at\u00a0how we can test the code which we have\u00a0written in apps script.\u00a0For this purpose, we’ll use a tool called \u201cQunit<\/strong><\/em>\u201d which helps us in writing and testing our apps script test cases.<\/p>\n

QUnit<\/strong><\/em> is a powerful, easy-to-use, JavaScript unit testing framework. It’s used by the jQuery project to test its code and plugins but is capable of testing any generic JavaScript code.It is made available as a script library for Google Apps Script.<\/p>\n

Key Points QUnit for Google Apps Script :<\/strong><\/p>\n

    \n
  1. Tests are run on Google’s servers, not in your browser. The browser only displays test results.<\/li>\n
  2. Configuration is required by calling QUnit.config(myConfig)<\/code>, where myConfig<\/code> is an object with your configuration settings.<\/li>\n
  3. The Google Apps Script service running the tests needs to implement a doGet(e)<\/code> function that.<\/li>\n<\/ol>\n
      \n
    • Calls QUnit.urlParams(e.parameter)<\/code>, which ensures that QUnit-specific HTTP parameters are handled when you interact with the QUnit GUI;<\/li>\n
    • Optionally, configures QUnit with the Qunit.config()<\/code> function;<\/li>\n
    • Loads tests with QUnit.load(myTests)<\/code>, where myTests<\/code> is a function containing your tests;<\/li>\n
    • Returns the result of Qunit.getHtml();<\/code><\/li>\n
    • Some helper functions can be imported from QUnit to the test suite by calling QUnit.helpers(this).<\/code><\/li>\n<\/ul>\n

      Steps for adding ‘Qunit<\/em>‘ in project :<\/strong><\/p>\n

        \n
      1. Go to script editor.<\/li>\n
      2. Select “Resources” > “Libraries…” in the Google Apps Script editor.<\/li>\n
      3. Enter this project key (MxL38OxqIK-B73jyDTvCe-OBao7QLBR4j) in the “Find a Library” field, and choose “Select”.<\/li>\n
      4. Select version number 4<\/code>, and choose QUnit as the identifier. (Do not turn on Development Mode)<\/li>\n
      5. Press Save.<\/li>\n<\/ol>\n

        \"Add<\/p>\n

        Here is the sample code:<\/strong><\/p>\n

        [js]
        \nfunction calculateAmountAndQty(quantity,amount){
        \n if(typeof (quantity) == ‘undefined’ || quantity == ‘null’ || isNaN(quantity)) {
        \n quantity=0;
        \n }<\/p>\n

        if(typeof (amount) == ‘undefined’ || amount == ‘null’ || isNaN(amount)) {
        \n amount=0;
        \n }<\/p>\n

        return (quantity*amount);
        \n}
        \n[\/js]<\/p>\n

        We’ll be writing test cases for the above code. Open up the scripts editor and paste the code given below and save the script afterwards.<\/p>\n

        [js]
        \n QUnit.helpers( this );
        \n function testFunctions() {
        \n testingCalculateAmountAndQty();
        \n }<\/p>\n

        function doGet( e ) {
        \n QUnit.urlParams( e.parameter );
        \n QUnit.config({
        \n title: "QUnit for Google Apps Script – Test suite" \/\/ Sets the title of the test page.
        \n });
        \n QUnit.load( testFunctions );<\/p>\n

        return QUnit.getHtml();
        \n };<\/p>\n

        function testingCalculateAmountAndQty(){
        \n QUnit.test( "calculateAmountAndQty testing", function() {
        \n expect(7);
        \n equal( calculateAmountAndQty(10,2000), 20000, "Test for quantity : 10 and amount : 2000 sp output is 20000" );
        \n equal( calculateAmountAndQty("printer",2000), 0, "Test for quantity : printer and amount : 2000 so output is 0" );
        \n equal( calculateAmountAndQty(10,"mouse"), 0, "Test for quantity : 10 and amount : mouse so output is 0" );
        \n equal( calculateAmountAndQty(10,null), 0, "Test for quantity : 10 and amount : null so output is 0" );
        \n equal( calculateAmountAndQty(null,2000), 0, "Test for quantity : null and amount : 2000 so output is 0" );
        \n equal( calculateAmountAndQty(undefined,2000), 0, "Test for quantity : undefined and amount : 2000 so output is 0" );
        \n equal( calculateAmountAndQty(10,undefined), 0, "Test for quantity : 10 and amount : undefined so output is 0" );
        \n });
        \n }
        \n[\/js]<\/p>\n

        Steps to Run Qunit Test Case :<\/strong><\/p>\n

          \n
        1. Click on Publish> Deploy as web app.
          \n\"Deploy<\/li>\n
        2. Click on Deploy.<\/li>\n
        3. Click on latest code. It redirects to Qunit page where all test case report is displayed .<\/li>\n<\/ol>\n

          Output<\/strong> :<\/p>\n

          \"Qunit<\/p>\n

          Note: <\/strong>Qunit configuration is mandatory.<\/p>\n

          For more reference :
          \n1. https:\/\/qunitjs.com
          \n2. https:\/\/github.com\/simula-innovation\/qunit\/tree\/gas\/gas<\/p>\n","protected":false},"excerpt":{"rendered":"

          In my previous blog, we learnt how to use Google Apps Script in spreadsheets. Now we will take a look at\u00a0how we can test the code which we have\u00a0written in apps script.\u00a0For this purpose, we’ll use a tool called \u201cQunit\u201d which helps us in writing and testing our apps script test cases. QUnit is a […]<\/p>\n","protected":false},"author":76,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":50},"categories":[1],"tags":[3173,3179],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/33364"}],"collection":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/users\/76"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/comments?post=33364"}],"version-history":[{"count":0,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/33364\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/media?parent=33364"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/categories?post=33364"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/tags?post=33364"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}