com.societegenerale.commons.plugin.rules.NoPowerMockRuleTest Maven / Gradle / Ivy

Go to download
package com.societegenerale.commons.plugin.rules;

import java.util.Collection;

import com.societegenerale.commons.plugin.service.ScopePathProvider;
import com.societegenerale.commons.plugin.utils.ArchUtils;
import com.tngtech.archunit.base.Optional;
import com.tngtech.archunit.core.domain.JavaClass;
import com.tngtech.archunit.lang.ArchCondition;
import com.tngtech.archunit.lang.ConditionEvents;
import com.tngtech.archunit.lang.SimpleConditionEvent;
import org.junit.runner.RunWith;

import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes;

/**
 *  Using PowerMock is very often done for the wrong reasons, and is a smell of bad design. Code refactoring is preferred so that we don't need to mock private or static methods (typical use cases for PowerMock).
 */
public class NoPowerMockRuleTest implements ArchRuleTest {

    private static final String POWER_MOCK_RUNNER_CLASS_NAME = "PowerMockRunner";

    protected static final String POWER_MOCK_VIOLATION_MESSAGE = "Favor Mockito and proper dependency injection - ";


    @Override
    public void execute(String packagePath, ScopePathProvider scopePathProvider, Collection excludedPaths) {
        classes().should(notUsePowerMock()).check(ArchUtils.importAllClassesInPackage(scopePathProvider.getTestClassesPath(), packagePath, excludedPaths));
    }

    public static ArchCondition notUsePowerMock() {

        return new ArchCondition("not use Powermock") {

            @Override
            @SuppressWarnings("squid:S1166")
            public void check(JavaClass testClass, ConditionEvents events) {

                try {
                    Optional runWithAnnotation = testClass.tryGetAnnotationOfType(RunWith.class);

                    if (runWithAnnotation.isPresent() && runWithAnnotation.get().toString().contains(POWER_MOCK_RUNNER_CLASS_NAME)) {

                        events.add(SimpleConditionEvent.violated(testClass,
                                POWER_MOCK_VIOLATION_MESSAGE + testClass.getName()));
                    }
                }
                catch(RuntimeException e){
                    // if the runner used is another than Powermock (SpringRunner for instance), a Runtime exception will be thrown
                    // see https://github.com/TNG/ArchUnit/issues/120

                    //therefore, just swallowing the exception, as we are interested only by PowerMockRunner here.
                }

            }

        };
    }
}