Skip to content
This repository was archived by the owner on Oct 12, 2023. It is now read-only.

Commit 5ca0910

Browse files
author
Zeqi Cui
committed
Added Scalastyle config
Fixed style check errors
1 parent 1b2ae39 commit 5ca0910

File tree

9 files changed

+206
-15
lines changed

9 files changed

+206
-15
lines changed

‎lib/scalastyle_config.xml

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
<scalastyle commentFilter="enabled">
2+
<name>Scalastyle standard configuration</name>
3+
<check level="warning" class="org.scalastyle.file.FileTabChecker" enabled="true"></check>
4+
<check level="warning" class="org.scalastyle.file.FileLengthChecker" enabled="true">
5+
<parameters>
6+
<parameter name="maxFileLength"><![CDATA[800]]></parameter>
7+
</parameters>
8+
</check>
9+
<check level="warning" class="org.scalastyle.file.HeaderMatchesChecker" enabled="true">
10+
<parameters>
11+
<parameter name="header"><![CDATA[/**
12+
* The MIT License (MIT)
13+
* Copyright (c) 2018 Microsoft Corporation
14+
*
15+
* Permission is hereby granted, free of charge, to any person obtaining a copy
16+
* of this software and associated documentation files (the "Software"), to deal
17+
* in the Software without restriction, including without limitation the rights
18+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
19+
* copies of the Software, and to permit persons to whom the Software is
20+
* furnished to do so, subject to the following conditions:
21+
*
22+
* The above copyright notice and this permission notice shall be included in all
23+
* copies or substantial portions of the Software.
24+
*
25+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
30+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31+
* SOFTWARE.
32+
*/]]></parameter>
33+
</parameters>
34+
</check>
35+
<check level="warning" class="org.scalastyle.scalariform.SpacesAfterPlusChecker" enabled="true"></check>
36+
<check level="warning" class="org.scalastyle.file.WhitespaceEndOfLineChecker" enabled="true"></check>
37+
<check level="warning" class="org.scalastyle.scalariform.SpacesBeforePlusChecker" enabled="true"></check>
38+
<check level="warning" class="org.scalastyle.file.FileLineLengthChecker" enabled="true">
39+
<parameters>
40+
<parameter name="maxLineLength"><![CDATA[160]]></parameter>
41+
<parameter name="tabSize"><![CDATA[4]]></parameter>
42+
</parameters>
43+
</check>
44+
<check level="warning" class="org.scalastyle.scalariform.ClassNamesChecker" enabled="true">
45+
<parameters>
46+
<parameter name="regex"><![CDATA[[A-Z][A-Za-z]*]]></parameter>
47+
</parameters>
48+
</check>
49+
<check level="warning" class="org.scalastyle.scalariform.ObjectNamesChecker" enabled="true">
50+
<parameters>
51+
<parameter name="regex"><![CDATA[[A-Z][A-Za-z]*]]></parameter>
52+
</parameters>
53+
</check>
54+
<check level="warning" class="org.scalastyle.scalariform.PackageObjectNamesChecker" enabled="true">
55+
<parameters>
56+
<parameter name="regex"><![CDATA[^[a-z][A-Za-z]*$]]></parameter>
57+
</parameters>
58+
</check>
59+
<check level="warning" class="org.scalastyle.scalariform.EqualsHashCodeChecker" enabled="true"></check>
60+
<check level="warning" class="org.scalastyle.scalariform.IllegalImportsChecker" enabled="true">
61+
<parameters>
62+
<parameter name="illegalImports"><![CDATA[sun._,java.awt._]]></parameter>
63+
</parameters>
64+
</check>
65+
<check level="warning" class="org.scalastyle.scalariform.ParameterNumberChecker" enabled="true">
66+
<parameters>
67+
<parameter name="maxParameters"><![CDATA[8]]></parameter>
68+
</parameters>
69+
</check>
70+
<check level="warning" class="org.scalastyle.scalariform.MagicNumberChecker" enabled="true">
71+
<parameters>
72+
<parameter name="ignore"><![CDATA[-1,0,1,2,3]]></parameter>
73+
</parameters>
74+
</check>
75+
<check level="warning" class="org.scalastyle.scalariform.NoWhitespaceBeforeLeftBracketChecker" enabled="false"></check>
76+
<check level="warning" class="org.scalastyle.scalariform.NoWhitespaceAfterLeftBracketChecker" enabled="true"></check>
77+
<check level="warning" class="org.scalastyle.scalariform.ReturnChecker" enabled="true"></check>
78+
<check level="warning" class="org.scalastyle.scalariform.NullChecker" enabled="false"></check>
79+
<check level="warning" class="org.scalastyle.scalariform.NoCloneChecker" enabled="true"></check>
80+
<check level="warning" class="org.scalastyle.scalariform.NoFinalizeChecker" enabled="true"></check>
81+
<check level="warning" class="org.scalastyle.scalariform.CovariantEqualsChecker" enabled="true"></check>
82+
<check level="warning" class="org.scalastyle.scalariform.StructuralTypeChecker" enabled="true"></check>
83+
<check level="warning" class="org.scalastyle.file.RegexChecker" enabled="true">
84+
<parameters>
85+
<parameter name="regex"><![CDATA[println]]></parameter>
86+
</parameters>
87+
</check>
88+
<check level="warning" class="org.scalastyle.scalariform.NumberOfTypesChecker" enabled="true">
89+
<parameters>
90+
<parameter name="maxTypes"><![CDATA[30]]></parameter>
91+
</parameters>
92+
</check>
93+
<check level="warning" class="org.scalastyle.scalariform.CyclomaticComplexityChecker" enabled="true">
94+
<parameters>
95+
<parameter name="maximum"><![CDATA[15]]></parameter>
96+
</parameters>
97+
</check>
98+
<check level="warning" class="org.scalastyle.scalariform.UppercaseLChecker" enabled="true"></check>
99+
<check level="warning" class="org.scalastyle.scalariform.SimplifyBooleanExpressionChecker" enabled="true"></check>
100+
<check level="warning" class="org.scalastyle.scalariform.IfBraceChecker" enabled="true">
101+
<parameters>
102+
<parameter name="singleLineAllowed"><![CDATA[true]]></parameter>
103+
<parameter name="doubleLineAllowed"><![CDATA[false]]></parameter>
104+
</parameters>
105+
</check>
106+
<check level="warning" class="org.scalastyle.scalariform.MethodLengthChecker" enabled="true">
107+
<parameters>
108+
<parameter name="maxLength"><![CDATA[70]]></parameter>
109+
</parameters>
110+
</check>
111+
<check level="warning" class="org.scalastyle.scalariform.MethodNamesChecker" enabled="true">
112+
<parameters>
113+
<parameter name="regex"><![CDATA[^[a-z][A-Za-z0-9]*$]]></parameter>
114+
</parameters>
115+
</check>
116+
<check level="warning" class="org.scalastyle.scalariform.NumberOfMethodsInTypeChecker" enabled="true">
117+
<parameters>
118+
<parameter name="maxMethods"><![CDATA[30]]></parameter>
119+
</parameters>
120+
</check>
121+
<check level="warning" class="org.scalastyle.scalariform.PublicMethodsHaveTypeChecker" enabled="false"></check>
122+
<check level="warning" class="org.scalastyle.file.NewLineAtEofChecker" enabled="true"></check>
123+
<check level="warning" class="org.scalastyle.file.NoNewLineAtEofChecker" enabled="false"></check>
124+
<check level="warning" class="org.scalastyle.scalariform.WhileChecker" enabled="false"></check>
125+
<check level="warning" class="org.scalastyle.scalariform.VarFieldChecker" enabled="false"></check>
126+
<check level="warning" class="org.scalastyle.scalariform.VarLocalChecker" enabled="false"></check>
127+
<check level="warning" class="org.scalastyle.scalariform.RedundantIfChecker" enabled="true"></check>
128+
<check level="warning" class="org.scalastyle.scalariform.TokenChecker" enabled="true">
129+
<parameters>
130+
<parameter name="regex"><![CDATA[println]]></parameter>
131+
</parameters>
132+
<customMessage>Avoid print line, use logger.</customMessage>
133+
</check>
134+
<check level="warning" class="org.scalastyle.scalariform.DeprecatedJavaChecker" enabled="true"></check>
135+
<check level="warning" class="org.scalastyle.scalariform.EmptyClassChecker" enabled="true"></check>
136+
<check level="warning" class="org.scalastyle.scalariform.ClassTypeParameterChecker" enabled="false">
137+
<parameters>
138+
<parameter name="regex"><![CDATA[^[A-Z_]$]]></parameter>
139+
</parameters>
140+
</check>
141+
<check level="warning" class="org.scalastyle.scalariform.UnderscoreImportChecker" enabled="false"></check>
142+
<check level="warning" class="org.scalastyle.scalariform.LowercasePatternMatchChecker" enabled="true"></check>
143+
<check level="warning" class="org.scalastyle.scalariform.MultipleStringLiteralsChecker" enabled="false">
144+
<parameters>
145+
<parameter name="allowed"><![CDATA[2]]></parameter>
146+
<parameter name="ignoreRegex"><![CDATA[^""$]]></parameter>
147+
</parameters>
148+
</check>
149+
<check level="warning" class="org.scalastyle.scalariform.ImportGroupingChecker" enabled="true"></check>
150+
</scalastyle>

‎pom.xml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,6 @@
134134
<sourceDirectory>${project.basedir}/src/main/scala</sourceDirectory>
135135
<testSourceDirectory>${project.basedir}/src/test/scala</testSourceDirectory>
136136
<configLocation>${project.basedir}/lib/scalastyle_config.xml</configLocation>
137-
<outputFile>${project.basedir}/scalastyle-output.xml</outputFile>
138137
<outputEncoding>UTF-8</outputEncoding>
139138
</configuration>
140139
<executions>

‎src/main/scala/com/microsoft/azure/sqldb/spark/config/SqlDBConfigBuilder.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
*/
2323
package com.microsoft.azure.sqldb.spark.config
2424

25-
import com.microsoft.azure.sqldb.spark.config.Config._
25+
import com.microsoft.azure.sqldb.spark.config.Config.Property
2626

2727
case class SqlDBConfigBuilder(props: Map[Property, Any] = Map()) extends {
2828

‎src/main/scala/com/microsoft/azure/sqldb/spark/connect/package.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,4 @@ package object connect {
6666
@DeveloperApi
6767
implicit def toDataFrameFunctions[T](ds: Dataset[T]): DataFrameFunctions[Row] = DataFrameFunctions[Row](ds.toDF())
6868

69-
}
69+
}

‎src/main/scala/com/microsoft/azure/sqldb/spark/query/package.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,5 @@ package object query {
4141
*/
4242
@DeveloperApi
4343
implicit def toQueryFunctions(sqlContext: SQLContext): QueryFunctions = QueryFunctions(sqlContext)
44-
44+
4545
}

‎src/test/scala/com/microsoft/azure/sqldb/spark/SqlDBSpark.scala

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,27 @@
1+
/**
2+
* The MIT License (MIT)
3+
* Copyright (c) 2018 Microsoft Corporation
4+
*
5+
* Permission is hereby granted, free of charge, to any person obtaining a copy
6+
* of this software and associated documentation files (the "Software"), to deal
7+
* in the Software without restriction, including without limitation the rights
8+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
* copies of the Software, and to permit persons to whom the Software is
10+
* furnished to do so, subject to the following conditions:
11+
*
12+
* The above copyright notice and this permission notice shall be included in all
13+
* copies or substantial portions of the Software.
14+
*
15+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
* SOFTWARE.
22+
*/
123
package com.microsoft.azure.sqldb.spark
224

325
import org.scalatest.{BeforeAndAfter, BeforeAndAfterEach, FlatSpec, Matchers}
426

5-
trait SqlDBSpark extends FlatSpec with Matchers with BeforeAndAfter with BeforeAndAfterEach {
6-
7-
}
27+
trait SqlDBSpark extends FlatSpec with Matchers with BeforeAndAfter with BeforeAndAfterEach

‎src/test/scala/com/microsoft/azure/sqldb/spark/bulk/BulkCopyUtilsSpec.scala

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1+
/**
2+
* The MIT License (MIT)
3+
* Copyright (c) 2018 Microsoft Corporation
4+
*
5+
* Permission is hereby granted, free of charge, to any person obtaining a copy
6+
* of this software and associated documentation files (the "Software"), to deal
7+
* in the Software without restriction, including without limitation the rights
8+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
* copies of the Software, and to permit persons to whom the Software is
10+
* furnished to do so, subject to the following conditions:
11+
*
12+
* The above copyright notice and this permission notice shall be included in all
13+
* copies or substantial portions of the Software.
14+
*
15+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
* SOFTWARE.
22+
*/
123
package com.microsoft.azure.sqldb.spark.bulk
224

325
import com.microsoft.azure.sqldb.spark.SqlDBSpark

‎src/test/scala/com/microsoft/azure/sqldb/spark/config/ConfigSpec.scala

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,20 @@ import com.microsoft.azure.sqldb.spark.SqlDBSpark
2727
class ConfigSpec extends SqlDBSpark {
2828

2929
it should "throw IllegalArgumentException if required properties aren't met" in {
30-
a [IllegalArgumentException] should be thrownBy {
30+
an [IllegalArgumentException] should be thrownBy {
3131
Config(Map("url" -> "mysql.database.windows.net"))
3232
}
3333
}
3434

3535
it should "throw IllegalArgumentException if queryCustom and dbTable are both stated" in {
36-
a [IllegalArgumentException] should be thrownBy {
36+
an [IllegalArgumentException] should be thrownBy {
3737
Config(Map(
3838
"url" -> "mysql.database.windows.net",
39-
"databaseName" -> "",
40-
"user" -> "",
41-
"password" -> "",
42-
"dbTable" -> "",
43-
"QueryCustom" -> ""
39+
"databaseName" -> "MyDatabase",
40+
"user" -> "MyUsername",
41+
"password" -> "**********",
42+
"dbTable" -> "MyDBTable",
43+
"QueryCustom" -> "MyQueryCustom"
4444
))
4545
}
4646
}

‎src/test/scala/com/microsoft/azure/sqldb/spark/connect/ConnectionUtilsSpec.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,4 @@ class ConnectionUtilsSpec extends SqlDBSpark {
8686
))
8787
ConnectionUtils.getTableOrQuery(queryConfig) should be (ConnectionUtils.getQueryCustom(queryCustom))
8888
}
89-
}
89+
}

0 commit comments

Comments
 (0)