From 6a3fad82a1b545038c2372da718714038b5aa664 Mon Sep 17 00:00:00 2001 From: DR695H Date: Mon, 3 Jun 2019 21:32:22 -0400 Subject: add in kafka lib for working with kafka directly Change-Id: Ibea385fbd3eb835c1b29a8bf9883122c97a4dd62 Issue-ID: TEST-158 Signed-off-by: DR695H --- robotframework-onap/ONAPLibrary/JSONKeywords.py | 2 +- robotframework-onap/ONAPLibrary/Kafka.py | 26 ++++++++ robotframework-onap/ONAPLibrary/KafkaKeywords.py | 76 ++++++++++++++++++++++++ robotframework-onap/setup.py | 3 +- 4 files changed, 105 insertions(+), 2 deletions(-) create mode 100644 robotframework-onap/ONAPLibrary/Kafka.py create mode 100644 robotframework-onap/ONAPLibrary/KafkaKeywords.py diff --git a/robotframework-onap/ONAPLibrary/JSONKeywords.py b/robotframework-onap/ONAPLibrary/JSONKeywords.py index bd1a59d..e007e6c 100644 --- a/robotframework-onap/ONAPLibrary/JSONKeywords.py +++ b/robotframework-onap/ONAPLibrary/JSONKeywords.py @@ -22,7 +22,7 @@ class JSONKeywords(object): """ def __init__(self): - pass + super(JSONKeywords, self).__init__() @keyword def json_equals(self, left, right): diff --git a/robotframework-onap/ONAPLibrary/Kafka.py b/robotframework-onap/ONAPLibrary/Kafka.py new file mode 100644 index 0000000..5ff8b21 --- /dev/null +++ b/robotframework-onap/ONAPLibrary/Kafka.py @@ -0,0 +1,26 @@ +# Copyright 2019 AT&T Intellectual Property. All rights reserved. +# +# 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. + +from ONAPLibrary.robotlibcore import HybridCore +from ONAPLibrary.KafkaKeywords import KafkaKeywords + + +class Kafka(HybridCore): + """ Utilities useful for Kafka consuming and producing """ + + def __init__(self): + self.keyword_implementors = [ + KafkaKeywords() + ] + HybridCore.__init__(self, self.keyword_implementors) diff --git a/robotframework-onap/ONAPLibrary/KafkaKeywords.py b/robotframework-onap/ONAPLibrary/KafkaKeywords.py new file mode 100644 index 0000000..6da5b52 --- /dev/null +++ b/robotframework-onap/ONAPLibrary/KafkaKeywords.py @@ -0,0 +1,76 @@ +# Copyright 2019 AT&T Intellectual Property. All rights reserved. +# +# 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. +from pykafka import KafkaClient +from pykafka.common import OffsetType +from robot.api.deco import keyword +from robot import utils + + +class KafkaKeywords(object): + """ Utilities useful for Kafka consuming and producing """ + + def __init__(self): + super(KafkaKeywords, self).__init__() + self._cache = utils.ConnectionCache('No Kafka Environments created') + + @keyword + def connect(self, alias, kafka_host, kafka_version="1.0.0"): + """connect to the specified kafka server""" + client = KafkaClient(hosts=kafka_host, broker_version=kafka_version) + self._cache.register(client, alias=alias) + + @keyword + def produce(self, alias, topic, key, value): + assert topic + assert value + + producer = self._get_producer(alias, topic) + return producer.produce(value, key) + + def _get_producer(self, alias, topic_name): + topic = self._cache.switch(alias).topics[topic_name] + prod = topic.get_sync_producer() + return prod + + @keyword + def consume(self, alias, topic_name, consumer_group=None): + assert topic_name + + consumer = self._get_consumer(alias, topic_name, consumer_group) + msg = consumer.consume() + if msg is None: + return None + else: + return msg.value + + def _get_consumer(self, alias, topic_name, consumer_group=None, set_offset_to_earliest=False): + assert topic_name + + # default to the topic as group name + if consumer_group: + cgn = consumer_group + else: + cgn = topic_name + + topic = self._cache.switch(alias).topics[topic_name] + + offset_type = OffsetType.LATEST + if set_offset_to_earliest: + offset_type = OffsetType.EARLIEST + + c = topic.get_simple_consumer( + consumer_group=cgn, auto_offset_reset=offset_type, auto_commit_enable=True, + reset_offset_on_start=True, consumer_timeout_ms=5000) + + return c diff --git a/robotframework-onap/setup.py b/robotframework-onap/setup.py index 53cdbc0..780e296 100644 --- a/robotframework-onap/setup.py +++ b/robotframework-onap/setup.py @@ -38,7 +38,8 @@ setup( 'six', 'requests', 'future', - 'robotframework-requests' + 'robotframework-requests', + 'pykafka' ], # what we need packages=['eteutils', 'loadtest', 'vcpeutils', 'ONAPLibrary'], # The name of your scripts package package_dir={ -- cgit 1.2.3-korg