| 1 |
package oauth.signpost; |
| 2 |
|
| 3 |
import static org.junit.Assert.assertEquals; |
| 4 |
import static org.junit.Assert.assertNotNull; |
| 5 |
import static org.junit.Assert.assertTrue; |
| 6 |
import static org.mockito.Matchers.anyObject; |
| 7 |
import static org.mockito.Mockito.verify; |
| 8 |
import static org.mockito.Mockito.when; |
| 9 |
|
| 10 |
import java.io.ByteArrayInputStream; |
| 11 |
import java.io.ByteArrayOutputStream; |
| 12 |
import java.io.ObjectInputStream; |
| 13 |
import java.io.ObjectOutputStream; |
| 14 |
import java.net.URL; |
| 15 |
|
| 16 |
import oauth.signpost.basic.DefaultOAuthConsumer; |
| 17 |
import oauth.signpost.exception.OAuthExpectationFailedException; |
| 18 |
import oauth.signpost.http.HttpParameters; |
| 19 |
import oauth.signpost.http.HttpRequest; |
| 20 |
import oauth.signpost.mocks.OAuthProviderMock; |
| 21 |
|
| 22 |
import org.junit.Before; |
| 23 |
import org.junit.Test; |
| 24 |
import org.junit.runner.RunWith; |
| 25 |
import org.mockito.Mock; |
| 26 |
import org.mockito.MockitoAnnotations; |
| 27 |
import org.mockito.runners.MockitoJUnit44Runner; |
| 28 |
|
| 29 |
@RunWith(MockitoJUnit44Runner.class) |
| 30 |
public abstract class OAuthProviderTest extends SignpostTestBase { |
| 31 |
|
| 32 |
protected OAuthProvider provider; |
| 33 |
|
| 34 |
@Mock |
| 35 |
OAuthConsumer consumerMock; |
| 36 |
|
| 37 |
@Before |
| 38 |
public void prepare() throws Exception { |
| 39 |
|
| 40 |
MockitoAnnotations.initMocks(this); |
| 41 |
|
| 42 |
// init consumer mock |
| 43 |
when(consumerMock.getConsumerKey()).thenReturn(CONSUMER_KEY); |
| 44 |
when(consumerMock.getConsumerSecret()).thenReturn(CONSUMER_SECRET); |
| 45 |
when(consumerMock.getToken()).thenReturn(TOKEN); |
| 46 |
when(consumerMock.getTokenSecret()).thenReturn(TOKEN_SECRET); |
| 47 |
|
| 48 |
provider = buildProvider(REQUEST_TOKEN_ENDPOINT_URL, ACCESS_TOKEN_ENDPOINT_URL, |
| 49 |
AUTHORIZE_WEBSITE_URL, true); |
| 50 |
} |
| 51 |
|
| 52 |
protected abstract OAuthProvider buildProvider(String requestTokenUrl, String accessTokenUrl, |
| 53 |
String websiteUrl, boolean mockConnection) throws Exception; |
| 54 |
|
| 55 |
@Test(expected = OAuthExpectationFailedException.class) |
| 56 |
public void shouldThrowExpectationFailedIfConsumerKeyNotSet() throws Exception { |
| 57 |
provider = buildProvider(REQUEST_TOKEN_ENDPOINT_URL, ACCESS_TOKEN_ENDPOINT_URL, |
| 58 |
AUTHORIZE_WEBSITE_URL, true); |
| 59 |
provider.retrieveRequestToken(new DefaultOAuthConsumer(null, CONSUMER_SECRET), |
| 60 |
REQUEST_TOKEN_ENDPOINT_URL); |
| 61 |
} |
| 62 |
|
| 63 |
@Test(expected = OAuthExpectationFailedException.class) |
| 64 |
public void shouldThrowExpectationFailedIfConsumerSecretNotSet() throws Exception { |
| 65 |
provider = buildProvider(REQUEST_TOKEN_ENDPOINT_URL, ACCESS_TOKEN_ENDPOINT_URL, |
| 66 |
AUTHORIZE_WEBSITE_URL, true); |
| 67 |
provider.retrieveRequestToken(new DefaultOAuthConsumer(CONSUMER_KEY, null), |
| 68 |
REQUEST_TOKEN_ENDPOINT_URL); |
| 69 |
} |
| 70 |
|
| 71 |
@Test |
| 72 |
public void shouldRetrieveRequestTokenAndUpdateConsumer() throws Exception { |
| 73 |
|
| 74 |
String callbackUrl = "http://www.example.com"; |
| 75 |
String result = provider.retrieveRequestToken(consumerMock, callbackUrl); |
| 76 |
|
| 77 |
verify(consumerMock).sign((HttpRequest) anyObject()); |
| 78 |
verify(consumerMock).setTokenWithSecret(TOKEN, TOKEN_SECRET); |
| 79 |
|
| 80 |
assertEquals(AUTHORIZE_WEBSITE_URL + "?" + OAuth.OAUTH_TOKEN + "=" + TOKEN + "&" |
| 81 |
+ OAuth.OAUTH_CALLBACK + "=" + "http%3A%2F%2Fwww.example.com", result); |
| 82 |
} |
| 83 |
|
| 84 |
@Test |
| 85 |
public void shouldRespectCustomQueryParametersInAuthWebsiteUrl() throws Exception { |
| 86 |
provider = buildProvider(REQUEST_TOKEN_ENDPOINT_URL, ACCESS_TOKEN_ENDPOINT_URL, |
| 87 |
"http://provider.com/authorize?q=1", true); |
| 88 |
|
| 89 |
String callbackUrl = "http://www.example.com"; |
| 90 |
// the URL ctor checks for URL validity |
| 91 |
URL url = new URL(provider.retrieveRequestToken(consumerMock, callbackUrl)); |
| 92 |
assertTrue(url.getQuery().startsWith("q=1&oauth_token=")); |
| 93 |
} |
| 94 |
|
| 95 |
@Test(expected = OAuthExpectationFailedException.class) |
| 96 |
public void shouldThrowWhenGettingAccessTokenAndRequestTokenNotSet() throws Exception { |
| 97 |
when(consumerMock.getToken()).thenReturn(null); |
| 98 |
provider.retrieveAccessToken(consumerMock, null); |
| 99 |
} |
| 100 |
|
| 101 |
@Test(expected = OAuthExpectationFailedException.class) |
| 102 |
public void shouldThrowWhenGettingAccessTokenAndRequestTokenSecretNotSet() throws Exception { |
| 103 |
when(consumerMock.getTokenSecret()).thenReturn(null); |
| 104 |
provider.retrieveAccessToken(consumerMock, null); |
| 105 |
} |
| 106 |
|
| 107 |
@Test |
| 108 |
public void shouldRetrieveAccessTokenAndUpdateConsumer() throws Exception { |
| 109 |
|
| 110 |
provider.retrieveAccessToken(consumerMock, null); |
| 111 |
|
| 112 |
verify(consumerMock).sign((HttpRequest) anyObject()); |
| 113 |
verify(consumerMock).setTokenWithSecret(TOKEN, TOKEN_SECRET); |
| 114 |
} |
| 115 |
|
| 116 |
@Test |
| 117 |
public void shouldMakeSpecialResponseParametersAvailableToConsumer() throws Exception { |
| 118 |
|
| 119 |
assertTrue(provider.getResponseParameters().isEmpty()); |
| 120 |
|
| 121 |
((OAuthProviderMock) provider).mockConnection(OAuth.OAUTH_TOKEN + "=" + TOKEN + "&" |
| 122 |
+ OAuth.OAUTH_TOKEN_SECRET + "=" + TOKEN_SECRET + "&a=1"); |
| 123 |
provider.retrieveRequestToken(consumerMock, null); |
| 124 |
|
| 125 |
assertEquals(1, provider.getResponseParameters().size()); |
| 126 |
assertTrue(provider.getResponseParameters().containsKey("a")); |
| 127 |
assertEquals("1", provider.getResponseParameters().getFirst("a")); |
| 128 |
|
| 129 |
((OAuthProviderMock) provider).mockConnection(OAuth.OAUTH_TOKEN + "=" + TOKEN + "&" |
| 130 |
+ OAuth.OAUTH_TOKEN_SECRET + "=" + TOKEN_SECRET + "&b=2&c=3"); |
| 131 |
provider.retrieveAccessToken(consumerMock, null); |
| 132 |
|
| 133 |
assertEquals(2, provider.getResponseParameters().size()); |
| 134 |
assertTrue(provider.getResponseParameters().containsKey("b")); |
| 135 |
assertTrue(provider.getResponseParameters().containsKey("c")); |
| 136 |
assertEquals("2", provider.getResponseParameters().getFirst("b")); |
| 137 |
assertEquals("3", provider.getResponseParameters().getFirst("c")); |
| 138 |
} |
| 139 |
|
| 140 |
@Test |
| 141 |
public void shouldBeSerializable() throws Exception { |
| 142 |
// the mock consumer isn't serializable, thus set a normal one |
| 143 |
OAuthConsumer consumer = new DefaultOAuthConsumer(CONSUMER_KEY, CONSUMER_SECRET); |
| 144 |
consumer.setTokenWithSecret(TOKEN, TOKEN_SECRET); |
| 145 |
|
| 146 |
provider = buildProvider(REQUEST_TOKEN_ENDPOINT_URL, ACCESS_TOKEN_ENDPOINT_URL, |
| 147 |
AUTHORIZE_WEBSITE_URL, false); |
| 148 |
provider.setOAuth10a(true); |
| 149 |
|
| 150 |
// prepare a provider that has response params set |
| 151 |
HttpParameters params = new HttpParameters(); |
| 152 |
params.put("a", "1"); |
| 153 |
((AbstractOAuthProvider) provider).setResponseParameters(params); |
| 154 |
|
| 155 |
ByteArrayOutputStream baos = new ByteArrayOutputStream(); |
| 156 |
ObjectOutputStream ostream = new ObjectOutputStream(baos); |
| 157 |
ostream.writeObject(provider); |
| 158 |
|
| 159 |
ObjectInputStream istream = new ObjectInputStream(new ByteArrayInputStream( |
| 160 |
baos.toByteArray())); |
| 161 |
provider = (OAuthProvider) istream.readObject(); |
| 162 |
|
| 163 |
assertEquals(REQUEST_TOKEN_ENDPOINT_URL, provider.getRequestTokenEndpointUrl()); |
| 164 |
assertEquals(ACCESS_TOKEN_ENDPOINT_URL, provider.getAccessTokenEndpointUrl()); |
| 165 |
assertEquals(AUTHORIZE_WEBSITE_URL, provider.getAuthorizationWebsiteUrl()); |
| 166 |
assertEquals(true, provider.isOAuth10a()); |
| 167 |
assertNotNull(provider.getResponseParameters()); |
| 168 |
assertEquals("1", provider.getResponseParameters().getFirst("a")); |
| 169 |
} |
| 170 |
} |