-
Notifications
You must be signed in to change notification settings - Fork 736
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ed4f9c8
commit 7588267
Showing
2 changed files
with
62 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
package org.kohsuke.github; | ||
|
||
import com.tngtech.archunit.core.domain.JavaClass; | ||
import com.tngtech.archunit.core.domain.JavaClasses; | ||
import com.tngtech.archunit.core.domain.properties.HasAnnotations; | ||
import com.tngtech.archunit.core.domain.properties.HasName.AndFullName; | ||
import com.tngtech.archunit.core.importer.ClassFileImporter; | ||
import com.tngtech.archunit.core.importer.ImportOption; | ||
import com.tngtech.archunit.lang.ArchCondition; | ||
import com.tngtech.archunit.lang.ArchRule; | ||
import com.tngtech.archunit.lang.ConditionEvents; | ||
import com.tngtech.archunit.lang.SimpleConditionEvent; | ||
import org.junit.Test; | ||
|
||
import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes; | ||
|
||
public class ArchTests { | ||
|
||
private final JavaClasses classFiles = new ClassFileImporter() | ||
.withImportOption(new ImportOption.DoNotIncludeTests()) | ||
.withImportOption(new ImportOption.DoNotIncludeJars()) | ||
.importPackages("org.kohsuke.github"); | ||
|
||
@Test | ||
public void testPreviewsAreFlaggedAsDeprecated() { | ||
|
||
String description = "annotate all preview APIs as @Deprecated until they are promoted to stable"; | ||
|
||
ArchRule rule = classes().should(new ArchCondition<JavaClass>(description) { | ||
|
||
@Override | ||
public void check(final JavaClass targetClazz, final ConditionEvents events) { | ||
checkForPreviewAnnotation(targetClazz, events); | ||
targetClazz.getAllMethods().forEach(method -> { | ||
checkForPreviewAnnotation(method, events); | ||
}); | ||
} | ||
|
||
<T extends HasAnnotations<T> & AndFullName> void checkForPreviewAnnotation(T codeTarget, | ||
ConditionEvents events) { | ||
|
||
if (codeTarget.tryGetAnnotationOfType(Preview.class).isPresent() | ||
&& !codeTarget.tryGetAnnotationOfType(Deprecated.class).isPresent()) { | ||
|
||
String message = codeTarget.getFullName() | ||
+ " uses a preview API and is missing the '@Deprecated' annotation."; | ||
|
||
events.add(new SimpleConditionEvent(codeTarget, false, message)); | ||
} | ||
} | ||
}); | ||
|
||
rule.check(classFiles); | ||
|
||
} | ||
} |