Add jquery frontend

.travis.yml

@@ -5,6 +5,16 @@ dist: trusty
 language: python
 python: "3.5"
 
+
+addons:
+  firefox: latest
+
+before_install:
+  - wget https://github.com/mozilla/geckodriver/releases/download/v0.19.1/geckodriver-v0.19.1-linux64.tar.gz
+  - mkdir geckodriver
+  - tar -xzf geckodriver-v0.19.1-linux64.tar.gz -C geckodriver
+  - export PATH=$PATH:$PWD/geckodriver
+
 # command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
 install:
   # code below is taken from http://conda.pydata.org/docs/travis.html
@@ -23,7 +33,7 @@ install:
   # Useful for debugging any issues with conda
   - conda info -a
 
-  - conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION numpy scipy matplotlib pandas pytest h5py
+  - conda create -n test-environment python=$TRAVIS_PYTHON_VERSION numpy scipy matplotlib pandas pytest h5py
   - source activate test-environment
 
   # install PIL for preprocessing tests
@@ -40,7 +50,10 @@ install:
   # install TensorFlow (CPU version).
   - pip install tensorflow
 
-script: pytest --cov=picasso
+jobs:
+    include:
+        - script: pytest -vls --cov=picasso
+        - script: pytest -vls ./integration_tests/
 
 after_success:
   - codecov

Makefile

@@ -51,15 +51,16 @@ lint: ## check style with flake8
 	flake8 picasso tests
 
 test: ## run tests quickly with the default Python
-	py.test
-
+	py.test ./tests
+	py.test ./integration_tests
+
 
 test-all: ## run tests on every Python version with tox
 	tox
 
 coverage: ## check code coverage quickly with the default Python
 	coverage run --source picasso -m pytest
-	
+
 		coverage report -m
 		coverage html
 		$(BROWSER) htmlcov/index.html

integration_tests/conftest.py

@@ -0,0 +1,33 @@
+###############################################################################
+# Copyright (c) 2017 Merantix GmbH
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+#
+# Contributors:
+#    Ryan Henderson - initial API and implementation and/or initial
+#    documentation
+###############################################################################
+from PIL import Image
+import numpy as np
+import pytest
+from selenium.webdriver import Firefox
+from selenium.webdriver.firefox.options import Options
+
+from picasso import create_app
+
+
+@pytest.fixture
+def app():
+    _app = create_app()
+    return _app
+
+
+@pytest.fixture(scope='module')
+def webdriver():
+    options = Options()
+    options.add_argument('-headless')
+    driver = Firefox(firefox_options=options)
+    yield driver
+    driver.quit()

integration_tests/test_selenium.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+###############################################################################
+# Copyright (c) 2017 Merantix GmbH
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+#
+# Contributors:
+#    Jan Steinke - Selenium integration tests
+###############################################################################
+
+"""
+test_selenium
+----------------------------------
+
+Integration tests for `picasso` module.
+"""
+
+import pytest
+from flask import url_for
+
+
+@pytest.mark.usefixtures('live_server')
+class TestIntegration:
+
+    def test_page_load(self, webdriver):
+        url = url_for('frontend.index', _external=True)
+        webdriver.get(url)
+        webdriver.find_element_by_id('appstate_checkpoint')
+
+

picasso/__init__.py

@@ -8,14 +8,33 @@
 import os
 import sys
 from picasso.interfaces.rest import API
+from picasso.interfaces.web import frontend
+from picasso import picasso
 
 if sys.version_info.major < 3 or (sys.version_info.major == 3 and
                                   sys.version_info.minor < 5):
     raise SystemError('Python 3.5+ required, found {}'.format(sys.version))
 
-app = Flask(__name__)
-app.config.from_object('picasso.config.Default')
-app.register_blueprint(API, url_prefix='/api')
+
+def create_app(debug=False):
+    _app = Flask(__name__)
+    _app.debug = debug
+    _app.config.from_object('picasso.config.Default')
+    _app.register_blueprint(API, url_prefix='/api')
+    _app.register_blueprint(frontend, url_prefix='/v2')
+    _app.register_blueprint(picasso.frontend)
+
+    # Use a bogus secret key for debugging ease. No client information is stored;
+    # the secret key is only necessary for generating the session cookie.
+    if _app.debug:
+        _app.secret_key = '...'
+    else:
+        _app.secret_key = os.urandom(24)
+
+    return _app
+
+
+app = create_app()
 
 if os.getenv('PICASSO_SETTINGS'):
     app.config.from_envvar('PICASSO_SETTINGS')
@@ -38,5 +57,3 @@
                      ' and '
                      'https://picasso.readthedocs.io/en/latest/settings.html'
                      .format(__version__))
-
-import picasso.picasso

picasso/interfaces/rest.py

@@ -16,6 +16,9 @@
 
 import os
 import shutil
+import logging
+from tempfile import mkdtemp
+
 from PIL import Image
 from werkzeug.utils import secure_filename
 from flask import (
@@ -32,6 +35,29 @@
 )
 
 API = Blueprint('api', __name__)
+logger = logging.getLogger(__name__)
+
+
+@API.before_request
+def initialize_new_session():
+    """Check session and initialize if necessary
+
+    Before every request, check the user session.  If no session exists, add
+    one and provide temporary locations for images
+
+    """
+    if 'image_uid_counter' in session and 'image_list' in session:
+        logger.debug('images are already being tracked')
+    else:
+        # reset image list counter for the session
+        session['image_uid_counter'] = 0
+        session['image_list'] = []
+    if 'img_input_dir' in session and 'img_output_dir' in session:
+        logger.debug('temporary image directories already exist')
+    else:
+        # make image upload directory
+        session['img_input_dir'] = mkdtemp()
+        session['img_output_dir'] = mkdtemp()
 
 
 @API.route('/', methods=['GET'])
@@ -66,7 +92,7 @@ def images():
     if request.method == 'POST':
         file_upload = request.files['file']
         if file_upload:
-            image = {}
+            image = dict()
             image['filename'] = secure_filename(file_upload.filename)
             full_path = os.path.join(session['img_input_dir'],
                                      image['filename'])
@@ -99,12 +125,8 @@ def visualizers():
 @API.route('/visualizers/<vis_name>', methods=['GET'])
 def visualizers_information(vis_name):
     vis = get_visualizations()[vis_name]
-    if hasattr(vis, 'ALLOWED_SETTINGS'):
-        settings = vis.ALLOWED_SETTINGS
-    else:
-        settings = {}
 
-    return jsonify(settings=settings)
+    return jsonify(settings=vis.ALLOWED_SETTINGS)
 
 
 @API.route('/visualize', methods=['GET'])
@@ -120,23 +142,25 @@ def visualize():
     image_uid = request.args.get('image')
     vis_name = request.args.get('visualizer')
     vis = get_visualizations()[vis_name]
-    if hasattr(vis, 'settings'):
-        for key in vis.settings.keys():
+    if vis.ALLOWED_SETTINGS:
+        for key in vis.ALLOWED_SETTINGS.keys():
             if request.args.get(key) is not None:
                 session['settings'][key] = request.args.get(key)
             else:
-                session['settings'][key] = vis.settings[key][0]
+                session['settings'][key] = vis.ALLOWED_SETTINGS[key][0]
+    else:
+        logger.debug('Selected Visualizer {0} has no settings.'.format(vis_name))
     inputs = []
     for image in session['image_list']:
         if image['uid'] == int(image_uid):
             full_path = os.path.join(session['img_input_dir'],
                                      image['filename'])
-            entry = {}
+            entry = dict()
             entry['filename'] = image['filename']
             entry['data'] = Image.open(full_path)
             inputs.append(entry)
-    if 'settings' in session:
-        vis.update_settings(session['settings'])
+
+    vis.update_settings(session['settings'])
     output = vis.make_visualization(
         inputs, output_dir=session['img_output_dir'])
     return jsonify(output[0])

picasso/interfaces/web.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+###############################################################################
+# Copyright (c) 2017 Merantix GmbH
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+#
+# Contributors:
+#    Jan Steinke - Restful API
+###############################################################################
+"""Flask blueprint for interfacing with picasso via web.
+
+This is used by the main flask application to provide a web front-end based on the REST api.
+"""
+
+from flask import (
+    render_template,
+    Blueprint
+    )
+
+frontend = Blueprint('frontend', __name__)
+
+
+@frontend.route('/')
+def index():
+    return render_template('v2/index.html')
+