API and web test combined

Manual_Tester · October 30, 2018, 12:25am

Is it possible to combine API and web test and use the response from API test as test data for Web Tests?

Thanks

kazurayam · October 30, 2018, 2:24am

Yes, you can.

When you create a test case in Katalon Studio, it generates the following import statements:

import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUIimport com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as Mobileimport com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WS

This means your test case can call both of WebUI.xxx keywords and WS.xxx keywords wherever you like.

Manual_Tester · October 30, 2018, 4:58am

That’s right direction to start with. Do you have any samples or any examples you can point me to?

Thanks

kazurayam · October 30, 2018, 6:27am

I made a Katalon Studio project. The project does the following:

get the Yahoo! RSS feed at Yahoo News - Latest News & Headlines using Katalon Web Service keyword WS.sendRequest(TestObject)
parse the XML document and find a list of URLs of contained news pages using XPath. Basic knowledge about XML processing in Java is required.
iterate over the list of URLs found; open the URL in browser, take screenshots and save the image into /tmp folder

import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject
import java.nio.file.Path
import java.nio.file.Paths
import javax.xml.parsers.DocumentBuilder
import javax.xml.parsers.DocumentBuilderFactory
import javax.xml.xpath.XPath
import javax.xml.xpath.XPathConstants
import javax.xml.xpath.XPathFactory
import org.w3c.dom.Document
import com.kms.katalon.core.configuration.RunConfiguration
import com.kms.katalon.core.testobject.HttpBodyContent
import com.kms.katalon.core.testobject.ResponseObject
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WS
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
DocumentBuilderFactory dbfactory = DocumentBuilderFactory.newInstance()
    dbfactory.setNamespaceAware(true)ResponseObject response = WS.sendRequest(findTestObject('Yahoo.com RSS mostviewed'))
if (response.isXmlContentType()) {
    println "is XML"
    HttpBodyContent content = response.getBodyContent()
    println "content encoding: ${content.getContentEncoding()}"
    println "content length: ${content.getContentLength()}"
    println "content type: ${content.getContentType()}"
    InputStream is = content.getInputStream()
    // parsing XML document
    DocumentBuilder db = dbfactory.newDocumentBuilder()
    Document document = db.parse(is)
    // get access to Items using XPath
    XPath xpath = XPathFactory.newInstance().newXPath()
    WebUI.openBrowser('')
    Path outdir = Paths.get(RunConfiguration.getProjectDir()).resolve('tmp')
    for (int x = 1; x <= 3; x++) {
        String url = (String)xpath.evaluate("/rss/channel/item[${x}]/link",                                            document, XPathConstants.STRING)
        println "url: ${url}"
        if (url != null) {
            // taking evidence screenshot
            WebUI.navigateToUrl(url)
            WebUI.delay(2)
            Path outfile = outdir.resolve(URLEncoder.encode(url,'UTF-8') + ".png")
            WebUI.takeScreenshot(outfile.toString())
        }
    }
    WebUI.closeBrowser()
}

I got 3 png files successfully.

You can downlowd the zip file of this sample project at Releases · kazurayam/KatalonDiscussion10444 · GitHub

KS10444_TestObject.PNG

Manual_Tester · October 31, 2018, 8:55am

kazurayam said:

I made a Katalon Studio project. The project does the following:

get the Yahoo! RSS feed at Yahoo News - Latest News & Headlines using Katalon Web Service keyword WS.sendRequest(TestObject)

parse the XML document and find the URL of contained news pages using XPath. Basic knowledge about XML processing in Java is required.

iterate over the list of URLs found; open the URL in browser, take screenshots and save the image into /tmp folder
import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject

import java.nio.file.Path
import java.nio.file.Paths
import javax.xml.parsers.DocumentBuilder
import javax.xml.parsers.DocumentBuilderFactory
import javax.xml.xpath.XPath
import javax.xml.xpath.XPathConstants
import javax.xml.xpath.XPathFactory
import org.w3c.dom.Document
import com.kms.katalon.core.configuration.RunConfiguration
import com.kms.katalon.core.testobject.HttpBodyContent
import com.kms.katalon.core.testobject.ResponseObject
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WS
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
DocumentBuilderFactory dbfactory = DocumentBuilderFactory.newInstance()
dbfactory.setNamespaceAware(true)ResponseObject response = WS.sendRequest(findTestObject(‘Yahoo.com RSS mostviewed’))
if (response.isXmlContentType()) {
println “is XML”
HttpBodyContent content = response.getBodyContent()
println “content encoding: ${content.getContentEncoding()}”
println “content length: ${content.getContentLength()}”
println “content type: ${content.getContentType()}”
InputStream is = content.getInputStream()
// parsing XML document
DocumentBuilder db = dbfactory.newDocumentBuilder()
Document document = db.parse(is)
// get access to Items using XPath
XPath xpath = XPathFactory.newInstance().newXPath()
WebUI.openBrowser(‘’)
Path outdir = Paths.get(RunConfiguration.getProjectDir()).resolve(‘tmp’)
for (int x = 1; x <= 3; x++) {
String url = (String)xpath.evaluate(“/rss/channel/item[${x}]/link”, document, XPathConstants.STRING)
println “url: ${url}”
if (url != null) {
// taking evidence screenshot
WebUI.navigateToUrl(url)
WebUI.delay(2)
Path outfile = outdir.resolve(URLEncoder.encode(url,‘UTF-8’) + “.png”)
WebUI.takeScreenshot(outfile.toString())
}
}
WebUI.closeBrowser()
}


  
  
I got 3 png files successfully.  
  
You can downlowd the zip file of this sample project at https://github.com/kazurayam/KatalonDiscussion10444/releases

kazurayam said:

I made a Katalon Studio project. The project does the following:

get the Yahoo! RSS feed at Yahoo News - Latest News & Headlines using Katalon Web Service keyword WS.sendRequest(TestObject)

parse the XML document and find the URL of contained news pages using XPath. Basic knowledge about XML processing in Java is required.

iterate over the list of URLs found; open the URL in browser, take screenshots and save the image into /tmp folder
import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject

import java.nio.file.Path
import java.nio.file.Paths
import javax.xml.parsers.DocumentBuilder
import javax.xml.parsers.DocumentBuilderFactory
import javax.xml.xpath.XPath
import javax.xml.xpath.XPathConstants
import javax.xml.xpath.XPathFactory
import org.w3c.dom.Document
import com.kms.katalon.core.configuration.RunConfiguration
import com.kms.katalon.core.testobject.HttpBodyContent
import com.kms.katalon.core.testobject.ResponseObject
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WS
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
DocumentBuilderFactory dbfactory = DocumentBuilderFactory.newInstance()
dbfactory.setNamespaceAware(true)ResponseObject response = WS.sendRequest(findTestObject(‘Yahoo.com RSS mostviewed’))
if (response.isXmlContentType()) {
println “is XML”
HttpBodyContent content = response.getBodyContent()
println “content encoding: ${content.getContentEncoding()}”
println “content length: ${content.getContentLength()}”
println “content type: ${content.getContentType()}”
InputStream is = content.getInputStream()
// parsing XML document
DocumentBuilder db = dbfactory.newDocumentBuilder()
Document document = db.parse(is)
// get access to Items using XPath
XPath xpath = XPathFactory.newInstance().newXPath()
WebUI.openBrowser(‘’)
Path outdir = Paths.get(RunConfiguration.getProjectDir()).resolve(‘tmp’)
for (int x = 1; x <= 3; x++) {
String url = (String)xpath.evaluate(“/rss/channel/item[${x}]/link”, document, XPathConstants.STRING)
println “url: ${url}”
if (url != null) {
// taking evidence screenshot
WebUI.navigateToUrl(url)
WebUI.delay(2)
Path outfile = outdir.resolve(URLEncoder.encode(url,‘UTF-8’) + “.png”)
WebUI.takeScreenshot(outfile.toString())
}
}
WebUI.closeBrowser()
}


  
  
I got 3 png files successfully.  
  
You can downlowd the zip file of this sample project at https://github.com/kazurayam/KatalonDiscussion10444/releases

kazurayam said:

I made a Katalon Studio project. The project does the following:

get the Yahoo! RSS feed at Yahoo News - Latest News & Headlines using Katalon Web Service keyword WS.sendRequest(TestObject)

parse the XML document and find the URL of contained news pages using XPath. Basic knowledge about XML processing in Java is required.

iterate over the list of URLs found; open the URL in browser, take screenshots and save the image into /tmp folder
import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject

import java.nio.file.Path
import java.nio.file.Paths
import javax.xml.parsers.DocumentBuilder
import javax.xml.parsers.DocumentBuilderFactory
import javax.xml.xpath.XPath
import javax.xml.xpath.XPathConstants
import javax.xml.xpath.XPathFactory
import org.w3c.dom.Document
import com.kms.katalon.core.configuration.RunConfiguration
import com.kms.katalon.core.testobject.HttpBodyContent
import com.kms.katalon.core.testobject.ResponseObject
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WS
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
DocumentBuilderFactory dbfactory = DocumentBuilderFactory.newInstance()
dbfactory.setNamespaceAware(true)ResponseObject response = WS.sendRequest(findTestObject(‘Yahoo.com RSS mostviewed’))
if (response.isXmlContentType()) {
println “is XML”
HttpBodyContent content = response.getBodyContent()
println “content encoding: ${content.getContentEncoding()}”
println “content length: ${content.getContentLength()}”
println “content type: ${content.getContentType()}”
InputStream is = content.getInputStream()
// parsing XML document
DocumentBuilder db = dbfactory.newDocumentBuilder()
Document document = db.parse(is)
// get access to Items using XPath
XPath xpath = XPathFactory.newInstance().newXPath()
WebUI.openBrowser(‘’)
Path outdir = Paths.get(RunConfiguration.getProjectDir()).resolve(‘tmp’)
for (int x = 1; x <= 3; x++) {
String url = (String)xpath.evaluate(“/rss/channel/item[${x}]/link”, document, XPathConstants.STRING)
println “url: ${url}”
if (url != null) {
// taking evidence screenshot
WebUI.navigateToUrl(url)
WebUI.delay(2)
Path outfile = outdir.resolve(URLEncoder.encode(url,‘UTF-8’) + “.png”)
WebUI.takeScreenshot(outfile.toString())
}
}
WebUI.closeBrowser()
}


  
  
I got 3 png files successfully.  
  
You can downlowd the zip file of this sample project at https://github.com/kazurayam/KatalonDiscussion10444/releases

Kazurayam, Thanks a lot for the example, there is lot to learn about the abilities of this tool from this example, really appreciate your help.

Manual_Tester · October 31, 2018, 8:57am

Kazurayam, Thanks a lot for the example, there is lot to learn about the abilities of this tool from this example, really appreciate your help.

Topic		Replies	Views
Is there a way to combine Web and API tests? Archive katalon-studio	3	2617	January 23, 2019
Using web and API testing together? Katalon Studio katalon-studio , web-testing	3	407	March 7, 2022
Is it possible to have both API Related Test Suite & UI Test Suite in same project? Katalon Studio katalon-studio , web-testing	6	2662	April 7, 2020
Possible to do API calls & Web Testing as part of the same test? Katalon Studio katalon-studio , web-testing	6	1396	August 8, 2022
How to integrate Web UI testing into API testing project? Katalon Studio integrations , katalon-studio , web-testing , api-testing	1	869	August 1, 2022

API and web test combined

Related Topics