SCM-Manager/scm-it/src/test/java/sonia/scm/it/utils/ScmRequests.java

package sonia.scm.it.utils;

import io.restassured.RestAssured;
import io.restassured.response.Response;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import sonia.scm.user.User;
import sonia.scm.web.VndMediaType;

import java.util.List;
import java.util.Map;
import java.util.function.Consumer;

import static org.hamcrest.Matchers.is;
import static sonia.scm.it.utils.TestData.createPasswordChangeJson;


/**
 * Encapsulate rest requests of a repository in builder pattern
 * <p>
 * A Get Request can be applied with the methods request*()
 * These methods return a AppliedGet*Request object
 * This object can be used to apply general assertions over the rest Assured response
 * In the AppliedGet*Request classes there is a using*Response() method
 * that return the *Response class containing specific operations related to the specific response
 * the *Response class contains also the request*() method to apply the next GET request from a link in the response.
 */
public class ScmRequests {

  private static final Logger LOG = LoggerFactory.getLogger(ScmRequests.class);

  private String username;
  private String password;

  public static ScmRequests start() {
    return new ScmRequests();
  }

  public IndexResponse requestIndexResource(String username, String password) {
    setUsername(username);
    setPassword(password);
    return new IndexResponse(applyGETRequest(RestUtil.REST_BASE_URL.toString()));
  }

  public <SELF extends UserResponse<SELF, T>, T extends ModelResponse> UserResponse<SELF,T> requestUser(String username, String password, String pathParam) {
    setUsername(username);
    setPassword(password);
    return new UserResponse<>(applyGETRequest(RestUtil.REST_BASE_URL.resolve("users/"+pathParam).toString()), null);
  }

  public ChangePasswordResponse<ChangePasswordResponse> requestUserChangePassword(String username, String password, String userPathParam, String newPassword) {
    setUsername(username);
    setPassword(password);
    return new ChangePasswordResponse<>(applyPUTRequest(RestUtil.REST_BASE_URL.resolve("users/"+userPathParam+"/password").toString(), VndMediaType.PASSWORD_OVERWRITE, TestData.createPasswordChangeJson(password,newPassword)), null);

  }

  /**
   * Apply a GET Request to the extracted url from the given link
   *
   * @param linkPropertyName the property name of link
   * @param response         the response containing the link
   * @return the response of the GET request using the given link
   */
  private Response applyGETRequestFromLink(Response response, String linkPropertyName) {
    return applyGETRequestFromLinkWithParams(response, linkPropertyName, "");
  }

  /**
   * Apply a GET Request to the extracted url from the given link
   *
   * @param linkPropertyName the property name of link
   * @param response         the response containing the link
   * @param params           query params eg. ?q=xyz&count=12 or path params eg. namespace/name
   * @return the response of the GET request using the given link
   */
  private Response applyGETRequestFromLinkWithParams(Response response, String linkPropertyName, String params) {
    return applyGETRequestWithQueryParams(response
      .then()
      .extract()
      .path(linkPropertyName), params);
  }

  /**
   * Apply a GET Request to the given <code>url</code> and return the response.
   *
   * @param url    the url of the GET request
   * @param params query params eg. ?q=xyz&count=12 or path params eg. namespace/name
   * @return the response of the GET request using the given <code>url</code>
   */
  private Response applyGETRequestWithQueryParams(String url, String params) {
    LOG.info("GET {}", url);
    return RestAssured.given()
      .auth().preemptive().basic(username, password)
      .when()
      .get(url + params);
  }

  /**
   * Apply a GET Request to the given <code>url</code> and return the response.
   *
   * @param url the url of the GET request
   * @return the response of the GET request using the given <code>url</code>
   **/
  private Response applyGETRequest(String url) {
    return applyGETRequestWithQueryParams(url, "");
  }


  /**
   * Apply a PUT Request to the extracted url from the given link
   *
   * @param response         the response containing the link
   * @param linkPropertyName the property name of link
   * @param body
   * @return the response of the PUT request using the given link
   */
  private Response applyPUTRequestFromLink(Response response, String linkPropertyName, String content, String body) {
    return applyPUTRequest(response
      .then()
      .extract()
      .path(linkPropertyName), content, body);
  }


  /**
   * Apply a PUT Request to the given <code>url</code> and return the response.
   *
   * @param url       the url of the PUT request
   * @param mediaType
   * @param body
   * @return the response of the PUT request using the given <code>url</code>
   */
  private Response applyPUTRequest(String url, String mediaType, String body) {
    LOG.info("PUT {}", url);
    return RestAssured.given()
      .auth().preemptive().basic(username, password)
      .when()
      .contentType(mediaType)
      .accept(mediaType)
      .body(body)
      .put(url);
  }

  private void setUsername(String username) {
    this.username = username;
  }

  private void setPassword(String password) {
    this.password = password;
  }

  public class IndexResponse extends ModelResponse<IndexResponse, IndexResponse> {
    public static final String LINK_AUTOCOMPLETE_USERS = "_links.autocomplete.find{it.name=='users'}.href";
    public static final String LINK_AUTOCOMPLETE_GROUPS = "_links.autocomplete.find{it.name=='groups'}.href";
    public static final String LINK_REPOSITORIES = "_links.repositories.href";
    private static final String LINK_ME = "_links.me.href";
    private static final String LINK_USERS = "_links.users.href";

    public IndexResponse(Response response) {
      super(response, null);
    }

    public AutoCompleteResponse<IndexResponse> requestAutoCompleteUsers(String q) {
      return new AutoCompleteResponse<>(applyGETRequestFromLinkWithParams(response, LINK_AUTOCOMPLETE_USERS, "?q=" + q), this);
    }

    public AutoCompleteResponse<IndexResponse> requestAutoCompleteGroups(String q) {
      return new AutoCompleteResponse<>(applyGETRequestFromLinkWithParams(response, LINK_AUTOCOMPLETE_GROUPS, "?q=" + q), this);
    }

    public RepositoryResponse<IndexResponse> requestRepository(String namespace, String name) {
      return new RepositoryResponse<>(applyGETRequestFromLinkWithParams(response, LINK_REPOSITORIES, namespace + "/" + name), this);
    }

    public MeResponse<IndexResponse> requestMe() {
      return new MeResponse<>(applyGETRequestFromLink(response, LINK_ME), this);
    }

    public UserResponse<? extends UserResponse, IndexResponse> requestUser(String username) {
      return new UserResponse<>(applyGETRequestFromLinkWithParams(response, LINK_USERS, username), this);
    }

    public IndexResponse assertUsersLinkDoesNotExists() {
      return super.assertPropertyPathDoesNotExists(LINK_USERS);
    }


  }

  public class RepositoryResponse<PREV extends ModelResponse> extends ModelResponse<RepositoryResponse<PREV>, PREV> {


    public static final String LINKS_SOURCES = "_links.sources.href";
    public static final String LINKS_CHANGESETS = "_links.changesets.href";

    public RepositoryResponse(Response response, PREV previousResponse) {
      super(response, previousResponse);
    }

    public SourcesResponse<RepositoryResponse> requestSources() {
      return new SourcesResponse<>(applyGETRequestFromLink(response, LINKS_SOURCES), this);
    }

    public ChangesetsResponse<RepositoryResponse> requestChangesets() {
      return new ChangesetsResponse<>(applyGETRequestFromLink(response, LINKS_CHANGESETS), this);
    }

  }

  public class ChangesetsResponse<PREV extends ModelResponse> extends ModelResponse<ChangesetsResponse<PREV>, PREV> {

    public ChangesetsResponse(Response response, PREV previousResponse) {
      super(response, previousResponse);
    }

    public ChangesetsResponse assertChangesets(Consumer<List<Map>> changesetsConsumer) {
      List<Map> changesets = response.then().extract().path("_embedded.changesets");
      changesetsConsumer.accept(changesets);
      return this;
    }

    public DiffResponse<ChangesetsResponse> requestDiff(String revision) {
      return new DiffResponse<>(applyGETRequestFromLink(response, "_embedded.changesets.find{it.id=='" + revision + "'}._links.diff.href"), this);
    }

    public ModificationsResponse<ChangesetsResponse> requestModifications(String revision) {
      return new ModificationsResponse<>(applyGETRequestFromLink(response, "_embedded.changesets.find{it.id=='" + revision + "'}._links.modifications.href"), this);
    }
  }


  public class SourcesResponse<PREV extends ModelResponse> extends ModelResponse<SourcesResponse<PREV>, PREV> {

    public SourcesResponse(Response response, PREV previousResponse) {
      super(response, previousResponse);
    }

    public SourcesResponse assertRevision(Consumer<String> assertRevision) {
      String revision = response.then().extract().path("revision");
      assertRevision.accept(revision);
      return this;
    }

    public SourcesResponse assertFiles(Consumer<List> assertFiles) {
      List files = response.then().extract().path("files");
      assertFiles.accept(files);
      return this;
    }

    public ChangesetsResponse<SourcesResponse> requestFileHistory(String fileName) {
      return new ChangesetsResponse<>(applyGETRequestFromLink(response, "_embedded.files.find{it.name=='" + fileName + "'}._links.history.href"), this);
    }

    public SourcesResponse<SourcesResponse> requestSelf(String fileName) {
      return new SourcesResponse<>(applyGETRequestFromLink(response, "_embedded.files.find{it.name=='" + fileName + "'}._links.self.href"), this);
    }
  }

  public class ModificationsResponse<PREV extends ModelResponse> extends ModelResponse<ModificationsResponse<PREV>, PREV> {

    public ModificationsResponse(Response response, PREV previousResponse) {
      super(response, previousResponse);
    }

    public ModificationsResponse<PREV> assertRevision(Consumer<String> assertRevision) {
      String revision = response.then().extract().path("revision");
      assertRevision.accept(revision);
      return this;
    }

    public ModificationsResponse<PREV> assertAdded(Consumer<List<String>> assertAdded) {
      List<String> added = response.then().extract().path("added");
      assertAdded.accept(added);
      return this;
    }

    public ModificationsResponse<PREV> assertRemoved(Consumer<List<String>> assertRemoved) {
      List<String> removed = response.then().extract().path("removed");
      assertRemoved.accept(removed);
      return this;
    }

    public ModificationsResponse<PREV> assertModified(Consumer<List<String>> assertModified) {
      List<String> modified = response.then().extract().path("modified");
      assertModified.accept(modified);
      return this;
    }

  }

  public class MeResponse<PREV extends ModelResponse> extends UserResponse<MeResponse<PREV>, PREV> {


    public MeResponse(Response response, PREV previousResponse) {
      super(response, previousResponse);
    }

    public ChangePasswordResponse<UserResponse> requestChangePassword(String oldPassword, String newPassword) {
      return new ChangePasswordResponse<>(applyPUTRequestFromLink(super.response, LINKS_PASSWORD_HREF, VndMediaType.PASSWORD_CHANGE, createPasswordChangeJson(oldPassword, newPassword)), this);
    }
  }

  public class UserResponse<SELF extends UserResponse<SELF, PREV>, PREV extends ModelResponse> extends ModelResponse<SELF, PREV> {

    public static final String LINKS_PASSWORD_HREF = "_links.password.href";

    public UserResponse(Response response, PREV previousResponse) {
      super(response, previousResponse);
    }

    public SELF assertPassword(Consumer<String> assertPassword) {
      return super.assertSingleProperty(assertPassword, "password");
    }

    public SELF assertType(Consumer<String> assertType) {
      return assertSingleProperty(assertType, "type");
    }

    public SELF assertAdmin(Consumer<Boolean> assertAdmin) {
      return assertSingleProperty(assertAdmin, "admin");
    }

    public SELF assertPasswordLinkDoesNotExists() {
      return assertPropertyPathDoesNotExists(LINKS_PASSWORD_HREF);
    }

    public SELF assertPasswordLinkExists() {
      return assertPropertyPathExists(LINKS_PASSWORD_HREF);
    }

    public ChangePasswordResponse<UserResponse> requestChangePassword(String newPassword) {
      return new ChangePasswordResponse<>(applyPUTRequestFromLink(super.response, LINKS_PASSWORD_HREF, VndMediaType.PASSWORD_OVERWRITE, createPasswordChangeJson(null, newPassword)), this);
    }
  }


  /**
   * encapsulate standard assertions over model properties
   */
  public class ModelResponse<SELF extends ModelResponse<SELF, PREV>, PREV extends ModelResponse> {

    protected PREV previousResponse;
    protected Response response;

    public ModelResponse(Response response, PREV previousResponse) {
      this.response = response;
      this.previousResponse = previousResponse;
    }

    public PREV returnToPrevious() {
      return previousResponse;
    }

    public <T> SELF assertSingleProperty(Consumer<T> assertSingleProperty, String propertyJsonPath) {
      T propertyValue = response.then().extract().path(propertyJsonPath);
      assertSingleProperty.accept(propertyValue);
      return (SELF) this;
    }

    public SELF assertPropertyPathExists(String propertyJsonPath) {
      response.then().assertThat().body("any { it.containsKey('" + propertyJsonPath + "')}", is(true));
      return (SELF) this;
    }

    public SELF assertPropertyPathDoesNotExists(String propertyJsonPath) {
      response.then().assertThat().body("this.any { it.containsKey('" + propertyJsonPath + "')}", is(false));
      return (SELF) this;
    }

    public SELF assertArrayProperty(Consumer<List> assertProperties, String propertyJsonPath) {
      List properties = response.then().extract().path(propertyJsonPath);
      assertProperties.accept(properties);
      return (SELF) this;
    }

    /**
     * special assertion of the status code
     *
     * @param expectedStatusCode the expected status code
     * @return the self object
     */
    public SELF assertStatusCode(int expectedStatusCode) {
      this.response.then().assertThat().statusCode(expectedStatusCode);
      return (SELF) this;
    }
  }

  public class AutoCompleteResponse<PREV extends ModelResponse> extends ModelResponse<AutoCompleteResponse<PREV>, PREV> {

    public AutoCompleteResponse(Response response, PREV previousResponse) {
      super(response, previousResponse);
    }

    public AutoCompleteResponse<PREV> assertAutoCompleteResults(Consumer<List<Map>> checker) {
      List<Map> result = response.then().extract().path("");
      checker.accept(result);
      return this;
    }

  }


  public class DiffResponse<PREV extends ModelResponse> extends ModelResponse<DiffResponse<PREV>, PREV> {

    public DiffResponse(Response response, PREV previousResponse) {
      super(response, previousResponse);
    }
  }

  public class ChangePasswordResponse<PREV extends ModelResponse> extends ModelResponse<ChangePasswordResponse<PREV>, PREV> {

    public ChangePasswordResponse(Response response, PREV previousResponse) {
      super(response, previousResponse);
    }
  }
}