Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abhivaikar/vanillacheck
A vanilla and simple test runner written in Java for writing automated tests.
https://github.com/abhivaikar/vanillacheck
java test-automation unit-testing
Last synced: about 13 hours ago
JSON representation
A vanilla and simple test runner written in Java for writing automated tests.
- Host: GitHub
- URL: https://github.com/abhivaikar/vanillacheck
- Owner: abhivaikar
- Created: 2024-12-10T08:17:09.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-10T09:20:11.000Z (2 months ago)
- Last Synced: 2025-02-06T13:54:54.993Z (4 days ago)
- Topics: java, test-automation, unit-testing
- Language: Java
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VanillaCheck
Hi there! I'm working on this project, **VanillaCheck**, as an exercise to better understand how testing frameworks like JUnit or TestNG are created. This is not meant to compete with those frameworks; it's just a simple and experimental attempt to build something from scratch to learn the core concepts behind test discovery, execution, and reporting.
---
## Why I Created VanillaCheck
I’ve always been fascinated by how popular testing frameworks make writing and running tests so seamless. To understand the inner workings, I decided to create my own basic test runner. The goal is to explore:
- **How tests are discovered automatically using annotations.**
- **How hooks like setup and teardown are implemented.**
- **How results are captured and presented.**
This project is my way of diving deeper into those concepts and experimenting with a lightweight test runner.
---
## What VanillaCheck Does
VanillaCheck is a minimal test runner that:
1. Automatically discovers test methods in a class using custom annotations.
2. Executes tests sequentially with before and after hooks.
3. Generates test result reports in three formats:
- Console output
- JSON file
- HTML file (styled with Bootstrap)
---
## Features
- **Custom Annotations**:
- `@AutoTest`: Marks a method as a test.
- `@BeforeAutoTest`: Marks a method to run before each test.
- `@AfterAutoTest`: Marks a method to run after each test.
- **Simple Test Execution**:
- Tests are discovered and executed in sequence.
- Failures in one test don’t stop others from running.
- **Report Generation**:
- A clean JSON file summarizing the results.
- A Bootstrap-styled HTML report for easy viewing.
---
## How It Works
Here’s a simple example of how to use VanillaCheck:
### Write a Test Class
```java
package com.vanillacheck.tests;
import com.vanillacheck.annotations.AutoTest;
import com.vanillacheck.annotations.BeforeAutoTest;
import com.vanillacheck.annotations.AfterAutoTest;
import org.assertj.core.api.Assertions;
public class YourTestClass {
@BeforeAutoTest
public void setup() {
System.out.println("Before each test");
}
@AutoTest
public void testExamplePass() {
Assertions.assertThat(1 + 1).isEqualTo(2);
}
@AutoTest
public void testExampleFail() {
Assertions.assertThat(1 + 1).isEqualTo(3);
}
@AfterAutoTest
public void teardown() {
System.out.println("After each test");
}
}
```
### Run the Tests
The `TestRunner` class is responsible for running your tests:
```java
public class TestRunner {
public static void main(String[] args) {
TestRunner runner = new TestRunner();
List results = runner.runTests(YourTestClass.class);
runner.displayResults(results);
runner.writeJsonReport(results, "test-results.json");
runner.writeHtmlReport(results, "test-report.html");
}
}
```
---
## What You’ll See
### **1. Console Output**
VanillaCheck prints a summary of the test results in the console:
```plaintext
=== Test Summary ===
Total tests run: 2
Passed: 1
Failed: 1
====================
Detailed Results:
Test: testExamplePass | Status: PASS
Test: testExampleFail | Status: FAIL
Reason: expected:<3> but was:<2>
```
### **2. JSON Report (`test-results.json`)**
The results are also written to a JSON file for structured analysis:
```json
[
{
"testName": "testExamplePass",
"status": "PASS",
"exceptionMessage": null,
"executionTime": 5
},
{
"testName": "testExampleFail",
"status": "FAIL",
"exceptionMessage": "expected:<3> but was:<2>",
"executionTime": 7
}
]
```
### **3. HTML Report (`test-report.html`)**
The HTML report provides a visually appealing summary of test results, styled with Bootstrap:
- **Total tests**, **passed**, and **failed** are displayed in a table.
- Each test includes its name, status, exception (if any), and execution time.