annotate scripts/copy-user.py @ 5639:f576957cbb1f

Add support for prev/next/self links when returning paginated results. To do this: 1) change "data" envelope from an array to a dict 2) move the "data" array to the "collection" property, which is an array of elements in the collection. 3) add @links dict keyed by link relation: self, next, prev. Each relation is an array of dicts with uri and rel keys. In this case there is only one element, but there is nothing preventing a relation from having multiple url's. So this follows the formatting needed for the general case. Relations are present only if it makes sense. So first page has no prev and last page has no next. 4) add @total_size with number of element selected if they were not paginated. Replicates data in X-Count-Total header. Changed index to start at 1. So the first page is page_index 1 and not page_index 0. (So I am no longer surprised when I set page_index to 1 and am missing a bunch of records 8-)). Also a small fixup, json response ends with a newline so printing the data, or using curl makes sure that anything printing after the json output (like shell prompts) is on a new line. Tests added for all cases.
author John Rouillard <rouilj@ieee.org>
date Sat, 09 Mar 2019 11:06:10 -0500
parents 64b05e24dbd8
children 2a6c3eb4e059
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1943
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 #!/usr/bin/env python
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 # Copyright (C) 2003 by Intevation GmbH
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 # Author:
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4 # Thomas Arendsen Hein <thomas@intevation.de>
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 #
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6 # This program is free software dual licensed under the GPL (>=v2)
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 # and the Roundup Licensing (see COPYING.txt in the roundup distribution).
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9 """
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10 copy-user <instance-home> <instance-home> <userid> [<userid>...]
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12 Copy one or more Roundup users from one tracker instance to another.
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13 Example:
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 copy-user /roundup/tracker1 /roundup/tracker2 `seq 3 10` 14 16
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15 (copies users 3, 4, 5, 6, 7, 8, 9, 10, 14 and 16)
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16 """
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5248
diff changeset
18 from __future__ import print_function
1943
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19 import sys
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20 import roundup.instance
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23 def copy_user(home1, home2, *userids):
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24 """Copy users which are listed by userids from home1 to home2"""
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26 copyattribs = ['username', 'password', 'address', 'realname', 'phone',
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27 'organisation', 'alternate_addresses', 'roles', 'timezone']
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29 try:
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30 instance1 = roundup.instance.open(home1)
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5248
diff changeset
31 print("Opened source instance: %s" % home1)
1943
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32 except:
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5248
diff changeset
33 print("Can't open source instance: %s" % home1)
1943
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34 sys.exit(1)
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36 try:
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37 instance2 = roundup.instance.open(home2)
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5248
diff changeset
38 print("Opened target instance: %s" % home2)
1943
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39 except:
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5248
diff changeset
40 print("Can't open target instance: %s" % home2)
1943
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
41 sys.exit(1)
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43 db1 = instance1.open('admin')
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 db2 = instance2.open('admin')
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45
4781
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4570
diff changeset
46 db1.tx_Source = "cli"
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4570
diff changeset
47 db2.tx_Source = "cli"
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4570
diff changeset
48
1943
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49 userlist = db1.user.list()
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50 for userid in userids:
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
51 try:
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52 userid = str(int(userid))
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 4781
diff changeset
53 except ValueError as why:
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5248
diff changeset
54 print("Not a numeric user id: %s Skipping ..." % (userid,))
1943
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
55 continue
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
56 if userid not in userlist:
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5248
diff changeset
57 print("User %s not in source instance. Skipping ..." % userid)
1943
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
58 continue
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
59
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60 user = {}
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
61 for attrib in copyattribs:
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
62 value = db1.user.get(userid, attrib)
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
63 if value:
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
64 user[attrib] = value
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
65 try:
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
66 db2.user.lookup(user['username'])
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5248
diff changeset
67 print("User %s: Username '%s' exists in target instance. Skipping ..." % (userid, user['username']))
1943
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
68 continue
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 4781
diff changeset
69 except KeyError as why:
1943
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
70 pass
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5248
diff changeset
71 print("Copying user %s (%s) ..." % (userid, user['username']))
1943
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
72 db2.user.create(**user)
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
73
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
74 db2.commit()
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
75 db2.close()
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5248
diff changeset
76 print("Closed target instance.")
1943
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
77 db1.close()
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5248
diff changeset
78 print("Closed source instance.")
1943
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
79
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
80
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
81 if __name__ == "__main__":
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
82 if len(sys.argv) < 4:
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5248
diff changeset
83 print(__doc__)
1943
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
84 sys.exit(1)
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
85 else:
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
86 copy_user(*sys.argv[1:])
bd9e2e998e9d added contributed script for copying users between trackers
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
87

Roundup Issue Tracker: http://roundup-tracker.org/