feat: Adds checkstyle module. (#1685)

damencho · web-flow · commit 2ad6eb0b2a4a · 2021-09-02T12:54:55.000-05:00
* feat: Adds checkstyle module.
diff --git a/checkstyle.xml b/checkstyle.xml
diff --git a/jvb/checkstyle.xml b/jvb/checkstyle.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+          "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+          "https://checkstyle.org/dtds/configuration_1_3.dtd">
+
+<module name="Checker">
+    <module name="LineLength">
+        <property name="fileExtensions" value="java"/>
+        <property name="max" value="120"/>
+        <property name="ignorePattern" value="http://|https://"/>
+    </module>
+
+    <module name="TreeWalker">
+        <module name="LeftCurly">
+            <property name="option" value="nl"/>
+            <property name="tokens" value="LITERAL_CATCH"/>
+            <property name="tokens" value="LITERAL_ELSE"/>
+            <property name="tokens" value="LITERAL_FINALLY"/>
+            <property name="tokens" value="LITERAL_IF"/>
+            <property name="tokens" value="LITERAL_TRY"/>
+        </module>
+
+        <!-- Skips empty blocks {}, to not skip them: value="alone" -->
+        <module name="RightCurly">
+            <property name="option" value="alone_or_singleline"/>
+        </module>
+
+        <module name="WhitespaceAfter">
+            <!-- Drops TYPECAST from default tokens -->
+            <property name="tokens" value="COMMA , SEMI , LITERAL_IF , LITERAL_ELSE , LITERAL_WHILE , LITERAL_DO , LITERAL_FOR , DO_WHILE"/>
+        </module>
+    </module>
+
+    <module name="FileTabCharacter">
+        <property name="eachLine" value="true"/>
+    </module>
+</module>
diff --git a/jvb/pom.xml b/jvb/pom.xml
@@ -457,6 +457,21 @@
         <artifactId>maven-surefire-plugin</artifactId>
         <version>2.22.2</version>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+        <version>3.1.1</version>
+        <configuration>
+          <configLocation>checkstyle.xml</configLocation>
+        </configuration>
+        <executions>
+          <execution>
+            <goals>
+              <goal>check</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
       <plugin>
         <groupId>com.github.spotbugs</groupId>
         <artifactId>spotbugs-maven-plugin</artifactId>
diff --git a/jvb/src/main/java/org/jitsi/videobridge/Conference.java b/jvb/src/main/java/org/jitsi/videobridge/Conference.java
@@ -493,7 +493,8 @@ private double getMaxReceiverRtt(String excludedEndpointId)
      */
     void expire()
     {
-        if (!expired.compareAndSet(false, true)) {
+        if (!expired.compareAndSet(false, true))
+        {
             return;
         }
 
diff --git a/jvb/src/main/java/org/jitsi/videobridge/cc/vp8/VP8AdaptiveSourceProjectionContext.java b/jvb/src/main/java/org/jitsi/videobridge/cc/vp8/VP8AdaptiveSourceProjectionContext.java
@@ -462,7 +462,8 @@ private VP8FrameProjection createLayerSwitchProjection(
             tl0PicIdx = VpxUtils.applyTl0PicIdxDelta(lastVP8FrameProjection.getTl0PICIDX(),
                 1);
         }
-        else {
+        else
+        {
             picId = frame.getPictureId();
             tl0PicIdx = frame.getTl0PICIDX();
         }
@@ -708,7 +709,8 @@ public void rewriteRtp(
             throw new RewriteException("Frame not in tracker (aged off?)");
         }
 
-        if (vp8Frame.getProjection() == null) {
+        if (vp8Frame.getProjection() == null)
+        {
             /* Shouldn't happen for an accepted packet whose frame is still known? */
             throw new RewriteException("Frame does not have projection?");
         }
diff --git a/jvb/src/main/java/org/jitsi/videobridge/octo/ConfOctoTransport.java b/jvb/src/main/java/org/jitsi/videobridge/octo/ConfOctoTransport.java
@@ -229,7 +229,7 @@ public void setRelays(Collection<String> newRelayIds)
             {
                 bridgeOctoTransport.removeHandler(conferenceId, this);
             }
-            else if(remoteBridges.isEmpty())
+            else if (remoteBridges.isEmpty())
             {
                 bridgeOctoTransport.addHandler(conferenceId, this);
             }
diff --git a/jvb/src/main/java/org/jitsi/videobridge/rest/JSONDeserializer.java b/jvb/src/main/java/org/jitsi/videobridge/rest/JSONDeserializer.java
@@ -727,7 +727,8 @@ public static PayloadTypePacketExtension deserializePayloadType(
 
             Object rtcpFbs = payloadType.get(JSONSerializer.RTCP_FBS);
 
-            if (rtcpFbs != null && rtcpFbs instanceof JSONArray) {
+            if (rtcpFbs != null && rtcpFbs instanceof JSONArray)
+            {
                 deserializeRtcpFbs((JSONArray) rtcpFbs, payloadTypeIQ);
             }
 
diff --git a/jvb/src/main/java/org/jitsi/videobridge/sctp/SctpManager.java b/jvb/src/main/java/org/jitsi/videobridge/sctp/SctpManager.java
@@ -129,8 +129,10 @@ public SctpClientSocket createClientSocket() {
     /**
      * Close the active {@link SctpSocket}, if there is one
      */
-    public void closeConnection() {
-        if (socket != null) {
+    public void closeConnection()
+    {
+        if (socket != null)
+        {
             if (logger.isDebugEnabled())
             {
                 logger.debug("Closing SCTP socket " + socket.hashCode());
diff --git a/jvb/src/main/java/org/jitsi/videobridge/shim/ChannelShim.java b/jvb/src/main/java/org/jitsi/videobridge/shim/ChannelShim.java
@@ -245,7 +245,8 @@ public void describe(ColibriConferenceIQ.ChannelCommon commonIq)
                 iq.addSource(bridgeSource);
             }
 
-            if (sources != null) {
+            if (sources != null)
+            {
                 int[] ssrcs = sources.stream()
                         .map(SourcePacketExtension::getSSRC)
                         .filter(ssrc -> ssrc != -1L)
@@ -255,7 +256,8 @@ public void describe(ColibriConferenceIQ.ChannelCommon commonIq)
                 iq.setSSRCs(ssrcs);
             }
 
-            if (sourceGroups != null) {
+            if (sourceGroups != null)
+            {
                 sourceGroups.forEach(iq::addSourceGroup);
             }
         }
diff --git a/jvb/src/main/java/org/jitsi/videobridge/shim/ConferenceShim.java b/jvb/src/main/java/org/jitsi/videobridge/shim/ConferenceShim.java
@@ -447,9 +447,12 @@ public IQ handleColibriConferenceIQ(ColibriConferenceIQ conferenceIQ)
             {
                 // Item not found conditions are assumed to be less critical, as they often happen in case a request
                 // arrives late for an expired endpoint.
-                if (XMPPError.Condition.item_not_found.equals(e.getCondition())) {
+                if (XMPPError.Condition.item_not_found.equals(e.getCondition()))
+                {
                     logger.warn("Error processing channels: " + e);
-                } else {
+                }
+                else
+                {
                     logger.error("Error processing channels: " + e);
                 }
                 return IQUtils.createError(conferenceIQ, e.getCondition(), e.getMessage());
diff --git a/jvb/src/main/java/org/jitsi/videobridge/stats/Statistics.java b/jvb/src/main/java/org/jitsi/videobridge/stats/Statistics.java
@@ -46,7 +46,7 @@ public static ColibriStatsExtension toXmppExtensionElement(
     {
         ColibriStatsExtension ext = new ColibriStatsExtension();
 
-        for (Map.Entry<String,Object> e : statistics.getStats().entrySet())
+        for (Map.Entry<String, Object> e : statistics.getStats().entrySet())
         {
             ext.addStat(
                     new ColibriStatsExtension.Stat(e.getKey(), e.getValue()));
@@ -65,7 +65,7 @@ public static ColibriStatsExtension toXmppExtensionElement(
     /**
      * Map of the names of the statistics and their values.
      */
-    private final Map<String,Object> stats = new HashMap<>();
+    private final Map<String, Object> stats = new HashMap<>();
 
     /**
      * Generates/updates the statistics represented by this instance.
@@ -230,10 +230,10 @@ else if (o instanceof Number)
      *
      * @return the map with the names of the statistics and their values.
      */
-    public Map<String,Object> getStats()
+    public Map<String, Object> getStats()
     {
         Lock lock = this.lock.readLock();
-        Map<String,Object> stats;
+        Map<String, Object> stats;
 
         lock.lock();
         try
@@ -275,7 +275,7 @@ public String toString()
     {
         StringBuilder s = new StringBuilder();
 
-        for(Map.Entry<String,Object> e : getStats().entrySet())
+        for (Map.Entry<String, Object> e : getStats().entrySet())
         {
             s.append(e.getKey()).append(":").append(e.getValue()).append("\n");
         }
diff --git a/jvb/src/main/java/org/jitsi/videobridge/xmpp/MediaSourceFactory.java b/jvb/src/main/java/org/jitsi/videobridge/xmpp/MediaSourceFactory.java
@@ -394,7 +394,8 @@ private static List<SourceSsrcs> getSourceSsrcs(
             });
         });
 
-        if (!sourceGroupsCopy.isEmpty()) {
+        if (!sourceGroupsCopy.isEmpty())
+        {
             logger.warn(
                 "Unprocessed source groups: " +
                     sourceGroupsCopy.stream()

Original file line number	Diff line number	Diff line change
`@@ -493,7 +493,8 @@ private double getMaxReceiverRtt(String excludedEndpointId)`
`493`	`493`	`*/`
`494`	`494`	`void expire()`
`495`	`495`	`{`
`496`		`- if (!expired.compareAndSet(false, true)) {`
	`496`	`+ if (!expired.compareAndSet(false, true))`
	`497`	`+ {`
`497`	`498`	`return;`
`498`	`499`	`}`
`499`	`500`
Original file line number	Diff line number	Diff line change
`@@ -462,7 +462,8 @@ private VP8FrameProjection createLayerSwitchProjection(`
`462`	`462`	`tl0PicIdx = VpxUtils.applyTl0PicIdxDelta(lastVP8FrameProjection.getTl0PICIDX(),`
`463`	`463`	`1);`
`464`	`464`	`}`
`465`		`- else {`
	`465`	`+ else`
	`466`	`+ {`
`466`	`467`	`picId = frame.getPictureId();`
`467`	`468`	`tl0PicIdx = frame.getTl0PICIDX();`
`468`	`469`	`}`
`@@ -708,7 +709,8 @@ public void rewriteRtp(`
`708`	`709`	`throw new RewriteException("Frame not in tracker (aged off?)");`
`709`	`710`	`}`
`710`	`711`
`711`		`- if (vp8Frame.getProjection() == null) {`
	`712`	`+ if (vp8Frame.getProjection() == null)`
	`713`	`+ {`
`712`	`714`	`/* Shouldn't happen for an accepted packet whose frame is still known? */`
`713`	`715`	`throw new RewriteException("Frame does not have projection?");`
`714`	`716`	`}`
Original file line number	Diff line number	Diff line change
`@@ -229,7 +229,7 @@ public void setRelays(Collection<String> newRelayIds)`
`229`	`229`	`{`
`230`	`230`	`bridgeOctoTransport.removeHandler(conferenceId, this);`
`231`	`231`	`}`
`232`		`- else if(remoteBridges.isEmpty())`
	`232`	`+ else if (remoteBridges.isEmpty())`
`233`	`233`	`{`
`234`	`234`	`bridgeOctoTransport.addHandler(conferenceId, this);`
`235`	`235`	`}`
Original file line number	Diff line number	Diff line change
`@@ -727,7 +727,8 @@ public static PayloadTypePacketExtension deserializePayloadType(`
`727`	`727`
`728`	`728`	`Object rtcpFbs = payloadType.get(JSONSerializer.RTCP_FBS);`
`729`	`729`
`730`		`- if (rtcpFbs != null && rtcpFbs instanceof JSONArray) {`
	`730`	`+ if (rtcpFbs != null && rtcpFbs instanceof JSONArray)`
	`731`	`+ {`
`731`	`732`	`deserializeRtcpFbs((JSONArray) rtcpFbs, payloadTypeIQ);`
`732`	`733`	`}`
`733`	`734`
Original file line number	Diff line number	Diff line change
`@@ -245,7 +245,8 @@ public void describe(ColibriConferenceIQ.ChannelCommon commonIq)`
`245`	`245`	`iq.addSource(bridgeSource);`
`246`	`246`	`}`
`247`	`247`
`248`		`- if (sources != null) {`
	`248`	`+ if (sources != null)`
	`249`	`+ {`
`249`	`250`	`int[] ssrcs = sources.stream()`
`250`	`251`	`.map(SourcePacketExtension::getSSRC)`
`251`	`252`	`.filter(ssrc -> ssrc != -1L)`
`@@ -255,7 +256,8 @@ public void describe(ColibriConferenceIQ.ChannelCommon commonIq)`
`255`	`256`	`iq.setSSRCs(ssrcs);`
`256`	`257`	`}`
`257`	`258`
`258`		`- if (sourceGroups != null) {`
	`259`	`+ if (sourceGroups != null)`
	`260`	`+ {`
`259`	`261`	`sourceGroups.forEach(iq::addSourceGroup);`
`260`	`262`	`}`
`261`	`263`	`}`