1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.openxml4j.opc;
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.Set;
import java.util.TreeMap;
import org.apache.commons.compress.archivers.ArchiveEntry;
import org.apache.commons.compress.archivers.zip.ZipArchiveInputStream;
import org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream;
import org.apache.poi.util.IOUtils;
import org.junit.jupiter.api.Assertions;
import org.xmlunit.builder.DiffBuilder;
import org.xmlunit.builder.Input;
import org.xmlunit.diff.Comparison;
import org.xmlunit.diff.ComparisonResult;
import org.xmlunit.diff.DefaultNodeMatcher;
import org.xmlunit.diff.Diff;
import org.xmlunit.diff.DifferenceEvaluator;
import org.xmlunit.diff.ElementSelectors;
/**
* Compare the contents of 2 zip files.
*/
public final class ZipFileAssert {
private ZipFileAssert() {
}
private static void equals(
TreeMap<String, UnsynchronizedByteArrayOutputStream> file1,
TreeMap<String, UnsynchronizedByteArrayOutputStream> file2) {
Set<String> listFile1 = file1.keySet();
Assertions.assertEquals(listFile1.size(), file2.keySet().size(), "not the same number of files in zip:");
for (String fileName : listFile1) {
// extract the contents for both
UnsynchronizedByteArrayOutputStream contain1 = file1.get(fileName);
UnsynchronizedByteArrayOutputStream contain2 = file2.get(fileName);
assertNotNull(contain2, fileName + " not found in 2nd zip");
// no need to check for contain1. The key come from it
if (fileName.matches(".*\\.(xml|rels)$")) {
// we have a xml file
final Diff diff = DiffBuilder.
compare(Input.fromByteArray(contain1.toByteArray())).
withTest(Input.fromByteArray(contain2.toByteArray())).
ignoreWhitespace().
checkForSimilar().
withDifferenceEvaluator(new IgnoreXMLDeclEvaluator()).
withNodeMatcher(new DefaultNodeMatcher(ElementSelectors.byNameAndAllAttributes, ElementSelectors.byNameAndText)).
build();
assertFalse(diff.hasDifferences(), fileName+": "+ diff);
} else {
// not xml, may be an image or other binary format
Assertions.assertEquals(contain1.size(), contain2.size(), fileName + " does not have the same size in both zip:");
assertArrayEquals(contain1.toByteArray(), contain2.toByteArray(), "contents differ");
}
}
}
private static TreeMap<String, UnsynchronizedByteArrayOutputStream> decompress(
File filename) throws IOException {
// store the zip content in memory
// let s assume it is not Go ;-)
TreeMap<String, UnsynchronizedByteArrayOutputStream> zipContent = new TreeMap<>();
try (
/* Open file to decompress */
FileInputStream file_decompress = new FileInputStream(filename);
/* Create a buffer for the decompressed files */
BufferedInputStream buffi = new BufferedInputStream(file_decompress);
/* Open the file with the buffer */
ZipArchiveInputStream zis = new ZipArchiveInputStream(buffi)
) {
/* Processing entries of the zip file */
ArchiveEntry entree;
while ((entree = zis.getNextEntry()) != null) {
/* Create an array for the current entry */
UnsynchronizedByteArrayOutputStream byteArray = UnsynchronizedByteArrayOutputStream.builder().get();
IOUtils.copy(zis, byteArray);
zipContent.put(entree.getName(), byteArray);
}
}
return zipContent;
}
/**
* Asserts that two files are equal. Throws an {@code AssertionFailedError}
* if they are not.
*/
public static void assertEquals(File expected, File actual) {
assertNotNull(expected);
assertNotNull(actual);
assertTrue(expected.exists(), "File does not exist [" + expected.getAbsolutePath() + "]");
assertTrue(actual.exists(), "File does not exist [" + actual.getAbsolutePath() + "]");
assertTrue(expected.canRead(), "Expected file not readable");
assertTrue(actual.canRead(), "Actual file not readable");
assertDoesNotThrow(() -> equals(decompress(expected), decompress(actual)));
}
private static class IgnoreXMLDeclEvaluator implements DifferenceEvaluator {
@Override
public ComparisonResult evaluate(final Comparison comparison, final ComparisonResult outcome) {
if (outcome != ComparisonResult.EQUAL) {
// only evaluate differences
switch (comparison.getType()) {
case CHILD_NODELIST_SEQUENCE:
case XML_STANDALONE:
case NAMESPACE_PREFIX:
return ComparisonResult.SIMILAR;
case TEXT_VALUE:
switch (comparison.getControlDetails().getTarget().getParentNode().getNodeName()) {
case "dcterms:created":
case "dc:creator":
return ComparisonResult.SIMILAR;
}
break;
default:
break;
}
}
return outcome;
}
}
}
|
