Forum Discussion

richie's avatar
richie
Community Hero
7 months ago

GroovyScript - Extract specific number of attribute values from variable content response

Hey! I've checked my groovy script notes which contains essentially all the groovy script snippets people have ever helped me with over the years - mostly from nmrao if I'm being honest - but I hav...
Scripting
  • nmrao's avatar
    nmrao
    7 months ago

    richie 

    You can quickly try this groovy to understand how this can be achieved in general.

    Follow inline comments:

    def range = 1..10

println "Items in the range: $range"


def startingIndex=0

//Set this value, how many values to be stored 
def endIndex=4

//This is to ensure not to grab more than present in the list
assert endIndex <= range.size(), 'Choose the endIndex less than list size'

//Now get the sub list from original list
def mySubList = range.subList(startingIndex,endIndex)
println mySubList

//In order to save data as custom property, coierce it to String
def mySubListToString = mySubList.join(',')
println mySubListToString //Save this at suite level

//Convert string back to list when needed later
def stringToList = mySubListToString.split()
println stringToList

    If running the above from the ReadyAPI / SoapUI, use log.info instead of println

    Hope you knew how to store mySubListToString into Test Suite custom property.

    Note that all the properties in ReadyAPI are stored as string.

  • nmrao's avatar
    nmrao
    7 months ago

    richie 

    All it needs here is to replace

    def range = 1..10

    with

    def json = new groovy.json.JsonSlurper().parseText(context.response)

    def range = json.data.id.findAll()

    Change endIndex value depending on how many values that you need. 

    In order to store values at test suite level, add below statement at line number 20.

    context.testCase.testSuite.setPropertyValue('MY_SUBLIST', mySubListToString)

     

    And lines #22, 23, 24 are not needed here i.e., script assertion, as those to fetch and convert string to list. Instead use the when you need those values later.

    By the way, first it requires to fetch the MY_SUBLIST value stored at test suite level, so add below statement before using those lines.

    def mySubListToString = context.testCase.testSuite.getPropertyValue('MY_SUBLIST)

    Now it has all code it required with your data to achieve what is mentioned in the original question.

    NOTE: I am referring the line numbers here in this response from my original response's code.

richie's avatar
richie
Community Hero
7 months ago

Hey nmrao 

My bad- I'm sorry for causing any confusion - I'm working with 60 different REST APIs which provide all the data for the 3 tiered web app I'm working on and all these APIs are starting to merge into one.

I've been playing around with the Script Assertions on a different GET API - which is why I've caused confusion.

Also - the question I'm asking is so transferrable when the number of records in your response payload changes - once I get this sorted I'm gonna be using this snippet of groovy for a lot of things.  

So - to make things straightforward - lets keep going with the original API I mentioned before GET /v2/plans which returns a number of 'plans'.  (I've attached the same payload as the original one I attached in my first post).  Each plan has a unique identifier with JSONPATH--> x.data*.id (where the first record's id attribute has JSONPATH x.data[0].id)

Spent the last 4 hours going through all my notes and googling and I managed to get a little further with the following code:

//Script Assertion
def json = new groovy.json.JsonSlurper().parseText(context.response) 

// Log the first id 
log.info('First (index zero) id = ' + json.data[0].id) 

// Log all ids with index identifier (it's JSON so it starts at ZERO) 
json.data.eachWithIndex(){ prop, idx -> 
log.info('id ' + idx + ' = ' + prop.id) }

So at this point, I have logged all the id values in the response along with it;s index identifier.

I've been googling to try and understand what this '{ prop ->' represents in groovy  - I see it a lot but I've never really understood what it actually means, but I'm trying to understand so I can reuse it in the future but I didn't really understand.  It said that -> is used in a closure and this separates the "argument list from the body"

Anyway - sorry going off at a tangent. - so I've now got a list of id's logged - but because of the user of this '{ prop ->' - I don't know how to convert the indexed id's (displayed in the logging) to a custom property. I've reminded myself of the getProperty() and setProperty() methods, but I'm struggling on this point, cos my list of indexed id's aren't actually assigned to a variable - so I'm a little lost there.

Once I can do that - I was thinking I need to somehow assign the x.data[0].id attribute in my property list (once it's been extracted) to the startingIndex variable you have defined in the code you gave me (def startingIndex = 0) so then I can continue to use the rest of the code you gave me (see below)  - I think

- I'm sure I'm missing several important issues like just cos I've a variable named as startingIndex with a numeric value - the groovy compiler isn't going to know that I want :

x.data[0].id to be assigned startingIndex=0,

x.data[1].id assigned startingIndex=1

x.data[2].id assigned startingIndex=2

x.data[3].id assigned startingIndex=3

def range = 1..10

log.info "Items in the range: $range"

def startingIndex=0

//Set this value, how many values to be stored 
def endIndex=4

//This is to ensure not to grab more than present in the list
assert endIndex <= range.size(), 'Choose the endIndex less than list size'

//Now get the sub list from original list
def mySubList = range.subList(startingIndex,endIndex)
log.info mySubList

//In order to save data as custom property, coierce it to String
def mySubListToString = mySubList.join(',')
log.info mySubListToString //Save this at suite level

//Convert string back to list when needed later
def stringToList = mySubListToString.split()
log.info stringToList

So that's where I am right now.  

I'm actually having a lot of fun - this is way more interesting than the rest of my job at the moment, so if you can give me a couple of pointers to steer me where I'm going wrong - I'd really appreciate it.

thanks man - as always - can't thank you enough,

Oh - I should also apologise - I've been kindof jumping all over the place trying to find a way through so I've trying various different approaches to do what I need - that probably isn't helping you understand what I'm talking about either!

rich