GH-3213: Expose LeaderInitiatorFB.candidate

artembilan · artembilan · commit 46cf5db78a42 · 2020-03-11T16:07:17.000-04:00
Fixes #3213 * Expose a `LeaderInitiatorFactoryBean.setCandidate()` for better control over candidate options * Expose a `candidate` attribute for the `<int-zk:leader-listener>` tag * Fix `dokka` task to obtain `package-list` URL from the local dir * Migrate ZK tests to JUnit 5
diff --git a/build.gradle b/build.gradle
@@ -1008,6 +1008,7 @@ dokka {
 		moduleName = 'spring-integration'
 		externalDocumentationLink {
 			url = new URL("https://docs.spring.io/spring-integration/docs/$version/api/")
+			packageListUrl = new File(buildDir, "api/package-list").toURI().toURL()
 		}
 		externalDocumentationLink {
 			url = new URL('https://docs.spring.io/spring-framework/docs/current/javadoc-api/')
diff --git a/spring-integration-zookeeper/src/main/java/org/springframework/integration/zookeeper/config/LeaderInitiatorFactoryBean.java b/spring-integration-zookeeper/src/main/java/org/springframework/integration/zookeeper/config/LeaderInitiatorFactoryBean.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2019 the original author or authors.
+ * Copyright 2015-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,6 +30,7 @@
 import org.springframework.integration.leader.event.DefaultLeaderEventPublisher;
 import org.springframework.integration.leader.event.LeaderEventPublisher;
 import org.springframework.integration.zookeeper.leader.LeaderInitiator;
+import org.springframework.util.Assert;
 
 /**
  * Creates a {@link LeaderInitiator}.
@@ -71,8 +72,27 @@ public LeaderInitiatorFactoryBean setPath(String path) {
 		return this;
 	}
 
+	/**
+	 * Configure a role for {@link DefaultCandidate}.
+	 * Or this or {@link #setCandidate(Candidate)} can be configured, but not both.
+	 * @param role the role for candidate
+	 * @return this instance
+	 */
 	public LeaderInitiatorFactoryBean setRole(String role) {
-		this.candidate = new DefaultCandidate(UUID.randomUUID().toString(), role);
+		Assert.isNull(this.candidate,
+				"Or 'role' for an internal 'DefaultCandidate' or 'candidate' option must be provided, but not both.");
+		return setCandidate(new DefaultCandidate(UUID.randomUUID().toString(), role));
+	}
+
+	/**
+	 * Configure a {@link Candidate} for leader election.
+	 * Or this or {@link #setRole(String)} can be configured, but not both.
+	 * @param candidate the {@link Candidate} to use
+	 * @return this instance
+	 * @since 5.3
+	 */
+	public LeaderInitiatorFactoryBean setCandidate(Candidate candidate) {
+		this.candidate = candidate;
 		return this;
 	}
 
diff --git a/spring-integration-zookeeper/src/main/java/org/springframework/integration/zookeeper/config/xml/LeaderListenerParser.java b/spring-integration-zookeeper/src/main/java/org/springframework/integration/zookeeper/config/xml/LeaderListenerParser.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2019 the original author or authors.
+ * Copyright 2015-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -44,6 +44,7 @@ protected AbstractBeanDefinition parseInternal(Element element, ParserContext pa
 
 		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, IntegrationNamespaceUtils.AUTO_STARTUP);
 		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, IntegrationNamespaceUtils.PHASE);
+		IntegrationNamespaceUtils.setReferenceIfAttributeDefined(builder, element, "candidate");
 
 		return builder.getBeanDefinition();
 	}
diff --git a/spring-integration-zookeeper/src/main/resources/org/springframework/integration/zookeeper/config/spring-integration-zookeeper.xsd b/spring-integration-zookeeper/src/main/resources/org/springframework/integration/zookeeper/config/spring-integration-zookeeper.xsd
@@ -31,7 +31,7 @@
 		</xsd:annotation>
 		<xsd:complexType>
 			<xsd:attributeGroup ref="integration:smartLifeCycleAttributeGroup"/>
-			<xsd:attribute name="id" type="xsd:string" use="optional"/>
+			<xsd:attribute name="id" type="xsd:string"/>
 			<xsd:attribute name="client" type="xsd:string">
 				<xsd:annotation>
 					<xsd:documentation>
@@ -44,6 +44,19 @@
 					</xsd:appinfo>
 				</xsd:annotation>
 			</xsd:attribute>
+			<xsd:attribute name="candidate" type="xsd:string">
+				<xsd:annotation>
+					<xsd:documentation>
+						A reference to a Candidate bean.
+						Or this or 'role' option can be provided, but not both.
+					</xsd:documentation>
+					<xsd:appinfo>
+						<tool:annotation kind="ref">
+							<tool:expected-type type="org.springframework.integration.leader.Candidate"/>
+						</tool:annotation>
+					</xsd:appinfo>
+				</xsd:annotation>
+			</xsd:attribute>
 			<xsd:attribute name="path">
 				<xsd:annotation>
 					<xsd:documentation>
diff --git a/spring-integration-zookeeper/src/test/java/org/springframework/integration/zookeeper/ZookeeperTestSupport.java b/spring-integration-zookeeper/src/test/java/org/springframework/integration/zookeeper/ZookeeperTestSupport.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2019 the original author or authors.
+ * Copyright 2015-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,10 +25,10 @@
 import org.apache.curator.retry.BoundedExponentialBackoffRetry;
 import org.apache.curator.test.TestingServer;
 import org.apache.curator.utils.CloseableUtils;
-import org.junit.After;
-import org.junit.AfterClass;
-import org.junit.Before;
-import org.junit.BeforeClass;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
 
 /**
  * @author Marius Bogoevici
@@ -48,12 +48,12 @@ public class ZookeeperTestSupport {
 
 	protected CuratorFramework client;
 
-	@BeforeClass
+	@BeforeAll
 	public static void setUpClass() throws Exception {
 		testingServer = new TestingServer(true);
 	}
 
-	@AfterClass
+	@AfterAll
 	public static void tearDownClass() {
 		try {
 			testingServer.stop();
@@ -64,12 +64,12 @@ public static void tearDownClass() {
 		testingServer.getTempDirectory().delete();
 	}
 
-	@Before
+	@BeforeEach
 	public void setUp() {
 		client = createNewClient();
 	}
 
-	@After
+	@AfterEach
 	public void tearDown() throws Exception {
 		CloseableUtils.closeQuietly(this.client);
 	}
diff --git a/spring-integration-zookeeper/src/test/java/org/springframework/integration/zookeeper/config/CuratorFrameworkFactoryBeanTests.java b/spring-integration-zookeeper/src/test/java/org/springframework/integration/zookeeper/config/CuratorFrameworkFactoryBeanTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2019 the original author or authors.
+ * Copyright 2015-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@
 import org.apache.curator.framework.CuratorFramework;
 import org.apache.curator.framework.imps.CuratorFrameworkState;
 import org.apache.curator.test.TestingServer;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 /**
  * @author Gary Russell
diff --git a/spring-integration-zookeeper/src/test/java/org/springframework/integration/zookeeper/config/LeaderInitiatorFactoryBeanTests.java b/spring-integration-zookeeper/src/test/java/org/springframework/integration/zookeeper/config/LeaderInitiatorFactoryBeanTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2019 the original author or authors.
+ * Copyright 2015-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,14 +20,14 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.UUID;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
 
 import org.apache.curator.framework.CuratorFramework;
-import org.junit.AfterClass;
-import org.junit.BeforeClass;
-import org.junit.Test;
-import org.junit.runner.RunWith;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.ApplicationListener;
@@ -42,17 +42,16 @@
 import org.springframework.integration.zookeeper.ZookeeperTestSupport;
 import org.springframework.integration.zookeeper.leader.LeaderInitiator;
 import org.springframework.test.annotation.DirtiesContext;
-import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
 
 /**
  * @author Gary Russell
  * @author Artem Bilan
+ *
  * @since 4.2
  *
  */
-@ContextConfiguration
-@RunWith(SpringJUnit4ClassRunner.class)
+@SpringJUnitConfig
 @DirtiesContext
 public class LeaderInitiatorFactoryBeanTests extends ZookeeperTestSupport {
 
@@ -64,12 +63,12 @@ public class LeaderInitiatorFactoryBeanTests extends ZookeeperTestSupport {
 	@Autowired
 	private Config config;
 
-	@BeforeClass
-	public static void getClient() throws Exception {
+	@BeforeAll
+	public static void getClient() {
 		client = createNewClient();
 	}
 
-	@AfterClass
+	@AfterAll
 	public static void closeClient() {
 		if (client != null) {
 			client.close();
@@ -118,7 +117,7 @@ public void publishOnGranted(Object source, Context context, String role) {
 	@Configuration
 	public static class Config {
 
-		private final List<AbstractLeaderEvent> events = new ArrayList<AbstractLeaderEvent>();
+		private final List<AbstractLeaderEvent> events = new ArrayList<>();
 
 		private final CountDownLatch latch1 = new CountDownLatch(1);
 
@@ -129,7 +128,7 @@ public LeaderInitiatorFactoryBean leaderInitiator(CuratorFramework client) {
 			return new LeaderInitiatorFactoryBean()
 					.setClient(client)
 					.setPath("/siTest/")
-					.setRole("foo");
+					.setCandidate(new DefaultCandidate(UUID.randomUUID().toString(), "foo"));
 		}
 
 		@Bean
diff --git a/spring-integration-zookeeper/src/test/java/org/springframework/integration/zookeeper/config/xml/ZookeeperParserTests.java b/spring-integration-zookeeper/src/test/java/org/springframework/integration/zookeeper/config/xml/ZookeeperParserTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2019 the original author or authors.
+ * Copyright 2015-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,8 +19,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 import org.apache.curator.framework.CuratorFramework;
-import org.junit.Test;
-import org.junit.runner.RunWith;
+import org.junit.jupiter.api.Test;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
@@ -29,16 +28,16 @@
 import org.springframework.integration.zookeeper.ZookeeperTestSupport;
 import org.springframework.integration.zookeeper.leader.LeaderInitiator;
 import org.springframework.test.annotation.DirtiesContext;
-import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
 
 /**
  * @author Gary Russell
+ * @author Artem Bilan
+ *
  * @since 4.2
  *
  */
-@ContextConfiguration
-@RunWith(SpringJUnit4ClassRunner.class)
+@SpringJUnitConfig
 @DirtiesContext
 public class ZookeeperParserTests extends ZookeeperTestSupport {
 
@@ -76,9 +75,10 @@ public void test() throws Exception {
 	public static class Config {
 
 		@Bean
-		public CuratorFramework client() throws Exception {
+		public CuratorFramework client() {
 			return createNewClient();
 		}
+
 	}
 
 }
diff --git a/spring-integration-zookeeper/src/test/java/org/springframework/integration/zookeeper/event/ZookeeperLeaderTests.java b/spring-integration-zookeeper/src/test/java/org/springframework/integration/zookeeper/event/ZookeeperLeaderTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2019 the original author or authors.
+ * Copyright 2015-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,12 +25,11 @@
 import java.util.concurrent.LinkedBlockingQueue;
 import java.util.concurrent.TimeUnit;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.context.ApplicationEvent;
 import org.springframework.context.ApplicationEventPublisher;
-import org.springframework.context.SmartLifecycle;
 import org.springframework.integration.channel.QueueChannel;
 import org.springframework.integration.core.MessageSource;
 import org.springframework.integration.endpoint.SourcePollingChannelAdapter;
@@ -48,17 +47,19 @@
 
 /**
  * @author Gary Russell
+ * @author Artem Bilan
+ *
  * @since 4.2
  *
  */
 public class ZookeeperLeaderTests extends ZookeeperTestSupport {
 
-	private final BlockingQueue<AbstractLeaderEvent> events = new LinkedBlockingQueue<AbstractLeaderEvent>();
+	private final BlockingQueue<AbstractLeaderEvent> events = new LinkedBlockingQueue<>();
 
 	private final SourcePollingChannelAdapter adapter = buildChannelAdapter();
 
 	private final SmartLifecycleRoleController controller = new SmartLifecycleRoleController(
-			Collections.singletonList("sitest"), Collections.<SmartLifecycle>singletonList(this.adapter));
+			Collections.singletonList("sitest"), Collections.singletonList(this.adapter));
 
 	private final CountDownLatch yieldBarrier = new CountDownLatch(1);
 
diff --git a/spring-integration-zookeeper/src/test/java/org/springframework/integration/zookeeper/lock/ZkLockRegistryTests.java b/spring-integration-zookeeper/src/test/java/org/springframework/integration/zookeeper/lock/ZkLockRegistryTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2019 the original author or authors.
+ * Copyright 2015-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,15 +27,16 @@
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.locks.Lock;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 import org.springframework.integration.test.util.TestUtils;
 import org.springframework.integration.zookeeper.ZookeeperTestSupport;
 import org.springframework.messaging.MessagingException;
 
 /**
  * @author Gary Russell
- * @author Artem Bilan
+ * @author Artem Bilan\
+ *
  * @since 4.2
  *
  */
@@ -78,7 +79,7 @@ public void testLockInterruptibly() throws Exception {
 	}
 
 	@Test
-	public void testReentrantLock() throws Exception {
+	public void testReentrantLock() {
 		ZookeeperLockRegistry registry = new ZookeeperLockRegistry(this.client);
 		for (int i = 0; i < 10; i++) {
 			Lock lock1 = registry.obtain("foo");
diff --git a/spring-integration-zookeeper/src/test/java/org/springframework/integration/zookeeper/metadata/ZookeeperMetadataStoreTests.java b/spring-integration-zookeeper/src/test/java/org/springframework/integration/zookeeper/metadata/ZookeeperMetadataStoreTests.java
diff --git a/src/reference/asciidoc/whats-new.adoc b/src/reference/asciidoc/whats-new.adoc
diff --git a/src/reference/asciidoc/zookeeper.adoc b/src/reference/asciidoc/zookeeper.adoc

Original file line number	Diff line number	Diff line change
`@@ -1008,6 +1008,7 @@ dokka {`
`1008`	`1008`	`moduleName = 'spring-integration'`
`1009`	`1009`	`externalDocumentationLink {`
`1010`	`1010`	`url = new URL("https://docs.spring.io/spring-integration/docs/$version/api/")`
	`1011`	`+ packageListUrl = new File(buildDir, "api/package-list").toURI().toURL()`
`1011`	`1012`	`}`
`1012`	`1013`	`externalDocumentationLink {`
`1013`	`1014`	`url = new URL('https://docs.spring.io/spring-framework/docs/current/javadoc-api/')`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2015-2019 the original author or authors.`
	`2`	`+ * Copyright 2015-2020 the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -44,6 +44,7 @@ protected AbstractBeanDefinition parseInternal(Element element, ParserContext pa`
`44`	`44`
`45`	`45`	`IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, IntegrationNamespaceUtils.AUTO_STARTUP);`
`46`	`46`	`IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, IntegrationNamespaceUtils.PHASE);`
	`47`	`+ IntegrationNamespaceUtils.setReferenceIfAttributeDefined(builder, element, "candidate");`
`47`	`48`
`48`	`49`	`return builder.getBeanDefinition();`
`49`	`50`	`}`