Mercurial > p > roundup > code
view roundup/demo.py @ 5525:bb7865241f8a
Make CSV import/export compatible across Python versions (also RDBMS journals) (issue 2550976, issue 2550975).
The roundup-admin export and import commands are used for migrating
between different database backends. It is desirable that they should
be usable also for migrations between Python 2 and Python 3, and in
some cases (e.g. with the anydbm backend) this may be required.
To be usable for such migrations, the format of the generated CSV
files needs to be stable, meaning the same as currently used with
Python 2. The export process uses repr() to produce the fields in the
CSV files and eval() to convert them back to Python data structures.
repr() of strings with non-ASCII characters produces different results
for Python 2 and Python 3.
This patch adds repr_export and eval_import functions to
roundup/anypy/strings.py which provide the required operations that
are just repr() and eval() in Python 2, but are more complicated in
Python 3 to use data representations compatible with Python 2. These
functions are then used in the required places for export and import.
repr() and eval() are also used in storing the dict of changed values
in the journal for the RDBMS backends. It is similarly desirable that
the database be compatible between Python 2 and Python 3, so that
export and import do not need to be used for a migration between
Python versions for non-anydbm back ends. Thus, this patch changes
rdbms_common.py in the places involved in storing journals in the
database, not just in those involved in import/export.
Given this patch, import/export with non-ASCII characters appear based
on some limited testing to work across Python versions, and an
instance using the sqlite backend appears to be compatible between
Python versions without needing import/export, *if* the sessions/otks
databases (which use anydbm) are deleted when changing Python version.
| author | Joseph Myers <jsm@polyomino.org.uk> |
|---|---|
| date | Sun, 02 Sep 2018 23:48:04 +0000 |
| parents | 7f00a47b3559 |
| children | d8d046749b5b |
line wrap: on
line source
#!/usr/bin/env python # # Copyright (c) 2003 Richard Jones (richard@mechanicalcat.net) # from __future__ import print_function import errno import os import shutil import socket import sys import getopt try: import urlparse except ImportError: import urllib.parse as urlparse from roundup import configuration from roundup.scripts import roundup_server # Path where demo instance files will be stored TRACKER_HOME = os.path.abspath('demo') def install_demo(home, backend, template): """Install a demo tracker Parameters: home: tracker home directory path backend: database backend name template: tracker template """ from roundup import init, instance, password, backends # set up the config for this tracker config = configuration.CoreConfig() config['TRACKER_HOME'] = home config['MAIL_DOMAIN'] = 'localhost' config['DATABASE'] = 'db' config['WEB_DEBUG'] = True if backend in ('mysql', 'postgresql'): config['RDBMS_HOST'] = 'localhost' config['RDBMS_USER'] = 'rounduptest' config['RDBMS_PASSWORD'] = 'rounduptest' config['RDBMS_NAME'] = 'rounduptest' config['RDBMS_BACKEND'] = backend # see if we need to clean up existing directory if os.path.exists(home): if os.path.exists(home + '/config.ini'): # clear everything out to avoid conflicts with former # extensions and detectors print("Nuking directory left from the previous demo instance.") shutil.rmtree(home) else: print("Error: Refusing to nuke non-tracker directory:") print(" %s" % home) sys.exit(1) template_dir = os.path.join('share', 'roundup', 'templates', template) init.install(home, template_dir) # don't have email flying around nosyreaction = os.path.join(home, 'detectors', 'nosyreaction.py') if os.path.exists(nosyreaction): os.remove(nosyreaction) nosyreaction += 'c' if os.path.exists(nosyreaction): os.remove(nosyreaction) # figure basic params for server hostname = 'localhost' # pick a fairly odd, random port port = 8917 while 1: print('Trying to set up web server on port %d ...'%port,) s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) try: s.connect((hostname, port)) except socket.error as e: if not hasattr(e, 'args') or e.args[0] != errno.ECONNREFUSED: raise print('should be ok.') break else: s.close() print('already in use.') port += 100 config['TRACKER_WEB'] = 'http://%s:%s/demo/'%(hostname, port) # write the config config['INSTANT_REGISTRATION'] = 1 # FIXME: Move template-specific demo initialization into the templates. if template == 'responsive': config['STATIC_FILES'] = "static" if template == 'jinja2': config['TEMPLATE_ENGINE'] = 'jinja2' config['STATIC_FILES'] = "static" config.save(os.path.join(home, config.INI_FILE)) # open the tracker and initialise tracker = instance.open(home) tracker.init(password.Password('admin')) # add the "demo" user db = tracker.open('admin') # FIXME: Move tracker-specific demo initialization into the tracker templates. if template == 'minimal': db.user.create(username='demo', password=password.Password('demo'), roles='User') else: db.user.create(username='demo', password=password.Password('demo'), realname='Demo User', roles='User') db.commit() db.close() def run_demo(home): """Run the demo tracker instance from its ``home`` directory""" print("Demo Tracker Home:", home) cfg = configuration.CoreConfig(home) url = cfg["TRACKER_WEB"] hostname, port = urlparse.urlparse(url)[1].split(':') port = int(port) success_message = '''Server running - connect to: %(url)s 1. Log in as "demo"/"demo" or "admin"/"admin". 2. Hit Control-C to stop the server. 3. Re-start the server by running "%(script)s" again. 4. Reset the tracker by running "%(script)s nuke". By default the demo tracker is set up to be accessed from "localhost". If you want to run it on a server, edit "%(datadir)s/config.ini" and set the "web" option in section "[tracker]" to your host name, then restart demo. If you want to change backend types, you must use "nuke". ''' % dict(url=url, script=sys.argv[0], datadir=TRACKER_HOME) # disable command line processing in roundup_server sys.argv = sys.argv[:1] + ['-p', str(port), '-n', hostname, 'demo=' + home] roundup_server.run(success_message=success_message) def usage(msg = ''): if msg: print(msg) print("""\ Usage: %(script)s [options] [nuke] Run a demo server. Config and database files are created in %(datadir)s subdirectory of %(script)s dir. 'nuke' will re-initialize the demo instance, deleting the old data. See docs/installation "For The Really Impatient" for more details. Options: -h -- print this help message -t template -- specify the tracker template to use -b backend -- specify the database backend to use """ % dict(script=sys.argv[0], datadir=TRACKER_HOME+os.sep)) def main(): """Run a demo server for users to play with for instant gratification. Sets up the web service on localhost. Disables nosy lists. """ try: opts, args = getopt.getopt(sys.argv[1:], 't:b:h') except getopt.GetoptError as e: usage(str(e)) return 1 for opt, arg in opts: if opt == '-h': usage() return 0 home = os.path.abspath(TRACKER_HOME) nuke = args and args[0] == 'nuke' if not os.path.exists(home) or nuke: backend = 'anydbm' template = 'classic' for opt, arg in opts: if opt == '-t': template = arg elif opt == '-b': backend = arg if (len(args) > 1 or (len(args) == 1 and args[0] != 'nuke')): usage() return 1 print("Initializing demo instance in:\n %s" % home) install_demo(home, backend, template) elif opts: print("Error: Arguments are not allowed when running an existing demo.") print(" Use the 'nuke' command to start over.") sys.exit(1) run_demo(home) if __name__ == '__main__': sys.exit(main()) # vim: set filetype=python sts=4 sw=4 et si :
