Repository navigation
Migration‐Guide‐ignoreHeader‐to‐withHeaders‐notice
Affects: Parameterized CSV scenarios | Deprecated in: v1.4.0 | Removed in: v1.4.1
- See detailed ACs in this issue https://github.com/authorjapps/zerocode/issues/743
- See this PR which implements this change https://github.com/authorjapps/zerocode/pull/755
ignoreHeader had confusing double-negative logic (ignoreHeader: false to enable headers and ignoreHeader: true to skip the first line if the headers didn't have pipes | | ).
The new withHeaders field says exactly what it does, so easy to interpret and use.
To keep things clean, we've also added support for standard (non-piped) headers. The legacy piped syntax | | is now deprecated and will be removed in a future release.
Step 1 — Search your scenario files (.json / .yaml) for ignoreHeader.
Step 2 — Replace using this mapping:
| Remove | Replace with | If |
|---|---|---|
"ignoreHeader": false |
"withHeaders": false |
First CSV row is data |
"ignoreHeader": false |
"withHeaders": true |
First CSV row is a header with piped syntax | | |
"ignoreHeader": true |
"withHeaders": true |
First CSV row is header without piped syntax | | |
Step 3 — Verify your scenarios run as before.
No other changes needed for existing index-based params (${0}, ${1} etc.) — they are unaffected.
Once migrated, you can reference external CSV columns by name instead of index:
"parameterized": {
"withHeaders": true,
"csvSource": "test-data/users.csv"
}Then in your steps:
"url": "/users/${PARAM.username}",
"assertions": {
"name": "${PARAM.fullname}",
"id": "(int)${PARAM.userid}"
}| Version | Status |
|---|---|
| v1.3.46 and below |
ignoreHeader only |
| v1.4.0 |
withHeaders introduced — ignoreHeader removed — migrate before upgrading - Piped syntax for headers deprecated (still works, logs a warning) |
| v1.4.1+ | Piped syntax for headers removed — migrate before upgrading |
❌ ignoreHeader will NOT work in v1.4.0+:
"parameterized": {
"ignoreHeader": true,
"csvSource":[
"USERID, USERNAME, ADDRESS, USERNO, ISADMIN",
"octocat, The Octocat, San Francisco, 583231, false"
]
}"parameterized": {
"withHeaders": true,
"csvSource":[
"|USERID|, |USERNAME|, |ADDRESS|, |USERNO|, |ISADMIN|",
"octocat, The Octocat, San Francisco, 583231, false"
]
}✅ The New Standard:
"parameterized": {
"withHeaders": true,
"csvSource":[
"USERID, USERNAME, ADDRESS, USERNO, ISADMIN",
"octocat, The Octocat, San Francisco, 583231, false"
]
}Notes:
- The same applies if the CSV is external.
- All users should set
"withHeaders": truein their scenarios if the CSV has headers (whether the headers have pipes | | or not)
Open an issue or start a Discussion if you run into any migration problems.
Visit the Zerocode Documentation Site for all usages.
-
User's Guide
-
Matchers
-
Zerocode Value Tokens
-
YAML DSL
-
Http Testing
- External JSON file content
- External YAML file content / YAML step-reuse
- Env Switching - CI,DIT,SIT etc
- Sending "Content-Type": "application/x-www-form-urlencoded"
- Http max implicit delay and connection timeout
- Retry mechanism
- File Upload Testing - Send POST request via form-data
- Sending bare JSON String in the body
-
Kafka Testing
- Introduction
- Produce, consume proto message
- Produce raw message
- Consume raw message
- Produce JSON message
- Consume JSON message
- Produce and consume XML message
- Kafka - consume the latest message or n latest messages
- Produce avro message
- Consume avro message
- KSQL in action
- Produce multiple records
- Produce from file
- Produce to a partition
- Produce and consume records with headers
- Produce n assert partition ack
- Comsume and dump to file
- commitSync vs commitAsync
- Overriding config inside a test
- Chosing String or Int or Avro Serializer
- Chosing String or Int or Avro Deserializer
- Attaching timestamp during load
- Default timestamp provided by Kafka
- Consume and assert avro schema metadata
- Error handling - produce via avro schema
- Sorting Kafka records consumed
-
DB Testing
-
Kotlin Testing
-
Performance Testing - Load and Stress
- Performance Testing - via awesome JUnit runners
- Load Vs Stress generation on target application
- Run a single test or a scenario in parallel
- Run multiple test scenarios in parallel - Production load simulation
- Dynamically change the payload for every request
- Analytics - Useful report(s) or statistics
-
Parameterized Testing
-
Docker
-
More+
-
Extensions
-
JUnit5 Jupiter Test
-
Questions And Answers(FAQ)
- What is Zerocode testing?
- SSL http https connections supported?
- How to assert array size Greater-Than Lesser-Than etc?
- How to invoke POST api?
- How to assert custom headers of the response?
- How to pass custom security token into the request header?
- When to use JUnit Suite runner and when Zerocode Package runner?
- How to execute DB SQL and assert?
- How to handle Http response other than utf-8 e.g. utf-16 or utf-32 ?
- Random Number Generator Placeholders Usages and Limits
- Automation tests for Zerocode lib itself
- Picking a leaf value from the array matching JSON Path
- Array assertions made easy, incl. size and element finder
-
Read Our Blogs
- Top 16 Open Source API Testing Tools For REST & SOAP Services - joecolantonio (Lists popular tools - Globally)
- OAuth2 Test Automation - DZone 2min Read
- Zero defect APIs - Build Pipe Line - Medium 10 min Read
- Develop ZeroDefect API's with ZeroCode! - Extreme Portal ( A must read for all developers and test engineers) 10min Read
- Performance testing using JUnit and maven - Codeproject 10 min Read
- REST API or SOAP End Point Testing - Codeproject 10min Read
- DZone- MuleSoft API Testing With Zerocode Test Framework - DZone 5min Read
- Testing need not be harder or slower, it should be easier and faster - DZone 5 min Read
- Kotlin Integration Testing simplified via Zerocode - Extreme portal 10 min Read
- and More...