/*
 * 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.flink.api.java.typeutils.runtime.kryo;

import org.apache.flink.api.common.ExecutionConfig;
import org.apache.flink.api.common.typeutils.TypeSerializer;
import org.apache.flink.api.common.typeutils.TypeSerializerMatchers;
import org.apache.flink.api.common.typeutils.TypeSerializerSchemaCompatibility;
import org.apache.flink.api.common.typeutils.TypeSerializerUpgradeTestBase;
import org.apache.flink.api.java.typeutils.runtime.kryo.KryoPojosForMigrationTests.Animal;
import org.apache.flink.api.java.typeutils.runtime.kryo.KryoPojosForMigrationTests.Cat;
import org.apache.flink.api.java.typeutils.runtime.kryo.KryoPojosForMigrationTests.Dog;
import org.apache.flink.api.java.typeutils.runtime.kryo.KryoPojosForMigrationTests.Parrot;
import org.apache.flink.testutils.migration.MigrationVersion;

import com.esotericsoftware.kryo.serializers.DefaultSerializers;
import org.hamcrest.Matcher;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;

import java.util.ArrayList;
import java.util.Collection;

import static org.apache.flink.api.common.typeutils.TypeSerializerMatchers.hasSameCompatibilityAs;
import static org.apache.flink.api.common.typeutils.TypeSerializerSchemaCompatibility.compatibleWithReconfiguredSerializer;
import static org.hamcrest.Matchers.is;

/**
 * Tests migrations for {@link KryoSerializerSnapshot}.
 */
@SuppressWarnings("WeakerAccess")
@RunWith(Parameterized.class)
public class KryoSerializerUpgradeTest extends TypeSerializerUpgradeTestBase<Object, Object> {

	public KryoSerializerUpgradeTest(TestSpecification<Object, Object> testSpecification) {
		super(testSpecification);
	}

	@Parameterized.Parameters(name = "Test Specification = {0}")
	public static Collection<TestSpecification<?, ?>> testSpecifications() throws Exception {
		ArrayList<TestSpecification<?, ?>> testSpecifications = new ArrayList<>();
		for (MigrationVersion migrationVersion : MIGRATION_VERSIONS) {
			testSpecifications.add(
					new TestSpecification<>(
							"kryo-type-serializer-empty-config",
							migrationVersion,
							KryoTypeSerializerEmptyConfigSetup.class,
							KryoTypeSerializerEmptyConfigVerifier.class));
			testSpecifications.add(
					new TestSpecification<>(
							"kryo-type-serializer-unrelated-config-after-restore",
							migrationVersion,
							KryoTypeSerializerEmptyConfigSetup.class,
							KryoTypeSerializerWithUnrelatedConfigVerifier.class));
			testSpecifications.add(
					new TestSpecification<>(
							"kryo-type-serializer-changed-registration-order",
							migrationVersion,
							KryoTypeSerializerChangedRegistrationOrderSetup.class,
							KryoTypeSerializerChangedRegistrationOrderVerifier.class));
			testSpecifications.add(
					new TestSpecification<>(
							"kryo-custom-type-serializer-changed-registration-order",
							migrationVersion,
							KryoCustomTypeSerializerChangedRegistrationOrderSetup.class,
							KryoCustomTypeSerializerChangedRegistrationOrderVerifier.class));
		}

		return testSpecifications;
	}

	// ----------------------------------------------------------------------------------------------
	//  Specification for "kryo-type-serializer-empty-config"
	// ----------------------------------------------------------------------------------------------

	public static final class KryoTypeSerializerEmptyConfigSetup implements TypeSerializerUpgradeTestBase.PreUpgradeSetup<Animal> {

		@Override
		public TypeSerializer<Animal> createPriorSerializer() {
			return new KryoSerializer<>(Animal.class, new ExecutionConfig());
		}

		@Override
		public Animal createTestData() {
			return new Dog("Hasso");
		}
	}

	public static final class KryoTypeSerializerEmptyConfigVerifier implements TypeSerializerUpgradeTestBase.UpgradeVerifier<Animal> {

		@Override
		public TypeSerializer<Animal> createUpgradedSerializer() {
			return new KryoSerializer<>(Animal.class, new ExecutionConfig());
		}

		@Override
		public Matcher<Animal> testDataMatcher() {
			return is(new Dog("Hasso"));
		}

		@Override
		public Matcher<TypeSerializerSchemaCompatibility<Animal>> schemaCompatibilityMatcher(MigrationVersion version) {
			return TypeSerializerMatchers.isCompatibleAsIs();
		}
	}

	// ----------------------------------------------------------------------------------------------
	//  Specification for "kryo-type-serializer-empty-config-then-some-config"
	// ----------------------------------------------------------------------------------------------

	public static final class KryoTypeSerializerWithUnrelatedConfigVerifier implements TypeSerializerUpgradeTestBase.UpgradeVerifier<Animal> {

		@Override
		public TypeSerializer<Animal> createUpgradedSerializer() {
			ExecutionConfig executionConfig = new ExecutionConfig();
			executionConfig.registerKryoType(DummyClassOne.class);
			executionConfig.registerTypeWithKryoSerializer(
					DummyClassTwo.class,
					DefaultSerializers.StringSerializer.class);

			return new KryoSerializer<>(Animal.class, executionConfig);
		}

		@Override
		public Matcher<Animal> testDataMatcher() {
			return is(new Dog("Hasso"));
		}

		@Override
		public Matcher<TypeSerializerSchemaCompatibility<Animal>> schemaCompatibilityMatcher(MigrationVersion version) {
			return hasSameCompatibilityAs(compatibleWithReconfiguredSerializer(new KryoSerializer<>(
					Animal.class,
					new ExecutionConfig())));
		}
	}

	// ----------------------------------------------------------------------------------------------
	//  Specification for "kryo-type-serializer-changed-registration-order"
	// ----------------------------------------------------------------------------------------------

	public static final class KryoTypeSerializerChangedRegistrationOrderSetup implements TypeSerializerUpgradeTestBase.PreUpgradeSetup<Animal> {

		@Override
		public TypeSerializer<Animal> createPriorSerializer() {
			ExecutionConfig executionConfig = new ExecutionConfig();
			executionConfig.registerKryoType(Dog.class);
			executionConfig.registerKryoType(Cat.class);
			executionConfig.registerKryoType(Parrot.class);

			return new KryoSerializer<>(Animal.class, executionConfig);
		}

		@Override
		public Animal createTestData() {
			return new Dog("Hasso");
		}
	}

	public static final class KryoTypeSerializerChangedRegistrationOrderVerifier implements TypeSerializerUpgradeTestBase.UpgradeVerifier<Animal> {

		@Override
		public TypeSerializer<Animal> createUpgradedSerializer() {
			ExecutionConfig executionConfig = new ExecutionConfig();
			executionConfig.registerKryoType(DummyClassOne.class);
			executionConfig.registerKryoType(Dog.class);
			executionConfig.registerKryoType(DummyClassTwo.class);
			executionConfig.registerKryoType(Cat.class);
			executionConfig.registerKryoType(Parrot.class);

			return new KryoSerializer<>(Animal.class, executionConfig);
		}

		@Override
		public Matcher<Animal> testDataMatcher() {
			return is(new Dog("Hasso"));
		}

		@Override
		public Matcher<TypeSerializerSchemaCompatibility<Animal>> schemaCompatibilityMatcher(MigrationVersion version) {
			return hasSameCompatibilityAs(compatibleWithReconfiguredSerializer(new KryoSerializer<>(
					Animal.class,
					new ExecutionConfig())));
		}
	}

	// ----------------------------------------------------------------------------------------------
	//  Specification for "kryo-custom-type-serializer-changed-registration-order"
	// ----------------------------------------------------------------------------------------------

	public static final class KryoCustomTypeSerializerChangedRegistrationOrderSetup implements TypeSerializerUpgradeTestBase.PreUpgradeSetup<Animal> {

		@Override
		public TypeSerializer<Animal> createPriorSerializer() {
			ExecutionConfig executionConfig = new ExecutionConfig();
			executionConfig.registerTypeWithKryoSerializer(
					Dog.class,
					KryoPojosForMigrationTests.DogKryoSerializer.class);
			executionConfig.registerKryoType(Cat.class);
			executionConfig.registerTypeWithKryoSerializer(
					Parrot.class,
					KryoPojosForMigrationTests.ParrotKryoSerializer.class);

			return new KryoSerializer<>(Animal.class, executionConfig);
		}

		@Override
		public Animal createTestData() {
			return new Dog("Hasso");
		}
	}

	public static final class KryoCustomTypeSerializerChangedRegistrationOrderVerifier implements TypeSerializerUpgradeTestBase.UpgradeVerifier<Animal> {

		@Override
		public TypeSerializer<Animal> createUpgradedSerializer() {
			ExecutionConfig executionConfig = new ExecutionConfig();
			executionConfig.registerKryoType(DummyClassOne.class);
			executionConfig.registerTypeWithKryoSerializer(
					Dog.class,
					KryoPojosForMigrationTests.DogV2KryoSerializer.class);
			executionConfig.registerKryoType(DummyClassTwo.class);
			executionConfig.registerKryoType(Cat.class);
			executionConfig.registerTypeWithKryoSerializer(
					Parrot.class,
					KryoPojosForMigrationTests.ParrotKryoSerializer.class);

			return new KryoSerializer<>(Animal.class, executionConfig);
		}

		@Override
		public Matcher<Animal> testDataMatcher() {
			return is(new Dog("Hasso"));
		}

		@Override
		public Matcher<TypeSerializerSchemaCompatibility<Animal>> schemaCompatibilityMatcher(MigrationVersion version) {
			return hasSameCompatibilityAs(compatibleWithReconfiguredSerializer(new KryoSerializer<>(
					Animal.class,
					new ExecutionConfig())));
		}
	}

	/**
	 * Dummy class to be registered in the tests.
	 */
	public static final class DummyClassOne {

	}

	/**
	 * Dummy class to be registered in the tests.
	 */
	public static final class DummyClassTwo {

	}
}