Add Karate integration example with Testomat.io support #104
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Introduced a new Karate project with a Maven setup, including a `pom.xml` for dependencies. - Added a README.md detailing setup instructions, test scenarios, and integration steps. - Created feature files for testing the Swagger Petstore API with unique test IDs. - Implemented a test runner in Java to execute the Karate tests and generate JUnit XML reports.
DavertMik
requested changes
Aug 25, 2025
|
|
||
| # 3. Create pom.xml with Karate dependencies | ||
| cat > pom.xml << 'EOF' | ||
| <?xml version="1.0" encoding="UTF-8"?> |
Contributor
There was a problem hiding this comment.
why do we need to do things like that?
YevheniiVlasenko
requested changes
Aug 29, 2025
Contributor
YevheniiVlasenko
left a comment
YevheniiVlasenko
left a comment
There was a problem hiding this comment.
Good job! There are a few things to improve!
Comment on lines
+1
to
+11
| { | ||
| "permissions": { | ||
| "allow": [ | ||
| "mcp__context7__resolve-library-id", | ||
| "mcp__context7__get-library-docs", | ||
| "Bash(mkdir:*)" | ||
| ], | ||
| "deny": [], | ||
| "ask": [] | ||
| } | ||
| } No newline at end of file |
Contributor
There was a problem hiding this comment.
I think this does not belong here. It's local.
Comment on lines
+176
to
+191
|
|
||
| ``` | ||
| karate-example/ | ||
| ├── pom.xml | ||
| ├── README.md | ||
| └── src/ | ||
| └── test/ | ||
| ├── java/ | ||
| │ └── com/ | ||
| │ └── testomat/ | ||
| │ └── karate/ | ||
| │ └── KarateTest.java | ||
| └── resources/ | ||
| └── simple-api-test.feature | ||
| ``` | ||
|
|
Contributor
There was a problem hiding this comment.
If this structure refers to the project the user creates in the first part of the README, then it's wrong. If it does not then as a user I can't see where I get this from.
Comment on lines
+23
to
+110
| ## 🚀 Setup Framework From Scratch (In a Nutshell) | ||
|
|
||
| ### Quick Setup (5 minutes) | ||
|
|
||
| ```bash | ||
| # 1. Create project directory | ||
| mkdir my-karate-project | ||
| cd my-karate-project | ||
|
|
||
| # 2. Create Maven directory structure | ||
| mkdir -p src/test/java/com/example/karate | ||
| mkdir -p src/test/resources | ||
|
|
||
| # 3. Create pom.xml with Karate dependencies | ||
| cat > pom.xml << 'EOF' | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 | ||
| http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <groupId>com.example</groupId> | ||
| <artifactId>karate-project</artifactId> | ||
| <version>1.0.0</version> | ||
| <properties> | ||
| <maven.compiler.source>11</maven.compiler.source> | ||
| <maven.compiler.target>11</maven.compiler.target> | ||
| <karate.version>1.4.1</karate.version> | ||
| </properties> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>com.intuit.karate</groupId> | ||
| <artifactId>karate-junit5</artifactId> | ||
| <version>${karate.version}</version> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| </dependencies> | ||
| <build> | ||
| <testResources> | ||
| <testResource> | ||
| <directory>src/test/java</directory> | ||
| <excludes><exclude>**/*.java</exclude></excludes> | ||
| </testResource> | ||
| </testResources> | ||
| </build> | ||
| </project> | ||
| EOF | ||
|
|
||
| # 4. Create test runner | ||
| cat > src/test/java/com/example/karate/TestRunner.java << 'EOF' | ||
| package com.example.karate; | ||
| import com.intuit.karate.Results; | ||
| import com.intuit.karate.Runner; | ||
| import org.junit.jupiter.api.Test; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| public class TestRunner { | ||
| @Test | ||
| void testAll() { | ||
| Results results = Runner.path("classpath:") | ||
| .outputJunitXml(true) | ||
| .parallel(1); | ||
| assertTrue(results.getFailCount() == 0, results.getErrorMessages()); | ||
| } | ||
| } | ||
| EOF | ||
|
|
||
| # 5. Create your first .feature file | ||
| cat > src/test/resources/sample-test.feature << 'EOF' | ||
| Feature: Sample API Test | ||
|
|
||
| Background: | ||
| * url 'https://petstore.swagger.io/v2' | ||
|
|
||
| Scenario Outline: Get pet - <testCase> @<testId> | ||
| Given path 'pet', <petId> | ||
| When method get | ||
| Then status <expectedStatus> | ||
|
|
||
| Examples: | ||
| | testCase | petId | expectedStatus | testId | | ||
| | existing | 1 | 200 | T1a2b3c4d | | ||
| | nonexistent | 999 | 404 | T5e6f7g8h | | ||
| EOF | ||
|
|
||
| # 6. Run your first test | ||
| mvn test | ||
| ``` |
Contributor
There was a problem hiding this comment.
As it's a demo project that will not be or will be rarely updated, I would rather do this using Maven Archetype or, simpler, tell the user to clone the project with a ready-to-use structure. Both ways are more user-friendly and faster to use.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
pom.xmlfor dependencies.