-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
ValidationProblemSerializationTest.groovy
204 lines (174 loc) · 7.55 KB
/
ValidationProblemSerializationTest.groovy
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/*
* Copyright 2023 the original author or authors.
*
* 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 org.gradle.plugin.devel.tasks.internal
import com.google.common.collect.HashMultimap
import com.google.gson.Gson
import org.gradle.api.problems.Severity
import org.gradle.api.problems.internal.DefaultProblemReporter
import org.gradle.api.problems.internal.DocLink
import org.gradle.api.problems.internal.GradleCoreProblemGroup
import org.gradle.api.problems.internal.InternalProblemReporter
import org.gradle.api.problems.internal.ProblemEmitter
import spock.lang.Specification
class ValidationProblemSerializationTest extends Specification {
Gson gson = ValidationProblemSerialization.createGsonBuilder().create()
InternalProblemReporter problemReporter = new DefaultProblemReporter(Stub(ProblemEmitter), [], org.gradle.internal.operations.CurrentBuildOperationRef.instance(), HashMultimap.create())
def "can serialize and deserialize a validation problem"() {
given:
def problem = problemReporter.create {
it.id("id", "label", GradleCoreProblemGroup.validation())
}
when:
def json = gson.toJson([problem])
def deserialized = ValidationProblemSerialization.parseMessageList(json)
then:
deserialized.size() == 1
deserialized[0].definition.id.name == "id"
deserialized[0].definition.id.displayName == "label"
deserialized[0].definition.id.group.name == "validation"
deserialized[0].definition.id.group.displayName == "Validation"
deserialized[0].definition.id.group.parent == null
deserialized[0].locations.isEmpty()
deserialized[0].definition.documentationLink == null
}
def "can serialize and deserialize a validation problem with a location"() {
given:
def problem = problemReporter.create {
it.id("type", "label", GradleCoreProblemGroup.validation())
.lineInFileLocation("location", 1, 2, 3)
}
when:
def json = gson.toJson([problem])
def deserialized = ValidationProblemSerialization.parseMessageList(json)
then:
deserialized.size() == 1
deserialized[0].definition.id.name == "type"
deserialized[0].definition.id.displayName == "label"
deserialized[0].locations[0].path == "location"
deserialized[0].locations[0].line == 1
deserialized[0].locations[0].column == 2
deserialized[0].locations[0].length == 3
deserialized[0].definition.documentationLink == null
}
def "can serialize and deserialize a validation problem with a documentation link"() {
given:
def problem = problemReporter.create {
it.id("id", "label", GradleCoreProblemGroup.validation())
.documentedAt(new TestDocLink())
.lineInFileLocation("location", 1, 1)
}
when:
def json = gson.toJson([problem])
def deserialized = ValidationProblemSerialization.parseMessageList(json)
then:
deserialized.size() == 1
deserialized[0].definition.id.name == "id"
deserialized[0].definition.id.displayName == "label"
deserialized[0].locations[0].path == "location"
deserialized[0].locations[0].line == 1
deserialized[0].locations[0].column == 1
deserialized[0].definition.documentationLink.getUrl() == "url"
deserialized[0].definition.documentationLink.getConsultDocumentationMessage() == "consult"
}
/**
* Required to be a named, static class for serialization to work.
* See https://google.github.io/gson/UserGuide.html#nested-classes-including-inner-classes
*/
class TestDocLink implements DocLink {
@Override
String getUrl() {
return "url"
}
@Override
String getConsultDocumentationMessage() {
return "consult"
}
}
def "can serialize and deserialize a validation problem with a cause"() {
given:
def problem = problemReporter.create {
it.id("id", "label", GradleCoreProblemGroup.validation())
.withException(new RuntimeException("cause"))
}
when:
def json = gson.toJson([problem])
def deserialized = ValidationProblemSerialization.parseMessageList(json)
then:
deserialized.size() == 1
deserialized[0].definition.id.name == "id"
deserialized[0].definition.id.displayName == "label"
deserialized[0].locations == [] as List
deserialized[0].definition.documentationLink == null
deserialized[0].exception.message == "cause"
}
def "can serialize and deserialize a validation problem with a severity"(Severity severity) {
given:
def problem = problemReporter.create {
it.id("id", "label", GradleCoreProblemGroup.validation())
.severity(severity)
}
when:
def json = gson.toJson([problem])
def deserialized = ValidationProblemSerialization.parseMessageList(json)
then:
deserialized.size() == 1
deserialized[0].definition.id.name == "id"
deserialized[0].definition.id.displayName == "label"
deserialized[0].locations == [] as List
deserialized[0].definition.documentationLink == null
deserialized[0].definition.severity == severity
where:
severity << Severity.values()
}
def "can serialize and deserialize a validation problem with a solution"() {
given:
def problem = problemReporter.create {
it.id("id", "label", GradleCoreProblemGroup.validation())
.solution("solution 0")
.solution("solution 1")
}
when:
def json = gson.toJson([problem])
def deserialized = ValidationProblemSerialization.parseMessageList(json)
then:
deserialized.size() == 1
deserialized[0].definition.id.name == "id"
deserialized[0].definition.id.displayName == "label"
deserialized[0].locations == [] as List
deserialized[0].definition.documentationLink == null
deserialized[0].solutions[0] == "solution 0"
deserialized[0].solutions[1] == "solution 1"
}
def "can serialize and deserialize a validation problem with additional data"() {
given:
def problem = problemReporter.create {
it.id("id", "label", GradleCoreProblemGroup.validation())
.additionalData("key 1", "value 1")
.additionalData("key 2", "value 2")
}
when:
def json = gson.toJson([problem])
def deserialized = ValidationProblemSerialization.parseMessageList(json)
then:
deserialized.size() == 1
deserialized[0].definition.id.name == "id"
deserialized[0].definition.id.displayName == "label"
deserialized[0].locations == [] as List
deserialized[0].definition.documentationLink == null
deserialized[0].additionalData["key 1"] == "value 1"
deserialized[0].additionalData["key 2"] == "value 2"
}
}