collective.atspreadsheet

by Izhar Firdaus — last modified Feb 16, 2011 02:15 AM

Spreadsheet content type for Plone

Project Description

Change history

Changelog

1.0a2 (2010-03-29)
  • added image files for the JQueryUI of spreadsheet
  • added new content type : CSVSpreadsheet (displays CSV file as spreadsheet)
1.0a1 (2010-03-29)
  • Initial product

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

>>> browser.open(portal_url)

We have the login portlet, so let's use that.

>>> 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 test that we are still on the portal front page:

>>> browser.url == portal_url
True

And we ensure that we get the friendly logged-in message:

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

-- extra stuff goes here -- The CSVSpreadsheet content type ===============================

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

Adding a new CSVSpreadsheet content item

System Message: WARNING/2 (<string>, line 100)

Title underline too short.

Adding a new CSVSpreadsheet 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 'CSVSpreadsheet' and click the 'Add' button to get to the add form.

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

Now we fill the form and submit it.

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

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

Updating an existing CSVSpreadsheet content item

System Message: WARNING/2 (<string>, line 124)

Title underline too short.

Updating an existing CSVSpreadsheet 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 CSVSpreadsheet Sample'
>>> browser.getControl('Save').click()

We check that the changes were applied.

>>> 'Changes saved' in browser.contents
True
>>> 'New CSVSpreadsheet Sample' in browser.contents
True
Removing a/an CSVSpreadsheet content item

System Message: WARNING/2 (<string>, line 140)

Title underline too short.

Removing a/an CSVSpreadsheet content item
--------------------------------

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

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

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

>>> browser.getLink('Contents').click()
>>> browser.getControl('New CSVSpreadsheet 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 CSVSpreadsheet Sample' tab.

>>> browser.open(portal_url)
>>> 'New CSVSpreadsheet Sample' in browser.contents
False
Adding a new CSVSpreadsheet content item as contributor

System Message: WARNING/2 (<string>, line 170)

Title underline too short.

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

Not only site managers are allowed to add CSVSpreadsheet 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)
>>> 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 'CSVSpreadsheet' and click the 'Add' button to get to the add form.

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

Now we fill the form and submit it.

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

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

Finally, let's login back as manager.

>>> browser.getLink('Log out').click()
>>> browser.open(portal_url)
>>> 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 Spreadsheet content type

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

Adding a new Spreadsheet 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 'Spreadsheet' and click the 'Add' button to get to the add form.

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

Now we fill the form and submit it.

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

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

Updating an existing Spreadsheet 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 Spreadsheet Sample'
>>> browser.getControl('Save').click()

We check that the changes were applied.

>>> 'Changes saved' in browser.contents
True
>>> 'New Spreadsheet Sample' in browser.contents
True
Removing a/an Spreadsheet content item

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

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

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

>>> browser.getLink('Contents').click()
>>> browser.getControl('New Spreadsheet 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 Spreadsheet Sample' tab.

>>> browser.open(portal_url)
>>> 'New Spreadsheet Sample' in browser.contents
False
Adding a new Spreadsheet content item as contributor

Not only site managers are allowed to add Spreadsheet 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)
>>> 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 'Spreadsheet' and click the 'Add' button to get to the add form.

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

Now we fill the form and submit it.

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

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

Finally, let's login back as manager.

>>> browser.getLink('Log out').click()
>>> browser.open(portal_url)
>>> 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

"Izhar Firdaus <izhar _at_ inigo-tech.com>", Author

Current Release

No stable release available yet.

All Releases

Version Released Description Compatibility Licenses Status
1.0a2 More about this release… alpha

Comments (0)