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
161
162
|
// Copyright 2022 Code Intelligence GmbH
//
// Licensed 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 com.code_intelligence.jazzer.junit;
import static com.google.common.truth.Truth.assertThat;
import static com.google.common.truth.Truth8.assertThat;
import static org.junit.Assume.assumeFalse;
import static org.junit.Assume.assumeTrue;
import static org.junit.platform.engine.discovery.DiscoverySelectors.selectClass;
import static org.junit.platform.testkit.engine.EventConditions.container;
import static org.junit.platform.testkit.engine.EventConditions.displayName;
import static org.junit.platform.testkit.engine.EventConditions.event;
import static org.junit.platform.testkit.engine.EventConditions.finishedSuccessfully;
import static org.junit.platform.testkit.engine.EventConditions.finishedWithFailure;
import static org.junit.platform.testkit.engine.EventConditions.test;
import static org.junit.platform.testkit.engine.EventConditions.type;
import static org.junit.platform.testkit.engine.EventConditions.uniqueIdSubstrings;
import static org.junit.platform.testkit.engine.EventType.DYNAMIC_TEST_REGISTERED;
import static org.junit.platform.testkit.engine.EventType.FINISHED;
import static org.junit.platform.testkit.engine.EventType.REPORTING_ENTRY_PUBLISHED;
import static org.junit.platform.testkit.engine.EventType.STARTED;
import static org.junit.platform.testkit.engine.TestExecutionResultConditions.instanceOf;
import com.code_intelligence.jazzer.api.FuzzerSecurityIssueMedium;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.stream.Stream;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.platform.testkit.engine.EngineExecutionResults;
import org.junit.platform.testkit.engine.EngineTestKit;
import org.junit.rules.TemporaryFolder;
public class DirectoryInputsTest {
private static final String ENGINE = "engine:junit-jupiter";
private static final String CLAZZ = "class:com.example.DirectoryInputsFuzzTest";
private static final String INPUTS_FUZZ =
"test-template:inputsFuzz(com.code_intelligence.jazzer.api.FuzzedDataProvider)";
private static final String INVOCATION = "test-template-invocation:#";
@Rule public TemporaryFolder temp = new TemporaryFolder();
Path baseDir;
@Before
public void setup() {
baseDir = temp.getRoot().toPath();
}
@Test
public void fuzzingEnabled() throws IOException {
assumeFalse(System.getenv("JAZZER_FUZZ").isEmpty());
// Create a fake test resource directory structure with an inputs directory to verify that
// Jazzer uses it and emits a crash file into it.
Path inputsDirectory = baseDir.resolve(Paths.get("src", "test", "resources", "com", "example",
"DirectoryInputsFuzzTestInputs", "inputsFuzz"));
Files.createDirectories(inputsDirectory);
EngineExecutionResults results =
EngineTestKit.engine("junit-jupiter")
.selectors(selectClass("com.example.DirectoryInputsFuzzTest"))
.configurationParameter("jazzer.internal.basedir", baseDir.toAbsolutePath().toString())
.execute();
results.containerEvents().assertEventsMatchExactly(event(type(STARTED), container(ENGINE)),
event(type(STARTED), container(uniqueIdSubstrings(ENGINE, CLAZZ))),
event(type(STARTED), container(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ))),
event(type(FINISHED), container(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ)),
finishedSuccessfully()),
event(type(FINISHED), container(uniqueIdSubstrings(ENGINE, CLAZZ)), finishedSuccessfully()),
event(type(FINISHED), container(ENGINE), finishedSuccessfully()));
results.testEvents().assertEventsMatchExactly(
event(type(DYNAMIC_TEST_REGISTERED), test(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ))),
event(type(STARTED), test(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ, INVOCATION + 1))),
event(type(FINISHED), test(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ, INVOCATION + 1)),
displayName("<empty input>"), finishedSuccessfully()),
event(type(DYNAMIC_TEST_REGISTERED), test(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ))),
event(type(STARTED), test(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ, INVOCATION + 2))),
event(type(FINISHED), test(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ, INVOCATION + 2)),
displayName("seed"), finishedWithFailure(instanceOf(FuzzerSecurityIssueMedium.class))),
event(type(DYNAMIC_TEST_REGISTERED), test(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ))),
event(type(STARTED), test(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ, INVOCATION + 3)),
displayName("Fuzzing...")),
event(type(FINISHED), test(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ, INVOCATION + 3)),
displayName("Fuzzing..."),
finishedWithFailure(instanceOf(FuzzerSecurityIssueMedium.class))));
// Should crash on the exact input "directory" as provided by the seed, with the crash emitted
// into the seed corpus.
try (Stream<Path> crashFiles = Files.list(baseDir).filter(
path -> path.getFileName().toString().startsWith("crash-"))) {
assertThat(crashFiles).isEmpty();
}
try (Stream<Path> seeds = Files.list(inputsDirectory)) {
assertThat(seeds).containsExactly(
inputsDirectory.resolve("crash-8d392f56d616a516ceabb82ed8906418bce4647d"));
}
assertThat(Files.readAllBytes(
inputsDirectory.resolve("crash-8d392f56d616a516ceabb82ed8906418bce4647d")))
.isEqualTo("directory".getBytes(StandardCharsets.UTF_8));
// Verify that the engine created the generated corpus directory. Since the crash was found on a
// seed, it should be empty.
Path generatedCorpus = baseDir.resolve(
Paths.get(".cifuzz-corpus", "com.example.DirectoryInputsFuzzTest", "inputsFuzz"));
assertThat(Files.isDirectory(generatedCorpus)).isTrue();
try (Stream<Path> entries = Files.list(generatedCorpus)) {
assertThat(entries).isEmpty();
}
}
@Test
public void fuzzingDisabled() {
assumeTrue(System.getenv("JAZZER_FUZZ").isEmpty());
EngineExecutionResults results =
EngineTestKit.engine("junit-jupiter")
.selectors(selectClass("com.example.DirectoryInputsFuzzTest"))
.execute();
results.containerEvents().assertEventsMatchExactly(event(type(STARTED), container(ENGINE)),
event(type(STARTED), container(uniqueIdSubstrings(ENGINE, CLAZZ))),
event(type(STARTED), container(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ))),
event(type(REPORTING_ENTRY_PUBLISHED),
container(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ))),
event(type(FINISHED), container(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ))),
event(type(FINISHED), container(uniqueIdSubstrings(ENGINE, CLAZZ)), finishedSuccessfully()),
event(type(FINISHED), container(ENGINE), finishedSuccessfully()));
results.testEvents().assertEventsMatchExactly(
event(type(DYNAMIC_TEST_REGISTERED), test(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ))),
event(type(STARTED), test(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ, INVOCATION + 1))),
event(type(FINISHED), test(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ, INVOCATION + 1)),
displayName("<empty input>"), finishedSuccessfully()),
event(type(DYNAMIC_TEST_REGISTERED), test(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ))),
event(type(STARTED), test(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ, INVOCATION + 2))),
event(type(FINISHED), test(uniqueIdSubstrings(ENGINE, CLAZZ, INPUTS_FUZZ, INVOCATION + 2)),
displayName("seed"), finishedWithFailure(instanceOf(FuzzerSecurityIssueMedium.class))));
// Verify that the generated corpus directory hasn't been created.
Path generatedCorpus =
baseDir.resolve(Paths.get(".cifuzz-corpus", "com.example.DirectoryInputsFuzzTest"));
assertThat(Files.notExists(generatedCorpus)).isTrue();
}
}
|
