/*
 * Copyright 2015-2026 the original author or authors.
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v2.0 which
 * accompanies this distribution and is available at
 *
 * https://www.eclipse.org/legal/epl-v20.html
 */

package org.junit.platform.engine.support.descriptor;

import static java.util.Collections.emptyList;
import static java.util.Comparator.comparing;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.platform.commons.test.PreconditionAssertions.assertPreconditionViolationFor;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.UnaryOperator;

import org.junit.jupiter.api.Test;
import org.junit.platform.engine.TestDescriptor;
import org.junit.platform.engine.UniqueId;

public interface TestDescriptorOrderChildrenTests {

	/**
	 * @return a test descriptor without any children.
	 */
	TestDescriptor createEmptyTestDescriptor();

	default TestDescriptor createTestDescriptorWithChildren() {
		var testDescriptor = createEmptyTestDescriptor();
		testDescriptor.addChild(new StubTestDescriptor(UniqueId.root("child", "0")));
		testDescriptor.addChild(new StubTestDescriptor(UniqueId.root("child", "1")));
		testDescriptor.addChild(new StubTestDescriptor(UniqueId.root("child", "2")));
		return testDescriptor;
	}

	@Test
	default void orderChildrenInReverseOrder() {
		var testDescriptor = createTestDescriptorWithChildren();
		var childrenInOriginalOrder = new ArrayList<>(testDescriptor.getChildren());
		testDescriptor.orderChildren(children -> {
			children.sort(comparing((TestDescriptor o) -> childrenInOriginalOrder.indexOf(o)).reversed());
			return children;
		});
		List<TestDescriptor> children = new ArrayList<>(testDescriptor.getChildren());
		assertThat(children).isEqualTo(childrenInOriginalOrder.reversed());
	}

	@Test
	default void orderChildrenEmptyList() {
		var testDescriptor = createTestDescriptorWithChildren();
		assertPreconditionViolationFor(() -> testDescriptor.orderChildren(children -> emptyList()))//
				.withMessage("orderer may not add or remove test descriptors");
	}

	@Test
	default void orderChildrenInSameOrder() {
		var testDescriptor = createTestDescriptorWithChildren();
		var childrenInOriginalOrder = new ArrayList<>(testDescriptor.getChildren());
		testDescriptor.orderChildren(children -> {
			children.sort(comparing(childrenInOriginalOrder::indexOf));
			return children;
		});
		List<TestDescriptor> children = new ArrayList<>(testDescriptor.getChildren());
		assertThat(children).isEqualTo(childrenInOriginalOrder);
	}

	@Test
	default void orderChildrenRemovesDescriptor() {
		var testDescriptor = createTestDescriptorWithChildren();
		UnaryOperator<List<TestDescriptor>> orderer = children -> {
			children.remove(1);
			return children;
		};
		assertPreconditionViolationFor(() -> testDescriptor.orderChildren(orderer))//
				.withMessage("orderer may not add or remove test descriptors");
	}

	@Test
	default void orderChildrenAddsDescriptor() {
		var testDescriptor = createTestDescriptorWithChildren();
		UnaryOperator<List<TestDescriptor>> orderer = children -> {
			children.add(1, new StubTestDescriptor(UniqueId.root("extra", "extra1")));
			return children;
		};
		assertPreconditionViolationFor(() -> testDescriptor.orderChildren(orderer))//
				.withMessage("orderer may not add or remove test descriptors");
	}

	@Test
	default void orderChildrenReplacesDescriptor() {
		var testDescriptor = createTestDescriptorWithChildren();
		UnaryOperator<List<TestDescriptor>> orderer = children -> {
			children.set(1, new StubTestDescriptor(UniqueId.root("replaced", "replaced1")));
			return children;
		};
		assertPreconditionViolationFor(() -> testDescriptor.orderChildren(orderer))//
				.withMessage("orderer may not add or remove test descriptors");
	}

	@Test
	default void orderChildrenDuplicatesDescriptor() {
		var testDescriptor = createTestDescriptorWithChildren();
		UnaryOperator<List<TestDescriptor>> orderer = children -> {
			children.add(1, children.getLast());
			return children;
		};
		assertPreconditionViolationFor(() -> testDescriptor.orderChildren(orderer))//
				.withMessage("orderer may not add or remove test descriptors");
	}

	@SuppressWarnings("DataFlowIssue")
	@Test
	default void orderChildrenOrdererReturnsNull() {
		var testDescriptor = createTestDescriptorWithChildren();
		assertPreconditionViolationFor(() -> testDescriptor.orderChildren(children -> null))//
				.withMessage("orderer may not return null");
	}

	@Test
	default void orderChildrenProvidedChildrenAreModifiable() {
		var testDescriptor = createTestDescriptorWithChildren();
		AtomicReference<List<TestDescriptor>> childrenRef = new AtomicReference<>();
		testDescriptor.orderChildren(children -> {
			childrenRef.set(children);
			return children;
		});
		assertThat(childrenRef.get()).isInstanceOf(ArrayList.class);
	}
}

class StubTestDescriptor extends AbstractTestDescriptor {

	StubTestDescriptor(UniqueId uniqueId) {
		super(uniqueId, "stub: " + uniqueId);
	}

	@Override
	public Type getType() {
		return Type.TEST;
	}

}
