Handling empty cells and using null in Examples from a CSV file

The problem involves handling empty cells and using null in ‘Examples’.

Our test data is read from CSV files with various combinations, and not all values are always present in the columns (specifically benchmarks to be compared with response values).

The comparison needs to be conditional:

  • If a value is not present in the CSV, the comparison should be skipped.
  • If a value is present, we need to read the response key and perform the comparison.

Yes, when you use a CSV file, it is a little harder to pre-process so that empty values are handled the way you expect. But it is possible, note that all the examples below can be tried locally, just cut and paste them into local / feature files.

First let us see how to do this in a “normal” Examples block and see the difference later:

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>Feature: using nulls and inline json
Scenario Outline:
Given url 'https://reqres.in/api'
And path 'register'
And request { email: '#(email)', password: '#(password)' }
When method post
Then status 400
* print response
* match response == errorResponse
Examples:
| email! | password! | errorResponse! |
| null | null | { error: 'Missing email or username' } |
| 'aa' | 'bb' | { error: 'Note: Only defined users succeed registration' } |
</code>
<code>Feature: using nulls and inline json Scenario Outline: Given url 'https://reqres.in/api' And path 'register' And request { email: '#(email)', password: '#(password)' } When method post Then status 400 * print response * match response == errorResponse Examples: | email! | password! | errorResponse! | | null | null | { error: 'Missing email or username' } | | 'aa' | 'bb' | { error: 'Note: Only defined users succeed registration' } | </code>
Feature: using nulls and inline json

  Scenario Outline:
    Given url 'https://reqres.in/api'
    And path 'register'
    And request { email: '#(email)', password: '#(password)' }
    When method post
    Then status 400
    * print response
    * match response == errorResponse

    Examples:
      | email! | password! | errorResponse!                                             |
      | null   | null      | { error: 'Missing email or username' }                     |
      | 'aa'   | 'bb'      | { error: 'Note: Only defined users succeed registration' } |

Note how the column names are suffixed with ! so that things like null are processed correctly instead of the default '' or empty-string. But when you use a CSV as the data-source, you need to do the pre-processing manually. Fortunately this is easy by using a @setup Scenario:

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>Feature: converting empty cells to null from a csv
@setup
Scenario:
* def raw = read('examples.csv')
* def convert = x => x || null
* def data = raw.map(x => ({ email: convert(x.email), password: convert(x.password), error: x.error }))
Scenario Outline:
Given url 'https://reqres.in/api'
And path 'register'
And request { email: '#(email)', password: '#(password)' }
When method post
Then status 400
* print response
* match response == { error: '#(error)' }
Examples:
| karate.setup().data |
</code>
<code>Feature: converting empty cells to null from a csv @setup Scenario: * def raw = read('examples.csv') * def convert = x => x || null * def data = raw.map(x => ({ email: convert(x.email), password: convert(x.password), error: x.error })) Scenario Outline: Given url 'https://reqres.in/api' And path 'register' And request { email: '#(email)', password: '#(password)' } When method post Then status 400 * print response * match response == { error: '#(error)' } Examples: | karate.setup().data | </code>
Feature: converting empty cells to null from a csv

  @setup
  Scenario:
    * def raw = read('examples.csv')
    * def convert = x => x || null
    * def data = raw.map(x => ({ email: convert(x.email), password: convert(x.password), error: x.error }))

  Scenario Outline:
    Given url 'https://reqres.in/api'
    And path 'register'
    And request { email: '#(email)', password: '#(password)' }
    When method post
    Then status 400
    * print response
    * match response == { error: '#(error)' }

    Examples:
      | karate.setup().data |

For the above example, the contents of examples.csv are the following:

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>email,password,error
,,Missing email or username
aa,bb,Note: Only defined users succeed registration
</code>
<code>email,password,error ,,Missing email or username aa,bb,Note: Only defined users succeed registration </code>
email,password,error
,,Missing email or username
aa,bb,Note: Only defined users succeed registration

And for completeness, the other way of “looping” in the Karate world is this way:

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>Feature: looping over a json array converted from a csv
Scenario:
* def raw = read('examples.csv')
* def convert = x => x || null
* def data = raw.map(x => ({ email: convert(x.email), password: convert(x.password), error: x.error }))
* call read('@register') data
@ignore @register
Scenario:
Given url 'https://reqres.in/api'
And path 'register'
And request { email: '#(email)', password: '#(password)' }
When method post
Then status 400
* print response
* match response == { error: '#(error)' }
</code>
<code>Feature: looping over a json array converted from a csv Scenario: * def raw = read('examples.csv') * def convert = x => x || null * def data = raw.map(x => ({ email: convert(x.email), password: convert(x.password), error: x.error })) * call read('@register') data @ignore @register Scenario: Given url 'https://reqres.in/api' And path 'register' And request { email: '#(email)', password: '#(password)' } When method post Then status 400 * print response * match response == { error: '#(error)' } </code>
Feature: looping over a json array converted from a csv

  Scenario:
    * def raw = read('examples.csv')
    * def convert = x => x || null
    * def data = raw.map(x => ({ email: convert(x.email), password: convert(x.password), error: x.error }))
    * call read('@register') data

  @ignore @register
  Scenario:
    Given url 'https://reqres.in/api'
    And path 'register'
    And request { email: '#(email)', password: '#(password)' }
    When method post
    Then status 400
    * print response
    * match response == { error: '#(error)' }

Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa Dịch vụ tổ chức sự kiện 5 sao Thông tin về chúng tôi Dịch vụ sinh nhật bé trai Dịch vụ sinh nhật bé gái Sự kiện trọn gói Các tiết mục giải trí Dịch vụ bổ trợ Tiệc cưới sang trọng Dịch vụ khai trương Tư vấn tổ chức sự kiện Hình ảnh sự kiện Cập nhật tin tức Liên hệ ngay Thuê chú hề chuyên nghiệp Tiệc tất niên cho công ty Trang trí tiệc cuối năm Tiệc tất niên độc đáo Sinh nhật bé Hải Đăng Sinh nhật đáng yêu bé Khánh Vân Sinh nhật sang trọng Bích Ngân Tiệc sinh nhật bé Thanh Trang Dịch vụ ông già Noel Xiếc thú vui nhộn Biểu diễn xiếc quay đĩa Dịch vụ tổ chức tiệc uy tín Khám phá dịch vụ của chúng tôi Tiệc sinh nhật cho bé trai Trang trí tiệc cho bé gái Gói sự kiện chuyên nghiệp Chương trình giải trí hấp dẫn Dịch vụ hỗ trợ sự kiện Trang trí tiệc cưới đẹp Khởi đầu thành công với khai trương Chuyên gia tư vấn sự kiện Xem ảnh các sự kiện đẹp Tin mới về sự kiện Kết nối với đội ngũ chuyên gia Chú hề vui nhộn cho tiệc sinh nhật Ý tưởng tiệc cuối năm Tất niên độc đáo Trang trí tiệc hiện đại Tổ chức sinh nhật cho Hải Đăng Sinh nhật độc quyền Khánh Vân Phong cách tiệc Bích Ngân Trang trí tiệc bé Thanh Trang Thuê dịch vụ ông già Noel chuyên nghiệp Xem xiếc khỉ đặc sắc Xiếc quay đĩa thú vị
Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa
Thiết kế website Thiết kế website Thiết kế website Cách kháng tài khoản quảng cáo Mua bán Fanpage Facebook Dịch vụ SEO Tổ chức sinh nhật