IGNITE-429
Project: http://git-wip-us.apache.org/repos/asf/ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/3a0cb51f Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/3a0cb51f Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/3a0cb51f Branch: refs/heads/ignite-2236 Commit: 3a0cb51f8303af5a841c2d5353f9d0ddc0e626df Parents: fa427dc Author: shtykh_roman <rsht...@yahoo.com> Authored: Fri Jan 15 14:24:22 2016 +0300 Committer: Anton Vinogradov <a...@apache.org> Committed: Fri Jan 15 14:24:22 2016 +0300 ---------------------------------------------------------------------- modules/storm/README.txt | 37 +++ modules/storm/licenses/apache-2.0.txt | 202 ++++++++++++ modules/storm/pom.xml | 104 +++++++ .../ignite/stream/storm/StormStreamer.java | 304 +++++++++++++++++++ .../ignite/stream/storm/package-info.java | 22 ++ .../storm/IgniteStormStreamerSelfTestSuite.java | 38 +++ .../storm/StormIgniteStreamerSelfTest.java | 184 +++++++++++ .../ignite/stream/storm/TestStormSpout.java | 141 +++++++++ .../storm/src/test/resources/example-ignite.xml | 71 +++++ pom.xml | 1 + 10 files changed, 1104 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/3a0cb51f/modules/storm/README.txt ---------------------------------------------------------------------- diff --git a/modules/storm/README.txt b/modules/storm/README.txt new file mode 100644 index 0000000..eb20f25 --- /dev/null +++ b/modules/storm/README.txt @@ -0,0 +1,37 @@ +Apache Ignite Storm Streamer Module +----------------------------------- + +Apache Ignite Storm Streamer module provides streaming via Storm to Ignite cache. + +Starting data transfer to Ignite cache can be done with the following steps. + +1. Import Ignite Kafka Streamer Module In Maven Project + +If you are using Maven to manage dependencies of your project, you can add Storm 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-storm</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 streamer. + +3. Make sure your key-value data input to the streamer is specified with the field named "ignite" +(or a different one you configure with StormStreamer.setIgniteTupleField(...)). +See TestStormSpout.declareOutputFields(...) for an example. + +4. Create a topology with the streamer and start. http://git-wip-us.apache.org/repos/asf/ignite/blob/3a0cb51f/modules/storm/licenses/apache-2.0.txt ---------------------------------------------------------------------- diff --git a/modules/storm/licenses/apache-2.0.txt b/modules/storm/licenses/apache-2.0.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/modules/storm/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/3a0cb51f/modules/storm/pom.xml ---------------------------------------------------------------------- diff --git a/modules/storm/pom.xml b/modules/storm/pom.xml new file mode 100644 index 0000000..0cd1fcb --- /dev/null +++ b/modules/storm/pom.xml @@ -0,0 +1,104 @@ +<?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-storm</artifactId> + <version>1.5.1.final-SNAPSHOT</version> + <url>http://ignite.apache.org</url> + + <properties> + <storm.version>0.10.0</storm.version> + </properties> + + <dependencies> + <dependency> + <groupId>org.apache.ignite</groupId> + <artifactId>ignite-core</artifactId> + <version>${project.version}</version> + </dependency> + + <dependency> + <groupId>org.apache.storm</groupId> + <artifactId>storm-core</artifactId> + <version>${storm.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> + </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/3a0cb51f/modules/storm/src/main/java/org/apache/ignite/stream/storm/StormStreamer.java ---------------------------------------------------------------------- diff --git a/modules/storm/src/main/java/org/apache/ignite/stream/storm/StormStreamer.java b/modules/storm/src/main/java/org/apache/ignite/stream/storm/StormStreamer.java new file mode 100644 index 0000000..bdaec0b --- /dev/null +++ b/modules/storm/src/main/java/org/apache/ignite/stream/storm/StormStreamer.java @@ -0,0 +1,304 @@ +/* + * 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.stream.storm; + +import backtype.storm.task.OutputCollector; +import backtype.storm.task.TopologyContext; +import backtype.storm.topology.IRichBolt; +import backtype.storm.topology.OutputFieldsDeclarer; +import backtype.storm.tuple.Tuple; +import java.util.Map; +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; +import org.apache.ignite.stream.StreamAdapter; + +/** + * Apache Storm streamer implemented as a Storm bolt. + * Obtaining data from other bolts and spouts is done by the specified tuple field. + */ +public class StormStreamer<K, V> extends StreamAdapter<Tuple, K, V> implements IRichBolt { + /** Default flush frequency. */ + private static final long DFLT_FLUSH_FREQ = 10000L; + + /** Default Ignite tuple field. */ + private static final String DFLT_TUPLE_FIELD = "ignite"; + + /** Logger. */ + private IgniteLogger log; + + /** Field by which tuple data is obtained in topology. */ + private String igniteTupleField = DFLT_TUPLE_FIELD; + + /** 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; + + /** Storm output collector. */ + private OutputCollector collector; + + /** Ignite grid configuration file. */ + private static String igniteConfigFile; + + /** Cache name. */ + private static String cacheName; + + /** + * Gets Ignite tuple field, by which tuple data is obtained in topology. + * + * @return Tuple field. + */ + public String getIgniteTupleField() { + return igniteTupleField; + } + + /** + * Names Ignite tuple field, by which tuple data is obtained in topology. + * + * @param igniteTupleField Name of tuple field. + */ + public void setIgniteTupleField(String igniteTupleField) { + this.igniteTupleField = igniteTupleField; + } + + /** + * Gets the cache name. + * + * @return Cache name. + */ + public String getCacheName() { + return cacheName; + } + + /** + * Sets the cache name. + * + * @param cacheName Cache name. + */ + public void setCacheName(String cacheName) { + StormStreamer.cacheName = cacheName; + } + + /** + * Gets Ignite configuration file. + * + * @return Configuration file. + */ + public String getIgniteConfigFile() { + return igniteConfigFile; + } + + /** + * Specifies Ignite configuration file. + * + * @param igniteConfigFile Ignite config file. + */ + public void setIgniteConfigFile(String igniteConfigFile) { + StormStreamer.igniteConfigFile = igniteConfigFile; + } + + /** + * 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; + } + + /** + * Starts streamer. + * + * @throws IgniteException If failed. + */ + @SuppressWarnings("unchecked") + public void start() throws IgniteException { + A.notNull(igniteConfigFile, "Ignite config file"); + A.notNull(cacheName, "Cache name"); + A.notNull(igniteTupleField, "Ignite tuple field"); + + setIgnite(StreamerContext.getIgnite()); + + final IgniteDataStreamer<K, V> dataStreamer = StreamerContext.getStreamer(); + dataStreamer.autoFlushFrequency(autoFlushFrequency); + dataStreamer.allowOverwrite(allowOverwrite); + + setStreamer(dataStreamer); + + log = getIgnite().log(); + + stopped = false; + } + + /** + * Stops streamer. + * + * @throws IgniteException If failed. + */ + public void stop() throws IgniteException { + if (stopped) + return; + + stopped = true; + + getIgnite().<K, V>dataStreamer(cacheName).close(true); + + getIgnite().close(); + } + + /** + * Initializes Ignite client instance from a configuration file and declares the output collector of the bolt. + * + * @param map Map derived from topology. + * @param topologyContext Context topology in storm. + * @param collector Output collector. + */ + @Override + public void prepare(Map map, TopologyContext topologyContext, OutputCollector collector) { + start(); + + this.collector = collector; + } + + /** + * Transfers data into grid. + * + * @param tuple Storm tuple. + */ + @SuppressWarnings("unchecked") + @Override + public void execute(Tuple tuple) { + if (stopped) + return; + + if (!(tuple.getValueByField(igniteTupleField) instanceof Map)) + throw new IgniteException("Map as a streamer input is expected!"); + + final Map<K, V> gridVals = (Map<K, V>)tuple.getValueByField(igniteTupleField); + + try { + if (log.isDebugEnabled()) + log.debug("Tuple (id:" + tuple.getMessageId() + ") from storm: " + gridVals); + + getStreamer().addData(gridVals); + + collector.ack(tuple); + } + catch (Exception e) { + log.error("Error while processing tuple of " + gridVals, e); + collector.fail(tuple); + } + } + + /** + * Cleans up the streamer when the bolt is going to shutdown. + */ + @Override + public void cleanup() { + stop(); + } + + /** + * Normally declares output fields for the stream of the topology. + * Empty because we have no tuples for any further processing. + * + * @param declarer OutputFieldsDeclarer. + */ + @Override + public void declareOutputFields(OutputFieldsDeclarer declarer) { + // No-op. + } + + /** + * Not used. + * + * @return Configurations. + */ + @Override + public Map<String, Object> getComponentConfiguration() { + return null; + } + + /** + * Streamer context initializing grid and data streamer instances on demand. + */ + public static class StreamerContext { + /** Constructor. */ + private StreamerContext() { + } + + /** Instance holder. */ + private static class Holder { + private static final Ignite IGNITE = Ignition.start(igniteConfigFile); + private static final IgniteDataStreamer STREAMER = IGNITE.dataStreamer(cacheName); + } + + /** + * Obtains grid instance. + * + * @return Grid instance. + */ + public static Ignite getIgnite() { + return Holder.IGNITE; + } + + /** + * Obtains data streamer instance. + * + * @return Data streamer instance. + */ + public static IgniteDataStreamer getStreamer() { + return Holder.STREAMER; + } + } +} http://git-wip-us.apache.org/repos/asf/ignite/blob/3a0cb51f/modules/storm/src/main/java/org/apache/ignite/stream/storm/package-info.java ---------------------------------------------------------------------- diff --git a/modules/storm/src/main/java/org/apache/ignite/stream/storm/package-info.java b/modules/storm/src/main/java/org/apache/ignite/stream/storm/package-info.java new file mode 100644 index 0000000..67b2d17 --- /dev/null +++ b/modules/storm/src/main/java/org/apache/ignite/stream/storm/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. --> + * StormStreamer -- integration with Apache Storm. + */ +package org.apache.ignite.stream.storm; http://git-wip-us.apache.org/repos/asf/ignite/blob/3a0cb51f/modules/storm/src/test/java/org/apache/ignite/stream/storm/IgniteStormStreamerSelfTestSuite.java ---------------------------------------------------------------------- diff --git a/modules/storm/src/test/java/org/apache/ignite/stream/storm/IgniteStormStreamerSelfTestSuite.java b/modules/storm/src/test/java/org/apache/ignite/stream/storm/IgniteStormStreamerSelfTestSuite.java new file mode 100644 index 0000000..25546e5 --- /dev/null +++ b/modules/storm/src/test/java/org/apache/ignite/stream/storm/IgniteStormStreamerSelfTestSuite.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.stream.storm; + +import junit.framework.TestSuite; + +/** + * Apache Storm streamer tests. + */ +public class IgniteStormStreamerSelfTestSuite extends TestSuite { + + /** + * @return Test suite. + * @throws Exception Thrown in case of the failure. + */ + public static TestSuite suite() throws Exception { + TestSuite suite = new TestSuite("Apache Storm streamer Test Suite"); + + suite.addTest(new TestSuite(StormIgniteStreamerSelfTest.class)); + + return suite; + } +} http://git-wip-us.apache.org/repos/asf/ignite/blob/3a0cb51f/modules/storm/src/test/java/org/apache/ignite/stream/storm/StormIgniteStreamerSelfTest.java ---------------------------------------------------------------------- diff --git a/modules/storm/src/test/java/org/apache/ignite/stream/storm/StormIgniteStreamerSelfTest.java b/modules/storm/src/test/java/org/apache/ignite/stream/storm/StormIgniteStreamerSelfTest.java new file mode 100644 index 0000000..0ce4c6e --- /dev/null +++ b/modules/storm/src/test/java/org/apache/ignite/stream/storm/StormIgniteStreamerSelfTest.java @@ -0,0 +1,184 @@ +/* + * 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.stream.storm; + +import backtype.storm.Config; +import backtype.storm.ILocalCluster; +import backtype.storm.Testing; +import backtype.storm.generated.StormTopology; +import backtype.storm.testing.CompleteTopologyParam; +import backtype.storm.testing.MkClusterParam; +import backtype.storm.testing.MockedSources; +import backtype.storm.testing.TestJob; +import backtype.storm.topology.TopologyBuilder; +import backtype.storm.tuple.Values; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Map; +import java.util.UUID; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import org.apache.ignite.Ignite; +import org.apache.ignite.IgniteCache; +import org.apache.ignite.cache.CachePeekMode; +import org.apache.ignite.configuration.IgniteConfiguration; +import org.apache.ignite.events.CacheEvent; +import org.apache.ignite.lang.IgniteBiPredicate; +import org.apache.ignite.testframework.junits.common.GridCommonAbstractTest; +import org.jetbrains.annotations.NotNull; + +import static org.apache.ignite.events.EventType.EVT_CACHE_OBJECT_PUT; + +/** + * Tests for {@link StormStreamer}. + */ +public class StormIgniteStreamerSelfTest extends GridCommonAbstractTest { + /** Cache name. */ + private static final String TEST_CACHE = "testCache"; + + /** Ignite test configuration file. */ + private static final String GRID_CONF_FILE = "modules/storm/src/test/resources/example-ignite.xml"; + + /** Ignite instance. */ + private Ignite ignite; + + /** Parallelization in Storm. */ + private static final int STORM_EXECUTORS = 2; + + /** {@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 streamer bolt. Ignite started in bolt based on what is specified in the configuration file. + * + * @throws TimeoutException + * @throws InterruptedException + */ + public void testStormStreamerIgniteBolt() throws TimeoutException, InterruptedException { + final StormStreamer<String, String> stormStreamer = new StormStreamer<>(); + + stormStreamer.setAutoFlushFrequency(10L); + stormStreamer.setAllowOverwrite(true); + stormStreamer.setCacheName(TEST_CACHE); + stormStreamer.setIgniteTupleField(TestStormSpout.IGNITE_TUPLE_FIELD); + stormStreamer.setIgniteConfigFile(GRID_CONF_FILE); + + Config daemonConf = new Config(); + + daemonConf.put(Config.STORM_LOCAL_MODE_ZMQ, false); + + MkClusterParam mkClusterParam = new MkClusterParam(); + + mkClusterParam.setDaemonConf(daemonConf); + mkClusterParam.setSupervisors(4); + + final CountDownLatch latch = new CountDownLatch(TestStormSpout.CNT); + + IgniteBiPredicate<UUID, CacheEvent> putLsnr = new IgniteBiPredicate<UUID, CacheEvent>() { + @Override public boolean apply(UUID uuid, CacheEvent evt) { + assert evt != null; + + latch.countDown(); + + return true; + } + }; + + final UUID putLsnrId = ignite.events(ignite.cluster().forCacheNodes(TEST_CACHE)) + .remoteListen(putLsnr, null, EVT_CACHE_OBJECT_PUT); + + Testing.withSimulatedTimeLocalCluster(mkClusterParam, new TestJob() { + @Override public void run(ILocalCluster cluster) throws IOException, InterruptedException { + // Creates a test topology. + TopologyBuilder builder = new TopologyBuilder(); + + TestStormSpout testStormSpout = new TestStormSpout(); + + builder.setSpout("test-spout", testStormSpout); + builder.setBolt("ignite-bolt", stormStreamer, STORM_EXECUTORS).shuffleGrouping("test-spout"); + + StormTopology topology = builder.createTopology(); + + // Prepares a mock data for the spout. + MockedSources mockedSources = new MockedSources(); + + mockedSources.addMockData("test-spout", getMockData()); + + // Prepares the config. + Config conf = new Config(); + + conf.setMessageTimeoutSecs(10); + + IgniteCache<Integer, String> cache = ignite.cache(TEST_CACHE); + + CompleteTopologyParam completeTopologyParam = new CompleteTopologyParam(); + + completeTopologyParam.setTimeoutMs(10000); + completeTopologyParam.setMockedSources(mockedSources); + completeTopologyParam.setStormConf(conf); + + // Checks the cache doesn't contain any entries yet. + assertEquals(0, cache.size(CachePeekMode.PRIMARY)); + + Testing.completeTopology(cluster, topology, completeTopologyParam); + + // Checks events successfully processed in 20 seconds. + assertTrue(latch.await(10, TimeUnit.SECONDS)); + + ignite.events(ignite.cluster().forCacheNodes(TEST_CACHE)).stopRemoteListen(putLsnrId); + + // Validates all entries are in the cache. + assertEquals(TestStormSpout.CNT, cache.size(CachePeekMode.PRIMARY)); + + for (Map.Entry<Integer, String> entry : TestStormSpout.getKeyValMap().entrySet()) + assertEquals(entry.getValue(), cache.get(entry.getKey())); + } + } + ); + } + + /** + * Prepares entry values for test input. + * + * @return Array of entry values. + */ + @NotNull + private static Values[] getMockData() { + final int SIZE = 10; + + ArrayList<Values> mockData = new ArrayList<>(); + + for (int i = 0; i < TestStormSpout.CNT; i += SIZE) + mockData.add(new Values(TestStormSpout.getKeyValMap().subMap(i, i + SIZE))); + + return mockData.toArray(new Values[mockData.size()]); + } +} http://git-wip-us.apache.org/repos/asf/ignite/blob/3a0cb51f/modules/storm/src/test/java/org/apache/ignite/stream/storm/TestStormSpout.java ---------------------------------------------------------------------- diff --git a/modules/storm/src/test/java/org/apache/ignite/stream/storm/TestStormSpout.java b/modules/storm/src/test/java/org/apache/ignite/stream/storm/TestStormSpout.java new file mode 100644 index 0000000..a006ca7 --- /dev/null +++ b/modules/storm/src/test/java/org/apache/ignite/stream/storm/TestStormSpout.java @@ -0,0 +1,141 @@ +/* + * 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.stream.storm; + +import backtype.storm.spout.SpoutOutputCollector; +import backtype.storm.task.TopologyContext; +import backtype.storm.topology.IRichSpout; +import backtype.storm.topology.OutputFieldsDeclarer; +import backtype.storm.tuple.Fields; +import java.util.Map; +import java.util.TreeMap; + +/** + * Testing Storm spout. + */ +public class TestStormSpout implements IRichSpout { + + /** Field by which tuple data is obtained by the streamer. */ + public static final String IGNITE_TUPLE_FIELD = "test-field"; + + /** Number of outgoing tuples. */ + public static final int CNT = 500; + + /** Spout message prefix. */ + private static final String VAL_PREFIX = "v:"; + + /** Spout output collector. */ + private SpoutOutputCollector collector; + + /** Map of messages to be sent. */ + private static TreeMap<Integer, String> keyValMap; + + static { + keyValMap = generateKeyValMap(); + } + + /** + * Declares the output field for the component. + * + * @param outputFieldsDeclarer Declarer to declare fields on. + */ + @Override + public void declareOutputFields(OutputFieldsDeclarer outputFieldsDeclarer) { + outputFieldsDeclarer.declare(new Fields(IGNITE_TUPLE_FIELD)); + } + + /** + * {@inheritDoc} + */ + @Override + public void open(Map map, TopologyContext topologyContext, SpoutOutputCollector spoutOutputCollector) { + this.collector = spoutOutputCollector; + } + + /** + * Requests to emit a tuple to the output collector. + */ + @Override + public void nextTuple() { + // No-op. Sent via mocked sources. + } + + /** + * Generates key,value pair to emit to bolt({@link StormStreamer}). + * + * @return Key, value pair. + */ + private static TreeMap<Integer, String> generateKeyValMap() { + TreeMap<Integer, String> keyValMap = new TreeMap<>(); + + for (int evt = 0; evt < CNT; evt++) { + String msg = VAL_PREFIX + evt; + + keyValMap.put(evt, msg); + } + + return keyValMap; + } + + public static TreeMap<Integer, String> getKeyValMap() { + return keyValMap; + } + + /** + * {@inheritDoc} + */ + @Override + public void ack(Object msgId) { + } + + /** + * {@inheritDoc} + */ + @Override + public void fail(Object msgId) { + } + + /** + * {@inheritDoc} + */ + @Override + public void close() { + } + + /** + * {@inheritDoc} + */ + @Override + public void activate() { + } + + /** + * {@inheritDoc} + */ + @Override + public void deactivate() { + } + + /** + * {@inheritDoc} + */ + @Override + public Map<String, Object> getComponentConfiguration() { + return null; + } +} http://git-wip-us.apache.org/repos/asf/ignite/blob/3a0cb51f/modules/storm/src/test/resources/example-ignite.xml ---------------------------------------------------------------------- diff --git a/modules/storm/src/test/resources/example-ignite.xml b/modules/storm/src/test/resources/example-ignite.xml new file mode 100644 index 0000000..fbb05d3 --- /dev/null +++ b/modules/storm/src/test/resources/example-ignite.xml @@ -0,0 +1,71 @@ +<?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 p2p deployment 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/3a0cb51f/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 5c6e87c..0a74c47 100644 --- a/pom.xml +++ b/pom.xml @@ -80,6 +80,7 @@ <module>modules/mqtt</module> <module>modules/zookeeper</module> <module>modules/camel</module> + <module>modules/storm</module> <module>modules/osgi-paxlogging</module> <module>modules/osgi-karaf</module> <module>modules/osgi</module>