Skip to content

Commit

Permalink
[Enhancement #480] add code style framework (#488)
Browse files Browse the repository at this point in the history 
* [WIP] compatible with both flink yarn/k8s modes task submission/termination (#261)

* [feature] flink k8s native mode support

* [feature] flink k8s native mode support

* [issue#220] refactoring SubmitRequest, SubmitResponse to adapt k8s submit operations

* [issue#220] refactoring SubmitRequest, SubmitResponse to adapt k8s submit operations

* [issue#220] New dto object for flink stop action parameter transfer process

* [issue#220] refactor: move the parameters of the flink stop method to a dedicated dto object

* modify configuration constants of workspace(#251)

* typo(#251)

* add isAnyBank method(#251)

* add unified fs operator defined(#251)

* register FsOperator to SpringBoot Bean(#251)

* remove unnecessary import(#251)

* extend the signature of method upload, copy, copyDir(#251)

* Separate workspace storage type into configuration(#251)

* Separate workspace storage type into configuration(#251)

* add fileMd5 method(#251)

* replace the code reference of HdfsUtils to FsOperator(#251)

* change the bean injection behavior of FsOperator(#251)

* change the config key of streamx.workspace(#251)

* fix stack overflow bug

* LfsOperator.upload support dir source

* Update ConfigConst.scala

* Update HdfsOperator.scala

* Update LfsOperator.scala

* Update UnifiledFsOperator.scala

* Update Utils.scala

* compatible with flink k8s submit

* compatible with flink k8s submit

Co-authored-by: benjobs <benjobs@qq.com>

* Revert "[WIP] compatible with both flink yarn/k8s modes task submission/termination (#261)" (#262)

This reverts commit 7ae4d15.

* Provide Flink-K8s Runtime Support for StreamX (#325)

[feature] Support for submit/cancel Flink-SQL-Job on Flink-K8s-native session/application mode.
[feature] Support for tracking Flink job status and metrics information from Flink-K8s cluster.
[feature] Support for StreamX instance to manage both Flink-Yarn or Flink-K8s runtime Cluster, and to use either

* [Enhancement #480] add code style framework

* [Enhancement #480] add code style framework

* [Enhancement #480] add code style framework

* [Enhancement #480] add code style framework

Co-authored-by: al-assad <yulin.ying@outlook.com>
Co-authored-by: benjobs <benjobs@qq.com>
  • Loading branch information
@wuchunfu @Al-assad @wolfboys
3 people committed Dec 10, 2021
1 parent 2049a55 commit 1213220
Show file tree
Hide file tree
Showing 346 changed files with 7,057 additions and 5,753 deletions.
75 changes: 62 additions & 13 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,15 +85,14 @@
<protobuf.version>2.5.0</protobuf.version>
<slf4j.version>1.7.32</slf4j.version>
<logback.version>1.2.6</logback.version>
<spotless.version>2.9.0</spotless.version>
<grpc.version>1.15.0</grpc.version>
<jackson.version>2.12.1</jackson.version>
<gson.version>2.8.5</gson.version>
<guava.version>30.0-jre</guava.version>
<caffeine.version>2.8.6</caffeine.version>

<checkstyle.version>2.17</checkstyle.version>
<puppycrawl.version>8.29</puppycrawl.version>
<checkstyle.version>3.1.2</checkstyle.version>
<puppycrawl.version>9.2</puppycrawl.version>

<PermGen>64m</PermGen>
<MaxPermGen>512m</MaxPermGen>
Expand Down Expand Up @@ -485,17 +484,59 @@
<version>${puppycrawl.version}</version>
</dependency>
</dependencies>
<configuration>
<configLocation>${maven.multiModuleProjectDirectory}/tools/checkstyle/checkstyle.xml</configLocation>
<encoding>UTF-8</encoding>
<consoleOutput>true</consoleOutput>
<includeTestSourceDirectory>false</includeTestSourceDirectory>
<failOnViolation>true</failOnViolation>
<sourceDirectories>
<sourceDirectory>${project.build.sourceDirectory}</sourceDirectory>
<sourceDirectory>${project.build.testSourceDirectory}</sourceDirectory>
</sourceDirectories>
<resourceIncludes>
**/*.properties,
**/*.sh,
**/*.bat,
**/*.yml,
**/*.yaml,
**/*.xml
</resourceIncludes>
<resourceExcludes>
**/.asf.yaml,
**/.github/**
</resourceExcludes>
<excludes>
</excludes>
</configuration>
<executions>
<execution>
<id>validate</id>
<phase>process-sources</phase>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.scalastyle</groupId>
<artifactId>scalastyle-maven-plugin</artifactId>
<version>1.0.0</version>
<configuration>
<verbose>false</verbose>
<failOnViolation>true</failOnViolation>
<includeTestSourceDirectory>false</includeTestSourceDirectory>
<failOnWarning>false</failOnWarning>
<sourceDirectory>${basedir}/src/main/scala</sourceDirectory>
<testSourceDirectory>${basedir}/src/test/scala</testSourceDirectory>
<configLocation>${maven.multiModuleProjectDirectory}/scalastyle-config.xml</configLocation>
<outputFile>${project.build.directory}/target/scalastyle-output.xml</outputFile>
<inputEncoding>UTF-8</inputEncoding>
<outputEncoding>UTF-8</outputEncoding>
</configuration>
<executions>
<execution>
<id>check-style</id>
<phase>validate</phase>
<configuration>
<configLocation>dev/checkstyle.xml</configLocation>
<suppressionsLocation>dev/checkstyle-suppression.xml</suppressionsLocation>
<includeTestSourceDirectory>true</includeTestSourceDirectory>
<consoleOutput>true</consoleOutput>
<failsOnError>true</failsOnError>
</configuration>
<goals>
<goal>check</goal>
</goals>
Expand Down Expand Up @@ -714,8 +755,16 @@
</plugin>
-->

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.scalastyle</groupId>
<artifactId>scalastyle-maven-plugin</artifactId>
</plugin>
</plugins>

</build>

</project>
</project>
284 changes: 284 additions & 0 deletions scalastyle-config.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,284 @@
<!--
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.
-->

<!--
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:
// scalastyle:off
... // stuff that breaks the styles
// scalastyle:on
You can also disable only one rule, by specifying its rule id, as specified in:
http://www.scalastyle.org/rules-0.7.0.html
// scalastyle:off no.finalize
override def finalize(): Unit = ...
// scalastyle:on no.finalize
This file is divided into 3 sections:
(1) rules that we enforce.
(2) rules that we would like to enforce, but haven't cleaned up the codebase to turn on yet
(or we need to make the scalastyle rule more configurable).
(3) rules that we don't want to enforce.
-->

<scalastyle>
<name>Scalastyle standard configuration</name>

<check level="error" class="org.scalastyle.file.FileTabChecker" enabled="true"/>

<check level="error" class="org.scalastyle.scalariform.SpacesAfterPlusChecker" enabled="true"/>

<check level="error" class="org.scalastyle.scalariform.SpacesBeforePlusChecker" enabled="true"/>

<check level="error" class="org.scalastyle.file.WhitespaceEndOfLineChecker" enabled="true"/>

<check level="error" class="org.scalastyle.scalariform.ClassNamesChecker" enabled="true">
<parameters>
<parameter name="regex"><![CDATA[[A-Z][A-Za-z]*]]></parameter>
</parameters>
</check>

<check level="error" class="org.scalastyle.scalariform.ObjectNamesChecker" enabled="true">
<parameters>
<parameter name="regex"><![CDATA[[A-Z][A-Za-z]*]]></parameter>
</parameters>
</check>

<check level="error" class="org.scalastyle.scalariform.PackageObjectNamesChecker" enabled="true">
<parameters>
<parameter name="regex"><![CDATA[^[a-z][A-Za-z]*$]]></parameter>
</parameters>
</check>

<check level="error" class="org.scalastyle.scalariform.ParameterNumberChecker" enabled="true">
<parameters>
<parameter name="maxParameters"><![CDATA[15]]></parameter>
</parameters>
</check>

<check level="error" class="org.scalastyle.scalariform.EqualsHashCodeChecker" enabled="true"/>

<check level="error" class="org.scalastyle.scalariform.IllegalImportsChecker" enabled="true">
<parameters>
<parameter name="illegalImports"><![CDATA[sun._,java.awt._]]></parameter>
</parameters>
<customMessage>Illegal import of sun._ or java.awt._</customMessage>
</check>

<check level="error" class="org.scalastyle.scalariform.IllegalImportsChecker" enabled="true">
<parameters>
<parameter name="illegalImports"><![CDATA[scala.collection.Seq,scala.collection.IndexedSeq]]></parameter>
</parameters>
<customMessage><![CDATA[
Don't import scala.collection.Seq and scala.collection.IndexedSeq as it may bring some problems with cross-build between Scala 2.12 and 2.13.
Please refer below page to see the details of changes around Seq / IndexedSeq.
https://docs.scala-lang.org/overviews/core/collections-migration-213.html
If you really need to use scala.collection.Seq or scala.collection.IndexedSeq, please use the fully-qualified name instead.
]]>
</customMessage>
</check>

<!-- We cannot turn the following two on, because it'd fail a lot of string interpolation use cases. -->
<!-- Ideally the following two rules should be configurable to rule out string interpolation. -->
<check level="error" class="org.scalastyle.scalariform.NoWhitespaceBeforeLeftBracketChecker" enabled="true"/>

<check level="error" class="org.scalastyle.scalariform.NoWhitespaceAfterLeftBracketChecker" enabled="true"/>

<!-- Doesn't seem super big deal here ... -->
<check level="error" class="org.scalastyle.scalariform.NoCloneChecker" enabled="true"/>

<check level="error" class="org.scalastyle.scalariform.NoFinalizeChecker" enabled="true"/>

<check level="error" class="org.scalastyle.scalariform.CovariantEqualsChecker" enabled="true"/>

<check level="error" class="org.scalastyle.scalariform.StructuralTypeChecker" enabled="true"/>

<check level="error" class="org.scalastyle.scalariform.UppercaseLChecker" enabled="true"/>

<check level="error" class="org.scalastyle.scalariform.IfBraceChecker" enabled="true">
<parameters>
<parameter name="singleLineAllowed"><![CDATA[true]]></parameter>
<parameter name="doubleLineAllowed"><![CDATA[true]]></parameter>
</parameters>
</check>

<!-- Single Space between ')' and '{' -->
<check customId="SingleSpaceBetweenRParenAndLCurlyBrace" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
<parameters>
<parameter name="regex">\)\{</parameter>
</parameters>
<customMessage><![CDATA[
Single Space between ')' and `{`.
]]>
</customMessage>
</check>

<check customId="GuavaToStringHelper" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
<parameters>
<parameter name="regex">Objects.toStringHelper</parameter>
</parameters>
<customMessage>Avoid using Object.toStringHelper. Use ToStringBuilder instead.</customMessage>
</check>

<check customId="mutablesynchronizedbuffer" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
<parameters>
<parameter name="regex">mutable\.SynchronizedBuffer</parameter>
</parameters>
<customMessage><![CDATA[
Are you sure that you want to use mutable.SynchronizedBuffer? In most cases, you should use
java.util.concurrent.ConcurrentLinkedQueue instead.
If you must use mutable.SynchronizedBuffer, wrap the code block with
// scalastyle:off mutablesynchronizedbuffer
mutable.SynchronizedBuffer[...]
// scalastyle:on mutablesynchronizedbuffer
]]>
</customMessage>
</check>

<check customId="awaitresult" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
<parameters>
<parameter name="regex">Await\.result</parameter>
</parameters>
<customMessage><![CDATA[
Are you sure that you want to use Await.result? In most cases, you should use ThreadUtils.awaitResult instead.
If you must use Await.result, wrap the code block with
// scalastyle:off awaitresult
Await.result(...)
// scalastyle:on awaitresult
]]>
</customMessage>
</check>

<check customId="awaitready" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
<parameters>
<parameter name="regex">Await\.ready</parameter>
</parameters>
<customMessage><![CDATA[
Are you sure that you want to use Await.ready? In most cases, you should use ThreadUtils.awaitReady instead.
If you must use Await.ready, wrap the code block with
// scalastyle:off awaitready
Await.ready(...)
// scalastyle:on awaitready
]]>
</customMessage>
</check>

<check customId="FileSystemGet" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
<parameters>
<parameter name="regex">FileSystem.get\([a-zA-Z_$][a-zA-Z_$0-9]*\)</parameter>
</parameters>
<customMessage><![CDATA[
Are you sure that you want to use "FileSystem.get(Configuration conf)"? If the input
configuration is not set properly, a default FileSystem instance will be returned. It can
lead to errors when you deal with multiple file systems. Please consider using
"FileSystem.get(URI uri, Configuration conf)" or "Path.getFileSystem(Configuration conf)" instead.
If you must use the method "FileSystem.get(Configuration conf)", wrap the code block with
// scalastyle:off FileSystemGet
FileSystem.get(...)
// scalastyle:on FileSystemGet
]]>
</customMessage>
</check>

<check customId="commons-lang2" level="error" class="org.scalastyle.scalariform.TokenChecker" enabled="true">
<parameters>
<parameter name="regex">org\.apache\.commons\.lang\.</parameter>
</parameters>
<customMessage>Use Commons Lang 3 classes (package org.apache.commons.lang3.*) instead
of Commons Lang 2 (package org.apache.commons.lang.*)
</customMessage>
</check>

<!-- Do not enable ScalaDocChecker below. This forces all the classes,-->
<!-- traits, methods, types and properties to have documentation which-->
<!-- is overwhelming.-->
<check level="error" class="org.scalastyle.scalariform.ScalaDocChecker" enabled="false"/>

<!-- This one complains about all kinds of random things. Disable. -->
<!-- <check level="error" class="org.scalastyle.scalariform.SimplifyBooleanExpressionChecker" enabled="true"/>-->

<!-- This breaks symbolic method names so we don't turn it on. -->
<!-- Maybe we should update it to allow basic symbolic names, and then we are good to go. -->
<!-- <check level="error" class="org.scalastyle.scalariform.MethodNamesChecker" enabled="true">-->
<!-- <parameters>-->
<!-- <parameter name="regex"><![CDATA[^[a-z][A-Za-z0-9]*$]]></parameter>-->
<!-- </parameters>-->
<!-- </check>-->

<!-- Doesn't seem super big deal here ... -->
<check level="error" class="org.scalastyle.file.FileLengthChecker" enabled="true">
<parameters>
<parameter name="maxFileLength">800</parameter>
</parameters>
</check>

<!-- Doesn't seem super big deal here ... -->
<check level="error" class="org.scalastyle.scalariform.NumberOfTypesChecker" enabled="true">
<parameters>
<parameter name="maxTypes">50</parameter>
</parameters>
</check>

<!-- Doesn't seem super big deal here ... -->
<check level="error" class="org.scalastyle.scalariform.CyclomaticComplexityChecker" enabled="true">
<parameters>
<parameter name="maximum">80</parameter>
</parameters>
</check>

<!-- <check level="error" class="org.scalastyle.scalariform.PublicMethodsHaveTypeChecker" enabled="true"/>-->

<check level="error" class="org.scalastyle.file.NewLineAtEofChecker" enabled="true"/>

<!-- We want the opposite of this: NewLineAtEofChecker is enabled above -->
<check level="error" class="org.scalastyle.file.NoNewLineAtEofChecker" enabled="false"/>

<!-- Avoid Java annotations -->
<check level="error" class="org.scalastyle.scalariform.OverrideJavaChecker" enabled="true"/>

<check level="error" class="org.scalastyle.scalariform.DeprecatedJavaChecker" enabled="true"/>

<check level="error" class="org.scalastyle.scalariform.EnsureSingleSpaceBeforeTokenChecker" enabled="true">
<parameters>
<parameter name="tokens">ARROW, EQUALS, ELSE, TRY, CATCH, FINALLY, LARROW, RARROW</parameter>
</parameters>
</check>

<check level="error" class="org.scalastyle.scalariform.EnsureSingleSpaceAfterTokenChecker" enabled="true">
<parameters>
<parameter name="tokens">ARROW, EQUALS, COMMA, COLON, IF, ELSE, DO, WHILE, FOR, MATCH, TRY, CATCH, FINALLY, LARROW, RARROW
</parameter>
</parameters>
</check>

<!-- JavaConversions should be replaced with JavaConverters -->
<!-- <check customId="javaconversions" level="error" class="org.scalastyle.scalariform.TokenChecker" enabled="true">-->
<!-- <parameters>-->
<!-- <parameter name="regex">JavaConversions</parameter>-->
<!-- </parameters>-->
<!-- <customMessage>Instead of importing implicits in scala.collection.JavaConversions._, import-->
<!-- scala.collection.JavaConverters._ and use .asScala / .asJava methods-->
<!-- </customMessage>-->
<!-- </check>-->

<check level="error" class="org.scalastyle.scalariform.DisallowSpaceBeforeTokenChecker" enabled="true">
<parameters>
<parameter name="tokens">COMMA</parameter>
</parameters>
</check>

<!-- ??? usually shouldn't be checked into the code base. -->
<check level="error" class="org.scalastyle.scalariform.NotImplementedErrorUsage" enabled="true"/>
</scalastyle>

0 comments on commit 1213220

Please sign in to comment.