├── settings.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── src ├── test │ ├── resources │ │ └── application.properties │ └── java │ │ └── io │ │ └── github │ │ └── mangkyu │ │ └── springboot │ │ └── test │ │ └── automock │ │ ├── testcontext │ │ ├── AutoMockMockService.java │ │ ├── AutoMockTestController.java │ │ ├── AutoMockTestControllerTest.java │ │ └── AutoMockTestContext.java │ │ ├── AutoMockApplication.java │ │ ├── utils │ │ ├── AutoMockPropertyUtilsTest.java │ │ └── AutoMockBeanUtilsTest.java │ │ ├── listener │ │ ├── AutoMockTestExecutionListenerTest.java │ │ ├── InitMockTest.java │ │ └── AutoMockEventListenerTest.java │ │ ├── parser │ │ └── AutoMockClassParserTest.java │ │ └── beanfactorypostprocessor │ │ └── AutoMockBeanFactoryPostProcessorTest.java └── main │ ├── java │ └── io │ │ └── github │ │ └── mangkyu │ │ └── springboot │ │ └── test │ │ └── automock │ │ ├── properties │ │ └── AutoMockProperties.java │ │ ├── utils │ │ ├── AutoMockPropertyUtils.java │ │ └── AutoMockBeanUtils.java │ │ ├── listener │ │ ├── AutoMockTestExecutionListener.java │ │ └── AutoMockEventListener.java │ │ ├── config │ │ └── AutoMockAutoConfiguration.java │ │ ├── parser │ │ └── AutoMockClassParser.java │ │ └── beanfactorypostprocessor │ │ └── AutoMockBeanFactoryPostProcessor.java │ └── resources │ └── META-INF │ └── spring.factories ├── .gitignore ├── publish.gradle ├── README.md ├── gradlew.bat ├── scripts └── publish-maven.gradle ├── gradlew └── LICENSE /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'spring-boot-test-automock' 2 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MangKyu/spring-boot-test-automock/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /src/test/resources/application.properties: -------------------------------------------------------------------------------- 1 | io.github.mangkyu.automock.enable=true 2 | io.github.mangkyu.automock.target.basepackage=io.github.mangkyu.springboot.test.automock -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.1-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /src/test/java/io/github/mangkyu/springboot/test/automock/testcontext/AutoMockMockService.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.testcontext; 2 | 3 | import org.springframework.stereotype.Service; 4 | 5 | @Service 6 | public class AutoMockMockService { 7 | 8 | public String call(final String input) { 9 | return input; 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /src/main/java/io/github/mangkyu/springboot/test/automock/properties/AutoMockProperties.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.properties; 2 | 3 | public class AutoMockProperties { 4 | 5 | private final String basePackage; 6 | 7 | public AutoMockProperties(final String basePackage) { 8 | this.basePackage = basePackage; 9 | } 10 | 11 | public String getBasePackage() { 12 | return basePackage; 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/spring.factories: -------------------------------------------------------------------------------- 1 | org.springframework.test.context.TestExecutionListener=\ 2 | io.github.mangkyu.springboot.test.automock.listener.AutoMockTestExecutionListener 3 | 4 | org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureWebMvc=\ 5 | io.github.mangkyu.springboot.test.automock.config.AutoMockAutoConfiguration 6 | 7 | org.springframework.context.ApplicationListener=\ 8 | io.github.mangkyu.springboot.test.automock.listener.AutoMockEventListener -------------------------------------------------------------------------------- /src/test/java/io/github/mangkyu/springboot/test/automock/AutoMockApplication.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class AutoMockApplication { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(AutoMockApplication.class, args); 11 | } 12 | 13 | } 14 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### CUSTOM ### 2 | local.properties 3 | 4 | HELP.md 5 | .gradle 6 | build/ 7 | !gradle/wrapper/gradle-wrapper.jar 8 | !**/src/main/** 9 | !**/src/test/** 10 | 11 | ### STS ### 12 | .apt_generated 13 | .classpath 14 | .factorypath 15 | .project 16 | .settings 17 | .springBeans 18 | .sts4-cache 19 | 20 | ### IntelliJ IDEA ### 21 | .idea 22 | *.iws 23 | *.iml 24 | *.ipr 25 | out/ 26 | 27 | ### NetBeans ### 28 | /nbproject/private/ 29 | /nbbuild/ 30 | /dist/ 31 | /nbdist/ 32 | /.nb-gradle/ 33 | 34 | ### VS Code ### 35 | .vscode/ -------------------------------------------------------------------------------- /src/test/java/io/github/mangkyu/springboot/test/automock/testcontext/AutoMockTestController.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.testcontext; 2 | 3 | import org.springframework.beans.factory.annotation.Autowired; 4 | import org.springframework.web.bind.annotation.RestController; 5 | 6 | @RestController 7 | public class AutoMockTestController { 8 | 9 | private final AutoMockMockService mockService; 10 | 11 | @Autowired 12 | public AutoMockTestController(final AutoMockMockService mockService) { 13 | this.mockService = mockService; 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /src/test/java/io/github/mangkyu/springboot/test/automock/testcontext/AutoMockTestControllerTest.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.testcontext; 2 | 3 | import org.junit.jupiter.api.Test; 4 | import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest; 5 | 6 | import static org.mockito.Mockito.mock; 7 | 8 | @WebMvcTest 9 | public class AutoMockTestControllerTest { 10 | 11 | private AutoMockMockService mockService = mock(AutoMockMockService.class); 12 | 13 | private AutoMockMockService realService = new AutoMockMockService(); 14 | 15 | @Test 16 | void sampleTest() { 17 | } 18 | 19 | } 20 | -------------------------------------------------------------------------------- /src/main/java/io/github/mangkyu/springboot/test/automock/utils/AutoMockPropertyUtils.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.utils; 2 | 3 | import org.springframework.context.ApplicationContext; 4 | 5 | public final class AutoMockPropertyUtils { 6 | 7 | private AutoMockPropertyUtils() { 8 | throw new IllegalStateException(); 9 | } 10 | 11 | public static final String AUTO_MOCK_BASE_PACKAGE = "io.github.mangkyu.automock.target.basepackage"; 12 | 13 | public static String findBasePackage(final ApplicationContext applicationContext) { 14 | return applicationContext.getEnvironment().getProperty(AUTO_MOCK_BASE_PACKAGE); 15 | } 16 | 17 | } 18 | -------------------------------------------------------------------------------- /src/test/java/io/github/mangkyu/springboot/test/automock/utils/AutoMockPropertyUtilsTest.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.utils; 2 | 3 | import org.junit.jupiter.api.Test; 4 | import org.springframework.beans.factory.annotation.Autowired; 5 | import org.springframework.boot.test.context.SpringBootTest; 6 | import org.springframework.context.ApplicationContext; 7 | 8 | import static org.assertj.core.api.Assertions.assertThat; 9 | 10 | @SpringBootTest 11 | class AutoMockPropertyUtilsTest { 12 | 13 | @Autowired 14 | private ApplicationContext beanFactory; 15 | 16 | @Test 17 | void findBasePackages() { 18 | final String result = AutoMockPropertyUtils.findBasePackage(beanFactory); 19 | assertThat(result).isEqualTo("io.github.mangkyu.springboot.test.automock"); 20 | } 21 | 22 | } -------------------------------------------------------------------------------- /src/test/java/io/github/mangkyu/springboot/test/automock/listener/AutoMockTestExecutionListenerTest.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.listener; 2 | 3 | import io.github.mangkyu.springboot.test.automock.testcontext.AutoMockTestContext; 4 | import org.junit.jupiter.api.BeforeEach; 5 | import org.junit.jupiter.api.Test; 6 | import org.springframework.test.context.TestContext; 7 | 8 | class AutoMockTestExecutionListenerTest { 9 | 10 | private AutoMockTestExecutionListener listener; 11 | private TestContext testContext; 12 | 13 | @BeforeEach 14 | void init() { 15 | listener = new AutoMockTestExecutionListener(); 16 | testContext = new AutoMockTestContext(); 17 | } 18 | 19 | @Test 20 | void beforeTestExecution() { 21 | listener.beforeTestExecution(testContext); 22 | } 23 | 24 | } -------------------------------------------------------------------------------- /publish.gradle: -------------------------------------------------------------------------------- 1 | ext { 2 | PUBLISH_GROUP_ID = 'io.github.mangkyu' 3 | PUBLISH_VERSION = '0.0.5' 4 | PUBLISH_ARTIFACT_ID = 'spring-boot-test-automock' 5 | PUBLISH_DESCRIPTION = 'SpringBoot Test AutoMock Library' 6 | PUBLISH_URL = 'https://github.com/MangKyu/spring-boot-test-automock' 7 | PUBLISH_LICENSE_NAME = 'GNU License' 8 | PUBLISH_LICENSE_URL = 'https://github.com/MangKyu/spring-boot-test-automock/blob/master/LICENSE' 9 | PUBLISH_DEVELOPER_ID = 'MangKyu' 10 | PUBLISH_DEVELOPER_NAME = 'MinKyu Jo' 11 | PUBLISH_DEVELOPER_EMAIL = 'whalsrb1226@gmail.com' 12 | PUBLISH_SCM_CONNECTION = 'scm:git:github.com/MangKyu/spring-boot-test-automock.git' 13 | PUBLISH_SCM_DEVELOPER_CONNECTION = 'scm:git:ssh://github.com:MangKyu/spring-boot-test-automock.git' 14 | PUBLISH_SCM_URL = 'https://github.com/MangKyu/spring-boot-test-automock/tree/master' 15 | } -------------------------------------------------------------------------------- /src/main/java/io/github/mangkyu/springboot/test/automock/listener/AutoMockTestExecutionListener.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.listener; 2 | 3 | import io.github.mangkyu.springboot.test.automock.parser.AutoMockClassParser; 4 | import org.mockito.internal.util.MockUtil; 5 | import org.slf4j.Logger; 6 | import org.slf4j.LoggerFactory; 7 | import org.springframework.test.context.TestContext; 8 | import org.springframework.test.context.support.AbstractTestExecutionListener; 9 | 10 | import java.util.List; 11 | 12 | public class AutoMockTestExecutionListener extends AbstractTestExecutionListener { 13 | 14 | private static final Logger log = LoggerFactory.getLogger(AutoMockTestExecutionListener.class); 15 | 16 | @Override 17 | public void beforeTestExecution(final TestContext testContext) { 18 | final List mockedFieldVariables = AutoMockClassParser.findMockedFieldVariables(testContext); 19 | for (final Object fieldVariable : mockedFieldVariables) { 20 | log.debug("reset mock, test class: {}, test method: {}, variable: {} ", 21 | testContext.getTestClass().getSimpleName(), testContext.getTestMethod().getName(), MockUtil.getMockName(fieldVariable)); 22 | MockUtil.resetMock(fieldVariable); 23 | } 24 | } 25 | 26 | } 27 | -------------------------------------------------------------------------------- /src/main/java/io/github/mangkyu/springboot/test/automock/config/AutoMockAutoConfiguration.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.config; 2 | 3 | import io.github.mangkyu.springboot.test.automock.beanfactorypostprocessor.AutoMockBeanFactoryPostProcessor; 4 | import org.springframework.boot.autoconfigure.AutoConfigureOrder; 5 | import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; 6 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; 7 | import org.springframework.boot.autoconfigure.condition.SearchStrategy; 8 | import org.springframework.context.annotation.Bean; 9 | import org.springframework.context.annotation.Configuration; 10 | import org.springframework.core.Ordered; 11 | 12 | @Configuration 13 | @ConditionalOnMissingBean(name = AutoMockAutoConfiguration.AUTO_MOCK_BEAN_NAME, search = SearchStrategy.CURRENT) 14 | @ConditionalOnProperty(name = "io.github.mangkyu.automock.enable", havingValue = "true") 15 | @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE) 16 | public class AutoMockAutoConfiguration { 17 | 18 | public static final String AUTO_MOCK_BEAN_NAME = "autoMockBeanFactoryPostProcessor"; 19 | 20 | @Bean 21 | public AutoMockBeanFactoryPostProcessor autoMockBeanFactoryPostProcessor() { 22 | return new AutoMockBeanFactoryPostProcessor(); 23 | } 24 | 25 | } -------------------------------------------------------------------------------- /src/main/java/io/github/mangkyu/springboot/test/automock/utils/AutoMockBeanUtils.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.utils; 2 | 3 | import org.slf4j.Logger; 4 | import org.slf4j.LoggerFactory; 5 | import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; 6 | import org.springframework.beans.factory.support.BeanDefinitionRegistry; 7 | import org.springframework.beans.factory.support.RootBeanDefinition; 8 | import org.springframework.context.annotation.AnnotationBeanNameGenerator; 9 | 10 | import static org.mockito.Mockito.mock; 11 | 12 | public final class AutoMockBeanUtils { 13 | 14 | private static final Logger log = LoggerFactory.getLogger(AutoMockBeanUtils.class); 15 | 16 | private AutoMockBeanUtils() { 17 | throw new IllegalStateException(); 18 | } 19 | 20 | public static void registerSingletonMock(final ConfigurableListableBeanFactory beanFactory, final Class parameterType, final String beanName) { 21 | beanFactory.registerSingleton(beanName, mock(parameterType)); 22 | log.debug("Mock object beanName: {} is registered Singleton", beanName); 23 | } 24 | 25 | public static String generateDefaultBeanName(final BeanDefinitionRegistry beanFactory, final Class parameterType) { 26 | final RootBeanDefinition definition = new RootBeanDefinition(parameterType); 27 | return AnnotationBeanNameGenerator.INSTANCE.generateBeanName(definition, beanFactory); 28 | } 29 | 30 | } 31 | -------------------------------------------------------------------------------- /src/test/java/io/github/mangkyu/springboot/test/automock/utils/AutoMockBeanUtilsTest.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.utils; 2 | 3 | import io.github.mangkyu.springboot.test.automock.testcontext.AutoMockMockService; 4 | import org.junit.jupiter.api.BeforeEach; 5 | import org.junit.jupiter.api.Test; 6 | import org.mockito.internal.util.MockUtil; 7 | import org.springframework.beans.factory.support.DefaultListableBeanFactory; 8 | 9 | import static org.assertj.core.api.Assertions.assertThat; 10 | 11 | class AutoMockBeanUtilsTest { 12 | 13 | private DefaultListableBeanFactory beanFactory; 14 | private Class clazz; 15 | private String beanName; 16 | 17 | @BeforeEach 18 | void init() { 19 | beanFactory = new DefaultListableBeanFactory(); 20 | clazz = AutoMockMockService.class; 21 | beanName = "autoMockMockService"; 22 | } 23 | 24 | @Test 25 | void registerSingletonMockSuccess() { 26 | AutoMockBeanUtils.registerSingletonMock(beanFactory, clazz, beanName); 27 | 28 | final AutoMockMockService result = (AutoMockMockService) beanFactory.getBean(beanName); 29 | 30 | assertThat(result).isNotNull(); 31 | assertThat(MockUtil.isMock(result)).isTrue(); 32 | } 33 | 34 | @Test 35 | void generateDefaultBeanNameSuccess() { 36 | final String result = AutoMockBeanUtils.generateDefaultBeanName(beanFactory, clazz); 37 | assertThat(result).isEqualTo(beanName); 38 | } 39 | 40 | } -------------------------------------------------------------------------------- /src/test/java/io/github/mangkyu/springboot/test/automock/listener/InitMockTest.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.listener; 2 | 3 | import io.github.mangkyu.springboot.test.automock.testcontext.AutoMockMockService; 4 | import org.junit.jupiter.api.Test; 5 | import org.mockito.internal.util.MockUtil; 6 | import org.springframework.beans.factory.annotation.Autowired; 7 | import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest; 8 | 9 | import static org.assertj.core.api.Assertions.assertThat; 10 | import static org.mockito.Mockito.doReturn; 11 | 12 | @WebMvcTest 13 | public class InitMockTest { 14 | 15 | @Autowired 16 | private AutoMockMockService autoMockMockService; 17 | 18 | @Test 19 | void isMocked() { 20 | assertThat(MockUtil.isMock(autoMockMockService)).isTrue(); 21 | } 22 | 23 | @Test 24 | void call1() { 25 | doReturn("A").when(autoMockMockService).call("C"); 26 | 27 | final String result = autoMockMockService.call("C"); 28 | assertThat(result).isEqualTo("A"); 29 | } 30 | 31 | @Test 32 | void call2() { 33 | doReturn("B").when(autoMockMockService).call("C"); 34 | 35 | final String result = autoMockMockService.call("C"); 36 | 37 | assertThat(result).isEqualTo("B"); 38 | 39 | } 40 | 41 | @Test 42 | void call3() { 43 | final String result = autoMockMockService.call("C"); 44 | 45 | assertThat(result).isNull(); 46 | doReturn("C").when(autoMockMockService).call("C"); 47 | } 48 | 49 | @Test 50 | void call4() { 51 | final String result = autoMockMockService.call("C"); 52 | assertThat(result).isNull(); 53 | } 54 | 55 | } 56 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # AutoMock: Enhance your @WebMvcTest performance 2 | 3 | ## What is AutoMock 4 | SpringBoot supports @WebMvcTest annotation for convenience web layer(controller) slice test. When testing web layer, it is necessary to mock or spy beans that controller depends on using @MockBean and @SpyBean. 5 | However test specific controller through @WebMvcTest with @MockBean or @SpyBean affects test performance because it requires to reload spring context. Also it makes test context to handle lots of application context while testing. 6 |
7 | 8 | AutoMock will automatically generate mock objects that our component depends on through constructor parameter type. So it will allows your @WebMvcTest to reuse spring test context and enhance your @WebMvcTest test performance 9 |
10 | 11 | ## How to use 12 | Basically we will test our controller layers like below 13 | 14 | ASIS: 15 | ```java 16 | @WebMvcTest(MockBeanController.class) 17 | public class MockBeanTest { 18 | 19 | @MockBean 20 | private MockBeanService mockBeanService; 21 | 22 | } 23 | ``` 24 | 25 |
26 |
27 | 28 | If you use AutoMock, Mock object will be created and registered in bean factory. So field injection through autowired is possible instead of @MockBean like below. 29 | Be aware that controller is not specified in @WebMvcTest. Specify controller will also require spring test context to be created. So do not specify controllers. 30 | 31 | ```java 32 | @WebMvcTest 33 | public class MockBeanTest { 34 | 35 | @Autowired 36 | private MockBeanService mockBeanService; 37 | 38 | } 39 | ``` 40 | 41 | 42 |
43 |
44 | 45 | 46 | ## Getting started 47 | build.gradle 48 | ```gradle 49 | testImplementation 'io.github.mangkyu:spring-boot-test-automock:0.0.4' 50 | ``` 51 | 52 | ## Be aware 53 | - Currently automock not supports spying 54 | - Currently mock object is generated based on constructor parameter type 55 | - As it does not specify controller, any controller's api can be called by mockmvc 56 | 57 | -------------------------------------------------------------------------------- /src/main/java/io/github/mangkyu/springboot/test/automock/parser/AutoMockClassParser.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.parser; 2 | 3 | import io.github.mangkyu.springboot.test.automock.listener.AutoMockTestExecutionListener; 4 | import org.mockito.internal.util.MockUtil; 5 | import org.slf4j.Logger; 6 | import org.slf4j.LoggerFactory; 7 | import org.springframework.beans.BeanUtils; 8 | import org.springframework.test.context.TestContext; 9 | import org.springframework.test.util.ReflectionTestUtils; 10 | 11 | import java.lang.reflect.Constructor; 12 | import java.lang.reflect.Field; 13 | import java.util.Arrays; 14 | import java.util.List; 15 | import java.util.stream.Collectors; 16 | 17 | public final class AutoMockClassParser { 18 | 19 | private static final Logger log = LoggerFactory.getLogger(AutoMockClassParser.class); 20 | private static final ClassLoader CLASS_LOADER = AutoMockClassParser.class.getClassLoader(); 21 | 22 | private AutoMockClassParser() { 23 | throw new IllegalStateException(); 24 | } 25 | 26 | public static Constructor findConstructor(final String beanClassName) { 27 | try { 28 | final Class beanClass = CLASS_LOADER.loadClass(beanClassName); 29 | return BeanUtils.getResolvableConstructor(beanClass); 30 | } catch (final ClassNotFoundException e) { 31 | log.debug("cannot find class: {}", beanClassName, e); 32 | } 33 | 34 | // return constructor that has no parameterTypes 35 | return AutoMockTestExecutionListener.class.getDeclaredConstructors()[0]; 36 | } 37 | 38 | public static List findMockedFieldVariables(final TestContext testContext) { 39 | return Arrays.stream(findDeclaredFields(testContext)) 40 | .map(v -> ReflectionTestUtils.getField(testContext.getTestInstance(), v.getName())) 41 | .filter(MockUtil::isMock) 42 | .collect(Collectors.toList()); 43 | } 44 | 45 | private static Field[] findDeclaredFields(final TestContext testContext) { 46 | return testContext.getTestClass().getDeclaredFields(); 47 | } 48 | 49 | public static boolean belongsToUserPackage(final Class parameterClass, final String basePackage) { 50 | return parameterClass.getPackage().getName().contains(basePackage); 51 | } 52 | 53 | } 54 | -------------------------------------------------------------------------------- /src/test/java/io/github/mangkyu/springboot/test/automock/parser/AutoMockClassParserTest.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.parser; 2 | 3 | import io.github.mangkyu.springboot.test.automock.listener.AutoMockTestExecutionListener; 4 | import io.github.mangkyu.springboot.test.automock.testcontext.AutoMockTestContext; 5 | import org.junit.jupiter.api.BeforeEach; 6 | import org.junit.jupiter.api.Test; 7 | import org.springframework.test.context.TestContext; 8 | 9 | import java.lang.reflect.Constructor; 10 | import java.util.List; 11 | 12 | import static org.assertj.core.api.Assertions.assertThat; 13 | 14 | class AutoMockClassParserTest { 15 | 16 | private TestContext testContext; 17 | 18 | @BeforeEach 19 | void init() { 20 | testContext = new AutoMockTestContext(); 21 | } 22 | 23 | @Test 24 | void findConstructorSuccess() { 25 | final Constructor constructor = AutoMockClassParser.findConstructor(TestConstructorClass.class.getName()); 26 | assertThat(constructor.getParameterTypes().length).isOne(); 27 | } 28 | 29 | @Test 30 | void findConstructorSuccess_NotExistsClass() { 31 | final Constructor constructor = AutoMockClassParser.findConstructor("NotExists"); 32 | assertThat(constructor.getParameterTypes().length).isZero(); 33 | } 34 | 35 | @Test 36 | void findMockedFieldVariables() { 37 | final List fieldList = AutoMockClassParser.findMockedFieldVariables(testContext); 38 | assertThat(fieldList.size()).isEqualTo(1); 39 | } 40 | 41 | @Test 42 | void belongsToUserPackage_True() { 43 | final String basePackage = "io.github.mangkyu.springboot.test.automock.listener"; 44 | 45 | final boolean result = AutoMockClassParser.belongsToUserPackage(AutoMockTestExecutionListener.class, basePackage); 46 | assertThat(result).isTrue(); 47 | } 48 | 49 | @Test 50 | void belongsToUserPackage_False() { 51 | final String basePackage = "io.github.mangkyu.springboot.test.automock.utils"; 52 | 53 | final boolean result = AutoMockClassParser.belongsToUserPackage(AutoMockTestExecutionListener.class, basePackage); 54 | assertThat(result).isFalse(); 55 | } 56 | 57 | private static class TestConstructorClass { 58 | private final String name; 59 | 60 | public TestConstructorClass(final String name) { 61 | this.name = name; 62 | } 63 | 64 | public String getName() { 65 | return name; 66 | } 67 | } 68 | 69 | } -------------------------------------------------------------------------------- /src/main/java/io/github/mangkyu/springboot/test/automock/listener/AutoMockEventListener.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.listener; 2 | 3 | import io.github.mangkyu.springboot.test.automock.properties.AutoMockProperties; 4 | import io.github.mangkyu.springboot.test.automock.utils.AutoMockBeanUtils; 5 | import io.github.mangkyu.springboot.test.automock.utils.AutoMockPropertyUtils; 6 | import org.slf4j.Logger; 7 | import org.slf4j.LoggerFactory; 8 | import org.springframework.beans.factory.support.DefaultListableBeanFactory; 9 | import org.springframework.boot.SpringApplication; 10 | import org.springframework.boot.context.event.ApplicationPreparedEvent; 11 | import org.springframework.context.ApplicationListener; 12 | import org.springframework.util.StringUtils; 13 | 14 | public class AutoMockEventListener implements ApplicationListener { 15 | 16 | private static final Logger log = LoggerFactory.getLogger(AutoMockEventListener.class); 17 | 18 | @Override 19 | public void onApplicationEvent(final ApplicationPreparedEvent event) { 20 | final DefaultListableBeanFactory beanFactory = (DefaultListableBeanFactory) event.getApplicationContext().getBeanFactory(); 21 | final String beanName = AutoMockBeanUtils.generateDefaultBeanName(beanFactory, AutoMockProperties.class); 22 | if (!beanFactory.containsBean(beanName)) { 23 | final AutoMockProperties autoMockProperties = new AutoMockProperties(findBasePackage(event)); 24 | beanFactory.registerSingleton(beanName, autoMockProperties); 25 | log.debug("BeanName: {} is registered Singleton", beanName); 26 | } else { 27 | log.debug("BeanName: {} is already registered Singleton", beanName); 28 | } 29 | } 30 | 31 | private String findBasePackage(final ApplicationPreparedEvent event) { 32 | final String propertyBasePackage = AutoMockPropertyUtils.findBasePackage(event.getApplicationContext()); 33 | return StringUtils.hasText(propertyBasePackage) 34 | ? propertyBasePackage 35 | : findBasePackageFromMainClass((SpringApplication) event.getSource()); 36 | } 37 | 38 | private String findBasePackageFromMainClass(final SpringApplication springApplication) { 39 | return ((Class) springApplication.getAllSources().stream() 40 | .findFirst() 41 | .orElseThrow(() -> new IllegalStateException("MainClass Not Found"))) 42 | .getPackage() 43 | .getName(); 44 | } 45 | 46 | } -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /src/test/java/io/github/mangkyu/springboot/test/automock/testcontext/AutoMockTestContext.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.testcontext; 2 | 3 | import org.springframework.context.ApplicationContext; 4 | import org.springframework.context.ApplicationEvent; 5 | import org.springframework.context.annotation.AnnotationConfigApplicationContext; 6 | import org.springframework.test.annotation.DirtiesContext; 7 | import org.springframework.test.context.TestContext; 8 | 9 | import java.lang.reflect.Method; 10 | import java.util.function.Function; 11 | 12 | public class AutoMockTestContext implements TestContext { 13 | 14 | private final ApplicationContext applicationContext; 15 | private final Class testClass; 16 | private final Object testInstance; 17 | 18 | 19 | public AutoMockTestContext() { 20 | this.applicationContext = new AnnotationConfigApplicationContext(); 21 | this.testClass = AutoMockTestControllerTest.class; 22 | 23 | try { 24 | this.testInstance = testClass.newInstance(); 25 | } catch (final InstantiationException | IllegalAccessException e) { 26 | throw new RuntimeException(); 27 | } 28 | } 29 | 30 | @Override 31 | public boolean hasApplicationContext() { 32 | return true; 33 | } 34 | 35 | @Override 36 | public void publishEvent(final Function eventFactory) { 37 | 38 | } 39 | 40 | @Override 41 | public ApplicationContext getApplicationContext() { 42 | return applicationContext; 43 | } 44 | 45 | @Override 46 | public Class getTestClass() { 47 | return testClass; 48 | } 49 | 50 | @Override 51 | public Object getTestInstance() { 52 | return testInstance; 53 | } 54 | 55 | @Override 56 | public Method getTestMethod() { 57 | return testClass.getDeclaredMethods()[0]; 58 | } 59 | 60 | @Override 61 | public Throwable getTestException() { 62 | return null; 63 | } 64 | 65 | @Override 66 | public void markApplicationContextDirty(final DirtiesContext.HierarchyMode hierarchyMode) { 67 | 68 | } 69 | 70 | @Override 71 | public void updateState(final Object testInstance, final Method testMethod, final Throwable testException) { 72 | 73 | } 74 | 75 | @Override 76 | public T computeAttribute(final String name, final Function computeFunction) { 77 | return TestContext.super.computeAttribute(name, computeFunction); 78 | } 79 | 80 | @Override 81 | public void setAttribute(final String name, final Object value) { 82 | 83 | } 84 | 85 | @Override 86 | public Object getAttribute(final String name) { 87 | return null; 88 | } 89 | 90 | @Override 91 | public Object removeAttribute(final String name) { 92 | return null; 93 | } 94 | 95 | @Override 96 | public boolean hasAttribute(final String name) { 97 | return false; 98 | } 99 | 100 | @Override 101 | public String[] attributeNames() { 102 | return new String[0]; 103 | } 104 | } 105 | -------------------------------------------------------------------------------- /src/main/java/io/github/mangkyu/springboot/test/automock/beanfactorypostprocessor/AutoMockBeanFactoryPostProcessor.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.beanfactorypostprocessor; 2 | 3 | import io.github.mangkyu.springboot.test.automock.parser.AutoMockClassParser; 4 | import io.github.mangkyu.springboot.test.automock.properties.AutoMockProperties; 5 | import io.github.mangkyu.springboot.test.automock.utils.AutoMockBeanUtils; 6 | import org.slf4j.Logger; 7 | import org.slf4j.LoggerFactory; 8 | import org.springframework.beans.BeansException; 9 | import org.springframework.beans.factory.config.BeanFactoryPostProcessor; 10 | import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; 11 | import org.springframework.beans.factory.support.BeanDefinitionRegistry; 12 | import org.springframework.context.annotation.ScannedGenericBeanDefinition; 13 | import org.springframework.util.StringUtils; 14 | 15 | import java.lang.reflect.Constructor; 16 | import java.util.Arrays; 17 | import java.util.List; 18 | import java.util.stream.Collectors; 19 | 20 | public class AutoMockBeanFactoryPostProcessor implements BeanFactoryPostProcessor { 21 | 22 | private static final Logger log = LoggerFactory.getLogger(AutoMockBeanFactoryPostProcessor.class); 23 | 24 | @Override 25 | public void postProcessBeanFactory(final ConfigurableListableBeanFactory beanFactory) throws BeansException { 26 | log.trace("postProcessBeanFactory start"); 27 | final List> constructorList = findConstructorsOfScannedBean(beanFactory); 28 | final AutoMockProperties autoMockProperties = (AutoMockProperties) beanFactory.getSingleton(AutoMockBeanUtils.generateDefaultBeanName((BeanDefinitionRegistry) beanFactory, AutoMockProperties.class)); 29 | if (autoMockProperties == null || !StringUtils.hasText(autoMockProperties.getBasePackage())) { 30 | throw new IllegalStateException("AutoMockProperties not found"); 31 | } 32 | 33 | for (Constructor v : constructorList) { 34 | for (Class parameterClass : v.getParameterTypes()) { 35 | addUnregisteredCustomBeans(beanFactory, autoMockProperties, parameterClass); 36 | } 37 | } 38 | 39 | log.trace("postProcessBeanFactory complete"); 40 | } 41 | 42 | private void addUnregisteredCustomBeans(final ConfigurableListableBeanFactory beanFactory, final AutoMockProperties autoMockProperties, final Class parameterClass) { 43 | final String beanName = AutoMockBeanUtils.generateDefaultBeanName((BeanDefinitionRegistry) beanFactory, parameterClass); 44 | if (isUnregisteredCustomBean(beanFactory, autoMockProperties, parameterClass, beanName)) { 45 | AutoMockBeanUtils.registerSingletonMock(beanFactory, parameterClass, beanName); 46 | } 47 | } 48 | 49 | private boolean isUnregisteredCustomBean(final ConfigurableListableBeanFactory beanFactory, final AutoMockProperties autoMockProperties, final Class parameterClass, final String beanName) { 50 | return !beanFactory.containsBean(beanName) && AutoMockClassParser.belongsToUserPackage(parameterClass, autoMockProperties.getBasePackage()); 51 | } 52 | 53 | public List> findConstructorsOfScannedBean(final ConfigurableListableBeanFactory beanFactory) { 54 | return Arrays.stream(beanFactory.getBeanDefinitionNames()) 55 | .map(beanFactory::getBeanDefinition) 56 | .filter(v -> v instanceof ScannedGenericBeanDefinition) 57 | .map(v -> AutoMockClassParser.findConstructor(v.getBeanClassName())) 58 | .collect(Collectors.toList()); 59 | } 60 | 61 | } 62 | -------------------------------------------------------------------------------- /src/test/java/io/github/mangkyu/springboot/test/automock/beanfactorypostprocessor/AutoMockBeanFactoryPostProcessorTest.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.beanfactorypostprocessor; 2 | 3 | import io.github.mangkyu.springboot.test.automock.properties.AutoMockProperties; 4 | import io.github.mangkyu.springboot.test.automock.testcontext.AutoMockTestController; 5 | import io.github.mangkyu.springboot.test.automock.utils.AutoMockBeanUtils; 6 | import org.junit.jupiter.api.BeforeEach; 7 | import org.junit.jupiter.api.Test; 8 | import org.springframework.beans.factory.support.DefaultListableBeanFactory; 9 | import org.springframework.context.annotation.ScannedGenericBeanDefinition; 10 | import org.springframework.core.type.classreading.CachingMetadataReaderFactory; 11 | import org.springframework.core.type.classreading.MetadataReader; 12 | 13 | import java.io.IOException; 14 | import java.lang.reflect.Constructor; 15 | import java.util.List; 16 | 17 | import static org.assertj.core.api.Assertions.assertThat; 18 | import static org.junit.jupiter.api.Assertions.assertThrows; 19 | 20 | class AutoMockBeanFactoryPostProcessorTest { 21 | 22 | private DefaultListableBeanFactory beanFactory; 23 | private AutoMockBeanFactoryPostProcessor beanFactoryPostProcessor; 24 | private final Class clazz = AutoMockTestController.class; 25 | 26 | @BeforeEach 27 | void init() throws IOException { 28 | beanFactory = new DefaultListableBeanFactory(); 29 | beanFactoryPostProcessor = new AutoMockBeanFactoryPostProcessor(); 30 | 31 | final CachingMetadataReaderFactory metadataReaderFactory = new CachingMetadataReaderFactory(); 32 | final MetadataReader metadataReader = metadataReaderFactory.getMetadataReader(clazz.getName()); 33 | final ScannedGenericBeanDefinition beanDefinition = new ScannedGenericBeanDefinition(metadataReader); 34 | 35 | final String beanName = AutoMockBeanUtils.generateDefaultBeanName(beanFactory, clazz); 36 | beanFactory.registerBeanDefinition(beanName, beanDefinition); 37 | beanFactory.registerSingleton(beanName, new AutoMockTestController(null)); 38 | } 39 | 40 | @Test 41 | void postProcessBeanFactoryFail_AutoMockNotExists() { 42 | final IllegalStateException result = assertThrows(IllegalStateException.class, () -> beanFactoryPostProcessor.postProcessBeanFactory(beanFactory)); 43 | 44 | assertThat(result).isNotNull(); 45 | } 46 | 47 | @Test 48 | void postProcessBeanFactoryFail_AutoMockNotPropertiesNull() { 49 | registerAutoMockProperties(""); 50 | 51 | final IllegalStateException result = assertThrows(IllegalStateException.class, () -> beanFactoryPostProcessor.postProcessBeanFactory(beanFactory)); 52 | 53 | assertThat(result).isNotNull(); 54 | } 55 | 56 | @Test 57 | void postProcessBeanFactorySuccess() { 58 | registerAutoMockProperties("mypackage"); 59 | beanFactoryPostProcessor.postProcessBeanFactory(beanFactory); 60 | 61 | assertThat(beanFactory.getSingletonNames().length).isEqualTo(clazz.getDeclaredConstructors()[0].getParameterTypes().length + 1); 62 | } 63 | 64 | @Test 65 | void findConstructorsOfScannedBeanSuccess() { 66 | final List> constructorList = beanFactoryPostProcessor.findConstructorsOfScannedBean(beanFactory); 67 | 68 | assertThat(constructorList.size()).isOne(); 69 | } 70 | 71 | private void registerAutoMockProperties(final String value) { 72 | final String beanName = AutoMockBeanUtils.generateDefaultBeanName(beanFactory, AutoMockProperties.class); 73 | beanFactory.registerSingleton(beanName, new AutoMockProperties(value)); 74 | } 75 | 76 | } -------------------------------------------------------------------------------- /src/test/java/io/github/mangkyu/springboot/test/automock/listener/AutoMockEventListenerTest.java: -------------------------------------------------------------------------------- 1 | package io.github.mangkyu.springboot.test.automock.listener; 2 | 3 | import io.github.mangkyu.springboot.test.automock.AutoMockApplication; 4 | import io.github.mangkyu.springboot.test.automock.properties.AutoMockProperties; 5 | import io.github.mangkyu.springboot.test.automock.utils.AutoMockBeanUtils; 6 | import io.github.mangkyu.springboot.test.automock.utils.AutoMockPropertyUtils; 7 | import org.junit.jupiter.api.BeforeEach; 8 | import org.junit.jupiter.api.Test; 9 | import org.springframework.beans.factory.support.DefaultListableBeanFactory; 10 | import org.springframework.boot.SpringApplication; 11 | import org.springframework.boot.context.event.ApplicationPreparedEvent; 12 | import org.springframework.context.ApplicationContext; 13 | import org.springframework.context.ConfigurableApplicationContext; 14 | import org.springframework.context.annotation.AnnotationConfigApplicationContext; 15 | 16 | import static org.assertj.core.api.Assertions.assertThat; 17 | 18 | class AutoMockEventListenerTest { 19 | 20 | private AutoMockEventListener target; 21 | private ApplicationPreparedEvent event; 22 | private ApplicationContext applicationContext; 23 | private Class clazz; 24 | 25 | @BeforeEach 26 | void init() { 27 | target = new AutoMockEventListener(); 28 | applicationContext = new AnnotationConfigApplicationContext(); 29 | clazz = AutoMockApplication.class; 30 | event = new ApplicationPreparedEvent(new SpringApplication(clazz), new String[0], (ConfigurableApplicationContext) applicationContext); 31 | ((ConfigurableApplicationContext) applicationContext).refresh(); 32 | } 33 | 34 | @Test 35 | void propertyRegistered() { 36 | final String myBasePackage = "myBasePackage"; 37 | System.setProperty(AutoMockPropertyUtils.AUTO_MOCK_BASE_PACKAGE, myBasePackage); 38 | target.onApplicationEvent(event); 39 | 40 | final DefaultListableBeanFactory beanFactory = (DefaultListableBeanFactory) applicationContext.getAutowireCapableBeanFactory(); 41 | final AutoMockProperties result = (AutoMockProperties) beanFactory.getSingleton(AutoMockBeanUtils.generateDefaultBeanName(beanFactory, AutoMockProperties.class)); 42 | 43 | assertThat(result).isNotNull(); 44 | assertThat(result.getBasePackage()).isEqualTo(myBasePackage); 45 | System.clearProperty(AutoMockPropertyUtils.AUTO_MOCK_BASE_PACKAGE); 46 | } 47 | 48 | @Test 49 | void mainClassPackageRegistered() { 50 | target.onApplicationEvent(event); 51 | 52 | final DefaultListableBeanFactory beanFactory = (DefaultListableBeanFactory) applicationContext.getAutowireCapableBeanFactory(); 53 | final AutoMockProperties result = (AutoMockProperties) beanFactory.getSingleton(AutoMockBeanUtils.generateDefaultBeanName(beanFactory, AutoMockProperties.class)); 54 | 55 | assertThat(result).isNotNull(); 56 | assertThat(result.getBasePackage()).isEqualTo(clazz.getPackage().getName()); 57 | } 58 | 59 | @Test 60 | void alreadyRegistered() { 61 | final String basePackage = "alreadyRegistered"; 62 | final DefaultListableBeanFactory beanFactory = (DefaultListableBeanFactory) applicationContext.getAutowireCapableBeanFactory(); 63 | final String beanName = AutoMockBeanUtils.generateDefaultBeanName(beanFactory, AutoMockProperties.class); 64 | beanFactory.registerSingleton(beanName, new AutoMockProperties(basePackage)); 65 | 66 | target.onApplicationEvent(event); 67 | final AutoMockProperties result = (AutoMockProperties) beanFactory.getSingleton(beanName); 68 | 69 | 70 | assertThat(result).isNotNull(); 71 | assertThat(result.getBasePackage()).isEqualTo(basePackage); 72 | } 73 | 74 | } -------------------------------------------------------------------------------- /scripts/publish-maven.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'maven-publish' 2 | apply plugin: 'signing' 3 | apply from: 'publish.gradle' 4 | 5 | task sourcesJar(type: Jar) { 6 | archiveClassifier.set("sources") 7 | } 8 | 9 | task javadocJar(type: Jar) { 10 | archiveClassifier.set("javadoc") 11 | } 12 | 13 | artifacts { 14 | archives sourcesJar 15 | archives javadocJar 16 | } 17 | 18 | 19 | group = PUBLISH_GROUP_ID 20 | version = PUBLISH_VERSION 21 | 22 | ext["signing.keyId"] = '' 23 | ext["signing.password"] = '' 24 | ext["signing.secretKeyRingFile"] = '' 25 | ext["ossrhUsername"] = '' 26 | ext["ossrhPassword"] = '' 27 | ext["sonatypeStagingProfileId"] = '' 28 | 29 | File secretPropsFile = project.rootProject.file('local.properties') 30 | if (secretPropsFile.exists()) { 31 | Properties p = new Properties() 32 | p.load(new FileInputStream(secretPropsFile)) 33 | p.each { name, value -> 34 | ext[name] = value 35 | } 36 | } else { 37 | ext["signing.keyId"] = System.getenv('SIGNING_KEY_ID') 38 | ext["signing.password"] = System.getenv('SIGNING_PASSWORD') 39 | ext["signing.secretKeyRingFile"] = System.getenv('SIGNING_SECRET_KEY_RING_FILE') 40 | ext["ossrhUsername"] = System.getenv('OSSRH_USERNAME') 41 | ext["ossrhPassword"] = System.getenv('OSSRH_PASSWORD') 42 | ext["sonatypeStagingProfileId"] = System.getenv('SONATYPE_STAGING_PROFILE_ID') 43 | } 44 | 45 | publishing { 46 | publications { 47 | release(MavenPublication) { 48 | groupId PUBLISH_GROUP_ID 49 | artifactId PUBLISH_ARTIFACT_ID 50 | version PUBLISH_VERSION 51 | 52 | artifact("$buildDir/libs/${project.getName()}-${version}.jar") 53 | 54 | artifact sourcesJar 55 | artifact javadocJar 56 | 57 | pom { 58 | name = PUBLISH_ARTIFACT_ID 59 | description = PUBLISH_DESCRIPTION 60 | url = PUBLISH_URL 61 | licenses { 62 | license { 63 | name = PUBLISH_LICENSE_NAME 64 | url = PUBLISH_LICENSE_URL 65 | } 66 | } 67 | developers { 68 | developer { 69 | id = PUBLISH_DEVELOPER_ID 70 | name = PUBLISH_DEVELOPER_NAME 71 | email = PUBLISH_DEVELOPER_EMAIL 72 | } 73 | // Other devs... 74 | } 75 | scm { 76 | connection = PUBLISH_SCM_CONNECTION 77 | developerConnection = PUBLISH_SCM_DEVELOPER_CONNECTION 78 | url = PUBLISH_SCM_URL 79 | } 80 | withXml { 81 | def dependenciesNode = asNode().appendNode('dependencies') 82 | 83 | project.configurations.implementation.allDependencies.each { 84 | def dependencyNode = dependenciesNode.appendNode('dependency') 85 | dependencyNode.appendNode('groupId', it.group) 86 | dependencyNode.appendNode('artifactId', it.name) 87 | dependencyNode.appendNode('version', it.version) 88 | } 89 | } 90 | } 91 | } 92 | } 93 | repositories { 94 | maven { 95 | name = "sonatype" 96 | url = "https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/" 97 | 98 | credentials { 99 | username ossrhUsername 100 | password ossrhPassword 101 | } 102 | } 103 | } 104 | } 105 | 106 | nexusPublishing { 107 | repositories { 108 | sonatype { 109 | nexusUrl.set(uri("https://s01.oss.sonatype.org/service/local/")) 110 | snapshotRepositoryUrl.set(uri("https://s01.oss.sonatype.org/content/repositories/snapshots/")) 111 | packageGroup = PUBLISH_GROUP_ID 112 | stagingProfileId = sonatypeStagingProfileId 113 | username = ossrhUsername 114 | password = ossrhPassword 115 | } 116 | } 117 | } 118 | 119 | signing { 120 | sign publishing.publications 121 | } -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 84 | 85 | APP_NAME="Gradle" 86 | APP_BASE_NAME=${0##*/} 87 | 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | 142 | # Increase the maximum file descriptors if we can. 143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 144 | case $MAX_FD in #( 145 | max*) 146 | MAX_FD=$( ulimit -H -n ) || 147 | warn "Could not query maximum file descriptor limit" 148 | esac 149 | case $MAX_FD in #( 150 | '' | soft) :;; #( 151 | *) 152 | ulimit -n "$MAX_FD" || 153 | warn "Could not set maximum file descriptor limit to $MAX_FD" 154 | esac 155 | fi 156 | 157 | # Collect all arguments for the java command, stacking in reverse order: 158 | # * args from the command line 159 | # * the main class name 160 | # * -classpath 161 | # * -D...appname settings 162 | # * --module-path (only if needed) 163 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 164 | 165 | # For Cygwin or MSYS, switch paths to Windows format before running java 166 | if "$cygwin" || "$msys" ; then 167 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 168 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 169 | 170 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 171 | 172 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 173 | for arg do 174 | if 175 | case $arg in #( 176 | -*) false ;; # don't mess with options #( 177 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 178 | [ -e "$t" ] ;; #( 179 | *) false ;; 180 | esac 181 | then 182 | arg=$( cygpath --path --ignore --mixed "$arg" ) 183 | fi 184 | # Roll the args list around exactly as many times as the number of 185 | # args, so each arg winds up back in the position where it started, but 186 | # possibly modified. 187 | # 188 | # NB: a `for` loop captures its iteration list before it begins, so 189 | # changing the positional parameters here affects neither the number of 190 | # iterations, nor the values presented in `arg`. 191 | shift # remove old arg 192 | set -- "$@" "$arg" # push replacement arg 193 | done 194 | fi 195 | 196 | # Collect all arguments for the java command; 197 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 198 | # shell script including quotes and variable substitutions, so put them in 199 | # double quotes to make sure that they get re-expanded; and 200 | # * put everything else in single quotes, so that it's not re-expanded. 201 | 202 | set -- \ 203 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 204 | -classpath "$CLASSPATH" \ 205 | org.gradle.wrapper.GradleWrapperMain \ 206 | "$@" 207 | 208 | # Use "xargs" to parse quoted args. 209 | # 210 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 211 | # 212 | # In Bash we could simply go: 213 | # 214 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 215 | # set -- "${ARGS[@]}" "$@" 216 | # 217 | # but POSIX shell has neither arrays nor command substitution, so instead we 218 | # post-process each arg (as a line of input to sed) to backslash-escape any 219 | # character that might be a shell metacharacter, then use eval to reverse 220 | # that process (while maintaining the separation between arguments), and wrap 221 | # the whole thing up as a single "set" statement. 222 | # 223 | # This will of course break if any of these variables contains a newline or 224 | # an unmatched quote. 225 | # 226 | 227 | eval "set -- $( 228 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 229 | xargs -n1 | 230 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 231 | tr '\n' ' ' 232 | )" '"$@"' 233 | 234 | exec "$JAVACMD" "$@" 235 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a member through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive member interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the member that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of member commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive member interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular member, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular member or of the way in which the particular member 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------