Server: runner and job api

Author: rleh

file_storage/.gitignore

@@ -0,0 +1 @@
+*

hwut_server/api/__init__.py

@@ -1,5 +1,5 @@
 from hwut_server.api.about import mod as mod_about
-from hwut_server.api.execute import mod as mod_execute
+from hwut_server.api.jobs import mod as mod_jobs
 from hwut_server.api.runners import mod as mod_runners
 from hwut_server.api.targets import mod as mod_targets
 
@@ -10,6 +10,6 @@ def register(app):
     """
 
     app.register_blueprint(mod_about)
-    app.register_blueprint(mod_execute)
+    app.register_blueprint(mod_jobs)
     app.register_blueprint(mod_runners)
     app.register_blueprint(mod_targets)

hwut_server/api/execute.py

@@ -0,0 +1,109 @@
+import os
+from secrets import token_urlsafe
+from flask import Blueprint, jsonify, request, redirect, abort
+from datetime import datetime
+
+from hwut_server.decorators import requires_authentication, check_authentication
+from hwut_server.models.jobs import Jobs, JobStatus
+from hwut_server.models.targets import Microcontrollers, Boards
+from hwut_server.database import db
+from hwut_server.utils import FILE_STORAGE
+
+mod = Blueprint('jobs', __name__, url_prefix='/jobs')
+
+
+@mod.route('/submit', methods=['PUT'])
+@requires_authentication
+def submit():
+    user = request.authorization.username
+
+    duration_limit_seconds = 60
+    if request.args.get('duration_limit_seconds'):
+        duration_limit_seconds = request.args.get('duration_limit_seconds')
+    if duration_limit_seconds > 300:
+        return abort(413, 'maximum execution time is 300 seconds')
+
+    # board argument is optional
+    board = request.args.get('board')
+    if board:
+        try:
+            Boards.query.filter(Boards.name == board).one()
+        except:
+            return abort(400, 'board in unknown')
+
+    microcontroller = request.args.get('microcontroller')
+    if microcontroller is None:
+        return abort(400, 'microcontroller must be specified')
+    else:
+        try:
+            Microcontrollers.query.filter(Microcontrollers.name == microcontroller).one()
+        except:
+            return abort(400, 'microcontroller in unknown')
+
+    filename_executable = token_urlsafe(32)
+    size = request.content_length
+    if size is None or size < 500:  # minimum size 0.5kB
+        return abort(400, 'executable file is missing or empty')
+    if size is not None and size > 5000000:  # Size limit 5MB
+        return abort(413, 'maximum executable file size is 5MB')
+    with open(os.path.join(FILE_STORAGE, filename_executable), 'wb') as f:
+        f.write(request.stream.read())
+
+    try:
+        job = Jobs(
+            datetime.now(),
+            JobStatus.WAITING,
+            duration_limit_seconds,
+            filename_executable,
+            user,
+            board,
+            microcontroller,
+        )
+        if request.args.get('comment'):
+            job.comment = request.args.get('comment')
+        db.session.add(job)
+        db.session.commit()
+    except:
+        return abort(500, 'unable to create runner')
+    return redirect(mod.url_prefix + '/' + str(job.id), 201)
+
+
+@mod.route('/<int:id>', methods=['GET'])
+def get(id):
+    job = Jobs.query.filter(Jobs.id == id).one()
+    auth = request.authorization
+    extended = (auth and ((check_authentication(auth.username, auth.password, superuser=True)) or (
+                check_authentication(auth.username, auth.password) and auth.username == job.owner)))
+    return jsonify(job.to_dict(extended))
+
+
+@mod.route('/<int:id>', methods=['DELETE'])
+@requires_authentication
+def cancel(id):
+    job = Jobs.query.filter(Jobs.id == id).one()
+    auth = request.authorization
+    if auth and (
+            (check_authentication(auth.username, auth.password, superuser=True))
+            or (check_authentication(auth.username, auth.password) and auth.username == job.owner)):
+        if job.status == JobStatus.WAITING:
+            job.status = JobStatus.CANCELED
+            db.session.commit()
+            return jsonify(job.to_dict(True)), 204
+        else:
+            return abort(400, 'Unable to cancel job. Current job status: {}'.format(job.status.name))
+    else:
+        return abort(401)
+
+
+@mod.route('', methods=['GET'])
+@requires_authentication
+def list_jobs():
+    auth = request.authorization
+    if check_authentication(auth.username, auth.password, superuser=True):
+        job_list = Jobs.query.all()
+    else:
+        job_list = Jobs.query.filter(Jobs.owner == auth.username).all()
+    extended = False
+    if request.args.get('extended') and request.args.get('extended') == '1':
+        extended = True
+    return jsonify([job.to_dict(extended) for job in job_list])

hwut_server/api/jobs.py

@@ -3,7 +3,7 @@
 
 from hwut_server.models import Boards, Microcontrollers
 from hwut_server.models.runners import Runners
-from hwut_server.decorators import requires_authentication, requires_superuser
+from hwut_server.decorators import requires_authentication, requires_superuser, check_authentication
 from hwut_server.utils import dict_list_extended_if_authentication
 from hwut_server.database import db
 
@@ -33,7 +33,10 @@ def runners_list(filter_type, filter1, filter2):
 def targets_boards_get(id):
     try:
         runner = Runners.query.filter(Runners.id == id).one()
-        if True:  # FIXME: if user is owner os superuser
+        auth = request.authorization
+        if auth and (
+                (check_authentication(auth.username, auth.password, superuser=True))
+                or (check_authentication(auth.username, auth.password) and auth.username == runner.owner)):
             return jsonify(runner.to_dict_long())
         else:
             return jsonify(runner.to_dict_short())
@@ -47,23 +50,15 @@ def runner_create():
     if (request.args.get('board') is None) or (request.args.get('microcontroller') is None):
         abort(400)
 
-    # FIXME: get user
     user = request.authorization.username
-
     try:
         board = Boards.query.filter(Boards.name == request.args.get('board')).one()
-    except MultipleResultsFound:
-        abort(500, 'board "{}" exists multiple time in database'.format(request.args.get('board')))
-        return
     except NoResultFound:
         abort(410, 'board "{}" does not exist'.format(request.args.get('board')))
         return
     try:
         microcontroller = Microcontrollers.query\
             .filter(Microcontrollers.name == request.args.get('microcontroller')).one()
-    except MultipleResultsFound:
-        abort(500, 'microcontroller exists multiple time in database')
-        return
     except NoResultFound:
         abort(410, 'microcontroller does not exist')
         return

hwut_server/api/runners.py

@@ -7,39 +7,55 @@ class JobStatus(Enum):
     WAITING = 10
     RUNNING = 20
     FINISHED = 30
+    CANCELED = 40
 
 
 class Jobs(db.Model):
     __tablename__ = 'jobs'
     id = db.Column('id', db.BigInteger, db.Sequence('jobs_id_seq'), primary_key=True, index=True, unique=True,
                    autoincrement=True)
-    created = db.Column(db.TIMESTAMP, nullable=False)
-    uploaded = db.Column(db.TIMESTAMP, nullable=False)
-    status = db.Column(db.Enum(JobStatus))
-    name = db.Column(db.Text)
+    created = db.Column(db.DateTime, nullable=False)
+    status = db.Column(db.Enum(JobStatus), nullable=False)
+    comment = db.Column(db.Text)
+    duration_limit_seconds = db.Column(db.Integer, nullable=False)
     filename_executable = db.Column(db.Text, nullable=False)
     filename_log = db.Column(db.Text)
     filename_other = db.Column(db.Text)
     owner = db.Column(db.Text, db.ForeignKey('users.name'), nullable=False)
+    board = db.Column(db.Text, db.ForeignKey('boards.name'))
+    microcontroller = db.Column(db.Text, db.ForeignKey('microcontrollers.name'), nullable=False)
 
-    def __init__(self, created, uploaded, name):
+    def __init__(self, created, status, duration_limit_seconds, filename_executable, owner, board, microcontroller):
         # 'id' auto increment
         self.created = created
-        self.uploaded = uploaded
-        self.name = name
+        self.status = status
+        self.duration_limit_seconds = duration_limit_seconds
+        self.filename_executable = filename_executable
+        self.owner = owner
+        self.board = board
+        self.microcontroller = microcontroller
 
     def __repr__(self):
         return '<job %i>' % self.id
 
-    def to_dict_short(self):
-        return {
-            'id': self.id,
-            'name': self.name,
-        }
-
-    def to_dict_long(self):
-        return {
-            'id': self.id,
-            'name': self.name,
-            'created': self.created,
-        }
+    def to_dict(self, extended=True):
+        if extended:
+            return {
+                'id': self.id,
+                'created': self.created,
+                'status': self.status.name,
+                'comment': self.comment,
+                'duration_limit_seconds': self.duration_limit_seconds,
+                'filename_log': self.filename_log,
+                'filename_other': self.filename_other,
+                'owner': self.owner,
+                'board': self.board,
+                'microcontroller': self.microcontroller,
+            }
+        else:
+            return {
+                'id': self.id,
+                'created': self.created,
+                'status': self.status.name,
+                'owner': self.owner,
+            }

hwut_server/models/jobs.py

@@ -8,6 +8,7 @@ class Boards(db.Model):
     name = db.Column(db.Text, primary_key=True, unique=True, nullable=False)
     manufacturer = db.Column(db.Text)
     runners = relationship("Runners")
+    jobs = relationship("Jobs")
 
     def __init__(self, name):
         self.name = name
@@ -33,6 +34,7 @@ class Microcontrollers(db.Model):
     name = db.Column(db.Text, primary_key=True, unique=True, nullable=False)
     manufacturer = db.Column(db.Text)
     runners = relationship("Runners")
+    jobs = relationship("Jobs")
 
     def __init__(self, name):
         self.name = name

hwut_server/models/targets.py

@@ -2,7 +2,7 @@
 
 from hwut_server.decorators import requires_authentication
 
-mod = Blueprint('jobs', __name__)
+mod = Blueprint('runner_jobs', __name__)
 
 
 @mod.route('/get', methods=['GET'])

hwut_server/runner_api/jobs.py

@@ -1,5 +1,6 @@
 from hwut_server.decorators import check_authentication, authenticate
 
+FILE_STORAGE = './file_storage'
 
 def dict_list_extended_if_authentication(r, l):
     if r.args.get('extended') == '1':