Liferay is a Gartner Magic Quadrant Leader for the Sixth Year! Find out why

JUnit

Tags: liferay junit

Writing JUnits #

When writing JUnits for Liferay, it is important to remember that Liferay is a server platform that leverages many technologies and introduces many levels of abstraction to prevent clashing of classloaders and other things of that sort. Most JUnits will need to ensure that authentication is enabled and all the services (especially Spring) is properly initialized. This is what

com.liferay.portal.service.ServiceTestUtil
is for. It is therefore good practice, whether it be in your TestCase or your TestSetup, to have the following:

	public void setUp() {
		ServiceTestUtil.initServices();
		ServiceTestUtil.initPermissions();
	}
	...
	public void tearDown() {
		ServiceTestUtil.destroyServices();
	}

Running portal-impl JUnits #

Two files need to be configured. In

<portal>/portal-impl/test/portal-test.properties
, configure your database credentials and, for some operating systems (e.g., OS X), you need to specify something for
liferay.home=
. Update
<portal>/portal-impl/test/test-portal-impl.properties
with appropriate values for companyId, userId and password.

To run a specific suite or test, go to your command prompt and, while in the portal-impl directory, type:

ant test-class -Dclass=MiscTestSuite

This works for both test suites and individual test classes as well:

ant test-class -Dclass=XmlRpcParserTest

Debugging JUnit tests #

If you want to debug your code while executing Junit tests in Liferay, you have to follow these steps:

1. Add this line to your build.<username>.properties file:

junit.debug=true

2. Launch your test as described in the previous section. You will now see a message "Listening at port XXXX"

3. In your IDE, create a socket listening to that port. For example, in IntellIJ:

  • Open Run/Debug configurations
  • Select Remote and click on the Add Icon.
  • Enter a name for your new socket (e.g. TestSocket), fill in the host and the port and click OK
  • Now you can see your new Socket at the Run/Debug configurations list.

4. Select your socket as if it were your server and start it in debug mode

At this point, the code execution will stop at the breakpoints you have defined

Other #

  • JUnits in Plugins does not seem to work (See LEP-6806)
0 Attachments
33481 Views
Average (0 Votes)
The average rating is 0.0 stars out of 5.
Comments
Threaded Replies Author Date
Hi Ganesh, This article should be expanded to... Jorge Ferrer July 27, 2008 9:19 AM
Sure Jorge. This is just the starting phase.... Ganesh Ram July 27, 2008 11:11 PM
Is there any way to have these kind of tests in... Alex Wallace September 30, 2008 2:39 PM
Is it work in liferay portal 5.2.3. I can't run... GoreX GoreX August 12, 2009 10:55 AM
There is no such ServiceTestUtil either in the... Adam Victor Nazareth Brandizzi April 30, 2010 8:22 AM
I have de same problem, how do a can use Junit... Joaquin Cabal June 3, 2010 2:04 PM
Bill Gates would be so proud... Jakub Liska August 27, 2011 2:29 PM
Hi, I want to create JUnits to test my... Jaime L. López Carratalá November 15, 2011 4:18 AM
Even having the ServiceTestUtil class available... Dirk Ulrich December 4, 2011 11:50 PM
Dear all, More information, please refer to: ... P.C. SUN February 22, 2012 10:28 PM
http://www.liferay.com/community/wiki/-/wiki/Ma... P.C. SUN February 22, 2012 10:30 PM

Hi Ganesh,

This article should be expanded to be really useful
Posted on 7/27/08 9:19 AM.
Sure Jorge. This is just the starting phase. Will surely expand this.

Thanks,
Ganesh
Posted on 7/27/08 11:11 PM in reply to Jorge Ferrer.
Is there any way to have these kind of tests in an ext environment for custom services/code?
Posted on 9/30/08 2:39 PM.
Is it work in liferay portal 5.2.3.
I can't run the tests, beacuse it's connection refused. I created the user the database and all privileges in mysql database.
Posted on 8/12/09 10:55 AM.
There is no such ServiceTestUtil either in the sources of Liferay 5.2.3 or in the compiled Liferay. Where can I find it? Is there another way to write tests for new Liferay portlets?
Posted on 4/30/10 8:22 AM.
I have de same problem, how do a can use Junit for services in liferay 5.2.3?
Posted on 6/3/10 2:04 PM in reply to Adam Victor Brandizzi.
Bill Gates would be so proud...
Posted on 8/27/11 2:29 PM in reply to Joaquin Cabal.
Hi, I want to create JUnits to test my portlets, but in the EE I can't find the ServiceTestUtil or the base test classes, how can I write junit test in EE?
Posted on 11/15/11 4:18 AM in reply to Jakub Liska.
Even having the ServiceTestUtil class available the description above is not sufficient enough to get unit test work.
A comprehensive guidance of how to set up the test environment would be highly appreciated.
Posted on 12/4/11 11:50 PM.
Dear all,

More information, please refer to:

http://www.liferay.com/community/wiki/-/wiki/Main/How+to+use+JUnit+to+test+servi­ce+in+portlets
Posted on 2/22/12 10:28 PM in reply to Dirk Ulrich.
http://www.liferay.com/community/wiki/-/wiki/Main/How+to+use+JUnit+to+test+servi­ce+in+portlets
Posted on 2/22/12 10:30 PM in reply to P.C. SUN.