","
"];c.fn.extend({text:function(a){if(c.isFunction(a))return this.each(function(b){var d=
-c(this);d.text(a.call(this,b,d.text()))});if(typeof a!=="object"&&a!==w)return this.empty().append((this[0]&&this[0].ownerDocument||s).createTextNode(a));return c.text(this)},wrapAll:function(a){if(c.isFunction(a))return this.each(function(d){c(this).wrapAll(a.call(this,d))});if(this[0]){var b=c(a,this[0].ownerDocument).eq(0).clone(true);this[0].parentNode&&b.insertBefore(this[0]);b.map(function(){for(var d=this;d.firstChild&&d.firstChild.nodeType===1;)d=d.firstChild;return d}).append(this)}return this},
-wrapInner:function(a){if(c.isFunction(a))return this.each(function(b){c(this).wrapInner(a.call(this,b))});return this.each(function(){var b=c(this),d=b.contents();d.length?d.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){c(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){c.nodeName(this,"body")||c(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.appendChild(a)})},
-prepend:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,this)});else if(arguments.length){var a=c(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,
-this.nextSibling)});else if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,c(arguments[0]).toArray());return a}},remove:function(a,b){for(var d=0,f;(f=this[d])!=null;d++)if(!a||c.filter(a,[f]).length){if(!b&&f.nodeType===1){c.cleanData(f.getElementsByTagName("*"));c.cleanData([f])}f.parentNode&&f.parentNode.removeChild(f)}return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++)for(b.nodeType===1&&c.cleanData(b.getElementsByTagName("*"));b.firstChild;)b.removeChild(b.firstChild);
-return this},clone:function(a){var b=this.map(function(){if(!c.support.noCloneEvent&&!c.isXMLDoc(this)){var d=this.outerHTML,f=this.ownerDocument;if(!d){d=f.createElement("div");d.appendChild(this.cloneNode(true));d=d.innerHTML}return c.clean([d.replace(Ja,"").replace(/=([^="'>\s]+\/)>/g,'="$1">').replace(V,"")],f)[0]}else return this.cloneNode(true)});if(a===true){ra(this,b);ra(this.find("*"),b.find("*"))}return b},html:function(a){if(a===w)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(Ja,
-""):null;else if(typeof a==="string"&&!ta.test(a)&&(c.support.leadingWhitespace||!V.test(a))&&!F[(La.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(Ka,Ma);try{for(var b=0,d=this.length;b' + _('Searching') + '
').appendTo(this.out); - this.dots = $('').appendTo(this.title); - this.status = $('').appendTo(this.out); - this.output = $('\
- \
-
\
- ';
-
- var replyTemplate = '\
- \
-
\
- \
- \ - <%username%>\ - \ - <%time.delta%>\ -
\ -<#text#>
\
- \ - \ - reply ▿\ - proposal ▹\ - \ - \ - \ -
\ -\ -<#proposal_diff#>\ -\ -
-
-
-
-
-
\ No newline at end of file
diff --git a/src/postorius/doc/_build/html/development.html b/src/postorius/doc/_build/html/development.html
deleted file mode 100644
index c1e8131..0000000
--- a/src/postorius/doc/_build/html/development.html
+++ /dev/null
@@ -1,362 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Acknowledgements¶
-
-
-Test Server¶
-We’re proud to provide you a development server which is sponsered by XXX #Todo -Feel free to change anything you like, we can simply rest the DB from Time to Time.
-
-
-Missing Functionality¶
--
-
-
-
- Delete Domain -
-
-
- missing in REST -
- implemented in mailman3 a8 -
-
-Show a List of all subscribed users
-
-
-
-ACL¶
--
-
Middleware
--
-We don’t have the Middleware which is required to work with users and it’s permissions yet. For this reason we had to tweak some functions to be a hardcoded Demo object.
--
-
-
-
- Login Check -
At the moment we’re using a hardcoded List of allowed usernames and Passwords which are all stored in Plain within the AuthBackends Source File.
-
-
--
-
- has_perm Decorator -
As we don’t have a middleware to check for users and it’s permissions we do only use one permission at the moment. The permission site domain_admin is hardcoded to user.username == “james@example.com“
-
-
-
-
-
-Ideas¶
--
-
- ContactPage - -
-
-
-
-
-
\ No newline at end of file
diff --git a/src/postorius/doc/_build/html/genindex.html b/src/postorius/doc/_build/html/genindex.html
deleted file mode 100644
index cf95631..0000000
--- a/src/postorius/doc/_build/html/genindex.html
+++ /dev/null
@@ -1,123 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Development¶
-This is a short guide to help you get started with Postorius development.
-
-
-
-Directory layout¶
-Postorius is a Django application, so if you have developed with Django before, -the file structure probably looks familiar. These are the basics:
-__init__.py
-auth/ # Custom authorization code (List owners and
- # moderators)
-context_processors.py # Some variables available in all templates
-doc/ # Sphinx documentation
-fieldset_forms.py # A custom form class to build html forms with
- # fieldsets
-forms.py # All kinds of classes to build and validate forms
-management/ # Commands to use with Django's manage.py script
-models.py # Code to connect to mailman.client and provide
- # a Django-style model API for lists, mm-users and
- # domains
-static/ # Static files (CSS, JS, images)
-templates/ # HTML Templates
-tests/ # Postorius test files
-urls.py # URL routes
-utils.py # Some handy utilities
-views/
- views.py # View classes and functions for all views connected
- # in urls.py
- generic.py # Generic class-based views; Currently holds a
- # class for views based on a single mailing list
-
-
-Development Workflow¶
-The source code is hosted on Launchpad, which also means that we are using -Bazaar for version control.
-Changes are usually not made directly in the project’s trunk branch, but in -feature-related personal branches, which get reviewed and then merged into -the trunk.
-The ideal workflow would be like this:
--
-
- File a bug to suggest a new feature or report a bug (or just pick one of -the existing bugs). -
- Create a new branch with your code changes. -
- Make a “merge proposal” to get your code reviewed and merged. -
Launchpad has a nice tour which describes all this in detail.
-
-
-Writing View Code¶
-When the work on Postorius was started, the standard way to write view code in -Django was to write a single function for each different view. Since then -Django has introduced so-called ‘class-based views’ which make it much easier -to reuse view functionality. While using simple functions is not discuraged, it -makes sense to check if using a class-based approach could make sense.
-Check Postorius’ views/views.py and views/generic.py for examples!
-
-
-
-
-
-
-Authentication/Authorization¶
-Three of Django’s default User roles are relvant for Postorius:
--
-
- Superuser: Can do everything. -
- AnonymousUser: Can view list index and info pages. -
- Authenticated users: Can view list index and info pages. Can (un)subscribe -from lists. -
Apart from these default roles, there are two others relevant in Postorius:
--
-
- List owners: Can change list settings, moderate messages and delete their -lists. -
- List moderators: Can moderate messages. -
There are a number of decorators to protect views from unauthorized users.
--
-
- @user_passes_test(lambda u: u.is_superuser) (redirects to login form) -
- @login_required (redirects to login form) -
- @list_owner_required (returns 403) -
- @list_moderator_required (returns 403) -
- @superuser_or_403 (returns 403) -
- @loggedin_or_403 (returns 403) -
- @basic_auth_login -
Check out views/views.py or views/api.py for examples!
-The last one (basic_auth_login) checks the request header for HTTP Basic Auth -credentials and uses those to authenticate against Django’s session-based -mechanism. It can be used in cases where a view is accessed from other clients -than the web browser.
-Please make sure to put it outside the other auth decorators.
-Good:
-@basic_auth_login
-@list_owner_required
-def my_view_func(request):
- ...
-Won’t work, because list_owner_required will not recognize the user:
-@list_owner_required
-@basic_auth_login
-def my_view_func(request):
- ...
-
-
-
-Accessing the Mailman API¶
-Postorius uses mailman.client to connect to Mailman’s REST API. In order to -directly use the client, cd to your project folder and execute -python manage.py mmclient. This will open a python shell (IPython, if -that’s available) and provide you with a client object connected to to your -local Mailman API server (it uses the credentials from your settings.py).
-A quick example:
-$ python manage.py mmclient
-
->>> client
-<Client (user:pwd) http://localhost:8001/3.0/>
-
->>> print client.system['mailman_version']
-GNU Mailman 3.0.0b2+ (Here Again)
-
->>> mailman_dev = client.get_list('mailman-developers@python.org')
->>> print mailman_dev settings
-{u'owner_address': u'mailman-developers@python.org',
- u'default_nonmember_action': u'hold', ...}
-For detailed information how to use mailman.client, check out its documentation.
-
-
-
-
-Testing¶
-Currently only some of the Postorius code is covered by a test. We should change that!
-All test modules reside in the postorius/src/postorius/tests directory -and this is where you should put your own tests, too. To make the django test -runner find your tests, make sure to add them to the folder’s __init__.py:
-from postorius.tests import test_utils
-from postorius.tests.test_list_members import ListMembersViewTest
-from postorius.tests.test_list_settings import ListSettingsViewTest
-from postorius.tests.my_own_tests import MyOwnUnitTest
-
-__test__ = {
- "Test Utils": test_utils,
- "List Members": ListMembersViewTest,
- "List Settings": ListSettingsViewTest,
- "My Own Test": MyOwnUnitTest,
-}
-
-
-Running the tests¶
-To run the tests go to your project folder and run python manage.py test -postorius from there.
-
-
-Testing mailman.client results¶
-Most of Postorius’ code involves some results from calls to the mailman.client -library. mailman.client is itself covered by tests, so Postorius’ own tests -don’t need to check if mailman.client returns correct results. Instead we can -just mock them! This has the big advantage that you can run the test suite -without having to worry about the state of the local Mailman database. It also -makes the tests run faster, because we spare ourselves the HTTP calls to the -local Mailman REST API.
-This approach has the obvious downside that the Postorius tests will not -recognize any changes to the Mailman API. So at some point there should be some -separate integration tests to test the whole chain. But let’s not worry about -that for now.
-
-
-Mocking mailman.client objects¶
-Postorius uses Michael Foord’s mock library for mocking. There are some -shortcuts you can use to quickly create mock objects that behave a little bit -like objects retreived from mailman.client, like:
--
-
- create_mock_domain -
- create_mock_list -
- create_mock_member -
These create_mock_* functions are very simple tools that return MagigMock objects with the properties passed to them in a dictionary. They also set some defaults for properties that you didn’t pass to its create_mock_* function. For instance, a mock list created with create_mock_list() will always have members, moderators and owners properties.
-
-
-
-
-Domains¶
-postorius.tests.utils.create_mock_domain creates a mock domain object:
->>> properties = dict(contact_address='postmaster@example.org',
-... description='Example dot Org',
-... mail_host='example.org',
-... url_host='www.example.org')
->>> mock_domain = create_mock_domain(properties)
->>> print mock_domain
-<MagicMock name='Domain' id='...'>
->>> print mock_domain.contact_address
-postmaster@example.org
->>> print mock_domain.description
-Example dot Org
->>> print mock_domain.mail_host
-example.org
->>> print mock_domain.url_host
-www.example.org
-
-
-
-
-Mailing Lists¶
-postorius.tests.utils.create_mock_list creates a mock list object:
->>> properties = dict(fqdn_listname='testlist@example.org',
-... mail_host='example.org',
-... list_name='testlist',
-... display_name='Test List')
->>> mock_list = create_mock_list(properties)
->>> print mock_list
-<MagicMock name='List' id='...'>
->>> print mock_list.fqdn_listname
-testlist@example.org
->>> print mock_list.mail_host
-example.org
->>> print mock_list.list_name
-testlist
->>> print mock_list.display_name
-Test List
-
-
-
-
-Memberships¶
-postorius.tests.utils.create_mock_list creates a mock list object:
->>> properties = dict(fqdn_listname='testlist@example.org',
-... address='les@example.org',)
->>> mock_member = create_mock_member(properties)
->>> print mock_member
-<MagicMock name='Member' id='...'>
->>> print mock_member.fqdn_listname
-testlist@example.org
->>> print mock_member.address
-les@example.org
-
-
-
-
-
-
\ No newline at end of file
diff --git a/src/postorius/doc/_build/html/index.html b/src/postorius/doc/_build/html/index.html
deleted file mode 100644
index aa21bde..0000000
--- a/src/postorius/doc/_build/html/index.html
+++ /dev/null
@@ -1,116 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Index
- - -P
-
|
-
T
-
|
-
-
-
-
-
-
\ No newline at end of file
diff --git a/src/postorius/doc/_build/html/license.html b/src/postorius/doc/_build/html/license.html
deleted file mode 100644
index d78b9b5..0000000
--- a/src/postorius/doc/_build/html/license.html
+++ /dev/null
@@ -1,139 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/src/postorius/doc/_build/html/news.html b/src/postorius/doc/_build/html/news.html
deleted file mode 100644
index 3f98d51..0000000
--- a/src/postorius/doc/_build/html/news.html
+++ /dev/null
@@ -1,186 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Contributions:¶
-
-
-Mailman is licensed unter GPL¶
-Copyright (C) 1998-2010 by the Free Software Foundation, Inc.
-This file is part of GNU Mailman.
-GNU Mailman 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.
-GNU Mailman 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 -GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
-
-
-RRZE Icon Set¶
-CreativeCommons Licence
-The RRZE Icon Set is licenced under a Creative Commons Licence. -Please see the website for the current licence text.
-More information about the Project could be found here: -http://rrze-icon-set.berlios.de/licence.html
-Special thanks to: -* Franziska Sponsel (created additional Icons specially for our Project)
-
-
-
-
-
-
\ No newline at end of file
diff --git a/src/postorius/doc/_build/html/objects.inv b/src/postorius/doc/_build/html/objects.inv
deleted file mode 100644
index 0c1d872..0000000
--- a/src/postorius/doc/_build/html/objects.inv
+++ /dev/null
@@ -1,10 +0,0 @@
-# Sphinx inventory version 2
-# Project: Postorius
-# Version: 1.0a2
-# The remainder of this file is compressed using zlib.
-xڍ�M
-�0F�9ŀnS̶7p! @��@�h&���v"Xڅ�Y|��|�q��
-���z�
-�K���
-~�d�G8N��7�o� F ��>,A�va�-
-�B����>p�jq�2ϙ܃9J��͘絒�K��}�#�Nl��¿�Ժir��l}�
\ No newline at end of file
diff --git a/src/postorius/doc/_build/html/py-modindex.html b/src/postorius/doc/_build/html/py-modindex.html
deleted file mode 100644
index aa9ec3a..0000000
--- a/src/postorius/doc/_build/html/py-modindex.html
+++ /dev/null
@@ -1,131 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- News / Changelog¶
-Copyright (C) 2012 by the Free Software Foundation, Inc.
-The Postorius Django app provides a web user interface to -access GNU Mailman.
-Postorius is free software: you can redistribute it and/or -modify it under the terms of the GNU Lesser General Public License as -published by the Free Software Foundation, version 3 of the License.
-Postorius 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 Lesser -General Public License for more details.
-You should have received a copy of the GNU Lesser General Public License -along with Postorius. If not, see <http://www.gnu.org/licenses/>.
-
-
-1.0 alpha 2¶
-(2012-XX-XX)
--
-
- dev setup fix for Django 1.4 contributed by Rohan Jain -
- missing csrf tokens in templates contributed by Richard Wackerbarth (LP: 996658) -
- moderation: fixed typo in success message call -
- installation documentation for Apache/mod_wsgi -
- moved project files to separate branch -
- show error message if connection to Mailman API fails -
- added list members view -
- added developer documentation -
- added test helper utils -
- all code now conform to PEP8 -
- themes: removed obsolete MAILMAN_THEME settings from templates, contexts, file structure; contributed by Richard Wackerbarth (LP: 1043258) -
- added access control for list owners and moderators -
- added a mailmanclient shell to use as a manage.py command (python manage.py mmclient) -
- use “url from future” template tag in all templates. Contributed by Richard Wackerbarth. -
- added “new user” form. Contributed by George Chatzisofroniou. -
- added user subscription page -
- added decorator to allow login via http basic auth (to allow non-browser clients to use API views) -
- added api view for list index -
- several changes regarding style and navigation structure -
-
-1.0 alpha 1 – “Space Farm”¶
-(2012-03-23)
-Many thanks go out to Anna Senarclens de Grancy and Benedict Stein for -developing the initial versions of this Django app during the Google Summer of -Code 2010 and 2011.
--
-
- add/remove/edit mailing lists -
- edit list settings -
- show all mailing lists on server -
- subscribe/unsubscribe/mass subscribe mailing lists -
- add/remove domains -
- show basic list info and metrics -
- login using django user account or using BrowserID -
- show basic user profile -
- accept/discard/reject/defer messages -
- Implementation of Django Messages contributed by Benedict Stein (LP: #920084) -
- Dependency check in setup.py contributed by Daniel Mizyrycki -
- Proper processing of acceptable aliases in list settings form contributed by -Daniel Mizyrycki -
-
-
-
-
-
\ No newline at end of file
diff --git a/src/postorius/doc/_build/html/search.html b/src/postorius/doc/_build/html/search.html
deleted file mode 100644
index fd1824c..0000000
--- a/src/postorius/doc/_build/html/search.html
+++ /dev/null
@@ -1,105 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Python Module Index
- - - -| - p | ||
| - | - postorius | - |
| - | - postorius.tests.test_utils | - |
| - t | ||
| - | - tests | - |
| - | - tests.tests | - |
-
-
-
-
-
\ No newline at end of file
diff --git a/src/postorius/doc/_build/html/searchindex.js b/src/postorius/doc/_build/html/searchindex.js
deleted file mode 100644
index 58c80d3..0000000
--- a/src/postorius/doc/_build/html/searchindex.js
+++ /dev/null
@@ -1 +0,0 @@
-Search.setIndex({objects:{tests:{tests:[4,0,1,""]},"postorius.tests":{test_utils:[0,0,1,""]}},terms:{all:[0,4,2,3],code:[0,4,3],forget:4,prefil:4,test_list_set:0,four:[],ackownledg:[],runserv:2,dirnam:[],follow:[4,2],content:[1,4],decid:[],depend:[3,2],authoris:[],send:[],shall:4,granci:3,under:3,tour_:[],sens:0,introduc:0,merchant:3,sourc:0,everi:[],string:4,without:[0,4,3],far:[],none:4,offlin:[],util:[0,4,3],context_processor:0,mechan:[0,4],veri:0,exact:4,relev:0,mailmanwebgsoc2011:[],common:[],testobject:4,contenttyp:[],administr:4,level:[],did:4,button:4,list:[0,4,3],liza:4,"try":4,item:4,adjust:[],localhost:[0,4],quick:0,prepar:2,dir:[],pleas:[0,4],modelbackend:[],impli:3,fieldset_form:0,httpresponseredirect:4,cfg:[],seper:[],request:[0,4],past:[],second:2,pass:0,download:2,further:[],click:4,compat:[],index:[0,4,3],what:[],name_of_permiss:[],appear:[],richard:3,sum:[],abl:[4,2],current:[0,4],delet:[0,4],new_list1:4,postoriu:[0,1,2,3],franziska:[],"new":[0,1,3,4],net:[],method:[],manag:[0,4,2,3],redirect:[0,4],abov:4,gener:[0,3],never:2,remeb:[],here:0,themself:[],ubuntu:[],path:2,along:3,modifi:[4,3],sinc:[0,2],valu:4,search:[],mailinglist:[],vertifi:[],anymor:[],errorlog:[],step:[],jame:4,doctest:4,pick:0,action:4,chang:[0,3,2],mailman_media:[],ourselv:0,mock:0,contactpag:[],via:3,appli:[],app:[4,3],sponser:[],prefer:2,releas:2,api:[0,3],sponsel:[],foord:0,home:[],instal:[1,2,3,4],myownunittest:0,middlewar:[],from:[0,4,2,3],describ:[0,4],would:0,commun:[],doubl:4,two:0,perm:[],next:[],websit:[],few:[],call:[0,3],typo:3,recommend:[],dict:0,type:4,web_host:4,create_mock_list:0,mailman_django:[],abspath:[],relat:[0,4],ital:[],site:[4,2],warn:[4,2],trail:[],berlio:[],stick:[],autodoc:[],particular:3,dooo:[],hold:0,unpack:[],easiest:4,dot:0,customlog:[],account:[3,2],join:[],reviewd:[],alia:2,setup:[4,2,3],work:0,uniqu:[],dev:[3,2],itself:0,can:[0,4,2,3],purpos:3,def:0,control:[0,3],defer:3,sqlite:2,prompt:2,login_requir:[0,4],tar:[],process:3,sudo:2,accept:3,topic:[],tag:3,want:[4,2],fieldset:0,create_mock_memb:0,create_mock_domain:0,nearli:[],alwai:[0,2],cours:[],multipl:[],listmembersviewtest:0,anoth:4,magigmock:0,faulti:[],georg:[4,3],write:0,how:[0,2],list_nam:0,reject:3,instead:[0,4],config:[],nasti:[],css:[0,2],updat:4,product:2,recogn:0,farm:3,pypi:2,after:[4,2],"long":[],usabl:[],befor:[0,4],wrong:4,date:2,end:[],data:4,"short":0,third:2,postfix:[],bind:[],bootstrap:[],credenti:0,django:[0,4,2,3],alias:3,environ:2,adverrtis:4,jain:3,enter:4,fallback:[],automaticli:[],egg:[],order:[0,2],listnam:4,help:0,move:3,becaus:[0,4],has_perm:[],"__future__":[],mailman_vers:0,style:[0,3],render:[],fit:3,fix:3,browserid:3,unicode_liter:[],better:[],restart:[],helper:3,media_root:[],mail:[0,4,3],hidden:[],main:[],might:[],guarente:[],split:[],them:[0,2],good:0,"return":0,thei:[0,4],python:[0,4,2,3],databs:[],handi:0,auth:[0,3],unfortuneatli:[],"break":[],mention:4,front:4,resourc:4,now:[0,4,2,3],introduct:[],get_list:0,term:3,benst:[],somewher:2,name:[0,4],anyth:[],edit:[4,3],simpl:0,postorius_error:[],didn:0,authent:0,separ:[0,4,3],easili:[],senarclen:3,each:[0,4],debug:4,found:[4,2],went:4,mailman_test_bindir:[],mean:0,everyth:[0,4],domain:[0,4,3],fail:[4,3],replac:[],idea:[],procedur:[],realli:4,redistribut:3,meta:4,"static":[0,2],connect:[0,3],our:4,patch:[],todo:[],dependeci:[],out:[0,3],variabl:0,shown:4,won:0,space:3,miss:3,robert:2,develop:[0,1,2,3,4],publish:3,api_us:4,profil:3,daniel:3,rest_serv:[],got:[],correct:[0,2],mailmancli:3,earlier:[],insid:[],workflow:0,free:[4,3],standard:0,standalon:[],reason:[],base:0,mailmanweb:[],dictionari:0,lists_of_domain:[],put:0,org:[0,3,2],restbackend:[],"40mail":4,launch:[],could:0,latest:2,membership:[0,4],keep:2,filter:[],thing:4,place:[],isn:[],outsid:0,root_urlconf:[],requireti:[],summari:4,first:[4,2],softwar:3,rang:[],directli:[0,4],prevent:[],feel:4,onc:[],number:0,natti:[],restrict:4,mai:[],instruct:[4,2],alreadi:4,done:4,messag:[0,4,3],authentif:4,owner:[0,4,3],stabl:4,installed_app:[],open:[0,4],gpl:[],differ:[0,2],rrze:[],my_own_test:0,script:0,benedict:3,hardcopi:[],licens:3,system:0,least:4,downsid:0,url_host:0,too:0,licenc:[],fullfil:[],"final":4,store:[],shell:[0,4,3],option:4,real_nam:4,tool:0,copi:3,specifi:4,gsoc:[],"var":[],part:4,"__test__":0,exactli:[],than:0,priveledg:[],serv:2,test_some_method:[],kind:0,provid:[0,4,2,3],remov:[4,3],structur:[0,3],new_domain:[],project:[0,3,2],"__init__":0,reus:0,postorius_standalon:2,were:4,posit:4,minut:[],other:[0,4],fqdn_listnam:[0,4],browser:[0,3],pre:[],sai:[],runner:0,ani:[0,3],postorius_access:[],packag:2,have:[0,4,2,3],tabl:2,need:[0,4,2],element:[],wsgiscriptalia:2,engin:2,inform:[0,2],florian:[],destroi:[],self:[],note:[4,2],also:[0,2],ideal:0,exampl:[0,4],take:[],which:[0,4,2],combin:[],mock_memb:0,singl:[0,4],even:3,sure:[0,4,2],kati:4,allow:[4,2,3],httpredirectobject:4,usernam:[],object:[0,4],asdasd:[],most:[0,4],plan:[],letter:4,watt:4,alpha:3,"class":0,icon:[],collectstat:2,don:[0,4],bzr:2,url:[0,4,3],doc:0,later:[],cover:[0,2],temporili:4,doe:4,meanwhil:[],deni:2,pars:4,effect:[],usual:0,review:0,dev_setup:[],wsgi:2,owner_address:0,show:[4,3],text:4,contact_address:0,session:[0,4],permiss:4,corner:[],fine:[],find:0,magicmock:0,involv:0,absolut:[],onli:[0,4,2],eas:[],locat:2,launchpad:[0,2],copyright:3,explain:4,configur:[],apach:[3,2],behind:[],should:[0,4,2,3],theme:3,version:[0,3,2],suppos:[],central:[],templat:[0,3],folder:[0,2],local:[0,4,2],hope:3,media_url:[],hit:[],contribut:3,get:[0,4,2],familiar:0,"__file__":[],stop:4,obviou:0,absolute_import:[],csrf:3,report:0,subscript:[4,3],requir:4,layout:0,retreiv:0,mail_host:[0,4],bar:[],template_dir:[],possibl:2,"public":3,reload:2,bad:[],integr:0,restadmin:[],mm_membership:4,where:0,view:[0,4,3],wiki:[],conform:3,set:[0,4,2,3],special:[],sometest:[],see:[4,2,3],domain_admin:[],result:0,respons:4,testcas:[],wonder:[],awar:4,statu:4,mailman3a7:[],correctli:[],databas:[0,4,2],someth:4,test_list_memb:0,state:0,quickest:2,between:4,"import":[0,4],awai:[],approach:0,email:4,realnam:[],unauthor:0,extens:[],spare:0,correclti:[],ipython:0,advertis:4,subfold:[],thank:3,both:[],protect:0,last:[0,4],chain:0,plugin:[],admin:2,howev:[],against:0,etc:2,tour:0,instanc:[0,4],context:3,delete_list:4,logout:[],login:[0,4,3],com:4,load:4,english:4,simpli:4,point:0,instanti:[],overview:4,unittest:[],address:[0,4],virtualhost:2,mock_list:0,header:0,featur:0,non:3,shortcut:0,linux:4,guid:[0,4,2],assum:2,backend:[],quit:[],trunk:0,mailman:[0,1,2,3,4],coupl:4,"0a7":[],is_superus:0,three:0,been:4,compon:[],much:0,unsubscrib:[4,3],modif:[],addit:[],quickli:0,upcom:[],imag:[0,2],xxx:[],superuser_or_403:0,togeth:4,i18n:[],ngeorg:4,niederreit:2,those:[0,4],"case":[0,4],creativecommon:[],therefor:[],look:0,gnu:[0,3,2],plain:[],align:[],properti:0,easier:0,lesser:3,"while":[0,2],dashboard:4,publicli:2,error:3,exist:0,everyon:[],authentication_backend:[],anonymousus:0,default_nonmember_act:0,new_list:[],advantag:0,almost:2,demo:[],metric:3,list_own:4,worri:0,archiv:4,revis:[],sever:3,subscrib:[0,4,3],decor:[0,4,3],let:[0,4],welcom:[],author:0,receiv:3,suggest:0,make:[0,4,2],belong:4,same:4,member:[0,3],handl:[],html:0,gui:4,document:[0,3,2],mod_wsgi:[3,2],behav:0,acl:[],finish:4,http:[0,4,2,3],webserv:2,upon:[],mmclient:[0,3],moment:[],http_host:4,initi:3,mani:3,stack:[],expand:[],appropri:[],moder:[0,3],foundat:3,scenario:[],framework:[],api_pass:4,whole:0,well:[4,2],membership_set:[],person:0,client:[0,4,2,3],command:[0,3],thi:[0,4,2,3],choos:4,model:0,loggedin_or_403:0,rout:0,left:[],summer:3,just:[0,2],rest:[0,4],indic:4,mailman_dev:0,mailman3:4,pep8:3,webui:[],test_util:0,yet:[],languag:4,web:[0,1,2,3],like:0,display_nam:0,easi:[],project_path:[],had:[],list_summari:4,littl:0,apache2:[],add:[0,4,3],valid:[0,4],lawrenc:[],discurag:0,save:[],modul:[0,4],build:0,bin:[],applic:[0,2],obsolet:3,stein:3,unter:[],read:[],big:0,regard:3,testlist:0,test:[0,4,3],know:2,gsoc_mailman:[],press:4,cooki:[],bit:0,password:[],tweak:[],authbackend:[],apart:0,resid:[0,2],template_context_processor:[],success:[4,3],changelog:[1,3],restpass:[],server:[0,3,2],collect:2,href:[],setup_mm:4,either:4,chatzisofroni:3,page:[0,4,3],www:[0,3],right:[],acknowledg:[],creation:4,some:[0,4],back:[],propos:0,proper:3,create_list:[],funcit:[],librari:0,distribut:3,basic:[0,3],buildout:2,djangoproject:[],confirm:4,avoid:[],woun:[],token:3,list_moderator_requir:0,select:[],slash:[],necessari:2,foo:[],anna:3,refer:4,machin:4,core:[],who:[],run:[0,4,2],bold:[],usag:[],symlink:[],host:0,repositori:[],basic_auth_login:0,post:4,bazaar:[0,2],mm_new_domain:[],stage:[],src:0,about:0,create_mock_:0,usa:4,list_owner_requir:0,mass_subscrib:4,rohan:3,side:[],permission_requir:[],srv:2,act:2,fals:4,discard:3,readi:2,processor:[],block:4,own:[0,4],addus:[],status_cod:4,pythonpath:2,xyz:[],within:4,someviewclass:[],easy_instal:2,warranti:3,creativ:[],empti:4,contrib:[],your:[0,2],merg:0,choosen:4,span:4,log:4,wai:[0,4,2],"40exampl":4,execut:[0,4],print:[0,4],submit:4,custom:0,avail:[0,4,2],start:[0,4,2],reli:[],interfac:[3,2],includ:4,suit:[0,4],superus:[0,2],systers_django:[],lambda:0,"function":[0,4],media:[],head:[],my_view_func:0,form:[0,4,3],offer:4,descrip:[],requestfactori:[],navig:3,pwd:0,link:4,translat:4,teardown_mm:4,branch:[0,3,2],line:[4,2],"true":4,bug:0,info:[0,3],pull:2,succe:4,made:[0,4],render_mailman_them:[],bullet:[],"0b2":0,whether:4,access:[0,4,3],displai:4,below:4,memebership:[],otherwis:[],more:3,postmast:0,extend_ajax:[],proud:[],creat:[0,4,2],hardcod:[],dure:[4,3],doesn:[],listsettingsviewtest:0,implement:3,file:[0,3,2],syncdb:2,pip:2,wackerbarth:3,check:[0,4,3],probabl:0,again:0,coder:2,successfulli:[],googl:3,titl:[],user:[0,4,2,3],when:0,detail:[0,3,2],gettext:4,"default":0,mizyrycki:3,mock_list2:[],role:0,futur:3,rememb:[],writabl:2,you:[0,4,2,3],user_passes_test:0,servernam:[],nice:[0,4],michael:0,why:4,prequir:[],consid:[],stai:[],outdat:4,sphinx:0,faster:0,mock_domain:0,directori:[0,4,2],enjoi:4,bottom:[],descript:[0,4],rule:[],mailman_them:3,relvant:0,mass:[4,3],came:[],time:[4,2],escap:4,inc:3},objtypes:{"0":"py:module"},titles:["Development","Postorius - The New Mailman Web UI","Installation","News / Changelog","Using the Django App - Developers Resource (outdated)"],objnames:{"0":["py","module","Python module"]},filenames:["development","index","setup","news","using"]})
\ No newline at end of file
diff --git a/src/postorius/doc/_build/html/setup.html b/src/postorius/doc/_build/html/setup.html
deleted file mode 100644
index b2b4666..0000000
--- a/src/postorius/doc/_build/html/setup.html
+++ /dev/null
@@ -1,252 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Search
-
-
-
- - Please activate JavaScript to enable the search - functionality. -
-- From here you can search these documents. Enter your search - words into the box below and click "search". Note that the search - function will automatically search for all of the words. Pages - containing fewer words won't appear in the result list. -
- - -
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/src/postorius/doc/_build/html/testing.html b/src/postorius/doc/_build/html/testing.html
deleted file mode 100644
index 4c72b19..0000000
--- a/src/postorius/doc/_build/html/testing.html
+++ /dev/null
@@ -1,155 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Installation¶
-
-
-Note
-This installation guide covers Postorius, the web user interface for -GNU Mailman 3. To install GNU Mailman follow the instructions in the documentation: -http://packages.python.org/mailman/
-
-
-
-
-Install Dependencies¶
-Django:
-$ sudo pip install django
-mailman.client:
-$ bzr branch lp:mailman.client
-$ cd mailman.client
-$ sudo python setup.py install
-
-
-Install Postorius¶
-
-
-
-
-Latest release¶
-If you just want to install the latest release of Postorius, install it from -PyPi:
-$ sudo pip install postorius
-or:
-$ sudo easy_install postorius
-
-
-
-
-
-Latest dev version¶
-If you want to always be up to date with the latest development version, you -should install Postorius using bazaar:
-$ bzr branch lp:postorius
-$ cd postorius
-$ sudo python setup.py develop
-$ cd ..
-You can always pull in the latest changes from the development branch:
-$ cd postorius
-$ bzr pull
-$ cd ..
-Make sure to keep mailman.client up to date as well:
-$ cd mailman.client
-$ bzr pull lp:mailman.client
-$ cd ..
-
-
-
-
-Setup your django project¶
-Since you have now installed the necessary packages to run Postorius, it’s -time to setup your Django site.
-First, get the project directory from launchpad:
-$ bzr branch lp:~mailman-coders/postorius/postorius_standalone
-Second, change the database setting in postorius_standalone/settings.py to -your preferred database. If you’re OK with using sqlite, just change the path -in line 48 to the correct location.
-
-
-Note
-Detailed information on how to use different database engines can be found -in the Django documentation.
-Third, prepare the database:
-$ cd postorius_standalone
-$ python manage.py syncdb
-$ cd ..
-This will create the .db file (if you ar using SQLite) and will setup all the -necessary db tables. You will also be prompted to create a superuser which -will act as an admin account for Postorius.
-
-
-See also
-Robert Niederreiter has provided a buildout for GNU Mailman 3 and -Postorius.
-
-
-
-Running the development server¶
-The quickest way to run Postorius is to just start the development server:
-$ cd postorius_standalone
-$ python manage.py runserver
-
-
-Warning
-You should use the development server only locally. While it’s possible to -make your site publicly available using the dev server, you should never -do that in a production environment.
-
-
-
-
-Running Postorius on Apache with mod_wsgi¶
-
-
-Note
-This guide assumes that you know how to setup a VirtualHost with Apache. -If you are using SQLite, the .db file as well as its folder need to be -writable by the web server.
-These settings need to be added to your Apache VirtualHost:
-Alias /static /path/to/postorius_standalone/static
-<Directory "/path/to/postorius_standalone/static">
- Order deny,allow
- Allow from all
-</Directory>
-
-WSGIScriptAlias / /path/to/postorius_standalone/srv/postorius.wsgi
-<Directory "/path/to/postorius_standalone/srv">
- Order deny,allow
- Allow from all
-</Directory>
-The first Alias serves the static files (CSS, JS, Images, etc.). The -WSGIScriptAlias serves the Django application. The paths need to be changed -depending on which location you downloaded postorius_standalone to.
-We’re almost ready. But you need to collect the static files from Postorius -(which resides somewhere on your pythonpath) to be able to serve them from the -site directory. All you have to do is to change into the -postorius_standalone directory and run:
-$ python manage.py collectstatic
-After reloading the webserver Postorius should be running!
-
-
-
-
-
-
\ No newline at end of file
diff --git a/src/postorius/doc/_build/html/using.html b/src/postorius/doc/_build/html/using.html
deleted file mode 100644
index 3d4829b..0000000
--- a/src/postorius/doc/_build/html/using.html
+++ /dev/null
@@ -1,402 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Writing tests¶
-
-
-Mocking mailman.client objects¶
-
-
-
-
-
-
-Mailing Lists¶
->>> from postorius.tests.utils import *
->>> properties = dict(fqdn_listname='testlist@example.org',
-... mail_host='example.org',
-... list_name='testlist',
-... display_name='Test List')
->>> mock_list = create_mock_list(properties)
->>> print mock_list.fqdn_listname
-testlist@example.org
->>> print mock_list.mail_host
-example.org
->>> print mock_list.list_name
-testlist
->>> print mock_list.display_name
-Test List
->>> print mock_list
-<MagicMock name='List' id='...'>
-
-
-
-
-
-
\ No newline at end of file
diff --git a/src/postorius/doc/development.rst b/src/postorius/doc/development.rst
index 86c153d..90adedc 100644
--- a/src/postorius/doc/development.rst
+++ b/src/postorius/doc/development.rst
@@ -5,77 +5,99 @@
This is a short guide to help you get started with Postorius development.
-Directory layout
-================
-
-Postorius is a Django application, so if you have developed with Django before,
-the file structure probably looks familiar. These are the basics:
-
-::
-
- __init__.py
- auth/ # Custom authorization code (List owners and
- # moderators)
- context_processors.py # Some variables available in all templates
- doc/ # Sphinx documentation
- fieldset_forms.py # A custom form class to build html forms with
- # fieldsets
- forms.py # All kinds of classes to build and validate forms
- management/ # Commands to use with Django's manage.py script
- models.py # Code to connect to mailman.client and provide
- # a Django-style model API for lists, mm-users and
- # domains
- static/ # Static files (CSS, JS, images)
- templates/ # HTML Templates
- tests/ # Postorius test files
- urls.py # URL routes
- utils.py # Some handy utilities
- views/
- views.py # View classes and functions for all views connected
- # in urls.py
- generic.py # Generic class-based views; Currently holds a
- # class for views based on a single mailing list
-
-
Development Workflow
====================
-The source code is hosted on Launchpad_, which also means that we are using
+The source code is hosted on Launchpad_, which means that we are using
Bazaar for version control.
-.. _Launchpad: https://launchpad.net
+.. _Launchpad: https://launchpad.net/postorius
Changes are usually not made directly in the project's trunk branch, but in
feature-related personal branches, which get reviewed and then merged into
the trunk.
-The ideal workflow would be like this:
+An ideal workflow would be like this:
1. File a bug to suggest a new feature or report a bug (or just pick one of
the existing bugs).
2. Create a new branch with your code changes.
3. Make a "merge proposal" to get your code reviewed and merged.
-Launchpad has a nice tour_ which describes all this in detail.
-.. _tour: https://launchpad.net/+tour/index
+Testing
+=======
+After a fresh checkout of Postorius you can run the tests from
+Postorius' root directory using ``tox``:
-Writing View Code
-=================
+::
-When the work on Postorius was started, the standard way to write view code in
-Django was to write a single function for each different view. Since then
-Django has introduced so-called 'class-based views' which make it much easier
-to reuse view functionality. While using simple functions is not discuraged, it
-makes sense to check if using a class-based approach could make sense.
+ $ tox
-Check Postorius' ``views/views.py`` and ``views/generic.py`` for examples!
+By default this will test against a couple of different environments.
+If you want to only run the tests in a specific environment or a single
+module, you can specify this using the ``-e`` option and/or a double
+dash:
+
+::
+
+ # List all currently configured envs:
+ $ tox -l
+ py27-django1.5
+ py27-django1.6
+ py27-django1.7
+
+ # Test Django 1.7 on Python2.7 only:
+ $ tox -e py27-django1.7
+
+ # Run only tests in ``test_address_activation``:
+ $ tox -- postorius.tests.test_address_activation
+
+ # You get the idea...
+ $ tox -e py27-django1.7 -- postorius.tests.test_address_activation
-Authentication/Authorization
-============================
+All test modules reside in the ``postorius/src/postorius/tests``
+directory. Please have a look at the existing examples.
+
+
+Mocking calls to Mailman's REST API
+-----------------------------------
+
+A lot of Postorius' code involves calls to Mailman's REST API (through
+the mailman.client library). Running these tests against a real instance
+of Mailman would be bad practice and slow, so ``vcrpy`` *cassettes* are
+used instead (see the `vcrpy Documentation`_ for details). These files
+contain pre-recorded HTTP responses.
+
+.. _`vcrpy Documentation`: https://github.com/kevin1024/vcrpy
+
+If you write new tests, it's advisable to add a separate fixture file
+for each test case, so the cached responses don't interfere with other
+tests. The cassette files are stored in the
+``tests/fixtures/vcr_cassettes`` directory.
+
+In order to record new API responses for your test case, you need to
+first start the mailman core, with the API server listening on port
+9001. You can use the ``testing/test_mailman.cfg`` file from the
+Postorius source. Make sure, you use a fresh mailman.db file.
+
+Once the core is running, you can record the new cassette file defined
+in your test case like by running tox with the `record` test env:
+
+::
+
+ # This will only record the cassette files defined in my_new_test_module:
+ $ tox -e record -- postorius.tests.my_new_test_module
+
+ # This will re-record all cassette files:
+ $ tox -e record
+
+
+View Auth
+=========
Three of Django's default User roles are relvant for Postorius:
@@ -94,38 +116,10 @@
- ``@user_passes_test(lambda u: u.is_superuser)`` (redirects to login form)
- ``@login_required`` (redirects to login form)
-- ``@list_owner_required`` (returns 403)
-- ``@list_moderator_required`` (returns 403)
-- ``@superuser_or_403`` (returns 403)
-- ``@loggedin_or_403`` (returns 403)
-- ``@basic_auth_login``
-
-Check out ``views/views.py`` or ``views/api.py`` for examples!
-
-The last one (basic_auth_login) checks the request header for HTTP Basic Auth
-credentials and uses those to authenticate against Django's session-based
-mechanism. It can be used in cases where a view is accessed from other clients
-than the web browser.
-
-Please make sure to put it outside the other auth decorators.
-
-Good:
-
-::
-
- @basic_auth_login
- @list_owner_required
- def my_view_func(request):
- ...
-
-Won't work, because list_owner_required will not recognize the user:
-
-::
-
- @list_owner_required
- @basic_auth_login
- def my_view_func(request):
- ...
+- ``@list_owner_required`` (returns 403 if logged-in user isn't the
+ list's owner)
+- ``@list_moderator_required`` (returns 403 if logged-in user isn't the
+ list's moderator)
Accessing the Mailman API
@@ -157,68 +151,3 @@
For detailed information how to use mailman.client, check out its documentation_.
.. _documentation: http://bazaar.launchpad.net/~mailman-coders/mailman.client/trunk/view/head:/src/mailmanclient/docs/using.txt
-
-
-Testing
-=======
-
-Currently only some of the Postorius code is covered by a test. We should change that!
-
-All test modules reside in the ``postorius/src/postorius/tests`` directory
-and this is where you should put your own tests, too. To make the django test
-runner find your tests, make sure to add them to the folder's ``__init__.py``:
-
-::
-
- from postorius.tests import test_utils
- from postorius.tests.test_list_members import ListMembersViewTest
- from postorius.tests.test_list_settings import ListSettingsViewTest
- from postorius.tests.my_own_tests import MyOwnUnitTest
-
- __test__ = {
- "Test Utils": test_utils,
- "List Members": ListMembersViewTest,
- "List Settings": ListSettingsViewTest,
- "My Own Test": MyOwnUnitTest,
- }
-
-
-Running the tests
------------------
-
-To run the tests go to your project folder and run ``python manage.py test
-postorius`` from there.
-
-
-Testing mailman.client results
-------------------------------
-
-Most of Postorius' code involves some results from calls to the mailman.client
-library. mailman.client is itself covered by tests, so Postorius' own tests
-don't need to check if mailman.client returns correct results. Instead we can
-just mock them! This has the big advantage that you can run the test suite
-without having to worry about the state of the local Mailman database. It also
-makes the tests run faster, because we spare ourselves the HTTP calls to the
-local Mailman REST API.
-
-This approach has the obvious downside that the Postorius tests will not
-recognize any changes to the Mailman API. So at some point there should be some
-separate integration tests to test the whole chain. But let's not worry about
-that for now.
-
-
-Mocking mailman.client objects
-------------------------------
-
-Postorius uses Michael Foord's ``mock`` library for mocking. There are some
-shortcuts you can use to quickly create mock objects that behave a little bit
-like objects retreived from mailman.client, like:
-
-- create_mock_domain
-- create_mock_list
-- create_mock_member
-
-These ``create_mock_*`` functions are very simple tools that return MagigMock objects with the properties passed to them in a dictionary. They also set some defaults for properties that you didn't pass to its ``create_mock_*`` function. For instance, a mock list created with ``create_mock_list()`` will always have ``members``, ``moderators`` and ``owners`` properties.
-
-
-.. automodule:: postorius.tests.test_utils
diff --git a/src/postorius/doc/index.rst b/src/postorius/doc/index.rst
index da81de8..829875c 100644
--- a/src/postorius/doc/index.rst
+++ b/src/postorius/doc/index.rst
@@ -1,7 +1,14 @@
Postorius - The New Mailman Web UI
==================================
-Contents:
+Copyright (C) 2009-2015 by the Free Software Foundation, Inc.
+
+This is Postorius, the new official web interface for the GUN Mailman 3
+list management system.
+
+
+Table of Contents
+-----------------
.. toctree::
:maxdepth: 1
@@ -9,4 +16,3 @@
news.rst
setup.rst
development.rst
-
diff --git a/src/postorius/doc/news.rst b/src/postorius/doc/news.rst
index 94cea12..fc904da 100644
--- a/src/postorius/doc/news.rst
+++ b/src/postorius/doc/news.rst
@@ -2,7 +2,7 @@
News / Changelog
================
-Copyright (C) 2012-2014 by the Free Software Foundation, Inc.
+Copyright (C) 2012-2015 by the Free Software Foundation, Inc.
The Postorius Django app provides a web user interface to
access GNU Mailman.
@@ -34,7 +34,7 @@
* Fix small bug moderator/owner forms on list members page. Contributed by Pranjal Yadav (LP: 1308219).
* Fix broken translation string on the login page. Contributed by Pranjal Yadav.
* Show held message details in a modal window. Contributed by Abhilash Raj (LP: 1004049).
-
+* Rework of internal testing
1.0 beta 1 -- "Year of the Parrot"
==================================
diff --git a/src/postorius/doc/settings.py b/src/postorius/doc/settings.py
index 4809130..00fa7b3 100755
--- a/src/postorius/doc/settings.py
+++ b/src/postorius/doc/settings.py
@@ -1,5 +1,5 @@
#-*- coding: utf-8 -*-
-# Copyright (C) 1998-2012 by the Free Software Foundation, Inc.
+# Copyright (C) 1998-2015 by the Free Software Foundation, Inc.
#
# This file is part of Postorius.
#
diff --git a/src/postorius/doc/using.rst b/src/postorius/doc/using.rst
deleted file mode 100644
index ac69426..0000000
--- a/src/postorius/doc/using.rst
+++ /dev/null
@@ -1,32 +0,0 @@
-Using the Django App - Developers Resource (outdated)
-=====================================================
-
-.. warning::
- This user guide is outdated and needs to be updated.
-
-.. automodule:: tests.tests
-
-Running the tests explained above.
-----------------------------------
-We've added our own test-suite to the Django App which will be executed together with the Django Test. Last thing you should do is running these tests. If they fail you did something wrong, if they succeed you can enjoy the site.
-
-Run the following in the Site Directory
-
- .. code-block:: bash
-
- $ python manage.py test
-
-.. note::
- Please be aware that we want to run a development instance of mailman you need to stop the stable one first and the tests will open it's own mailman temporily.
-
-Accessing the REST Client for Testing
--------------------------------------
-
-If you want to access the Functions, which we use in the views, directly feel free to run the following block of code within a Shell which does have it's current Directory within the Django Site Directory.
-
- .. code-block:: python
-
- from settings import API_USER, API_PASS
- from mailman.client import Client
- c = Client('http://localhost:8001/3.0', API_USER, API_PASS)
- #DEBUG: Python Session
diff --git a/src/postorius/fieldset_forms.py b/src/postorius/fieldset_forms.py
index 3972de6..f8634e0 100644
--- a/src/postorius/fieldset_forms.py
+++ b/src/postorius/fieldset_forms.py
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (C) 1998-2014 by the Free Software Foundation, Inc.
+# Copyright (C) 1998-2015 by the Free Software Foundation, Inc.
#
# This file is part of Postorius.
#
diff --git a/src/postorius/forms.py b/src/postorius/forms.py
index b69061a..13bad30 100644
--- a/src/postorius/forms.py
+++ b/src/postorius/forms.py
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (C) 2012-2014 by the Free Software Foundation, Inc.
+# Copyright (C) 2012-2015 by the Free Software Foundation, Inc.
#
# This file is part of Postorius.
#
diff --git a/src/postorius/management/commands/mmclient.py b/src/postorius/management/commands/mmclient.py
index 2145d05..0e0f91a 100644
--- a/src/postorius/management/commands/mmclient.py
+++ b/src/postorius/management/commands/mmclient.py
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (C) 1998-2014 by the Free Software Foundation, Inc.
+# Copyright (C) 1998-2015 by the Free Software Foundation, Inc.
#
# This file is part of Postorius.
#
diff --git a/src/postorius/models.py b/src/postorius/models.py
index 2280ec6..c21147b 100644
--- a/src/postorius/models.py
+++ b/src/postorius/models.py
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (C) 1998-2014 by the Free Software Foundation, Inc.
+# Copyright (C) 1998-2015 by the Free Software Foundation, Inc.
#
# This file is part of Postorius.
#
diff --git a/src/postorius/templatetags/nav_helpers.py b/src/postorius/templatetags/nav_helpers.py
index d345f56..5ca23c3 100644
--- a/src/postorius/templatetags/nav_helpers.py
+++ b/src/postorius/templatetags/nav_helpers.py
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (C) 1998-2014 by the Free Software Foundation, Inc.
+# Copyright (C) 1998-2015 by the Free Software Foundation, Inc.
#
# This file is part of Postorius.
#
diff --git a/src/postorius/tests/__init__.py b/src/postorius/tests/__init__.py
index 9999672..b3bd492 100644
--- a/src/postorius/tests/__init__.py
+++ b/src/postorius/tests/__init__.py
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (C) 2012-2014 by the Free Software Foundation, Inc.
+# Copyright (C) 2012-2015 by the Free Software Foundation, Inc.
#
# This file is part of Postorius.
#
@@ -15,10 +15,22 @@
# You should have received a copy of the GNU General Public License along with
# Postorius. If not, see
-
-
-
-
-
-
-
-
-
-
-
-
- Using the Django App - Developers Resource (outdated)¶
-
-
-Warning
-This user guide is outdated and needs to be updated.
-
-
-
-
-Tests Login and Permissions¶
-Setup Testobject (starts Mailman3 with an empty Database).
----->>> from setup import setup_mm, Testobject, teardown_mm ->>> testobject = setup_mm(Testobject()) ---Note
-You need to stop all Mailman3 instances before running the tests
-
-
-
- Modules needed -
As we can’t make sure that you’re running the same language as we did we -made sure that each test below is executed using the exact same translation -mechanism as we use to Display you Status Messages and other GUI Texts.
--
-
- Import Translation Module to check success messages -
- --
>>> from django.utils.translation import gettext as _ -
- - Import HTTPRedirectObject to check whether a response redirects -
- --
>>> from django.http import HttpResponseRedirect -
-
-
Import Django test client.
->>> from django.test.client import Client
->>> c = Client()
-
-
-
-
-List index¶
-Try accessing the list index page.
->>> response = c.get('/lists/',)
->>> response.status_code
-200
-
-
-
-
-Login Required¶
-As described within the installation instructions we already started using -authentification. The easiest way testing it is that we simply load a page -which is restricted to some users only. -This was done using Django’s @login_required Decorator in front of the View. -One of the pages which requires a Login is the Domain Administration, if -we can load the page without a redirect to the Login page, you’re either -already logged in or something went wrong.
->>> response = c.get('/domains/')
->>> print type(response) == HttpResponseRedirect
-True
-
-
-Pages¶
-
-
-
-
-
-
-
-
-
-
-Create a New List¶
-After creating a Domain you should be able to create new Lists. The Button for -doing so is shown on the List index Page which should offer a list of all -available (adverrtised) lists.
->>> response = c.get('/lists/')
->>> response.status_code
-200
->>> "Lists <span>on" in response.content
-True
-The new List creation form is opened by clicking on the Button mentioned above -or accessing the page directly
->>> response = c.get('/lists/new/')
->>> response.status_code
-200
->>> print "Create a new List on" in response.content
-True
-Creating a new List we do need to specify at least the below mentioned items. -Those were entered using some nice GUI Forms which do only show up available -Values or offer you to choose a name which will be checked during validation. -We’re now submitting the form using a POST request and get redirected to -the List Index Page
->>> response = c.post('/lists/new/',
-... {"listname": "new_list1",
-... "mail_host": "mail.example.com",
-... "list_owner": "james@example.com",
-... "description": "doctest testing list",
-... "advertised": "True",
-... "languages": "English (USA)"})
->>> print type(response) == HttpResponseRedirect
-True
-As List index is an overview of all advertised Lists and we’ve choosen to -do so we should now see our new List within the overview. HTTP_HOST is added -as META Data for the request because we do only want to see Domains which -belong to the example.com web_host
->>> response = c.get('/lists/',HTTP_HOST='example.com')
->>> response.status_code
-200
->>> "New_list1" in response.content
-True
-
-
-
-
-List Summary¶
-List summary is a dashboard for each List. It does have Links to the most -useful functions which are only related to that Domain. These include the -Values mentioned below. _(function) is used to Translate these to you local -language.
->>> response = c.get('/lists/new_list1%40mail.example.com/',)
->>> response.status_code
-200
->>> _("Subscribe") in response.content
-True
->>> _("Archives") in response.content
-True
->>> _("Edit Options") in response.content
-True
->>> _("Unsubscribe") in response.content
-True
-
-
-
-
-
-
-
-
-
-
-
-
-Subscriptions¶
-The Subscriptions form is found on the below URL. Last part of the Url is one -of [None,’subscribe’,’unsubscribe’]
->>> url = '/subscriptions/new_list1%40mail.example.com/subscribe'
->>> response = c.get(url)
->>> response.status_code
-200
-Forms will be prefilled with the Users Email if so. is logged in.
->>> "james@example.com" in response.content
-True
-Now we can subscribe James and Katie and check that we get redirected to List Summary.
->>> response = c.post(url,
-... {"email": "james@example.com",
-... "real_name": "James Watt",
-... "name": "subscribe",
-... "fqdn_listname": "new_list1@mail.example.com"})
->>> response = c.post(url,
-... {"email": "katie@example.com",
-... "real_name": "Katie Doe",
-... "name": "subscribe",
-... "fqdn_listname": "new_list1@mail.example.com"})
->>> print (_('Subscribed')+' katie@example.com') in response.content
-True
-The logged in user (james@example.com) can now modify his own membership -using a button which is displayed in list_summary.
->>> response = c.get('/lists/new_list1%40mail.example.com/')
->>> "mm_membership" in response.content
-True
-Using the same subscription page we can unsubscribe as well.
->>> response = c.post('/subscriptions/new_list1%40mail.example.com/unsubscribe',
-... {"email": "katie@example.com",
-... "name": "unsubscribe",
-... "fqdn_listname": "new_list1@mail.example.com"})
->>> print (_('Unsubscribed')+' katie@example.com') in response.content
-True
-
-
-
-
-
-
-
-
-Mass Subscribe Users (within settings)¶
-Another page related to Mass Subscriptions will be available to List Owners -as well. This page will allow adding a couple of users to one lists at the -same time.
->>> url = '/subscriptions/new_list1%40mail.example.com/mass_subscribe/'
->>> response = c.get(url)
->>> response.status_code
-200
-Try mass subscribing the users 'liza@example.com‘ and -'george@example.com‘. Each address should be provided on a separate -line so add ‘n’ between the names to indicate that this was done -(we’re on a Linux machine which is why the letter ‘n’ was used and -the double ‘’ instead of a single one is to escape the string -parsing of Python).
->>> url = '/subscriptions/new_list1%40mail.example.com/mass_subscribe/'
->>> response = c.post(url,
-... {"emails": "liza@example.com\ngeorge@example.com"})
-If everything was successful, we shall get a positive response from -the page. We’ll check that this was the case.
->>> print _("The mass subscription was successful.") in response.content
-True
-
-
-
-
-Delete the List¶
-Finally, let’s delete the list. -We start by checking that the list is really there (for reference).
->>> response = c.get('/lists/',HTTP_HOST='example.com')
->>> print "New_list1" in response.content
-True
--
-
- Trying to delete the List we have to confirm this action -
- --
>>> response = c.get('/delete_list/new_list1%40mail.example.com/',) ->>> print "Please confirm" in response.content -True -
- - Confirmed by pressing the button which requests the same page using POST -
- --
>>> response = c.post('/delete_list/new_list1%40mail.example.com/',) -
- - ...and check that it’s been deleted. -
- --
>>> response = c.get('/lists/',HTTP_HOST='example.com') ->>> print "new_list1%40example.com" in response.content -False -
-
-
-Finishing Test¶
--
-
- Don’t forget to remove the test object after testing all functions -
- --
>>> teardown_mm(testobject) -
-
-
-Running the tests explained above.¶
-We’ve added our own test-suite to the Django App which will be executed together with the Django Test. Last thing you should do is running these tests. If they fail you did something wrong, if they succeed you can enjoy the site.
-Run the following in the Site Directory
-----$ python manage.py test -
-
-Note
-Please be aware that we want to run a development instance of mailman you need to stop the stable one first and the tests will open it’s own mailman temporily.
-
-
-Accessing the REST Client for Testing¶
-If you want to access the Functions, which we use in the views, directly feel free to run the following block of code within a Shell which does have it’s current Directory within the Django Site Directory.
-----from settings import API_USER, API_PASS -from mailman.client import Client -c = Client('http://localhost:8001/3.0', API_USER, API_PASS) -#DEBUG: Python Session -
\ - Sort by:\ - best rated\ - newest\ - oldest\ -
\ -\ -
Add a comment\ - (markup):
\ -