BeforeJUnitPlugin.java

/*******************************************************************************
 * Copyright (c) 2025 Carsten Hammer.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     Carsten Hammer
 *******************************************************************************/
package org.sandbox.jdt.internal.corext.fix.helper;

import static org.sandbox.jdt.internal.corext.fix.helper.lib.JUnitConstants.*;

import java.util.Set;

import org.eclipse.jdt.core.dom.ASTNode;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.internal.corext.fix.CompilationUnitRewriteOperationsFixCore.CompilationUnitRewriteOperationWithSourceRange;

import org.sandbox.jdt.internal.corext.fix.JUnitCleanUpFixCore;
import org.sandbox.jdt.internal.corext.fix.helper.lib.InheritedLifecycleMethodRefactorer;
import org.sandbox.jdt.internal.corext.fix.helper.lib.TriggerPatternCleanupPlugin;
import org.sandbox.jdt.triggerpattern.api.CleanupPattern;
import org.sandbox.jdt.triggerpattern.api.PatternKind;
import org.sandbox.jdt.triggerpattern.api.RewriteRule;

/**
 * Migrates JUnit 4 @Before annotations to JUnit 5 @BeforeEach.
 * 
 * <p>
 * Uses TriggerPattern-based declarative architecture with @RewriteRule
 * annotation to eliminate boilerplate code.
 * </p>
 * 
 * <p>
 * <b>Before:</b>
 * </p>
 * 
 * <pre>
 * import org.junit.Before;
 * 
 * public class MyTest {
 *     {@literal @}Before
 *     public void setUp() { }
 * }
 * </pre>
 * 
 * <p>
 * <b>After:</b>
 * </p>
 * 
 * <pre>
 * import org.junit.jupiter.api.BeforeEach;
 * 
 * public class MyTest {
 *     {@literal @}BeforeEach
 *     public void setUp() { }
 * }
 * </pre>
 * 
 * @since 1.3.0
 */
@CleanupPattern(value = "@Before", kind = PatternKind.ANNOTATION, qualifiedType = ORG_JUNIT_BEFORE, cleanupId = "cleanup.junit.before", description = "Migrate @Before to @BeforeEach", displayName = "JUnit 4 @Before → JUnit 5 @BeforeEach")
@RewriteRule(replaceWith = "@BeforeEach", targetQualifiedType = ORG_JUNIT_JUPITER_API_BEFORE_EACH)
public class BeforeJUnitPlugin extends TriggerPatternCleanupPlugin {

	@Override
	public void find(JUnitCleanUpFixCore fixcore, CompilationUnit compilationUnit,
			Set<CompilationUnitRewriteOperationWithSourceRange> operations, Set<ASTNode> nodesprocessed) {
		super.find(fixcore, compilationUnit, operations, nodesprocessed);
		InheritedLifecycleMethodRefactorer.addInheritedLifecycleOverrides(compilationUnit,
				operations, nodesprocessed, Set.of(ORG_JUNIT_BEFORE, ORG_JUNIT_JUPITER_API_BEFORE_EACH),
				ORG_JUNIT_JUPITER_API_BEFORE_EACH);
	}

	@Override
	public String getPreview(boolean afterRefactoring) {
		if (afterRefactoring) {
			return """
					@BeforeEach
					public void setUp() {
					}
					"""; //$NON-NLS-1$
		}
		return """
				@Before
				public void setUp() {
				}
				"""; //$NON-NLS-1$
	}

	@Override
	public String toString() {
		return "Before"; //$NON-NLS-1$
	}
}