google-nomulus/javatests/google/registry/model/billing/BillingEventTest.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.model.billing;

import static com.google.common.truth.Truth.assertThat;
import static google.registry.model.ofy.ObjectifyService.ofy;
import static google.registry.testing.DatastoreHelper.createTld;
import static google.registry.testing.DatastoreHelper.persistActiveDomain;
import static google.registry.testing.DatastoreHelper.persistResource;
import static google.registry.testing.JUnitBackports.assertThrows;
import static google.registry.util.DateTimeUtils.END_OF_TIME;
import static org.joda.money.CurrencyUnit.USD;
import static org.joda.time.DateTimeZone.UTC;

import com.google.common.collect.ImmutableSet;
import com.googlecode.objectify.Key;
import google.registry.model.EntityTestCase;
import google.registry.model.billing.BillingEvent.Flag;
import google.registry.model.billing.BillingEvent.Reason;
import google.registry.model.domain.DomainBase;
import google.registry.model.domain.GracePeriod;
import google.registry.model.domain.rgp.GracePeriodStatus;
import google.registry.model.reporting.HistoryEntry;
import org.joda.money.Money;
import org.joda.time.DateTime;
import org.junit.Before;
import org.junit.Test;

/** Unit tests for {@link BillingEvent}. */
public class BillingEventTest extends EntityTestCase {
  private final DateTime now = DateTime.now(UTC);

  HistoryEntry historyEntry;
  HistoryEntry historyEntry2;
  DomainBase domain;
  BillingEvent.OneTime oneTime;
  BillingEvent.OneTime oneTimeSynthetic;
  BillingEvent.Recurring recurring;
  BillingEvent.Cancellation cancellationOneTime;
  BillingEvent.Cancellation cancellationRecurring;
  BillingEvent.Modification modification;

  @Before
  public void setUp() {
    createTld("tld");
    domain = persistActiveDomain("foo.tld");
    historyEntry = persistResource(
        new HistoryEntry.Builder()
            .setParent(domain)
            .setModificationTime(now)
            .build());
    historyEntry2 = persistResource(
        new HistoryEntry.Builder()
        .setParent(domain)
        .setModificationTime(now.plusDays(1))
        .build());

    oneTime = persistResource(commonInit(
        new BillingEvent.OneTime.Builder()
            .setParent(historyEntry)
            .setReason(Reason.CREATE)
            .setFlags(ImmutableSet.of(BillingEvent.Flag.ANCHOR_TENANT))
            .setPeriodYears(2)
            .setCost(Money.of(USD, 1))
            .setEventTime(now)
            .setBillingTime(now.plusDays(5))));
    recurring = persistResource(commonInit(
        new BillingEvent.Recurring.Builder()
            .setParent(historyEntry)
            .setFlags(ImmutableSet.of(Flag.AUTO_RENEW))
            .setReason(Reason.RENEW)
            .setEventTime(now.plusYears(1))
            .setRecurrenceEndTime(END_OF_TIME)));
    oneTimeSynthetic = persistResource(commonInit(
        new BillingEvent.OneTime.Builder()
            .setParent(historyEntry)
            .setReason(Reason.CREATE)
            .setFlags(ImmutableSet.of(BillingEvent.Flag.ANCHOR_TENANT, BillingEvent.Flag.SYNTHETIC))
            .setSyntheticCreationTime(now.plusDays(10))
            .setCancellationMatchingBillingEvent(Key.create(recurring))
            .setPeriodYears(2)
            .setCost(Money.of(USD, 1))
            .setEventTime(now)
            .setBillingTime(now.plusDays(5))));
    cancellationOneTime = persistResource(commonInit(
        new BillingEvent.Cancellation.Builder()
            .setParent(historyEntry2)
            .setReason(Reason.CREATE)
            .setEventTime(now.plusDays(1))
            .setBillingTime(now.plusDays(5))
            .setOneTimeEventKey(Key.create(oneTime))));
    cancellationRecurring = persistResource(commonInit(
        new BillingEvent.Cancellation.Builder()
            .setParent(historyEntry2)
            .setReason(Reason.RENEW)
            .setEventTime(now.plusDays(1))
            .setBillingTime(now.plusYears(1).plusDays(45))
            .setRecurringEventKey(Key.create(recurring))));
    modification = persistResource(commonInit(
        new BillingEvent.Modification.Builder()
            .setParent(historyEntry2)
            .setReason(Reason.CREATE)
            .setCost(Money.of(USD, 1))
            .setDescription("Something happened")
            .setEventTime(now.plusDays(1))
            .setEventKey(Key.create(oneTime))));
  }

  private <E extends BillingEvent, B extends BillingEvent.Builder<E, B>> E commonInit(B builder) {
    return builder
        .setClientId("a registrar")
        .setTargetId("foo.tld")
        .build();
  }

  @Test
  public void testPersistence() {
    assertThat(ofy().load().entity(oneTime).now()).isEqualTo(oneTime);
    assertThat(ofy().load().entity(oneTimeSynthetic).now()).isEqualTo(oneTimeSynthetic);
    assertThat(ofy().load().entity(recurring).now()).isEqualTo(recurring);
    assertThat(ofy().load().entity(cancellationOneTime).now()).isEqualTo(cancellationOneTime);
    assertThat(ofy().load().entity(cancellationRecurring).now()).isEqualTo(cancellationRecurring);
    assertThat(ofy().load().entity(modification).now()).isEqualTo(modification);
  }

  @Test
  public void testParenting() {
    // Note that these are all tested separately because BillingEvent is an abstract base class that
    // lacks the @Entity annotation, and thus we cannot call .type(BillingEvent.class)
    assertThat(ofy().load().type(BillingEvent.OneTime.class).ancestor(domain).list())
        .containsExactly(oneTime, oneTimeSynthetic);
    assertThat(ofy().load().type(BillingEvent.Recurring.class).ancestor(domain).list())
        .containsExactly(recurring);
    assertThat(ofy().load().type(BillingEvent.Cancellation.class).ancestor(domain).list())
        .containsExactly(cancellationOneTime, cancellationRecurring);
    assertThat(ofy().load().type(BillingEvent.Modification.class).ancestor(domain).list())
        .containsExactly(modification);
    assertThat(ofy().load().type(BillingEvent.OneTime.class).ancestor(historyEntry).list())
        .containsExactly(oneTime, oneTimeSynthetic);
    assertThat(ofy().load().type(BillingEvent.Recurring.class).ancestor(historyEntry).list())
        .containsExactly(recurring);
    assertThat(ofy().load().type(BillingEvent.Cancellation.class).ancestor(historyEntry2).list())
        .containsExactly(cancellationOneTime, cancellationRecurring);
    assertThat(ofy().load().type(BillingEvent.Modification.class).ancestor(historyEntry2).list())
        .containsExactly(modification);
  }

  @Test
  public void testCancellationMatching() {
    Key<?> recurringKey = ofy().load().entity(oneTimeSynthetic).now()
        .getCancellationMatchingBillingEvent();
    assertThat(ofy().load().key(recurringKey).now()).isEqualTo(recurring);
  }

  @Test
  public void testIndexing() throws Exception {
    verifyIndexing(oneTime, "clientId", "eventTime", "billingTime", "syntheticCreationTime");
    verifyIndexing(
        oneTimeSynthetic, "clientId", "eventTime", "billingTime", "syntheticCreationTime");
    verifyIndexing(
        recurring, "clientId", "eventTime", "recurrenceEndTime", "recurrenceTimeOfYear.timeString");
    verifyIndexing(cancellationOneTime, "clientId", "eventTime", "billingTime");
    verifyIndexing(modification, "clientId", "eventTime");
  }

  @Test
  public void testFailure_syntheticFlagWithoutCreationTime() {
    IllegalStateException thrown =
        assertThrows(
            IllegalStateException.class,
            () ->
                oneTime
                    .asBuilder()
                    .setFlags(ImmutableSet.of(BillingEvent.Flag.SYNTHETIC))
                    .setCancellationMatchingBillingEvent(Key.create(recurring))
                    .build());
    assertThat(thrown)
        .hasMessageThat()
        .contains("Synthetic creation time must be set if and only if the SYNTHETIC flag is set.");
  }

  @Test
  public void testFailure_syntheticCreationTimeWithoutFlag() {
    IllegalStateException thrown =
        assertThrows(
            IllegalStateException.class,
            () -> oneTime.asBuilder().setSyntheticCreationTime(now.plusDays(10)).build());
    assertThat(thrown)
        .hasMessageThat()
        .contains("Synthetic creation time must be set if and only if the SYNTHETIC flag is set");
  }

  @Test
  public void testFailure_syntheticFlagWithoutCancellationMatchingKey() {
    IllegalStateException thrown =
        assertThrows(
            IllegalStateException.class,
            () ->
                oneTime
                    .asBuilder()
                    .setFlags(ImmutableSet.of(BillingEvent.Flag.SYNTHETIC))
                    .setSyntheticCreationTime(END_OF_TIME)
                    .build());
    assertThat(thrown)
        .hasMessageThat()
        .contains(
            "Cancellation matching billing event must be set "
                + "if and only if the SYNTHETIC flag is set");
  }

  @Test
  public void testFailure_cancellationMatchingKeyWithoutFlag() {
    IllegalStateException thrown =
        assertThrows(
            IllegalStateException.class,
            () ->
                oneTime
                    .asBuilder()
                    .setCancellationMatchingBillingEvent(Key.create(recurring))
                    .build());
    assertThat(thrown)
        .hasMessageThat()
        .contains(
            "Cancellation matching billing event must be set "
                + "if and only if the SYNTHETIC flag is set");
  }

  @Test
  public void testSuccess_cancellation_forGracePeriod_withOneTime() {
    BillingEvent.Cancellation newCancellation = BillingEvent.Cancellation.forGracePeriod(
        GracePeriod.forBillingEvent(GracePeriodStatus.ADD, oneTime),
        historyEntry2,
        "foo.tld");
    // Set ID to be the same to ignore for the purposes of comparison.
    newCancellation = newCancellation.asBuilder().setId(cancellationOneTime.getId()).build();
    assertThat(newCancellation).isEqualTo(cancellationOneTime);
  }

  @Test
  public void testSuccess_cancellation_forGracePeriod_withRecurring() {
    BillingEvent.Cancellation newCancellation = BillingEvent.Cancellation.forGracePeriod(
        GracePeriod.createForRecurring(
            GracePeriodStatus.AUTO_RENEW,
            now.plusYears(1).plusDays(45),
            "a registrar",
            Key.create(recurring)),
        historyEntry2,
        "foo.tld");
    // Set ID to be the same to ignore for the purposes of comparison.
    newCancellation = newCancellation.asBuilder().setId(cancellationRecurring.getId()).build();
    assertThat(newCancellation).isEqualTo(cancellationRecurring);
  }

  @Test
  public void testFailure_cancellation_forGracePeriodWithoutBillingEvent() {
    IllegalArgumentException thrown =
        assertThrows(
            IllegalArgumentException.class,
            () ->
                BillingEvent.Cancellation.forGracePeriod(
                    GracePeriod.createWithoutBillingEvent(
                        GracePeriodStatus.REDEMPTION, now.plusDays(1), "a registrar"),
                    historyEntry,
                    "foo.tld"));
    assertThat(thrown).hasMessageThat().contains("grace period without billing event");
  }

  @Test
  public void testFailure_cancellationWithNoBillingEvent() {
    IllegalStateException thrown =
        assertThrows(
            IllegalStateException.class,
            () ->
                cancellationOneTime
                    .asBuilder()
                    .setOneTimeEventKey(null)
                    .setRecurringEventKey(null)
                    .build());
    assertThat(thrown).hasMessageThat().contains("exactly one billing event");
  }

  @Test
  public void testFailure_cancellationWithBothBillingEvents() {
    IllegalStateException thrown =
        assertThrows(
            IllegalStateException.class,
            () ->
                cancellationOneTime
                    .asBuilder()
                    .setOneTimeEventKey(Key.create(oneTime))
                    .setRecurringEventKey(Key.create(recurring))
                    .build());
    assertThat(thrown).hasMessageThat().contains("exactly one billing event");
  }

  @Test
  public void testDeadCodeThatDeletedScrapCommandsReference() {
    assertThat(recurring.getParentKey()).isEqualTo(Key.create(historyEntry));
    new BillingEvent.OneTime.Builder().setParent(Key.create(historyEntry));
  }
}