Configure HTTP Basic Auth for soapUI Test Suties.

Since soapUI is a powerful tool, it frequently offers more than one way to do things.  Setting up HTTP Basic Authentication is one of these things.  If you’re dealing with a SOAP based web service that has this kind of security setup, this article will show you how to best configure your soapUI tests to supply the basic authentication credentials.  The username and password supplied for HTTP Basic Authentication is ultimately an HTTP header field.  As such, each SOAP test request in soapUI can be configured with a HTTP Basic Authentication username and password.  When the test request is run an “Authorization” header is added to the HTTP envelope that contains the SOAP request.  Here’s an example:

Authorization: Basic QRJ3aXphblByb2ZpbGU6VGVzdCCmMs==

There are at least three ways in soapUI to setup HTTP Basic Authentication:

1. on each SOAP test request (in a test case or in sample request)
2. through the “Interface Viewer”
3. with a Groovy setup script for a test suite.

Setting up HTTP Basic Authentication for A Test Request

This is an easy, quick way to set the username and password for a few requests, but not a good solution for a test suite.  When you use this method each individual SOAP test request must have the username and password set for the request to work properly.  With a SOAP test request open, you can change the username and password for that request by clicking the button labeled “Aut” underneath the request pane, as shown below.  Just enter the username and password in the fields.  The next time you run the SOAP request the “Authorization” header will be added to the HTTP envelope.

Setting up HTTP Basic Authentication through the Interface Viewer

If you know that many SOAP test requests will need to share the same HTTP Basic Authentication credentials, you’ll want to just set them one time.  You can do this through a soapUI tool called the Interface Viewer.  To open the Interface Viewer, right-click on a WSDL operation in the project explorer tree on the left-hand side of the soapUI interface and choose “Show Interface Viewer”.  This will open a screen with four tabs: Overview, Service Endpoints, WSDL Content, and WS-I Compliance.  The HTTP Basic Authentication credentials are set through the “Service Endpoints” tab.  For each endpoint in the list you can specify what username and password to use.  Once specified, all of the test requests on the WSDL operation (the one you selected to open the Interface Viewer) using the specific endpoint will automatically use the username and password you entered.  An example of using the Interface Viewer is shown below.

Setting up HTTP Basic Authentication with a Groovy Test Suite Setup Script

Another fairly effective way to do this setup for all the SOAP test requests in a test suite is with a Groovy setup script.  Using the Interface Viewer is probably a more convenient way to do the setup than the Groovy script, but if you need some more control then you might have to use the script.  Below is a sample Groovy script that you could copy and paste into the “Setup Script” text box for one of your test suites.  The script relies on the existence of  two properties which must be defined in the test suite: basicAuthUser and basicAuthPass.  These properties should contain, respectively, the username and password to be used in the HTTP Basic Authentication header for each SOAP test request in the test suite.

import com.eviware.soapui.impl.wsdl.teststeps.*

for( testCase in testSuite.getTestCaseList() ) {
   log.info("Setting HTTP basic auth for all WSDL test requests in test case ["+
             testCase.getLabel()+"]")
  for( testStep in testCase.getTestStepList() ) {
    if( testStep instanceof WsdlTestRequestStep ) {
      testStep.getTestRequest()
              .setUsername(testSuite
                           .getPropertyValue("basicAuthUser"))
      testStep.getTestRequest()
              .setPassword(testSuite
                           .getPropertyValue("basicAuthPass"))
    }
  }
}

The script above uses the soapUI Java API to access the necessary pieces of the test suite.  It first loops over all of the test cases in the test suite.  For each test case, the script loops over each test step therein.  If the test step is a WsdlTestRequestStep, which is a SOAP test request, then the username and password are set.  This script will run just before the test cases run when the entire test suite is executed.