google-nomulus/javatests/google/registry/model/domain/TestExtraLogicManager.java

// Copyright 2016 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.domain;

import static com.google.common.base.Preconditions.checkArgument;

import com.google.common.base.Ascii;
import com.google.common.base.Joiner;
import com.google.common.base.Splitter;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import google.registry.flows.EppException;
import google.registry.flows.domain.RegistryExtraFlowLogic;
import google.registry.model.domain.fee.BaseFee;
import google.registry.model.domain.fee.BaseFee.FeeType;
import google.registry.model.domain.fee.Credit;
import google.registry.model.domain.fee.Fee;
import google.registry.model.domain.flags.FlagsCreateCommandExtension;
import google.registry.model.domain.flags.FlagsTransferCommandExtension;
import google.registry.model.domain.flags.FlagsUpdateCommandExtension;
import google.registry.model.eppinput.EppInput;
import google.registry.model.reporting.HistoryEntry;
import java.math.BigDecimal;
import java.util.List;
import java.util.Set;
import org.joda.time.DateTime;

/**
 * Fake extra logic manager which synthesizes information from the domain name for testing purposes.
 */
public class TestExtraLogicManager implements RegistryExtraFlowLogic {

  /**
   * Dummy exception used to signal success. This is thrown by the performAdditionalXXXLogic()
   * methods to indicate to the test that everything worked properly, because the
   * TestExtraLogicManager instance used by the flow will have been created deep in the flow and is
   * not accessible to the test code directly.  We should fix this when we make the extra flow logic
   * injected.
   */
  public static class TestExtraLogicManagerSuccessException extends RuntimeException {
    TestExtraLogicManagerSuccessException(String message) {
      super(message);
    }
  }

  /**
   * Gets the flags to be used in the EPP flags extension for info commands.
   *
   * <p>The test extra logic manager uses domain names differently for info commands than for other
   * flows. In other flows, the test logic needs returns (via the success exception) the flags found
   * in the incoming message. But for info commands, there aren't any incoming flags, only outgoing
   * ones. So we need to specify the flags using a dummy domain name; those flags can then be
   * inserted into the outgoing info response.
   */
  @Override
  public Set<String> getExtensionFlags(
      DomainResource domain, String clientId, DateTime asOfDate) {
    // Take the part before the period, split by dashes, and treat each part after the first as
    // a flag.
    List<String> components =
        Splitter.on('-').splitToList(
            Iterables.getFirst(
                Splitter.on('.').split(domain.getFullyQualifiedDomainName()), ""));
    return ImmutableSet.copyOf(components.subList(1, components.size()));
  }

  /**
   * Gets the flags to be used in the EPP flags extension for application info commands.
   *
   * <p>This method works the same way as getExtensionFlags().
   */
  @Override
  public Set<String> getApplicationExtensionFlags(
      DomainApplication application, String clientId, DateTime asOfDate) {
    // Take the part before the period, split by dashes, and treat each part after the first as
    // a flag.
    List<String> components =
        Splitter.on('-').splitToList(
            Iterables.getFirst(
                Splitter.on('.').split(application.getFullyQualifiedDomainName()), ""));
    return ImmutableSet.copyOf(components.subList(1, components.size()));
  }

  BaseFee domainNameToFeeOrCredit(String domainName) {
    // The second-level domain should be of the form "description-price", where description is the
    // description string of the fee or credit, and price is the price (credit if negative, fee
    // otherwise). To make sure this is a valid domain name, don't use any spaces, and limit prices
    // to integers. Don't use a two-character description for credits, since it is illegal to have
    // both the third and fourth characters of a domain name label be hyphens.
    List<String> components =
        Splitter.on('-').limit(2).splitToList(
            Iterables.getFirst(Splitter.on('.').split(domainName), ""));
    checkArgument(components.size() == 2, "Domain name must be of the form description-price.tld");
    int price = Integer.parseInt(components.get(1));
    if (price < 0) {
      return Credit.create(
          new BigDecimal(price), FeeType.valueOf(Ascii.toUpperCase(components.get(0))));
    } else {
      return Fee.create(
          new BigDecimal(price), FeeType.valueOf(Ascii.toUpperCase(components.get(0))));
    }
  }

  /** Performs additional tasks required for an application create command. */
  @Override
  public void performAdditionalApplicationCreateLogic(
      DomainApplication application,
      String clientId,
      int years,
      EppInput eppInput,
      HistoryEntry historyEntry) throws EppException {
    FlagsCreateCommandExtension flags =
        eppInput.getSingleExtension(FlagsCreateCommandExtension.class);
    if (flags == null) {
      return;
    }
    throw new TestExtraLogicManagerSuccessException(Joiner.on(',').join(flags.getFlags()));
  }

  /** Performs additional tasks required for an application create command. */
  @Override
  public void performAdditionalApplicationDeleteLogic(
      DomainApplication application,
      String clientId,
      DateTime asOfDate,
      EppInput eppInput,
      HistoryEntry historyEntry) throws EppException {
    throw new TestExtraLogicManagerSuccessException("application deleted");
  }

  /** Computes the expected application update cost, for use in fee challenges and the like. */
  @Override
  public BaseFee getApplicationUpdateFeeOrCredit(
      DomainApplication application,
      String clientId,
      DateTime asOfDate,
      EppInput eppInput) throws EppException {
    return domainNameToFeeOrCredit(application.getFullyQualifiedDomainName());
  }

  /** Performs additional tasks required for an application update command. */
  @Override
  public void performAdditionalApplicationUpdateLogic(
      DomainApplication application,
      String clientId,
      DateTime asOfDate,
      EppInput eppInput,
      HistoryEntry historyEntry) throws EppException {
    FlagsUpdateCommandExtension flags =
        eppInput.getSingleExtension(FlagsUpdateCommandExtension.class);
    if (flags == null) {
      return;
    }
    throw new TestExtraLogicManagerSuccessException(
        "add:"
        + Joiner.on(',').join(flags.getAddFlags().getFlags())
        + ";remove:"
        + Joiner.on(',').join(flags.getRemoveFlags().getFlags()));
  }

  /** Computes the expected create cost, for use in fee challenges and the like. */
  @Override
  public BaseFee getCreateFeeOrCredit(
      String domainName,
      String clientId,
      DateTime asOfDate,
      int years,
      EppInput eppInput) throws EppException {
    return domainNameToFeeOrCredit(domainName);
  }

  /** Performs additional tasks required for an allocate command. */
  @Override
  public void performAdditionalDomainAllocateLogic(
      DomainResource domain,
      String clientId,
      DateTime asOfDate,
      int years,
      EppInput eppInput,
      HistoryEntry historyEntry) throws EppException {
    throw new TestExtraLogicManagerSuccessException("allocated");
  }

  /** Performs additional tasks required for a create command. */
  @Override
  public void performAdditionalDomainCreateLogic(
      DomainResource domain,
      String clientId,
      int years,
      EppInput eppInput,
      HistoryEntry historyEntry) throws EppException {
    FlagsCreateCommandExtension flags =
        eppInput.getSingleExtension(FlagsCreateCommandExtension.class);
    if (flags == null) {
      return;
    }
    throw new TestExtraLogicManagerSuccessException(Joiner.on(',').join(flags.getFlags()));
  }

  /** Performs additional tasks required for a delete command. */
  @Override
  public void performAdditionalDomainDeleteLogic(
      DomainResource domainResource,
      String clientId,
      DateTime asOfDate,
      EppInput eppInput,
      HistoryEntry historyEntry) throws EppException {
    throw new TestExtraLogicManagerSuccessException("deleted");
  }

  /** Computes the expected renewal cost, for use in fee challenges and the like. */
  @Override
  public BaseFee getRenewFeeOrCredit(
      DomainResource domain,
      String clientId,
      DateTime asOfDate,
      int years,
      EppInput eppInput) throws EppException {
    return domainNameToFeeOrCredit(domain.getFullyQualifiedDomainName());
  }

  /** Performs additional tasks required for a renew command. */
  @Override
  public void performAdditionalDomainRenewLogic(
      DomainResource domainResource,
      String clientId,
      DateTime asOfDate,
      int years,
      EppInput eppInput,
      HistoryEntry historyEntry) throws EppException {
    throw new TestExtraLogicManagerSuccessException("renewed");
  }

  /** Performs additional tasks required for a restore command. */
  @Override
  public void performAdditionalDomainRestoreLogic(
      DomainResource domainResource,
      String clientId,
      DateTime asOfDate,
      EppInput eppInput,
      HistoryEntry historyEntry) throws EppException {
    throw new TestExtraLogicManagerSuccessException("restored");
  }

  /** Performs additional tasks required for a transfer approve command. */
  @Override
  public void performAdditionalDomainTransferApproveLogic(
      DomainResource domain, String clientId, HistoryEntry historyEntry) throws EppException {
    throw new TestExtraLogicManagerSuccessException("transfer approved");
  }

  /** Performs additional tasks required for a transfer cancel command. */
  @Override
  public void performAdditionalDomainTransferCancelLogic(
      DomainResource domain, String clientId, HistoryEntry historyEntry) throws EppException {
    throw new TestExtraLogicManagerSuccessException("transfer cancelled");
  }

  /** Performs additional tasks required for a transfer reject command. */
  @Override
  public void performAdditionalDomainTransferRejectLogic(
      DomainResource domain, String clientId, HistoryEntry historyEntry) throws EppException {
    throw new TestExtraLogicManagerSuccessException("transfer rejected");
  }

  /** Performs additional tasks required for a transfer request command. */
  @Override
  public void performAdditionalDomainTransferRequestLogic(
      DomainResource domainResource,
      String clientId,
      DateTime asOfDate,
      int years,
      EppInput eppInput,
      HistoryEntry historyEntry) throws EppException {
    FlagsTransferCommandExtension flags =
        eppInput.getSingleExtension(FlagsTransferCommandExtension.class);
    if (flags == null) {
      return;
    }
    throw new TestExtraLogicManagerSuccessException(
        "add:"
        + Joiner.on(',').join(flags.getAddFlags().getFlags())
        + ";remove:"
        + Joiner.on(',').join(flags.getRemoveFlags().getFlags()));
  }

  /** Computes the expected update cost, for use in fee challenges and the like. */
  @Override
  public BaseFee getUpdateFeeOrCredit(
      DomainResource domain,
      String clientId,
      DateTime asOfDate,
      EppInput eppInput) throws EppException {
    return domainNameToFeeOrCredit(domain.getFullyQualifiedDomainName());
  }

  /** Performs additional tasks required for an update command. */
  @Override
  public void performAdditionalDomainUpdateLogic(
      DomainResource domainResource,
      String clientId,
      DateTime asOfDate,
      EppInput eppInput,
      HistoryEntry historyEntry) throws EppException {
    FlagsUpdateCommandExtension flags =
        eppInput.getSingleExtension(FlagsUpdateCommandExtension.class);
    if (flags == null) {
      return;
    }
    throw new TestExtraLogicManagerSuccessException(
        "add:"
        + Joiner.on(',').join(flags.getAddFlags().getFlags())
        + ";remove:"
        + Joiner.on(',').join(flags.getRemoveFlags().getFlags()));
  }
}