1 /** 2 * Copyright (c) 2013-2022, jcabi.com 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 1) Redistributions of source code must retain the above 8 * copyright notice, this list of conditions and the following 9 * disclaimer. 2) Redistributions in binary form must reproduce the above 10 * copyright notice, this list of conditions and the following 11 * disclaimer in the documentation and/or other materials provided 12 * with the distribution. 3) Neither the name of the jcabi.com nor 13 * the names of its contributors may be used to endorse or promote 14 * products derived from this software without specific prior written 15 * permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT 19 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 20 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 21 * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 22 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 28 * OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 package com.jcabi.github; 31 32 import com.google.common.base.Predicate; 33 import com.google.common.collect.ImmutableSet; 34 import com.google.common.collect.Iterables; 35 import com.jcabi.aspects.Immutable; 36 import java.util.Set; 37 import org.hamcrest.CustomTypeSafeMatcher; 38 import org.hamcrest.MatcherAssert; 39 import org.hamcrest.Matchers; 40 import org.junit.Rule; 41 import org.junit.Test; 42 43 /** 44 * Test for immutability. 45 * Checks that all classes in package {@code com.jcabi.github } 46 * have {@code @Immutable} annotation. 47 * 48 * @author Paul Polishchuk (ppol@ua.fm) 49 * @version $Id: 2de2fbf84d43eb8a09331a3a3d8c3b56f2c5d140 $ 50 */ 51 public final class ImmutabilityTest { 52 53 /** 54 * ClasspathRule. 55 * @checkstyle VisibilityModifierCheck (3 lines) 56 */ 57 @Rule 58 public final transient ClasspathRule classpath = new ClasspathRule(); 59 60 /** 61 * Test for immutability. 62 * Checks that all classes in package {@code com.jcabi.github } 63 * have {@code @Immutable} annotation. 64 * 65 * @throws Exception If some problem inside 66 */ 67 @Test 68 public void checkImmutability() throws Exception { 69 MatcherAssert.assertThat( 70 Iterables.filter( 71 this.classpath.allTypes(), 72 new Predicate<Class<?>>() { 73 @Override 74 public boolean apply(final Class<?> input) { 75 return !ImmutabilityTest.skip().contains( 76 input.getName() 77 ); 78 } 79 } 80 ), 81 Matchers.everyItem( 82 new CustomTypeSafeMatcher<Class<?>>("annotated type") { 83 @Override 84 protected boolean matchesSafely(final Class<?> item) { 85 return item.isAnnotationPresent(Immutable.class); 86 } 87 } 88 ) 89 ); 90 } 91 92 /** 93 * Get set of class names to be skipped. 94 * @return Set 95 */ 96 private static Set<String> skip() { 97 return ImmutableSet.<String>builder() 98 .add("com.jcabi.github.mock.JsonNode") 99 .add("com.jcabi.github.Bulk") 100 .add("com.jcabi.github.Smarts") 101 .build(); 102 } 103 }