IdACmdAdminCreateTest.java

/*
 * Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package com.io7m.idstore.tests.server.controller.admin;

import com.io7m.idstore.database.api.IdDatabaseAdminsQueriesType;
import com.io7m.idstore.database.api.IdDatabaseException;
import com.io7m.idstore.model.IdAdmin;
import com.io7m.idstore.model.IdAdminPermissionSet;
import com.io7m.idstore.model.IdEmail;
import com.io7m.idstore.model.IdName;
import com.io7m.idstore.model.IdNonEmptyList;
import com.io7m.idstore.model.IdRealName;
import com.io7m.idstore.protocol.admin.IdACommandAdminCreate;
import com.io7m.idstore.protocol.admin.IdAResponseAdminCreate;
import com.io7m.idstore.server.controller.admin.IdACmdAdminCreate;
import com.io7m.idstore.server.controller.command_exec.IdCommandExecutionFailure;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;

import java.util.Map;
import java.util.Optional;
import java.util.Set;

import static com.io7m.idstore.error_codes.IdStandardErrorCodes.ADMIN_DUPLICATE;
import static com.io7m.idstore.error_codes.IdStandardErrorCodes.SECURITY_POLICY_DENIED;
import static com.io7m.idstore.model.IdAdminPermission.ADMIN_CREATE;
import static com.io7m.idstore.model.IdAdminPermission.USER_WRITE_EMAIL;
import static java.util.Optional.empty;
import static java.util.UUID.randomUUID;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.mockito.Mockito.when;

public final class IdACmdAdminCreateTest
  extends IdACmdAbstractContract
{
  /**
   * Creating admins requires the ADMIN_CREATE permission.
   *
   * @throws Exception On errors
   */

  @Test
  public void testNotAllowed()
    throws Exception
  {
    /* Arrange. */

    final var admin =
      this.createAdmin("admin", IdAdminPermissionSet.empty());
    final var context =
      this.createContextAndSession(admin);

    /* Act. */

    final var handler = new IdACmdAdminCreate();
    final var ex =
      assertThrows(IdCommandExecutionFailure.class, () -> {
        handler.execute(context, new IdACommandAdminCreate(
          empty(),
          new IdName("ad"),
          new IdRealName("Someone"),
          new IdEmail("someone-else@example.com"),
          this.password(),
          Set.of()
        ));
      });

    /* Assert. */

    assertEquals(SECURITY_POLICY_DENIED, ex.errorCode());
  }

  /**
   * An admin cannot be created with more permissions than the creator.
   *
   * @throws Exception On errors
   */

  @Test
  public void testNoEscalation()
    throws Exception
  {
    /* Arrange. */

    final var admin =
      this.createAdmin("admin", IdAdminPermissionSet.of(ADMIN_CREATE));
    final var context =
      this.createContextAndSession(admin);

    /* Act. */

    final var handler = new IdACmdAdminCreate();
    final var ex =
      assertThrows(IdCommandExecutionFailure.class, () -> {
        handler.execute(context, new IdACommandAdminCreate(
          empty(),
          new IdName("ad"),
          new IdRealName("Someone"),
          new IdEmail("someone-else@example.com"),
          this.password(),
          Set.of(ADMIN_CREATE, USER_WRITE_EMAIL)
        ));
      });

    /* Assert. */

    assertEquals(SECURITY_POLICY_DENIED, ex.errorCode());
  }

  /**
   * Creating admins requires the admin to not exist.
   *
   * @throws Exception On errors
   */

  @Test
  public void testMustNotExist()
    throws Exception
  {
    /* Arrange. */

    final var admin0 =
      this.createAdmin("admin0", IdAdminPermissionSet.of(ADMIN_CREATE));
    final var context =
      this.createContextAndSession(admin0);

    final var admins =
      mock(IdDatabaseAdminsQueriesType.class);

    Mockito.doThrow(new IdDatabaseException("", ADMIN_DUPLICATE, Map.of(), empty()))
      .when(admins)
      .adminCreate(
        any(),
        any(),
        any(),
        any(),
        any(),
        any(),
        any()
      );

    final var transaction = this.transaction();
    when(transaction.queries(IdDatabaseAdminsQueriesType.class))
      .thenReturn(admins);

    final var password = this.password();

    /* Act. */

    final var handler = new IdACmdAdminCreate();
    final var ex =
      assertThrows(IdCommandExecutionFailure.class, () -> {
        handler.execute(context, new IdACommandAdminCreate(
          empty(),
          new IdName("ad"),
          new IdRealName("Someone"),
          new IdEmail("someone-else@example.com"),
          password,
          Set.of()
        ));
      });

    /* Assert. */

    assertEquals(ADMIN_DUPLICATE, ex.errorCode());

    verify(transaction).queries(IdDatabaseAdminsQueriesType.class);
    verify(transaction).adminIdSet(admin0.id());
    verify(admins, this.once())
      .adminCreate(
        any(),
        Mockito.eq(new IdName("ad")),
        Mockito.eq(new IdRealName("Someone")),
        Mockito.eq(new IdEmail("someone-else@example.com")),
        any(),
        Mockito.eq(password),
        Mockito.eq(Set.of())
      );
    verifyNoMoreInteractions(admins);
    verifyNoMoreInteractions(transaction);
  }

  /**
   * Creating admins works.
   *
   * @throws Exception On errors
   */

  @Test
  public void testCreateOK()
    throws Exception
  {
    /* Arrange. */

    final var admin0 =
      this.createAdmin("admin0", IdAdminPermissionSet.of(ADMIN_CREATE));
    final var context =
      this.createContextAndSession(admin0);

    final var adminId =
      randomUUID();
    final var password =
      this.password();
    final var expectedAdmin =
      new IdAdmin(
        adminId,
        new IdName("ad"),
        new IdRealName("Someone"),
        IdNonEmptyList.single(new IdEmail("someone-else@example.com")),
        this.timeStart(),
        this.timeStart().plusSeconds(1L),
        password,
        IdAdminPermissionSet.empty()
      );

    final var admins =
      mock(IdDatabaseAdminsQueriesType.class);

    when(admins.adminCreate(
        any(),
        any(),
        any(),
        any(),
        any(),
        any(),
        any()))
      .thenReturn(expectedAdmin);

    final var transaction = this.transaction();
    when(transaction.queries(IdDatabaseAdminsQueriesType.class))
      .thenReturn(admins);

    /* Act. */

    final var handler =
      new IdACmdAdminCreate();
    final var response =
      handler.execute(context, new IdACommandAdminCreate(
        Optional.of(adminId),
        new IdName("ad"),
        new IdRealName("Someone"),
        new IdEmail("someone-else@example.com"),
        password,
        Set.of()
      ));

    /* Assert. */

    assertEquals(
      new IdAResponseAdminCreate(
        context.requestId(),
        expectedAdmin.withRedactedPassword()),
      response
    );

    verify(transaction).queries(IdDatabaseAdminsQueriesType.class);
    verify(transaction).adminIdSet(admin0.id());
    verify(admins, this.once())
      .adminCreate(
        any(),
        Mockito.eq(new IdName("ad")),
        Mockito.eq(new IdRealName("Someone")),
        Mockito.eq(new IdEmail("someone-else@example.com")),
        any(),
        Mockito.eq(password),
        Mockito.eq(Set.of())
      );
    verifyNoMoreInteractions(admins);
    verifyNoMoreInteractions(transaction);
  }
}