SoapUI API/Webservices Testing Part 3

Internal Links:
- End points, Domains, Resources | GET, POST, PUT, DELETE | Create New REST Project | First New REST Project | WADL | the "Request 1" window | the JSON Response | TestSuites and TestCases
- Generate TestSuite | 8 Assertions to choose from | the "TestCase1" dialog box | the "CountriesTestSuite" dialog box | How to produce "Documentation" | v1/film || YouTube Videos | Reserve
External Links:
- Veezi Help Pages: Intro | Auth | Session | Web Session | Films | Film Pack | Screen | Site | Attribute
- Veezi | Web Site | Support and Resources | Getting Started Guide, the Veezi-er Way (PDF File) | reserve
- SOAP UI | Web Site | SoapUI Home Page || Blake's Web Site: Veezi to Excel | Veezi API PHP | reserve
- Blake's Web Site | VeeziHelpDoc || SoapUI Help Doc | Part 1 | Part 2 | Part 3 || SoapUI email from Joe | reserve
- Blake's Web Sites php2022 | PHP and MySQL | SoapUIapiPart3#v1film | Veezi APIs thru Excel | Explanation Of 07 | reserve
- YouTube Video | May 07, 2020 | 15:47 | SoapUI API/Webservices Testing Part 3- How To Create First REST Project, Test Suite, Test Case

restcountries.eu no longer works, restcountries.com works

Before we start there is news about the link the speaker uses for this video.
The link from the example https://restcountries.eu no longer works.
However, there is a https://restcountries.com that looks pretty close to what the speaker was talking about
It does give us links just like the video.

restcountries.com Navigation

restcountries.com Home Page has a panel on the left
There's information about the new version 3 format.
- There is a section for V3 and another for V2
- I'm going to use V2 to get familiar with SoapUI
In the left panel there is a Heading titled "API ENDPOINTS V2"
- Under that heading, are the following: All, Name, Full Name, etc.
- Just like the instructor in the video, I will use Name

All about Name

Click the "Name" link under "API ENDPOINTS V2" in the panel on the left.
- The page automatically scrolls to the Name section
  - The description for Name is as follows:
    - Search by country name. It can be the native name or partial name
- There are three examples of links:
  - https://restcountries.com/v2/name/{name}
  - https://restcountries.com/v2/name/peru
  - https://restcountries.com/v2/name/united
I believe we can get everything else to work from here, providing we use the newer URLs
I will update this document to reflect the newer links,
- and because I'm using version 5.7.0 and the video uses 5.5.0

SOAP UI - How To Create a Rest Project, Test Suite, Test Case

he first displays the following from Notepad on his desktop

SOAP UI
How To Create a Rest Project, Test Suite, Test Case
- - - - - - - - - - - - - - - - - - - - - - - - - -
https://restcountries.eu/ - the video uses .eu; we will use .com

the Rest Countries page opens

he finds the url
.eu https://restcountries.eu/rest/v2/all
.com https://restcountries.com/v2/all
01:00 | he opens that url in a browser
- when he first opens the url in his browser, it was completely filled with lines of text, the entire screen, some, very little, in other laguages

Go to Top

01:14 | he selects another example, instead of All he selects Name: name/united
- https://restcountries.com/v2/name/united
- this also fills his screen with lines of text
he edits the last folder from "united" to "india"
- https://restcountries.com/v2/name/india
- this also fills his screen with lines of text
01:21 | this time the browser filled its window with lines of text for 12 lines, roughly one third the "real estate" in the browser window

he chooses a url from the page
the edited url now looks like this:
- .eu - https://restcountries.eu/rest/v2/name/india
- .com - https://restcountries.com/v2/name/india
- since he used india earlier, he received the same screen that is shown above as a screen shot

Go to Top
this is a URL
- https://restcountries.eu/rest/v2/name/india
- https://restcountries.com/v2/name/india

End points, Domains, and Resources

Go to Top
02:17 | End point
- the first part of the URL is refered to as an "End point"
- example: https://restcountries.eu
- example: https://restcountries.com
- an end point contains a domain such as .eu or .com from the above URL
02:38 | Domains
- examples of domains: .eu .com .edu .info .gov .net .org
- endpoints contain the domain
02:59 | Resource
- the last part of the old url ie: "rest/v2/name/india" is called the resource
- the last part of the new url ie: "v2/name/india" is called the resource
- the server deals with the resource
- a resource can have more parameters by adding a question mark and a parameter
  - old example: rest/v2/name/india?population
  - new example: v2/name/india?population

old - https://restcountries.eu/rest/v2/name/india
new - https://restcountries.com/v2/name/india
he's saying we can send this url as a GET request

4 types of Requests - GET, POST, PUT, DELETE

Go to Top
04:12 | there are GET requests, POST requests, PUT request, DELETE request
04:20 | these are different operations we can do .....

GET - used to mine and Select something from a data base on the server
POST - Create a new resource in the server
PUT - Update an existing resource on the server
DELETE - Delete a resource from the server

Performing a GET request

Go to Top
05:14 | he will use this url: https://restcountries.eu/rest/v2/name/india
05:14 | we will use this url: https://restcountries.com/v2/name/india

he notes there is nothing under the word "Projects" in the Projects pane

3 ways to Create a REST project

Right-click the word Projects to display the submenu that gives you a menu item for "New REST Project"
Click File from the menu bar to display the submenu that gives you a menu item for "New REST Project"
Click the "REST" button in the toolbar to display a dialog box that will create a REST project

the "New REST Project" dialog box

displayed in the dialog box: Creates a new REST Project in this workspace
text box labeled as: "URI:"
- inside the textbox is: http://example.com/resource/path/search?parameter=value
there are also the following buttons:
- a "Help" button, an "OK" and "Cancel" buttons, and an additional button titled "Import WADL..."
looking at the format that the text box wants: http://example.com/resource/path/search?parameter=value
I break it down in this table below.

	URL	Resource	Path	Search?Parameter	Value
format	https://example.com	resource	path	search?parameter	value
.eu example	https://restcountries.eu	rest/v2/name/india
.com example	https://restcountries.com	v2/name/india

The .eu way

The .eu way

put it all together and you get : https://restcountries.eu/rest/v2/name/india
I was surprised that the entire string was classified as a resource
- /rest/v2/name/india

06:39 | he clicks the "OK" button

The .com way

The .com way

put it all together and you get : https://restcountries.com/v2/name/india
I was surprised that the entire string was classified as a resource
- /v2/name/india

after entering the URL

after clicking the "OK" button

the SoapUI with a REST project

Go to Top
the tree view in the Projects panel grew

06:46 | the Projects panel looks like this:

the .eu way	the .com way
Projects REST Project 1 http://restcountries.eu India [/rest/v2/name/india] India 1 Request 1	Projects REST Project 1 http://restcountries.com India [/v2/name/india] India 1 Request 1

The Properties Box is still below the Projects panel

There are three panels instead of two for SOAP
- there are two panels on the left, and one panel on the right
- the bottom panel on the left has many controls including 3 buttons, "Add..", "Edit..", and "Remove.."

Go to Top
instead of one long text box above the panel like in SOAP
- there is a drop-down menu labled "Method" for Get, Put, Post, Delete
- then there's a drop-down text box labeled "Endpoint"
  - .eu - the contents displayed in the drop-down text box is: https://restcountries.eu
  - .com-the contents displayed in the drop-down text box will be: https://restcountries.com
- the next text box is labeled "Resource"
  - .eu - the contents displayed in the text box is: /rest/v2/name/india
  - .com -the contents displayed in the text box will be: /v2/name/india
- the next text box is labeled "Parameters"
  - this text box is empty

WADL: Web Application Description Language

Go to Top
http://restcountries.eu is the WADL, but this link takes you to a web page
- for the .com way: http://restcountries.com is the WADL, but this link takes you to a web page
- he earlier described how he navigated that web site
from the tree view in the Projects panel
the speaker is pointing to the http://restcountries.eu in the tree view in the Projects panel
- the .com way will be http://restcountries.com
the speaker is saying that this "represents" the WADL

the .eu way

Projects
- REST Project 1 - - - - - - - - - - - - - - - - - -> (the name of the project)
  - http://restcountries.eu - - - - - - - - - -> (WADL)
    - India [/rest/v2/name/india]
      - India 1
        
        Request 1 - - - -> (one request)

the .com way

Projects
- REST Project 1 - - - - - - - - - - - - - - - - - -> (the name of the project)
  - http://restcountries.com - - - - - - - - -> (WADL)
    - India [/v2/name/india]
      - India 1
        
        Request 1 - - - -> (one request)

07:22 | WADL: Web Application Description Language includes the URL

the "Request 1" window

Go to Top
it appears with the Method set at GET
the .eu way
- and Endpoint set at https://restcountries.eu
- and Resource set at /rest/v2/name/india
the .com way
- and Endpoint set at https://restcountries.com
- and Resource set at /v2/name/india
he says you can pass parameters if you want to

in the Response pane he received the following text:
- The content you are trying to view cannot be viewed as XML
Note: on the left side of the Response tab there are four side tabs
- Raw, HTML, JSON, XML

the JSON Response

Go to Top
The XML tab has the focus
- he clicks the JSON tab and the Response pane is now filled with JSON data
for my 5.7.0 version, after clicking the "Run" button,
- the JSON tab automatically took the focus from the XML tab, and displayed the JSON data
- so I did not see the error message for the XML tab until I clicked it.
09:01 | this is not a test case, this is a request
- he closes the "Request 1" window

Creating Test Suites and Test Cases

Go to Top
09:13 | We have to make sure the leaf that has the focus is labeled (https://restcountries.eu) (soon .com)
- .eu - He first clicks the "Collapse" button for the "India [/rest/v2/name/india]" leaf
  . com-He first clicks the "Collapse" button for the "India [/v2/name/india]" leaf
  - forcing the "India 1" leaf and the leaf under it, labeled "Request 1", to disappear from view.
- He than clicks on the (https://restcountries.eu) leaf. (soon .com)
  - This verifies that the leaf has the focus,
    - and he calls that leaf the "WADL".

The speaker is looking for the "Generate TestSuite" menu item from the submenu.
The screen shot below displays the WADL leaf that has the focus, and the submenu.

the "Generate TestSuite" dialog box

Go to Top
TestSuite: drop-down text box containing (create)
Style: with two option buttons, one must be choosen.
- (o) One TestCase for each Resource (default is on)
- ( ) Single TestCase with one Request for each Method
Resources: "Select all" "Unselect all"
- [x] India: /rest/v2/name/india (is in a large text box that could hold more than one resource)
  - This one looks like it's check box is turned on.
  - when using .com, the "/rest" will be gone from the path for the resource.
Generate LoadTest [ ] Generates a default LoadTest for each created TestCase
- The check box for this is turned off.
There are three buttons: a "Help" button, an "OK" button, and a "Cancel" button.

09:24 | He is accepting the defaults and clicks the "OK" button.
Go to Top

The smaller "Generate TestSuite" dialog box, that wants the name.

Go to Top
within the dialog box are the following controls:
- a text box labeled: "Enter name of TestSuite to create"
- with the following contents as a default: https://restcountries.eu TestSuite
  - When we use the .com, we will see that reflected as the default.
- the dialog box includes an "OK" and "Cancel" buttons

Go to Top

09:38 | he changes the name from "https://restcountries.eu TestSuite" to "CountriesTestSuite"
09:38 | later it will be .com "https://restcountries.com TestSuite" to "CountriesTestSuite"
Here's a screen shot after the name change.

the TestSuite is created

Go to Top
here's a screen shot after clicking the "OK" button

here's my screen shot from v5.7.0

Go to Top
he expands the TestSuite and a leaf is displayed named "India TestCase"

Go to Top
a screen shot of the submenu is below

The 5.7.0 Rename TestCase dialog box - before renaming

The 5.7.0 Rename TestCase dialog box - after renaming

The 5.7.0 Tree View from the Projects panel - after renaming

Tree View from the Projects panel - after renaming

Go to Top
he renamed it from "India TestCase" to "TestCase1"
the screen shot below displays the tree view after the re-name.
the other three leaves popped up after he clicked the "OK" button from the "Rename TestCase" dialog box

Note that the three leaves belonging to the leaf labeled "TestCase1"
- have parentheses with either a "1" or a "0"
a "1" for "Test Steps(1)" contains just one request
"Load Test(0)" and "Security Tests(0)" I believe have no request within them

Go to Top
a leaf is displayed below it named "Request 1"
here's a screen shot of it

Go to Top
and this looks more like the Request and Respond panels from SOAP
a screen shot of this is below

Go to Top
The Endpoint as https://restcountries.eu
The Resource as /rest/v2/name/india
- we get the resource from the server
- that .eu above will become a .com
  - and we will lose the /rest folder because .com doesn't use a named folder like that

Go to Top
he receives the message:
- The content you are trying to view cannot be viewed as XML

Go to Top
What he does is click the sideways "JSON" tab
- and the Response panel displays JSON data.
here's a screen shot below

Go to Top
He says: We just ran a test case.

Adding an Assertion

we can add one Assertion to the response.

He scrolls thru the JSON code until he finds "name",
- with the contents of "British Indian Ocean Territory".
- He says: I can place an assertion on this.

the Assertions(0) button

the zero (0) represents that no "Assertions" have been made

Go to Top
The Request and Response panel made room for a new panel to be displayed underneith both of them
- with its own buttons.
The new panel is displayed in the screen shot below.

Go to Top
A new dialog box is displayed titled "Add Assertion".
A screen shot of the "Add Assertion" dialog box is shown below.

8 Assertions to choose from

Go to Top
Two of them are greyed out, meaning we can't use them.

Recently used
Property Content
Compliance, Status and Standards
Script
SLA
JMS
JDBC
Security

Go to Top
Note that in the screen shot above, "Recently used" had the focus
- It's description is displayed on the right side of the screen as:
  - Contains
  - Searches for the existence of a string token in the property value,
    supports regular expressions. Applicable to any property.

The screen shot below displays the text for the "Property Content" assertion.

Go to Top
There is more text in the description section of the dialog box.
- Contains - Searches for the existence ...
- JsonPath Count - Uses an JsonPath expression to count...
- JsonPath Existence Match - Uses an JsonPath expression to select content...
- JsonPath Match - Uses an JsonPath expression to existence of a node ...
- JsonPath RegEx Match - Uses an JsonPath expression to select content...
- and there's more

Go to Top
11:39 | He goes back to the "Recently used" assertion.
11:50 | He clicks the "Add" button in the lower right hand corner of the "Add Assertion" dialog box.
11:51 | The "Contains Assertion" dialog box is displayed.
- here's it's screen shot

Go to Top
he pasted that into the "Content:" box
- here's it's screen shot

the Content box for Contains Assertion dialog box

Go to Top
the "Ignore Case:" check box - he leaves it blank
12:11 | He then clicks the "Contains Assertion" dialog box's "OK" button.
- The dialog box disappears, and the "Assertions(0)" button now has a one "Assertions(1)" instead of zero.
  - And it's indicator light is green, letting us know that it's not empty
  - Before it's indicator light was black, letting us know it's empty
here's it's screen shot

Go to Top
Green indicates there is something in there.
here's a before and after picture

Go to Top
you click the "Assertions(1)" button located near the bottom of the window
and like before, a panel opened up under the request and respond panes.
However this time there is some text inside the pane:
- A green indicator light, then the text: "Contains - VALID"
- With the mouse cursor near by, he display's it's tool tip as: "Assertions for this request"
here's a screen shot

Go to Top
12:32 | by clicking the or right-clicking, I don't know yet, on the word "Contains -" another submenu is displayed
- also with an "Add Assertion" menu item
- but more important, is the "Configure" menu item used for modifying the Assertion.

the VALID submenu	the Contains submenu

Go to Top
and the "Contains Assertion" dialog box is displayed
Note the "Content:" is "British Indian Ocean Territory"
He will edit the "Content:" by removing the word "Territory"

Content with Territory

Content without Territory

the "Contains Assertion" dialog box disappears.

Go to Top
Note that the text "British Indian Ocean Territory" is still selected,
- probably from the first time he copied it to the clipboard.
here's the screen shot

British Indian Ocean Territory is still high-lighted

Go to Top
he first closes the "Request 1" window
he then clicks the "Request 1" leaf from the tree view and the "Request 1" window reappears
he clicks the "Run" button
he then clicks the sideways "JSON" tab to see the JSON data in the Response pane.
the screen shot of this is below

Go to Top
he says suppose you have multiple test cases you can execute them as a group
- I cannot figure out what he's saying: as a less sequential balance

we can go to the "TestCase1" level
he clicked the "Collapse" button for the "TestSteps(1)" leaf
- which hides the "Request 1" (test case ??) leaf

the "TestCase1" dialog box

and the "TestCase1" dialog box or window is displayed

Go to Top
13:13 | Here's a screen shot of the "TestCase1" dialog box.

Go to Top
the top button tool bar includes a "Run" button within the 9 buttons displayed under the title bar
underneath that there looks like a text box, buts it's actually a status bar
underneath that there's two tabs labeled "TestSteps" and "Test On Demand"
- it looks like the "TestSteps" tab has the focus
under the tabs is another set of 17 buttons
under that is a large text box with a green indicator and "Request 1" the test step is already in there
under that is a text box with a slider control labeled: "TestCase Description"
- it's contents: TestCase generated for REST Resource [India] located at [/rest/v2/nam....
- the .com will eliminate the "/rest" folder, TestCase generated for REST Resource [India] located at [/v2/nam....
under the slider control appears to be four buttons:
- Description, Properties, Setup Script, and Teardown Script
and more stuff below that

Go to Top
he says it has one step for now

he clicks the Run button and the empty Status Bar displays the word FINISHED and the whole area is green.
here's the screen shot of this dialog box after the Run button was clicked

Go to Top
he says: sometimes you can have multiple test cases
he might be saying, its hard to tell: you may want to run them singularly or parallel
he says: than you have to select the Test Suite from the tree view
he collapses the "TestCase1" leaf and then clicks the "CountriesTestSuite" leaf

the "CountriesTestSuite" dialog box

Go to Top
below is a screen shot of the "CountriesTestSuite" dialog box after he clicked the "Run" button

Go to Top
Inside the larger panel that displays "TestCase1" not as a tab,
- its also the place holder for the second FINISHED status bar
he says: if you have more numbers of test cases
- you can click the button with the two right arrows under the title bar.
- I think you run several test cases one at a time by clicking that button.
13:55 | he talks about the button that's to the left of the double arrow button
- its tool tip displays: "The selected TestCases are run in sequence"
14:05 | he closes the "CountriesTestSuite" dialog box

Go to Top
the following text is from his Notepad from his desktop


-> Create Rest Project using URL(WADL)
-> Create test suite and test cases
-> Add contain assertions
-> Execute tests in sequence and parallel
-> Documentation

How to produce "Documentation"

Go to Top
he leaves Notepad and goes back to displaying the SoapUI
he selects the WADL (the "https://restcountries.eu" leaf in the tree view)
- when .com, leaf will display https://restcountries.com
here's the screen shot of the tree view

Go to Top
here's the screen shot of the submenu

Go to Top
he clicks the menu item and the "Create Report" dialog box is displayed
here's its screen shot

Go to Top
the Browse buttons opens a dialog box similar to the "Open" dialog box in Windows
he decides to use "E:\soapuidoc", a folder he earlier created to save all his documentation
after clicking the "Open" button from the "Open" dialog box
- the "Open" dialog box disappears and the folder he has chosen is displayed in the "Output Folder:" text box in the "Create Report" dialog box

Go to Top
a small "Progress" message box is briefly displayed
here's it's screen shot

Go to Top
here's it's screen shot

Go to Top
the file extension is .html, therefore displayed in a browser

Go to Top
he points out the first line: https://restcountries.eu
- he says: this is the actual URA
he then points to the line under the bulleted Resources
- the lines contents: https://restcountries.eu/rest/v2/name/india
- this is the actual request we are sending
and he says: the GET request we are sending
- note in this document, the text "GET" is under the word "Methods"
".com" will replace the ".eu", and the "/rest" folder will no longer be needed in the path

YouTube Videos

Go to Top
05:24 | May 05, 2020 | SoapUI API/Webservices Testing Part 1- Introduction & Installation on Windows
25:08 | May 06, 2020 | SoapUI API/Webservices Testing Part 2- How To Create First SOAP Project, Test Suite, Test Case
15:47 | May 07, 2020 | SoapUI API/Webservices Testing Part 3- How To Create First REST Project, Test Suite, Test Case
13:24 | May 08, 2020 | SoapUI API/Webservices Testing Part 4- Assertions : Contains & Not Contains

using the v1/film endpoint

REST Resources

Veezi | Veezi API Help - that simple documentation page for the 8 API calls
Oracle Help Center | REST API query parameters
SoapUI | Getting Started with REST Testing in SoapUI
SoapUI | Understanding REST Headers and Parameters
SoapUI | Getting started with Assertions
Google Search: api get parameters
Google Search: can i use Excel to send a REST GET request
XML Review from Blake's Veezi Learning Doc
reserve

Learned from Joe

Go to Top
Method: GET
Endpoint: https://api.us.veezi.com/v1/film
Header: VeeziAccessToken
Value: 19m3sgh48vcax1p9mmhp4dd87w

First you click the "+ Add header" in the "Authentication & Headers" tab
2 new text boxes show up, one under Header and another under value
- Header: Accept
- Value: application/xml