How nyk5073/api-automation-with-karate-dsl works
Project type and purpose
• This is a test‐automation project using the Karate framework to perform API testing against a sample “Conduit” application.
• Its primary function is to drive HTTP requests via feature files (DSL), apply assertions in Java/Karate, and produce test reports.
File structure
• Top‐level files:
• pom.xml – Maven build and dependency management, Surefire plugin configuration.
• README.md – project description and instructions.
• src/test/java/karate-config.js – global Karate configuration (base URL, credentials).
• src/test/java/logback-test.xml – logging configuration for test execution.
• src/test/java/conduitApp/
• ConduitTest.java – Java test harness invoking Karate features.
• feature/HomePage.feature & User.feature – scenario definitions for endpoints.
• src/test/java/helpers/
• CreateUser.feature – reusable feature (caller can “call” it).
• DataGenerator.java – utility class generating fake data via JavaFaker.
• target/karate-reports & surefire-reports – generated HTML/JSON test reports.
README for additional insights
• Dependencies: Karate framework, JavaFaker library.
• Execution via mvn test → Surefire runs JUnit which invokes Karate DSL.
• Output: detailed reports in target directories.
a. Main components
1. Maven Surefire Test Runner (pom.xml)
2. JUnit/Java Harness (ConduitTest.java)
3. Karate Engine & DSL Processor
4. Feature Files (HomePage.feature, User.feature, CreateUser.feature)
5. Helpers (DataGenerator.java)
6. Configuration (karate-config.js, logback-test.xml)
7. System under Test (Conduit REST API endpoints)
8. Reporting Module (karate-reports, surefire-reports)
9. External libraries (JavaFaker)
b. Relationships & interactions
• Maven Surefire triggers JUnit ConduitTest.java.
• ConduitTest invokes Karate Engine, which:
• Loads karate-config.js → sets base URL, timeouts.
• Parses and executes feature files.
• Invokes helper feature (CreateUser) or DataGenerator for test data.
• Karate Engine issues HTTP requests to the Conduit API.
• Responses return to Karate Engine → assertions evaluate pass/fail.
• Karate Engine writes logs (configured by logback-test.xml).
• Results are aggregated into HTML/JSON under target/karate-reports and surefire-reports.
c. Architectural patterns and design principles
• Test layering: Configuration → DSL feature definitions → Test runner harness → SUT.
• Reusability: helper feature and data generator for DRY test code.
• Separation of concerns: config, test logic, data generation, reporting.
d. Technologies & frameworks
• Java 17+, Maven 3.11.0+, Karate framework, JavaFaker, JUnit/Surefire, Logback.
Elements
• Clear labels for each component.
• Maven → JUnit → Karate Engine → SUT → Karate Engine → Reports.
• Karate Engine ↔ Helper Utilities.
• Rectangles for code modules (feature files, Java classes).