Merge ~mateuszsusik/dpcs:aplikacjaklienta into dpcs:master

[Mateusz Susik]

Run as `python2 -m dpcs.client.main.client 'polecenie'`

When the installation ticket is resolved, the above will be obsolete.

Additionally an example of a daemon, it will be useful in future, and a .gitignore.

[Mateusz Susik (mateuszsusik)]

Adding Paweł Goliński as a reviewer, as I modified his code.

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..908a064
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,81 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask instance folder
+instance/
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# Spyder project settings
+.spyderproject
diff --git a/__init__.py b/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/__init__.py
diff --git a/client/__init__.py b/client/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/client/__init__.py
diff --git a/client/main/__init__.py b/client/main/__init__.py
new file mode 100644
index 0000000..0829681
--- /dev/null
+++ b/client/main/__init__.py
@@ -0,0 +1,3 @@
+__author__ = "Mateusz Susik"
+
+__all__ = ['mock', 'daemon']
diff --git a/client/main/client.py b/client/main/client.py
new file mode 100644
index 0000000..82b62d1
--- /dev/null
+++ b/client/main/client.py
@@ -0,0 +1,164 @@
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+from os import mkdir
+from os import path
+from random import sample
+from string import ascii_lowercase
+from string import ascii_uppercase
+from string import digits
+import subprocess
+import sys
+
+from requests import get
+from requests import post
+from requests import RequestException
+
+from ...systemcheck.systemcheck import systemcheck
+
+EXIT_OK = 0
+
+SERVER_ADDRESS = "http://private-a6e53-dpcs.apiary-mock.com/"
+
+
+def generate_report(exit_code, stderr_output):
+    """Generate a report which will be sent to the DCPS server.
+
+    Arguments
+    ---------
+    exit_code : int
+        The exit code of the failed process
+
+    stderr_output : string
+        The output written on stderr by the failed process
+
+    Return
+    ------
+    template : dict
+        The report that can be sent to the DCPS server.
+    """
+    template = {
+        "crash_report": {
+            "application": {
+                # TO DO - implementation depends on the way how the demon is
+                # implemented
+            },
+            "system_info": {},
+            "exit_code": exit_code,
+            "stderr_output": stderr_output
+        }
+    }
+
+    system_info = systemcheck()
+
+    for k, v in system_info['platform'].iteritems():
+        template['crash_report']['system_info'][k] = v
+
+    return template
+
+
+def handle_request_error(exception, dpcs_message):
+    """Handle the exception coming from the requests library.
+
+    Arguments
+    ---------
+    exception : requests.RequestException
+        The request exception caught during the communication with the server.
+        Can be anything from 310 to 500
+
+    dpcs_message : string
+        The message to be printed. Should describe why DPCS client failed.
+    """
+    print(dpcs_message, file=sys.stderr)
+    print(exception.response.text, file=sys.stderr)
+
+
+def rand_fname(parent_path, prefix, suffix, length=4):
+    """Create a random filename for storing the solution script.
+
+    Arguments
+    ---------
+    parent_path : string
+        The directory where the DCPS script should be stored.
+
+    prefix : string
+        The prefix that will be added to the filename.
+
+    suffix : string
+        The suffix that will be added to the filename.
+        Usually should end with '.sh'
+
+    length : int, optional
+        The length of the sequence of random
+        haracters in the created filename.
+
+    Return
+    ------
+    fname : string
+        The new file's name.
+        The file under this name is guaranteed not to exist.
+    """
+    chars = ascii_lowercase + ascii_uppercase + digits
+
+    fname = path.join(parent_path,
+                      prefix + ''.join(sample(chars, length)) + suffix)
+
+    return fname if not path.exists(fname) else rand_fname(suffix, length)
+
+if __name__ == '__main__':
+
+    if len(sys.argv) != 2:
+        print("Usage python client.py '[command to check]'")
+        exit(1)
+
+    p = subprocess.Popen(sys.argv[1],
+                         stdout=subprocess.PIPE,
+                         stderr=subprocess.PIPE)
+    _, output = p.communicate()
+    code = p.returncode
+
+    if code != EXIT_OK:
+        # output to to, co wysyłamy
+
+        api_description_url = SERVER_ADDRESS + "vd1/paths/"
+        try:
+            response = get(api_description_url)
+        except RequestException as e:
+            handle_request_error(
+                e, "DPCS coudln't get api description"
+            )
+            exit(2)
+
+        api_paths = response.json()
+        crash_report_url = SERVER_ADDRESS + api_paths["crash-reports"]
+        headers = {
+          'Content-Type': 'text/json'
+        }
+
+        report = generate_report(code, output)
+
+        try:
+            response = post(crash_report_url,
+                            headers=headers,
+                            data=report)
+        except RequestException as e:
+            handle_request_error(
+                e, "DPCS coudln't post crash information"
+            )
+            exit(3)
+
+        script = response.json()['crash_report_ack'][
+                                 'solution']['shell_script']
+
+        home = path.expanduser("~")
+        scripts_directory = path.join(home, '.local/share/dpcs/')
+
+        if not path.exists(scripts_directory):
+            mkdir(scripts_directory)
+
+        filename = rand_fname(scripts_directory, 'dpcs_solution_', '.sh')
+
+        with open(filename, 'w+') as f:
+            f.write(script)
+
+            print("DPCS might have found a solution to your problem!")
+            print("The script produced by DPCS is available in " + filename)
diff --git a/client/main/demon.py b/client/main/demon.py
new file mode 100644
index 0000000..c2e2768
--- /dev/null
+++ b/client/main/demon.py
@@ -0,0 +1,91 @@
+"""DPCS client implementation.
+
+Simplest usage:
+sudo python -m [parent_directory_name].demon start
+"""
+from __future__ import print_function
+from os import path
+import time
+
+from daemon import runner
+from requests import get
+from requests import post
+from requests import RequestException
+
+from .mock import sample_report
+
+
+SERVER_ADDRESS = "http://private-a6e53-dpcs.apiary-mock.com/"
+
+
+class DPCSDaemon():
+    """Wrapper over DPCS client functionality."""
+
+    def __init__(self):
+        self.stdin_path = '/dev/null'
+        self.stdout_path = '/dev/tty'
+        self.stderr_path = '/dev/tty'
+        self.pidfile_path = '/tmp/dpcs.pid'
+        self.pidfile_timeout = 5
+
+    def _handle_request_error(self, exception, dpcs_message):
+        print(dpcs_message)
+        print(exception.response.text)
+
+    def run(self):
+        first_sent = False
+
+        while True:
+
+            # Mock - sends every ten seconds a simple message.
+
+            # First report is sent immediately so that a developer
+            # doesn't have to wait
+            if first_sent:
+                time.sleep(10)
+            else:
+                first_sent = True
+
+            api_description_url = SERVER_ADDRESS + "vd1/paths/"
+            try:
+                response = get(api_description_url)
+            except RequestException as e:
+                self._handle_request_error(
+                    e, "DPCS coudln't get api description"
+                )
+                continue
+
+            api_paths = response.json()
+            crash_report_url = SERVER_ADDRESS + api_paths["crash-reports"]
+            headers = {
+              'Content-Type': 'text/json'
+            }
+
+            try:
+                response = post(crash_report_url,
+                                headers=headers,
+                                data=sample_report)
+            except RequestException as e:
+                self._handle_request_error(
+                    e, "DPCS coudln't post crash information"
+                )
+                continue
+
+            script = response.json()['crash_report_ack'][
+                                     'solution']['shell_script']
+
+            home = path.expanduser("~")
+            scripts_directory = path.join(home, '.local/share/dpcs/')
+
+            # Check if directory exists, create if not
+            # Create a script file (using unique id)
+
+            print("DPCS might have found a solution to your problem!")
+            print("The script produced by DPCS is available in ")
+            print(script)
+
+            print(home)
+
+app = DPCSDaemon()
+daemon_runner = runner.DaemonRunner(app)
+daemon_runner.do_action()
diff --git a/client/main/mock.py b/client/main/mock.py
new file mode 100644
index 0000000..00577b2
--- /dev/null
+++ b/client/main/mock.py
@@ -0,0 +1,13 @@
+sample_report = {
+    "crash_report": {
+        "application": {
+            "name": "Google Chrome",
+            "version": "48.0.2564.116"
+        },
+        "system_info": {
+            "version": "14.04.1 LTS"
+        },
+        "exit_code": 1,
+        "stderr_output": "Lines from stdErr."
+    }
+}
diff --git a/systemcheck/__init__.py b/systemcheck/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/systemcheck/__init__.py
diff --git a/systemcheck/systemcheck.py b/systemcheck/systemcheck.py
index b7e4d8c..727ac75 100755
--- a/systemcheck/systemcheck.py
+++ b/systemcheck/systemcheck.py
@@ -5,7 +5,8 @@ import os
 import re
 import json
 
-if __name__ == "__main__":
+
+def systemcheck():
     uname = platform.uname()
     platform_dict = {
         "system_name": uname[1],
@@ -19,10 +20,11 @@ if __name__ == "__main__":
             "dpkg-query -W -f='${binary:Package}\t${Version}\t${Status}\n' | grep \"install ok installed\""
         ).read()
     packages_raw_info = packages_raw_info.split("\n")
+
+    # regex catches {binary:Package} and {Version} from dpkg output
+    package_re = re.compile(r"(.+)\t(.+)\t.*")
     for line in packages_raw_info:
         if line:
-            # regex catches {binary:Package} and {Version} from dpkg output
-            package_re = re.compile(r"(.+)\t(.+)\t.*")
             package_info = package_re.match(line)
             package_dict = {
                 "name": package_info.group(1),
@@ -32,5 +34,9 @@ if __name__ == "__main__":
     data = {}
     data["platform"] = platform_dict
     data["packages"] = package_list
-    json_data = json.dumps(data)
-    print json_data
+    return data
+
+
+if __name__ == "__main__":
+
+    print(json.dumps(systemcheck()))