com.jalios.jcms.test

Class JcmsTestCaseUtil

java.lang.Object

com.jalios.jcms.test.JcmsTestCaseUtil

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public abstract class JcmsTestCaseUtil
extends java.lang.Object
implements JcmsConstants

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	A_VERY_LONG_TEXT
static long	ASYNC_TEST__ITERATION_WAIT_TIME
static long	ASYNC_TEST__MAX_ITERATION
static long	ASYNC_TEST__MAX_WAIT_TIME_BEFORE_FAILURE

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, REVISION, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

Constructors

Constructor and Description
JcmsTestCaseUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Set<Group>	addReadRights(Publication pub, Group... groups) Convenient method to add read right Groups on given publication.
static java.util.Set<Member>	addReadRights(Publication pub, Member... members) Convenient method to add read right Members on given publication.
static void	beginTransaction()
static void	commitTransaction()
static generated.Article	createArticle(Member writer, Workspace ws, boolean deleteOnTearDown)
static DBFileDocument	createDBFileDocument(Member writer, Workspace ws, java.lang.String title, java.lang.String filename)
static DBMember	createDBMember(java.lang.String name, boolean deleteOnTearDown, Group... groups)
static java.lang.String	createFile(java.lang.String filename)
static FileDocument	createFileDocument(Member writer, Workspace ws, java.lang.String title, java.lang.String filename)
static Member	createMember(java.lang.String name, boolean deleteOnTearDown, Group... groups)
static generated.SmallNews	createSmallNews(Member writer, Workspace ws, boolean deleteOnTearDown)
static void	createWorkspace(Workspace workspace) Utility method to create the given Workspace by admin Member.
static void	createWorkspace(Workspace workspace, Member author) Utility method to create the given Workspace by admin Member.
static java.lang.String	dataToDebugString(Data data) Produces output like: [(Clazz' simple name) {data.toString()} (id)]
static void	deleteData(Data... array)
static void	deleteData(java.lang.String... ids)
static void	deleteOnTearDown(Data data)
static void	deleteOnTearDown(Workspace ws, java.util.Set<Data> initialDataSet) Deletes on tear down the workspace, and all its Datas, but not those contained in optional initialDataSet. The initialDataSet should be initialized before the Workspace was created, using for example :
static java.lang.Object	deserialize(java.io.File file) Deserialize the given file into a new object which is returned.
static void	disableJSync() Disable JSync in Junit prop.
static void	disableLdap() Disable LDAP in Junit prop.
static void	enableJSync() Enable JSync in Junit prop.
static void	enableLdap() Enable LDAP in Junit prop.
static generated.Article	getArticle(Member writer, Workspace ws)
static DBFileDocument	getDBFileDocument(Member writer, Workspace ws, java.lang.String title, java.lang.String filename)
static FileDocument	getFileDocument(Member writer, Workspace ws, java.lang.String title, java.lang.String filename)
static javax.servlet.http.HttpServletRequest	getMockHttpServletRequest() Convenient Method to return a new instance of a fake http servlet request.
static javax.servlet.http.HttpServletRequest	getMockHttpServletRequest(javax.servlet.http.HttpSession session) Convenient Method to return a new instance of a fake http servlet request using the specified mock session
static javax.servlet.http.HttpServletResponse	getMockHttpServletResponse() Convenient Method to return a new instance of a fake http servlet response.
static javax.servlet.http.HttpServletResponse	getMockHttpServletResponse(javax.servlet.http.HttpSession session) Convenient Method to return a new instance of a fake http servlet response using the specified mock session
static javax.servlet.http.HttpSession	getMockHttpSession() Convenient Method to return a new instance of a fake http session.
static JcmsJspContext	getMockJcmsJspContext() Retrieve a mock explorer JcmsJspContext.
static JcmsJspContext	getMockJcmsJspContext(javax.servlet.http.HttpServletRequest request) Retrieve a mock explorer JcmsJspContext based on the specified request
static javax.servlet.ServletContext	getMockServletContext() Convenient Method to return the fake servlet context used for this JCMS test.
protected static generated.SmallNews	getSmallNews(Member writer, Workspace ws, boolean insertDateInContent)
static java.util.Set<Data>	getWorkspaceDeleteOnTearDownSet(Workspace ws, java.util.Set<Data> initialDataSet) Returns a collection of Datas (bound to the Workspace) that have been created since the workspace creation.
static boolean	ignoreUnstableTest()
static void	logC3P0Data() Retrieve current C3P0 information from JXM and log them.
static void	publishPublicationTransaction(java.lang.String pubId, Member opAuthor) Delegates to updatePstatusTransaction(String, Member, int) using pstatus WorkflowConstants.PUBLISHED_PSTATUS.
static void	restoreAuthenticationRequired() Restores property "channel.is-authentication-required".
static void	restoreIncomingMail() Restores property "mail.incoming.enabled".
static void	restoreProperties(java.util.Collection<java.lang.String> names) Restores given properties represented by their names.
static void	restoreProperties(JProperties properties) Restores given JProperties.
static void	restoreProperty(java.lang.String name) Restores given property.
static void	restoreReadRightsGroups(Publication pub, java.util.Collection<Group> initialAuthorizedGroups)
static void	restoreReadRightsMembers(Publication pub, java.util.Collection<Member> initialAuthorizedMembers)
static java.io.File	serialize(java.lang.Object obj) Serialize the given object into a temp file and return this file.
static void	setAuthenticationRequired(boolean isAuthRequired) Sets property "channel.is-authentication-required" to isAuthRequired.
static void	setIncomingMail(boolean enabled) Sets property "mail.incoming.enabled" to enabled.
static void	setProperties(JProperties properties) Sets given JProperties.
static void	setProperties(java.util.Map<java.lang.String,java.lang.String> map)
static void	setProperty(java.lang.String name, java.lang.String value)
static void	sleep(long millis)
static void	updatePstatusTransaction(java.lang.String pubId, Member opAuthor, int newPstatus) Checks and performs update the publication (makes an update instance) with given pstatus.
static void	updateWorkspaceTypeWorkflow(Workspace ws, java.lang.Class<? extends Data> typeClass, java.lang.Object workflowToUse) An utility method to update the given Workspace, with the chosen Workflow associated to the given Type.
static void	updateWorkspaceTypeWorkflow(Workspace ws, java.util.HashMap<java.lang.Class<?>,java.lang.Object> subTypeMap) An utility method to update the given Workspace typeMap.
static void	waitForAlarm(long time, AlarmManager alarmMgr, boolean reallyWaitFor, java.lang.String logPrefix)
static void	waitForDBTimePrecision() wait 1 ms if the DB support time with ms precision, otherwise 1 s
static void	waitForLuceneIndexation(boolean checkFileContentIndexing, Publication... pubs)
static void	waitForLuceneIndexation(Publication... pubs) Wait for the specified publication(s) to be indexed in all the lucene publication index in its current version as returned by Publication.getVersionString().
static void	waitForMemberLuceneIndexation(Member... mbrs) Wait for the specified Members(s) to be indexed in the lucene member index in its current mdate as returned by BasicStorable.getMdate().
static void	waitForMemberLuceneIndexation(java.lang.String... ids) Wait for the specified Members(s) to be indexed in the lucene member index in its current mdate as returned by BasicStorable.getMdate().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

A_VERY_LONG_TEXT

public static java.lang.String A_VERY_LONG_TEXT

ASYNC_TEST__MAX_WAIT_TIME_BEFORE_FAILURE

public static long ASYNC_TEST__MAX_WAIT_TIME_BEFORE_FAILURE

ASYNC_TEST__ITERATION_WAIT_TIME

public static long ASYNC_TEST__ITERATION_WAIT_TIME

ASYNC_TEST__MAX_ITERATION

public static long ASYNC_TEST__MAX_ITERATION

Constructor Detail

JcmsTestCaseUtil

public JcmsTestCaseUtil()

Method Detail

getMockServletContext

public static javax.servlet.ServletContext getMockServletContext()

Convenient Method to return the fake servlet context used for this JCMS test.

Returns:

a ServletContext

See Also:

MockServletContext

getMockHttpSession

public static javax.servlet.http.HttpSession getMockHttpSession()

Convenient Method to return a new instance of a fake http session.

Returns:

a HttpSession

See Also:

HttpSession

getMockHttpServletRequest

public static javax.servlet.http.HttpServletRequest getMockHttpServletRequest()

Convenient Method to return a new instance of a fake http servlet request.

Returns:

a HttpServletRequest

See Also:

MockHttpServletRequest

getMockHttpServletRequest

public static javax.servlet.http.HttpServletRequest getMockHttpServletRequest(javax.servlet.http.HttpSession session)

Convenient Method to return a new instance of a fake http servlet request using the specified mock session

Parameters:

session - the session

Returns:

a HttpServletRequest

See Also:

MockHttpServletRequest

getMockHttpServletResponse

public static javax.servlet.http.HttpServletResponse getMockHttpServletResponse()

Convenient Method to return a new instance of a fake http servlet response.

Returns:

a HttpServletResponse

See Also:

MockHttpServletResponse

getMockHttpServletResponse

public static javax.servlet.http.HttpServletResponse getMockHttpServletResponse(javax.servlet.http.HttpSession session)

Convenient Method to return a new instance of a fake http servlet response using the specified mock session

Parameters:

session - the session

Returns:

a HttpServletResponse

See Also:

MockHttpServletResponse

getMockJcmsJspContext

public static JcmsJspContext getMockJcmsJspContext()

Retrieve a mock explorer JcmsJspContext.

Returns:

a new instance of JcmsJspContext

Since:

jcms-5.7.3

getMockJcmsJspContext

public static JcmsJspContext getMockJcmsJspContext(javax.servlet.http.HttpServletRequest request)

Retrieve a mock explorer JcmsJspContext based on the specified request

Parameters:

request - the mock request to use, if null a new mock request is created

Returns:

a new instance of JcmsJspContext

Since:

jcms-5.7.3

serialize

public static java.io.File serialize(java.lang.Object obj)
                              throws java.lang.Exception

Serialize the given object into a temp file and return this file.

Parameters:

obj - the Object to be serialized

Returns:

the file where the object has been serialized.

Throws:

java.lang.Exception - if an error occurs

deserialize

public static java.lang.Object deserialize(java.io.File file)
                                    throws java.lang.Exception

Deserialize the given file into a new object which is returned.

Parameters:

file - the file

Returns:

the object

Throws:

java.lang.Exception - if an error occurs

beginTransaction

public static void beginTransaction()

commitTransaction

public static void commitTransaction()

deleteData

public static void deleteData(Data... array)

deleteData

public static void deleteData(java.lang.String... ids)

deleteOnTearDown

public static void deleteOnTearDown(Data data)

deleteOnTearDown

public static void deleteOnTearDown(Workspace ws,
                    java.util.Set<Data> initialDataSet)

Deletes on tear down the workspace, and all its Datas, but not those contained in optional initialDataSet.
The initialDataSet should be initialized before the Workspace was created, using for example :

 Set<Data> initialDataSet = channel.getAllDataSet();
 

Then, the workspace is created, using :

 Workspace workspace = new Workspace();
 ...
 workspace.performCreate(admin);
 

Then you might want to delete it on tear down, using :

 deleteOnTearDown(workspace, initialDataSet);
 

Deleted datas will be :

• all the workspace's publications
• the following datas that are not in initialDataSet :
• the workspace's categories, and their CategoryRights
• the workspace's groups

Parameters:

ws - the workspace to delete.

initialDataSet - a Set of Datas not to delete, since already existing before the start of the test

Since:

jcms-7.1.3, jcms-8.0.0

getWorkspaceDeleteOnTearDownSet

public static java.util.Set<Data> getWorkspaceDeleteOnTearDownSet(Workspace ws,
                                                  java.util.Set<Data> initialDataSet)

Returns a collection of Datas (bound to the Workspace) that have been created since the workspace creation.

Helper method to retrieve datas to delete when the Workspace needs to be deleted.

Parameters:

ws - the workspace to retrieve its created Data to delete

initialDataSet - the collection of existing datas before workspace has been created.

Returns:

datas bound to the workspace, and that have been created since the workspace creation.

Since:

jcms-9.0.3

sleep

public static void sleep(long millis)

Parameters:

millis - the length of time to sleep in milliseconds.

waitForAlarm

public static void waitForAlarm(long time,
                AlarmManager alarmMgr,
                boolean reallyWaitFor,
                java.lang.String logPrefix)

waitForLuceneIndexation

public static void waitForLuceneIndexation(Publication... pubs)

Wait for the specified publication(s) to be indexed in all the lucene publication index in its current version as returned by Publication.getVersionString().

For this method to work properly with DBData, it must be invoked in a different transaction than the transaction in which the create/update operation of the DBData was performed. Indeed indexing is trigger by the PublicationSearchEngineListener during the transaction commit, thus indexing will have been performed only after transaction end.

If needed, several verification for the maximum duration specified ASYNC_TEST__MAX_WAIT_TIME_BEFORE_FAILURE.

Parameters:

pubs - the publications to found in index.

waitForLuceneIndexation

public static void waitForLuceneIndexation(boolean checkFileContentIndexing,
                           Publication... pubs)

waitForMemberLuceneIndexation

public static void waitForMemberLuceneIndexation(java.lang.String... ids)
                                          throws java.lang.Exception

Wait for the specified Members(s) to be indexed in the lucene member index in its current mdate as returned by BasicStorable.getMdate().

For this method to work properly with DBMember, it must be invoked in a different transaction than the transaction in which the create/update operation of the DBMember was performed. Indeed indexing is trigger by the MemberSearchEngineListener during the transaction commit, thus indexing will have been performed only after transaction end.

If needed, several verification for the maximum duration specified ASYNC_TEST__MAX_WAIT_TIME_BEFORE_FAILURE.

Parameters:

ids - the ids of Member to found in index.

Throws:

java.lang.Exception - if index could not be read or member could not be found

waitForMemberLuceneIndexation

public static void waitForMemberLuceneIndexation(Member... mbrs)
                                          throws java.lang.Exception

Wait for the specified Members(s) to be indexed in the lucene member index in its current mdate as returned by BasicStorable.getMdate().

For this method to work properly with DBMember, it must be invoked in a different transaction than the transaction in which the create/update operation of the DBMember was performed. Indeed indexing is trigger by the MemberSearchEngineListener during the transaction commit, thus indexing will have been performed only after transaction end.

If needed, several verification for the maximum duration specified ASYNC_TEST__MAX_WAIT_TIME_BEFORE_FAILURE.

Parameters:

mbrs - the Members to found in index.

Throws:

java.lang.Exception - if index could not be read or member could not be found

logC3P0Data

public static void logC3P0Data()

Retrieve current C3P0 information from JXM and log them.

dataToDebugString

public static java.lang.String dataToDebugString(Data data)

Produces output like:
[(Clazz' simple name) {data.toString()} (id)]

Parameters:

data - the data to get the debug string.

Returns:

the debugging String of the data.

Since:

jcms-7.1.3, jcms-8.0.0

waitForDBTimePrecision

public static void waitForDBTimePrecision()

wait 1 ms if the DB support time with ms precision, otherwise 1 s

setProperty

public static void setProperty(java.lang.String name,
               java.lang.String value)

Parameters:

name - the property name to set

value - the property value to set

Since:

jcms-8.0.3, jcms-9.0.0

See Also:

setProperties(JProperties)

setProperties

public static void setProperties(java.util.Map<java.lang.String,java.lang.String> map)

Parameters:

map - the map of properties to set

Since:

jcms-8.0.3, jcms-9.0.0

See Also:

setProperties(JProperties)

setProperties

public static void setProperties(JProperties properties)

Sets given JProperties.

First call of this method will backup propertys current value, for automatic restore in test tear down.

Example:

 // How to disabled channel mails
 setProperty("mail.enabled", "false");
 
 // How to update several properties
 JProperties props = new JProperties();
 props.put("my-first-property", "true");
 props.put("my-second-property", "foo");
 setProperties(props);
 
 // How to restore properties (If not done, it will be restored automatically during tearDown())
 // Using a single String
 restoreProperty("mail.enabled"); // Restore one property
 
 // Using a Collection<String>
 restoreProperties(Util.getArrayList("my-first-property", "my-second-property"); // Restore several properties
 
 // Using a JProperties
 restoreProperties((JProperties) props); // Restore several properties
 

Complete Test Case:
If you had to write a unit test which is only relevant when site authentication is required.
Preparing and restoring the environnement at start and end of each test can be painful.
To make this initialization easier, you can do:

 PrivateSiteTest extends JcmsTestCase {
   @Override
   protected void setUp() throws Exception {
     super.setUp();
     logger.info("Channel authentication required: " + channel.isAuthenticationRequired()); // Prints "false" by default
     setAuthenticationRequired(true);
   }
   
   public void testPrivateSite() {
     assertTrue("The site must be private to run this test...", channel.isAuthenticationRequired());
     ...
   }
   
   private void setAuthenticationRequired(boolean isPrivateSite) {
     setProperty("channel.is-authentication-required", String.valuedOf(isPrivateSite));
   }
 }
 

You may also want to restore initial value during the test:

 PrivateSiteTest extends JcmsTestCase {
   ...
   
   public void testPrivateSite() {
     assertTrue("The site must be private to run this test...", channel.isAuthenticationRequired());
     // ... first test with authentication required
     
     restoreAuthenticationRequired();
     assertFalse("The site must be public to run this test...", channel.isAuthenticationRequired());
     // ... second test with initial authentication required
   }
     
   private void restoreAuthenticationRequired() {
     restoreProperty("channel.is-authentication-required");
   }
 }
 

Implementation details:

• channel.setProperty is called for each property to set
• then, properties.firePropertiesChange() is called one time
• thus, JPropertiesListener will be called.

Parameters:

properties - the JProperties to set

Since:

jcms-8.0.3, jcms-9.0.0

restoreProperty

public static void restoreProperty(java.lang.String name)

Restores given property.

Parameters:

name - the name of property to restore

Since:

jcms-8.0.3, jcms-9.0.0

See Also:

restoreProperties(JProperties)

restoreProperties

public static void restoreProperties(java.util.Collection<java.lang.String> names)

Restores given properties represented by their names.

Parameters:

names - the names of properties to restore

Since:

jcms-8.0.3, jcms-9.0.0

See Also:

restoreProperties(JProperties)

restoreProperties

public static void restoreProperties(JProperties properties)

Restores given JProperties.

Parameters:

properties - the JProperties to restore.

Since:

jcms-8.0.3, jcms-9.0.0

setIncomingMail

public static void setIncomingMail(boolean enabled)

Sets property "mail.incoming.enabled" to enabled.

Parameters:

enabled - the value to set.

Since:

jcms-8.0.3, jcms-9.0.0

restoreIncomingMail

public static void restoreIncomingMail()

Restores property "mail.incoming.enabled".

Since:

jcms-8.0.3, jcms-9.0.0

setAuthenticationRequired

public static void setAuthenticationRequired(boolean isAuthRequired)

Sets property "channel.is-authentication-required" to isAuthRequired.

Parameters:

isAuthRequired - the value to set.

Since:

jcms-8.0.3, jcms-9.0.0

restoreAuthenticationRequired

public static void restoreAuthenticationRequired()

Restores property "channel.is-authentication-required".

Since:

jcms-8.0.3, jcms-9.0.0

enableJSync

public static void enableJSync()

Enable JSync in Junit prop.

Sets property "jsync.enabled" to true.

disableJSync

public static void disableJSync()

Disable JSync in Junit prop.

Sets property "jsync.enabled" to false.

enableLdap

public static void enableLdap()

Enable LDAP in Junit prop.

Sets property "ldap.enabled" to true.

Since:

jcms-9.0.3

disableLdap

public static void disableLdap()

Disable LDAP in Junit prop.

Sets property "ldap.enabled" to false.

Since:

jcms-9.0.3

createWorkspace

public static void createWorkspace(Workspace workspace)

Utility method to create the given Workspace by admin Member.

Manages deleteOnTearDown, and clears the workspace's id if already set.

Use as follow:

 Workspace ws = new Workspace(otherWs);   // Bootstraps a Workspace based on another WS
 ws.setTitle("my test workspace");        // ws customization
 createWorkspace(ws);                     // handles deleteOnTearDown
 

Parameters:

workspace - the workspace to create

Since:

jcms-8.0.3, jcms-9.0.0

createWorkspace

public static void createWorkspace(Workspace workspace,
                   Member author)

Utility method to create the given Workspace by admin Member.

Manages deleteOnTearDown, and clears the workspace's id if already set.

Use as follow:

 Workspace ws = new Workspace(otherWs);   // Bootstraps a Workspace based on another WS
 ws.setTitle("my test workspace");        // ws customization
 createWorkspace(ws, author);             // handles deleteOnTearDown
 

Utility method to create the given Workspace.

Manages deleteOnTearDown.

Parameters:

workspace - the workspace to create

author - the create operation author

Since:

jcms-8.0.3, jcms-9.0.0

createMember

public static Member createMember(java.lang.String name,
                  boolean deleteOnTearDown,
                  Group... groups)

createDBMember

public static DBMember createDBMember(java.lang.String name,
                      boolean deleteOnTearDown,
                      Group... groups)

createFile

public static java.lang.String createFile(java.lang.String filename)

getFileDocument

public static FileDocument getFileDocument(Member writer,
                           Workspace ws,
                           java.lang.String title,
                           java.lang.String filename)

createFileDocument

public static FileDocument createFileDocument(Member writer,
                              Workspace ws,
                              java.lang.String title,
                              java.lang.String filename)

getDBFileDocument

public static DBFileDocument getDBFileDocument(Member writer,
                               Workspace ws,
                               java.lang.String title,
                               java.lang.String filename)

createDBFileDocument

public static DBFileDocument createDBFileDocument(Member writer,
                                  Workspace ws,
                                  java.lang.String title,
                                  java.lang.String filename)

getArticle

public static generated.Article getArticle(Member writer,
                           Workspace ws)

createArticle

public static generated.Article createArticle(Member writer,
                              Workspace ws,
                              boolean deleteOnTearDown)

getSmallNews

protected static generated.SmallNews getSmallNews(Member writer,
                               Workspace ws,
                               boolean insertDateInContent)

createSmallNews

public static generated.SmallNews createSmallNews(Member writer,
                                  Workspace ws,
                                  boolean deleteOnTearDown)

addReadRights

public static java.util.Set<Member> addReadRights(Publication pub,
                                  Member... members)

Convenient method to add read right Members on given publication.

Can be used as follow:

 Set<Member> initialAuthMemberSet = addReadRights(pub, member1, member2); 
 // custom processing here
 // [...]
 // Restore
 restoreReadRightsMembers(pub, initialAuthMemberSet);
 

Parameters:

pub - the pub to add a read right on given Members

members - the member(s) to add in pub's authorizedMemberSet

Returns:

the initial authorizedMemberSet for restore purpose

addReadRights

public static java.util.Set<Group> addReadRights(Publication pub,
                                 Group... groups)

Convenient method to add read right Groups on given publication.

Can be used as follow:

 Set<Group> initialAuthGroupSet = addReadRights(pub, group1, group2); 
 // custom processing here
 // [...]
 // Restore
 restoreReadRightsGroups(pub, initialAuthGroupSet);
 

Parameters:

pub - the pub to add a read right on given Groups

groups - the group(s) to add in pub's authorizedGroupSet

Returns:

the initial authorizedGroupSet for restore purpose

restoreReadRightsMembers

public static void restoreReadRightsMembers(Publication pub,
                            java.util.Collection<Member> initialAuthorizedMembers)

Parameters:

pub - the pub to restore its initial authorizedMemberSet

initialAuthorizedMembers - initial authorized members to restore (typically returned by addReadRights(Publication, Member...))

restoreReadRightsGroups

public static void restoreReadRightsGroups(Publication pub,
                           java.util.Collection<Group> initialAuthorizedGroups)

Parameters:

pub - the pub to restore its initial authorizedGrouSet

initialAuthorizedGroups - initial authorized groups to restore (typically returned by addReadRights(Publication, Group...))

updatePstatusTransaction

public static void updatePstatusTransaction(java.lang.String pubId,
                            Member opAuthor,
                            int newPstatus)

Checks and performs update the publication (makes an update instance) with given pstatus.

If pstatus is WorkflowConstants.PUBLISHED_PSTATUS, and publication's pdate is null, sets a new pdate.

Opens and closes a new transaction.

Parameters:

pubId - the id of publication to udpate its pstatus

opAuthor - the author of operation

newPstatus - the new pstatus to set

Since:

jcms-9.0.5 jcms-10.0.1

See Also:

Publication.updatePstatus(Member, int, String)

publishPublicationTransaction

public static void publishPublicationTransaction(java.lang.String pubId,
                                 Member opAuthor)

Delegates to updatePstatusTransaction(String, Member, int) using pstatus WorkflowConstants.PUBLISHED_PSTATUS.

Parameters:

pubId - the id of publication to udpate its pstatus

opAuthor - the author of operation

Since:

jcms-9.0.5 jcms-10.0.1

See Also:

updatePstatusTransaction(String, Member, int)

ignoreUnstableTest

public static boolean ignoreUnstableTest()

updateWorkspaceTypeWorkflow

public static void updateWorkspaceTypeWorkflow(Workspace ws,
                               java.lang.Class<? extends Data> typeClass,
                               java.lang.Object workflowToUse)

An utility method to update the given Workspace, with the chosen Workflow associated to the given Type.

Note: It is better to make a backup of the Type Workflow in order to restore at the end of the test:

 Object wfBackup = myWs.getTypeMap().get(MyType.class);
 JcmsTestCaseUtil.updateWorkspaceTypeWorkflow(myWs, MyType.class, "");
 // ... (processing)
 JcmsTestCaseUtil.updateWorkspaceTypeWorkflow(myWs, MyType.class, wfBackup);
 

Parameters:

ws - the workspace

typeClass - the class

workflowToUse - the workflow Id. Use an empty string if it is just to activate the type.

updateWorkspaceTypeWorkflow

public static void updateWorkspaceTypeWorkflow(Workspace ws,
                               java.util.HashMap<java.lang.Class<?>,java.lang.Object> subTypeMap)

An utility method to update the given Workspace typeMap.

Note: It is better to make a backup of the Type Workflow in order to restore at the end of the test:

 Object wfBackup = myWs.getTypeMap().get(MyType.class);
 JcmsTestCaseUtil.updateWorkspaceTypeWorkflow(myWs, MyType.class, "");
 // ... (processing)
 JcmsTestCaseUtil.updateWorkspaceTypeWorkflow(myWs, MyType.class, wfBackup);
 

Update given workspace's typeMap with given subset typeMap.

Parameters:

ws - the workspace to apply changes

subTypeMap - the typeMap subset to change