Feature/basic server

.travis.yml

@@ -0,0 +1,9 @@
+language: python
+python:
+  - "3.6"
+# command to install dependencies
+install:
+  - python setup.py develop
+# command to run tests
+script:
+  - pytest --doctest-module

README.md

@@ -29,25 +29,23 @@ Instead of running these commands manually you can run the ./setup.sh script whi
 
 Or if you want to run the commands manually...
 
-```
-# From the root of the repo go to ./fullEndToEndDemo
-cd ./fullEndToEndDemo
-
-# Grab all the dependencies, this install is pretty huge
-sudo apt-get update
-sudo apt-get install git cmake g++ redis-server libboost-all-dev libopencv-dev python-opencv python-numpy python-scipy -y
-
-#Make it
-cmake .
-make
-
-# This step is optional. It removes a pointless annoying error opencv spits out
-# About: https://stackoverflow.com/questions/12689304/ctypes-error-libdc1394-error-failed-to-initialize-libdc1394
-sudo ln /dev/null /dev/raw1394
-
-# Then run either ./runDemo1.sh or ./runDemo2.sh to run the demo
-
-
+```console
+$ # From the root of the repo go to ./fullEndToEndDemo
+$ cd ./fullEndToEndDemo
+$ 
+$ # Grab all the dependencies, this install is pretty huge
+$ sudo apt-get update
+$ sudo apt-get install git cmake g++ redis-server libboost-all-dev libopencv-dev python-opencv python-numpy python-scipy -y
+$ 
+$ #Make it
+$ cmake .
+$ make
+$ 
+$ # This step is optional. It removes a pointless annoying error opencv spits out
+$ # About: https://stackoverflow.com/questions/12689304/ctypes-error-libdc1394-error-failed-to-initialize-libdc1394
+$ sudo ln /dev/null /dev/raw1394
+$ 
+$ # Then run either ./runDemo1.sh or ./runDemo2.sh to run the demo
 ```
 
 # Python setup
@@ -58,19 +56,19 @@ This setup was tested on a newly deployed vm on Ubuntu 18.04 LTS, YMMV on differ
 
 To use python package, do the following:
 
-```
-sudo apt-get update
-sudo apt-get install python3-pip python3-opencv redis-server -y
-
-# On some systems this path is missing
-# read more here: https://github.com/pypa/pip/issues/3813
-PATH="$PATH:~/.local/bin"
-
-#cd to project directory
-pip3 install .
+```console
+$ sudo apt-get update
+$ sudo apt-get install python3-pip python3-opencv redis-server -y
+$ 
+$ # On some systems this path is missing
+$ # read more here: https://github.com/pypa/pip/issues/3813
+$ PATH="$PATH:~/.local/bin"
+$ 
+$ # cd to project directory
+$ pip3 install .
 ```
 
-You also need install redis.
+if you got permission error, install it under virtual env or use `--user` flag.
 
 # Demo 1
 
@@ -94,8 +92,8 @@ The demo takes <s>2 minutes</s> (1 minute 38 seconds*) to run on a quad core VM
 
 *Thanks to [meowcoder](https://github.com/meowcoder) for the speed up!
 
-```
-user@instance-1:~/transformationInvariantImageSearch/fullEndToEndDemo$ time ./runDemo1.sh 
+```console
+$ time ./fullEndToEndDemo/runDemo1.sh 
 Loading image: inputImages/cat1.png ... done
 Added 46725 image fragments to DB
 Loading image: inputImages/cat2.png ... done
@@ -135,8 +133,8 @@ sys     0m6.592s
 python example
 
 ```console
-$ time transformation-invariant-image-search insert fullEndToEndDemo/inputImages/cat*  && \
-  time transformation-invariant-image-search lookup fullEndToEndDemo/inputImages/cat_original.png
+$ time transformation-invariant-image-search insert fullEndToEndDemo/inputImages/cat*  &&  \
+$ time transformation-invariant-image-search lookup fullEndToEndDemo/inputImages/cat_original.png
 
 loading fullEndToEndDemo/inputImages/cat1.png
 100%|██| 3/3 [00:07<00:00,  2.66s/it]
@@ -219,8 +217,8 @@ Here the two images mona.jpg and van_gogh.jpg are inserted into the database and
 
 *Thanks to [meowcoder](https://github.com/meowcoder) for the speed up!
 
-```
-user@instance-1:~/transformationInvariantImageSearch/fullEndToEndDemo$ time ./runDemo2.sh 
+```console
+$ time ./fullEndToEndDemo/runDemo2.sh 
 Loading image: ./inputImages/mona.jpg ... done
 Added 26991 image fragments to DB
 Loading image: ./inputImages/van_gogh.jpg ... done
@@ -239,8 +237,9 @@ sys     0m18.224s
 python example
 
 ```console
-$ time transformation-invariant-image-search insert ./fullEndToEndDemo/inputImages/mona.jpg ./fullEndToEndDemo/inputImages/van_gogh.jpg && \
-  time transformation-invariant-image-search lookup ./fullEndToEndDemo/inputImages/monaComposite.jpg
+$ time transformation-invariant-image-search insert \
+$ ./fullEndToEndDemo/inputImages/mona.jpg ./fullEndToEndDemo/inputImages/van_gogh.jpg && \
+$ time transformation-invariant-image-search lookup ./fullEndToEndDemo/inputImages/monaComposite.jpg
 
 loading ./fullEndToEndDemo/inputImages/mona.jpg
 100%|███| 3/3 [00:03<00:00,  1.24s/it]

setup.py

@@ -1,10 +1,6 @@
 #!/usr/bin/env python
 from setuptools import setup, find_packages
 
-"""
-TODO
-- copy or link `python` folder to `transformation_invariant_image_search`
-"""
 
 def readme():
     with open('README.md') as f:
@@ -29,16 +25,29 @@ def readme():
     zip_safe=False,
     python_requires='>=3.6',
     install_requires=[
+        'appdirs>=1.4.3',
+        'Flask-Admin==1.5.3',
+        'Flask-SQLAlchemy>=2.3.2',
+        'Flask>=1.0.2',
         'hiredis',
         'numpy',
+        'opencv-python>=4.0.0.21',
+        'Pillow>=5.4.1',
         'redis',
         'scikit-learn',
         'scipy',
+        'SQLAlchemy-Utils>=0.33.11',
         'tqdm>=4.29.1',
     ],
+    extras_require={
+        'dev': [
+            'docutils==0.14',
+            'pytest==4.2.0',
+        ],
+    },
     entry_points={
         'console_scripts': [
-            'transformation-invariant-image-search = transformation_invariant_image_search.main:main']
+            'transformation-invariant-image-search = transformation_invariant_image_search.main:cli']
     },
     classifiers=[
         'Development Status :: 3 - Alpha',

tests/test_main.py

@@ -0,0 +1,98 @@
+import json
+import os
+import shutil
+import tempfile
+
+from click.testing import CliRunner
+from flask import current_app
+import click
+import pytest
+
+from transformation_invariant_image_search import main
+
+
+@pytest.fixture
+def client():
+    db_fd, config_db = tempfile.mkstemp()
+    image_fd = tempfile.mkdtemp()
+    db_uri = 'sqlite:///{}'.format(config_db)
+    app = main.create_app(db_uri=db_uri, image_dir=image_fd)
+    app.config['DATABASE'] = config_db
+    app.config['TESTING'] = True
+    client = app.test_client()
+
+    yield client
+
+    os.close(db_fd)
+    os.unlink(app.config['DATABASE'])
+    shutil.rmtree(image_fd)
+
+
+def test_empty_db(client):
+    """Start with a blank database."""
+    rv = client.get('/')
+    assert b'Home - Transformation Invariant Image Search' in rv.data
+
+
+def test_checksum_get(client):
+    """test checksum with a blank database."""
+    url = '/api/checksum'
+    rv = client.get(url)
+    assert rv.get_json() == []
+
+
+def test_checksum_post(client):
+    """Start with a blank database."""
+    csm_value = '54abb6e1eb59cccf61ae356aff7e491894c5ca606dfda4240d86743424c65faf'
+    url = '/api/checksum'
+    exp_dict = dict(value=csm_value, id=1, ext='png', trash=False)
+    rv = client.post(url, data=dict(value=csm_value, ext='png'))
+    assert rv.get_json() == exp_dict
+    rv = client.get(url)
+    assert rv.get_json() == [exp_dict]
+
+
+def test_image_post(client):
+    url = '/api/image'
+    filename = 'fullEndToEndDemo/inputImages/cat_original.png'
+    csm_value = '54abb6e1eb59cccf61ae356aff7e491894c5ca606dfda4240d86743424c65faf'
+    ext = 'png'
+    exp_dict = dict(id=1, value=csm_value, ext=ext, trash=False)
+    rv = client.post(url)
+    assert rv.get_json()['error']
+    file_data = {'file': open(filename, 'rb')}
+    rv = client.post(url, data=file_data)
+    post_exp_dict = exp_dict.copy()
+    post_exp_dict['url'] = ['http://localhost/i/{}.{}'.format(csm_value, ext)]
+    assert rv.get_json() == post_exp_dict
+    image_dir = client.application.config.get('IMAGE_DIR')
+    exp_dst_file = os.path.join(image_dir, csm_value[:2], '{}.{}'.format(csm_value, ext))
+    assert os.path.isfile(exp_dst_file)
+    rv = client.get(url)
+    assert rv.get_json() == [exp_dict]
+
+
+def test_upload_api(client):
+    filename = 'fullEndToEndDemo/inputImages/cat1.png'
+    upload_url = '/api/image'
+    rv = client.post(upload_url, data={'file': open(filename, 'rb')})
+    assert rv.get_json() == {
+        'ext': 'png', 'id': 1, 'trash': False,
+        'url': ['http://localhost/i/4aba099f752d609aad2ed4c28f972ae96d02ad2579d0dd3f16b1ac29a88caf6d.png'],
+        'value': '4aba099f752d609aad2ed4c28f972ae96d02ad2579d0dd3f16b1ac29a88caf6d'
+    }
+
+
+@pytest.mark.parametrize(
+    'args,word',
+    [
+        ('--help', 'Usage:'),
+        ('--version', 'Transformation Invariant Image Search')
+    ]
+)
+def test_cli(args, word):
+    runner = CliRunner()
+    result = runner.invoke(main.cli, [args])
+    assert result.exit_code == 0
+    if word is not None:
+        assert word in result.output

tests/test_models.py

@@ -0,0 +1,13 @@
+def test_checksum():
+    from transformation_invariant_image_search import models, main
+    app = main.create_app(db_uri='sqlite://')
+    csm_value = '54abb6e1eb59cccf61ae356aff7e491894c5ca606dfda4240d86743424c65faf'
+    with app.app_context():
+        models.DB.create_all()
+        m = models.Checksum(value=csm_value, ext='png')
+        models.DB.session.add(m)
+        models.DB.session.commit()
+        assert m.id == 1
+
+        res = models.DB.session.query(models.Checksum).filter_by(id=1).first()
+        assert res.value == csm_value

transformation_invariant_image_search/keypoints.py

@@ -56,6 +56,16 @@ def recolour(img, gauss_width=41):
 
 
 def compute_keypoints(img):
+    """Compute keypoints.
+
+    >>> filename = 'fullEndToEndDemo/inputImages/cat_original.png'
+    >>> img = cv2.imread(filename)
+    >>> res = compute_keypoints(img)
+    >>> len(res) == 50
+    True
+    >>> sorted(res)[0]
+    (1.0, 26.0)
+    """
     gauss_width = 21
     img = recolour(img, gauss_width)
     b, _, _ = cv2.split(img)