AnnotationBasedKeySpaceResolverUnitTests.java

/*
 * Copyright 2014-2025 the original author or authors.
 *
 * Licensed 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
 *
 *      https://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.springframework.data.keyvalue.core.mapping;

import static org.assertj.core.api.Assertions.*;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import org.springframework.core.annotation.AliasFor;
import org.springframework.data.annotation.Persistent;
import org.springframework.data.keyvalue.TypeWithDirectKeySpaceAnnotation;
import org.springframework.data.keyvalue.TypeWithInhteritedPersistentAnnotationNotHavingKeySpace;
import org.springframework.data.keyvalue.TypeWithPersistentAnnotationNotHavingKeySpace;
import org.springframework.data.keyvalue.annotation.KeySpace;

/**
 * Unit tests for {@link AnnotationBasedKeySpaceResolver}.
 *
 * @author Christoph Strobl
 * @author Oliver Gierke
 */
class AnnotationBasedKeySpaceResolverUnitTests {

	private AnnotationBasedKeySpaceResolver resolver;

	@BeforeEach
	void setUp() {
		resolver = AnnotationBasedKeySpaceResolver.INSTANCE;
	}

	@Test // DATACMNS-525
	void shouldResolveKeySpaceDefaultValueCorrectly() {
		assertThat(resolver.resolveKeySpace(EntityWithDefaultKeySpace.class)).isEqualTo("daenerys");
	}

	@Test // DATAKV-105
	void shouldReturnNullWhenNoKeySpaceFoundOnComposedPersistentAnnotation() {
		assertThat(resolver.resolveKeySpace(TypeWithInhteritedPersistentAnnotationNotHavingKeySpace.class)).isNull();
	}

	@Test // DATAKV-105
	void shouldReturnNullWhenPersistentIsFoundOnNonComposedAnnotation() {
		assertThat(resolver.resolveKeySpace(TypeWithPersistentAnnotationNotHavingKeySpace.class)).isNull();
	}

	@Test // DATAKV-105
	void shouldReturnNullWhenPersistentIsNotFound() {
		assertThat(resolver.resolveKeySpace(TypeWithoutKeySpace.class)).isNull();
	}

	@Test // DATACMNS-525
	void shouldResolveInheritedKeySpaceCorrectly() {
		assertThat(resolver.resolveKeySpace(EntityWithInheritedKeySpace.class)).isEqualTo("viserys");
	}

	@Test // DATACMNS-525
	void shouldResolveDirectKeySpaceAnnotationCorrectly() {
		assertThat(resolver.resolveKeySpace(TypeWithDirectKeySpaceAnnotation.class)).isEqualTo("rhaegar");
	}

	@Test // DATAKV-129
	void shouldResolveKeySpaceUsingAliasForCorrectly() {
		assertThat(resolver.resolveKeySpace(EntityWithSetKeySpaceUsingAliasFor.class)).isEqualTo("viserys");
	}

	@Test // DATAKV-129
	void shouldResolveKeySpaceUsingAliasForCorrectlyOnSubClass() {
		assertThat(resolver.resolveKeySpace(EntityWithInheritedKeySpaceUsingAliasFor.class)).isEqualTo("viserys");
	}

	@PersistentAnnotationWithExplicitKeySpaceUsingAliasFor
	private static class EntityWithDefaultKeySpace {

	}

	@PersistentAnnotationWithExplicitKeySpaceUsingAliasFor(firstname = "viserys")
	static class EntityWithSetKeySpaceUsingAliasFor {

	}

	private static class EntityWithInheritedKeySpace extends EntityWithSetKeySpaceUsingAliasFor {

	}

	private static class EntityWithInheritedKeySpaceUsingAliasFor extends EntityWithSetKeySpaceUsingAliasFor {

	}

	@Persistent
	@Retention(RetentionPolicy.RUNTIME)
	@Target({ ElementType.TYPE })
	@KeySpace
	static @interface PersistentAnnotationWithExplicitKeySpaceUsingAliasFor {

		@AliasFor(annotation = KeySpace.class, attribute = "value")
		String firstname() default "daenerys";

		String lastname() default "targaryen";

	}

	static class TypeWithoutKeySpace {

		String foo;

	}
}