ftw.builder 1.5.2

Auto commit

When having a functional testing layer (plone.app.testing.FunctionalTesting) and doing browser tests it is necessary that the new objects are committed in the ZODB. When using a IntegrationTesting on the other hand it is essential that nothing is comitted, since this would break test isolation.

The session provides the auto_commit option (dislabed by default), which commits to the ZODB after creating an object. Since it is disabled by default you need to enable it in functional test cases.

A default session factory functional_session_factory that enables the auto-commit feature is provided:

def functional_session_factory():
    sess = BuilderSession()
    sess.auto_commit = True
    return sess

You can use set_builder_session_factory to replace the default session factory in functional tests. Make sure to also base your fixture on the BUILDER_LAYER fixture:

from ftw.builder.session import BuilderSession
from ftw.builder.testing import BUILDER_LAYER
from ftw.builder.testing import functional_session_factory
from ftw.builder.testing import set_builder_session_factory
from plone.app.testing import FunctionalTesting
from plone.app.testing import IntegrationTesting
from plone.app.testing import PLONE_FIXTURE
from plone.app.testing import PloneSandboxLayer


class MyPackageLayer(PloneSandboxLayer):
    defaultBases = (PLONE_FIXTURE, BUILDER_LAYER)

MY_PACKAGE_FIXTURE = MyPackageLayer()

MY_PACKAGE_INTEGRATION_TESTING = IntegrationTesting(
    bases=(MY_PACKAGE_FIXTURE, ),
    name="MyPackage:Integration")

MY_PACKAGE_FUNCTIONAL_TESTING = FunctionalTesting(
    bases=(MY_PACKAGE_FIXTURE,
           set_builder_session_factory(functional_session_factory)),
    name="MyPackage:Integration")

Attaching files

The default Archetypes file builder let’s you attach a file or create the file with dummy content. The archetypes image builder provides a real image (1x1 px GIF):

file1 = create(Builder('file')
               .with_dummy_content())

file2 = create(Builder('file')
               .attach_file_containing('File content', name='filename.pdf')

image1 = create(Builder('image')
               .with_dummy_content())

Users builder

There is a “user” builder registered by default.

By default the user is named John Doe:

john = create(Builder('user'))
john.getId() == "john.doe"
john.getProperty('fullname') == "Doe John"
john.getProperty('email') == "john@doe.com"
john.getRoles() == ['Member', 'Authenticated']

Changing the name of the user changes also the userid and the email address. You can also configure all the other necessary things:

folder = create(Builder('folder'))
hugo = create(Builder('user')
              .named('Hugo', 'Boss')
              .with_roles('Contributor')
              .with_roles('Editor', on=folder))

hugo.getId() == 'hugo.boss'
hugo.getProperty('fullname') == 'Boss Hugo'
hugo.getProperty('email') == 'hugo@boss.com'
hugo.getRoles() == ['Contributor', 'Authenticated']
hugo.getRolesInContext(folder) == ['Contributor', 'Authenticated', 'Editor']

Groups builder

The “group” bilder helps you create groups:

folder = create(Builder('folder'))
user = create(Builder('user'))
group = create(Builder('group')
               .titled('Administrators')
               .with_roles('Site Administrator')
               .with_roles('Editor', on=folder)
               .with_members(user))

Creating python builders

Define a simpe builder class for your python object and register them in the builder registry

class PersonBuilder(object):

    def __init__(self, session):
        self.session = session
        self.children_names = []
        self.arguments = {}

    def of_age(self):
        self.arguments['age'] = 18
        return self

    def with_children(self, children_names):
        self.children_names = children_names
        return self

    def having(self, **kwargs):
        self.arguments.update(kwargs)
        return self

    def create(self, **kwargs):
        person = Person(
            self.arguments.get('name'),
            self.arguments.get('age'))

        for name in self.children_names:
            person.add_child(
                create(Builder('person').having(name=name, age=5))
            )

        return person

builder_registry.register('person', PersonBuilder)

Creating Archetypes builders

Use the ArchetypesBuilder base class for creating new Archetypes builders. Set the portal_type and your own methods.

from ftw.builder.archetypes import ArchetypesBuilder
from ftw.builder import builder_registry

class NewsBuilder(ArchetypesBuilder):
    portal_type = 'News Item'

    def containing(self, text):
        self.arguments['text'] = text
        return self

builder_registry.register('news', NewsBuilder)

Creating Dexterity builders

Use the DexterityBuilder base class for creating new Dexterity builders. Set the portal_type and your own methods.

from ftw.builder.dexterity import DexterityBuilder
from ftw.builder import builder_registry

class DocumentBuilder(DexterityBuilder):
    portal_type = 'dexterity.document'

    def with_dummy_content(self):
        self.arguments["file"] = NamedBlobFile(data='Test data', filename='test.doc')
        return self

Events

You can do things before and after creating the object:

class MyBuilder(ArchetypesBuilder):

    def before_create(self):
        super(NewsBuilder, self).before_create()
        do_something()

    def after_create(self):
        do_something()
        super(NewsBuilder, self).after_create()

Overriding existing builders

Sometimes it is necessary to override an existing builder. For re-registering an existing builder you can use the force flag:

builder_registry.register('file', CustomFileBuilder, force=True)