annotate test/test_init.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 198b6e810c67
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5037
diff changeset
1 #-*- encoding: utf-8 -*-
4816
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
2
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
3 import unittest, os, pprint, difflib, textwrap
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
4
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
5 from roundup.init import loadTemplateInfo
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
6
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
7
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
8 class TemplateInfoTestCase(unittest.TestCase):
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
9 def testLoadTemplateInfo(self):
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
10 path = os.path.join(os.path.dirname(__file__),
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
11 '../share/roundup/templates/classic')
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
12 self.maxDiff = None
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
13 self.assertEqual(
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
14 loadTemplateInfo(path),
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
15 {
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
16 'description': textwrap.dedent('''\
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
17 This is a generic issue tracker that may be used to track bugs,
4818
edb171528a7d init.loadTemplateInfo: replace rfc822 with email.parser (Python 3 compatible)
anatoly techtonik <techtonik@gmail.com>
parents: 4816
diff changeset
18 feature requests, project issues or any number of other types
edb171528a7d init.loadTemplateInfo: replace rfc822 with email.parser (Python 3 compatible)
anatoly techtonik <techtonik@gmail.com>
parents: 4816
diff changeset
19 of issues. Most users of Roundup will find that this template
edb171528a7d init.loadTemplateInfo: replace rfc822 with email.parser (Python 3 compatible)
anatoly techtonik <techtonik@gmail.com>
parents: 4816
diff changeset
20 suits them, with perhaps a few customisations.'''),
4816
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
21 'intended-for': 'All first-time Roundup users',
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
22 'name': 'classic',
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
23 'path': path
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
24 }
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
25 )
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
26
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
27 # vim: set et sts=4 sw=4 :

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