google-nomulus/javatests/google/registry/tmch/NordnUploadActionTest.java

// Copyright 2017 The Nomulus Authors. 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 google.registry.tmch;

import static com.google.common.net.HttpHeaders.AUTHORIZATION;
import static com.google.common.net.HttpHeaders.CONTENT_TYPE;
import static com.google.common.net.HttpHeaders.LOCATION;
import static com.google.common.net.MediaType.FORM_DATA;
import static com.google.common.truth.Truth.assertThat;
import static com.google.common.truth.Truth8.assertThat;
import static google.registry.testing.DatastoreHelper.createTld;
import static google.registry.testing.DatastoreHelper.loadRegistrar;
import static google.registry.testing.DatastoreHelper.newDomainBase;
import static google.registry.testing.DatastoreHelper.persistDomainAndEnqueueLordn;
import static google.registry.testing.DatastoreHelper.persistResource;
import static google.registry.testing.JUnitBackports.assertThrows;
import static google.registry.testing.TaskQueueHelper.assertTasksEnqueued;
import static google.registry.util.UrlFetchUtils.getHeaderFirst;
import static java.nio.charset.StandardCharsets.US_ASCII;
import static java.nio.charset.StandardCharsets.UTF_8;
import static javax.servlet.http.HttpServletResponse.SC_ACCEPTED;
import static javax.servlet.http.HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
import static org.mockito.Matchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import com.google.appengine.api.taskqueue.LeaseOptions;
import com.google.appengine.api.taskqueue.Queue;
import com.google.appengine.api.taskqueue.TaskHandle;
import com.google.appengine.api.taskqueue.TaskOptions;
import com.google.appengine.api.taskqueue.TaskOptions.Method;
import com.google.appengine.api.taskqueue.TransientFailureException;
import com.google.appengine.api.urlfetch.HTTPHeader;
import com.google.appengine.api.urlfetch.HTTPRequest;
import com.google.appengine.api.urlfetch.HTTPResponse;
import com.google.appengine.api.urlfetch.URLFetchService;
import com.google.apphosting.api.DeadlineExceededException;
import com.google.common.base.VerifyException;
import com.google.common.collect.ImmutableList;
import google.registry.model.domain.DomainBase;
import google.registry.model.domain.launch.LaunchNotice;
import google.registry.model.ofy.Ofy;
import google.registry.model.registry.Registry;
import google.registry.testing.AppEngineRule;
import google.registry.testing.FakeClock;
import google.registry.testing.FakeSleeper;
import google.registry.testing.InjectRule;
import google.registry.testing.TaskQueueHelper.TaskMatcher;
import google.registry.util.Retrier;
import google.registry.util.TaskQueueUtils;
import google.registry.util.UrlFetchException;
import java.net.URL;
import java.security.SecureRandom;
import java.util.List;
import java.util.Optional;
import org.joda.time.DateTime;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoRule;

/** Unit tests for {@link NordnUploadAction}. */
@RunWith(JUnit4.class)
public class NordnUploadActionTest {

  private static final String CLAIMS_CSV = "1,2010-05-01T10:11:12.000Z,1\n"
      + "roid,domain-name,notice-id,registrar-id,registration-datetime,ack-datetime,"
      + "application-datetime\n"
      + "2-TLD,claims-landrush1.tld,landrush1tcn,99999,2010-05-01T10:11:12.000Z,"
      + "1969-12-31T23:00:00.000Z\n";

  private static final String SUNRISE_CSV = "1,2010-05-01T10:11:12.000Z,1\n"
      + "roid,domain-name,SMD-id,registrar-id,registration-datetime,application-datetime\n"
      + "2-TLD,sunrise1.tld,my-smdid,99999,2010-05-01T10:11:12.000Z\n";

  private static final String LOCATION_URL = "http://trololol";

  @Rule
  public final AppEngineRule appEngine =
      AppEngineRule.builder().withDatastore().withTaskQueue().build();

  @Rule public final MockitoRule mocks = MockitoJUnit.rule();
  @Rule public final InjectRule inject = new InjectRule();

  @Mock private URLFetchService fetchService;
  @Mock private HTTPResponse httpResponse;
  @Captor private ArgumentCaptor<HTTPRequest> httpRequestCaptor;

  private final FakeClock clock = new FakeClock(DateTime.parse("2010-05-01T10:11:12Z"));
  private final LordnRequestInitializer lordnRequestInitializer =
      new LordnRequestInitializer(Optional.of("attack"));
  private final NordnUploadAction action = new NordnUploadAction();

  @Before
  public void before() throws Exception {
    inject.setStaticField(Ofy.class, "clock", clock);
    when(fetchService.fetch(any(HTTPRequest.class))).thenReturn(httpResponse);
    when(httpResponse.getContent()).thenReturn("Success".getBytes(US_ASCII));
    when(httpResponse.getResponseCode()).thenReturn(SC_ACCEPTED);
    when(httpResponse.getHeadersUncombined())
        .thenReturn(ImmutableList.of(new HTTPHeader(LOCATION, "http://trololol")));
    persistResource(loadRegistrar("TheRegistrar").asBuilder().setIanaIdentifier(99999L).build());
    createTld("tld");
    persistResource(Registry.get("tld").asBuilder().setLordnUsername("lolcat").build());
    action.clock = clock;
    action.fetchService = fetchService;
    action.lordnRequestInitializer = lordnRequestInitializer;
    action.phase = "claims";
    action.taskQueueUtils = new TaskQueueUtils(new Retrier(new FakeSleeper(clock), 3));
    action.tld = "tld";
    action.tmchMarksdbUrl = "http://127.0.0.1";
    action.random = new SecureRandom();
    action.retrier = new Retrier(new FakeSleeper(clock), 3);
  }

  @Test
  public void test_convertTasksToCsv() {
    List<TaskHandle> tasks =
        ImmutableList.of(
            makeTaskHandle("task1", "example", "csvLine1", "lordn-sunrise"),
            makeTaskHandle("task2", "example", "csvLine2", "lordn-sunrise"),
            makeTaskHandle("task3", "example", "ending", "lordn-sunrise"));
    assertThat(NordnUploadAction.convertTasksToCsv(tasks, clock.nowUtc(), "col1,col2"))
        .isEqualTo("1,2010-05-01T10:11:12.000Z,3\ncol1,col2\ncsvLine1\ncsvLine2\nending\n");
  }

  @Test
  public void test_convertTasksToCsv_doesntFailOnEmptyTasks() {
    assertThat(NordnUploadAction.convertTasksToCsv(ImmutableList.of(), clock.nowUtc(), "col1,col2"))
        .isEqualTo("1,2010-05-01T10:11:12.000Z,0\ncol1,col2\n");
  }

  @Test
  public void test_convertTasksToCsv_throwsNpeOnNullTasks() {
    assertThrows(
        NullPointerException.class,
        () -> NordnUploadAction.convertTasksToCsv(null, clock.nowUtc(), "header"));
  }

  @SuppressWarnings("unchecked")
  @Test
  public void test_loadAllTasks_retryLogic_thirdTrysTheCharm() {
    Queue queue = mock(Queue.class);
    TaskHandle task = new TaskHandle(TaskOptions.Builder.withTaskName("blah"), "blah");
    when(queue.leaseTasks(any(LeaseOptions.class)))
        .thenThrow(TransientFailureException.class)
        .thenThrow(DeadlineExceededException.class)
        .thenReturn(ImmutableList.of(task), ImmutableList.of());
    assertThat(action.loadAllTasks(queue, "tld")).containsExactly(task);
  }

  @SuppressWarnings("unchecked")
  @Test
  public void test_loadAllTasks_retryLogic_allFailures() {
    Queue queue = mock(Queue.class);
    when(queue.leaseTasks(any(LeaseOptions.class)))
        .thenThrow(new TransientFailureException("some transient error"));
    RuntimeException thrown =
        assertThrows(TransientFailureException.class, () -> action.loadAllTasks(queue, "tld"));
    assertThat(thrown).hasMessageThat().isEqualTo("some transient error");
  }

  @Test
  public void testRun_claimsMode_appendsTldAndClaimsToRequestUrl() throws Exception {
    persistClaimsModeDomain();
    action.run();
    assertThat(getCapturedHttpRequest().getURL())
        .isEqualTo(new URL("http://127.0.0.1/LORDN/tld/claims"));
  }

  @Test
  public void testRun_sunriseMode_appendsTldAndClaimsToRequestUrl() throws Exception {
    persistSunriseModeDomain();
    action.run();
    assertThat(getCapturedHttpRequest().getURL())
        .isEqualTo(new URL("http://127.0.0.1/LORDN/tld/sunrise"));
  }

  @Test
  public void testRun_usesMultipartContentType() throws Exception {
    persistClaimsModeDomain();
    action.run();
    assertThat(getHeaderFirst(getCapturedHttpRequest(), CONTENT_TYPE).get())
        .startsWith("multipart/form-data; boundary=");
  }

  @Test
  public void testRun_hasPassword_setsAuthorizationHeader() throws Exception {
    persistClaimsModeDomain();
    action.run();
    assertThat(getHeaderFirst(getCapturedHttpRequest(), AUTHORIZATION))
        .hasValue("Basic bG9sY2F0OmF0dGFjaw==");  // echo -n lolcat:attack | base64
  }

  @Test
  public void testRun_noPassword_doesntSendAuthorizationHeader() throws Exception {
    action.lordnRequestInitializer = new LordnRequestInitializer(Optional.empty());
    persistClaimsModeDomain();
    action.run();
    assertThat(getHeaderFirst(getCapturedHttpRequest(), AUTHORIZATION)).isEmpty();
  }

  @Test
  public void testRun_claimsMode_payloadMatchesClaimsCsv() throws Exception {
    persistClaimsModeDomain();
    action.run();
    assertThat(new String(getCapturedHttpRequest().getPayload(), UTF_8)).contains(CLAIMS_CSV);
  }

  @Test
  public void testRun_claimsMode_verifyTaskGetsEnqueuedWithClaimsCsv() {
    persistClaimsModeDomain();
    action.run();
    assertTasksEnqueued(NordnVerifyAction.QUEUE, new TaskMatcher()
        .url(NordnVerifyAction.PATH)
        .header(NordnVerifyAction.URL_HEADER, LOCATION_URL)
        .header(CONTENT_TYPE, FORM_DATA.toString()));
  }

  @Test
  public void testRun_sunriseMode_payloadMatchesSunriseCsv() throws Exception {
    persistSunriseModeDomain();
    action.run();
    assertThat(new String(getCapturedHttpRequest().getPayload(), UTF_8)).contains(SUNRISE_CSV);
  }

  @Test
  public void test_noResponseContent_stillWorksNormally() throws Exception {
    // Returning null only affects logging.
    when(httpResponse.getContent()).thenReturn(null);
    persistSunriseModeDomain();
    action.run();
    assertThat(new String(getCapturedHttpRequest().getPayload(), UTF_8)).contains(SUNRISE_CSV);
  }

  @Test
  public void testRun_sunriseMode_verifyTaskGetsEnqueuedWithSunriseCsv() {
    persistSunriseModeDomain();
    action.run();
    assertTasksEnqueued(NordnVerifyAction.QUEUE, new TaskMatcher()
        .url(NordnVerifyAction.PATH)
        .header(NordnVerifyAction.URL_HEADER, LOCATION_URL)
        .header(CONTENT_TYPE, FORM_DATA.toString()));
  }

  @Test
  public void testFailure_nullRegistryUser() {
    persistClaimsModeDomain();
    persistResource(Registry.get("tld").asBuilder().setLordnUsername(null).build());
    VerifyException thrown = assertThrows(VerifyException.class, action::run);
    assertThat(thrown).hasMessageThat().contains("lordnUsername is not set for tld.");
  }

  @Test
  public void testFetchFailure() {
    persistClaimsModeDomain();
    when(httpResponse.getResponseCode()).thenReturn(SC_INTERNAL_SERVER_ERROR);
    assertThrows(UrlFetchException.class, action::run);
  }

  private HTTPRequest getCapturedHttpRequest() throws Exception {
    verify(fetchService).fetch(httpRequestCaptor.capture());
    return httpRequestCaptor.getAllValues().get(0);
  }

  private void persistClaimsModeDomain() {
    DomainBase domain = newDomainBase("claims-landrush1.tld");
    persistDomainAndEnqueueLordn(
        domain
            .asBuilder()
            .setLaunchNotice(
                LaunchNotice.create(
                    "landrush1tcn", null, null, domain.getCreationTime().minusHours(1)))
            .build());
  }

  private void persistSunriseModeDomain() {
    action.phase = "sunrise";
    DomainBase domain = newDomainBase("sunrise1.tld");
    persistDomainAndEnqueueLordn(domain.asBuilder().setSmdId("my-smdid").build());
  }

  private static TaskHandle makeTaskHandle(
      String taskName, String tag, String payload, String queue) {
    return new TaskHandle(
        TaskOptions.Builder.withPayload(payload).method(Method.PULL).tag(tag).taskName(taskName),
        queue);
  }
}