Release 0.1.2

Author: Gilles Grousset

README.md

@@ -38,6 +38,14 @@ Checkout the [Releases](https://github.com/Backelite/sonar-swift/releases) page.
 
 ###Release history
 
+####0.1.2
+- SwiftLint 0.5.1 support (new rules added).
+- Added *sonar.swift.simulator* key in *sonar-project.properties* to select destination simulator for running tests
+- SwiftLint scans source directories only
+
+####0.1.1
+- SwiftLint 0.4.0 support (new rules added).
+
 ####0.1.0
 - Initial release.
 
@@ -66,7 +74,7 @@ To install slather with profdata support, follow those steps :
 
 ###Installation (once for all your Swift projects)
 - Download the plugin binary into the $SONARQUBE_HOME/extensions/plugins directory
-- Copy [run-sonar.sh](https://rawgithub.com/Backelite/sonar-swift/master/src/main/shell/run-sonar-swift.sh) somewhere in your PATH
+- Copy [run-sonar-swift.sh](https://rawgithub.com/Backelite/sonar-swift/master/src/main/shell/run-sonar-swift.sh) somewhere in your PATH
 - Restart the SonarQube server.
 
 ###Configuration (once per project)

build-and-deploy.sh

@@ -16,6 +16,7 @@ fi
 #fi
 
 # Deploy new version of plugin in Sonar dir
+rm target/*sources.jar
 cp target/*.jar $SONARQUBE_HOME/extensions/plugins
 
 # Stop/start Sonar

pom.xml

@@ -26,7 +26,7 @@
 
     <groupId>com.backelite.sonarqube</groupId>
     <artifactId>sonar-swift-plugin</artifactId>
-    <version>0.1.1</version>
+    <version>0.1.2</version>
 
     <packaging>sonar-plugin</packaging>
 

sonar-project.properties

@@ -15,6 +15,11 @@ sonar.projectDescription=prjDescription
 sonar.sources=SourceDir
 # Path to test directories (comment if no test)
 sonar.tests=TestDir
+
+# Destination Simulator to run tests
+# As string expected in destination argument of xcodebuild command
+# Example = sonar.swift.simulator=platform=iOS Simulator,name=iPhone 6,OS=9.2
+sonar.swift.simulator=platform=iOS Simulator,name=iPhone 6,OS=9.2
 
 # Xcode project configuration (.xcodeproj)
 # and use the later to specify which project(s) to include in the analysis (comma separated list)

src/main/resources/com/sonar/sqale/swiftlint-model.xml

@@ -45,6 +45,19 @@
         <chc>
             <key>READABILITY</key>
             <name>Readability</name>
+            <chc>
+                <rule-repo>SwiftLint</rule-repo>
+                <rule-key>valid_docs</rule-key>
+                <prop>
+                    <key>remediationFunction</key>
+                    <txt>CONSTANT_ISSUE</txt>
+                </prop>
+                <prop>
+                    <key>offset</key>
+                    <val>5</val>
+                    <txt>min</txt>
+                </prop>
+            </chc>
             <chc>
                 <rule-repo>SwiftLint</rule-repo>
                 <rule-key>line_length</rule-key>

src/main/resources/org/sonar/plugins/swiftlint/profile-swiftlint.xml

@@ -27,6 +27,10 @@
       <repositoryKey>SwiftLint</repositoryKey>
       <key>leading_whitespace</key>
     </rule>
+    <rule>
+      <repositoryKey>SwiftLint</repositoryKey>
+      <key>legacy_constructor</key>
+    </rule>
     <rule>
       <repositoryKey>SwiftLint</repositoryKey>
       <key>nesting</key>
@@ -67,6 +71,10 @@
       <repositoryKey>SwiftLint</repositoryKey>
       <key>type_name</key>
     </rule>
+    <rule>
+      <repositoryKey>SwiftLint</repositoryKey>
+      <key>valid_docs</key>
+    </rule>
     <rule>
       <repositoryKey>SwiftLint</repositoryKey>
       <key>variable_name</key>

src/main/resources/org/sonar/plugins/swiftlint/rules.json

@@ -41,6 +41,13 @@
         "description": "Files should not contain leading whitespace.",
         "severity": "MINOR"
     },
+    {
+        "category": "SwiftLint",
+        "name": "Legacy Constructor",
+        "key": "legacy_constructor",
+        "description": "Swift constructors are preferred over legacy convenience functions.",
+        "severity": "MINOR"
+    },
     {
         "category": "SwiftLint",
         "name": "Nesting",
@@ -111,11 +118,18 @@
         "description": "Type name should only contain alphanumeric characters, start with an uppercase character and span between 3 and 40 characters in length.",
         "severity": "MINOR"
     },
+    {
+        "category": "SwiftLint",
+        "name": "Valid Docs",
+        "key": "valid_docs",
+        "description": "Documented declarations should be valid.",
+        "severity": "MINOR"
+    },
     {
         "category": "SwiftLint",
         "name": "Variable Name",
         "key": "variable_name",
-        "description": "Variable name should only contain alphanumeric characters and start with a a lowercase character. In an exception to the above, variable names may start with a capital letter when they are declared static and immutable.",
+        "description": "Variable name should only contain alphanumeric characters and start with a lowercase character or should only contain capital letters. In an exception to the above, variable names may start with a capital letter when they are declared static and immutable.",
         "severity": "CRITICAL"
     },
     {

src/main/shell/run-sonar-swift.sh

@@ -144,9 +144,6 @@ echo "Running run-sonar-swift.sh..."
 
 ## CHECK PREREQUISITES
 
-# Tests installed tools
-## TODO : see original Objc shell
-
 # sonar-project.properties in current directory
 if [ ! -f sonar-project.properties ]; then
 	echo >&2 "ERROR - No sonar-project.properties in current directory"; exit 1;
@@ -169,6 +166,10 @@ srcDirs=''; readParameter srcDirs 'sonar.sources'
 # The name of your application scheme in Xcode
 appScheme=''; readParameter appScheme 'sonar.swift.appScheme'
 
+# Read destination simulator
+destinationSimulator=''; readParameter destinationSimulator 'sonar.swift.simulator'
+
+
 # The file patterns to exclude from coverage report
 excludedPathsFromCoverage=''; readParameter excludedPathsFromCoverage 'sonar.swift.excludedPathsFromCoverage'
 
@@ -189,10 +190,15 @@ if [ -z "$appScheme" -o "$appScheme" = " " ]; then
 	echo >&2 "ERROR - sonar.swift.appScheme parameter is missing in sonar-project.properties. You must specify which scheme is used to build your application."
 	exit 1
 fi
+if [ -z "$destinationSimulator" -o "$destinationSimulator" = " " ]; then
+	echo >&2 "ERROR - sonar.swift.simulator parameter is missing in sonar-project.properties. You must specify which simulator to use."
+	exit 1
+fi
 
 if [ "$vflag" = "on" ]; then
  	echo "Xcode project file is: $projectFile"
  	echo "Xcode application scheme is: $appScheme"
+ 	echo "Destination simulator is: $destinationSimulator"
  	echo "Excluded paths from coverage are: $excludedPathsFromCoverage" 	
 fi
 
@@ -220,7 +226,11 @@ echo "<?xml version='1.0' ?><!DOCTYPE coverage SYSTEM 'http://cobertura.sourcefo
 
 echo -n 'Running tests'
 runCommand /dev/stdout xcodebuild clean -workspace $workspaceFile -scheme $appScheme
-runCommand sonar-reports/xcodebuild.log xcodebuild test -workspace $workspaceFile -scheme $appScheme -sdk iphonesimulator -configuration Debug -enableCodeCoverage YES
+buildCmd=(xcodebuild test -workspace $workspaceFile -scheme $appScheme -sdk iphonesimulator -configuration Debug -enableCodeCoverage YES)
+if [[ ! -z "$destinationSimulator" ]]; then
+    buildCmd+=(-destination "$destinationSimulator" -destination-timeout 60)
+fi
+runCommand  sonar-reports/xcodebuild.log "${buildCmd[@]}"
 cat sonar-reports/xcodebuild.log  | $XCPRETTY_CMD -t --report junit
 mv build/reports/junit.xml sonar-reports/TEST-report.xml
 
@@ -256,7 +266,7 @@ if [ "$swiftlint" = "on" ]; then
 	while read word; do
 
 		# Run SwiftLint command
-	    $SWIFTLINT_CMD > sonar-reports/$(echo $word | sed 's/\//_/g')-swiftlint.txt
+	    $SWIFTLINT_CMD lint --path $word > sonar-reports/$(echo $word | sed 's/\//_/g')-swiftlint.txt
 
 	done < tmpFileRunSonarSh
 	rm -rf tmpFileRunSonarSh