Skip to content

Commit 0921ad7

Browse files
authored
Add support for ignoring missing Javadoc on generated code using annotation (# 7264) (opensearch-project#7604)
* Allow wild cards for missingJavadoc (# 7264) It can be tedious and error prone to have to specify individual source files of generated code that does not follow OpenSearch standards. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Allow wild cards for missingJavadoc (# 7264) Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Address a comment Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Add support for ignoring missing Javadoc using annotation Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Fix a dependency issue for build-tool:reaper. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Undo support for wildcards for ignoring missing Javadoc. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove dependency on jboss from doc-tools by using class names. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove the missingJavadoc Gradle task that is no longer needed. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Update changelog Signed-off-by: Austin Lee <austin.t.lee@gmail.com> --------- Signed-off-by: Austin Lee <austin.t.lee@gmail.com>
1 parent adf7e2c commit 0921ad7

File tree

8 files changed

+256
-27
lines changed

8 files changed

+256
-27
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
99
- Add getter for path field in NestedQueryBuilder ([#4636](https://github.com/opensearch-project/OpenSearch/pull/4636))
1010
- Allow mmap to use new JDK-19 preview APIs in Apache Lucene 9.4+ ([#5151](https://github.com/opensearch-project/OpenSearch/pull/5151))
1111
- Add events correlation engine plugin ([#6854](https://github.com/opensearch-project/OpenSearch/issues/6854))
12+
- Add support for ignoring missing Javadoc on generated code using annotation ([#7604](https://github.com/opensearch-project/OpenSearch/pull/7604))
1213

1314
### Dependencies
1415
- Bump `log4j-core` from 2.18.0 to 2.19.0

buildSrc/version.properties

+1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ kotlin = 1.7.10
2323
antlr4 = 4.11.1
2424
guava = 31.1-jre
2525
protobuf = 3.22.3
26+
jboss_annotation = 1.0.2.Final
2627

2728
# when updating the JNA version, also update the version in buildSrc/build.gradle
2829
jna = 5.5.0

doc-tools/missing-doclet/build.gradle

-4
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ plugins {
55
group 'org.opensearch'
66
version '1.0.0-SNAPSHOT'
77

8-
repositories {
9-
mavenCentral()
10-
}
11-
128
tasks.withType(JavaCompile) {
139
options.compilerArgs += ["--release", targetCompatibility.toString()]
1410
options.encoding = "UTF-8"

doc-tools/missing-doclet/src/main/java/org/opensearch/missingdoclet/MissingDoclet.java

+28
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
import java.util.HashSet;
1414
import java.util.List;
1515
import java.util.Locale;
16+
import java.util.Optional;
1617
import java.util.Set;
1718
import java.util.stream.Collectors;
1819
import java.util.stream.Stream;
@@ -291,6 +292,22 @@ private void checkComment(Element element) {
291292
if (ignored.contains(element.toString())) {
292293
return;
293294
}
295+
// Ignore classes annotated with @Generated and all enclosed elements in them.
296+
if (isGenerated(element)) {
297+
return;
298+
}
299+
Element enclosing = element.getEnclosingElement();
300+
if (enclosing != null && isGenerated(enclosing)) {
301+
return;
302+
}
303+
// If a package contains only generated classes, ignore the package as well.
304+
if (element.getKind() == ElementKind.PACKAGE) {
305+
List<? extends Element> enclosedElements = element.getEnclosedElements();
306+
Optional<?> elm = enclosedElements.stream().findFirst().filter(e -> ((e.getKind() != ElementKind.CLASS) || !isGenerated(e)));
307+
if (elm.isEmpty()) {
308+
return;
309+
}
310+
}
294311
var tree = docTrees.getDocCommentTree(element);
295312
if (tree == null || tree.getFirstSentence().isEmpty()) {
296313
// Check for methods that override other stuff and perhaps inherit their Javadocs.
@@ -313,6 +330,17 @@ private void checkComment(Element element) {
313330
}
314331
}
315332

333+
// Ignore classes annotated with @Generated and all enclosed elements in them.
334+
private boolean isGenerated(Element element) {
335+
return element
336+
.getAnnotationMirrors()
337+
.stream()
338+
.anyMatch(m -> m
339+
.getAnnotationType()
340+
.toString() /* ClassSymbol.toString() returns class name */
341+
.equalsIgnoreCase("javax.annotation.Generated"));
342+
}
343+
316344
private boolean hasInheritedJavadocs(Element element) {
317345
boolean hasOverrides = element.getAnnotationMirrors().stream()
318346
.anyMatch(ann -> ann.getAnnotationType().toString().equals(Override.class.getName()));

server/build.gradle

+12-23
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ dependencies {
148148

149149
// protobuf
150150
api "com.google.protobuf:protobuf-java:${versions.protobuf}"
151+
implementation "org.jboss.spec.javax.annotation:jboss-annotations-api_1.2_spec:${versions.jboss_annotation}"
151152

152153
testImplementation(project(":test:framework")) {
153154
// tests use the locally compiled version of server
@@ -176,6 +177,7 @@ tasks.named("forbiddenPatterns").configure {
176177
exclude '**/*.dic'
177178
exclude '**/*.binary'
178179
exclude '**/*.st'
180+
exclude '**/*.meta'
179181
}
180182

181183
tasks.named("testingConventions").configure {
@@ -221,6 +223,16 @@ protobuf {
221223
protoc {
222224
artifact = "com.google.protobuf:protoc:${versions.protobuf}"
223225
}
226+
227+
generateProtoTasks {
228+
all().each { task ->
229+
task.builtins {
230+
java {
231+
option "annotate_code"
232+
}
233+
}
234+
}
235+
}
224236
}
225237

226238
tasks.named("processResources").configure {
@@ -344,29 +356,6 @@ tasks.named("dependencyLicenses").configure {
344356
}
345357
}
346358

347-
tasks.named("missingJavadoc").configure {
348-
/*
349-
* Generated code doesn't follow javadocs formats.
350-
* Unfortunately the missingJavadoc task doesnt take *.
351-
* TODO: Add support to missingJavadoc task to ignore all generated source code
352-
* https://github.com/opensearch-project/OpenSearch/issues/7264
353-
*/
354-
dependsOn("generateProto")
355-
javadocMissingIgnore = [
356-
"org.opensearch.extensions.proto.ExtensionIdentityProto",
357-
"org.opensearch.extensions.proto.ExtensionIdentityProto.ExtensionIdentityOrBuilder",
358-
"org.opensearch.extensions.proto.RegisterRestActionsProto",
359-
"org.opensearch.extensions.proto.RegisterRestActionsProto.RegisterRestActionsOrBuilder",
360-
"org.opensearch.extensions.proto.ExtensionRequestProto",
361-
"org.opensearch.extensions.proto.ExtensionRequestProto.ExtensionRequestOrBuilder",
362-
"org.opensearch.extensions.proto.RegisterTransportActionsProto",
363-
"org.opensearch.extensions.proto.RegisterTransportActionsProto.RegisterTransportActionsOrBuilder",
364-
"org.opensearch.extensions.proto.ExtensionTransportMessageProto",
365-
"org.opensearch.extensions.proto.ExtensionTransportMessageProto.ExtensionTransportMessageOrBuilder",
366-
"org.opensearch.extensions.proto"
367-
]
368-
}
369-
370359
tasks.named("filepermissions").configure {
371360
mustRunAfter("generateProto")
372361
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0d6b20c0e95c5b38f313cc2ab1a55560cedabe1f
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
OpenSearch (https://opensearch.org/)
2+
Copyright OpenSearch Contributors
3+
4+
This product includes software developed by
5+
Elasticsearch (http://www.elastic.co).
6+
Copyright 2009-2018 Elasticsearch
7+
8+
This product includes software developed by The Apache Software
9+
Foundation (http://www.apache.org/).
10+
11+
This product includes software developed by
12+
Joda.org (http://www.joda.org/).

0 commit comments

Comments
 (0)