/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.beam.sdk.io.aws2.options;

import static org.apache.beam.repackaged.core.org.apache.commons.lang3.reflect.FieldUtils.readField;
import static org.apache.beam.sdk.io.aws2.options.SerializationTestUtil.serialize;
import static org.assertj.core.api.Assertions.assertThat;
import static org.hamcrest.Matchers.hasItem;
import static org.hamcrest.Matchers.instanceOf;
import static org.junit.Assert.assertEquals;
import static software.amazon.awssdk.core.SdkSystemSetting.AWS_ACCESS_KEY_ID;
import static software.amazon.awssdk.core.SdkSystemSetting.AWS_REGION;
import static software.amazon.awssdk.core.SdkSystemSetting.AWS_SECRET_ACCESS_KEY;
import static software.amazon.awssdk.profiles.ProfileFileSystemSetting.AWS_CONFIG_FILE;
import static software.amazon.awssdk.profiles.ProfileFileSystemSetting.AWS_PROFILE;

import com.amazonaws.regions.Regions;
import com.fasterxml.jackson.databind.Module;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;
import java.net.URI;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.List;
import java.util.Properties;
import java.util.function.Supplier;
import org.apache.beam.sdk.testing.ExpectedLogs;
import org.apache.beam.sdk.util.ThrowingSupplier;
import org.apache.beam.sdk.util.common.ReflectHelpers;
import org.hamcrest.MatcherAssert;
import org.junit.ClassRule;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExternalResource;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
import software.amazon.awssdk.auth.credentials.AwsCredentials;
import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider;
import software.amazon.awssdk.auth.credentials.AwsSessionCredentials;
import software.amazon.awssdk.auth.credentials.ContainerCredentialsProvider;
import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider;
import software.amazon.awssdk.auth.credentials.EnvironmentVariableCredentialsProvider;
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
import software.amazon.awssdk.auth.credentials.SystemPropertyCredentialsProvider;
import software.amazon.awssdk.http.apache.ProxyConfiguration;
import software.amazon.awssdk.services.sts.StsClient;
import software.amazon.awssdk.services.sts.auth.StsAssumeRoleCredentialsProvider;
import software.amazon.awssdk.services.sts.model.AssumeRoleRequest;

/** Tests {@link AwsModule}. */
@RunWith(JUnit4.class)
public class AwsModuleTest {

  @ClassRule
  public static final ProfileFile PROFILE =
      new ProfileFile(
          "[default]",
          "aws_access_key_id=defaultkey",
          "aws_secret_access_key=123",
          "[profile other]",
          "aws_access_key_id=otherkey",
          "aws_secret_access_key=abc");

  private static final AwsCredentials DEFAULT_CREDENTIALS =
      AwsBasicCredentials.create("defaultkey", "123");

  private static final AwsCredentials OTHER_CREDENTIALS =
      AwsBasicCredentials.create("otherkey", "abc");

  @Rule public final ExpectedLogs logs = ExpectedLogs.none(AwsModule.class);

  @Test
  public void testObjectMapperIsAbleToFindModule() {
    List<Module> modules = ObjectMapper.findModules(ReflectHelpers.findClassLoader());
    MatcherAssert.assertThat(modules, hasItem(instanceOf(AwsModule.class)));
  }

  private <T> T serializeAndDeserialize(T obj) {
    return SerializationTestUtil.serializeDeserialize((Class<T>) obj.getClass(), obj);
  }

  @Test
  public void testStaticCredentialsProviderSerDe() {
    AwsCredentialsProvider provider =
        StaticCredentialsProvider.create(AwsBasicCredentials.create("key", "secret"));

    assertThat(serializeAndDeserialize(provider))
        .hasSameClassAs(provider)
        .isEqualToComparingFieldByFieldRecursively(provider);

    provider =
        StaticCredentialsProvider.create(AwsSessionCredentials.create("key", "secret", "token"));
    assertThat(serializeAndDeserialize(provider))
        .hasSameClassAs(provider)
        .isEqualToComparingFieldByFieldRecursively(provider);
  }

  @Test
  public void testAwsCredentialsProviderSerDe() {
    AwsCredentialsProvider provider = DefaultCredentialsProvider.create();
    AwsCredentialsProvider deserializedProvider = serializeAndDeserialize(provider);
    assertEquals(provider.getClass(), deserializedProvider.getClass());

    provider = EnvironmentVariableCredentialsProvider.create();
    deserializedProvider = serializeAndDeserialize(provider);
    assertEquals(provider.getClass(), deserializedProvider.getClass());

    provider = SystemPropertyCredentialsProvider.create();
    deserializedProvider = serializeAndDeserialize(provider);
    assertEquals(provider.getClass(), deserializedProvider.getClass());

    provider = ContainerCredentialsProvider.builder().build();
    deserializedProvider = serializeAndDeserialize(provider);
    assertEquals(provider.getClass(), deserializedProvider.getClass());
  }

  @Test
  public void testProfileCredentialsProviderSerDeWithDefaultProfile() throws Exception {
    withSystemProperties(
        PROFILE.properties("default"),
        () -> {
          AwsCredentialsProvider provider = ProfileCredentialsProvider.create();
          String serializedProvider = serialize(provider);

          assertThat(serializedProvider).isEqualTo("{\"@type\":\"ProfileCredentialsProvider\"}");

          AwsCredentialsProvider actual = deserialize(serializedProvider);
          assertThat(actual.resolveCredentials())
              .isEqualToComparingFieldByField(DEFAULT_CREDENTIALS);
          return assertThat(actual)
              .isExactlyInstanceOf(ProfileCredentialsProvider.class)
              .isEqualToComparingFieldByFieldRecursively(provider);
        });
  }

  @Test
  public void testProfileCredentialsProviderSerDeWithCustomProfile() throws Exception {
    withSystemProperties(
        PROFILE.properties("default"),
        () -> {
          AwsCredentialsProvider provider = ProfileCredentialsProvider.create("other");
          String serializedProvider = serialize(provider);

          assertThat(serializedProvider)
              .isEqualTo("{\"@type\":\"ProfileCredentialsProvider\",\"profileName\":\"other\"}");

          AwsCredentialsProvider actual = deserialize(serializedProvider);
          assertThat(actual.resolveCredentials()).isEqualToComparingFieldByField(OTHER_CREDENTIALS);
          return assertThat(actual)
              .isExactlyInstanceOf(ProfileCredentialsProvider.class)
              .isEqualToComparingFieldByFieldRecursively(provider);
        });
  }

  @Test
  public void testProfileCredentialsProviderSerDeWithCustomDefaultProfile() throws Exception {
    withSystemProperties(
        PROFILE.properties("other"),
        () -> {
          AwsCredentialsProvider provider = ProfileCredentialsProvider.create("other");
          String serializedProvider = serialize(provider);

          assertThat(serializedProvider).isEqualTo("{\"@type\":\"ProfileCredentialsProvider\"}");

          AwsCredentialsProvider actual = deserialize(serializedProvider);
          assertThat(actual.resolveCredentials())
              .isEqualToComparingFieldByFieldRecursively(OTHER_CREDENTIALS);
          return assertThat(actual)
              .isExactlyInstanceOf(ProfileCredentialsProvider.class)
              .isEqualToComparingFieldByFieldRecursively(provider);
        });
  }

  @Test
  public void testProfileCredentialsProviderSerDeWithUnknownProfile() throws Exception {
    withSystemProperties(
        PROFILE.properties("default"),
        () -> {
          AwsCredentialsProvider provider = ProfileCredentialsProvider.create("unknown");
          String serializedProvider = serialize(provider);

          // ProfileCredentialsProvider SILENTLY drops unknown profiles
          assertThat(serializedProvider).isEqualTo("{\"@type\":\"ProfileCredentialsProvider\"}");

          AwsCredentialsProvider actual = deserialize(serializedProvider);
          // NOTE: This documents the unexpected behavior in case a faulty provider is serialized
          return assertThat(actual.resolveCredentials())
              .isEqualToComparingFieldByField(DEFAULT_CREDENTIALS);
        });

    logs.verifyWarn("Serialized ProfileCredentialsProvider in faulty state.");
  }

  @Test
  public void testStsAssumeRoleCredentialsProviderSerDe() throws Exception {
    AssumeRoleRequest req = AssumeRoleRequest.builder().roleArn("roleArn").policy("policy").build();
    Supplier<AwsCredentialsProvider> provider =
        () ->
            StsAssumeRoleCredentialsProvider.builder()
                .stsClient(StsClient.create())
                .refreshRequest(req)
                .build();

    Properties overrides = new Properties();
    overrides.setProperty(AWS_REGION.property(), Regions.US_EAST_1.getName());
    overrides.setProperty(AWS_ACCESS_KEY_ID.property(), "key");
    overrides.setProperty(AWS_SECRET_ACCESS_KEY.property(), "secret");

    // Region and credentials for STS client are resolved using default providers
    AwsCredentialsProvider deserializedProvider =
        withSystemProperties(overrides, () -> serializeAndDeserialize(provider.get()));

    Supplier<AssumeRoleRequest> requestSupplier =
        (Supplier<AssumeRoleRequest>)
            readField(deserializedProvider, "assumeRoleRequestSupplier", true);
    assertThat(requestSupplier.get()).isEqualTo(req);
  }

  @Test
  public void testProxyConfigurationSerDe() {
    ProxyConfiguration proxyConfiguration =
        ProxyConfiguration.builder()
            .endpoint(URI.create("http://localhost:8080"))
            .username("username")
            .password("password")
            .build();

    ProxyConfiguration deserializedProxyConfiguration = serializeAndDeserialize(proxyConfiguration);
    assertEquals("localhost", deserializedProxyConfiguration.host());
    assertEquals(8080, deserializedProxyConfiguration.port());
    assertEquals("username", deserializedProxyConfiguration.username());
    assertEquals("password", deserializedProxyConfiguration.password());
  }

  private <T> T withSystemProperties(Properties overrides, ThrowingSupplier<T> fun)
      throws Exception {
    Properties systemProps = System.getProperties();

    Properties previousProps = new Properties();
    systemProps.entrySet().stream()
        .filter(e -> overrides.containsKey(e.getKey()))
        .forEach(e -> previousProps.put(e.getKey(), e.getValue()));

    overrides.forEach(systemProps::put);
    try {
      return fun.get();
    } finally {
      overrides.forEach(systemProps::remove);
      previousProps.forEach(systemProps::put);
    }
  }

  private static AwsCredentialsProvider deserialize(String provider) {
    return SerializationTestUtil.deserialize(provider, AwsCredentialsProvider.class);
  }

  static class ProfileFile extends ExternalResource {
    private String[] lines;
    private Path path;

    public ProfileFile(String... lines) {
      this.lines = lines;
    }

    public Properties properties(String defaultProfile) {
      Properties props = new Properties();
      props.setProperty(AWS_CONFIG_FILE.property(), path.toString());
      props.setProperty(AWS_PROFILE.property(), defaultProfile);
      return props;
    }

    @Override
    protected void before() throws Throwable {
      path = Files.createTempFile("profile", ".conf");
      Files.write(path, Arrays.asList(lines));
    }

    @Override
    protected void after() {
      try {
        Files.delete(path);
      } catch (IOException e) {
        // ignore
      }
    }
  }
}
