cs.board 1.0

A simple board to publish official documents in Plone Sites

.. contents::

.. Note!
-----
Update the following URLs to point to your:

- code repository
- bug tracker
- questions/comments feedback mail
(do not set a real mail, to avoid spams)

Or remove it if not used.

- Code repository: http://svn.somewhere.com/...
- Questions and comments to somemailing_list
- Report bugs at http://bug.somewhere.com/..


Change history
**************

Changelog
=========

1.0 (xxxx-xx-xx)
----------------

- Created recipe with ZopeSkel
[""]

Detailed Documentation
**********************

Introduction
============

This is a full-blown functional test. The emphasis here is on testing what
the user may input and see, and the system is largely tested as a black box.
We use PloneTestCase to set up this test as well, so we have a full Plone site
to play with. We *can* inspect the state of the portal, e.g. using
self.portal and self.folder, but it is often frowned upon since you are not
treating the system as a black box. Also, if you, for example, log in or set
roles using calls like self.setRoles(), these are not reflected in the test
browser, which runs as a separate session.

Being a doctest, we can tell a story here.

First, we must perform some setup. We use the testbrowser that is shipped
with Five, as this provides proper Zope 2 integration. Most of the
documentation, though, is in the underlying zope.testbrower package.

>>> from Products.Five.testbrowser import Browser
>>> browser = Browser()
>>> portal_url = self.portal.absolute_url()

The following is useful when writing and debugging testbrowser tests. It lets
us see all error messages in the error_log.

>>> self.portal.error_log._ignored_exceptions = ()

With that in place, we can go to the portal front page and log in. We will
do this using the default user from PloneTestCase:

>>> from Products.PloneTestCase.setup import portal_owner, default_password

Because add-on themes or products may remove or hide the login portlet, this test will use the login form that comes with plone.

>>> browser.open(portal_url + '/login_form')
>>> browser.getControl(name='__ac_name').value = portal_owner
>>> browser.getControl(name='__ac_password').value = default_password
>>> browser.getControl(name='submit').click()

Here, we set the value of the fields on the login form and then simulate a
submit click. We then ensure that we get the friendly logged-in message:

>>> "You are now logged in" in browser.contents
True

Finally, let's return to the front page of our site before continuing

>>> browser.open(portal_url)

-*- extra stuff goes here -*-
The BoardDocument content type
===============================

In this section we are tesing the BoardDocument content type by performing
basic operations like adding, updadating and deleting BoardDocument content
items.

Adding a new BoardDocument content item
--------------------------------

We use the 'Add new' menu to add a new content item.

>>> browser.getLink('Add new').click()

Then we select the type of item we want to add. In this case we select
'BoardDocument' and click the 'Add' button to get to the add form.

>>> browser.getControl('BoardDocument').click()
>>> browser.getControl(name='form.button.Add').click()
>>> 'BoardDocument' in browser.contents
True

Now we fill the form and submit it.

>>> browser.getControl(name='title').value = 'BoardDocument Sample'
>>> browser.getControl('Save').click()
>>> 'Changes saved' in browser.contents
True

And we are done! We added a new 'BoardDocument' content item to the portal.

Updating an existing BoardDocument content item
---------------------------------------

Let's click on the 'edit' tab and update the object attribute values.

>>> browser.getLink('Edit').click()
>>> browser.getControl(name='title').value = 'New BoardDocument Sample'
>>> browser.getControl('Save').click()

We check that the changes were applied.

>>> 'Changes saved' in browser.contents
True
>>> 'New BoardDocument Sample' in browser.contents
True

Removing a/an BoardDocument content item
--------------------------------

If we go to the home page, we can see a tab with the 'New BoardDocument
Sample' title in the global navigation tabs.

>>> browser.open(portal_url)
>>> 'New BoardDocument Sample' in browser.contents
True

Now we are going to delete the 'New BoardDocument Sample' object. First we
go to the contents tab and select the 'New BoardDocument Sample' for
deletion.

>>> browser.getLink('Contents').click()
>>> browser.getControl('New BoardDocument Sample').click()

We click on the 'Delete' button.

>>> browser.getControl('Delete').click()
>>> 'Item(s) deleted' in browser.contents
True

So, if we go back to the home page, there is no longer a 'New BoardDocument
Sample' tab.

>>> browser.open(portal_url)
>>> 'New BoardDocument Sample' in browser.contents
False

Adding a new BoardDocument content item as contributor
------------------------------------------------

Not only site managers are allowed to add BoardDocument content items, but
also site contributors.

Let's logout and then login as 'contributor', a portal member that has the
contributor role assigned.

>>> browser.getLink('Log out').click()
>>> browser.open(portal_url + '/login_form')
>>> browser.getControl(name='__ac_name').value = 'contributor'
>>> browser.getControl(name='__ac_password').value = default_password
>>> browser.getControl(name='submit').click()
>>> browser.open(portal_url)

We use the 'Add new' menu to add a new content item.

>>> browser.getLink('Add new').click()

We select 'BoardDocument' and click the 'Add' button to get to the add form.

>>> browser.getControl('BoardDocument').click()
>>> browser.getControl(name='form.button.Add').click()
>>> 'BoardDocument' in browser.contents
True

Now we fill the form and submit it.

>>> browser.getControl(name='title').value = 'BoardDocument Sample'
>>> browser.getControl('Save').click()
>>> 'Changes saved' in browser.contents
True

Done! We added a new BoardDocument content item logged in as contributor.

Finally, let's login back as manager.

>>> browser.getLink('Log out').click()
>>> browser.open(portal_url + '/login_form')
>>> browser.getControl(name='__ac_name').value = portal_owner
>>> browser.getControl(name='__ac_password').value = default_password
>>> browser.getControl(name='submit').click()
>>> browser.open(portal_url)


The Board content type
===============================

In this section we are tesing the Board content type by performing
basic operations like adding, updadating and deleting Board content
items.

Adding a new Board content item
--------------------------------

We use the 'Add new' menu to add a new content item.

>>> browser.getLink('Add new').click()

Then we select the type of item we want to add. In this case we select
'Board' and click the 'Add' button to get to the add form.

>>> browser.getControl('Board').click()
>>> browser.getControl(name='form.button.Add').click()
>>> 'Board' in browser.contents
True

Now we fill the form and submit it.

>>> browser.getControl(name='title').value = 'Board Sample'
>>> browser.getControl('Save').click()
>>> 'Changes saved' in browser.contents
True

And we are done! We added a new 'Board' content item to the portal.

Updating an existing Board content item
---------------------------------------

Let's click on the 'edit' tab and update the object attribute values.

>>> browser.getLink('Edit').click()
>>> browser.getControl(name='title').value = 'New Board Sample'
>>> browser.getControl('Save').click()

We check that the changes were applied.

>>> 'Changes saved' in browser.contents
True
>>> 'New Board Sample' in browser.contents
True

Removing a/an Board content item
--------------------------------

If we go to the home page, we can see a tab with the 'New Board
Sample' title in the global navigation tabs.

>>> browser.open(portal_url)
>>> 'New Board Sample' in browser.contents
True

Now we are going to delete the 'New Board Sample' object. First we
go to the contents tab and select the 'New Board Sample' for
deletion.

>>> browser.getLink('Contents').click()
>>> browser.getControl('New Board Sample').click()

We click on the 'Delete' button.

>>> browser.getControl('Delete').click()
>>> 'Item(s) deleted' in browser.contents
True

So, if we go back to the home page, there is no longer a 'New Board
Sample' tab.

>>> browser.open(portal_url)
>>> 'New Board Sample' in browser.contents
False

Adding a new Board content item as contributor
------------------------------------------------

Not only site managers are allowed to add Board content items, but
also site contributors.

Let's logout and then login as 'contributor', a portal member that has the
contributor role assigned.

>>> browser.getLink('Log out').click()
>>> browser.open(portal_url + '/login_form')
>>> browser.getControl(name='__ac_name').value = 'contributor'
>>> browser.getControl(name='__ac_password').value = default_password
>>> browser.getControl(name='submit').click()
>>> browser.open(portal_url)

We use the 'Add new' menu to add a new content item.

>>> browser.getLink('Add new').click()

We select 'Board' and click the 'Add' button to get to the add form.

>>> browser.getControl('Board').click()
>>> browser.getControl(name='form.button.Add').click()
>>> 'Board' in browser.contents
True

Now we fill the form and submit it.

>>> browser.getControl(name='title').value = 'Board Sample'
>>> browser.getControl('Save').click()
>>> 'Changes saved' in browser.contents
True

Done! We added a new Board content item logged in as contributor.

Finally, let's login back as manager.

>>> browser.getLink('Log out').click()
>>> browser.open(portal_url + '/login_form')
>>> browser.getControl(name='__ac_name').value = portal_owner
>>> browser.getControl(name='__ac_password').value = default_password
>>> browser.getControl(name='submit').click()
>>> browser.open(portal_url)




Contributors
************

"", Author


Download
********