// Copyright 2016 Google Inc. All Rights Reserved.
//
// 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.google.api.ads.adwords.lib.utils.v201609;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.fail;
import static org.mockito.Matchers.isA;
import static org.mockito.Mockito.when;
import com.google.api.ads.adwords.lib.client.AdWordsSession;
import com.google.api.ads.adwords.lib.factory.AdWordsServicesInterface;
import com.google.api.ads.adwords.lib.jaxb.v201609.DownloadFormat;
import com.google.api.ads.adwords.lib.jaxb.v201609.ReportDefinition;
import com.google.api.ads.adwords.lib.jaxb.v201609.ReportDefinitionDateRangeType;
import com.google.api.ads.adwords.lib.jaxb.v201609.ReportDefinitionReportType;
import com.google.api.ads.adwords.lib.jaxb.v201609.Selector;
import com.google.api.ads.adwords.lib.utils.AdHocReportDownloadHelper;
import com.google.api.ads.adwords.lib.utils.RawReportDownloadResponse;
import com.google.api.ads.adwords.lib.utils.ReportDownloadResponse;
import com.google.api.ads.adwords.lib.utils.ReportDownloadResponseException;
import com.google.api.ads.adwords.lib.utils.ReportException;
import com.google.api.ads.adwords.lib.utils.ReportRequest;
import com.google.api.ads.adwords.lib.utils.testing.GenericAdWordsServices;
import com.google.api.ads.adwords.lib.utils.v201609.DetailedReportDownloadResponseException.Builder;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;
import org.mockito.Matchers;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.MockitoAnnotations;
/**
* Tests for {@link ReportDownloader}.
*/
@RunWith(Parameterized.class)
public class ReportDownloaderTest {
private static final String AWQL_REQUEST = "SELECT CampaignId, CampaignName, Impressions "
+ "FROM CAMPAIGN_PERFORMANCE_REPORT DURING THIS_MONTH";
private static final String ERROR_TEXT = "A problem occurred processing your response";
private ReportDownloader reportDownloader;
private final boolean isUseAwql;
@Mock private AdWordsSession adWordsSession;
@Mock private AdHocReportDownloadHelper adHocDownloadHelper;
@Parameters(name = "isUseAwql={0}")
public static Collection<Object[]> data() {
Collection<Object[]> parameters = new ArrayList<Object[]>();
parameters.add(new Object[] {Boolean.TRUE});
parameters.add(new Object[] {Boolean.FALSE});
return parameters;
}
public ReportDownloaderTest(boolean isUseAwql) {
this.isUseAwql = isUseAwql;
}
@Before
public void setUp() {
MockitoAnnotations.initMocks(this);
reportDownloader = new ReportDownloader(adHocDownloadHelper);
}
/**
* Invokes {@link ReportDownloader#downloadReport(ReportDefinition)} or
* {@link ReportDownloader#downloadReport(String, DownloadFormat)}, depending on whether this
* instance is configured to use AWQL.
*
* @param downloadFormat the DownloadFormat for the request
* @param rawResponse the response to return from the mocked ad hoc helper
*/
private ReportDownloadResponse downloadReport(DownloadFormat downloadFormat,
RawReportDownloadResponse rawResponse, String expectedErrorText) throws ReportException,
ReportDownloadResponseException {
if (rawResponse.getHttpStatus() == 200) {
// Response indicates success, so return a ReportDownloadResponse.
when(
adHocDownloadHelper.downloadReport(
Matchers.any(ReportRequest.class), Matchers.any(Builder.class)))
.thenReturn(new ReportDownloadResponse(rawResponse));
} else {
// Response indicates failure, so throw an exception.
when(
adHocDownloadHelper.downloadReport(
Matchers.any(ReportRequest.class), Matchers.any(Builder.class)))
.thenThrow(new Builder().build(rawResponse.getHttpStatus(), expectedErrorText));
}
if (isUseAwql) {
return reportDownloader.downloadReport(AWQL_REQUEST, downloadFormat);
} else {
ReportDefinition reportDefinition = new ReportDefinition();
reportDefinition.setSelector(new Selector());
reportDefinition
.getSelector()
.getFields()
.addAll(Arrays.asList("CampaignId", "CampaignName", "Impressions"));
reportDefinition.setDateRangeType(ReportDefinitionDateRangeType.LAST_7_DAYS);
reportDefinition.setReportName("Custom report");
reportDefinition.setReportType(ReportDefinitionReportType.CAMPAIGN_PERFORMANCE_REPORT);
return reportDownloader.downloadReport(reportDefinition);
}
}
@Test
public void testGetFromAdWordsServices() throws Exception {
AdWordsServicesInterface adWordsServices = new GenericAdWordsServices();
ReportDownloaderInterface downloader =
adWordsServices.getUtility(adWordsSession, ReportDownloaderInterface.class);
assertNotNull("Null downloader from AdWordsServices", downloader);
}
@Test
public void testSuccess() throws Exception {
ByteArrayInputStream stream =
new ByteArrayInputStream("Report data".getBytes(AdHocReportDownloadHelper.REPORT_CHARSET));
RawReportDownloadResponse rawResponse =
new RawReportDownloadResponse(200, stream, AdHocReportDownloadHelper.REPORT_CHARSET,
DownloadFormat.CSV.name());
ReportDownloadResponse response = downloadReport(DownloadFormat.CSV, rawResponse, null);
assertEquals(200, response.getHttpStatus());
assertEquals(stream, response.getInputStream());
assertEquals("SUCCESS", response.getHttpResponseMessage());
}
@Test
public void testFailure_cannotReadStream() throws Exception {
InputStream stream = Mockito.mock(InputStream.class);
when(stream.read(isA(byte[].class))).thenThrow(new IOException());
RawReportDownloadResponse rawResponse =
new RawReportDownloadResponse(400, stream, AdHocReportDownloadHelper.REPORT_CHARSET,
DownloadFormat.CSV.name());
try {
downloadReport(DownloadFormat.CSV, rawResponse, null);
fail("Should have thrown an exception");
} catch (ReportDownloadResponseException e) {
assertEquals(400, e.getHttpStatus());
}
}
@Test
public void testFailure_failedStatusCode() throws Exception {
InputStream stream =
new ByteArrayInputStream(ERROR_TEXT.getBytes(AdHocReportDownloadHelper.REPORT_CHARSET));
int statusCode = 400;
RawReportDownloadResponse rawResponse =
new RawReportDownloadResponse(statusCode, stream, AdHocReportDownloadHelper.REPORT_CHARSET,
DownloadFormat.XML.name());
try {
downloadReport(DownloadFormat.XML, rawResponse, ERROR_TEXT);
fail("Should have thrown an exception");
} catch (DetailedReportDownloadResponseException e) {
assertEquals(statusCode, e.getHttpStatus());
assertEquals(ERROR_TEXT, e.getErrorText());
assertThat(e.toString(), org.hamcrest.Matchers.containsString(String.valueOf(statusCode)));
assertThat(e.toString(), org.hamcrest.Matchers.containsString(ERROR_TEXT));
}
}
@Test
public void testReportDownloadTimeoutSetter() throws Exception {
ReportDownloader reportDownloader = new ReportDownloader(adWordsSession);
assertEquals(180000, reportDownloader.getReportDownloadTimeout());
reportDownloader.setReportDownloadTimeout(42);
assertEquals(42, reportDownloader.getReportDownloadTimeout());
}
}