Forum Discussion

jkrier's avatar
jkrier
Regular Contributor
8 years ago

How to run SoapUI API commands in an external script

Does anyone know how to run SoapUI commands from an external script?   For example if I have an external script that does an evaluation based on an XML response and if I get the wrong response I wa...
  • Radford's avatar
    Radford
    8 years ago

    groovyguy, you shouldn't need to import the entire library.

     

    Reworking the original Class file a bit (I've made the getServiceAvailabilityResult method static for ease of calling, but I understand that this is just a cut down example so this may not be possible with the actual script):

     

    package library.serviceAvailabilityResult

class ServiceAvailabilityResult {

	static String getServiceAvailabilityResult(testRunner, String result) {

		def serviceAvailabilityResult = ''

		if(result == "yes") {
			serviceAvailabilityResult = result
		}else if(result == "no"){
			serviceAvailabilityResult = 'SERVICE IS NOT AVAILABLE'
			testRunner.fail(serviceAvailabilityResult)
		}else{
			serviceAvailabilityResult = 'Unrecognised input result parameter value "' + result + '"'
		}
		
		return serviceAvailabilityResult
	}
}

     

    I could then call this from a test case setup script, like so:

     

    import library.serviceAvailabilityResult.ServiceAvailabilityResult

// The variable inputString must be 'yes' or 'no'
def inputString = 'no'
def returnString = ServiceAvailabilityResult.getServiceAvailabilityResult(testRunner, inputString)

log.info('ServiceAvailabilityResult.getServiceAvailabilityResult = ' + returnString)

     

    with the test case being failed as expected.

     

    jkrier, if your requirement for having an external script was to just have one script to maintain I would still recomend that you investigate Ready APIs Event functionality.

Radford's avatar
Radford
Super Contributor

The "testRunner" object you are referring to (along with others, like log, context, etc) are provided by Ready API, to the scripts written/run within it's script editors, here is the documentation for the Groovy test step, with their details (Note: different Ready API Groovy editors will provide subtly different objects).

 

While I fully understand your requirement for a single external script, you can't just "call" these internally provided objects from external scripts.

 

I see one of two possible solutions:

 

  1. Rework your external script function (this function actually being a method of a class) to pass in a reference to the testRunner object, as I assume that you will be calling this external script from an internal location that provides the testRunner object, probably from a test case setup script.
  2. Use the Ready API Events functionality. Here you can write a single script that is triggered on an event, for example "Before a test case runs". The advantage of this is that it is an internal script that has access to the testRunner object.

Personally I use (and would recommend) Events (option 2) to achieve the single script requirement. For example I have a script that runs before each test case that validates my assertions have content (I have a habit of adding blank assertions and forgetting to complete them :smileyhappy:). These events can be targeted to a limited subset of items, see the linked documentation page for details.

groovyguy's avatar
groovyguy
Community Hero
8 years ago

Radford is correct. You can't really expect to interface properly with ReadyAPI functionality without importing their entire library into your external script. 

  • Radford's avatar
    Radford
    Super Contributor
    8 years ago

    groovyguy, you shouldn't need to import the entire library.

     

    Reworking the original Class file a bit (I've made the getServiceAvailabilityResult method static for ease of calling, but I understand that this is just a cut down example so this may not be possible with the actual script):

     

    package library.serviceAvailabilityResult

class ServiceAvailabilityResult {

	static String getServiceAvailabilityResult(testRunner, String result) {

		def serviceAvailabilityResult = ''

		if(result == "yes") {
			serviceAvailabilityResult = result
		}else if(result == "no"){
			serviceAvailabilityResult = 'SERVICE IS NOT AVAILABLE'
			testRunner.fail(serviceAvailabilityResult)
		}else{
			serviceAvailabilityResult = 'Unrecognised input result parameter value "' + result + '"'
		}
		
		return serviceAvailabilityResult
	}
}

     

    I could then call this from a test case setup script, like so:

     

    import library.serviceAvailabilityResult.ServiceAvailabilityResult

// The variable inputString must be 'yes' or 'no'
def inputString = 'no'
def returnString = ServiceAvailabilityResult.getServiceAvailabilityResult(testRunner, inputString)

log.info('ServiceAvailabilityResult.getServiceAvailabilityResult = ' + returnString)

     

    with the test case being failed as expected.

     

    jkrier, if your requirement for having an external script was to just have one script to maintain I would still recomend that you investigate Ready APIs Event functionality.

    • groovyguy's avatar
      groovyguy
      Community Hero
      8 years ago

      Radford That's a great point, and looks like a thorough explanation! 

      • jkrier's avatar
        jkrier
        Regular Contributor
        8 years ago

        Thanks to groovyguy and Radford I appreciate your time and assistance with this. I am able to fail the test case now with the external script.

         

        As far as using Events. I already do these fairly extensively but I have to add them to every project that I have. Doing this in an event would essentially be the same as adding a Groovy Script step wouldn't? Since I would have to add the event to every project. Not all of my test cases that use the ServiceAvailabilityResult are in the same project. We have many projects with different test cases that use this.

    • nmrao's avatar
      nmrao
      Champion Level 3
      8 years ago

      Radford and others,
      If I think what is this method is achieving or value add that bring to the table? I see nothing unless user has some other things in mind and add some more code later to it.

      In this specific case, User is passing "yes" to this method and method is returning the same result back without any business logic based on the code, at least, for the moment. It does not make sense, IMO.

       

      I do not suggest / advocate something which I do not follow. For the above requirement,if I have to do it, use onliner instead of external and method and suggests the same to the community.

       

      That is why, it was suggested in other thread to use something like below and avoid class in this case or tell the use in a broader way so that other idea be though of.

       

      In the groovy script it self it is one line which is equivalent to call method

       

      String result = 'no'

      (result == 'yes') ?: testRunner.fail('Service is not running')

       

      //or

      assert result == 'yes', 'Service is not running'

       

       

      I do promote or advocate to write classes and reuse if it suites case such as mentioned below thread(s).

       

      https://community.smartbear.com/t5/SoapUI-NG/Getting-MissingMethodException-while-calling-Groovy-class-in-a/m-p/140870/highlight/true#M31668

       

      https://stackoverflow.com/questions/43254590/how-to-place-the-groovy-in-centralized-groovy-library-and-access-that-class-from/43269724#43269724

       

      https://community.smartbear.com/t5/SoapUI-NG/Call-Java-class-with-variable-in-groovy/m-p/140335/highlight/true#M31570