Skip to content

Add java-diff-utils support #1160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add java-diff-utils support #1160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,3 +240,19 @@ Usage example:
Awaitility.setDefaultConditionEvaluationListener(new AllureAwaitilityListener());
```

## Java-diff-utils
This library provides advanced data logging in allure when using `java-diff-utils`.
For more usage example look into module `allure-java-diff-utils`

```xml
<dependency>
<groupId>io.qameta.allure</groupId>
<artifactId>allure-java-diff-utils</artifactId>
<version>$LATEST_VERSION</version>
</dependency>
```

Usage example:
```java
new AllureDiff().diff("my first line\nmy second line", "my first line");
```
28 changes: 28 additions & 0 deletions allure-java-diff-utils/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
description = "Allure java-diff-utils integration"

val javaDiffUtils = "4.15"

dependencies {
api(project(":allure-attachments"))
implementation("io.github.java-diff-utils:java-diff-utils:$javaDiffUtils")
testImplementation("javax.annotation:javax.annotation-api")
testImplementation("org.assertj:assertj-core")
testImplementation("org.junit.jupiter:junit-jupiter-api")
testImplementation("org.junit.jupiter:junit-jupiter-params")
testImplementation("org.slf4j:slf4j-simple")
testImplementation(project(":allure-java-commons-test"))
testImplementation(project(":allure-junit-platform"))
testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")
}

tasks.jar {
manifest {
attributes(mapOf(
"Automatic-Module-Name" to "io.qameta.allure.diff"
))
}
}

tasks.test {
useJUnitPlatform()
}
262 changes: 262 additions & 0 deletions allure-java-diff-utils/examples/diff-two-jsons.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,262 @@

<head>
<meta charset="UTF-8">
<title>Diff</title>
<style>
.no-changes-footer {
padding: 12px;
margin: 8px;
background: #e8f5e9;
color: #2e7d32;
border: 1px solid #c8e6c9;
border-radius: 4px;
font-family: sans-serif;
font-size: 14px;
text-align: center;
}

.diff-line {
display: flex;
font-family: monospace;
white-space: pre;
margin: 0;
padding: 0;
line-height: 1.5;
font-size: 13px;
align-items: center;
}

.line-number {
width: 80px;
flex-shrink: 0;
color: #666;
padding: 0 10px;
text-align: right;
background: #f5f5f5;
height: 100%;
box-sizing: border-box;
}

.original-line {
border-right: 1px solid #eee;
}

.content {
padding: 0 8px;
flex-grow: 1;
white-space: pre-wrap;
}

.ADDED {
background-color: #ccffcc;
}

.REMOVED {
background-color: #ffcccc;
}

.UNCHANGED {
background-color: #f8f8f8;
}

.hidden {
display: none !important;
}

body {
margin: 0;
padding: 0;
}

.controls label {
margin-right: 12px;
cursor: pointer;
user-select: none;
}

.controls {
display: flex;
gap: 15px;
align-items: center;
margin-bottom: 8px;
padding: 8px;
background: #f8f8f8;
border-bottom: 1px solid #ddd;
font-family: sans-serif;
font-size: 13px;
}

.controls button {
padding: 4px 8px;
background: #e0e0e0;
border: 1px solid #ccc;
border-radius: 3px;
cursor: pointer;
font-size: 13px;
}

.controls button:hover {
background: #d0d0d0;
}

.copy-feedback {
color: #008000;
font-size: 12px;
margin-left: 8px;
display: none;
}
</style>
</head>

<body>
<div class="controls">
<div class="toggle-group">
<label>
<input type="checkbox" checked onclick="toggleVisibility('ADDED')"> Added
</label>
<label>
<input type="checkbox" checked onclick="toggleVisibility('REMOVED')"> Removed
</label>
<label>
<input type="checkbox" checked onclick="toggleVisibility('UNCHANGED')"> Context
</label>
<label>
<input type="checkbox" checked onclick="toggleLineNumbers()"> Numbers
</label>
</div>
<div class="copy-group">
<button onclick="copyText()">Copy</button>
<span class="copy-feedback" id="copyFeedback"></span>
</div>
</div>



<div class="diff-container">
<div class="diff-line UNCHANGED">
<div class="line-number original-line">1</div>
<div class="line-number revised-line">1</div>
<div class="content">{</div>
</div>
<div class="diff-line UNCHANGED">
<div class="line-number original-line">2</div>
<div class="line-number revised-line">2</div>
<div class="content"> &quot;id&quot;: 123,</div>
</div>
<div class="diff-line UNCHANGED">
<div class="line-number original-line">3</div>
<div class="line-number revised-line">3</div>
<div class="content"> &quot;name&quot;: &quot;John Doe&quot;,</div>
</div>
<div class="diff-line UNCHANGED">
<div class="line-number original-line">4</div>
<div class="line-number revised-line">4</div>
<div class="content"> &quot;email&quot;: &quot;[email protected]&quot;,</div>
</div>
<div class="diff-line UNCHANGED">
<div class="line-number original-line">5</div>
<div class="line-number revised-line">5</div>
<div class="content"> &quot;isActive&quot;: true,</div>
</div>
<div class="diff-line UNCHANGED">
<div class="line-number original-line">6</div>
<div class="line-number revised-line">6</div>
<div class="content"> &quot;roles&quot;: [</div>
</div>
<div class="diff-line UNCHANGED">
<div class="line-number original-line">7</div>
<div class="line-number revised-line">7</div>
<div class="content"> &quot;admin&quot;,</div>
</div>
<div class="diff-line UNCHANGED">
<div class="line-number original-line">8</div>
<div class="line-number revised-line">8</div>
<div class="content"> &quot;user&quot;</div>
</div>
<div class="diff-line UNCHANGED">
<div class="line-number original-line">9</div>
<div class="line-number revised-line">9</div>
<div class="content"> ],</div>
</div>
<div class="diff-line UNCHANGED">
<div class="line-number original-line">10</div>
<div class="line-number revised-line">10</div>
<div class="content"> &quot;address&quot;: {</div>
</div>
<div class="diff-line REMOVED">
<div class="line-number original-line">11</div>
<div class="line-number revised-line">-</div>
<div class="content"> &quot;street&quot;: &quot;123 Main St&quot;,</div>
</div>
<div class="diff-line REMOVED">
<div class="line-number original-line">13</div>
<div class="line-number revised-line">-</div>
<div class="content"> &quot;zipcode&quot;: &quot;10001&quot;</div>
</div>
<div class="diff-line ADDED">
<div class="line-number original-line">-</div>
<div class="line-number revised-line">11</div>
<div class="content"> &quot;city&quot;: &quot;New York&quot;,</div>
</div>
<div class="diff-line REMOVED">
<div class="line-number original-line">14</div>
<div class="line-number revised-line">-</div>
<div class="content"> }</div>
</div>
<div class="diff-line ADDED">
<div class="line-number original-line">-</div>
<div class="line-number revised-line">12</div>
<div class="content"> &quot;zipcode&quot;: &quot;10001&quot;,</div>
</div>
<div class="diff-line REMOVED">
<div class="line-number original-line">15</div>
<div class="line-number revised-line">-</div>
<div class="content">}</div>
</div>
<div class="diff-line ADDED">
<div class="line-number original-line">-</div>
<div class="line-number revised-line">13</div>
<div class="content"> &quot;additional&quot;: &quot;test&quot;</div>
</div>
<div class="diff-line ADDED">
<div class="line-number original-line">-</div>
<div class="line-number revised-line">14</div>
<div class="content"> }</div>
</div>
<div class="diff-line ADDED">
<div class="line-number original-line">-</div>
<div class="line-number revised-line">15</div>
<div class="content">}</div>
</div>
</div>

<script>
function showFeedback(message) {
const feedback = document.getElementById('copyFeedback');
feedback.textContent = message;
feedback.style.display = 'inline';
setTimeout(() => feedback.style.display = 'none', 2000);
}

function copyText() {
const visibleContents = document.querySelectorAll('.diff-line:not(.hidden) .content');
const lines = Array.from(visibleContents).map(content => content.innerText);

navigator.clipboard.writeText(lines.join('\n'))
.then(() => showFeedback('Text copied!'))
.catch(err => console.error('Copy failed', err));
}

function toggleVisibility(className) {
document.querySelectorAll(`.${className}`).forEach(element => {
element.classList.toggle('hidden');
});
}

function toggleLineNumbers() {
document.querySelectorAll('.line-number').forEach(element => {
element.classList.toggle('hidden');
});
}
</script>
</body>
Loading
Loading