From c224b8dd8e1d8c760f01aa63422db437401042ec Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Sat, 4 Nov 2017 23:07:10 +0100 Subject: [PATCH 01/19] Initial commit --- .gitignore | 92 +++++++++++++++++++++++ README.md | 60 +++++++++++++++ app.yaml | 15 ++++ appengine_config.py | 5 ++ config.json | 8 ++ decorators.py | 35 +++++++++ handlers.py | 175 +++++++++++++++++++++++++++++++++++++++++++ libs/.gitkeep | 0 main.py | 29 +++++++ requirements-app.txt | 1 + 10 files changed, 420 insertions(+) create mode 100644 .gitignore create mode 100644 README.md create mode 100644 app.yaml create mode 100644 appengine_config.py create mode 100644 config.json create mode 100644 decorators.py create mode 100644 handlers.py create mode 100644 libs/.gitkeep create mode 100644 main.py create mode 100644 requirements-app.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..97dc56b --- /dev/null +++ b/.gitignore @@ -0,0 +1,92 @@ +# 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 stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# IPython Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# dotenv +.env + +# virtualenv +venv/ +ENV/ + +# Spyder project settings +.spyderproject + +# Rope project settings +.ropeproject + +# Pycharm IDE directory +.idea diff --git a/README.md b/README.md new file mode 100644 index 0000000..c36e267 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# Private package index on Google App Engine +Intended to be used for companies or organizations that need a private PyPi. Originally based on [https://github.com/steiza/simplepypi](simplepypi), however this solution requires a compute engine instance which is quite expensive for the task. + +This application runs on Google App Engine and stores the uploaded packages on Google Cloud Storage. Like the original package it supports +1. Allows uploading of packages +2. Downloading by package (or package and version) +3. A / page that is navigatable with a web browser +4. /pypi/ listing +additionally it supports +5. Basic ACL through http auth + +Unsupported are: +1. Prevent overwriting a package with the same name / version +2. Package registration + +# Deploy service +Before deploying, install the required dependencies to the libs folder: +``` +pip install -t libs -r requirements-app.txt +``` +Next, have a look at config.json, you can set up multiple accounts for the http auth. The passwords are assumed to be hashed with sha1, you can obtain the hash as follows: +```python +from webapp2_extras import security +security.hash_password('mypassword', method='sha1') +``` +Now, you are ready to deploy to google app engine. Depending on how you set up your projects, this may require adjusting app.yaml, or setting the right project for gcloud. Then: +``` +gcloud app deploy app.yaml +``` +will launch your package index + +# Uploading packages to the package index +Uploading a python package is quite straightforward. First, add your private package index to `~/.pypirc`: +``` +[distutils] +index-servers = + pypi + local + +[local] +username = username +password = password +repository = https://project.appspot.com + +[pypi] +repository=https://pypi.python.org/pypi +username=your_pypi_username +password=your_pypi_password + +``` +The later reflects a configuration for uploading on the public pypi. Now go to the directory containing setup.py and upload your package to the private package index by specifying the local configuration: +``` +python setup.py sdist upload -r local +``` + +# Installing from the package index +When installing a package (e.g. dummy), specify the url to the package index: +``` +pip install -i http://username:password@localhost:8080/pypi dummy +``` \ No newline at end of file diff --git a/app.yaml b/app.yaml new file mode 100644 index 0000000..e4f592e --- /dev/null +++ b/app.yaml @@ -0,0 +1,15 @@ +runtime: python27 +api_version: 1 +threadsafe: yes + +handlers: +- url: /favicon\.ico + static_files: favicon.ico + upload: favicon\.ico + +- url: .* + script: main.app + +libraries: +- name: webapp2 + version: "2.5.2" diff --git a/appengine_config.py b/appengine_config.py new file mode 100644 index 0000000..1711b79 --- /dev/null +++ b/appengine_config.py @@ -0,0 +1,5 @@ +import os +from google.appengine.ext import vendor + +lib_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'libs') +vendor.add(lib_path) diff --git a/config.json b/config.json new file mode 100644 index 0000000..11d529f --- /dev/null +++ b/config.json @@ -0,0 +1,8 @@ +{ + "accounts": [ + { + "username": "username", + "password": "sha1(password)" + } + ] +} \ No newline at end of file diff --git a/decorators.py b/decorators.py new file mode 100644 index 0000000..43c0f9d --- /dev/null +++ b/decorators.py @@ -0,0 +1,35 @@ +import base64 +import json +from webapp2_extras import security + + +def basic_auth(func): + def callf(handler, *args, **kwargs): + auth_header = handler.request.headers.get('Authorization') + if auth_header is None: + __basic_login(handler) + else: + (username, password) = base64.b64decode(auth_header.split(' ')[1]).split(':') + if __basic_lookup(username) == __basic_hash(password): + return func(handler, *args, **kwargs) + else: + __basic_login(handler) + + return callf + + +def __basic_login(handler): + handler.response.set_status(401, message="Authorization Required") + handler.response.headers['WWW-Authenticate'] = 'Basic realm="Secure Area"' + + +def __basic_lookup(username): + with open('config.json') as data_file: + config = json.load(data_file) + for account in config["accounts"]: + if account['username'] == username: + return account['password'] + + +def __basic_hash(password): + return security.hash_password(password, method='sha1') diff --git a/handlers.py b/handlers.py new file mode 100644 index 0000000..7801f9b --- /dev/null +++ b/handlers.py @@ -0,0 +1,175 @@ +import os +import cgi +import webapp2 +import cloudstorage as gcs +from decorators import basic_auth +from google.appengine.api import app_identity + +# Standard setup +BUCKET_NAME = os.environ.get('BUCKET_NAME', app_identity.get_default_gcs_bucket_name()) +my_default_retry_params = gcs.RetryParams(initial_delay=0.2, + max_delay=5.0, + backoff_factor=2, + max_retry_period=15) +gcs.set_default_retry_params(my_default_retry_params) + + +class BaseHandler(webapp2.RequestHandler): + + def write404(self): + self.response.set_status(404) + self.response.write( + '404 Not Found' + '

Not found

' + ) + + def get_package_path(self, package, version=None, want_file=False): + path = '/{0}/packages/{1}/'.format(BUCKET_NAME, package) + + if version: + path = '{0}{1}'.format(path, version) + + if want_file: + path = '{0}/{1}'.format(path, '{}-{}.tar.gz'.format(package, version)) + + return path + + def generate_package_link(self, package_link): + path_split = [cgi.escape(pe) for pe in package_link.split('/')] + fname = '{package}-{version}.tar.gz'.format(package=path_split[-3], version=path_split[-2]) + return '{1}
'.format('/'.join(path_split[0:1] + path_split[2:-1]), fname) + + +# Handlers +class IndexHandler(BaseHandler): + + @basic_auth + def get(self): + self.response.write( + 'gaepypi' + 'packages' + ) + + @basic_auth + def post(self): + name = self.request.get('name', default_value=None) + version = self.request.get('version', default_value=None) + action = self.request.get(':action', default_value=None) + content = self.request.POST.getall('content')[0].file.read() + + if name and version and content and action == 'file_upload': + name = name.lower() + path = self.get_package_path(name, version, want_file=True) + + # Write file in bucket + write_retry_params = gcs.RetryParams(backoff_factor=1.1) + gcs_file = gcs.open(path, 'w', options={}, retry_params=write_retry_params) + gcs_file.write(content) + gcs_file.close() + + +class PypiHandler(BaseHandler): + + @basic_auth + def get(self): + self.response.write('\n') + packages_path = '/{0}/packages/'.format(BUCKET_NAME) + for package in gcs.listbucket(packages_path, delimiter='/'): + if package.is_dir: + vl = [version.filename for version in gcs.listbucket(package.filename, delimiter='/') if version.is_dir] + vl.sort() + + if len(vl) > 0: + self.response.write(self.generate_package_link(vl[-1])) + + self.response.write('') + + +class PypiPackageHandler(BaseHandler): + + @basic_auth + def get(self, package): + package = package.lower() + package_path = self.get_package_path(package) + contents = list(gcs.listbucket(package_path, delimiter='/')) + vl = [version.filename for version in contents if version.is_dir] + vl.sort() + + if len(vl) == 0: + self.write404() + return + + self.response.write('{}'.format(self.generate_package_link(vl[-1]))) + + +class PypiPackageVersionHandler(BaseHandler): + + @basic_auth + def get(self, package, version): + package = package.lower() + path = self.get_package_path(package, version, want_file=True) + + try: + gcs.stat(path) + self.response.write('{}'.format(self.generate_package_link(path))) + except gcs.NotFoundError: + self.write404() + + +class PackageBase(BaseHandler): + + @basic_auth + def get(self): + package_path = '/{0}/packages/'.format(BUCKET_NAME) + contents = list(gcs.listbucket(package_path, delimiter='/')) + contents.sort() + + self.response.write('\n') + + for each in contents: + name = each.filename.split('/')[-2] + self.response.write('{each}
'.format(each=cgi.escape(name),)) + + if len(contents) == 0: + self.response.write('Nothing to see here yet, try uploading a package!') + + self.response.write('\n') + + +class PackageList(BaseHandler): + + @basic_auth + def get(self, package): + package = package.lower() + package_path = self.get_package_path(package) + contents = list(gcs.listbucket(package_path, delimiter='/')) + versions = [version.filename for version in contents if version.is_dir] + versions.sort() + + if len(versions) == 0: + self.write404(self) + return + + self.response.write('\n') + + for each_version in versions: + self.response.write(self.generate_package_link(each_version)) + + self.response.write('\n') + + +class PackageDownload(BaseHandler): + + @basic_auth + def get(self, name, version, _): + path = self.get_package_path(name, version, want_file=True) + + self.response.content_type = 'application/octet-stream' + self.response.headers.add('Content-Disposition', 'attachment; filename={0}'.format(path.split('/')[-1])) + + gcs_file = gcs.open(path) + self.response.write(gcs_file.read()) + gcs_file.close() + + +__all__ = [cls.__name__ for cls in BaseHandler.__subclasses__()] diff --git a/libs/.gitkeep b/libs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/main.py b/main.py new file mode 100644 index 0000000..3af08b5 --- /dev/null +++ b/main.py @@ -0,0 +1,29 @@ +#!/usr/bin/env python +# +# Copyright 2007 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import webapp2 +from handlers import * + +app = webapp2.WSGIApplication([ + ('/', IndexHandler), + ('/pypi/', PypiHandler), + ('/pypi/([^/]*)/', PypiPackageHandler), + ('/pypi/([^/]*)/([^/]*)', PypiPackageVersionHandler), + ('/packages', PackageBase), + ('/packages/([^/]*)', PackageList), + ('/packages/([^/]*)/([^/]*)/(.*)', PackageDownload), +], debug=True) diff --git a/requirements-app.txt b/requirements-app.txt new file mode 100644 index 0000000..6e247aa --- /dev/null +++ b/requirements-app.txt @@ -0,0 +1 @@ +GoogleAppEngineCloudStorageClient==1.9.22.1 \ No newline at end of file From c72639ea70de156bf8f099ced3b395ff7ff1993d Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Sat, 4 Nov 2017 22:08:21 +0000 Subject: [PATCH 02/19] Add license --- LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 674 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d7e037d --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + gaepypi + Copyright (C) 2017 Joachim van der Herten + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU 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 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 . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + gaepypi Copyright (C) 2017 Joachim van der Herten + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. From 0faf561ac15d371d5a93f0aaefc38cb0295c2192 Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Sat, 4 Nov 2017 23:11:51 +0100 Subject: [PATCH 03/19] Updated readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c36e267..c1449e7 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Private package index on Google App Engine Intended to be used for companies or organizations that need a private PyPi. Originally based on [https://github.com/steiza/simplepypi](simplepypi), however this solution requires a compute engine instance which is quite expensive for the task. -This application runs on Google App Engine and stores the uploaded packages on Google Cloud Storage. Like the original package it supports +This application runs on Google App Engine (and now uses webapp2 instead of tornado) and stores the uploaded packages on Google Cloud Storage. Like the original package it supports 1. Allows uploading of packages 2. Downloading by package (or package and version) 3. A / page that is navigatable with a web browser @@ -56,5 +56,5 @@ python setup.py sdist upload -r local # Installing from the package index When installing a package (e.g. dummy), specify the url to the package index: ``` -pip install -i http://username:password@localhost:8080/pypi dummy +pip install -i http://username:password@project.appspot.com/pypi dummy ``` \ No newline at end of file From aa7080361936472a96e569e785cf044b30455e37 Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Sat, 4 Nov 2017 23:14:37 +0100 Subject: [PATCH 04/19] Complying to license --- app.yaml | 16 ++++++++++++++++ appengine_config.py | 16 ++++++++++++++++ decorators.py | 16 ++++++++++++++++ handlers.py | 16 ++++++++++++++++ main.py | 29 +++++++++++++++-------------- 5 files changed, 79 insertions(+), 14 deletions(-) diff --git a/app.yaml b/app.yaml index e4f592e..ea83733 100644 --- a/app.yaml +++ b/app.yaml @@ -1,3 +1,19 @@ +# GAEPyPi, private package index on Google App Engine +# Copyright (C) 2017 ML2Grow BVBA + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU 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 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 . + runtime: python27 api_version: 1 threadsafe: yes diff --git a/appengine_config.py b/appengine_config.py index 1711b79..ef0e9fa 100644 --- a/appengine_config.py +++ b/appengine_config.py @@ -1,3 +1,19 @@ +# GAEPyPi, private package index on Google App Engine +# Copyright (C) 2017 ML2Grow BVBA + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU 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 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 . + import os from google.appengine.ext import vendor diff --git a/decorators.py b/decorators.py index 43c0f9d..1885be8 100644 --- a/decorators.py +++ b/decorators.py @@ -1,3 +1,19 @@ +# GAEPyPi, private package index on Google App Engine +# Copyright (C) 2017 ML2Grow BVBA + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU 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 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 . + import base64 import json from webapp2_extras import security diff --git a/handlers.py b/handlers.py index 7801f9b..b78a2f6 100644 --- a/handlers.py +++ b/handlers.py @@ -1,3 +1,19 @@ +# GAEPyPi, private package index on Google App Engine +# Copyright (C) 2017 ML2Grow BVBA + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU 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 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 . + import os import cgi import webapp2 diff --git a/main.py b/main.py index 3af08b5..709f882 100644 --- a/main.py +++ b/main.py @@ -1,19 +1,20 @@ #!/usr/bin/env python # -# Copyright 2007 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# +# GAEPyPi, private package index on Google App Engine +# Copyright (C) 2017 ML2Grow BVBA + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU 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 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 . import webapp2 from handlers import * From 0d4101e16cb9c3f650692253b20881bc0bdb7006 Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Sat, 4 Nov 2017 23:16:36 +0100 Subject: [PATCH 05/19] Update README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c1449e7..73cc2df 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Private package index on Google App Engine -Intended to be used for companies or organizations that need a private PyPi. Originally based on [https://github.com/steiza/simplepypi](simplepypi), however this solution requires a compute engine instance which is quite expensive for the task. +Intended to be used for companies or organizations that need a private PyPi. Originally based on [simplepypi](https://github.com/steiza/simplepypi), however this solution requires a compute engine instance which is quite expensive for the task. This application runs on Google App Engine (and now uses webapp2 instead of tornado) and stores the uploaded packages on Google Cloud Storage. Like the original package it supports 1. Allows uploading of packages @@ -21,7 +21,7 @@ pip install -t libs -r requirements-app.txt Next, have a look at config.json, you can set up multiple accounts for the http auth. The passwords are assumed to be hashed with sha1, you can obtain the hash as follows: ```python from webapp2_extras import security -security.hash_password('mypassword', method='sha1') +security.hash_password('password', method='sha1') ``` Now, you are ready to deploy to google app engine. Depending on how you set up your projects, this may require adjusting app.yaml, or setting the right project for gcloud. Then: ``` From f744eec0d1e618625f3201f8c0ecbbebc7944573 Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Sat, 4 Nov 2017 22:17:36 +0000 Subject: [PATCH 06/19] Typo in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 73cc2df..0d8ff8e 100644 --- a/README.md +++ b/README.md @@ -56,5 +56,5 @@ python setup.py sdist upload -r local # Installing from the package index When installing a package (e.g. dummy), specify the url to the package index: ``` -pip install -i http://username:password@project.appspot.com/pypi dummy +pip install -i https://username:password@project.appspot.com/pypi dummy ``` \ No newline at end of file From 75a3af26e066a589fbb7cb0dbf74ea5b846adbd9 Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Sat, 4 Nov 2017 23:25:50 +0100 Subject: [PATCH 07/19] Error handling fixes --- config.json | 6 +++--- handlers.py | 16 +++++++++------- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/config.json b/config.json index 11d529f..9311a4f 100644 --- a/config.json +++ b/config.json @@ -1,8 +1,8 @@ { "accounts": [ { - "username": "username", - "password": "sha1(password)" + "username": "ml2growdep", + "password": "454f1b5de8b016bb1ac017662505bcb3035be873" } ] -} \ No newline at end of file +} diff --git a/handlers.py b/handlers.py index b78a2f6..37c240c 100644 --- a/handlers.py +++ b/handlers.py @@ -163,7 +163,7 @@ def get(self, package): versions.sort() if len(versions) == 0: - self.write404(self) + self.write404() return self.response.write('\n') @@ -180,12 +180,14 @@ class PackageDownload(BaseHandler): def get(self, name, version, _): path = self.get_package_path(name, version, want_file=True) - self.response.content_type = 'application/octet-stream' - self.response.headers.add('Content-Disposition', 'attachment; filename={0}'.format(path.split('/')[-1])) - - gcs_file = gcs.open(path) - self.response.write(gcs_file.read()) - gcs_file.close() + try: + gcs_file = gcs.open(path) + self.response.content_type = 'application/octet-stream' + self.response.headers.add('Content-Disposition', 'attachment; filename={0}'.format(path.split('/')[-1])) + self.response.write(gcs_file.read()) + gcs_file.close() + except gcs.NotFoundError: + self.write404() __all__ = [cls.__name__ for cls in BaseHandler.__subclasses__()] From 5c0ded4b31292dca0dff907e279890345bec6657 Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Sun, 5 Nov 2017 13:40:14 +0100 Subject: [PATCH 08/19] Include bucket ACL --- handlers.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/handlers.py b/handlers.py index 37c240c..c6fe64d 100644 --- a/handlers.py +++ b/handlers.py @@ -79,7 +79,7 @@ def post(self): # Write file in bucket write_retry_params = gcs.RetryParams(backoff_factor=1.1) - gcs_file = gcs.open(path, 'w', options={}, retry_params=write_retry_params) + gcs_file = gcs.open(path, 'w', options={'x-goog-acl': 'project-private'}, retry_params=write_retry_params) gcs_file.write(content) gcs_file.close() From a7695cbb0a028c36cc2c006ce17b9b996519ea1f Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Mon, 20 Nov 2017 22:30:53 +0100 Subject: [PATCH 09/19] Major rework, improving design and introducing testing --- .gitignore | 3 + README.md | 27 ++-- app.yaml | 17 ++- gaepypi/__init__.py | 22 +++ decorators.py => gaepypi/_decorators.py | 0 gaepypi/_handlers.py | 128 ++++++++++++++++ gaepypi/_version.py | 17 +++ gaepypi/exceptions.py | 19 +++ gaepypi/package.py | 161 ++++++++++++++++++++ gaepypi/storage.py | 113 ++++++++++++++ gaepypi/templates.py | 23 +++ gaepypi/templates/package-index.html.j2 | 7 + gaepypi/templates/storage-index.html.j2 | 3 + gaepypi/templates/version-index.html.j2 | 3 + main.py => gaepypi/wsgi.py | 11 +- handlers.py | 193 ------------------------ nox.py | 14 ++ tests/__init__.py | 0 tests/unit/__init__.py | 0 tests/unit/test_gcstorage.py | 121 +++++++++++++++ tests/unit/test_index.py | 114 ++++++++++++++ tests/unit/test_package.py | 136 +++++++++++++++++ 22 files changed, 923 insertions(+), 209 deletions(-) create mode 100644 gaepypi/__init__.py rename decorators.py => gaepypi/_decorators.py (100%) create mode 100644 gaepypi/_handlers.py create mode 100644 gaepypi/_version.py create mode 100644 gaepypi/exceptions.py create mode 100644 gaepypi/package.py create mode 100644 gaepypi/storage.py create mode 100644 gaepypi/templates.py create mode 100644 gaepypi/templates/package-index.html.j2 create mode 100644 gaepypi/templates/storage-index.html.j2 create mode 100644 gaepypi/templates/version-index.html.j2 rename main.py => gaepypi/wsgi.py (75%) delete mode 100644 handlers.py create mode 100644 nox.py create mode 100644 tests/__init__.py create mode 100644 tests/unit/__init__.py create mode 100644 tests/unit/test_gcstorage.py create mode 100644 tests/unit/test_index.py create mode 100644 tests/unit/test_package.py diff --git a/.gitignore b/.gitignore index 97dc56b..4e45e0e 100644 --- a/.gitignore +++ b/.gitignore @@ -78,6 +78,9 @@ celerybeat-schedule # dotenv .env +# nox +.nox + # virtualenv venv/ ENV/ diff --git a/README.md b/README.md index 0d8ff8e..44f87eb 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,18 @@ # Private package index on Google App Engine Intended to be used for companies or organizations that need a private PyPi. Originally based on [simplepypi](https://github.com/steiza/simplepypi), however this solution requires a compute engine instance which is quite expensive for the task. -This application runs on Google App Engine (and now uses webapp2 instead of tornado) and stores the uploaded packages on Google Cloud Storage. Like the original package it supports -1. Allows uploading of packages +This application runs on Google App Engine (and uses webapp2 instead of tornado) and stores the uploaded packages on Google Cloud Storage. It supports +1. Uploading of packages 2. Downloading by package (or package and version) 3. A / page that is navigatable with a web browser 4. /pypi/ listing -additionally it supports 5. Basic ACL through http auth +6. Prevent overwriting a package with the same name & version -Unsupported are: -1. Prevent overwriting a package with the same name / version -2. Package registration +Unsupported are: +1. Package registration -# Deploy service +## Deploy service Before deploying, install the required dependencies to the libs folder: ``` pip install -t libs -r requirements-app.txt @@ -29,7 +28,7 @@ gcloud app deploy app.yaml ``` will launch your package index -# Uploading packages to the package index +## Uploading packages to the package index Uploading a python package is quite straightforward. First, add your private package index to `~/.pypirc`: ``` [distutils] @@ -53,8 +52,18 @@ The later reflects a configuration for uploading on the public pypi. Now go to t python setup.py sdist upload -r local ``` -# Installing from the package index +## Installing from the package index When installing a package (e.g. dummy), specify the url to the package index: ``` pip install -i https://username:password@project.appspot.com/pypi dummy +``` + +## Running tests +To run the testsuite, we recommend to use the nox tool: +``` +pip install nox-automation +``` +Next, to run the tests: +``` +nox ``` \ No newline at end of file diff --git a/app.yaml b/app.yaml index ea83733..7d582c7 100644 --- a/app.yaml +++ b/app.yaml @@ -24,8 +24,21 @@ handlers: upload: favicon\.ico - url: .* - script: main.app + script: gaepypi.app libraries: - name: webapp2 - version: "2.5.2" + version: latest +- name: jinja2 + version: latest +- name: six + version: latest + +skip_files: +- ^(.*/)?#.*#$ +- ^(.*/)?.*~$ +- ^(.*/)?.*\.py[co]$ +- ^(.*/)?.*/RCS/.*$ +- ^(.*/)?\..*$ +- ^tests/.*$ +- ^\..*$ \ No newline at end of file diff --git a/gaepypi/__init__.py b/gaepypi/__init__.py new file mode 100644 index 0000000..85ff647 --- /dev/null +++ b/gaepypi/__init__.py @@ -0,0 +1,22 @@ +# GAEPyPi, private package index on Google App Engine +# Copyright (C) 2017 ML2Grow BVBA + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU 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 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 . + +from .exceptions import GAEPyPIError +from .package import Package, PackageIndex +from .storage import Storage, GCStorage +from .wsgi import app + +from ._version import __version__ \ No newline at end of file diff --git a/decorators.py b/gaepypi/_decorators.py similarity index 100% rename from decorators.py rename to gaepypi/_decorators.py diff --git a/gaepypi/_handlers.py b/gaepypi/_handlers.py new file mode 100644 index 0000000..fa17828 --- /dev/null +++ b/gaepypi/_handlers.py @@ -0,0 +1,128 @@ +# GAEPyPi, private package index on Google App Engine +# Copyright (C) 2017 ML2Grow BVBA + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU 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 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 . + +from .storage import GCStorage +from .package import Package, PackageIndex + +import os +import webapp2 +from cloudstorage import NotFoundError +from _decorators import basic_auth +from google.appengine.api import app_identity + + +class BaseHandler(webapp2.RequestHandler): + + def write_page(self, body): + self.response.write('{}'.format(body)) + + def write404(self): + self.response.set_status(404) + self.write_page('

Not found

') + + def get_storage(self): + bucket_name = os.environ.get('BUCKET_NAME', app_identity.get_default_gcs_bucket_name()) + return GCStorage(bucket_name) + + +# Handlers +class IndexHandler(BaseHandler): + + @basic_auth + def get(self): + self.write_page('packages') + + @basic_auth + def post(self): + name = self.request.get('name', default_value=None) + version = self.request.get('version', default_value=None) + action = self.request.get(':action', default_value=None) + upload = self.request.POST.getall('content')[0] + content = upload.file.read() + filename = upload.filename + + if name and version and content and action == 'file_upload': + package = Package(self.get_storage(), name, version) + package.put_file(filename, content) + + +class PypiHandler(BaseHandler): + + @basic_auth + def get(self): + self.write_page(self.get_storage().to_html(full_index=True)) + + +class PypiPackageHandler(BaseHandler): + + @basic_auth + def get(self, package): + storage = self.get_storage() + index = PackageIndex(storage, package) + if index.empty() or not index.exists(storage): + self.write404() + return + self.write_page(index.to_html(full_index=True)) + + +class PypiPackageVersionHandler(BaseHandler): + + @basic_auth + def get(self, package, version): + package = Package(self.get_storage(), package, version) + if not package.exists(): + self.write404() + return + self.write_page(package.to_html()) + + +class PackageBase(BaseHandler): + + @basic_auth + def get(self): + storage = self.get_storage() + if storage.empty(): + body = 'Nothing to see here yet, try uploading a package!' + else: + body = storage.to_html(full_index=False) + self.write_page(body) + + +class PackageList(BaseHandler): + + @basic_auth + def get(self, package): + index = PackageIndex(self.get_storage(), package) + if not index.exists(): + self.write404() + self.write_page(index.to_html(full_index=False)) + + +class PackageDownload(BaseHandler): + + @basic_auth + def get(self, name, version, filename): + try: + package = Package(self.get_storage(), name, version) + with package.get_file(filename) as gcs_file: + self.response.content_type = 'application/octet-stream' + self.response.headers.add('Content-Disposition', 'attachment; filename={0}'.format(filename)) + self.response.write(gcs_file.read()) + except NotFoundError: + self.write404() + + +__all__ = [cls.__name__ for cls in BaseHandler.__subclasses__()] diff --git a/gaepypi/_version.py b/gaepypi/_version.py new file mode 100644 index 0000000..c07f054 --- /dev/null +++ b/gaepypi/_version.py @@ -0,0 +1,17 @@ +# GAEPyPi, private package index on Google App Engine +# Copyright (C) 2017 ML2Grow BVBA + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU 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 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 . + +__version__ = '0.0.1' \ No newline at end of file diff --git a/gaepypi/exceptions.py b/gaepypi/exceptions.py new file mode 100644 index 0000000..dbaa190 --- /dev/null +++ b/gaepypi/exceptions.py @@ -0,0 +1,19 @@ +# GAEPyPi, private package index on Google App Engine +# Copyright (C) 2017 ML2Grow BVBA + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU 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 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 . + + +class GAEPyPIError(Exception): + pass \ No newline at end of file diff --git a/gaepypi/package.py b/gaepypi/package.py new file mode 100644 index 0000000..d387cc6 --- /dev/null +++ b/gaepypi/package.py @@ -0,0 +1,161 @@ +# GAEPyPi, private package index on Google App Engine +# Copyright (C) 2017 ML2Grow BVBA + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU 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 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 . + +from .exceptions import GAEPyPIError +from .templates import __templates__ + +import six +from contextlib import contextmanager +from abc import ABCMeta, abstractmethod + + +@six.add_metaclass(ABCMeta) +class BucketObject(object): + def __init__(self, storage, *args, **kwargs): + super(BucketObject, self).__init__(*args, **kwargs) + self.storage = storage + + def enquire_storage(self, storage): + return storage or self.storage + + @abstractmethod + def to_html(self): + pass + + @abstractmethod + def exists(self): + pass + + @abstractmethod + def empty(self): + pass + + +class Package(BucketObject): + + def __init__(self, storage, name, version): + super(Package, self).__init__(storage) + self.name = name.lower() + self.version = version + + files = [] + path = storage.get_package_path(name.lower(), version) + for f in storage.ls(path+'/'): + files.append(storage.split_path(f)['filename']) + self.files = set(files) + + def __str__(self): + return '{0}-{1}'.format(self.name, self.version) + + def __lt__(self, other): + return self.version < other.version if self.name == other.name else self.name < other.name + + def __eq__(self, other): + return isinstance(other, Package) \ + and self.name == other.name \ + and self.version == other.version + + def __hash__(self): + return hash((self.name, self.version)) + + def exists(self, storage=None): + storage = self.enquire_storage(storage) + version_path = storage.get_package_path(self.name, self.version) + return storage.path_exists(version_path) + + def to_html(self): + template = __templates__.get_template('package-index.html.j2') + return template.render({'indices': [[self]]}) + + def empty(self): + return len(self.files) == 0 + + @contextmanager + def get_file(self, filename, storage=None): + if filename not in self.files: + raise GAEPyPIError("File not found for {0}".format(self)) + storage = self.enquire_storage(storage) + path = storage.get_package_path(self.name, self.version, filename) + gcs_file = storage.read(path) + yield gcs_file + gcs_file.close() + + def put_file(self, filename, content, storage=None): + if filename in self.files: + err_msg = "File {0} has already been added to {1}, upload a new version".format(filename, self) + raise GAEPyPIError(err_msg) + storage = self.enquire_storage(storage) + path = storage.get_package_path(self.name, self.version, filename) + storage.write(path, content) + self.files.add(filename) + + +class PackageIndex(BucketObject, set): + + @classmethod + def get_all(cls, storage): + path = storage.get_packages_path() + packages = storage.ls(path, dir_only=True) + return [cls(storage, storage.split_path(package_path)['package']) for package_path in packages] + + def __init__(self, storage, name): + package_path = storage.get_package_path(name.lower()) + contents = storage.ls(package_path, dir_only=True) + versions = [storage.split_path(version_path)['version'] for version_path in contents] + super(PackageIndex, self).__init__(storage, [Package(storage, name, v) for v in versions]) + self.name = name + + def __str__(self): + return "Package Index for {0}".format(self.name) + + def __lt__(self, other): + return self.name < other.name + + @property + def size(self): + return len(self) + + def empty(self): + return self.size == 0 + + def exists(self, storage=None): + storage = self.enquire_storage(storage) + package_path = storage.get_package_path(self.name) + return storage.path_exists(package_path) + + def add(self, other): + assert isinstance(other, Package) + if self.name != other.name: + raise GAEPyPIError("Package {0} can not be added to {1} (name differs)".format(other, self)) + + if other in self: + raise GAEPyPIError("Version already exists, you should upload a different version.") + + super(PackageIndex, self).add(other) + + def to_html(self, full_index=True): + if full_index: + template = __templates__.get_template('package-index.html.j2') + return template.render({'indices': [self]}) + else: + template = __templates__.get_template('version-index.html.j2') + return template.render({'packages': self}) + + def get_version(self, version): + for p in self: + if p.version == version: + return p + raise GAEPyPIError("Version {0} not found!".format(version)) diff --git a/gaepypi/storage.py b/gaepypi/storage.py new file mode 100644 index 0000000..cee1e32 --- /dev/null +++ b/gaepypi/storage.py @@ -0,0 +1,113 @@ +# GAEPyPi, private package index on Google App Engine +# Copyright (C) 2017 ML2Grow BVBA + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU 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 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 . + +from .package import PackageIndex +from .templates import __templates__ + +import six +from abc import ABCMeta, abstractmethod +import cloudstorage as gcs + +my_default_retry_params = gcs.RetryParams(initial_delay=0.2, + max_delay=5.0, + backoff_factor=2, + max_retry_period=15) +gcs.set_default_retry_params(my_default_retry_params) + + +@six.add_metaclass(ABCMeta) +class Storage(object): + + @abstractmethod + def get_packages_path(self): + pass + + @abstractmethod + def get_package_path(self): + pass + + @abstractmethod + def split_path(self): + pass + + @abstractmethod + def ls(self, path, dir_only=False): + pass + + @abstractmethod + def read(self, path): + pass + + @abstractmethod + def write(self, path, content): + pass + + @abstractmethod + def file_exists(self, path): + pass + + def empty(self): + return len(PackageIndex.get_all(self)) == 0 + + def to_html(self, full_index=True): + package_indices = PackageIndex.get_all(self) + template_file = 'storage-index.html.j2' if not full_index else 'package-index.html.j2' + template = __templates__.get_template(template_file) + return template.render({'indices': package_indices}) + + +class GCStorage(Storage): + def __init__(self, bucket, acl='project-private'): + self.bucket = bucket + self.acl = acl + + def get_packages_path(self): + return '/{0}/packages'.format(self.bucket) + + def get_package_path(self, package, version=None, filename=None): + path = '{0}/{1}'.format(self.get_packages_path(), package) + if version: + path = '{0}/{1}'.format(path, version) + if filename: + path = '{0}/{1}'.format(path, filename) + return path + + def split_path(self, path): + segments = path.split('/') + assert segments[1] == self.bucket + segments = segments[3:-1] if segments[-1] == '' else segments[3:] + components = ['package', 'version', 'filename'] + return dict(zip(components, segments)) + + def ls(self, path, dir_only=False): + padded = path if path[-1] == '/' else path+'/' + return [f.filename for f in gcs.listbucket(padded, delimiter='/') if f.is_dir or not dir_only] + + def read(self, path): + return gcs.open(path) + + def write(self, path, content): + write_retry_params = gcs.RetryParams(backoff_factor=1.1) + gcs_file = gcs.open(path, 'w', options={'x-goog-acl': self.acl}, retry_params=write_retry_params) + gcs_file.write(content) + gcs_file.close() + + def file_exists(self, path): + match = list(gcs.listbucket(path.rstrip('/'), delimiter='/')) + return len(match) == 1 and not match[0].is_dir + + def path_exists(self, path): + return len(list(gcs.listbucket(path.rstrip('/'), delimiter='/'))) == 1 diff --git a/gaepypi/templates.py b/gaepypi/templates.py new file mode 100644 index 0000000..a4db636 --- /dev/null +++ b/gaepypi/templates.py @@ -0,0 +1,23 @@ +# GAEPyPi, private package index on Google App Engine +# Copyright (C) 2017 ML2Grow BVBA + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU 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 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 . + +import os +import jinja2 + +__templates__ = jinja2.Environment(loader=jinja2.FileSystemLoader( + os.path.join(os.path.dirname(__file__), 'templates')), + extensions=['jinja2.ext.autoescape'], + autoescape=True) \ No newline at end of file diff --git a/gaepypi/templates/package-index.html.j2 b/gaepypi/templates/package-index.html.j2 new file mode 100644 index 0000000..d1fe8ea --- /dev/null +++ b/gaepypi/templates/package-index.html.j2 @@ -0,0 +1,7 @@ +{% for index in indices | sort %} + {% for package in index | sort %} + {% for filename in package.files|sort %} + {{ filename }}
+ {% endfor %} + {% endfor %} +{% endfor %} diff --git a/gaepypi/templates/storage-index.html.j2 b/gaepypi/templates/storage-index.html.j2 new file mode 100644 index 0000000..d2c4577 --- /dev/null +++ b/gaepypi/templates/storage-index.html.j2 @@ -0,0 +1,3 @@ +{% for index in indices | sort %} + {{ index.name }}
+{% endfor %} \ No newline at end of file diff --git a/gaepypi/templates/version-index.html.j2 b/gaepypi/templates/version-index.html.j2 new file mode 100644 index 0000000..b25fadb --- /dev/null +++ b/gaepypi/templates/version-index.html.j2 @@ -0,0 +1,3 @@ +{% for package in packages | sort %} + {{ package|string() }}
+{% endfor %} \ No newline at end of file diff --git a/main.py b/gaepypi/wsgi.py similarity index 75% rename from main.py rename to gaepypi/wsgi.py index 709f882..86ff20f 100644 --- a/main.py +++ b/gaepypi/wsgi.py @@ -17,14 +17,15 @@ # along with this program. If not, see . import webapp2 -from handlers import * +from _handlers import * app = webapp2.WSGIApplication([ ('/', IndexHandler), ('/pypi/', PypiHandler), - ('/pypi/([^/]*)/', PypiPackageHandler), - ('/pypi/([^/]*)/([^/]*)', PypiPackageVersionHandler), + ('/pypi/([^/]+)/', PypiPackageHandler), + ('/pypi/([^/]+)/([^/]+)', PypiPackageVersionHandler), ('/packages', PackageBase), - ('/packages/([^/]*)', PackageList), - ('/packages/([^/]*)/([^/]*)/(.*)', PackageDownload), + ('/packages/([^/]+)', PackageList), + ('/packages/([^/]+)/([^/]+)', PypiPackageVersionHandler), + ('/packages/([^/]+)/([^/]+)/(.+)', PackageDownload) ], debug=True) diff --git a/handlers.py b/handlers.py deleted file mode 100644 index c6fe64d..0000000 --- a/handlers.py +++ /dev/null @@ -1,193 +0,0 @@ -# GAEPyPi, private package index on Google App Engine -# Copyright (C) 2017 ML2Grow BVBA - -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU 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 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 . - -import os -import cgi -import webapp2 -import cloudstorage as gcs -from decorators import basic_auth -from google.appengine.api import app_identity - -# Standard setup -BUCKET_NAME = os.environ.get('BUCKET_NAME', app_identity.get_default_gcs_bucket_name()) -my_default_retry_params = gcs.RetryParams(initial_delay=0.2, - max_delay=5.0, - backoff_factor=2, - max_retry_period=15) -gcs.set_default_retry_params(my_default_retry_params) - - -class BaseHandler(webapp2.RequestHandler): - - def write404(self): - self.response.set_status(404) - self.response.write( - '404 Not Found' - '

Not found

' - ) - - def get_package_path(self, package, version=None, want_file=False): - path = '/{0}/packages/{1}/'.format(BUCKET_NAME, package) - - if version: - path = '{0}{1}'.format(path, version) - - if want_file: - path = '{0}/{1}'.format(path, '{}-{}.tar.gz'.format(package, version)) - - return path - - def generate_package_link(self, package_link): - path_split = [cgi.escape(pe) for pe in package_link.split('/')] - fname = '{package}-{version}.tar.gz'.format(package=path_split[-3], version=path_split[-2]) - return '{1}
'.format('/'.join(path_split[0:1] + path_split[2:-1]), fname) - - -# Handlers -class IndexHandler(BaseHandler): - - @basic_auth - def get(self): - self.response.write( - 'gaepypi' - 'packages' - ) - - @basic_auth - def post(self): - name = self.request.get('name', default_value=None) - version = self.request.get('version', default_value=None) - action = self.request.get(':action', default_value=None) - content = self.request.POST.getall('content')[0].file.read() - - if name and version and content and action == 'file_upload': - name = name.lower() - path = self.get_package_path(name, version, want_file=True) - - # Write file in bucket - write_retry_params = gcs.RetryParams(backoff_factor=1.1) - gcs_file = gcs.open(path, 'w', options={'x-goog-acl': 'project-private'}, retry_params=write_retry_params) - gcs_file.write(content) - gcs_file.close() - - -class PypiHandler(BaseHandler): - - @basic_auth - def get(self): - self.response.write('\n') - packages_path = '/{0}/packages/'.format(BUCKET_NAME) - for package in gcs.listbucket(packages_path, delimiter='/'): - if package.is_dir: - vl = [version.filename for version in gcs.listbucket(package.filename, delimiter='/') if version.is_dir] - vl.sort() - - if len(vl) > 0: - self.response.write(self.generate_package_link(vl[-1])) - - self.response.write('') - - -class PypiPackageHandler(BaseHandler): - - @basic_auth - def get(self, package): - package = package.lower() - package_path = self.get_package_path(package) - contents = list(gcs.listbucket(package_path, delimiter='/')) - vl = [version.filename for version in contents if version.is_dir] - vl.sort() - - if len(vl) == 0: - self.write404() - return - - self.response.write('{}'.format(self.generate_package_link(vl[-1]))) - - -class PypiPackageVersionHandler(BaseHandler): - - @basic_auth - def get(self, package, version): - package = package.lower() - path = self.get_package_path(package, version, want_file=True) - - try: - gcs.stat(path) - self.response.write('{}'.format(self.generate_package_link(path))) - except gcs.NotFoundError: - self.write404() - - -class PackageBase(BaseHandler): - - @basic_auth - def get(self): - package_path = '/{0}/packages/'.format(BUCKET_NAME) - contents = list(gcs.listbucket(package_path, delimiter='/')) - contents.sort() - - self.response.write('\n') - - for each in contents: - name = each.filename.split('/')[-2] - self.response.write('{each}
'.format(each=cgi.escape(name),)) - - if len(contents) == 0: - self.response.write('Nothing to see here yet, try uploading a package!') - - self.response.write('\n') - - -class PackageList(BaseHandler): - - @basic_auth - def get(self, package): - package = package.lower() - package_path = self.get_package_path(package) - contents = list(gcs.listbucket(package_path, delimiter='/')) - versions = [version.filename for version in contents if version.is_dir] - versions.sort() - - if len(versions) == 0: - self.write404() - return - - self.response.write('\n') - - for each_version in versions: - self.response.write(self.generate_package_link(each_version)) - - self.response.write('\n') - - -class PackageDownload(BaseHandler): - - @basic_auth - def get(self, name, version, _): - path = self.get_package_path(name, version, want_file=True) - - try: - gcs_file = gcs.open(path) - self.response.content_type = 'application/octet-stream' - self.response.headers.add('Content-Disposition', 'attachment; filename={0}'.format(path.split('/')[-1])) - self.response.write(gcs_file.read()) - gcs_file.close() - except gcs.NotFoundError: - self.write404() - - -__all__ = [cls.__name__ for cls in BaseHandler.__subclasses__()] diff --git a/nox.py b/nox.py new file mode 100644 index 0000000..98f2ca7 --- /dev/null +++ b/nox.py @@ -0,0 +1,14 @@ +import nox + + +@nox.session +@nox.parametrize('python_version', ['2.7']) +def default(session, python_version): + session.interpreter = 'python' + python_version + session.install('mock', 'pytest', 'gae_installer', 'pyaml', 'webob', 'GoogleAppEngineCloudStorageClient', 'jinja2', + 'webapp2', 'six') + + session.run( + 'pytest', + 'tests/unit' + ) \ No newline at end of file diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/unit/__init__.py b/tests/unit/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/unit/test_gcstorage.py b/tests/unit/test_gcstorage.py new file mode 100644 index 0000000..64d927f --- /dev/null +++ b/tests/unit/test_gcstorage.py @@ -0,0 +1,121 @@ +from google.appengine.ext import testbed +from gaepypi import GCStorage +from mock import patch, Mock, PropertyMock +import unittest + + +class TestGCSStorage(unittest.TestCase): + + def setUp(self): + self.testbed = testbed.Testbed() + self.testbed.activate() + self.testbed.init_app_identity_stub() + self.testbed.init_datastore_v3_stub() + self.s = GCStorage('mybucket') + + def tearDown(self): + self.testbed.deactivate() + + def test_packages_path(self): + assert self.s.get_packages_path() == '/mybucket/packages' + + + def test_package_path(self): + assert self.s.get_package_path('dummy') == '/mybucket/packages/dummy' + assert self.s.get_package_path('dummy', '0.0.1') == '/mybucket/packages/dummy/0.0.1' + assert self.s.get_package_path('dummy', '0.0.1', 'file.txt') == '/mybucket/packages/dummy/0.0.1/file.txt' + + + def test_split_path(self): + assert self.s.split_path('/mybucket/packages/dummy') == {'package': 'dummy'} + assert self.s.split_path('/mybucket/packages/dummy/') == {'package': 'dummy'} + assert self.s.split_path('/mybucket/packages/dummy/0.0.1') == {'package': 'dummy', 'version': '0.0.1'} + assert self.s.split_path('/mybucket/packages/dummy/0.0.1/file.txt') == {'package': 'dummy', + 'version': '0.0.1', + 'filename': 'file.txt'} + + @patch('gaepypi.storage.gcs.listbucket') + def test_file_exists(self, mock): + m = Mock() + type(m).is_dir = PropertyMock(return_value=False) + mock.return_value = [m] + assert self.s.file_exists('/mybucket/file.txt') + mock.assert_called_with('/mybucket/file.txt', delimiter='/') + + @patch('gaepypi.storage.gcs.listbucket') + def test_file_not_exists(self, mock): + mock.return_value = [] + assert not self.s.file_exists('/mybucket/file.txt') + mock.assert_called_with('/mybucket/file.txt', delimiter='/') + + @patch('gaepypi.storage.gcs.listbucket') + def test_file_is_dir(self, mock): + m = Mock() + type(m).is_dir = PropertyMock(return_value=True) + mock.return_value = [m] + assert not self.s.file_exists('/mybucket/file') + mock.assert_called_with('/mybucket/file', delimiter='/') + + @patch('gaepypi.storage.gcs.listbucket') + def test_path_is_dir(self, mock): + m = Mock() + type(m).is_dir = PropertyMock(return_value=True) + mock.return_value = [m] + assert self.s.path_exists('/mybucket/file') + mock.assert_called_with('/mybucket/file', delimiter='/') + + @patch('gaepypi.storage.gcs.listbucket') + def test_path_exists(self, mock): + m = Mock() + type(m).is_dir = PropertyMock(return_value=False) + mock.return_value = [m] + assert self.s.path_exists('/mybucket/file.txt') + mock.assert_called_with('/mybucket/file.txt', delimiter='/') + + @patch('gaepypi.storage.gcs.listbucket') + def test_ls_all(self, mock): + files = [] + filenames = list(map(lambda f: '/mybucket/path/{0}'.format(f), ['dummy', 'a.txt', 'b.txt', 'wheel'])) + for isdir, filename in zip([True, False, False, True], filenames): + m = Mock() + type(m).is_dir = PropertyMock(return_value=isdir) + type(m).filename = PropertyMock(return_value=filename) + files.append(m) + mock.return_value = files + retrieved = self.s.ls('/mybucket/path/') + mock.assert_called_with('/mybucket/path/', delimiter='/') + assert len(retrieved) == 4 + assert filenames == retrieved + + @patch('gaepypi.storage.gcs.listbucket') + def test_ls_dir_only(self, mock): + files = [] + filenames = list(map(lambda f: '/mybucket/path/{0}'.format(f), ['dummy', 'a.txt', 'b.txt', 'wheel'])) + for isdir, filename in zip([True, False, False, True], filenames): + m = Mock() + type(m).is_dir = PropertyMock(return_value=isdir) + type(m).filename = PropertyMock(return_value=filename) + files.append(m) + mock.return_value = files + retrieved = self.s.ls('/mybucket/path', dir_only=True) + mock.assert_called_with('/mybucket/path/', delimiter='/') + assert len(retrieved) == 2 + assert filenames[0] == retrieved[0] + assert filenames[3] == retrieved[1] + + @patch('gaepypi.storage.gcs.open') + def test_open(self, mock): + self.s.read('/mybucket/path/a.txt') + mock.assert_called_with('/mybucket/path/a.txt') + + @patch('gaepypi.storage.gcs.open') + @patch('gaepypi.storage.gcs.RetryParams') + def test_write(self, retry, open): + retry.return_value = 'rp' + m = Mock() + m.write = Mock() + open.return_value = m + self.s.write('/mybucket/path/a.txt', '1111111') + retry.assert_called_with(backoff_factor=1.1) + open.assert_called_with('/mybucket/path/a.txt', 'w', options={'x-goog-acl': 'project-private'}, retry_params='rp') + m.write.assert_called_with('1111111') diff --git a/tests/unit/test_index.py b/tests/unit/test_index.py new file mode 100644 index 0000000..2b24c27 --- /dev/null +++ b/tests/unit/test_index.py @@ -0,0 +1,114 @@ +from gaepypi import Package, PackageIndex, GAEPyPIError +import mock +import unittest + + +class ResponseList(object): + def __init__(self, *args): + super(ResponseList, self).__init__() + self.responses = args + self._counter = 0 + + def __call__(self, *args, **kwargs): + val = self.responses[self._counter % len(self.responses)] + self._counter += 1 + return val + + +class TestPackageIndex(unittest.TestCase): + + def _storage_mock(self, name, version, files): + storage = mock.Mock() + path = '/mybucket/packages/{0}/{1}'.format(name, version) + storage.get_package_path = mock.Mock(return_value=path) + if len(files) == 1: + storage.split_path = mock.Mock(return_value={'filename': files[0]}) + storage.ls = mock.Mock(return_value=map(lambda f: path+'/'+f, files)) + return storage + + def setUp(self): + # Prepare storage interactions + self.storage = mock.Mock() + path = '/mybucket/packages/dummy' + self.storage.get_package_path = mock.Mock(side_effect=ResponseList(path, path + '/0.0.1', path + '/0.0.2')) + self.storage.ls = mock.Mock( + side_effect=ResponseList(['/mybucket/packages/dummy/0.0.1', '/mybucket/packages/dummy/0.0.2'], + ['/mybucket/packages/dummy/0.0.1/a.whl'], + ['/mybucket/packages/dummy/0.0.2/b.whl'])) + self.storage.split_path = mock.Mock(side_effect=ResponseList(dict(version='0.0.1'), + dict(version='0.0.2'), + dict(filename='a.whl'), + dict(filename='b.whl'))) + + self.index = PackageIndex(self.storage, 'dummy') + + def test_instantiation(self): + # Verify calls + self.storage.get_package_path.assert_has_calls([mock.call('dummy'), + mock.call('dummy', '0.0.1'), + mock.call('dummy', '0.0.2')]) + self.storage.ls.assert_has_calls([mock.call('/mybucket/packages/dummy', dir_only=True), + mock.call('/mybucket/packages/dummy/0.0.1/'), + mock.call('/mybucket/packages/dummy/0.0.2/')]) + self.storage.split_path.assert_has_calls([mock.call('/mybucket/packages/dummy/0.0.1'), + mock.call('/mybucket/packages/dummy/0.0.2'), + mock.call('/mybucket/packages/dummy/0.0.1/a.whl'), + mock.call('/mybucket/packages/dummy/0.0.2/b.whl')]) + assert self.index.name == 'dummy' + assert self.index.size == len(self.index) == 2 + assert not self.index.empty() + + def test_content(self): + s1 = self._storage_mock('dummy', '0.0.1', ['a.whl']) + s2 = self._storage_mock('dummy', '0.0.2', ['b.whl']) + s3 = self._storage_mock('dummy', '0.0.3', ['c.whl']) + + p1 = Package(s1, 'dummy', '0.0.1') + p2 = Package(s2, 'dummy', '0.0.2') + p3 = Package(s3, 'dummy', '0.0.3') + + assert p1 in self.index + assert p2 in self.index + assert p3 not in self.index + + def test_get_version(self): + with self.assertRaises(GAEPyPIError): + self.index.get_version('0.0.3') + + p = self.index.get_version('0.0.2') + assert isinstance(p, Package) + assert p.name == 'dummy' + assert p.version == '0.0.2' + assert p.files == set(['b.whl']) + + def test_add_version(self): + s3 = self._storage_mock('dummy', '0.0.3', ['c.whl']) + p3 = Package(s3, 'dummy', '0.0.3') + self.index.add(p3) + assert p3 in self.index + assert self.index.size == 3 + + def test_add_version_incorrect_name(self): + s3 = self._storage_mock('wheel', '0.0.3', ['c.whl']) + p3 = Package(s3, 'wheel', '0.0.3') + with self.assertRaises(GAEPyPIError): + self.index.add(p3) + + def test_add_version_exists(self): + s2 = self._storage_mock('dummy', '0.0.2', ['b.whl']) + p2 = Package(s2, 'dummy', '0.0.2') + with self.assertRaises(GAEPyPIError): + self.index.add(p2) + + def test_exists(self): + self.storage.get_package_path = mock.Mock(return_value='/mybucket/packages/dummy') + self.storage.path_exists = mock.Mock(return_value=True) + assert self.index.exists() + self.storage.path_exists.assert_called_with('/mybucket/packages/dummy') + + def test_not_exists(self): + self.storage.get_package_path = mock.Mock(return_value='/mybucket/packages/dummy') + self.storage.path_exists = mock.Mock(return_value=False) + assert not self.index.exists() + self.storage.path_exists.assert_called_with('/mybucket/packages/dummy') + diff --git a/tests/unit/test_package.py b/tests/unit/test_package.py new file mode 100644 index 0000000..ee053c1 --- /dev/null +++ b/tests/unit/test_package.py @@ -0,0 +1,136 @@ +import mock +from gaepypi import Package, GAEPyPIError +import unittest + + +class TestPackage(unittest.TestCase): + + def _storage_mock(self, name, version, files): + storage = mock.Mock() + path = '/mybucket/packages/{0}/{1}'.format(name, version) + storage.get_package_path = mock.Mock(return_value=path) + if len(files) == 1: + storage.split_path = mock.Mock(return_value={'filename': files[0]}) + storage.ls = mock.Mock(return_value=map(lambda f: path+'/'+f, files)) + return storage + + def test_instantiation(self): + storage = self._storage_mock('dummy', '0.0.1', ['file.txt']) + p = Package(storage, 'dummy', '0.0.1') + + storage.ls.assert_called_with('/mybucket/packages/dummy/0.0.1/') + storage.get_package_path.assert_called_with('dummy', '0.0.1') + assert p.name == 'dummy' + assert p.version == '0.0.1' + assert 'file.txt' in p.files + assert len(p.files) == 1 + + def test_no_capitals(self): + storage = self._storage_mock('dummy', '0.0.1', []) + p = Package(storage, 'Dummy', '0.0.1') + + storage.get_package_path.assert_called_with('dummy', '0.0.1') + assert p.name == 'dummy' + + def test_name(self): + storage = self._storage_mock('dummy', '0.0.1', []) + p = Package(storage, 'dummy', '0.0.1') + + assert str(p) == 'dummy-0.0.1' + + def test_comparison(self): + s1 = self._storage_mock('dummy', '0.0.1', ['a.txt']) + p1 = Package(s1, 'dummy', '0.0.1') + s2 = self._storage_mock('dummy', '0.0.2', ['b.txt']) + p2 = Package(s2, 'dummy', '0.0.2') + + assert p1 < p2 + assert not p2 < p1 + + def test_comparison_name(self): + s1 = self._storage_mock('b', '0.0.1', ['a.txt']) + p1 = Package(s1, 'b', '0.0.1') + s2 = self._storage_mock('a', '0.0.2', ['b.txt']) + p2 = Package(s2, 'a', '0.0.2') + + assert p2 < p1 + + def test_equality(self): + s1 = self._storage_mock('dummy', '0.0.1', ['a.txt']) + p1 = Package(s1, 'dummy', '0.0.1') + s2 = self._storage_mock('dummy', '0.0.1', ['b.txt']) + p2 = Package(s2, 'dummy', '0.0.1') + + assert p1 == p2 + + def test_equality_no_package(self): + s1 = self._storage_mock('dummy', '0.0.1', ['a.txt']) + p1 = Package(s1, 'dummy', '0.0.1') + + assert not p1 == 'a' + + def test_exists(self): + storage = self._storage_mock('dummy', '0.0.1', ['a.txt']) + storage.path_exists = mock.Mock(return_value=True) + p = Package(storage, 'dummy', '0.0.1') + + assert p.exists() + storage.path_exists.assert_called_with('/mybucket/packages/dummy/0.0.1') + + def test_not_exists(self): + storage = self._storage_mock('dummy', '0.0.1', ['a.txt']) + storage.path_exists = mock.Mock(return_value=False) + p = Package(storage, 'dummy', '0.0.1') + + assert not p.exists() + storage.path_exists.assert_called_with('/mybucket/packages/dummy/0.0.1') + + def test_empty(self): + storage = self._storage_mock('dummy', '0.0.1', ['a.txt']) + p1 = Package(storage, 'dummy', '0.0.1') + assert not p1.empty() + + storage = self._storage_mock('dummy', '0.0.1', []) + p2 = Package(storage, 'dummy', '0.0.1') + assert p2.empty() + + def test_getfile_not_found(self): + storage = self._storage_mock('dummy', '0.0.1', ['a.txt']) + p = Package(storage, 'dummy', '0.0.1') + with self.assertRaises(GAEPyPIError): + with p.get_file('b.txt') as f: + pass + + def test_getfile(self): + storage = self._storage_mock('dummy', '0.0.1', ['a.txt']) + p = Package(storage, 'dummy', '0.0.1') + # Now some reconfiguration of storage mock + fobj = mock.Mock() + fobj.close = mock.Mock() + storage.get_package_path = mock.Mock(return_value='/mybucket/packages/dummy/0.0.1/a.txt') + storage.read = mock.Mock(return_value=fobj) + + with p.get_file('a.txt') as f: + pass + + fobj.close.assert_called() + storage.read.assert_called_with('/mybucket/packages/dummy/0.0.1/a.txt') + storage.get_package_path.assert_called_with('dummy', '0.0.1', 'a.txt') + + def test_putfile_exists(self): + storage = self._storage_mock('dummy', '0.0.1', ['a.txt']) + p = Package(storage, 'dummy', '0.0.1') + with self.assertRaises(GAEPyPIError): + with p.put_file('a.txt', 'content') as f: + pass + + def test_putfile(self): + storage = self._storage_mock('dummy', '0.0.1', ['a.txt']) + p = Package(storage, 'dummy', '0.0.1') + storage.write = mock.Mock() + storage.get_package_path = mock.Mock(return_value='/mybucket/packages/dummy/0.0.1/b.txt') + p.put_file('b.txt', 'content') + + assert 'b.txt' in p.files + storage.get_package_path.assert_called_with('dummy', '0.0.1', 'b.txt') + storage.write.assert_called_with('/mybucket/packages/dummy/0.0.1/b.txt', 'content') \ No newline at end of file From d4d20f672f0541dab513acd6d70523d35aaba879 Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Mon, 20 Nov 2017 23:17:56 +0100 Subject: [PATCH 10/19] Inserted some docstrings and added additional interfaces --- gaepypi/_decorators.py | 3 +++ gaepypi/_handlers.py | 37 +++++++++++++++++++++++++++--- gaepypi/package.py | 29 ++++++++++++++++-------- gaepypi/renderable.py | 30 +++++++++++++++++++++++++ gaepypi/storage.py | 51 +++++++++++++++++++++++++++++++++++++++--- gaepypi/wsgi.py | 4 ++-- 6 files changed, 137 insertions(+), 17 deletions(-) create mode 100644 gaepypi/renderable.py diff --git a/gaepypi/_decorators.py b/gaepypi/_decorators.py index 1885be8..a363000 100644 --- a/gaepypi/_decorators.py +++ b/gaepypi/_decorators.py @@ -20,6 +20,9 @@ def basic_auth(func): + """ + Decorator to require HTTP auth for request handler + """ def callf(handler, *args, **kwargs): auth_header = handler.request.headers.get('Authorization') if auth_header is None: diff --git a/gaepypi/_handlers.py b/gaepypi/_handlers.py index fa17828..7b02cfc 100644 --- a/gaepypi/_handlers.py +++ b/gaepypi/_handlers.py @@ -16,6 +16,7 @@ from .storage import GCStorage from .package import Package, PackageIndex +from .exceptions import GAEPyPIError import os import webapp2 @@ -25,6 +26,9 @@ class BaseHandler(webapp2.RequestHandler): + """ + Basic handler class for our GAE webapp2 application + """ def write_page(self, body): self.response.write('{}'.format(body)) @@ -40,6 +44,9 @@ def get_storage(self): # Handlers class IndexHandler(BaseHandler): + """ + Handles / + """ @basic_auth def get(self): @@ -55,11 +62,18 @@ def post(self): filename = upload.filename if name and version and content and action == 'file_upload': - package = Package(self.get_storage(), name, version) - package.put_file(filename, content) + try: + package = Package(self.get_storage(), name, version) + package.put_file(filename, content) + except GAEPyPIError as e: + self.response.set_status(403) + self.write_page('

{0}

'.format(str(e))) class PypiHandler(BaseHandler): + """ + Handles /pypi/ + """ @basic_auth def get(self): @@ -67,6 +81,9 @@ def get(self): class PypiPackageHandler(BaseHandler): + """ + Handles /pypi/package + """ @basic_auth def get(self, package): @@ -78,7 +95,12 @@ def get(self, package): self.write_page(index.to_html(full_index=True)) -class PypiPackageVersionHandler(BaseHandler): +class PackageVersionHandler(BaseHandler): + """ + Handles + - /pypi/package/version + - /packages/package/version + """ @basic_auth def get(self, package, version): @@ -90,6 +112,9 @@ def get(self, package, version): class PackageBase(BaseHandler): + """ + Handles /packages + """ @basic_auth def get(self): @@ -102,6 +127,9 @@ def get(self): class PackageList(BaseHandler): + """ + Handles /packages/package + """ @basic_auth def get(self, package): @@ -112,6 +140,9 @@ def get(self, package): class PackageDownload(BaseHandler): + """ + Handles /packages/package/version/filename + """ @basic_auth def get(self, name, version, filename): diff --git a/gaepypi/package.py b/gaepypi/package.py index d387cc6..6db1179 100644 --- a/gaepypi/package.py +++ b/gaepypi/package.py @@ -16,6 +16,7 @@ from .exceptions import GAEPyPIError from .templates import __templates__ +from .renderable import Renderable import six from contextlib import contextmanager @@ -23,7 +24,7 @@ @six.add_metaclass(ABCMeta) -class BucketObject(object): +class BucketObject(Renderable): def __init__(self, storage, *args, **kwargs): super(BucketObject, self).__init__(*args, **kwargs) self.storage = storage @@ -31,20 +32,15 @@ def __init__(self, storage, *args, **kwargs): def enquire_storage(self, storage): return storage or self.storage - @abstractmethod - def to_html(self): - pass - @abstractmethod def exists(self): pass - @abstractmethod - def empty(self): - pass - class Package(BucketObject): + """ + Class representing a Python package (name, version and files) + """ def __init__(self, storage, name, version): super(Package, self).__init__(storage) @@ -104,9 +100,16 @@ def put_file(self, filename, content, storage=None): class PackageIndex(BucketObject, set): + """ + Class representing a package index (for a name, all versions present in storage) + """ @classmethod def get_all(cls, storage): + """ + Get all Package indices for a given storage + :return: iterable of PackageIndex + """ path = storage.get_packages_path() packages = storage.ls(path, dir_only=True) return [cls(storage, storage.split_path(package_path)['package']) for package_path in packages] @@ -137,6 +140,10 @@ def exists(self, storage=None): return storage.path_exists(package_path) def add(self, other): + """ + Add version to index + :param other: instance of Package, with matching name and distinct version. + """ assert isinstance(other, Package) if self.name != other.name: raise GAEPyPIError("Package {0} can not be added to {1} (name differs)".format(other, self)) @@ -155,6 +162,10 @@ def to_html(self, full_index=True): return template.render({'packages': self}) def get_version(self, version): + """ + Get package of specific version from the index + :return: Package object of given version + """ for p in self: if p.version == version: return p diff --git a/gaepypi/renderable.py b/gaepypi/renderable.py new file mode 100644 index 0000000..0170559 --- /dev/null +++ b/gaepypi/renderable.py @@ -0,0 +1,30 @@ +# GAEPyPi, private package index on Google App Engine +# Copyright (C) 2017 ML2Grow BVBA + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU 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 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 . + +from abc import ABCMeta, abstractmethod + +import six + + +@six.add_metaclass(ABCMeta) +class Renderable(object): + @abstractmethod + def to_html(self): + pass + + @abstractmethod + def empty(self): + pass diff --git a/gaepypi/storage.py b/gaepypi/storage.py index cee1e32..b69229b 100644 --- a/gaepypi/storage.py +++ b/gaepypi/storage.py @@ -16,6 +16,7 @@ from .package import PackageIndex from .templates import __templates__ +from .renderable import Renderable import six from abc import ABCMeta, abstractmethod @@ -29,40 +30,81 @@ @six.add_metaclass(ABCMeta) -class Storage(object): +class Storage(Renderable): + """ + Storage abstract class, describing the interface assumed by the Package/PackageIndex classes + """ @abstractmethod def get_packages_path(self): + """ + :return: (string) path to all package folders + """ pass @abstractmethod - def get_package_path(self): + def get_package_path(self, package, version=None, filename=None): + """ + Produce the package path + :param package: package name + :param version: package version + :param filename: specific file + """ pass @abstractmethod - def split_path(self): + def split_path(self, path): + """ + Break down a path into package/version/file (if present) + :param path: string + :return: dictionary with keys package, version and filename + """ pass @abstractmethod def ls(self, path, dir_only=False): + """ + list all nodes below a given path. + :param path: scan this path + :param dir_only: only include directories + :return: iterable + """ pass @abstractmethod def read(self, path): + """ + Read a specific file + :param path: path to file + :return: file object + """ pass @abstractmethod def write(self, path, content): + """ + Write content to file + """ pass @abstractmethod def file_exists(self, path): + """ + Query if a file exists + """ pass def empty(self): + """ + Verify if any packages are present in the storage + """ return len(PackageIndex.get_all(self)) == 0 def to_html(self, full_index=True): + """ + Render overview of all packages in storage + :param full_index: if true, print all files for all versions. if false, only print package names (once) + """ package_indices = PackageIndex.get_all(self) template_file = 'storage-index.html.j2' if not full_index else 'package-index.html.j2' template = __templates__.get_template(template_file) @@ -70,6 +112,9 @@ def to_html(self, full_index=True): class GCStorage(Storage): + """ + Implementation of the Storage abstract class for Google Cloud Storage + """ def __init__(self, bucket, acl='project-private'): self.bucket = bucket self.acl = acl diff --git a/gaepypi/wsgi.py b/gaepypi/wsgi.py index 86ff20f..b0a5ac1 100644 --- a/gaepypi/wsgi.py +++ b/gaepypi/wsgi.py @@ -23,9 +23,9 @@ ('/', IndexHandler), ('/pypi/', PypiHandler), ('/pypi/([^/]+)/', PypiPackageHandler), - ('/pypi/([^/]+)/([^/]+)', PypiPackageVersionHandler), + ('/pypi/([^/]+)/([^/]+)', PackageVersionHandler), ('/packages', PackageBase), ('/packages/([^/]+)', PackageList), - ('/packages/([^/]+)/([^/]+)', PypiPackageVersionHandler), + ('/packages/([^/]+)/([^/]+)', PackageVersionHandler), ('/packages/([^/]+)/([^/]+)/(.+)', PackageDownload) ], debug=True) From b02a6fc647854b8246dad3cf3e80b26ef5a38ad2 Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Mon, 20 Nov 2017 23:20:15 +0100 Subject: [PATCH 11/19] Resetting password --- config.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/config.json b/config.json index 9311a4f..6083265 100644 --- a/config.json +++ b/config.json @@ -1,8 +1,8 @@ { "accounts": [ { - "username": "ml2growdep", - "password": "454f1b5de8b016bb1ac017662505bcb3035be873" + "username": "user", + "password": "password" } ] } From a120befdab568342aa4bf547c47e857a0a8ed88b Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Mon, 20 Nov 2017 22:26:37 +0000 Subject: [PATCH 12/19] Add .gitlab-ci.yml --- .gitlab-ci.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .gitlab-ci.yml diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..9153475 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,11 @@ +image: python:2.7 + +stages: + - test + +test: + stage: test + script: + - pip install -U nox-automation + - nox + From 8101686c6c48083ec344c6505b670ae3335cd5c8 Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Mon, 20 Nov 2017 22:50:52 +0000 Subject: [PATCH 13/19] Add changelog --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2948b16 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,2 @@ +# Release 0.0.1 +Initial release of GAEPyPI \ No newline at end of file From 763294e2afd9a884b0e074a75870974b8b5aa887 Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Mon, 20 Nov 2017 23:07:06 +0000 Subject: [PATCH 14/19] Update .gitlab-ci.yml --- .gitlab-ci.yml | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 9153475..0f6f7ad 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -2,10 +2,30 @@ image: python:2.7 stages: - test + - deploy test: stage: test script: - pip install -U nox-automation - nox + +deploy_production: + stage: deploy + only: + - master + before_script: + - echo "deb http://packages.cloud.google.com/apt cloud-sdk-jessie main" | tee /etc/apt/sources.list.d/google-cloud-sdk.list + - curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add - + - apt-get update && apt-get install google-cloud-sdk + script: + - echo $DEPLOY_KEY_FILE_PRODUCTION > /tmp/$CI_PIPELINE_ID.json + - gcloud auth activate-service-account --key-file /tmp/$CI_PIPELINE_ID.json + - echo $ML2GROW_HTTP_AUTH > config.json + - cat config.json + - gcloud --quiet --project $PROJECT_ID_PRODUCTION app deploy app.yaml + after_script: + - rm /tmp/$CI_PIPELINE_ID.json + + From 0c3dd7910fcf60405060e60f2fee6a040922f7a0 Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Mon, 20 Nov 2017 23:10:47 +0000 Subject: [PATCH 15/19] Update .gitlab-ci.yml --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 0f6f7ad..b6cba60 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -17,7 +17,7 @@ deploy_production: before_script: - echo "deb http://packages.cloud.google.com/apt cloud-sdk-jessie main" | tee /etc/apt/sources.list.d/google-cloud-sdk.list - curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add - - - apt-get update && apt-get install google-cloud-sdk + - apt-get update && apt-get install -y google-cloud-sdk script: - echo $DEPLOY_KEY_FILE_PRODUCTION > /tmp/$CI_PIPELINE_ID.json - gcloud auth activate-service-account --key-file /tmp/$CI_PIPELINE_ID.json From 7eecea9d8c4ce970fdc35654265fa4b3b3a138ec Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Mon, 20 Nov 2017 23:20:58 +0000 Subject: [PATCH 16/19] Update .gitlab-ci.yml --- .gitlab-ci.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index b6cba60..c66fe6d 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -23,7 +23,8 @@ deploy_production: - gcloud auth activate-service-account --key-file /tmp/$CI_PIPELINE_ID.json - echo $ML2GROW_HTTP_AUTH > config.json - cat config.json - - gcloud --quiet --project $PROJECT_ID_PRODUCTION app deploy app.yaml + - ls + - gcloud --verbosity=info --quiet --project $PROJECT_ID_PRODUCTION app deploy app.yaml after_script: - rm /tmp/$CI_PIPELINE_ID.json From ce29b87a9f8d233a31830bd25a4a2faebcb5c53e Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Mon, 20 Nov 2017 23:27:36 +0000 Subject: [PATCH 17/19] Update .gitlab-ci.yml - Forgot to install libs! --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index c66fe6d..00533c9 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -19,11 +19,11 @@ deploy_production: - curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add - - apt-get update && apt-get install -y google-cloud-sdk script: + - pip install -U -t libs -r requirements-app.txt - echo $DEPLOY_KEY_FILE_PRODUCTION > /tmp/$CI_PIPELINE_ID.json - gcloud auth activate-service-account --key-file /tmp/$CI_PIPELINE_ID.json - echo $ML2GROW_HTTP_AUTH > config.json - cat config.json - - ls - gcloud --verbosity=info --quiet --project $PROJECT_ID_PRODUCTION app deploy app.yaml after_script: - rm /tmp/$CI_PIPELINE_ID.json From 2a7f478f7657acda9a73ac3bd934aefc3a1cb258 Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Mon, 9 Dec 2019 15:00:55 +0100 Subject: [PATCH 18/19] Reworked the library for python3 on App Engine, removed webapp2 and switched to Tornado --- app.yaml | 4 +-- gaepypi/_decorators.py | 48 ++++++++++++++++++++---------------- gaepypi/_handlers.py | 27 ++++++++++---------- gaepypi/_version.py | 2 +- gaepypi/package.py | 4 +-- gaepypi/renderable.py | 3 +-- gaepypi/storage.py | 8 +++--- gaepypi/templates.py | 8 +++--- gaepypi/wsgi.py | 41 ++++++++++++++++++++---------- nox.py | 14 ----------- noxfile.py | 11 +++++++++ requirements-app.txt | 4 ++- tests/unit/test_gcstorage.py | 1 - 13 files changed, 93 insertions(+), 82 deletions(-) delete mode 100644 nox.py create mode 100644 noxfile.py diff --git a/app.yaml b/app.yaml index 7d582c7..791a6de 100644 --- a/app.yaml +++ b/app.yaml @@ -14,7 +14,7 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -runtime: python27 +runtime: python37 api_version: 1 threadsafe: yes @@ -27,8 +27,6 @@ handlers: script: gaepypi.app libraries: -- name: webapp2 - version: latest - name: jinja2 version: latest - name: six diff --git a/gaepypi/_decorators.py b/gaepypi/_decorators.py index a363000..dc93f4a 100644 --- a/gaepypi/_decorators.py +++ b/gaepypi/_decorators.py @@ -16,39 +16,45 @@ import base64 import json -from webapp2_extras import security +from functools import wraps +from hashlib import sha1 -def basic_auth(func): - """ - Decorator to require HTTP auth for request handler - """ - def callf(handler, *args, **kwargs): +def basic_auth(f): + @wraps(f) + def new_f(*args): + handler = args[0] + auth_header = handler.request.headers.get('Authorization') if auth_header is None: - __basic_login(handler) + return __basic_login(handler) + if not auth_header.startswith('Basic '): + return __basic_login(handler) + + (username, password) = base64.b64decode(auth_header.split(' ')[1]).split(':') + + if auth(username, password): + f(*args) else: - (username, password) = base64.b64decode(auth_header.split(' ')[1]).split(':') - if __basic_lookup(username) == __basic_hash(password): - return func(handler, *args, **kwargs) - else: - __basic_login(handler) + __basic_login(handler) + + return new_f - return callf def __basic_login(handler): - handler.response.set_status(401, message="Authorization Required") - handler.response.headers['WWW-Authenticate'] = 'Basic realm="Secure Area"' + handler.set_header('WWW-Authenticate', 'Basic realm="Secure Area"') + handler.set_status(401) + handler.finish() + return False -def __basic_lookup(username): +def auth(username, password): with open('config.json') as data_file: config = json.load(data_file) - for account in config["accounts"]: - if account['username'] == username: - return account['password'] + if username in config["accounts"]: + account = config["accounts"][username] + return account["password"] == sha1(password.encode('utf-8')).hexdigest() -def __basic_hash(password): - return security.hash_password(password, method='sha1') + return False diff --git a/gaepypi/_handlers.py b/gaepypi/_handlers.py index 7b02cfc..bde03b3 100644 --- a/gaepypi/_handlers.py +++ b/gaepypi/_handlers.py @@ -19,13 +19,13 @@ from .exceptions import GAEPyPIError import os -import webapp2 +from tornado import web from cloudstorage import NotFoundError -from _decorators import basic_auth +from ._decorators import basic_auth from google.appengine.api import app_identity -class BaseHandler(webapp2.RequestHandler): +class BaseHandler(web.RequestHandler): """ Basic handler class for our GAE webapp2 application """ @@ -34,7 +34,7 @@ def write_page(self, body): self.response.write('{}'.format(body)) def write404(self): - self.response.set_status(404) + self.set_status(404) self.write_page('

Not found

') def get_storage(self): @@ -54,12 +54,11 @@ def get(self): @basic_auth def post(self): - name = self.request.get('name', default_value=None) - version = self.request.get('version', default_value=None) - action = self.request.get(':action', default_value=None) - upload = self.request.POST.getall('content')[0] - content = upload.file.read() - filename = upload.filename + name = self.get_argument('name') + version = self.get_argument('version') + action = self.get_argument(':action') + content = self.request.files['content'][0]['body'] + filename = self.request.files['content'][0]['filename'] if name and version and content and action == 'file_upload': try: @@ -144,14 +143,16 @@ class PackageDownload(BaseHandler): Handles /packages/package/version/filename """ + def prepare(self): + self.set_header("Content-Type", 'application/octet-stream') + @basic_auth def get(self, name, version, filename): try: package = Package(self.get_storage(), name, version) with package.get_file(filename) as gcs_file: - self.response.content_type = 'application/octet-stream' - self.response.headers.add('Content-Disposition', 'attachment; filename={0}'.format(filename)) - self.response.write(gcs_file.read()) + self.set_header('Content-Disposition', 'attachment; filename={0}'.format(filename)) + self.write(gcs_file.read()) except NotFoundError: self.write404() diff --git a/gaepypi/_version.py b/gaepypi/_version.py index c07f054..429aa30 100644 --- a/gaepypi/_version.py +++ b/gaepypi/_version.py @@ -14,4 +14,4 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -__version__ = '0.0.1' \ No newline at end of file +__version__ = '0.0.2' \ No newline at end of file diff --git a/gaepypi/package.py b/gaepypi/package.py index 6db1179..237805f 100644 --- a/gaepypi/package.py +++ b/gaepypi/package.py @@ -18,12 +18,10 @@ from .templates import __templates__ from .renderable import Renderable -import six from contextlib import contextmanager -from abc import ABCMeta, abstractmethod +from abc import abstractmethod -@six.add_metaclass(ABCMeta) class BucketObject(Renderable): def __init__(self, storage, *args, **kwargs): super(BucketObject, self).__init__(*args, **kwargs) diff --git a/gaepypi/renderable.py b/gaepypi/renderable.py index 0170559..f69e262 100644 --- a/gaepypi/renderable.py +++ b/gaepypi/renderable.py @@ -14,8 +14,7 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -from abc import ABCMeta, abstractmethod - +from abc import abstractmethod, ABCMeta import six diff --git a/gaepypi/storage.py b/gaepypi/storage.py index b69229b..0b49df4 100644 --- a/gaepypi/storage.py +++ b/gaepypi/storage.py @@ -18,8 +18,7 @@ from .templates import __templates__ from .renderable import Renderable -import six -from abc import ABCMeta, abstractmethod +from abc import abstractmethod import cloudstorage as gcs my_default_retry_params = gcs.RetryParams(initial_delay=0.2, @@ -29,7 +28,6 @@ gcs.set_default_retry_params(my_default_retry_params) -@six.add_metaclass(ABCMeta) class Storage(Renderable): """ Storage abstract class, describing the interface assumed by the Package/PackageIndex classes @@ -107,8 +105,8 @@ def to_html(self, full_index=True): """ package_indices = PackageIndex.get_all(self) template_file = 'storage-index.html.j2' if not full_index else 'package-index.html.j2' - template = __templates__.get_template(template_file) - return template.render({'indices': package_indices}) + template = __templates__.load(template_file) + return template.generate({'indices': package_indices}) class GCStorage(Storage): diff --git a/gaepypi/templates.py b/gaepypi/templates.py index a4db636..3793523 100644 --- a/gaepypi/templates.py +++ b/gaepypi/templates.py @@ -15,9 +15,7 @@ # along with this program. If not, see . import os -import jinja2 +from tornado import template -__templates__ = jinja2.Environment(loader=jinja2.FileSystemLoader( - os.path.join(os.path.dirname(__file__), 'templates')), - extensions=['jinja2.ext.autoescape'], - autoescape=True) \ No newline at end of file + +__templates__ = template.Loader(os.path.join(os.path.dirname(__file__), 'templates')) diff --git a/gaepypi/wsgi.py b/gaepypi/wsgi.py index b0a5ac1..6640d15 100644 --- a/gaepypi/wsgi.py +++ b/gaepypi/wsgi.py @@ -16,16 +16,31 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -import webapp2 -from _handlers import * - -app = webapp2.WSGIApplication([ - ('/', IndexHandler), - ('/pypi/', PypiHandler), - ('/pypi/([^/]+)/', PypiPackageHandler), - ('/pypi/([^/]+)/([^/]+)', PackageVersionHandler), - ('/packages', PackageBase), - ('/packages/([^/]+)', PackageList), - ('/packages/([^/]+)/([^/]+)', PackageVersionHandler), - ('/packages/([^/]+)/([^/]+)/(.+)', PackageDownload) -], debug=True) +import os +from tornado import web +from tornado import wsgi +from ._handlers import * +from .templates import __templates__ + + +settings = { + 'template_loader': __templates__ +} + + +class Application(web.Application): + def __init__(self): + routes = [ + ('/', IndexHandler), + ('/pypi/', PypiHandler), + ('/pypi/([^/]+)/', PypiPackageHandler), + ('/pypi/([^/]+)/([^/]+)', PackageVersionHandler), + ('/packages', PackageBase), + ('/packages/([^/]+)', PackageList), + ('/packages/([^/]+)/([^/]+)', PackageVersionHandler), + ('/packages/([^/]+)/([^/]+)/(.+)', PackageDownload) + ] + super(Application, self).__init__(routes, **settings) + + +app = wsgi.WSGIAdapter(Application()) \ No newline at end of file diff --git a/nox.py b/nox.py deleted file mode 100644 index 98f2ca7..0000000 --- a/nox.py +++ /dev/null @@ -1,14 +0,0 @@ -import nox - - -@nox.session -@nox.parametrize('python_version', ['2.7']) -def default(session, python_version): - session.interpreter = 'python' + python_version - session.install('mock', 'pytest', 'gae_installer', 'pyaml', 'webob', 'GoogleAppEngineCloudStorageClient', 'jinja2', - 'webapp2', 'six') - - session.run( - 'pytest', - 'tests/unit' - ) \ No newline at end of file diff --git a/noxfile.py b/noxfile.py new file mode 100644 index 0000000..23e46b6 --- /dev/null +++ b/noxfile.py @@ -0,0 +1,11 @@ +import nox + + +@nox.session(python="2.7") +def default(session): + session.install('mock', 'pytest', 'gae_installer', 'pyaml', 'webob', 'GoogleAppEngineCloudStorageClient', 'tornado', 'six') + + session.run( + 'pytest', + 'tests/unit' + ) \ No newline at end of file diff --git a/requirements-app.txt b/requirements-app.txt index 6e247aa..86e145a 100644 --- a/requirements-app.txt +++ b/requirements-app.txt @@ -1 +1,3 @@ -GoogleAppEngineCloudStorageClient==1.9.22.1 \ No newline at end of file +GoogleAppEngineCloudStorageClient==1.9.22.1 +tornado==6.0.3 +six \ No newline at end of file diff --git a/tests/unit/test_gcstorage.py b/tests/unit/test_gcstorage.py index 64d927f..06df3d9 100644 --- a/tests/unit/test_gcstorage.py +++ b/tests/unit/test_gcstorage.py @@ -19,7 +19,6 @@ def tearDown(self): def test_packages_path(self): assert self.s.get_packages_path() == '/mybucket/packages' - def test_package_path(self): assert self.s.get_package_path('dummy') == '/mybucket/packages/dummy' assert self.s.get_package_path('dummy', '0.0.1') == '/mybucket/packages/dummy/0.0.1' From 5b727b292ed44b45dc4bd0b47175ddbdb773686c Mon Sep 17 00:00:00 2001 From: Joachim van der Herten Date: Mon, 9 Dec 2019 16:46:02 +0100 Subject: [PATCH 19/19] Fixing tests (Im guessing these are broken in master as well) --- tests/unit/test_gcstorage.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/tests/unit/test_gcstorage.py b/tests/unit/test_gcstorage.py index 06df3d9..50ba2c7 100644 --- a/tests/unit/test_gcstorage.py +++ b/tests/unit/test_gcstorage.py @@ -37,15 +37,16 @@ def test_split_path(self): def test_file_exists(self, mock): m = Mock() type(m).is_dir = PropertyMock(return_value=False) + type(m).filename = PropertyMock(return_value='/mybucket/file.txt') mock.return_value = [m] assert self.s.file_exists('/mybucket/file.txt') - mock.assert_called_with('/mybucket/file.txt', delimiter='/') + mock.assert_called_with('/mybucket/file.txt') @patch('gaepypi.storage.gcs.listbucket') def test_file_not_exists(self, mock): mock.return_value = [] assert not self.s.file_exists('/mybucket/file.txt') - mock.assert_called_with('/mybucket/file.txt', delimiter='/') + mock.assert_called_with('/mybucket/file.txt') @patch('gaepypi.storage.gcs.listbucket') def test_file_is_dir(self, mock): @@ -53,12 +54,13 @@ def test_file_is_dir(self, mock): type(m).is_dir = PropertyMock(return_value=True) mock.return_value = [m] assert not self.s.file_exists('/mybucket/file') - mock.assert_called_with('/mybucket/file', delimiter='/') + mock.assert_called_with('/mybucket/file') @patch('gaepypi.storage.gcs.listbucket') def test_path_is_dir(self, mock): m = Mock() type(m).is_dir = PropertyMock(return_value=True) + type(m).filename = PropertyMock(return_value='/mybucket/file') mock.return_value = [m] assert self.s.path_exists('/mybucket/file') mock.assert_called_with('/mybucket/file', delimiter='/') @@ -67,6 +69,7 @@ def test_path_is_dir(self, mock): def test_path_exists(self, mock): m = Mock() type(m).is_dir = PropertyMock(return_value=False) + type(m).filename = PropertyMock(return_value='/mybucket/file.txt') mock.return_value = [m] assert self.s.path_exists('/mybucket/file.txt') mock.assert_called_with('/mybucket/file.txt', delimiter='/')