SCM-Manager/scm-webapp/src/test/java/sonia/scm/DefaultRootURLTest.java

/*
 * MIT License
 *
 * Copyright (c) 2020-present Cloudogu GmbH and Contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package sonia.scm;

import com.google.inject.OutOfScopeException;
import com.google.inject.ProvisionException;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import sonia.scm.config.ScmConfiguration;
import sonia.scm.util.HttpUtil;

import javax.inject.Provider;
import javax.servlet.http.HttpServletRequest;
import java.net.MalformedURLException;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.Mockito.when;

@ExtendWith(MockitoExtension.class)
class DefaultRootURLTest {

  private static final String URL_CONFIG = "https://hitchhiker.com/from-configuration";
  private static final String URL_REQUEST = "https://hitchhiker.com/from-request";

  @Mock
  private Provider<HttpServletRequest> requestProvider;

  @Mock
  private HttpServletRequest request;

  private ScmConfiguration configuration;

  private RootURL rootURL;

  @BeforeEach
  void init() {
    configuration = new ScmConfiguration();
    rootURL = new DefaultRootURL(requestProvider, configuration);
  }

  @Test
  void shouldUseRootURLFromRequest() {
    bindRequestUrl();
    assertThat(rootURL.getAsString()).isEqualTo(URL_REQUEST);
  }

  private void bindRequestUrl() {
    when(requestProvider.get()).thenReturn(request);
    when(request.getRequestURL()).thenReturn(new StringBuffer(URL_REQUEST));
    when(request.getRequestURI()).thenReturn("/from-request");
    when(request.getContextPath()).thenReturn("/from-request");
  }

  @Test
  void shouldUseRootURLFromConfiguration() {
    bindNonHttpScope();
    configuration.setBaseUrl(URL_CONFIG);
    assertThat(rootURL.getAsString()).isEqualTo(URL_CONFIG);
  }

  private void bindNonHttpScope() {
    when(requestProvider.get()).thenThrow(
      new ProvisionException("no request available", new OutOfScopeException("out of scope"))
    );
  }

  @Test
  void shouldThrowNonOutOfScopeProvisioningExceptions() {
    when(requestProvider.get()).thenThrow(
      new ProvisionException("something ugly happened", new IllegalStateException("some wrong state"))
    );

    assertThrows(ProvisionException.class, () -> rootURL.get());
  }

  @Test
  void shouldThrowIllegalStateExceptionForMalformedBaseUrl() {
    bindNonHttpScope();
    configuration.setBaseUrl("non_url");

    IllegalStateException exception = assertThrows(IllegalStateException.class, () -> rootURL.get());
    assertThat(exception.getMessage()).contains("malformed", "non_url");
    assertThat(exception.getCause()).isInstanceOf(MalformedURLException.class);
  }

  @Test
  void shouldThrowIllegalStateExceptionIfBaseURLIsNotConfigured() {
    bindNonHttpScope();

    IllegalStateException exception = assertThrows(IllegalStateException.class, () -> rootURL.get());
    assertThat(exception.getMessage()).contains("empty");
  }

  @Test
  void shouldUseRootURLFromForwardedRequest() {
    bindForwardedRequestUrl();
    assertThat(rootURL.get()).hasHost("hitchhiker.com");
  }

  private void bindForwardedRequestUrl() {
    when(requestProvider.get()).thenReturn(request);
    when(request.getHeader(HttpUtil.HEADER_X_FORWARDED_HOST)).thenReturn("hitchhiker.com");
    when(request.getScheme()).thenReturn("https");
    when(request.getServerPort()).thenReturn(443);
    when(request.getContextPath()).thenReturn("/from-request");
  }

}