SPFx Unit Testing with Azure DevOps

2 minute read

SPFx Unit Testing with Azure DevOps

Overview

SharePoint Framework is JavaScript based and supports any JavaScript framework for testing. The test cases can be implemented using Jest and Enzyme. The test cases help to validate the SPFx solutions for each of its releases. Please read through my previous article Unit Test With Jest And Enzyme to develop test cases for SPFx solution. The test cases had to run manually.

In this article, we will automate running the test cases using Azure DevOps.

Changes to SPFx Solution for Automated Testing using Azure DevOps

Follow below steps to make changes to the SPFx solution.

  1. On the command prompt, run below command to open the SPFx solution in a editor of your choice.

     code .
    
  2. Run below command to install the jest-junit dependency to get test reports which Azure DevOps can process.

     npm i jest-junit --save-dev --save-exact
    
  3. Add below jest configuration after devDependencies section inside package.json file.

     "jest": {  
       "reporters": [  
         [  
           "jest-junit", {  
             "suiteName": "SPFx Unit Test",  
             "outputDirectory": "./reports/",  
             "outputName": "./junit.xml"  
           }  
         ]  
       ]  
     }
    
  4. On the command prompt, run below command to test the configuration locally.

     npm test
    
  5. This will create a new folder named reports and junit.xml file.

Azure DevOps Build Pipeline Configuration

Create a repository in Azure DevOps projects and add the code. Once the repository is created, create a new build pipeline by adding below tasks.

Install Node JS

  • On the default agent, click the + sign.
  • Search for Node.
  • Add Node.js tool installer.
  • Specify the version as 8.x or 10.x

Install npm packages

Restore needed npm packages before starting the build process.

  • Add npm task.
  • Verify if the command is set to install.

Run Test Cases

  • Add npm task.
  • Set command to custom.
  • In the Command and arguments type test.

Publish Test Results

  • Add Publish Test Results task.
  • Select Test result format as JUnit.
  • In the Test results files, specify **/junit.xml

Execute Test Cases with Azure DevOps

Queue a new build and wait for the output.

Click Tests tab to view the test outcome.

The test outcome will display the number of passed and failed tests along with the run duration and pass percentage. Click on each of the test case to view the details of each test case run.

Summary

The test cases help to validate the SPFx solutions for each of its releases. The test cases can be implemented using Jest and Enzyme. We can automate running the test cases using Azure DevOps. The test outcome from Azure DevOps summarizes the number of passed and failed test cases. Although the test cases fail, build may continue further with the packaging and deployment.

This content was originally posted here.

Hits

Leave a comment