Swagger support for REST, execution counters for actions, persistence methods #1 #7 #9

- Besides, update some scalastyle rules.
- Move all sbt plugins to one file.
- Do some refactoring, so we only used immutable data structures.
- Add type ActionTransitions which stores the execution times.
- Initial persistence methods.
- Add initial Swagger support for the REST service.

Author: tdauth

README.md

@@ -65,5 +65,9 @@ Some suggestions how the REST API for the state machine could look like:
 * `/state-machine/<long>/state/<long>/transition/<long>` GET queries a specific transition of a specific state.
 * `/state-machine/<long>/execute` POST executes the passed action from the passed state which might lead to a new state and adds a transition to the state machine. The action must be part of all actions?
 
+## Swagger Support
+The Swagger support is based on [swagger-akka-http](https://github.com/swagger-akka-http/swagger-akka-http).
+The URL `http://localhost:8888/api-docs/swagger.json` should show create Swagger JSON output which can be rendered by Swagger UI.
+
 ### Bash Scripts for REST Calls
 The directory [scripts](./scripts) contains a number of Bash scripts which use `curl` to send REST calls to a running server.

build.sbt

@@ -7,8 +7,8 @@ organization := "retest"
 scalaVersion := "2.12.7"
 
 // Dependencies to represent the input of states and actions:
-libraryDependencies += "de.retest" % "retest-model" % "5.0.0" withSources() withJavadoc()
-libraryDependencies += "org.seleniumhq.selenium" % "selenium-java" % "2.35.0" withSources() withJavadoc()
+libraryDependencies += "de.retest" % "retest-model" % "5.0.0" withSources () withJavadoc ()
+libraryDependencies += "org.seleniumhq.selenium" % "selenium-java" % "2.35.0" withSources () withJavadoc ()
 
 // Dependencies to provide a REST service:
 libraryDependencies += "com.github.scopt" % "scopt_2.12" % "3.7.0"
@@ -20,6 +20,10 @@ libraryDependencies += "com.typesafe.akka" %% "akka-http-spray-json" % "10.1.5"
 libraryDependencies += "com.typesafe.akka" %% "akka-http-xml" % "10.1.5"
 libraryDependencies += "com.typesafe.akka" %% "akka-http-testkit" % "10.1.5" % "test"
 
+// Swagger:
+libraryDependencies += "io.swagger" % "swagger-jaxrs" % "1.5.21"
+libraryDependencies += "com.github.swagger-akka-http" %% "swagger-akka-http" % "1.0.0"
+
 // Test frameworks:
 libraryDependencies += "org.scalatest" %% "scalatest" % "3.0.5" % "test"
 libraryDependencies += "org.scalamock" %% "scalamock" % "4.1.0" % "test"
@@ -29,12 +33,5 @@ mainClass in (Compile, run) := Some("de.retest.guistatemachine.rest.WebServer")
 // set the main class for packaging the main jar
 mainClass in (Compile, packageBin) := Some("de.retest.guistatemachine.rest.WebServer")
 
-publishTo := {
-  val nexus = "https://oss.sonatype.org/"
-  if (isSnapshot.value)
-    Some("snapshots" at nexus + "content/repositories/snapshots")
-  else
-    Some("releases"  at nexus + "service/local/staging/deploy/maven2")
-}
-
-credentials += Credentials(Path.userHome / ".sbt" / ".credentials")
+// format the code
+scalafmtOnCompile := true

project/assembly.sbt

@@ -0,0 +1,10 @@
+// to create a standalone JAR file with all dependencies
+addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.14.6")
+// code formatting
+addSbtPlugin("com.lucidchart" % "sbt-scalafmt" % "1.15")
+// for signed releases
+addSbtPlugin("com.jsuereth" % "sbt-pgp" % "1.1.1")
+addSbtPlugin("com.typesafe.sbteclipse" % "sbteclipse-plugin" % "5.2.4")
+addSbtPlugin("com.github.gseitz" % "sbt-release" % "1.0.10")
+addSbtPlugin("org.scalastyle" %% "scalastyle-sbt-plugin" % "1.0.0")
+addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.5.1")

project/plugins.sbt

@@ -112,6 +112,6 @@
   </parameters>
  </check>
  <check level="warning" class="org.scalastyle.scalariform.PublicMethodsHaveTypeChecker" enabled="true"></check>
- <check level="warning" class="org.scalastyle.file.NewLineAtEofChecker" enabled="false"></check>
- <check level="warning" class="org.scalastyle.file.NoNewLineAtEofChecker" enabled="true"></check>
+ <check level="warning" class="org.scalastyle.file.NewLineAtEofChecker" enabled="true"></check>
+ <check level="warning" class="org.scalastyle.file.NoNewLineAtEofChecker" enabled="false"></check>
 </scalastyle>