Forum Discussion

mmoser18's avatar
mmoser18
Frequent Contributor
9 years ago

Adding HTTP-headers to ALL test-cases of a test-suite (or several test-suites)?

We had to change the authentication mechanism for several web-applications that we developed. That means that for all our test-cases I now need to include a set of additional HTTP-headers to each and...
mmoser18's avatar
mmoser18
Frequent Contributor

Access_token is a project-level custom property. It is always fetched and updated in a test-case at the very begin of my test-suites and is then valid and used during the entire execution of that test suite.

nmrao's avatar
nmrao
Champion Level 3
9 years ago

So, as you already mentioned, you need to get it and save it as Project level custom property say ACCESS_TOKEN.

Then, In your case there are two options.

Either you need to add the predefined Header property using property expansion to all the required steps say ${#Project#ACCESS_TOKEN}. So, yes, the header needs to be to added to all existing test requests and for the new test requests as well which you will be adding in the future.

Or add ACCESS_TOKEN as header for each out going request programatically. Not only that, but also requires a feature called Events (which is part of pro edition) or an extension for Open source edition mentioned here.

  • nmrao's avatar
    nmrao
    Champion Level 3
    9 years ago
    Action you needed here is "Before Submitting Each Request"
    • mmoser18's avatar
      mmoser18
      Frequent Contributor
      9 years ago

      Hi Rao

      thanks for pointing me to this solution! I am now trying to implement this.

       

      What I am currently stuck with is: How do I set/add HTTP-headers to a request?

      My RequestSteoBeforeSubmit.groovy file will need to reads something like this:

       

      testStep.httpRequest.setHeader('Authorization','Bearer ${#Project#Mashery_Access_Token}')
testStep.httpRequest.setHeader('X-Mashery-Host','${#Project#target_address}')
testStep.httpRequest.setHeader('X-Mashery-Service-Key','foobar')

      I have two questions:

       

      1. I wrote here "...httpRequest.setHeader('key', 'value') but I don't even know, whether httpHeader provides such a method.Is there some documentation on these "inner" types (like testSuite, testCase, testStep, httpRequest, etc.) to find out, what fields and methods they support?

       

      2. Some of the values would first have to be expanded (like in the above example the "${#Project#Mashery_Access_Token}" and "${#Project#target_address}"). I assume that this listener is called *after* properties-expansion has already taken place. If so: how would I expand such a property here in the listener before assigning it? Is that possible via the same

      value = context.expand("${some-property-name}")

      as one would do in a scripted-assertion?

       

       

      Regards,

      Michael

    • mmoser18's avatar
      mmoser18
      Frequent Contributor
      9 years ago

      Hi Rao

      thanks for your hints and pointers so far! Sorry for continue to pester you, but I am afraid, I haven't yet fully understood, how these listeners are supposed to work. What I did so far:

       

      1. I added SoapUIExtListeners.jar to the C:\Program Files\SmartBear\SoapUI-5.2.1\bin\ext directory.
      2. I created a directory C:\Program Files\SmartBear\SoapUI-5.2.1\bin\listeners into which I placed the file custom-listeners.xml.
      3. I added all the groovy scripts (FilterRequest.groovy, ..., TestSuiteTestStepAdded.groovy) that I found into directory C:\Program Files\SmartBear\SoapUI-5.2.1\bin\scripts

      I would have expected that when I now fire a request that I would now find log-entries from these miscellaneous .groovy files in the soapui.log (since most .groovy files contain a log-statement emitting their name), but not so.

       

      What I see instead is:

      ...

      2016-06-01 00:51:15,637 INFO  [RequestStepSubmitListener] Dummy script being run, implement required script
      2016-06-01 01:04:39,744 INFO  [RequestStepSubmitListener] Dummy script being run, implement required script
      2016-06-01 01:04:39,747 INFO  [RequestFilter] Setting submitContext, request, and log variables
      2016-06-01 01:04:39,759 INFO  [RequestFilter] Dummy script being run, implement required script
      2016-06-01 01:04:39,892 INFO  [RequestFilter] Setting submitContext, request, and log variables
      2016-06-01 01:04:39,906 INFO  [RequestFilter] Dummy script being run, implement required script

      ...

       

      So: how do I "activate" these listeners? I am obviously missing something here...

       

      Specifically that listener for "Before Submitting Each Request" that you mention: I didn't find any file with that name - I guess you mean "RequestStepBeforeSubmit.groovy"? That's at least the closest match that I found. How do I get that triggered/called?

       

      Regards,

      Michael

       

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

        Right, the script content you wrote should goes into the file called 'RequestStepBeforeSubmit.groovy' only. And place it in the scripts directory. The behaviour you observing is expected because there may not have any statements to execute or there could not be any file with such name, that is why it running default script when it can't find such file with that name.

        Also you must have condition in your case at least, so that those headers are not added to the request step which fetches the token itself.

        For eg: condition can be such as if test step name is not getAccessToken then only add headers.