org.alfresco.util.test.junitrules

Class RunAsFullyAuthenticatedRule

java.lang.Object

org.alfresco.util.test.junitrules.RunAsFullyAuthenticatedRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class RunAsFullyAuthenticatedRule
extends java.lang.Object
implements org.junit.rules.TestRule

This JUnit rule can be used to make test methods run as a particular user. A username can be provided on construction to the rule and then all @Test methods will be run as that user.

Furthermore, if an individual test method is annotated like this @RunAsUser(userName="John") than that method (and only that method) will be run as "John".

Example usage:

 public class YourTestClass
 {
     @ClassRule public static final ApplicationContextInit APP_CONTEXT_RULE = new ApplicationContextInit();
     @Rule public RunAsFullyAuthenticatedRule runAsGuidPerson = new RunAsFullyAuthenticatedRule("NeilM");
     
     @Test public void doSomething() throws Exception
     {
         // This will run as NeilM
     }
     
     @Test @RunAsUser(userName="DaveC") public void doSomething() throws Exception
     {
         // This will run as DaveC
     }
 }
 

Since:

Odin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RunAsFullyAuthenticatedRule.RunAsUser This annotation can be used to mark an individual Test method for running as a named user.

Constructor Summary

Constructors

Constructor and Description
RunAsFullyAuthenticatedRule() This constructs a rule where there is no specified user to run as.
RunAsFullyAuthenticatedRule(AlfrescoPerson personRule)
RunAsFullyAuthenticatedRule(java.lang.String userName)

Method Summary

Methods

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
java.lang.String	getUsername() Get the username which test methods will run as.

Methods inherited from class java.lang.Object

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

Constructor Detail

RunAsFullyAuthenticatedRule

public RunAsFullyAuthenticatedRule()

This constructs a rule where there is no specified user to run as. For this to be useful (or legal) a user must be specified on every test method using RunAsFullyAuthenticatedRule.RunAsUser.

RunAsFullyAuthenticatedRule

public RunAsFullyAuthenticatedRule(java.lang.String userName)

Parameters:

userName - the username which all test methods should run as.

RunAsFullyAuthenticatedRule

public RunAsFullyAuthenticatedRule(AlfrescoPerson personRule)

Parameters:

personRule - the rule which will provide the username which all test methods should run as.

Method Detail

getUsername

public java.lang.String getUsername()

Get the username which test methods will run as.

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                      org.junit.runner.Description description)

Specified by:

apply in interface org.junit.rules.TestRule