LatinIME/tests/src/com/android/inputmethod/latin/network/BlockingHttpClientTests.java

/*
 * Copyright (C) 2014 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.inputmethod.latin.network;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.mockito.Matchers.any;
import static org.mockito.Matchers.eq;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import androidx.test.filters.SmallTest;
import androidx.test.runner.AndroidJUnit4;

import com.android.inputmethod.latin.network.BlockingHttpClient.ResponseProcessor;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.MockitoAnnotations;

import java.io.BufferedInputStream;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.util.Arrays;
import java.util.Random;

/**
 * Tests for {@link BlockingHttpClient}.
 */
@SmallTest
@RunWith(AndroidJUnit4.class)
public class BlockingHttpClientTests {
    @Mock HttpURLConnection mMockHttpConnection;

    @Before
    public void setUp() throws Exception {
        MockitoAnnotations.initMocks(this);
    }

    @Test
    public void testError_badGateway() throws IOException, AuthException {
        when(mMockHttpConnection.getResponseCode()).thenReturn(HttpURLConnection.HTTP_BAD_GATEWAY);
        final BlockingHttpClient client = new BlockingHttpClient(mMockHttpConnection);
        final FakeErrorResponseProcessor processor = new FakeErrorResponseProcessor();

        try {
            client.execute(null /* empty request */, processor);
            fail("Expecting an HttpException");
        } catch (HttpException e) {
            // expected HttpException
            assertEquals(HttpURLConnection.HTTP_BAD_GATEWAY, e.getHttpStatusCode());
        }
    }

    @Test
    public void testError_clientTimeout() throws Exception {
        when(mMockHttpConnection.getResponseCode()).thenReturn(
                HttpURLConnection.HTTP_CLIENT_TIMEOUT);
        final BlockingHttpClient client = new BlockingHttpClient(mMockHttpConnection);
        final FakeErrorResponseProcessor processor = new FakeErrorResponseProcessor();

        try {
            client.execute(null /* empty request */, processor);
            fail("Expecting an HttpException");
        } catch (HttpException e) {
            // expected HttpException
            assertEquals(HttpURLConnection.HTTP_CLIENT_TIMEOUT, e.getHttpStatusCode());
        }
    }

    @Test
    public void testError_forbiddenWithRequest() throws Exception {
        final OutputStream mockOutputStream = Mockito.mock(OutputStream.class);
        when(mMockHttpConnection.getResponseCode()).thenReturn(HttpURLConnection.HTTP_FORBIDDEN);
        when(mMockHttpConnection.getOutputStream()).thenReturn(mockOutputStream);
        final BlockingHttpClient client = new BlockingHttpClient(mMockHttpConnection);
        final FakeErrorResponseProcessor processor = new FakeErrorResponseProcessor();

        try {
            client.execute(new byte[100], processor);
            fail("Expecting an HttpException");
        } catch (HttpException e) {
            assertEquals(HttpURLConnection.HTTP_FORBIDDEN, e.getHttpStatusCode());
        }
        verify(mockOutputStream).write(any(byte[].class), eq(0), eq(100));
    }

    @Test
    public void testSuccess_emptyRequest() throws Exception {
        final Random rand = new Random();
        byte[] response = new byte[100];
        rand.nextBytes(response);
        when(mMockHttpConnection.getResponseCode()).thenReturn(HttpURLConnection.HTTP_OK);
        when(mMockHttpConnection.getInputStream()).thenReturn(new ByteArrayInputStream(response));
        final BlockingHttpClient client = new BlockingHttpClient(mMockHttpConnection);
        final FakeSuccessResponseProcessor processor =
                new FakeSuccessResponseProcessor(response);

        client.execute(null /* empty request */, processor);
        assertTrue("ResponseProcessor was not invoked", processor.mInvoked);
    }

    @Test
    public void testSuccess() throws Exception {
        final OutputStream mockOutputStream = Mockito.mock(OutputStream.class);
        final Random rand = new Random();
        byte[] response = new byte[100];
        rand.nextBytes(response);
        when(mMockHttpConnection.getOutputStream()).thenReturn(mockOutputStream);
        when(mMockHttpConnection.getResponseCode()).thenReturn(HttpURLConnection.HTTP_OK);
        when(mMockHttpConnection.getInputStream()).thenReturn(new ByteArrayInputStream(response));
        final BlockingHttpClient client = new BlockingHttpClient(mMockHttpConnection);
        final FakeSuccessResponseProcessor processor =
                new FakeSuccessResponseProcessor(response);

        client.execute(new byte[100], processor);
        assertTrue("ResponseProcessor was not invoked", processor.mInvoked);
    }

    static class FakeErrorResponseProcessor implements ResponseProcessor<Void> {
        @Override
        public Void onSuccess(InputStream response) {
            fail("Expected an error but received success");
            return null;
        }
    }

    private static class FakeSuccessResponseProcessor implements ResponseProcessor<Void> {
        private final byte[] mExpectedResponse;

        boolean mInvoked;

        FakeSuccessResponseProcessor(byte[] expectedResponse) {
            mExpectedResponse = expectedResponse;
        }

        @Override
        public Void onSuccess(InputStream response) {
            try {
                mInvoked = true;
                BufferedInputStream in = new BufferedInputStream(response);
                ByteArrayOutputStream buffer = new ByteArrayOutputStream();
                int read = 0;
                while ((read = in.read()) != -1) {
                    buffer.write(read);
                }
                byte[] actualResponse = buffer.toByteArray();
                in.close();
                assertTrue("Response doesn't match",
                        Arrays.equals(mExpectedResponse, actualResponse));
            } catch (IOException ex) {
                fail("IOException in onSuccess");
            }
            return null;
        }
    }
}