Merge ~szymonpajzert/dpcs:ticket11 into dpcs:master

[SzymonPajzert]

[Marek Bardoński (bdfhjk)]

Good job.

The server code is well designed. Flask as a easy-to-learn library is a good choice for an alpha prototype. Restful solution is the best approach to the connection between client and server in my opinion.

I think a good idea will be to create a common test folder to be used by classification and clustering algorithms.

In a few days we will try to deploy it on a server, test if everything work well in practice and the finally approve.

Unmerged commits

d34ca46... by SzymonPajzert on 2016-03-07

server in alpha phase with in-memory database

diff --git a/server/main/__init__.py b/server/main/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/server/main/__init__.py
diff --git a/server/main/api.py b/server/main/api.py
new file mode 100755
index 0000000..6943eb0
--- /dev/null
+++ b/server/main/api.py
@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Listen to the server requests."""
+
+from flask import Flask
+from flask_restful import Api
+
+from resources.helloWorld import HelloWorld
+from resources.crashReport import CrashReportById, CrashReportNoId
+
+app = Flask(__name__)
+api = Api(app)
+
+# api config
+app.config['ERROR_404_HELP'] = False
+
+# api routes
+api.add_resource(HelloWorld, '/')
+api.add_resource(CrashReportById, '/vd1/crash-reports/<int:crash_report_id>')
+api.add_resource(CrashReportNoId, '/vd1/crash-reports/')
+
+if __name__ == '__main__':
+    app.run(debug=True)
diff --git a/server/main/resources/__init__.py b/server/main/resources/__init__.py
new file mode 100644
index 0000000..d854322
--- /dev/null
+++ b/server/main/resources/__init__.py
@@ -0,0 +1 @@
+"""Initialize resources package of dpcs_api."""
diff --git a/server/main/resources/crashReport.py b/server/main/resources/crashReport.py
new file mode 100755
index 0000000..56bed3f
--- /dev/null
+++ b/server/main/resources/crashReport.py
@@ -0,0 +1,59 @@
+"""Retrieve and modify information about crash report(s)."""
+from flask import abort
+from flask_restful import Resource, reqparse
+import json
+# Place holder for postgres communication
+import database
+import types
+
+
+class CrashReportById(Resource):
+    """Retrieve and modify information about given crash report."""
+
+    def get(self, crash_report_id):
+        """Retrieve information about given crash report."""
+        report = database.find_by_id(crash_report_id)
+        if report:
+            return report
+        else:
+            abort(404)
+
+    def put(self, crash_report_id):
+        """Update information about given crash report."""
+        pass
+
+    def delete(self, crash_report_id):
+        """Delete information about given crash report."""
+        pass
+
+
+class CrashReportNoId(Resource):
+    """Search for and send new crash report."""
+
+    def __init__(self, *args, **kwargs):
+        """Initialize with custom reqparser(s)."""
+        super(Resource, self).__init__(*args, **kwargs)
+
+        # get_parser parses incoming search requests
+        self.get_parser = reqparse.RequestParser()
+        self.get_parser.add_argument('browser', location='args')
+        self.get_parser.add_argument('version', location='args')
+
+        # post_parser parses incoming new crash reports
+        self.post_parser = reqparse.RequestParser()
+        self.post_parser.add_argument('crash_report', location='json',
+                                      type=types.inputCrashReport)
+
+    def get(self):
+        """Search for crash report."""
+        args = self.get_parser.parse_args()
+        print args
+        print args['version']
+        print args['browser']
+        return database.retrieve()
+
+    def post(self):
+        """Post new crash report and return its reference with solution."""
+        read_data = self.post_parser.parse_args()
+        print json.dumps(read_data, indent=2)
+        return database.append(read_data)
diff --git a/server/main/resources/crash_reports.json b/server/main/resources/crash_reports.json
new file mode 100644
index 0000000..409d00f
--- /dev/null
+++ b/server/main/resources/crash_reports.json
@@ -0,0 +1,33 @@
+[
+    {
+      "crash_report_id": 0,
+      "crash_report_url": "vd1/crash-reports/1",
+      "crash_group_id": 0,
+      "crash_group_url": "vd1/crash-groups/1",
+      "application": {
+        "name": "Google Chrome",
+        "version": "48.0.2564.116"
+      },
+      "system_info": {
+        "version": "14.04.1 LTS"
+      },
+      "exit_code": 1,
+      "stderr_output": "error: stack overflow"
+  },
+
+  {
+    "crash_report_id": 1,
+    "crash_report_url": "vd1/crash-reports/2",
+    "crash_group_id": 1,
+    "crash_group_url": "vd1/crash-groups/2",
+    "application": {
+      "name": "Mozilla Firefox",
+      "version": "123.56.78"
+    },
+    "system_info": {
+      "version": "15.04.1"
+    },
+    "exit_code": 1,
+    "stderr_output": "error: stack underflow"
+  }
+]
diff --git a/server/main/resources/database.py b/server/main/resources/database.py
new file mode 100644
index 0000000..49c9d00
--- /dev/null
+++ b/server/main/resources/database.py
@@ -0,0 +1,47 @@
+"""Connect to the stored data."""
+import json
+
+with open('./resources/crash_reports.json') as data_file:
+    crash_reports = json.load(data_file)
+
+next_it = 3
+
+
+def set_id(json_element, newid):
+    """Set new id to given json_element."""
+    json_element['crash_report_id'] = newid
+    json_element['crash_report_url'] = "vd1/crash-reports/" + str(newid)
+    json_element['crash_group_id'] = newid
+    json_element['crash_group_url'] = "vd1/crash-groups/" + str(newid)
+
+
+def append(json_element):
+    """Add new json element to the crash_reports collection."""
+    global next_it
+    if 'crash_report' in json_element:
+        json_element = json_element['crash_report']
+    else:
+        return False
+    set_id(json_element, len(crash_reports))
+    server_responce = {}
+    set_id(server_responce, len(crash_reports))
+    server_responce['solution'] = {
+        "solution_id": 42,
+        "solution_url": "vd1/solutions/42",
+        "shell_script": "# sudo rm -rf /"
+    }
+    crash_reports.append(json_element)
+    return {'crash_report_ack': server_responce}
+
+
+def retrieve():
+    """Retrieve database as list."""
+    return crash_reports
+
+
+def find_by_id(id):
+    """Find first crash matching id."""
+    report = filter(lambda t: t['crash_report_id'] == id, crash_reports)
+    if len(report) == 0:
+        return False
+    return report[0]
diff --git a/server/main/resources/helloWorld.py b/server/main/resources/helloWorld.py
new file mode 100755
index 0000000..2e52572
--- /dev/null
+++ b/server/main/resources/helloWorld.py
@@ -0,0 +1,10 @@
+"""Test wether server is working."""
+from flask_restful import Resource
+
+
+class HelloWorld(Resource):
+    """Test wether server is working by return of 'hello world'."""
+
+    def get(self):
+        """Return hello world in JSON."""
+        return {'hello': 'world'}
diff --git a/server/main/resources/types.py b/server/main/resources/types.py
new file mode 100644
index 0000000..bc57e1d
--- /dev/null
+++ b/server/main/resources/types.py
@@ -0,0 +1,26 @@
+"""Types for type validation during flask_restful argument parsing."""
+from jsonschema import validate
+
+
+def inputCrashReport(value, name):
+    """Input crash report validator."""
+    schema = {
+        "type": "object",
+        'properties': {
+            "application": {
+                'type': 'object',
+                'properties': {
+                    'name': {'type': 'string'},
+                    'version': {'type': 'string'}
+                }
+            },
+            "system_info": {
+                'type': 'object',
+                'properties': {
+                    'version': {'type': 'string'}
+                }
+            },
+        },
+    }
+    validate(value, schema)
+    return value