#!/usr/bin/python3 # Copyright 2021 Memgraph Ltd. # # Use of this software is governed by the Business Source License # included in the file licenses/BSL.txt; by using this file, you agree to be bound by the terms of the Business Source # License, and you may not use this file except in compliance with the Business Source License. # # As of the Change Date specified in that file, in accordance with # the Business Source License, use of this software will be governed # by the Apache License, Version 2.0, included in the file # licenses/APL.txt. import sys import pytest import mgclient import time from multiprocessing import Process, Value import common # These are the indices of the query and parameters in the result of CHECK # STREAM query QUERY = 0 PARAMS = 1 TRANSFORMATIONS_TO_CHECK = ["transform.simple", "transform.with_parameters"] SIMPLE_MSG = b"message" @pytest.mark.parametrize("transformation", TRANSFORMATIONS_TO_CHECK) def test_simple(producer, topics, connection, transformation): assert len(topics) > 0 cursor = connection.cursor() common.execute_and_fetch_all( cursor, "CREATE STREAM test " f"TOPICS {','.join(topics)} " f"TRANSFORM {transformation}", ) common.start_stream(cursor, "test") time.sleep(5) for topic in topics: producer.send(topic, SIMPLE_MSG).get(timeout=60) for topic in topics: common.check_vertex_exists_with_topic_and_payload( cursor, topic, SIMPLE_MSG ) @pytest.mark.parametrize("transformation", TRANSFORMATIONS_TO_CHECK) def test_separate_consumers(producer, topics, connection, transformation): assert len(topics) > 0 cursor = connection.cursor() stream_names = [] for topic in topics: stream_name = "stream_" + topic stream_names.append(stream_name) common.execute_and_fetch_all( cursor, f"CREATE STREAM {stream_name} " f"TOPICS {topic} " f"TRANSFORM {transformation}", ) for stream_name in stream_names: common.start_stream(cursor, stream_name) time.sleep(5) for topic in topics: producer.send(topic, SIMPLE_MSG).get(timeout=60) for topic in topics: common.check_vertex_exists_with_topic_and_payload( cursor, topic, SIMPLE_MSG ) def test_start_from_last_committed_offset(producer, topics, connection): # This test creates a stream, consumes a message to have a committed # offset, then destroys the stream. A new message is sent before the # stream is recreated and then restarted. This simulates when Memgraph is # stopped (stream is destroyed) and then restarted (stream is recreated). # This is of course not as good as restarting memgraph would be, but # restarting Memgraph during a single workload cannot be done currently. assert len(topics) > 0 cursor = connection.cursor() common.execute_and_fetch_all( cursor, "CREATE STREAM test " f"TOPICS {topics[0]} " "TRANSFORM transform.simple", ) common.start_stream(cursor, "test") time.sleep(1) producer.send(topics[0], SIMPLE_MSG).get(timeout=60) common.check_vertex_exists_with_topic_and_payload( cursor, topics[0], SIMPLE_MSG ) common.stop_stream(cursor, "test") common.drop_stream(cursor, "test") messages = [b"second message", b"third message"] for message in messages: producer.send(topics[0], message).get(timeout=60) for message in messages: vertices_with_msg = common.execute_and_fetch_all( cursor, "MATCH (n: MESSAGE {" f"payload: '{message.decode('utf-8')}'" "}) RETURN n", ) assert len(vertices_with_msg) == 0 common.execute_and_fetch_all( cursor, "CREATE STREAM test " f"TOPICS {topics[0]} " "TRANSFORM transform.simple", ) common.start_stream(cursor, "test") for message in messages: common.check_vertex_exists_with_topic_and_payload( cursor, topics[0], message ) @pytest.mark.parametrize("transformation", TRANSFORMATIONS_TO_CHECK) def test_check_stream(producer, topics, connection, transformation): assert len(topics) > 0 cursor = connection.cursor() common.execute_and_fetch_all( cursor, "CREATE STREAM test " f"TOPICS {topics[0]} " f"TRANSFORM {transformation} " "BATCH_SIZE 1", ) common.start_stream(cursor, "test") time.sleep(1) producer.send(topics[0], SIMPLE_MSG).get(timeout=60) common.stop_stream(cursor, "test") messages = [b"first message", b"second message", b"third message"] for message in messages: producer.send(topics[0], message).get(timeout=60) def check_check_stream(batch_limit): assert ( transformation == "transform.simple" or transformation == "transform.with_parameters" ) test_results = common.execute_and_fetch_all( cursor, f"CHECK STREAM test BATCH_LIMIT {batch_limit}" ) assert len(test_results) == batch_limit for i in range(batch_limit): message_as_str = messages[i].decode("utf-8") if transformation == "transform.simple": assert f"payload: '{message_as_str}'" in test_results[i][QUERY] assert test_results[i][PARAMS] is None else: assert test_results[i][QUERY] == ( "CREATE (n:MESSAGE " "{timestamp: $timestamp, " "payload: $payload, " "topic: $topic, " "offset: $offset})" ) parameters = test_results[i][PARAMS] # this is not a very sofisticated test, but checks if # timestamp has some kind of value assert parameters["timestamp"] > 1000000000000 assert parameters["topic"] == topics[0] assert parameters["payload"] == message_as_str check_check_stream(1) check_check_stream(2) check_check_stream(3) common.start_stream(cursor, "test") for message in messages: common.check_vertex_exists_with_topic_and_payload( cursor, topics[0], message ) def test_show_streams(producer, topics, connection): assert len(topics) > 1 cursor = connection.cursor() common.execute_and_fetch_all( cursor, "CREATE STREAM default_values " f"TOPICS {topics[0]} " f"TRANSFORM transform.simple " f"BOOTSTRAP_SERVERS 'localhost:9092'", ) consumer_group = "my_special_consumer_group" batch_interval = 42 batch_size = 3 common.execute_and_fetch_all( cursor, "CREATE STREAM complex_values " f"TOPICS {','.join(topics)} " f"TRANSFORM transform.with_parameters " f"CONSUMER_GROUP {consumer_group} " f"BATCH_INTERVAL {batch_interval} " f"BATCH_SIZE {batch_size} ", ) assert len(common.execute_and_fetch_all(cursor, "SHOW STREAMS")) == 2 common.check_stream_info( cursor, "default_values", ("default_values", None, None, "transform.simple", None, False), ) common.check_stream_info( cursor, "complex_values", ( "complex_values", batch_interval, batch_size, "transform.with_parameters", None, False, ), ) @pytest.mark.parametrize("operation", ["START", "STOP"]) def test_start_and_stop_during_check(producer, topics, connection, operation): # This test is quite complex. The goal is to call START/STOP queries # while a CHECK query is waiting for its result. Because the Global # Interpreter Lock, running queries on multiple threads is not useful, # because only one of them can call Cursor::execute at a time. Therefore # multiple processes are used to execute the queries, because different # processes have different GILs. # The counter variables are thread- and process-safe variables to # synchronize between the different processes. Each value represents a # specific phase of the execution of the processes. assert len(topics) > 1 assert operation == "START" or operation == "STOP" cursor = connection.cursor() common.execute_and_fetch_all( cursor, "CREATE STREAM test_stream " f"TOPICS {topics[0]} " f"TRANSFORM transform.simple", ) check_counter = Value("i", 0) check_result_len = Value("i", 0) operation_counter = Value("i", 0) CHECK_BEFORE_EXECUTE = 1 CHECK_AFTER_FETCHALL = 2 CHECK_CORRECT_RESULT = 3 CHECK_INCORRECT_RESULT = 4 def call_check(counter, result_len): # This process will call the CHECK query and increment the counter # based on its progress and expected behavior connection = common.connect() cursor = connection.cursor() counter.value = CHECK_BEFORE_EXECUTE result = common.execute_and_fetch_all( cursor, "CHECK STREAM test_stream" ) result_len.value = len(result) counter.value = CHECK_AFTER_FETCHALL if len(result) > 0 and "payload: 'message'" in result[0][QUERY]: counter.value = CHECK_CORRECT_RESULT else: counter.value = CHECK_INCORRECT_RESULT OP_BEFORE_EXECUTE = 1 OP_AFTER_FETCHALL = 2 OP_ALREADY_STOPPED_EXCEPTION = 3 OP_INCORRECT_ALREADY_STOPPED_EXCEPTION = 4 OP_UNEXPECTED_EXCEPTION = 5 def call_operation(counter): # This porcess will call the query with the specified operation and # increment the counter based on its progress and expected behavior connection = common.connect() cursor = connection.cursor() counter.value = OP_BEFORE_EXECUTE try: common.execute_and_fetch_all( cursor, f"{operation} STREAM test_stream" ) counter.value = OP_AFTER_FETCHALL except mgclient.DatabaseError as e: if "Kafka consumer test_stream is already stopped" in str(e): counter.value = OP_ALREADY_STOPPED_EXCEPTION else: counter.value = OP_INCORRECT_ALREADY_STOPPED_EXCEPTION except Exception: counter.value = OP_UNEXPECTED_EXCEPTION check_stream_proc = Process( target=call_check, daemon=True, args=(check_counter, check_result_len) ) operation_proc = Process( target=call_operation, daemon=True, args=(operation_counter,) ) try: check_stream_proc.start() time.sleep(0.5) assert common.timed_wait( lambda: check_counter.value == CHECK_BEFORE_EXECUTE ) assert common.timed_wait( lambda: common.get_is_running(cursor, "test_stream") ) assert check_counter.value == CHECK_BEFORE_EXECUTE, ( "SHOW STREAMS " "was blocked until the end of CHECK STREAM" ) operation_proc.start() assert common.timed_wait( lambda: operation_counter.value == OP_BEFORE_EXECUTE ) producer.send(topics[0], SIMPLE_MSG).get(timeout=60) assert common.timed_wait( lambda: check_counter.value > CHECK_AFTER_FETCHALL ) assert check_counter.value == CHECK_CORRECT_RESULT assert check_result_len.value == 1 check_stream_proc.join() operation_proc.join() if operation == "START": assert operation_counter.value == OP_AFTER_FETCHALL assert common.get_is_running(cursor, "test_stream") else: assert operation_counter.value == OP_ALREADY_STOPPED_EXCEPTION assert not common.get_is_running(cursor, "test_stream") finally: # to make sure CHECK STREAM finishes producer.send(topics[0], SIMPLE_MSG).get(timeout=60) if check_stream_proc.is_alive(): check_stream_proc.terminate() if operation_proc.is_alive(): operation_proc.terminate() def test_check_already_started_stream(topics, connection): assert len(topics) > 0 cursor = connection.cursor() common.execute_and_fetch_all( cursor, "CREATE STREAM started_stream " f"TOPICS {topics[0]} " f"TRANSFORM transform.simple", ) common.start_stream(cursor, "started_stream") with pytest.raises(mgclient.DatabaseError): common.execute_and_fetch_all(cursor, "CHECK STREAM started_stream") def test_start_checked_stream_after_timeout(topics, connection): cursor = connection.cursor() common.execute_and_fetch_all( cursor, "CREATE STREAM test_stream " f"TOPICS {topics[0]} " f"TRANSFORM transform.simple", ) timeout_ms = 2000 def call_check(): common.execute_and_fetch_all( common.connect().cursor(), f"CHECK STREAM test_stream TIMEOUT {timeout_ms}", ) check_stream_proc = Process(target=call_check, daemon=True) start = time.time() check_stream_proc.start() assert common.timed_wait( lambda: common.get_is_running(cursor, "test_stream") ) common.start_stream(cursor, "test_stream") end = time.time() assert ( end - start ) < 1.3 * timeout_ms, "The START STREAM was blocked too long" assert common.get_is_running(cursor, "test_stream") common.stop_stream(cursor, "test_stream") def test_restart_after_error(producer, topics, connection): cursor = connection.cursor() common.execute_and_fetch_all( cursor, "CREATE STREAM test_stream " f"TOPICS {topics[0]} " f"TRANSFORM transform.query", ) common.start_stream(cursor, "test_stream") time.sleep(1) producer.send(topics[0], SIMPLE_MSG).get(timeout=60) assert common.timed_wait( lambda: not common.get_is_running(cursor, "test_stream") ) common.start_stream(cursor, "test_stream") time.sleep(1) producer.send(topics[0], b"CREATE (n:VERTEX { id : 42 })") assert common.check_one_result_row( cursor, "MATCH (n:VERTEX { id : 42 }) RETURN n" ) @pytest.mark.parametrize("transformation", TRANSFORMATIONS_TO_CHECK) def test_bootstrap_server(producer, topics, connection, transformation): assert len(topics) > 0 cursor = connection.cursor() local = "localhost:9092" common.execute_and_fetch_all( cursor, "CREATE STREAM test " f"TOPICS {','.join(topics)} " f"TRANSFORM {transformation} " f"BOOTSTRAP_SERVERS '{local}'", ) common.start_stream(cursor, "test") time.sleep(5) for topic in topics: producer.send(topic, SIMPLE_MSG).get(timeout=60) for topic in topics: common.check_vertex_exists_with_topic_and_payload( cursor, topic, SIMPLE_MSG ) @pytest.mark.parametrize("transformation", TRANSFORMATIONS_TO_CHECK) def test_bootstrap_server_empty(producer, topics, connection, transformation): assert len(topics) > 0 cursor = connection.cursor() with pytest.raises(mgclient.DatabaseError): common.execute_and_fetch_all( cursor, "CREATE STREAM test " f"TOPICS {','.join(topics)} " f"TRANSFORM {transformation} " "BOOTSTRAP_SERVERS ''", ) @pytest.mark.parametrize("transformation", TRANSFORMATIONS_TO_CHECK) def test_set_offset(producer, topics, connection, transformation): assert len(topics) > 0 cursor = connection.cursor() common.execute_and_fetch_all( cursor, "CREATE STREAM test " f"TOPICS {topics[0]} " f"TRANSFORM {transformation} " "BATCH_SIZE 1", ) messages = [f"{i} message" for i in range(1, 21)] for message in messages: producer.send(topics[0], message.encode()).get(timeout=60) def consume(expected_msgs): common.start_stream(cursor, "test") if len(expected_msgs) == 0: time.sleep(2) else: assert common.check_one_result_row( cursor, ( f"MATCH (n: MESSAGE {{payload: '{expected_msgs[-1]}'}})" "RETURN n" ), ) common.stop_stream(cursor, "test") res = common.execute_and_fetch_all( cursor, "MATCH (n) RETURN n.payload" ) return res def execute_set_offset_and_consume(id, expected_msgs): common.execute_and_fetch_all( cursor, f"CALL mg.kafka_set_stream_offset('test', {id})" ) return consume(expected_msgs) with pytest.raises(mgclient.DatabaseError): res = common.execute_and_fetch_all( cursor, "CALL mg.kafka_set_stream_offset('foo', 10)" ) def comparison_check(a, b): return a == str(b).strip("'(,)") res = execute_set_offset_and_consume(10, messages[10:]) assert len(res) == 10 assert all([comparison_check(a, b) for a, b in zip(messages[10:], res)]) common.execute_and_fetch_all(cursor, "MATCH (n) DETACH DELETE n") res = execute_set_offset_and_consume(-1, messages) assert len(res) == len(messages) assert all([comparison_check(a, b) for a, b in zip(messages, res)]) res = common.execute_and_fetch_all(cursor, "MATCH (n) return n.offset") assert all([comparison_check(str(i), res[i]) for i in range(1, 20)]) res = common.execute_and_fetch_all(cursor, "MATCH (n) DETACH DELETE n") res = execute_set_offset_and_consume(-2, []) assert len(res) == 0 last_msg = "Final Message" producer.send(topics[0], last_msg.encode()).get(timeout=60) res = consume([last_msg]) assert len(res) == 1 assert comparison_check("Final Message", res[0]) common.execute_and_fetch_all(cursor, "MATCH (n) DETACH DELETE n") if __name__ == "__main__": sys.exit(pytest.main([__file__, "-rA"]))