Merge pull request #3 from codacy/add-badges

Add badges and tests

Author: Rodrigo Fernandes

README.md

@@ -0,0 +1,33 @@
+[![Codacy Badge](https://api.codacy.com/project/badge/grade/bc3a79d1b12649158a1eb4758e872141)](https://www.codacy.com/app/Codacy/codacy-engine-scala-seed)
+[![Codacy Badge](https://api.codacy.com/project/badge/coverage/bc3a79d1b12649158a1eb4758e872141)](https://www.codacy.com/app/Codacy/codacy-engine-scala-seed)
+[![Build Status](https://circleci.com/gh/codacy/codacy-engine-scala-seed.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/codacy/codacy-engine-scala-seed)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.codacy/codacy-engine-scala-seed_2.11/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.codacy/codacy-engine-scala-seed_2.11)
+
+# Engine Scala Seed
+
+We use external tools at Codacy, this is the library we use across the multiple external tools integrations.
+For more details and examples of tools that use this project, you can check
+[PMDJava](https://github.com/codacy/codacy-pmdjava),
+[ESLint](https://github.com/codacy/codacy-eslint) and
+[Pylint](https://github.com/codacy/codacy-pylint).
+
+### Usage
+
+Add to your SBT dependencies:
+
+```
+"com.codacy" %% "codacy-engine-scala-seed" % "1.4.0"
+```
+
+You shouldn't worry about the library itself, we use it as a core in our tools,
+and everything is well explained in our Docs section.
+
+## Docs
+
+[Docker Docs](http://docs.codacy.com/v1.5/docs/tool-developer-guide)
+
+[Scala Docker Template Docs](http://docs.codacy.com/v1.5/docs/tool-developer-guide-using-scala)
+
+## Test
+
+Follow the instructions at [codacy-plugins-test](https://github.com/codacy/codacy-plugins-test/blob/master/README.md#test-definition)

build.sbt

@@ -12,7 +12,10 @@ scalacOptions := Seq("-deprecation", "-feature", "-unchecked", "-Ywarn-adapted-a
 
 resolvers += "Bintray Typesafe Repo" at "http://dl.bintray.com/typesafe/maven-releases/"
 
-libraryDependencies += "com.typesafe.play" %% "play-json" % "2.3.10"
+libraryDependencies ++= Seq(
+  "com.typesafe.play" %% "play-json" % "2.3.10",
+  "org.scalatest" %% "scalatest" % "2.2.4" % "test"
+)
 
 organizationName := "Codacy"
 

circle.yml

@@ -0,0 +1,10 @@
+machine:
+  java:
+    version: oraclejdk8
+
+test:
+  override:
+    - sbt clean coverage test
+    - sbt coverageReport
+    - sbt coverageAggregate
+    - sbt codacyCoverage

project/plugins.sbt

@@ -13,3 +13,7 @@ addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "0.5.1")
 addSbtPlugin("com.jsuereth" % "sbt-pgp" % "1.0.0")
 
 addSbtPlugin("com.timushev.sbt" % "sbt-updates" % "0.1.9")
+
+addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.3.3")
+
+addSbtPlugin("com.codacy" % "sbt-codacy-coverage" % "1.2.1")

src/main/scala/codacy/dockerApi/utils/CommandRunner.scala

@@ -19,15 +19,18 @@ object CommandRunner {
 
     val pio = new ProcessIO(_.close(), readStream(stdout), readStream(stderr))
 
-    val process = Process(cmd, dir).run(pio)
-    val result = Try(process.exitValue())
+    Try(Process(cmd, dir).run(pio)) match {
+      case Success(process) =>
+        Try(process.exitValue()) match {
+          case Success(exitValue) =>
+            Right(CommandResult(exitValue, stdout, stderr))
 
-    result match {
-      case Success(exitValue) =>
-        Right(CommandResult(exitValue, stdout, stderr))
+          case Failure(e) =>
+            process.destroy()
+            Left(e)
+        }
 
       case Failure(e) =>
-        process.destroy()
         Left(e)
     }
   }

src/main/scala/codacy/dockerApi/utils/FileHelper.scala

@@ -27,13 +27,8 @@ object FileHelper {
   }
 
   def stripPath(filename: String, prefix: String): String = {
-
-    val FilenameRegex = s""".*$prefix/(.*)""".r
-
-    filename match {
-      case FilenameRegex(res) => res;
-      case _ => filename
-    }
+    filename.stripPrefix(prefix)
+      .stripPrefix("/")
   }
 
   def listAllFiles(path: String): Seq[File] = {

src/main/scala/codacy/dockerApi/utils/ToolHelper.scala

@@ -4,38 +4,29 @@ import codacy.dockerApi._
 
 object ToolHelper {
 
-  def getPatternsToLint(conf: Option[Seq[PatternDef]])(implicit spec: Spec): Seq[PatternDef] = {
-    conf.fold(getDefaultConfFromSpec(spec)) {
+  def getPatternsToLint(conf: Option[Seq[PatternDef]])(implicit spec: Spec): Option[Seq[PatternDef]] = {
+    conf.map {
       configuration =>
         configuration.map(pattern => getMissingParametersFromSpec(pattern))
     }
   }
 
-  private def convertToParametersDefFromSpec(parametersSpec: Option[Set[ParameterSpec]]): Option[Set[ParameterDef]] = {
-    parametersSpec.map(params => params.map(param => ParameterDef(param.name, param.default)))
-  }
-
-  private def getDefaultConfFromSpec(spec: Spec): Seq[PatternDef] = {
-    spec.patterns.toSeq.map(pattern => PatternDef(pattern.patternId, convertToParametersDefFromSpec(pattern.parameters)))
-  }
-
-
   private def buildParameterDefFromSpec(parameterSpec: ParameterSpec): ParameterDef = {
     ParameterDef(parameterSpec.name, parameterSpec.default)
   }
 
-  private def getParametersByPatternId(patternId: PatternId)(implicit spec: Spec): Set[ParameterDef] = {
+  private def getParametersByPatternId(patternId: PatternId)(implicit spec: Spec): Option[Set[ParameterDef]] = {
     val specPattern = spec.patterns.find(_.patternId == patternId)
 
     specPattern.flatMap {
       patternSpec =>
         patternSpec.parameters.map(params => params.map(buildParameterDefFromSpec))
-    }.getOrElse(Set())
+    }
   }
 
   private def getMissingParametersFromSpec(pattern: PatternDef)(implicit spec: Spec): PatternDef = {
-    val params = pattern.parameters.getOrElse(getParametersByPatternId(pattern.patternId))
-    PatternDef(pattern.patternId, Some(params))
+    val params = pattern.parameters.orElse(getParametersByPatternId(pattern.patternId))
+    PatternDef(pattern.patternId, params)
   }
 
 }

src/test/scala/HelloSpec.scala

@@ -0,0 +1,33 @@
+package codacy.dockerApi.utils
+
+import org.scalatest._
+import org.scalatest.EitherValues._
+
+import scala.collection.mutable.ArrayBuffer
+
+class CommandRunnerTest extends FlatSpec with Matchers {
+
+  val genericCMD = Seq("echo", "foo")
+  val invalidCMD = Seq("rm", "nofile.ext")
+  val errorCMD = Seq("rmzzz", "nofile.ext")
+
+  "CommandRunner" should "simpleEchoExec" in {
+    val result: Either[Throwable, CommandResult] = CommandRunner.exec(genericCMD)
+
+    result.right.value.stdout should be(ArrayBuffer("foo"))
+    result.right.value.exitCode should be(0)
+  }
+
+  "CommandRunner" should "handleInvalidExec" in {
+    val result: Either[Throwable, CommandResult] = CommandRunner.exec(invalidCMD)
+
+    result.right.value.stdout should be(ArrayBuffer())
+    result.right.value.exitCode should be(1)
+  }
+
+  "CommandRunner" should "handleErrorExec" in {
+    val result: Either[Throwable, CommandResult] = CommandRunner.exec(errorCMD)
+
+    result should be('left)
+  }
+}

src/test/scala/codacy/dockerApi/utils/CommandRunnerTest.scala

@@ -0,0 +1,61 @@
+package codacy.dockerApi.utils
+
+import org.scalatest._
+
+class FileHelperTest extends FlatSpec with Matchers {
+
+  "FileHelper" should "stripPath from String" in {
+    val pathString: String = "a/b/c/filename.ext"
+    val pathStringPrefix: String = "a/b"
+
+    val pathString2: String = "/a/b/filename.ext"
+    val pathStringPrefix2: String = "/a/b/"
+
+    val result: String = FileHelper.stripPath(pathString, pathStringPrefix)
+    result should be("c/filename.ext")
+
+    val result2: String = FileHelper.stripPath(pathString2, pathStringPrefix2)
+    result2 should be("filename.ext")
+  }
+
+  "FileHelper" should "stripPath with no common prefix" in {
+    val pathString: String = "filename.ext"
+    val pathString2: String = "c/d/filename.ext"
+
+    val result: String = FileHelper.stripPath(pathString, "/a/b/")
+    result should be(pathString)
+
+    val result2: String = FileHelper.stripPath(pathString2, "/a/b/")
+    result2 should be(pathString2)
+  }
+
+  "FileHelper" should "stripPath from Path" in {
+    val path: java.nio.file.Path = java.nio.file.Paths.get("a/b/c/filename.ext")
+    val pathPrefix: java.nio.file.Path = java.nio.file.Paths.get("a/b")
+
+    val path2: java.nio.file.Path = java.nio.file.Paths.get("/a/b/filename.ext")
+    val pathPrefix2: java.nio.file.Path = java.nio.file.Paths.get("/a/b/")
+
+    val result: String = FileHelper.stripPath(path, pathPrefix)
+    result should be("c/filename.ext")
+
+    val result2: String = FileHelper.stripPath(path2, pathPrefix2)
+    result2 should be("filename.ext")
+  }
+
+  "FileHelper" should "createTmpFile" in {
+    val fileTmp = FileHelper.createTmpFile("foo", "prefix", ".ext").toString
+
+    java.nio.file.Paths.get(fileTmp).getFileName.toString should startWith ("prefix")
+    fileTmp should endWith (".ext")
+    io.Source.fromFile(fileTmp).mkString should be("foo")
+  }
+
+  "FileHelper" should "createFile" in {
+    val pathString: String = "/tmp/fileHelperFilename.ext"
+    new java.io.File(pathString).delete()
+
+    val file = FileHelper.createFile(pathString, "foo").toString
+    io.Source.fromFile(file).mkString should be("foo")
+  }
+}