/*
 * 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.coders;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.collection.IsIterableContainingInAnyOrder.containsInAnyOrder;

import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.OutputStream;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.apache.beam.sdk.Pipeline;
import org.apache.beam.sdk.testing.NeedsRunner;
import org.apache.beam.sdk.testing.PAssert;
import org.apache.beam.sdk.testing.TestPipeline;
import org.apache.beam.sdk.transforms.Create;
import org.apache.beam.sdk.transforms.DoFn;
import org.apache.beam.sdk.transforms.ParDo;
import org.apache.beam.sdk.transforms.Reshuffle;
import org.apache.beam.sdk.transforms.SerializableFunction;
import org.apache.beam.sdk.values.PCollection;
import org.hamcrest.Description;
import org.hamcrest.TypeSafeMatcher;
import org.junit.Ignore;
import org.junit.Rule;
import org.junit.Test;
import org.junit.experimental.categories.Category;
import org.junit.rules.ExpectedException;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/** Tests for coder exception handling in runners. */
@RunWith(JUnit4.class)
@SuppressWarnings({
  "nullness" // TODO(https://issues.apache.org/jira/browse/BEAM-10402)
})
public class PCollectionCustomCoderTest {
  private static final Logger LOG = LoggerFactory.getLogger(PCollectionCustomCoderTest.class);
  /**
   * A custom test coder that can throw various exceptions during:
   *
   * <ul>
   *   <li>encoding or decoding of data.
   *   <li>serializing or deserializing the coder.
   * </ul>
   */
  static final String IO_EXCEPTION = "java.io.IOException";

  static final String NULL_POINTER_EXCEPTION = "java.lang.NullPointerException";
  static final String EXCEPTION_MESSAGE = "Super Unique Message!!!";

  @Rule public final transient ExpectedException thrown = ExpectedException.none();
  @Rule public final transient TestPipeline pipeline = TestPipeline.create();

  /** Wrapper of StringUtf8Coder with customizable exception-throwing. */
  public static class CustomTestCoder extends CustomCoder<String> {
    private final String decodingException;
    private final String encodingException;
    private final String serializationException;
    private final String deserializationException;
    private final String exceptionMessage;

    /**
     * @param decodingException The fully qualified class name of the exception to throw while
     *     decoding data. e.g. (e.g. 'java.lang.NullPointerException')
     * @param encodingException The fully qualified class name of the exception to throw while
     *     encoding data. e.g. (e.g. 'java.lang.NullPointerException')
     * @param serializationException The fully qualified class name of the exception to throw while
     *     serializing the coder. (e.g. 'java.lang.NullPointerException')
     * @param deserializationException The fully qualified class name of the exception to throw
     *     while deserializing the coder. (e.g. 'java.lang.NullPointerException')
     * @param exceptionMessage The message to place inside the body of the exception.
     */
    public CustomTestCoder(
        String decodingException,
        String encodingException,
        String serializationException,
        String deserializationException,
        String exceptionMessage) {
      this.decodingException = decodingException;
      this.encodingException = encodingException;
      this.serializationException = serializationException;
      this.deserializationException = deserializationException;
      this.exceptionMessage = exceptionMessage;
    }

    @Override
    public void encode(String value, OutputStream outStream) throws CoderException, IOException {
      throwIfPresent(encodingException);
      StringUtf8Coder.of().encode(value, outStream);
    }

    @Override
    public String decode(InputStream inStream) throws CoderException, IOException {
      throwIfPresent(decodingException);
      return StringUtf8Coder.of().decode(inStream);
    }

    private void writeObject(ObjectOutputStream out) throws IOException {
      throwIfPresent(serializationException);
      out.defaultWriteObject();
    }

    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
      in.defaultReadObject();
      throwIfPresent(deserializationException);
    }

    /**
     * Constructs and throws the specified exception.
     *
     * @param exceptionClassName The fully qualified class name of the exception to throw. If null,
     *     then no exception will be thrown.
     * @throws IOException Is thrown if java.lang.IOException is passed in as exceptionClassName.
     */
    private void throwIfPresent(String exceptionClassName) throws IOException {
      if (exceptionClassName == null) {
        return;
      }
      try {
        Object throwable =
            Class.forName(exceptionClassName)
                .getConstructor(String.class)
                .newInstance(exceptionMessage);
        if (throwable instanceof IOException) {
          throw (IOException) throwable;
        } else {
          throw new RuntimeException((Throwable) throwable);
        }
      } catch (InvocationTargetException
          | NoSuchMethodException
          | ClassNotFoundException
          | IllegalAccessException
          | InstantiationException e) {
        throw new RuntimeException(e);
      }
    }
  }

  @Test
  @Category(NeedsRunner.class)
  public void testDecodingIOException() throws Exception {
    Pipeline p =
        pipelineWith(new CustomTestCoder(IO_EXCEPTION, null, null, null, EXCEPTION_MESSAGE));

    thrown.expect(Exception.class);
    thrown.expect(new ExceptionMatcher("java.io.IOException: Super Unique Message!!!"));
    p.run().waitUntilFinish();
  }

  @Test
  @Category(NeedsRunner.class)
  public void testDecodingNPException() throws Exception {
    Pipeline p =
        pipelineWith(
            new CustomTestCoder(NULL_POINTER_EXCEPTION, null, null, null, EXCEPTION_MESSAGE));
    thrown.expect(Exception.class);
    thrown.expect(new ExceptionMatcher("java.lang.NullPointerException: Super Unique Message!!!"));

    p.run().waitUntilFinish();
  }

  @Test
  @Category(NeedsRunner.class)
  public void testEncodingIOException() throws Exception {
    Pipeline p =
        pipelineWith(new CustomTestCoder(null, IO_EXCEPTION, null, null, EXCEPTION_MESSAGE));
    thrown.expect(Exception.class);
    thrown.expect(new ExceptionMatcher("java.io.IOException: Super Unique Message!!!"));

    p.run().waitUntilFinish();
  }

  @Test
  @Category(NeedsRunner.class)
  public void testEncodingNPException() throws Exception {
    Pipeline p =
        pipelineWith(
            new CustomTestCoder(null, NULL_POINTER_EXCEPTION, null, null, EXCEPTION_MESSAGE));
    thrown.expect(Exception.class);
    thrown.expect(new ExceptionMatcher("java.lang.NullPointerException: Super Unique Message!!!"));
    p.run().waitUntilFinish();
  }

  @Test
  @Category(NeedsRunner.class)
  public void testSerializationIOException() throws Exception {
    Pipeline p =
        pipelineWith(new CustomTestCoder(null, null, IO_EXCEPTION, null, EXCEPTION_MESSAGE));
    thrown.expect(Exception.class);
    thrown.expect(new ExceptionMatcher("java.io.IOException: Super Unique Message!!!"));
    p.run().waitUntilFinish();
  }

  @Test
  @Category(NeedsRunner.class)
  public void testSerializationNPException() throws Exception {
    Pipeline p =
        pipelineWith(
            new CustomTestCoder(null, null, NULL_POINTER_EXCEPTION, null, EXCEPTION_MESSAGE));
    thrown.expect(Exception.class);
    thrown.expect(new ExceptionMatcher("java.lang.NullPointerException: Super Unique Message!!!"));

    p.run().waitUntilFinish();
  }

  // TODO(BEAM-6004) Have DirectRunner trigger deserialization.
  @Ignore("DirectRunner doesn't decode coders so this test does not pass.")
  @Test
  @Category(NeedsRunner.class)
  public void testDeserializationIOException() throws Exception {
    Pipeline p =
        pipelineWith(new CustomTestCoder(null, null, null, IO_EXCEPTION, EXCEPTION_MESSAGE));
    thrown.expect(Exception.class);
    thrown.expect(new ExceptionMatcher("java.io.IOException: Super Unique Message!!!"));
    p.run().waitUntilFinish();
  }

  // TODO(BEAM-6004) Have DirectRunner trigger deserialization.
  @Ignore("DirectRunner doesn't decode coders so this test does not pass.")
  @Test
  @Category(NeedsRunner.class)
  public void testDeserializationNPException() throws Exception {
    Pipeline p =
        pipelineWith(
            new CustomTestCoder(null, null, null, NULL_POINTER_EXCEPTION, EXCEPTION_MESSAGE));
    thrown.expect(Exception.class);
    thrown.expect(new ExceptionMatcher("java.lang.NullPointerException: Super Unique Message!!!"));
    p.run().waitUntilFinish();
  }

  @Test
  @Category(NeedsRunner.class)
  public void testNoException() throws Exception {
    Pipeline p = pipelineWith(new CustomTestCoder(null, null, null, null, null));
    p.run().waitUntilFinish();
  }

  public Pipeline pipelineWith(CustomTestCoder coder) throws Exception {
    List<String> pipelineContents =
        Arrays.asList("String", "Testing", "Custom", "Coder", "In", "Beam");

    // Create input.
    PCollection<String> customCoderPC =
        pipeline
            .begin()
            .apply("ReadStrings", Create.of(pipelineContents))
            .setCoder(coder)
            .apply(Reshuffle.viaRandomKey());
    PCollection<String> fixedCoderPC =
        customCoderPC.apply("Identity", ParDo.of(new IdentityDoFn()));
    fixedCoderPC.setCoder(StringUtf8Coder.of());
    ContentReader r = ContentReader.elementsEqual(pipelineContents);
    // PAssert.that relies on the last coder added to the PCollection, so we
    // need to create an identity ParDo with a valid coder.
    PAssert.that(fixedCoderPC).satisfies(r);

    return pipeline;
  }

  static class IdentityDoFn extends DoFn<String, String> {
    @ProcessElement
    public void process(ProcessContext c) {
      c.output(c.element());
    }
  }

  static class ContentReader implements SerializableFunction<Iterable<String>, Void> {
    private final String[] expected;

    public static ContentReader elementsEqual(Iterable<String> expected) {
      return new ContentReader(expected);
    }

    private ContentReader(Iterable<String> expected) {
      ArrayList<String> ret = new ArrayList<>();
      for (String t : expected) {
        ret.add(t);
      }
      this.expected = ret.toArray(new String[ret.size()]);
    }

    @Override
    public Void apply(Iterable<String> contents) {
      assertThat(contents, containsInAnyOrder(expected));
      return null;
    }
  }

  static class ExceptionMatcher extends TypeSafeMatcher<Throwable> {
    private String expectedError;

    public ExceptionMatcher(String expected) {
      this.expectedError = expected;
    }

    @Override
    public boolean matchesSafely(Throwable result) {
      if (result.toString().contains(expectedError)) {
        return true;
      }
      Throwable cause = result.getCause();
      while (null != cause) {
        String causeString = cause.toString();
        if (causeString.contains(expectedError)) {
          return true;
        }
        cause = cause.getCause();
      }
      return false;
    }

    @Override
    public void describeTo(Description descr) {
      descr.appendText("exception with text matching: " + expectedError);
    }
  }
}
