sitescripts/testpages/README.md - Issue 29328589: Issue 3122 - Add testpages.web.sitekey_frame URL handler

Side by Side Diff

Use n/p to move between diff chunks; N/P to move between comments.

Keyboard Shortcuts

	File
u :	up to issue
m :	publish + mail comments
M :	edit review message
j / k :	jump to file after / before current file
J / K :	jump to next file with a comment after / before current file
	Side-by-side diff
i :	toggle intra-line diffs
e :	expand all comments
c :	collapse all comments
s :	toggle showing all comments
n / p :	next / previous diff chunk or comment
N / P :	next / previous comment
<Up> / <Down> :	next / previous line
<Enter> :	respond to / edit current comment
d :	mark current comment as done

	Issue
u :	up to list of issues
m :	publish + mail comments
j / k :	jump to patch after / before current patch
o / <Enter> :	open current patch in side-by-side view
i :	open current patch in unified diff view

	Issue List
j / k :	jump to issue after / before current issue
o / <Enter> :	open current issue
# :	close issue

	Comment/message editing
<Ctrl> + s or <Ctrl> + Enter :	save comment
<Esc> :	cancel edit

Side by Side Diff: sitescripts/testpages/README.md

Issue 29328589: Issue 3122 - Add testpages.web.sitekey_frame URL handler (Closed)

Patch Set: Further improvements Created Oct. 8, 2015, noon

Left:
Right:

Use n/p to move between diff chunks; N/P to move between comments.

Jump to:

OLD	NEW
(Empty)
	1 # sitescripts.testpages

	2

	3 ## Introduction

	4

	5 This package contains all the dynamic URL handlers required for the otherwise

	6 static testpages.adblockplus.org project. This allows us to create test cases

	7 for things like sitekeys which require web responses to be generated

	8 dynamically.

	9

	10

	11 ## sitescripts.testpages.web.sitekey_frame

	12

	13 For test cases that test the $sitekey filter option you can use the make use of

	14 the `/sitekey-frame` URL handler. The handler renders a template of your

	15 choosing, passing in the public key and signature variables. For this you will

	16 need to have a suitable RSA key file, a Jinja2 template that makes use of the

	17 `public_key` + `signature` variables and a suitable `sitescripts.ini`

	18 configuration.

	19

	20 Here's an example configuration:

	21

	22 ```

	23 [multiplexer]

	24 sitescripts.testpages.web.sitekey_frame =

	25

	26 [testpages]

	27 sitekeyFrameTemplate=%(root)s/testpages.adblockplus.org/templates/sitekey_frame. tmpl

	28 sitekeyPath=%(root)s/testpages.adblockplus.org/static/site.key

	29 ```

	30

	31 The handler automatically sets the correct `X-Adblock-Key` response header but

	32 it's important that the template also populates the `data-adblockkey` attribute

	33 of the html element with the public key and signature. For example:

	34

	35 <html data-adblockkey="{{ public_key + "_" + signature }}">

OLD	NEW