Merge lp:~nataliabidart/magicicada-protocol/upload-to-pypi into lp:magicicada-protocol

[Natalia Bidart]

- Adapt setup.py so the project is buildable as wheel and available in Pypi (see https://pypi.org/project/ubuntuone-storageprotocol/).
- Added docker and travis files so test runs are executed on xenial envs and pass (see https://travis-ci.org/chicharreros/magicicada-protocol).

[lp:~nataliabidart/magicicada-protocol/upload-to-pypi]

178. By Natalia Bidart on 2018-04-08

More docker dependencies.

179. By Natalia Bidart on 2018-04-08

Merged update-copyright-headers into upload-to-pypi.

[Facundo Batista (facundo)]

+1

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2009-06-03 14:46:23 +0000
+++ .bzrignore	2018-04-08 19:49:23 +0000
@@ -8,3 +8,4 @@
 *.substvars
 *_pb2.py
 *.pyc
+*.egg-info
 
=== added file '.travis.yml'
--- .travis.yml	1970-01-01 00:00:00 +0000
+++ .travis.yml	2018-04-08 19:49:23 +0000
@@ -0,0 +1,13 @@
+sudo: required
+dist: trusty
+language: bash
+
+services:
+    - docker
+
+before_install:
+    - docker pull ubuntu:16.04
+    - docker build -t magicicada-test-run .
+
+script:
+    - docker run magicicada-test-run make test
 
=== added file 'Dockerfile'
--- Dockerfile	1970-01-01 00:00:00 +0000
+++ Dockerfile	2018-04-08 19:49:23 +0000
@@ -0,0 +1,14 @@
+FROM ubuntu:16.04
+
+ADD . /home/ubuntu/magicicada
+COPY . /home/ubuntu/magicicada
+WORKDIR /home/ubuntu/magicicada
+
+RUN apt update && apt install make gcc python python-dev virtualenv protobuf-compiler -y --no-install-recommends
+RUN make bootstrap
+
+RUN useradd -ms /bin/bash ubuntu
+RUN chown -R ubuntu:ubuntu /home/ubuntu
+
+USER ubuntu
+ENV HOME /home/ubuntu
 
=== added file 'Makefile'
--- Makefile	1970-01-01 00:00:00 +0000
+++ Makefile	2018-04-08 19:49:23 +0000
@@ -0,0 +1,62 @@
+# Copyright 2015-2018 Chicharreros (https://launchpad.net/~chicharreros)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+# For further info, check  http://launchpad.net/magicicada-protocol
+
+ENV = $(CURDIR)/.env
+SRC_DIR = $(CURDIR)/ubuntuone
+PATH := $(ENV)/bin:$(PATH)
+PYTHON = $(ENV)/bin/python
+PYTHONPATH := $(ENV)/lib/python2.7:$(ENV)/lib/python2.7/site-packages:$(SRC_DIR):$(PYTHONPATH)
+
+# use protobuf cpp
+PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=cpp
+PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION_VERSION=2
+
+export PATH
+export PYTHONPATH
+
+$(ENV): $(ENV)/bin/activate
+
+# only runs when requirements.txt or requirements-devel.txt changes
+$(ENV)/bin/activate: requirements.txt requirements-devel.txt
+	test -d $(ENV) || virtualenv $(ENV)
+	$(ENV)/bin/pip install -Ur requirements.txt
+	$(ENV)/bin/pip install -Ur requirements-devel.txt
+	touch $(ENV)/bin/activate
+
+bootstrap: build
+
+build: $(ENV)
+	$(PYTHON) setup.py build
+
+bdist: build
+	$(PYTHON) setup.py bdist_wheel
+
+upload: bdist
+	$(ENV)/bin/twine upload dist/*.whl
+
+test: lint
+	SSL_CERTIFICATES_DIR=ubuntuone/storageprotocol/tests/certs PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python $(ENV)/bin/trial ubuntuone
+
+clean:
+	$(PYTHON) setup.py clean
+	find -name '*.pyc' -delete
+	rm -rf build dist sdist _trial_temp ubuntuone_storageprotocol.egg-info
+
+lint: $(ENV)
+	$(ENV)/bin/flake8 --filename='*.py' --exclude='$(ENV),*_pb2.py,build'
+
+.PHONY: build bdist upload test lint
 
=== removed file 'README.windows'
--- README.windows	2010-03-15 18:48:27 +0000
+++ README.windows	1970-01-01 00:00:00 +0000
@@ -1,8 +0,0 @@
-installation steps
-
-- install protoc
-- download protobuf and "python setup.py install" in protobuf\python
-- easy_install pyopenssl
-- easy_install bzr
-- install twisted
-- install
 
=== added file 'requirements-devel.txt'
--- requirements-devel.txt	1970-01-01 00:00:00 +0000
+++ requirements-devel.txt	2018-04-08 19:49:23 +0000
@@ -0,0 +1,3 @@
+flake8
+mocker
+twine
 
=== added file 'requirements.txt'
--- requirements.txt	1970-01-01 00:00:00 +0000
+++ requirements.txt	2018-04-08 19:49:23 +0000
@@ -0,0 +1,11 @@
+pyOpenSSL
+protobuf
+# From twisted UserWarning: You do not have a working installation of the
+# service_identity module: 'No module named service_identity'.  Please install
+# it from <https://pypi.python.org/pypi/service_identity> and make sure all of
+# its dependencies are satisfied.  Without the service_identity module, Twisted
+# can perform only rudimentary TLS client hostname verification.  Many valid
+# certificate/hostname mappings may be rejected.
+service_identity
+twisted
+zope.interface
 
=== removed file 'run-tests'
--- run-tests	2018-04-08 19:36:31 +0000
+++ run-tests	1970-01-01 00:00:00 +0000
@@ -1,36 +0,0 @@
-#!/bin/bash
-#
-# Copyright 2010 Canonical Ltd.
-#
-# This program is free software: you can redistribute it and/or modify it
-# under the terms of the GNU Affero General Public License version 3,
-# as published by the Free Software Foundation.
-#
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranties of
-# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
-# PURPOSE. See the GNU Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-set -e
-
-SYSNAME=`uname -s`
-
-PROTOC_VERSION_AS_INT=`protoc --version | cut -d' ' -f2 | awk -F. '{ print $ 1 * 1000 + $2 * 100 + $ 3; }'`
-
-/usr/bin/env python setup.py build
-# run the tests with pure python protobuf
-SSL_CERTIFICATES_DIR=ubuntuone/storageprotocol/tests/certs PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python u1trial ubuntuone/storageprotocol/tests
-if [ "$SYSNAME" != "Darwin" ]; then
-    # and with the cpp extension, for server (linux) only:
-    if [ $PROTOC_VERSION_AS_INT -lt 2500 ]; then
-        SSL_CERTIFICATES_DIR=ubuntuone/storageprotocol/tests/certs PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=cpp u1trial ubuntuone/storageprotocol/tests
-    fi
-fi
-
-USE_PYFLAKES=1 u1lint
-/usr/bin/env python setup.py clean
-rm -rf build
-pep8 --repeat --ignore=E126,E127,E128 --exclude="*_pb2.py,.bzr,.pc,build" .
-rm -rf _trial_temp
 
=== removed file 'run-tests.bat'
--- run-tests.bat	2013-05-22 21:37:17 +0000
+++ run-tests.bat	1970-01-01 00:00:00 +0000
@@ -1,82 +0,0 @@
-:: Copyright 2012 Canonical Ltd.
-::
-:: This program is free software: you can redistribute it and/or modify it
-:: under the terms of the GNU General Public License version 3, as published
-:: by the Free Software Foundation.
-::
-:: This program is distributed in the hope that it will be useful, but
-:: WITHOUT ANY WARRANTY; without even the implied warranties of
-:: MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
-:: PURPOSE.  See the GNU General Public License for more details.
-::
-:: You should have received a copy of the GNU General Public License along
-:: with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-@ECHO off
-
-SET MODULE="tests"
-SET PYTHONEXEPATH=""
-SET IGNORE_PATHS="ubuntuone\controlpanel\dbustests"
-SET IGNORE_MODULES="test_linux.py, test_darwin.py"
-SET PYTHONPATH=%PYTHONPATH%;..\ubuntu-sso-client;..\ubuntuone-dev-tools\;..\dirspec;.
-
-ECHO Checking for Python on the path
-:: Look for Python from buildout
-FOR %%A in (python.exe) do (SET PYTHONEXEPATH=%%~$PATH:A)
-FOR %%B in (u1trial) do (SET TRIALPATH=%%~$PATH:B)
-FOR %%C in (u1lint) do (SET LINTPATH=%%~$PATH:C)
-FOR %%D in (pep8.exe) do (SET PEP8PATH=%%~$PATH:D)
-
-IF NOT "%PYTHONEXEPATH%" == "" GOTO :PYTHONPRESENT
-ECHO Please ensure you have python installed
-GOTO :END
-
-:PYTHONPRESENT
-
-:: throw the first parameter away if is /skip-lint,
-:: the way we do this is to ensure that /skip-lint
-:: is the first parameter and copy all the rest in a loop
-:: the main reason for that is that %* is not affected
-:: by SHIFT, that is, it allways have all passed parameters
-
-SET PARAMS=%*
-SET SKIPLINT=0
-IF "%1" == "/skip-lint" (
-    SET SKIPLINT=1
-    GOTO :CLEANPARAMS
-)ELSE (
-    GOTO :CONTINUEBATCH) 
-:CLEANPARAMS
-
-SHIFT
-SET PARAMS=%1
-:GETREST
-SHIFT
-if [%1]==[] (
-    GOTO CONTINUEBATCH)
-SET PARAMS=%PARAMS% %1
-GOTO GETREST
-:CONTINUEBATCH
-
-
-"%PYTHONEXEPATH%" setup.py build
-ECHO Running tests
-:: execute the tests with a number of ignored linux only modules
-"%PYTHONEXEPATH%" "%TRIALPATH%" -p %IGNORE_PATHS% -i %IGNORE_MODULES% %PARAMS% %MODULE%
-
-:: Clean the build from the setup.py
-ECHO Cleaning the generated code
-"%PYTHONEXEPATH%" setup.py clean
-
-IF %SKIPLINT% == 1 GOTO :CLEAN
-ECHO Performing style checks...
-SET USE_PYFLAKES=1
-"%PYTHONEXEPATH%" "%LINTPATH%" "%MODULE%"
-"%PEP8PATH%" --exclude ".svn,CVS,.bzr,.hg,.git,*_ui.py,*_rc.py,*_pb2.py" --repeat .
-
-:CLEAN
-:: Delete the temp folders
-IF "%TRIAL_TEMP_DIR%" == "" GOTO :TRIALTEMPEXISTS
-IF EXIST _trial_temp RMDIR /s /q _trial_temp
-:TRIALTEMPEXISTS
-IF EXIST "%TRIAL_TEMP_DIR%" RMDIR /s /q "%TRIAL_TEMP_DIR%"
 
=== modified file 'setup.py' (properties changed: +x to -x)
--- setup.py	2016-09-19 02:00:32 +0000
+++ setup.py	2018-04-08 19:49:23 +0000
@@ -1,7 +1,7 @@
-#!/usr/bin/env python
-# setup.py - Build system for Ubuntu One Storage Protocol package
+# -*- coding: utf-8 -*-
 #
 # Copyright 2009 Canonical Ltd.
+# Copyright 2015-2018 Chicharreros (https://launchpad.net/~chicharreros)
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3,
@@ -21,9 +21,9 @@
 import sys
 import subprocess
 
-from distutils.core import setup
 from distutils.spawn import find_executable
 from distutils.command import clean, build
+from setuptools import find_packages, setup
 
 
 class StorageProtocolBuild(build.build):
@@ -58,19 +58,30 @@
 
     def run(self):
         """Do the clean up"""
-        for source in \
-                glob.glob("ubuntuone/storageprotocol/*_pb2.py"):
+        for source in glob.glob("ubuntuone/storageprotocol/*_pb2.py"):
             os.unlink(source)
 
         # Call the parent class clean command
         clean.clean.run(self)
 
 
-setup(name='ubuntuone-storage-protocol',
-      version='99.12',
-      packages=['ubuntuone',
-                'ubuntuone.storageprotocol'],
-      extra_path='ubuntuone-storage-protocol',
-      cmdclass={'build': StorageProtocolBuild,
-                'clean': StorageProtocolClean},
-      )
+setup(
+    name='ubuntuone-storageprotocol',
+    namespace_packages=['ubuntuone'],
+    version='0.9.3',
+    description=(
+        'The protocol implementation for the Magicicada filesync server '
+        '(open source fork of the Ubuntu One filesync).'),
+    # From twisted - UserWarning: You do not have a working installation of the
+    # service_identity module: 'No module named service_identity'.  Please
+    # install it from <https://pypi.python.org/pypi/service_identity> and make
+    # sure all of its dependencies are satisfied.  Without the service_identity
+    # module, Twisted can perform only rudimentary TLS client hostname
+    # verification. Many valid certificate/hostname mappings may be rejected.
+    install_requires=[
+        'pyOpenSSL', 'protobuf', 'service_identity', 'twisted',
+        'zope.interface'],
+    packages=find_packages(),
+    cmdclass={'build': StorageProtocolBuild,
+              'clean': StorageProtocolClean},
+)
 
=== removed file 'ubuntuone.storageprotocol.pth'
--- ubuntuone.storageprotocol.pth	2011-02-07 22:57:54 +0000
+++ ubuntuone.storageprotocol.pth	1970-01-01 00:00:00 +0000
@@ -1,2 +0,0 @@
-ubuntuone-storage-protocol
-
 
=== modified file 'ubuntuone/storageprotocol/tests/test_context.py'
--- ubuntuone/storageprotocol/tests/test_context.py	2018-04-08 19:36:31 +0000
+++ ubuntuone/storageprotocol/tests/test_context.py	2018-04-08 19:49:23 +0000
@@ -132,7 +132,7 @@
         d = self.verify_context(server_context, client_context)
         e = yield self.assertFailure(d, SSL.Error)
         self.assertEqual(len(e.message), 1)
-        expected = ('SSL routines', 'ssl3_get_server_certificate',
+        expected = ('SSL routines', 'tls_process_server_certificate',
                     'certificate verify failed')
         self.assertEqual(e.message[0], expected)