Alpha Release

README.md

@@ -5,10 +5,10 @@ The web API implementation for the Delphi platform.
 We are currently in pre-alpha state! There is no release and the code in
 this repository is purely experimental!
 
-|branch | status | codacy |
-| :---: | :---: | :---: |
-| master | [![Build Status](https://travis-ci.org/delphi-hub/delphi-webapi.svg?branch=master)](https://travis-ci.org/delphi-hub/delphi-webapi) | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/8ebe27850ffb4139af6280fd1cd6d540)](https://www.codacy.com/app/delphi-hub/delphi-webapi?utm_source=github.com&utm_medium=referral&utm_content=delphi-hub/delphi-webapi&utm_campaign=Badge_Grade)|
-| develop | [![Build Status](https://travis-ci.org/delphi-hub/delphi-webapi.svg?branch=develop)](https://travis-ci.org/delphi-hub/delphi-webapi) | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/8ebe27850ffb4139af6280fd1cd6d540?branch=develop)](https://www.codacy.com/app/delphi-hub/delphi-webapi?branch=develop&utm_source=github.com&utm_medium=referral&utm_content=delphi-hub/delphi-webapi&utm_campaign=Badge_Grade) |
+|branch | status | codacy | snyk |
+| :---: | :---: | :---: | :---: |  
+| master | [![Build Status](https://travis-ci.org/delphi-hub/delphi-webapi.svg?branch=master)](https://travis-ci.org/delphi-hub/delphi-webapi) | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/8ebe27850ffb4139af6280fd1cd6d540)](https://www.codacy.com/app/delphi-hub/delphi-webapi?utm_source=github.com&utm_medium=referral&utm_content=delphi-hub/delphi-webapi&utm_campaign=Badge_Grade)| [![Known Vulnerabilities](https://snyk.io/test/github/delphi-hub/delphi-webapi/badge.svg?targetFile=build.sbt)](https://snyk.io/test/github/delphi-hub/delphi-webapi/?targetFile=build.sbt) |
+| develop | [![Build Status](https://travis-ci.org/delphi-hub/delphi-webapi.svg?branch=develop)](https://travis-ci.org/delphi-hub/delphi-webapi) | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/8ebe27850ffb4139af6280fd1cd6d540?branch=develop)](https://www.codacy.com/app/delphi-hub/delphi-webapi?branch=develop&utm_source=github.com&utm_medium=referral&utm_content=delphi-hub/delphi-webapi&utm_campaign=Badge_Grade) | [![Known Vulnerabilities](https://snyk.io/test/github/delphi-hub/delphi-webapi/develop/badge.svg?targetFile=build.sbt)](https://snyk.io/test/github/delphi-hub/delphi-webapi/develop/?targetFile=build.sbt) |
 
 ## What is the Delphi Web API?
 

build.sbt

@@ -4,36 +4,42 @@ version := "1.0.0-SNAPSHOT"
 
 scalaVersion := "2.12.4"
 
-libraryDependencies += "org.parboiled" %% "parboiled" % "2.1.4"
-libraryDependencies += "com.typesafe.akka" %% "akka-http" % "10.0.11"
-libraryDependencies += "com.typesafe.akka" %% "akka-stream" % "2.5.12"
-libraryDependencies += "com.typesafe.akka" %% "akka-http-spray-json" % "10.1.1"
-libraryDependencies += "io.spray" %%  "spray-json" % "1.3.3"
-libraryDependencies += "org.parboiled" %% "parboiled" % "2.1.4"
-libraryDependencies += "org.scalactic" %% "scalactic" % "3.0.4"
-libraryDependencies += "org.scalatest" %% "scalatest" % "3.0.4" % "test"
+val akkaVersion = "2.5.14"
+libraryDependencies ++= Seq (
+  "com.typesafe.akka" %% "akka-stream" % akkaVersion,
+  "com.typesafe.akka" %% "akka-slf4j" % akkaVersion
+)
+
+val akkaHttpVersion = "10.1.5"
+libraryDependencies ++= Seq (
+  "com.typesafe.akka" %% "akka-http" % akkaHttpVersion,
+  "com.typesafe.akka" %% "akka-http-testkit" % akkaHttpVersion,
+  "com.typesafe.akka" %% "akka-http-spray-json" % akkaHttpVersion
+)
 
 val elastic4sVersion = "6.3.0"
 libraryDependencies ++= Seq(
   "com.sksamuel.elastic4s" %% "elastic4s-core" % elastic4sVersion,
-
-  // for the http client
   "com.sksamuel.elastic4s" %% "elastic4s-http" % elastic4sVersion,
-
-  // if you want to use reactive streams
   "com.sksamuel.elastic4s" %% "elastic4s-http-streams" % elastic4sVersion,
-
-  // testing
-  "com.sksamuel.elastic4s" %% "elastic4s-testkit" % elastic4sVersion % "test",
-  "com.sksamuel.elastic4s" %% "elastic4s-embedded" % elastic4sVersion % "test"
 )
 
+libraryDependencies += "org.parboiled" %% "parboiled" % "2.1.4"
+libraryDependencies += "io.spray" %% "spray-json" % "1.3.3"
+libraryDependencies += "org.scalactic" %% "scalactic" % "3.0.4"
+libraryDependencies += "org.scalatest" %% "scalatest" % "3.0.4" % "it,test"
+libraryDependencies += "ch.qos.logback" % "logback-classic" % "1.2.3" % Runtime
 
 lazy val webapi = (project in file(".")).
+  //https://www.scala-sbt.org/1.x/docs/Testing.html
+configs(IntegrationTest).
+  settings(
+    Defaults.itSettings,
+   ).
   enablePlugins(JavaAppPackaging).
   enablePlugins(DockerPlugin).
   enablePlugins(ScalastylePlugin).
-  settings (
+  settings(
     dockerBaseImage := "openjdk:jre-alpine"
   ).
   enablePlugins(AshScriptPlugin).
@@ -44,3 +50,11 @@ lazy val webapi = (project in file(".")).
   )
 
 scalastyleConfig := baseDirectory.value / "project" / "scalastyle-config.xml"
+
+// Pinning secure versions of insecure transitive libraryDependencies
+// Please update when updating dependencies above (including Play plugin)
+libraryDependencies ++= Seq(
+  "com.fasterxml.jackson.core" % "jackson-databind" % "2.9.7"
+)
+
+trapExit := false

project/scalastyle-config.xml

@@ -8,8 +8,8 @@
  </check>
  <check level="warning" class="org.scalastyle.file.HeaderMatchesChecker" enabled="true">
   <parameters>
-   <parameter name="header"><![CDATA[// Copyright (C) 2011-2012 the original author or authors.
-// See the LICENCE.txt file distributed with this work for additional
+   <parameter name="header"><![CDATA[// Copyright (C) 2018 The Delphi Team.
+// See the LICENCE file distributed with this work for additional
 // information regarding copyright ownership.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");

src/it/scala/de/upb/cs/swt/delphi/webapi/FeatureQueryCheck.scala

@@ -0,0 +1,28 @@
+// Copyright (C) 2018 The Delphi Team.
+// See the LICENCE file distributed with this work for additional
+// information regarding copyright ownership.
+//
+// Licensed 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.
+
+package de.upb.cs.swt.delphi.webapi
+
+import org.scalatest.{FlatSpec, Matchers}
+
+class FeatureQueryCheck extends FlatSpec with Matchers {
+  "FeatureExtractor" should "provide a list of features" in {
+    val configuration = new Configuration()
+    val featureList = new FeatureQuery(configuration).featureList
+
+    featureList.size should be > 0
+  }
+}

src/it/scala/de/upb/cs/swt/delphi/webapi/SearchQueryTest.scala

@@ -0,0 +1,32 @@
+// Copyright (C) 2018 The Delphi Team.
+// See the LICENCE file distributed with this work for additional
+// information regarding copyright ownership.
+//
+// Licensed 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.
+
+package de.upb.cs.swt.delphi.webapi
+
+import de.upb.cs.swt.delphi.webapi.search.{QueryRequest, SearchQuery}
+import org.scalatest.{FlatSpec, Matchers}
+
+import scala.util.Success
+
+class SearchQueryTest extends FlatSpec with Matchers {
+  "Search query" should "check for fields" in {
+    val configuration = new Configuration()
+    val q = new SearchQuery(configuration, new FeatureQuery(configuration))
+
+    val response = q.search(QueryRequest("[if_icmpeq (opcode:159)]>1"))
+    response shouldBe a [Success[_]]
+  }
+}

src/it/scala/de/upb/cs/swt/delphi/webapi/StatisticsQueryCheck.scala

@@ -0,0 +1,11 @@
+package de.upb.cs.swt.delphi.webapi
+
+import org.scalatest.{FlatSpec, Matchers}
+
+class StatisticsQueryCheck extends FlatSpec with Matchers {
+  "Statics" should "be retrievable" in {
+    val configuration = new Configuration()
+    val stats = new StatisticsQuery(configuration)
+    println(stats.retrieveStandardStatistics)
+  }
+}

src/main/resources/application.conf

@@ -1,28 +1,19 @@
-es-priority-mailbox {
-  mailbox-type = "de.upb.cs.swt.delphi.webapi.ElasticPriorityMailbox"
-}
-
 akka.actor.deployment {
-  /espriomailboxactor {
-    mailbox = es-priority-mailbox
-  }
+
 }
 
 akka {
+
+  loggers = ["akka.event.slf4j.Slf4jLogger"]
+  logLevel = "INFO"
+  event-handlers = ["akka.event.slf4j.Slf4jEventHandler"]
+  log-dead-letters = 0
+  log-dead-letters-during-shutdown = off
+  log-config-on-start = off
+
   http {
     server {
       remote-address-header = on
     }
   }
 }
-
-# Use this dispatcher for actors that make blocking calls to the Elasticsearch database
-elasticsearch-handling-dispatcher {
-  type = Dispatcher
-  executor = "thread-pool-executor"
-  thread-pool-executor {
-    fixed-pool-size = 4
-    # This thread pool is intended for development purposes, and should be increased for production
-  }
-  throughput = 1
-}

src/main/resources/logback.xml

@@ -0,0 +1,36 @@
+<!-- https://www.playframework.com/documentation/latest/SettingsLogger -->
+<configuration>
+
+  <!--<conversionRule conversionWord="coloredLevel" converterClass="play.api.libs.logback.ColoredLevel" />-->
+
+  <appender name="FILE" class="ch.qos.logback.core.FileAppender">
+    <file>${application.home:-.}/logs/application.log</file>
+    <encoder>
+      <pattern>[%level] [%date] from  %logger in %thread - %message%n%xException</pattern>
+    </encoder>
+  </appender>
+
+  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+    <encoder>
+      <pattern>[%date]  %logger{15} - %message%n%xException{10}</pattern>
+    </encoder>
+  </appender>
+
+  <appender name="ASYNCFILE" class="ch.qos.logback.classic.AsyncAppender">
+    <appender-ref ref="FILE" />
+  </appender>
+
+  <appender name="ASYNCSTDOUT" class="ch.qos.logback.classic.AsyncAppender">
+    <appender-ref ref="STDOUT" />
+  </appender>
+
+  <logger name="de.upb.cs.swt.delphi" level="INFO" />
+  <logger name="application" level="DEBUG" />
+
+
+  <root level="WARN">
+    <!--<appender-ref ref="ASYNCFILE" />-->
+    <appender-ref ref="ASYNCSTDOUT" />
+  </root>
+
+</configuration>