This is an automated email from the ASF dual-hosted git repository.
dongjoon pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/spark-kubernetes-operator.git
The following commit(s) were added to refs/heads/main by this push:
new 798ca15 [SPARK-47929] Setup Static Analysis for Operator
798ca15 is described below
commit 798ca15844c71baf5d7f1f8842e461a73c1009a9
Author: zhou-jiang <zhou_ji...@apple.com>
AuthorDate: Mon Apr 22 22:42:23 2024 -0700
[SPARK-47929] Setup Static Analysis for Operator
### What changes were proposed in this pull request?
This is a breakdown PR from #2 - setting up common build Java tasks and
corresponding plugins.
### Why are the changes needed?
This PR includes checkstyle, pmd, spotbugs. Also includes jacoco for
coverage analysis, spotless for formatting. These tasks can help to enhance the
quality of future Java contributions. They can also be referred in CI tasks for
automation.
### Does this PR introduce _any_ user-facing change?
No
### How was this patch tested?
Tested manually.
### Was this patch authored or co-authored using generative AI tooling?
no
Closes #6 from jiangzho/builder_task.
Authored-by: zhou-jiang <zhou_ji...@apple.com>
Signed-off-by: Dongjoon Hyun <dongj...@apache.org>
---
build.gradle | 76 ++++++++++++-
config/checkstyle/checkstyle.xml | 208 +++++++++++++++++++++++++++++++++++
config/pmd/ruleset.xml | 33 ++++++
config/spotbugs/spotbugs_exclude.xml | 25 +++++
gradle.properties | 22 ++++
5 files changed, 362 insertions(+), 2 deletions(-)
diff --git a/build.gradle b/build.gradle
index 6732f5a..f64212b 100644
--- a/build.gradle
+++ b/build.gradle
@@ -1,3 +1,18 @@
+buildscript {
+ repositories {
+ maven {
+ url = uri("https://plugins.gradle.org/m2/";)
+ }
+ }
+ dependencies {
+ classpath
"com.github.spotbugs.snom:spotbugs-gradle-plugin:${spotBugsGradlePluginVersion}"
+ classpath
"com.diffplug.spotless:spotless-plugin-gradle:${spotlessPluginVersion}"
+ }
+}
+
+assert JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_17): "Java
17 or newer is " +
+ "required"
+
subprojects {
apply plugin: 'idea'
apply plugin: 'eclipse'
@@ -6,7 +21,64 @@ subprojects {
targetCompatibility = 17
repositories {
- mavenCentral()
- jcenter()
+ mavenCentral()
+ jcenter()
+ }
+
+ apply plugin: 'checkstyle'
+ checkstyle {
+ toolVersion = checkstyleVersion
+ configFile = file("$rootDir/config/checkstyle/checkstyle.xml")
+ ignoreFailures = false
+ showViolations = true
+ }
+
+ apply plugin: 'pmd'
+ pmd {
+ ruleSets = ["java-basic", "java-braces"]
+ ruleSetFiles = files("$rootDir/config/pmd/ruleset.xml")
+ toolVersion = pmdVersion
+ consoleOutput = true
+ ignoreFailures = false
+ }
+
+ apply plugin: 'com.github.spotbugs'
+ spotbugs {
+ toolVersion = spotBugsVersion
+ afterEvaluate {
+ reportsDir = file("${project.reporting.baseDir}/findbugs")
+ }
+ excludeFilter = file("$rootDir/config/spotbugs/spotbugs_exclude.xml")
+ ignoreFailures = false
+ }
+
+ apply plugin: 'jacoco'
+ jacoco {
+ toolVersion = jacocoVersion
+ }
+ jacocoTestReport {
+ dependsOn test
+ }
+
+ apply plugin: 'com.diffplug.spotless'
+ spotless {
+ java {
+ endWithNewline()
+ googleJavaFormat('1.17.0')
+ importOrder(
+ 'java',
+ 'javax',
+ 'scala',
+ '',
+ 'org.apache.spark',
+ )
+ trimTrailingWhitespace()
+ removeUnusedImports()
+ }
+ format 'misc', {
+ target '*.md', '*.gradle', '**/*.properties', '**/*.xml', '**/*.yaml',
'**/*.yml'
+ endWithNewline()
+ trimTrailingWhitespace()
+ }
}
}
diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
new file mode 100644
index 0000000..90161fe
--- /dev/null
+++ b/config/checkstyle/checkstyle.xml
@@ -0,0 +1,208 @@
+<!--
+ ~ 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.
+ -->
+
+<!DOCTYPE module PUBLIC
+ "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+ "https://checkstyle.org/dtds/configuration_1_3.dtd";>
+
+<!--
+
+ Checkstyle configuration based on the Google coding conventions from:
+
+ - Google Java Style
+ https://google.github.io/styleguide/javaguide.html
+
+ with Spark-specific changes from:
+
+ https://spark.apache.org/contributing.html#code-style-guide
+
+ Checkstyle is very configurable. Be sure to read the documentation at
+ http://checkstyle.sf.net (or in your downloaded distribution).
+
+ Most Checks are configurable, be sure to consult the documentation.
+
+ To completely disable a check, just comment it out or delete it from the
file.
+
+ Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
+
+ -->
+
+<module name="Checker">
+ <property name="charset" value="UTF-8"/>
+
+ <property name="severity" value="error"/>
+
+ <property name="fileExtensions" value="java, properties, xml"/>
+
+ <!-- Checks for whitespace -->
+ <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+ <module name="FileTabCharacter">
+ <property name="eachLine" value="true"/>
+ </module>
+
+ <module name="RegexpSingleline">
+ <!-- \s matches whitespace character, $ matches end of line. -->
+ <property name="format" value="\s+$"/>
+ <property name="message" value="No trailing whitespace allowed."/>
+ </module>
+
+ <module name="LineLength">
+ <property name="max" value="100"/>
+ <property name="ignorePattern"
+ value="^package.*|^import.*|a
href|href|http://|https://|ftp://"/>
+ </module>
+
+ <module name="NewlineAtEndOfFile"/>
+
+ <module name="TreeWalker">
+ <!--
+ If you wish to turn off checking for a section of code, you can put a
comment in the source
+ before and after the section, with the following syntax:
+
+ // checkstyle.off: XXX (such as checkstyle.off: NoFinalizer)
+ ... // stuff that breaks the styles
+ // checkstyle.on: XXX (such as checkstyle.on: NoFinalizer)
+ -->
+ <module name="SuppressionCommentFilter">
+ <property name="offCommentFormat" value="checkstyle\.off\: ([\w\|]+)"/>
+ <property name="onCommentFormat" value="checkstyle\.on\: ([\w\|]+)"/>
+ <property name="checkFormat" value="$1"/>
+ </module>
+ <module name="OuterTypeFilename"/>
+ <module name="IllegalTokenText">
+ <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
+ <property name="format"
+
value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
+ <property name="message" value="Avoid using corresponding octal or
Unicode escape."/>
+ </module>
+ <module name="AvoidEscapedUnicodeCharacters">
+ <property name="allowEscapesForControlCharacters" value="true"/>
+ <property name="allowByTailComment" value="true"/>
+ <property name="allowNonPrintableEscapes" value="true"/>
+ </module>
+ <module name="NoLineWrap"/>
+ <module name="EmptyBlock">
+ <property name="option" value="TEXT"/>
+ <property name="tokens"
+ value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
LITERAL_SWITCH"/>
+ </module>
+ <module name="NeedBraces">
+ <property name="allowSingleLineStatement" value="true"/>
+ </module>
+ <module name="OneStatementPerLine"/>
+ <module name="ArrayTypeStyle"/>
+ <module name="FallThrough"/>
+ <module name="UpperEll"/>
+ <module name="ModifierOrder"/>
+ <module name="SeparatorWrap">
+ <property name="tokens" value="DOT"/>
+ <property name="option" value="nl"/>
+ </module>
+ <module name="SeparatorWrap">
+ <property name="tokens" value="COMMA"/>
+ <property name="option" value="EOL"/>
+ </module>
+ <module name="PackageName">
+ <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
+ <message key="name.invalidPattern"
+ value="Package name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="ClassTypeParameterName">
+ <property name="format" value="([A-Z][a-zA-Z0-9]*$)"/>
+ <message key="name.invalidPattern"
+ value="Class type name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="MethodTypeParameterName">
+ <property name="format" value="([A-Z][a-zA-Z0-9]*)"/>
+ <message key="name.invalidPattern"
+ value="Method type name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="GenericWhitespace">
+ <message key="ws.followed"
+ value="GenericWhitespace ''{0}'' is followed by whitespace."/>
+ <message key="ws.preceded"
+ value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
+ <message key="ws.illegalFollow"
+ value="GenericWhitespace ''{0}'' should followed by
whitespace."/>
+ <message key="ws.notPreceded"
+ value="GenericWhitespace ''{0}'' is not preceded with
whitespace."/>
+ </module>
+ <module name="MethodParamPad"/>
+ <module name="AnnotationLocation">
+ <property name="tokens"
+ value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF,
CTOR_DEF"/>
+ </module>
+ <module name="AnnotationLocation">
+ <property name="tokens" value="VARIABLE_DEF"/>
+ <property name="allowSamelineMultipleAnnotations" value="true"/>
+ </module>
+ <module name="MethodName">
+ <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
+ <message key="name.invalidPattern"
+ value="Method name ''{0}'' must match pattern ''{1}''."/>
+ </module>
+ <module name="EmptyCatchBlock">
+ <property name="exceptionVariableName" value="expected"/>
+ </module>
+ <module name="CommentsIndentation"/>
+ <module name="UnusedImports"/>
+ <module name="RedundantImport"/>
+ <module name="RedundantModifier"/>
+ <module name="RegexpSinglelineJava">
+ <property name="format" value="throw new \w+Error\("/>
+ <property name="message" value="Avoid throwing error in application
code."/>
+ </module>
+ <module name="RegexpSinglelineJava">
+ <property name="format" value="Objects\.toStringHelper"/>
+ <property name="message"
+ value="Avoid using Object.toStringHelper. Use ToStringBuilder
instead."/>
+ </module>
+ <module name="RegexpSinglelineJava">
+ <property name="format" value="new
(java\.lang\.)?(Byte|Integer|Long|Short)\("/>
+ <property name="message"
+ value="Use static factory 'valueOf' or 'parseXXX' instead of
the deprecated constructors."/>
+ </module>
+ <module name="RegexpSinglelineJava">
+ <property name="format" value="Files\.createTempDir\("/>
+ <property name="message"
+ value="Avoid using com.google.common.io.Files.createTempDir()
due to CVE-2020-8908.
+ Use org.apache.spark.network.util.JavaUtils.createTempDir()
instead."/>
+ </module>
+ <module name="RegexpSinglelineJava">
+ <property name="format" value="FileBackedOutputStream"/>
+ <property name="message"
+ value="Avoid using FileBackedOutputStream due to
CVE-2023-2976."/>
+ </module>
+ <module name="RegexpSinglelineJava">
+ <property name="format" value="AtomicDoubleArray"/>
+ <property name="message" value="Avoid using AtomicDoubleArray due to
CVE-2018-10237."/>
+ </module>
+ <module name="RegexpSinglelineJava">
+ <property name="format" value="CompoundOrdering"/>
+ <property name="message" value="Avoid using CompoundOrdering due to
CVE-2018-10237."/>
+ </module>
+ <module name="RegexpSinglelineJava">
+ <property name="format" value="@Test\(expected"/>
+ <property name="message"
+ value="Please use the `assertThrows` method to test for
exceptions."/>
+ </module>
+ <module name="IllegalImport">
+ <property name="illegalPkgs" value="org.apache.log4j"/>
+ <property name="illegalPkgs" value="org.apache.commons.lang"/>
+ </module>
+ </module>
+</module>
diff --git a/config/pmd/ruleset.xml b/config/pmd/ruleset.xml
new file mode 100644
index 0000000..be72904
--- /dev/null
+++ b/config/pmd/ruleset.xml
@@ -0,0 +1,33 @@
+<?xml version="1.0"?>
+<!--
+ ~ 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.
+ ~
+ -->
+
+<ruleset name="pmd ruleset">
+ <description>
+ Spark Operator Ruleset
+ </description>
+ <rule ref="category/java/bestpractices.xml"/>
+ <rule ref="category/java/security.xml"/>
+ <rule ref="rulesets/java/basic.xml"/>
+ <rule ref="category/java/bestpractices.xml/JUnitTestContainsTooManyAsserts">
+ <properties>
+ <property name="maximumAsserts" value="10"/>
+ </properties>
+ </rule><!-- exclude on generated files -->
+ <exclude-pattern>.*/src/generated/.*</exclude-pattern>
+</ruleset>
diff --git a/config/spotbugs/spotbugs_exclude.xml
b/config/spotbugs/spotbugs_exclude.xml
new file mode 100644
index 0000000..c492bc2
--- /dev/null
+++ b/config/spotbugs/spotbugs_exclude.xml
@@ -0,0 +1,25 @@
+<!--
+ ~ 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.
+ -->
+
+<FindBugsFilter>
+ <Bug pattern="EI_EXPOSE_REP"/>
+ <Bug pattern="EI_EXPOSE_REP2"/>
+ <Bug pattern="MS_EXPOSE_REP"/>
+ <Bug pattern="CT_CONSTRUCTOR_THROW"/>
+</FindBugsFilter>
diff --git a/gradle.properties b/gradle.properties
new file mode 100644
index 0000000..013c2d1
--- /dev/null
+++ b/gradle.properties
@@ -0,0 +1,22 @@
+#
+# 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.
+#
+
+checkstyleVersion=10.15.0
+pmdVersion=6.55.0
+spotBugsGradlePluginVersion=6.0.12
+spotBugsVersion=4.8.4
+spotlessPluginVersion=6.25.0
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org
