Skip to content

Commit 8bbddc4

Browse files
rjernstrjernst
authored
Rename transport version terminology (#133492)
This commit further tweaks terminology for the new file-based transport version system. Specially it renames: named -> referable unreferenced -> unreferable latest -> upper_bound
1 parent 35083e8 commit 8bbddc4

File tree

16 files changed

+187
-179
lines changed

16 files changed

+187
-179
lines changed

‎build-tools-internal/src/integTest/groovy/org/elasticsearch/gradle/internal/transport/AbstractTransportVersionFuncTest.groovy

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,27 +33,27 @@ class AbstractTransportVersionFuncTest extends AbstractGradleFuncTest {
3333
}
3434
}
3535

36-
def namedTransportVersion(String name, String ids) {
37-
javaResource("myserver", "transport/definitions/named/" + name + ".csv", ids)
36+
def referableTransportVersion(String name, String ids) {
37+
javaResource("myserver", "transport/definitions/referable/" + name + ".csv", ids)
3838
}
3939

40-
def unreferencedTransportVersion(String name, String id) {
41-
javaResource("myserver", "transport/definitions/unreferenced/" + name + ".csv", id)
40+
def unreferableTransportVersion(String name, String id) {
41+
javaResource("myserver", "transport/definitions/unreferable/" + name + ".csv", id)
4242
}
4343

44-
def namedAndReferencedTransportVersion(String name, String ids) {
45-
return namedAndReferencedTransportVersion(name, ids, "Test${name.capitalize()}")
44+
def referableAndReferencedTransportVersion(String name, String ids) {
45+
return referableAndReferencedTransportVersion(name, ids, "Test${name.capitalize()}")
4646
}
4747

48-
def namedAndReferencedTransportVersion(String name, String ids, String classname) {
48+
def referableAndReferencedTransportVersion(String name, String ids, String classname) {
4949
javaSource("myserver", "org.elasticsearch", classname, "", """
5050
static final TransportVersion usage = TransportVersion.fromName("${name}");
5151
""")
52-
namedTransportVersion(name, ids)
52+
referableTransportVersion(name, ids)
5353
}
5454

55-
def latestTransportVersion(String branch, String name, String id) {
56-
javaResource("myserver", "transport/latest/" + branch + ".csv","${name},${id}")
55+
def transportVersionUpperBound(String branch, String name, String id) {
56+
javaResource("myserver", "transport/upper_bounds/" + branch + ".csv","${name},${id}")
5757
}
5858

5959
def validateReferencesFails(String project) {
@@ -87,11 +87,11 @@ class AbstractTransportVersionFuncTest extends AbstractGradleFuncTest {
8787
apply plugin: 'elasticsearch.transport-version-references'
8888
apply plugin: 'elasticsearch.transport-version-resources'
8989
"""
90-
namedTransportVersion("existing_91", "8012000")
91-
namedTransportVersion("existing_92", "8123000,8012001")
92-
unreferencedTransportVersion("initial_9_0_0", "8000000")
93-
latestTransportVersion("9.2", "existing_92", "8123000")
94-
latestTransportVersion("9.1", "existing_92", "8012001")
90+
referableTransportVersion("existing_91", "8012000")
91+
referableTransportVersion("existing_92", "8123000,8012001")
92+
unreferableTransportVersion("initial_9_0_0", "8000000")
93+
transportVersionUpperBound("9.2", "existing_92", "8123000")
94+
transportVersionUpperBound("9.1", "existing_92", "8012001")
9595
// a mock version of TransportVersion, just here so we can compile Dummy.java et al
9696
javaSource("myserver", "org.elasticsearch", "TransportVersion", "", """
9797
public static TransportVersion fromName(String name) {

‎build-tools-internal/src/integTest/groovy/org/elasticsearch/gradle/internal/transport/TransportVersionValidationFuncTest.groovy

Lines changed: 57 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,22 @@ class TransportVersionValidationFuncTest extends AbstractTransportVersionFuncTes
3838

3939
def "references must be defined"() {
4040
given:
41-
namedTransportVersion("not_used", "1000000")
41+
referableTransportVersion("not_used", "1000000")
4242
when:
4343
def result = validateResourcesFails()
4444
then:
4545
assertValidateResourcesFailure(result, "Transport version definition file " +
46-
"[myserver/src/main/resources/transport/definitions/named/not_used.csv] is not referenced")
46+
"[myserver/src/main/resources/transport/definitions/referable/not_used.csv] is not referenced")
4747
}
4848

4949
def "names must be lowercase alphanum or underscore"() {
5050
given:
51-
namedAndReferencedTransportVersion("${name}", "8100000", "TestNames")
51+
referableAndReferencedTransportVersion("${name}", "8100000", "TestNames")
5252
when:
5353
def result = validateResourcesFails()
5454
then:
5555
assertValidateResourcesFailure(result, "Transport version definition file " +
56-
"[myserver/src/main/resources/transport/definitions/named/${name}.csv] does not have a valid name, " +
56+
"[myserver/src/main/resources/transport/definitions/referable/${name}.csv] does not have a valid name, " +
5757
"must be lowercase alphanumeric and underscore")
5858

5959
where:
@@ -62,117 +62,117 @@ class TransportVersionValidationFuncTest extends AbstractTransportVersionFuncTes
6262

6363
def "definitions contain at least one id"() {
6464
given:
65-
namedAndReferencedTransportVersion("empty", "")
65+
referableAndReferencedTransportVersion("empty", "")
6666
when:
6767
def result = validateResourcesFails()
6868
then:
6969
assertValidateResourcesFailure(result, "Transport version definition file " +
70-
"[myserver/src/main/resources/transport/definitions/named/empty.csv] does not contain any ids")
70+
"[myserver/src/main/resources/transport/definitions/referable/empty.csv] does not contain any ids")
7171
}
7272

7373
def "definitions have ids in descending order"() {
7474
given:
75-
namedAndReferencedTransportVersion("out_of_order", "8100000,8200000")
75+
referableAndReferencedTransportVersion("out_of_order", "8100000,8200000")
7676
when:
7777
def result = validateResourcesFails()
7878
then:
7979
assertValidateResourcesFailure(result, "Transport version definition file " +
80-
"[myserver/src/main/resources/transport/definitions/named/out_of_order.csv] does not have ordered ids")
80+
"[myserver/src/main/resources/transport/definitions/referable/out_of_order.csv] does not have ordered ids")
8181
}
8282

8383
def "definition ids are unique"() {
8484
given:
85-
namedAndReferencedTransportVersion("duplicate", "8123000")
85+
referableAndReferencedTransportVersion("duplicate", "8123000")
8686
when:
8787
def result = validateResourcesFails()
8888
then:
8989
assertValidateResourcesFailure(result, "Transport version definition file " +
90-
"[myserver/src/main/resources/transport/definitions/named/existing_92.csv] contains id 8123000 already defined in " +
91-
"[myserver/src/main/resources/transport/definitions/named/duplicate.csv]")
90+
"[myserver/src/main/resources/transport/definitions/referable/existing_92.csv] contains id 8123000 already defined in " +
91+
"[myserver/src/main/resources/transport/definitions/referable/duplicate.csv]")
9292
}
9393

9494
def "definitions have bwc ids with non-zero patch part"() {
9595
given:
96-
namedAndReferencedTransportVersion("patched", "8200000,8100000")
96+
referableAndReferencedTransportVersion("patched", "8200000,8100000")
9797
when:
9898
def result = validateResourcesFails()
9999
then:
100100
assertValidateResourcesFailure(result, "Transport version definition file " +
101-
"[myserver/src/main/resources/transport/definitions/named/patched.csv] contains bwc id [8100000] with a patch part of 0")
101+
"[myserver/src/main/resources/transport/definitions/referable/patched.csv] contains bwc id [8100000] with a patch part of 0")
102102
}
103103

104104
def "definitions have primary ids which cannot change"() {
105105
given:
106-
namedTransportVersion("existing_92", "8500000")
106+
referableTransportVersion("existing_92", "8500000")
107107
when:
108108
def result = validateResourcesFails()
109109
then:
110110
assertValidateResourcesFailure(result, "Transport version definition file " +
111-
"[myserver/src/main/resources/transport/definitions/named/existing_92.csv] has modified primary id from 8123000 to 8500000")
111+
"[myserver/src/main/resources/transport/definitions/referable/existing_92.csv] has modified primary id from 8123000 to 8500000")
112112
}
113113

114114
def "cannot change committed ids to a branch"() {
115115
given:
116-
namedTransportVersion("existing_92", "8123000,8012002")
116+
referableTransportVersion("existing_92", "8123000,8012002")
117117
when:
118118
def result = validateResourcesFails()
119119
then:
120120
assertValidateResourcesFailure(result, "Transport version definition file " +
121-
"[myserver/src/main/resources/transport/definitions/named/existing_92.csv] modifies existing patch id from 8012001 to 8012002")
121+
"[myserver/src/main/resources/transport/definitions/referable/existing_92.csv] modifies existing patch id from 8012001 to 8012002")
122122
}
123123

124-
def "latest files must reference defined name"() {
124+
def "upper bounds files must reference defined name"() {
125125
given:
126-
latestTransportVersion("9.2", "dne", "8123000")
126+
transportVersionUpperBound("9.2", "dne", "8123000")
127127
when:
128128
def result = validateResourcesFails()
129129
then:
130-
assertValidateResourcesFailure(result, "Latest transport version file " +
131-
"[myserver/src/main/resources/transport/latest/9.2.csv] contains transport version name [dne] which is not defined")
130+
assertValidateResourcesFailure(result, "Transport version upper bound file " +
131+
"[myserver/src/main/resources/transport/upper_bounds/9.2.csv] contains transport version name [dne] which is not defined")
132132
}
133133

134-
def "latest files id must exist in definition"() {
134+
def "upper bound files id must exist in definition"() {
135135
given:
136-
latestTransportVersion("9.2", "existing_92", "8124000")
136+
transportVersionUpperBound("9.2", "existing_92", "8124000")
137137
when:
138138
def result = validateResourcesFails()
139139
then:
140-
assertValidateResourcesFailure(result, "Latest transport version file " +
141-
"[myserver/src/main/resources/transport/latest/9.2.csv] has id 8124000 which is not in definition " +
142-
"[myserver/src/main/resources/transport/definitions/named/existing_92.csv]")
140+
assertValidateResourcesFailure(result, "Transport version upper bound file " +
141+
"[myserver/src/main/resources/transport/upper_bounds/9.2.csv] has id 8124000 which is not in definition " +
142+
"[myserver/src/main/resources/transport/definitions/referable/existing_92.csv]")
143143
}
144144

145-
def "latest files have latest id within base"() {
145+
def "upper bound files have latest id within base"() {
146146
given:
147-
latestTransportVersion("9.0", "seemingly_latest", "8110001")
148-
namedAndReferencedTransportVersion("original", "8110000")
149-
namedAndReferencedTransportVersion("seemingly_latest", "8111000,8110001")
150-
namedAndReferencedTransportVersion("actual_latest", "8112000,8110002")
147+
transportVersionUpperBound("9.0", "seemingly_latest", "8110001")
148+
referableAndReferencedTransportVersion("original", "8110000")
149+
referableAndReferencedTransportVersion("seemingly_latest", "8111000,8110001")
150+
referableAndReferencedTransportVersion("actual_latest", "8112000,8110002")
151151
when:
152152
def result = validateResourcesFails()
153153
then:
154-
assertValidateResourcesFailure(result, "Latest transport version file " +
155-
"[myserver/src/main/resources/transport/latest/9.0.csv] has id 8110001 from [seemingly_latest] with base 8110000 " +
154+
assertValidateResourcesFailure(result, "Transport version upper bound file " +
155+
"[myserver/src/main/resources/transport/upper_bounds/9.0.csv] has id 8110001 from [seemingly_latest] with base 8110000 " +
156156
"but another id 8110002 from [actual_latest] is later for that base")
157157
}
158158

159-
def "latest files cannot change base id"() {
159+
def "upper bound files cannot change base id"() {
160160
given:
161-
namedAndReferencedTransportVersion("original", "8013000")
162-
namedAndReferencedTransportVersion("patch", "8015000,8013001")
163-
latestTransportVersion("9.1", "patch", "8013001")
161+
referableAndReferencedTransportVersion("original", "8013000")
162+
referableAndReferencedTransportVersion("patch", "8015000,8013001")
163+
transportVersionUpperBound("9.1", "patch", "8013001")
164164
when:
165165
def result = validateResourcesFails()
166166
then:
167-
assertValidateResourcesFailure(result, "Latest transport version file " +
168-
"[myserver/src/main/resources/transport/latest/9.1.csv] modifies base id from 8012000 to 8013000")
167+
assertValidateResourcesFailure(result, "Transport version upper bound file " +
168+
"[myserver/src/main/resources/transport/upper_bounds/9.1.csv] modifies base id from 8012000 to 8013000")
169169
}
170170

171171
def "ids must be dense"() {
172172
given:
173-
namedAndReferencedTransportVersion("original", "8013000")
174-
namedAndReferencedTransportVersion("patch1", "8015000,8013002")
175-
latestTransportVersion("9.0", "patch1", "8013002")
173+
referableAndReferencedTransportVersion("original", "8013000")
174+
referableAndReferencedTransportVersion("patch1", "8015000,8013002")
175+
transportVersionUpperBound("9.0", "patch1", "8013002")
176176
when:
177177
def result = validateResourcesFails()
178178
then:
@@ -181,49 +181,49 @@ class TransportVersionValidationFuncTest extends AbstractTransportVersionFuncTes
181181

182182
def "primary id must not be patch version"() {
183183
given:
184-
namedAndReferencedTransportVersion("patch", "8015001")
184+
referableAndReferencedTransportVersion("patch", "8015001")
185185
when:
186186
def result = validateResourcesFails()
187187
then:
188188
assertValidateResourcesFailure(result, "Transport version definition file " +
189-
"[myserver/src/main/resources/transport/definitions/named/patch.csv] has patch version 8015001 as primary id")
189+
"[myserver/src/main/resources/transport/definitions/referable/patch.csv] has patch version 8015001 as primary id")
190190
}
191191

192-
def "unreferenced directory is optional"() {
192+
def "unreferable directory is optional"() {
193193
given:
194-
file("myserver/src/main/resources/transport/unreferenced/initial_9_0_0.csv").delete()
195-
file("myserver/src/main/resources/transport/unreferenced").deleteDir()
194+
file("myserver/src/main/resources/transport/unreferable/initial_9_0_0.csv").delete()
195+
file("myserver/src/main/resources/transport/unreferable").deleteDir()
196196
when:
197197
def result = gradleRunner(":myserver:validateTransportVersionResources").build()
198198
then:
199199
result.task(":myserver:validateTransportVersionResources").outcome == TaskOutcome.SUCCESS
200200
}
201201

202-
def "latest can refer to an unreferenced definition"() {
202+
def "upper bound can refer to an unreferable definition"() {
203203
given:
204-
unreferencedTransportVersion("initial_10.0.0", "10000000")
205-
latestTransportVersion("10.0", "initial_10.0.0", "10000000")
204+
unreferableTransportVersion("initial_10.0.0", "10000000")
205+
transportVersionUpperBound("10.0", "initial_10.0.0", "10000000")
206206
when:
207207
def result = gradleRunner(":myserver:validateTransportVersionResources").build()
208208
then:
209209
result.task(":myserver:validateTransportVersionResources").outcome == TaskOutcome.SUCCESS
210210
}
211211

212-
def "named and unreferenced definitions cannot have the same name"() {
212+
def "referable and unreferable definitions cannot have the same name"() {
213213
given:
214-
unreferencedTransportVersion("existing_92", "10000000")
214+
unreferableTransportVersion("existing_92", "10000000")
215215
when:
216216
def result = validateResourcesFails()
217217
then:
218218
assertValidateResourcesFailure(result, "Transport version definition file " +
219-
"[myserver/src/main/resources/transport/definitions/named/existing_92.csv] " +
220-
"has same name as unreferenced definition " +
221-
"[myserver/src/main/resources/transport/definitions/unreferenced/existing_92.csv]")
219+
"[myserver/src/main/resources/transport/definitions/referable/existing_92.csv] " +
220+
"has same name as unreferable definition " +
221+
"[myserver/src/main/resources/transport/definitions/unreferable/existing_92.csv]")
222222
}
223223

224-
def "unreferenced definitions can have primary ids that are patches"() {
224+
def "unreferable definitions can have primary ids that are patches"() {
225225
given:
226-
unreferencedTransportVersion("initial_10.0.1", "10000001")
226+
unreferableTransportVersion("initial_10.0.1", "10000001")
227227
when:
228228
def result = gradleRunner(":myserver:validateTransportVersionResources").build()
229229
then:

0 commit comments

Comments
 (0)