IGNITE-813: Apache Flink Integration (sink connector) - Fixes #550. Signed-off-by: shtykh_roman <[email protected]>
Project: http://git-wip-us.apache.org/repos/asf/ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/b09ecd72 Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/b09ecd72 Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/b09ecd72 Branch: refs/heads/ignite-2630 Commit: b09ecd72f62c9e98dd40958cfee0bcd128b777e9 Parents: 04eb6c9 Author: samaitra <[email protected]> Authored: Fri Apr 1 10:26:35 2016 +0900 Committer: shtykh_roman <[email protected]> Committed: Fri Apr 1 10:26:35 2016 +0900 ---------------------------------------------------------------------- modules/flink/README.txt | 33 +++ modules/flink/licenses/apache-2.0.txt | 202 ++++++++++++++++++ modules/flink/pom.xml | 167 +++++++++++++++ .../apache/ignite/sink/flink/IgniteSink.java | 204 +++++++++++++++++++ .../apache/ignite/sink/flink/package-info.java | 22 ++ .../sink/flink/FlinkIgniteSinkSelfTest.java | 188 +++++++++++++++++ .../flink/FlinkIgniteSinkSelfTestSuite.java | 38 ++++ .../flink/src/test/resources/example-ignite.xml | 70 +++++++ pom.xml | 1 + 9 files changed, 925 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/b09ecd72/modules/flink/README.txt ---------------------------------------------------------------------- diff --git a/modules/flink/README.txt b/modules/flink/README.txt new file mode 100644 index 0000000..a198b1b --- /dev/null +++ b/modules/flink/README.txt @@ -0,0 +1,33 @@ +Apache Ignite Flink Sink Module +----------------------------------- + +Apache Ignite Flink Sink module is a streaming connector to inject Flink data into Ignite cache. + +Starting data transfer to Ignite can be done with the following steps. + +1. Import Ignite Flink Sink Module in Maven Project + +If you are using Maven to manage dependencies of your project, you can add Flink module +dependency like this (replace '${ignite.version}' with actual Ignite version you are +interested in): + +<project xmlns="http://maven.apache.org/POM/4.0.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 + http://maven.apache.org/xsd/maven-4.0.0.xsd";> + ... + <dependencies> + ... + <dependency> + <groupId>org.apache.ignite</groupId> + <artifactId>ignite-flink</artifactId> + <version>${ignite.version}</version> + </dependency> + ... + </dependencies> + ... +</project> + +2. Create an Ignite configuration file (see example-ignite.xml) and make sure it is accessible from the sink. + +3. Make sure your data input to the sink is specified. For example `input.addSink(igniteSinkObject)` http://git-wip-us.apache.org/repos/asf/ignite/blob/b09ecd72/modules/flink/licenses/apache-2.0.txt ---------------------------------------------------------------------- diff --git a/modules/flink/licenses/apache-2.0.txt b/modules/flink/licenses/apache-2.0.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/modules/flink/licenses/apache-2.0.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. http://git-wip-us.apache.org/repos/asf/ignite/blob/b09ecd72/modules/flink/pom.xml ---------------------------------------------------------------------- diff --git a/modules/flink/pom.xml b/modules/flink/pom.xml new file mode 100644 index 0000000..5d9ac24 --- /dev/null +++ b/modules/flink/pom.xml @@ -0,0 +1,167 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<!-- + POM file. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.ignite</groupId> + <artifactId>ignite-parent</artifactId> + <version>1</version> + <relativePath>../../parent</relativePath> + </parent> + + <artifactId>ignite-flink</artifactId> + <version>1.6.0-SNAPSHOT</version> + <url>http://ignite.apache.org</url> + + <properties> + <flink.version>1.0.0</flink.version> + </properties> + + <dependencies> + <dependency> + <groupId>org.apache.ignite</groupId> + <artifactId>ignite-core</artifactId> + <version>${project.version}</version> + </dependency> + + <dependency> + <groupId>org.apache.flink</groupId> + <artifactId>flink-java</artifactId> + <version>${flink.version}</version> + <exclusions> + <exclusion> + <groupId>log4j</groupId> + <artifactId>log4j</artifactId> + </exclusion> + <exclusion> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-log4j12</artifactId> + </exclusion> + <exclusion> + <groupId>commons-logging</groupId> + <artifactId>commons-logging</artifactId> + </exclusion> + <exclusion> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-simple</artifactId> + </exclusion> + <exclusion> + <groupId>org.slf4j</groupId> + <artifactId>log4j-over-slf4j</artifactId> + </exclusion> + <exclusion> + <groupId>org.apache.zookeeper</groupId> + <artifactId>zookeeper</artifactId> + </exclusion> + </exclusions> + </dependency> + + <dependency> + <groupId>org.apache.flink</groupId> + <artifactId>flink-streaming-java_2.10</artifactId> + <version>${flink.version}</version> + <exclusions> + <exclusion> + <groupId>log4j</groupId> + <artifactId>log4j</artifactId> + </exclusion> + <exclusion> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-log4j12</artifactId> + </exclusion> + <exclusion> + <groupId>commons-logging</groupId> + <artifactId>commons-logging</artifactId> + </exclusion> + <exclusion> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-simple</artifactId> + </exclusion> + <exclusion> + <groupId>org.slf4j</groupId> + <artifactId>log4j-over-slf4j</artifactId> + </exclusion> + <exclusion> + <groupId>org.apache.zookeeper</groupId> + <artifactId>zookeeper</artifactId> + </exclusion> + </exclusions> + </dependency> + + <dependency> + <groupId>org.apache.flink</groupId> + <artifactId>flink-clients_2.10</artifactId> + <version>${flink.version}</version> + <exclusions> + <exclusion> + <groupId>log4j</groupId> + <artifactId>log4j</artifactId> + </exclusion> + <exclusion> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-log4j12</artifactId> + </exclusion> + <exclusion> + <groupId>commons-logging</groupId> + <artifactId>commons-logging</artifactId> + </exclusion> + <exclusion> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-simple</artifactId> + </exclusion> + <exclusion> + <groupId>org.slf4j</groupId> + <artifactId>log4j-over-slf4j</artifactId> + </exclusion> + <exclusion> + <groupId>org.apache.zookeeper</groupId> + <artifactId>zookeeper</artifactId> + </exclusion> + </exclusions> + </dependency> + + <dependency> + <groupId>org.apache.ignite</groupId> + <artifactId>ignite-core</artifactId> + <version>${project.version}</version> + <type>test-jar</type> + <scope>test</scope> + </dependency> + + <dependency> + <groupId>org.apache.ignite</groupId> + <artifactId>ignite-log4j</artifactId> + <version>${project.version}</version> + <scope>test</scope> + </dependency> + + <dependency> + <groupId>org.apache.ignite</groupId> + <artifactId>ignite-spring</artifactId> + <version>${project.version}</version> + <scope>test</scope> + </dependency> + </dependencies> + +</project> http://git-wip-us.apache.org/repos/asf/ignite/blob/b09ecd72/modules/flink/src/main/java/org/apache/ignite/sink/flink/IgniteSink.java ---------------------------------------------------------------------- diff --git a/modules/flink/src/main/java/org/apache/ignite/sink/flink/IgniteSink.java b/modules/flink/src/main/java/org/apache/ignite/sink/flink/IgniteSink.java new file mode 100644 index 0000000..e0ae783 --- /dev/null +++ b/modules/flink/src/main/java/org/apache/ignite/sink/flink/IgniteSink.java @@ -0,0 +1,204 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.ignite.sink.flink; + +import java.util.Map; +import org.apache.flink.streaming.api.functions.sink.RichSinkFunction; +import org.apache.ignite.Ignite; +import org.apache.ignite.IgniteDataStreamer; +import org.apache.ignite.IgniteException; +import org.apache.ignite.IgniteLogger; +import org.apache.ignite.Ignition; +import org.apache.ignite.internal.util.typedef.internal.A; + +/** + * Apache Flink Ignite sink implemented as a RichSinkFunction. + */ +public class IgniteSink<IN> extends RichSinkFunction<IN> { + /** Default flush frequency. */ + private static final long DFLT_FLUSH_FREQ = 10000L; + + /** Logger. */ + private final IgniteLogger log; + + /** Automatic flush frequency. */ + private long autoFlushFrequency = DFLT_FLUSH_FREQ; + + /** Enables overwriting existing values in cache. */ + private boolean allowOverwrite = false; + + /** Flag for stopped state. */ + private static volatile boolean stopped = true; + + /** Ignite grid configuration file. */ + private static String igniteCfgFile; + + /** Cache name. */ + private static String cacheName; + + /** + * Gets the cache name. + * + * @return Cache name. + */ + public String getCacheName() { + return cacheName; + } + + /** + * Gets Ignite configuration file. + * + * @return Configuration file. + */ + public String getIgniteConfigFile() { + return igniteCfgFile; + } + + /** + * Obtains data flush frequency. + * + * @return Flush frequency. + */ + public long getAutoFlushFrequency() { + return autoFlushFrequency; + } + + /** + * Specifies data flush frequency into the grid. + * + * @param autoFlushFrequency Flush frequency. + */ + public void setAutoFlushFrequency(long autoFlushFrequency) { + this.autoFlushFrequency = autoFlushFrequency; + } + + /** + * Obtains flag for enabling overwriting existing values in cache. + * + * @return True if overwriting is allowed, false otherwise. + */ + public boolean getAllowOverwrite() { + return allowOverwrite; + } + + /** + * Enables overwriting existing values in cache. + * + * @param allowOverwrite Flag value. + */ + public void setAllowOverwrite(boolean allowOverwrite) { + this.allowOverwrite = allowOverwrite; + } + + /** + * Default IgniteSink constructor. + * + * @param cacheName Cache name. + * @param igniteCfgFile Ignite configuration file. + */ + public IgniteSink(String cacheName, String igniteCfgFile) { + this.cacheName = cacheName; + this.igniteCfgFile = igniteCfgFile; + this.log = SinkContext.getIgnite().log(); + } + + /** + * Starts streamer. + * + * @throws IgniteException If failed. + */ + @SuppressWarnings("unchecked") + public void start() throws IgniteException { + A.notNull(igniteCfgFile, "Ignite config file"); + A.notNull(cacheName, "Cache name"); + + SinkContext.getStreamer().autoFlushFrequency(autoFlushFrequency); + SinkContext.getStreamer().allowOverwrite(allowOverwrite); + + stopped = false; + } + + /** + * Stops streamer. + * + * @throws IgniteException If failed. + */ + public void stop() throws IgniteException { + if (stopped) + return; + + stopped = true; + + SinkContext.getStreamer().close(); + SinkContext.getIgnite().cache(cacheName).close(); + SinkContext.getIgnite().close(); + } + + /** + * Transfers data into grid. It is called when new data + * arrives to the sink, and forwards it to {@link IgniteDataStreamer}. + * + * @param in IN. + */ + @SuppressWarnings("unchecked") + @Override + public void invoke(IN in) { + try { + if (!(in instanceof Map)) + throw new IgniteException("Map as a streamer input is expected!"); + + SinkContext.getStreamer().addData((Map)in); + } + catch (Exception e) { + log.error("Error while processing IN of " + cacheName, e); + } + } + + /** + * Streamer context initializing grid and data streamer instances on demand. + */ + private static class SinkContext { + /** Constructor. */ + private SinkContext() { + } + + /** Instance holder. */ + private static class Holder { + private static final Ignite IGNITE = Ignition.start(igniteCfgFile); + private static final IgniteDataStreamer STREAMER = IGNITE.dataStreamer(cacheName); + } + + /** + * Obtains grid instance. + * + * @return Grid instance. + */ + private static Ignite getIgnite() { + return Holder.IGNITE; + } + + /** + * Obtains data streamer instance. + * + * @return Data streamer instance. + */ + private static IgniteDataStreamer getStreamer() { + return Holder.STREAMER; + } + } +} http://git-wip-us.apache.org/repos/asf/ignite/blob/b09ecd72/modules/flink/src/main/java/org/apache/ignite/sink/flink/package-info.java ---------------------------------------------------------------------- diff --git a/modules/flink/src/main/java/org/apache/ignite/sink/flink/package-info.java b/modules/flink/src/main/java/org/apache/ignite/sink/flink/package-info.java new file mode 100644 index 0000000..7b1437c --- /dev/null +++ b/modules/flink/src/main/java/org/apache/ignite/sink/flink/package-info.java @@ -0,0 +1,22 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * <!-- Package description. --> + * IgniteSink -- streaming connector integration with Apache Flink. + */ +package org.apache.ignite.sink.flink; http://git-wip-us.apache.org/repos/asf/ignite/blob/b09ecd72/modules/flink/src/test/java/org/apache/ignite/sink/flink/FlinkIgniteSinkSelfTest.java ---------------------------------------------------------------------- diff --git a/modules/flink/src/test/java/org/apache/ignite/sink/flink/FlinkIgniteSinkSelfTest.java b/modules/flink/src/test/java/org/apache/ignite/sink/flink/FlinkIgniteSinkSelfTest.java new file mode 100644 index 0000000..596dea7 --- /dev/null +++ b/modules/flink/src/test/java/org/apache/ignite/sink/flink/FlinkIgniteSinkSelfTest.java @@ -0,0 +1,188 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.ignite.sink.flink; + +import java.util.HashMap; +import java.util.Map; +import java.util.concurrent.CountDownLatch; +import org.apache.flink.streaming.api.datastream.DataStream; +import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment; +import org.apache.flink.streaming.api.functions.source.SourceFunction; +import org.apache.ignite.Ignite; +import org.apache.ignite.configuration.IgniteConfiguration; +import org.apache.ignite.events.CacheEvent; +import org.apache.ignite.events.EventType; +import org.apache.ignite.lang.IgnitePredicate; +import org.apache.ignite.testframework.junits.common.GridCommonAbstractTest; + +import static org.apache.ignite.events.EventType.EVT_CACHE_OBJECT_PUT; + +/** + * Tests for {@link IgniteSink}. + */ +public class FlinkIgniteSinkSelfTest extends GridCommonAbstractTest { + /** Cache name. */ + private static final String TEST_CACHE = "testCache"; + + /** Cache entries count. */ + private static final int CACHE_ENTRY_COUNT = 10000; + + /** Streaming events for testing. */ + private static final long DFLT_STREAMING_EVENT = 10000; + + /** Ignite instance. */ + private Ignite ignite; + + /** Ignite test configuration file. */ + private static final String GRID_CONF_FILE = "modules/flink/src/test/resources/example-ignite.xml"; + + /** {@inheritDoc} */ + @Override protected long getTestTimeout() { + return 10_000; + } + + /** {@inheritDoc} */ + @SuppressWarnings("unchecked") + @Override protected void beforeTest() throws Exception { + IgniteConfiguration cfg = loadConfiguration(GRID_CONF_FILE); + + cfg.setClientMode(false); + + ignite = startGrid("igniteServerNode", cfg); + } + + /** {@inheritDoc} */ + @Override protected void afterTest() throws Exception { + stopAllGrids(); + } + + /** + * Tests for the Flink sink. + * Ignite started in sink based on what is specified in the configuration file. + * + * @throws Exception + */ + @SuppressWarnings("unchecked") + public void testFlinkIgniteSink() throws Exception { + StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment(); + + env.getConfig().disableSysoutLogging(); + + IgniteSink igniteSink = new IgniteSink(TEST_CACHE, GRID_CONF_FILE); + + igniteSink.setAllowOverwrite(true); + + igniteSink.setAutoFlushFrequency(10); + + igniteSink.start(); + + CacheListener listener = subscribeToPutEvents(); + + DataStream<Map> stream = env.addSource(new SourceFunction<Map>() { + + private boolean running = true; + + @Override + public void run(SourceContext<Map> ctx) throws Exception { + Map testDataMap = new HashMap<>(); + long cnt = 0; + + while (running && (cnt < DFLT_STREAMING_EVENT)) { + testDataMap.put(cnt, "ignite-" + cnt); + cnt++; + } + + ctx.collect(testDataMap); + } + + @Override + public void cancel() { + running = false; + } + }).setParallelism(1); + + assertEquals(0, ignite.cache(TEST_CACHE).size()); + + // sink data into the grid. + stream.addSink(igniteSink); + + try { + env.execute(); + + CountDownLatch latch = listener.getLatch(); + + // Enough events was handled in 10 seconds. Limited by test's timeout. + latch.await(); + + unsubscribeToPutEvents(listener); + + assertEquals(DFLT_STREAMING_EVENT, ignite.getOrCreateCache(TEST_CACHE).size()); + + for (long i = 0; i < DFLT_STREAMING_EVENT; i++) + assertEquals("ignite-" + i, ignite.getOrCreateCache(TEST_CACHE).get(i)); + + } + finally { + igniteSink.stop(); + } + } + + /** + * Sets a listener for {@link EventType#EVT_CACHE_OBJECT_PUT}. + * + * @return Cache listener. + */ + private CacheListener subscribeToPutEvents() { + // Listen to cache PUT events and expect as many as messages as test data items. + CacheListener listener = new CacheListener(); + + ignite.events(ignite.cluster().forCacheNodes(null)).localListen(listener, EVT_CACHE_OBJECT_PUT); + + return listener; + } + + /** + * Removes the listener for {@link EventType#EVT_CACHE_OBJECT_PUT}. + * + * @param listener Cache listener. + */ + private void unsubscribeToPutEvents(CacheListener listener) { + ignite.events(ignite.cluster().forCacheNodes(null)).stopLocalListen(listener, EVT_CACHE_OBJECT_PUT); + } + + /** Listener. */ + private class CacheListener implements IgnitePredicate<CacheEvent> { + private final CountDownLatch latch = new CountDownLatch(CACHE_ENTRY_COUNT); + + /** @return Latch. */ + public CountDownLatch getLatch() { + return latch; + } + + /** + * @param evt Cache Event. + * @return {@code true}. + */ + @Override + public boolean apply(CacheEvent evt) { + latch.countDown(); + + return true; + } + } +} http://git-wip-us.apache.org/repos/asf/ignite/blob/b09ecd72/modules/flink/src/test/java/org/apache/ignite/sink/flink/FlinkIgniteSinkSelfTestSuite.java ---------------------------------------------------------------------- diff --git a/modules/flink/src/test/java/org/apache/ignite/sink/flink/FlinkIgniteSinkSelfTestSuite.java b/modules/flink/src/test/java/org/apache/ignite/sink/flink/FlinkIgniteSinkSelfTestSuite.java new file mode 100644 index 0000000..b6934e2 --- /dev/null +++ b/modules/flink/src/test/java/org/apache/ignite/sink/flink/FlinkIgniteSinkSelfTestSuite.java @@ -0,0 +1,38 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.ignite.sink.flink; + +import junit.framework.TestSuite; + +/** + * Apache Flink sink tests. + */ +public class FlinkIgniteSinkSelfTestSuite extends TestSuite { + + /** + * @return Test suite. + * @throws Exception Thrown in case of the failure. + */ + public static TestSuite suite() throws Exception { + TestSuite suite = new TestSuite("Apache Flink sink Test Suite"); + + suite.addTest(new TestSuite(FlinkIgniteSinkSelfTest.class)); + + return suite; + } +} http://git-wip-us.apache.org/repos/asf/ignite/blob/b09ecd72/modules/flink/src/test/resources/example-ignite.xml ---------------------------------------------------------------------- diff --git a/modules/flink/src/test/resources/example-ignite.xml b/modules/flink/src/test/resources/example-ignite.xml new file mode 100644 index 0000000..b8ddc8f --- /dev/null +++ b/modules/flink/src/test/resources/example-ignite.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<!-- + Ignite configuration with all defaults and enabled events. + Used for testing IgniteSink running Ignite in a client mode. +--> +<beans xmlns="http://www.springframework.org/schema/beans"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xmlns:util="http://www.springframework.org/schema/util"; + xsi:schemaLocation=" + http://www.springframework.org/schema/beans + http://www.springframework.org/schema/beans/spring-beans.xsd + http://www.springframework.org/schema/util + http://www.springframework.org/schema/util/spring-util.xsd";> + <bean id="ignite.cfg" class="org.apache.ignite.configuration.IgniteConfiguration"> + <!-- Enable client mode. --> + <property name="clientMode" value="true"/> + + <!-- Cache accessed from IgniteSink. --> + <property name="cacheConfiguration"> + <list> + <!-- Partitioned cache example configuration with configurations adjusted to server nodes'. --> + <bean class="org.apache.ignite.configuration.CacheConfiguration"> + <property name="atomicityMode" value="ATOMIC"/> + <property name="name" value="testCache"/> + </bean> + </list> + </property> + + <!-- Enable cache events. --> + <property name="includeEventTypes"> + <list> + <!-- Cache events (only EVT_CACHE_OBJECT_PUT for tests). --> + <util:constant static-field="org.apache.ignite.events.EventType.EVT_CACHE_OBJECT_PUT"/> + </list> + </property> + + <!-- Explicitly configure TCP discovery SPI to provide list of initial nodes. --> + <property name="discoverySpi"> + <bean class="org.apache.ignite.spi.discovery.tcp.TcpDiscoverySpi"> + <property name="ipFinder"> + <bean class="org.apache.ignite.spi.discovery.tcp.ipfinder.vm.TcpDiscoveryVmIpFinder"> + <property name="addresses"> + <list> + <value>127.0.0.1:47500</value> + </list> + </property> + </bean> + </property> + </bean> + </property> + </bean> +</beans> http://git-wip-us.apache.org/repos/asf/ignite/blob/b09ecd72/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index bde8a2c..3a4a268 100644 --- a/pom.xml +++ b/pom.xml @@ -85,6 +85,7 @@ <module>modules/osgi-karaf</module> <module>modules/osgi</module> <module>modules/web/ignite-weblogic-test</module> + <module>modules/flink</module> </modules> <profiles>
