Added runCommand, retreiveLogs and streamLogs to docu and implementation

Author: Johannes Duesing

OpenAPISpecification.yaml

@@ -347,7 +347,7 @@ paths:
       tags:
         - Basic Operations
       consumes:
-        - text/plain
+        - application/json
       summary: Add a label to the instance with the specified id
       description: >-
         This command will add the specified label to the instance with the
@@ -374,6 +374,65 @@ paths:
           description: 'Bad request, your label exceeded the character limit'
         '404':
           description: 'Not found, the id you specified could not be found'
+  /instances/{Id}/logs:
+    get:
+      tags:
+        - Basic Operations
+      summary: Retrieve the logging output of the specified instance
+      description: This command retrieves the docker container logging output for the specified instance, if the instance is in fact running inside a docker container.
+      operationId: retreiveLogs
+      parameters:
+        - name: Id
+          in: path
+          description: Id of the instance
+          required: true
+          type: integer
+          format: int64
+        - name: StdErr
+          in: query
+          description: Switch to select the stderr channel
+          required: false
+          type: boolean
+      responses:
+        '200':
+          description: Success, log string is being returned
+          schema:
+            type: string
+            example: "I am logging output .."
+        '400':
+          description: Selected instance not running inside docker container
+        '404':
+          description: Id not found on the server
+        '500':
+          description: Internal Server Error
+  /instances/{Id}/attach:
+    get:
+      tags:
+        - Basic Operations
+      summary: Stream logging output from instance
+      description: 'This command streams the docker container logging output for the specified instance. NOTE: This is a websocket endpoint, so only valid websocket requests will be processed. Swagger does not provide sufficient support for websockets, so this documentation might be confusing as it defines a HTTP method, etc. The names of parameters and response-codes are valid though.'
+      operationId: streamLogs
+      parameters:
+        - name: Id
+          in: path
+          description: Id of the instance
+          required: true
+          type: integer
+          format: int64
+        - name: StdErr
+          in: query
+          description: Switch to select the stderr channel
+          required: false
+          type: boolean
+      responses:
+        '200':
+          description: Success, logs are being streamed via websocket connection.
+        '400':
+          description: Selected instance not running inside docker container
+        '404':
+          description: Id not found on the server
+        '500':
+          description: Internal Server Error
   /instances/deploy:
     post:
       tags:
@@ -688,6 +747,49 @@ paths:
           description: One of the ids was not found on the server
         '500':
           description: Internal server error
+  /instances/{Id}/command:
+    post:
+      tags:
+        - Docker Operations
+      summary: Runs a command into a docker container
+      description: >-
+        This command runs a specified command inside a docker container.
+      operationId: command
+      parameters:
+        - in: path
+          name: Id
+          description: The ID of the instance that is a docker container
+          required: true
+          type: integer
+          format: int64
+        - in: body
+          name: CommandData
+          description: The data needed to run the command
+          required: true
+          schema:
+            type: object
+            required:
+              - Command
+            properties:
+              Command:
+                type: string
+                example: "rm -rf *"
+              Privileged:
+                type: boolean
+              User:
+                type: string
+                example: root
+      responses:
+        '200':
+          description: 'OK'
+        '400':
+          description: >-
+            Cannot run command, ID is no docker container.
+        '404':
+          description: Cannot run command, ID not found.
+        '500':
+          description: Internal server error, unknown operation result DESCRIPTION
+  
 definitions:
   InstanceLink:
     type: object

src/main/scala/de/upb/cs/swt/delphi/instanceregistry/connection/Server.scala

@@ -116,15 +116,21 @@ class Server(handler: RequestHandler) extends HttpApp
             } ~
             path("label") {
               entity(as[JsValue]) { json => addLabel(Id, json.asJsObject) }
+            } ~
+            path("logs") {
+              retrieveLogs(Id)
+            } ~
+            path("attach") {
+              streamLogs(Id)
+            } ~
+            path("command") {
+              entity(as[JsValue]) { json => runCommandInContainer(Id, json.asJsObject) }
             }
         }
     } ~
-      path("command") {
-        runCommandInContainer()
-      } ~
-      path("events") {
-        streamEvents()
-      }
+    path("events") {
+      streamEvents()
+    }
 
 
   /**
@@ -916,38 +922,52 @@ class Server(handler: RequestHandler) extends HttpApp
     *
     * @return Server route that either maps to 200 Ok or the respective error codes.
     */
-  def runCommandInContainer(): server.Route = parameters('Id.as[Long], 'Command.as[String],
-    'AttachStdin.as[Boolean].?, 'AttachStdout.as[Boolean].?,
-    'AttachStderr.as[Boolean].?, 'DetachKeys.as[String].?, 'Privileged.as[Boolean].?, 'Tty.as[Boolean].?, 'User.as[String].?
-  ) { (id, command, attachStdin, attachStdout, attachStderr, detachKeys, privileged, tty, user) =>
+  def runCommandInContainer(id:Long, json: JsObject): server.Route = {
     authenticateOAuth2[AccessToken]("Secure Site", AuthProvider.authenticateOAuthRequire(_, userType = UserType.Admin)) { token =>
       post {
         log.debug(s"POST /command has been called")
-        handler.handleCommand(id, command, attachStdin, attachStdout, attachStderr, detachKeys, privileged, tty, user) match {
-          case handler.OperationResult.IdUnknown =>
-            log.warning(s"Cannot run command $command to $id, id not found.")
-            complete {
-              HttpResponse(StatusCodes.NotFound, entity = s"Cannot run command, id $id not found.")
-            }
-          case handler.OperationResult.NoDockerContainer =>
-            log.warning(s"Cannot run command $command to $id, $id is no docker container.")
-            complete {
-              HttpResponse(StatusCodes.BadRequest, entity = s"Cannot run command, $id is no docker container.")
-            }
-          case handler.OperationResult.Ok =>
-            complete {
-              HttpResponse(StatusCodes.OK)
-            }
-          case r =>
-            complete {
-              HttpResponse(StatusCodes.InternalServerError, entity = s"Internal server error, unknown operation result $r")
+
+        val privileged = Try(json.fields("Privileged").toString.toBoolean) match {
+          case Success(res) => Some(res)
+          case Failure(_) => None
+        }
+
+        val user = Try(json.fields("User").toString) match {
+          case Success(res) => Some(res)
+          case Failure(_) => None
+        }
+
+        Try(json.fields("Command").toString) match {
+          case Success(command) =>
+            handler.handleCommand(id, command, None, None, None, None, privileged, None, user) match {
+              case handler.OperationResult.IdUnknown =>
+                log.warning(s"Cannot run command $command to $id, id not found.")
+                complete {
+                  HttpResponse(StatusCodes.NotFound, entity = s"Cannot run command, id $id not found.")
+                }
+              case handler.OperationResult.NoDockerContainer =>
+                log.warning(s"Cannot run command $command to $id, $id is no docker container.")
+                complete {
+                  HttpResponse(StatusCodes.BadRequest, entity = s"Cannot run command, $id is no docker container.")
+                }
+              case handler.OperationResult.Ok =>
+                complete {
+                  HttpResponse(StatusCodes.OK)
+                }
+              case r =>
+                complete {
+                  HttpResponse(StatusCodes.InternalServerError, entity = s"Internal server error, unknown operation result $r")
+                }
             }
+          case Failure(ex) =>
+            log.warning(s"Failed to unmarshal parameters with message ${ex.getMessage}. Data: $json")
+            complete{HttpResponse(StatusCodes.BadRequest, entity = "Wrong data format supplied.")}
         }
       }
     }
   }
 
-  def retrieveLogs(): server.Route = parameters('Id.as[Long], 'StdErr.as[Boolean].?) { (id, stdErrOption) =>
+  def retrieveLogs(id: Long): server.Route = parameters('StdErr.as[Boolean].?) { stdErrOption =>
     authenticateOAuth2[AccessToken]("Secure Site", AuthProvider.authenticateOAuthRequire(_, userType = UserType.Admin)) { token =>
       get {
         log.debug(s"GET /logs?Id=$id has been called")
@@ -982,7 +1002,7 @@ class Server(handler: RequestHandler) extends HttpApp
     }
   }
 
-  def streamLogs(): server.Route = parameters('Id.as[Long], 'StdErr.as[Boolean].?) { (id, stdErrOption) =>
+  def streamLogs(id: Long): server.Route = parameters('StdErr.as[Boolean].?) { stdErrOption =>
 
 
     val stdErrSelected = stdErrOption.isDefined && stdErrOption.get