org.gradle.performance.annotations.AllFeaturesShouldBeAnnotated.groovy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
/*
* Copyright 2020 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
*
* 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.gradle.performance.annotations
import groovy.transform.CompileStatic
import org.spockframework.runtime.extension.ExtensionAnnotation
import org.spockframework.runtime.extension.IAnnotationDrivenExtension
import org.spockframework.runtime.model.SpecInfo
import spock.lang.Ignore
import java.lang.annotation.ElementType
import java.lang.annotation.Retention
import java.lang.annotation.RetentionPolicy
import java.lang.annotation.Target
/**
* Make sure all feature methods are annotated by {@link @RunFor}
*
* @see {@link @RunFor}
*/
@Target([ElementType.TYPE])
@Retention(RetentionPolicy.RUNTIME)
@ExtensionAnnotation(AllFeaturesShouldBeAnnotatedByRunForExtension.class)
@interface AllFeaturesShouldBeAnnotated {
}
/**
* Marks a test has deliberately no @RunFor
*
* @see {@link @RunFor}
*/
@Target([ElementType.TYPE, ElementType.METHOD])
@Retention(RetentionPolicy.RUNTIME)
@interface NoRunFor {
}
@CompileStatic
class AllFeaturesShouldBeAnnotatedByRunForExtension implements IAnnotationDrivenExtension {
@Override
void visitSpecAnnotation(AllFeaturesShouldBeAnnotated runFor, SpecInfo spec) {
while (spec.subSpec != null) {
// Find the bottom spec in the hierarchy
spec = spec.subSpec
}
if (!spec.getReflection().isAnnotationPresent(RunFor) &&
!spec.getReflection().isAnnotationPresent(Ignore) &&
!spec.getReflection().isAnnotationPresent(NoRunFor)) {
spec.getFeatures()
.findAll {
!it.getFeatureMethod().getReflection().isAnnotationPresent(RunFor.class) &&
!it.getFeatureMethod().getReflection().isAnnotationPresent(Ignore.class)
}
.each { throw new IllegalStateException("All feature methods should be annotated by @RunFor! See RunFor javadoc for more details.") }
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy