diff --git a/.gitignore b/.gitignore --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,6 @@ dist/ version.txt .tox/ +kafka/ +kafka*.tgz +kafka*.tar.gz \ No newline at end of file diff --git a/requirements-test.txt b/requirements-test.txt --- a/requirements-test.txt +++ b/requirements-test.txt @@ -1,2 +1,3 @@ pytest swh.model +pytest-kafka diff --git a/setup.py b/setup.py --- a/setup.py +++ b/setup.py @@ -4,7 +4,41 @@ # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information +# Regarding the kafka installation development code (test) +# Copyright 2018 Infectious Media Ltd and pytest-kafka contributors +# +# Permission is hereby granted, free of charge, to any person +# obtaining a copy of this software and associated documentation files +# (the "Software"), to deal in the Software without restriction, +# including without limitation the rights to use, copy, modify, merge, +# publish, distribute, sublicense, and/or sell copies of the Software, +# and to permit persons to whom the Software is furnished to do so, +# subject to the following conditions: +# +# The above copyright notice and this permission notice shall be +# included in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS +# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN +# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. + +import contextlib +import os +import tarfile +import shutil +import subprocess +import sys +import urllib.request + +from pathlib import Path from setuptools import setup, find_packages +from setuptools.command.develop import develop # type: ignore + from os import path from io import open @@ -35,6 +69,82 @@ return requirements +# Dependencies for the test, copied from pytest-kafka's setup.py [1] +# [1] https://gitlab.com/karolinepauls/pytest-kafka/blob/master/setup.py +KAFKA_URL = ( + 'https://www.mirrorservice.org/sites/ftp.apache.org/kafka/1.1.1/' + 'kafka_2.11-1.1.1.tgz') +KAFKA_EXPECTED_HASH_SHA256 = '93b6f926b10b3ba826266272e3bd9d0fe8b33046da9a2688c58d403eb0a43430' # noqa +KAFKA_TAR = 'kafka.tgz' +KAFKA_TAR_ROOTDIR = 'kafka_2.11-1.1.1' +KAFKA_DIR = 'swh/journal/tests/kafka' + + +def set_up_kafka(): + """Download Kafka from an official mirror and untar it. The tarball + is checked for the right checksum. + + The data are not cleaned up to allow caching. Call specific + `setup.py clean` to clean up the test artefacts. + + """ + if not os.path.exists(KAFKA_TAR): + print('*swh-journal-setup* Downloading Kafka', file=sys.stderr) + urllib.request.urlretrieve(KAFKA_URL, KAFKA_TAR) + import hashlib + h = hashlib.sha256() + with open(KAFKA_TAR, 'rb') as f: + for chunk in f: + h.update(chunk) + hash_result = h.hexdigest() + if hash_result != KAFKA_EXPECTED_HASH_SHA256: + raise ValueError( + "Mismatch tarball %s hash checksum: expected %s, got %s" % ( + KAFKA_TAR, KAFKA_EXPECTED_HASH_SHA256, hash_result, )) + + if not os.path.exists(KAFKA_DIR): + print('*swh-journal-setup* Unpacking Kafka', file=sys.stderr) + with tarfile.open(KAFKA_TAR, 'r') as f: + f.extractall() + + print('*swh-journal-setup* Renaming:', KAFKA_TAR_ROOTDIR, '→', + KAFKA_DIR, file=sys.stderr) + Path(KAFKA_TAR_ROOTDIR).rename(KAFKA_DIR) + + +class InstallExtraDevDependencies(develop): + """Install development dependencies and download/setup Kafka. + + """ + def run(self): + """Set up the local dev environment fully. + + """ + print('*swh-journal-setup* Installing dev dependencies', + file=sys.stderr) + super().run() + subprocess.check_call(['pip', 'install', '-U', 'pip']) + subprocess.check_call(['pip', 'install', '.[testing]']) + + print('*swh-journal-setup* Setting up Kafka', file=sys.stderr) + set_up_kafka() + print('*swh-journal-setup* Setting up Kafka done') + + +class CleanupExtraDevDependencies(develop): + def run(self): + """Clean whatever `set_up_kafka` may create. + + """ + print('*swh-journal-setup* Cleaning up: %s, %s, %s' % ( + KAFKA_DIR, KAFKA_TAR_ROOTDIR, KAFKA_TAR)) + shutil.rmtree(KAFKA_DIR, ignore_errors=True) + shutil.rmtree(KAFKA_TAR_ROOTDIR, ignore_errors=True) + with contextlib.suppress(FileNotFoundError): + Path(KAFKA_TAR).unlink() + print('*swh-journal-setup* Cleaning up done') + + setup( name='swh.journal', description='Software Heritage Journal utilities', @@ -51,9 +161,15 @@ ''', install_requires=parse_requirements() + parse_requirements('swh'), setup_requires=['vcversioner'], - extras_require={'testing': parse_requirements('test')}, + extras_require={ + 'testing': parse_requirements('test') + }, vcversioner={}, include_package_data=True, + cmdclass={ + 'develop': InstallExtraDevDependencies, + 'clean': CleanupExtraDevDependencies, + }, classifiers=[ "Programming Language :: Python :: 3", "Intended Audience :: Developers", diff --git a/swh/journal/cli.py b/swh/journal/cli.py --- a/swh/journal/cli.py +++ b/swh/journal/cli.py @@ -57,22 +57,7 @@ """Manipulate publisher """ - mandatory_keys = [ - 'brokers', 'temporary_prefix', 'final_prefix', 'consumer_id', - 'publisher_id', 'object_types', 'storage' - ] - conf = ctx.obj['config'] - missing_keys = [] - for key in mandatory_keys: - if not conf.get(key): - missing_keys.append(key) - - if missing_keys: - raise click.ClickException( - 'Configuration error: The following keys must be' - ' provided: %s' % (','.join(missing_keys), )) - publisher = JournalPublisher(conf) try: while True: diff --git a/swh/journal/publisher.py b/swh/journal/publisher.py --- a/swh/journal/publisher.py +++ b/swh/journal/publisher.py @@ -13,6 +13,14 @@ from .serializers import kafka_to_key, key_to_kafka +logger = logging.getLogger(__name__) + + +MANDATORY_KEYS = [ + 'brokers', 'temporary_prefix', 'final_prefix', 'consumer_id', + 'publisher_id', 'object_types', 'storage' +] + class JournalPublisher: """The journal publisher is a layer in charge of: @@ -27,9 +35,27 @@ """ def __init__(self, config): self.config = config + self.check_config(config) self._prepare_storage(config) self._prepare_journal(config) self.max_messages = self.config['max_messages'] + logger.setLevel(logging.DEBUG) + + def check_config(self, config): + """Check the configuration is fine. + + If not raise an error. + + """ + missing_keys = [] + for key in MANDATORY_KEYS: + if not config.get(key): + missing_keys.append(key) + + if missing_keys: + raise ValueError( + 'Configuration error: The following keys must be' + ' provided: %s' % (','.join(missing_keys), )) def _prepare_journal(self, config): """Prepare the consumer and subscriber instances for the publisher to @@ -51,7 +77,7 @@ client_id=config['publisher_id'], ) - logging.debug('Subscribing to object types event: %s' % ( + logger.debug('Subscribing to object types event: %s' % ( config['object_types'], )) self.consumer.subscribe( topics=['%s.%s' % (config['temporary_prefix'], object_type) @@ -84,7 +110,7 @@ for num, message in enumerate(self.consumer): object_type = message.topic.split('.')[-1] - logging.debug('num: %s, object_type: %s, message: %s' % ( + logger.debug('num: %s, object_type: %s, message: %s' % ( num, object_type, message)) messages[object_type].append(message.value) if num + 1 >= self.max_messages: @@ -136,31 +162,31 @@ for object_type, objects in messages.items(): topic = '%s.%s' % (self.config['final_prefix'], object_type) for key, object in objects: - logging.debug('topic: %s, key: %s, value: %s' % ( + logger.debug('topic: %s, key: %s, value: %s' % ( topic, key, object)) self.producer.send(topic, key=key, value=object) self.producer.flush() def process_contents(self, content_objs): - logging.debug('contents: %s' % content_objs) + logger.debug('contents: %s' % content_objs) metadata = self.storage.content_get_metadata( (c[b'sha1'] for c in content_objs)) return [(content['sha1'], content) for content in metadata] def process_revisions(self, revision_objs): - logging.debug('revisions: %s' % revision_objs) + logger.debug('revisions: %s' % revision_objs) metadata = self.storage.revision_get((r[b'id'] for r in revision_objs)) return [(revision['id'], revision) for revision in metadata if revision] def process_releases(self, release_objs): - logging.debug('releases: %s' % release_objs) + logger.debug('releases: %s' % release_objs) metadata = self.storage.release_get((r[b'id'] for r in release_objs)) return [(release['id'], release) for release in metadata] def process_origins(self, origin_objs): - logging.debug('origins: %s' % origin_objs) + logger.debug('origins: %s' % origin_objs) r = [] for o in origin_objs: origin = {'url': o[b'url'], 'type': o[b'type']} @@ -168,7 +194,7 @@ return r def process_origin_visits(self, origin_visits): - logging.debug('origin_visits: %s' % origin_visits) + logger.debug('origin_visits: %s' % origin_visits) metadata = [] for ov in origin_visits: origin_visit = self.storage.origin_visit_get_by( @@ -180,7 +206,7 @@ return metadata def process_snapshots(self, snapshot_objs): - logging.debug('snapshots: %s' % snapshot_objs) + logger.debug('snapshots: %s' % snapshot_objs) metadata = [] for snap in snapshot_objs: full_obj = snapshot.snapshot_get_all_branches( diff --git a/swh/journal/tests/conftest.py b/swh/journal/tests/conftest.py new file mode 100644 --- /dev/null +++ b/swh/journal/tests/conftest.py @@ -0,0 +1,199 @@ +# Copyright (C) 2019 The Software Heritage developers +# See the AUTHORS file at the top-level directory of this distribution +# License: GNU General Public License version 3, or any later version +# See top-level LICENSE file for more information + +import os +import pytest +import logging + +from kafka import KafkaProducer +from subprocess import Popen +from typing import Tuple, Dict + +from pathlib import Path +from pytest_kafka import ( + make_zookeeper_process, make_kafka_server, make_kafka_consumer +) + +from swh.journal.publisher import JournalPublisher +from swh.model.hashutil import hash_to_bytes + +from swh.journal.serializers import kafka_to_key, key_to_kafka, kafka_to_value + + +TEST_CONFIG = { + 'brokers': ['something'], # this will be overriden in publisher setup + 'temporary_prefix': 'swh.tmp_journal.new', + 'final_prefix': 'swh.journal.objects', + 'consumer_id': 'swh.journal.publisher', + 'publisher_id': 'swh.journal.publisher', + 'object_types': ['something'], # this will be overriden in publisher setup + 'max_messages': 1, # will read 1 message and stops + 'storage': {'cls': 'memory', 'args': {}} +} + +CONTENTS = [ + { + 'length': 3, + 'sha1': hash_to_bytes( + '34973274ccef6ab4dfaaf86599792fa9c3fe4689'), + 'sha1_git': b'foo', + 'blake2s256': b'bar', + 'sha256': b'baz', + 'status': 'visible', + }, +] + +COMMITTER = [ + { + 'id': 1, + 'fullname': 'foo', + }, + { + 'id': 2, + 'fullname': 'bar', + } +] + +REVISIONS = [ + { + 'id': hash_to_bytes('7026b7c1a2af56521e951c01ed20f255fa054238'), + 'message': b'hello', + 'date': { + 'timestamp': { + 'seconds': 1234567891, + 'microseconds': 0, + }, + 'offset': 120, + 'negative_utc': None, + }, + 'committer': COMMITTER[0], + 'author': COMMITTER[0], + 'committer_date': None, + }, + { + 'id': hash_to_bytes('368a48fe15b7db2383775f97c6b247011b3f14f4'), + 'message': b'hello again', + 'date': { + 'timestamp': { + 'seconds': 1234567892, + 'microseconds': 0, + }, + 'offset': 120, + 'negative_utc': None, + }, + 'committer': COMMITTER[1], + 'author': COMMITTER[1], + 'committer_date': None, + }, +] + +RELEASES = [ + { + 'id': hash_to_bytes('d81cc0710eb6cf9efd5b920a8453e1e07157b6cd'), + 'name': b'v0.0.1', + 'date': { + 'timestamp': { + 'seconds': 1234567890, + 'microseconds': 0, + }, + 'offset': 120, + 'negative_utc': None, + }, + 'author': COMMITTER[0], + }, +] + +ORIGINS = [ + { + 'url': 'https://somewhere.org/den/fox', + 'type': 'git', + }, + { + 'url': 'https://overtherainbow.org/fox/den', + 'type': 'svn', + } +] + +ORIGIN_VISITS = [ + { + 'date': '2013-05-07T04:20:39.369271+00:00', + }, + { + 'date': '2018-11-27T17:20:39.000000+00:00', + } +] + + +class JournalPublisherTest(JournalPublisher): + """A journal publisher which override the default configuration + parsing setup. + + """ + def _prepare_storage(self, config): + super()._prepare_storage(config) + self.storage.content_add({'data': b'42', **c} for c in CONTENTS) + self.storage.revision_add(REVISIONS) + self.storage.release_add(RELEASES) + origins = self.storage.origin_add(ORIGINS) + origin_visits = [] + for i, ov in enumerate(ORIGIN_VISITS): + origin_id = origins[i]['id'] + ov = self.storage.origin_visit_add(origin_id, ov['date']) + origin_visits.append(ov) + self.origins = origins + self.origin_visits = origin_visits + + +KAFKA_ROOT = os.environ.get('SWH_KAFKA_ROOT', Path(__file__).parent) +KAFKA_SCRIPTS = KAFKA_ROOT / 'kafka/bin/' + +KAFKA_BIN = str(KAFKA_SCRIPTS / 'kafka-server-start.sh') +ZOOKEEPER_BIN = str(KAFKA_SCRIPTS / 'zookeeper-server-start.sh') + + +# Those defines fixtures +zookeeper_proc = make_zookeeper_process(ZOOKEEPER_BIN) +kafka_server = make_kafka_server(KAFKA_BIN, 'zookeeper_proc') + +logger = logging.getLogger('kafka') +logger.setLevel(logging.WARN) + + +@pytest.fixture +def producer_to_publisher( + request: 'SubRequest', # noqa F821 + kafka_server: Tuple[Popen, int]) -> KafkaProducer: # noqa + """Producer to send message to the publisher's consumer. + + """ + _, port = kafka_server + producer = KafkaProducer( + bootstrap_servers='localhost:{}'.format(port), + key_serializer=key_to_kafka, + value_serializer=key_to_kafka, + client_id=TEST_CONFIG['consumer_id'], + ) + return producer + + +# pytest fixture (no need for the annotation though or else it breaks) +consumer_from_publisher = make_kafka_consumer( + 'kafka_server', + seek_to_beginning=True, + key_deserializer=kafka_to_key, + value_deserializer=kafka_to_value, + auto_offset_reset='earliest', + enable_auto_commit=True, + client_id=TEST_CONFIG['publisher_id'], + kafka_topics=['dummy']) # will be overriden during test setup + + +def publisher(kafka_server: Tuple[Popen, int], + config: Dict) -> JournalPublisher: + # consumer and producer of the publisher needs to discuss with the + # right instance + _, port = kafka_server + config['brokers'] = ['localhost:{}'.format(port)] + return JournalPublisherTest(config) diff --git a/swh/journal/tests/test_publisher.py b/swh/journal/tests/test_publisher.py --- a/swh/journal/tests/test_publisher.py +++ b/swh/journal/tests/test_publisher.py @@ -1,223 +1,105 @@ -# Copyright (C) 2018 The Software Heritage developers +# Copyright (C) 2018-2019 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information -import unittest -from swh.model.hashutil import hash_to_bytes +from kafka import KafkaConsumer, KafkaProducer +from subprocess import Popen +from typing import Tuple, Dict, Text +from swh.journal.serializers import value_to_kafka, kafka_to_value + from swh.journal.publisher import JournalPublisher -from swh.storage.in_memory import Storage - -CONTENTS = [ - { - 'length': 3, - 'sha1': hash_to_bytes( - '34973274ccef6ab4dfaaf86599792fa9c3fe4689'), - 'sha1_git': b'foo', - 'blake2s256': b'bar', - 'sha256': b'baz', - 'status': 'visible', - }, -] - -COMMITTER = [ - { - 'id': 1, - 'fullname': 'foo', - }, - { - 'id': 2, - 'fullname': 'bar', - } -] - -REVISIONS = [ - { - 'id': hash_to_bytes('7026b7c1a2af56521e951c01ed20f255fa054238'), - 'message': b'hello', - 'date': { - 'timestamp': { - 'seconds': 1234567891, - 'microseconds': 0, - }, - 'offset': 120, - 'negative_utc': None, - }, - 'committer': COMMITTER[0], - 'author': COMMITTER[0], - 'committer_date': None, - }, - { - 'id': hash_to_bytes('368a48fe15b7db2383775f97c6b247011b3f14f4'), - 'message': b'hello again', - 'date': { - 'timestamp': { - 'seconds': 1234567892, - 'microseconds': 0, - }, - 'offset': 120, - 'negative_utc': None, - }, - 'committer': COMMITTER[1], - 'author': COMMITTER[1], - 'committer_date': None, - }, -] - -RELEASES = [ - { - 'id': hash_to_bytes('d81cc0710eb6cf9efd5b920a8453e1e07157b6cd'), - 'name': b'v0.0.1', - 'date': { - 'timestamp': { - 'seconds': 1234567890, - 'microseconds': 0, - }, - 'offset': 120, - 'negative_utc': None, - }, - 'author': COMMITTER[0], - }, -] - -ORIGINS = [ - { - 'url': 'https://somewhere.org/den/fox', - 'type': 'git', - }, - { - 'url': 'https://overtherainbow.org/fox/den', - 'type': 'svn', - } -] - -ORIGIN_VISITS = [ - { - 'date': '2013-05-07T04:20:39.369271+00:00', - }, - { - 'date': '2018-11-27T17:20:39.000000+00:00', - } -] - -TEST_CONFIG = { - 'brokers': ['localhost'], - 'temporary_prefix': 'swh.tmp_journal.new', - 'final_prefix': 'swh.journal.objects', - 'consumer_id': 'swh.journal.test.publisher', - 'publisher_id': 'swh.journal.test.publisher', - 'object_types': ['content'], - 'max_messages': 3, + +from .conftest import ( + TEST_CONFIG, CONTENTS, REVISIONS, RELEASES, publisher +) + + +OBJECT_TYPE_KEYS = { + 'content': (b'sha1', CONTENTS), + 'revision': (b'id', REVISIONS), + 'release': (b'id', RELEASES), } -class JournalPublisherTest(JournalPublisher): - def _prepare_storage(self, config): - self.storage = Storage() - self.storage.content_add({'data': b'42', **c} for c in CONTENTS) - self.storage.revision_add(REVISIONS) - self.storage.release_add(RELEASES) - origins = self.storage.origin_add(ORIGINS) - origin_visits = [] - for i, ov in enumerate(ORIGIN_VISITS): - origin_id = origins[i]['id'] - ov = self.storage.origin_visit_add(origin_id, ov['date']) - origin_visits.append(ov) - self.origins = origins - self.origin_visits = origin_visits - - print("publisher.origin-visits", self.origin_visits) - - -class JournalPublisherNoKafkaInMemoryStorage(JournalPublisherTest): - """A journal publisher with: - - no kafka dependency - - in-memory storage +def assert_publish(publisher: JournalPublisher, + consumer_from_publisher: KafkaConsumer, + producer_to_publisher: KafkaProducer, + object_type: Text): + """Assert that publishing object in the publisher is reified and + published in topics. + + Args: + journal_publisher (JournalPublisher): publisher to read and write data + kafka_consumer (KafkaConsumer): To read data from the publisher + kafka_producer (KafkaProducer): To send data to the publisher + + """ + # object type's id label key + object_key_id, expected_objects = OBJECT_TYPE_KEYS[object_type] + # objects to send to the publisher + objects = [{object_key_id: c[object_key_id.decode()]} + for c in expected_objects] + + # send message to the publisher + for obj in objects: + producer_to_publisher.send( + '%s.%s' % (TEST_CONFIG['temporary_prefix'], object_type), + obj + ) + + nb_messages = len(objects) + + # publisher should poll 1 message and send 1 reified object + publisher.poll(max_messages=nb_messages) + + # then (client reads from the messages from output topic) + msgs = [] + for num, msg in enumerate(consumer_from_publisher): + msgs.append((msg.topic, msg.key, msg.value)) + + expected_topic = '%s.%s' % (TEST_CONFIG['final_prefix'], object_type) + assert expected_topic == msg.topic + + expected_key = objects[num][object_key_id] + assert expected_key == msg.key + + # Transformation is needed due to our back and forth + # serialization to kafka + expected_value = kafka_to_value(value_to_kafka(expected_objects[num])) + assert expected_value == msg.value + + +def test_publish( + kafka_server: Tuple[Popen, int], + consumer_from_publisher: KafkaConsumer, + producer_to_publisher: KafkaProducer): """ + Reading from and writing to the journal publisher should work (contents) - def _prepare_journal(self, config): - """No journal for now - - """ - pass - - -class TestPublisher(unittest.TestCase): - def setUp(self): - self.publisher = JournalPublisherNoKafkaInMemoryStorage(TEST_CONFIG) - self.contents = [{b'sha1': c['sha1']} for c in CONTENTS] - self.revisions = [{b'id': c['id']} for c in REVISIONS] - self.releases = [{b'id': c['id']} for c in RELEASES] - # those needs id generation from the storage - # so initialization is different than other entities - self.origins = [{b'url': o['url'], - b'type': o['type']} - for o in self.publisher.origins] - self.origin_visits = [{b'origin': ov['origin'], - b'visit': ov['visit']} - for ov in self.publisher.origin_visits] - # full objects - storage = self.publisher.storage - ovs = [] - for ov in self.origin_visits: - _ov = storage.origin_visit_get_by( - ov[b'origin'], ov[b'visit']) - _ov['date'] = str(_ov['date']) - ovs.append(_ov) - self.expected_origin_visits = ovs - - def test_process_contents(self): - actual_contents = self.publisher.process_contents(self.contents) - expected_contents = [(c['sha1'], c) for c in CONTENTS] - self.assertEqual(actual_contents, expected_contents) - - def test_process_revisions(self): - actual_revisions = self.publisher.process_revisions(self.revisions) - expected_revisions = [(c['id'], c) for c in REVISIONS] - self.assertEqual(actual_revisions, expected_revisions) - - def test_process_releases(self): - actual_releases = self.publisher.process_releases(self.releases) - expected_releases = [(c['id'], c) for c in RELEASES] - self.assertEqual(actual_releases, expected_releases) - - def test_process_origins(self): - actual_origins = self.publisher.process_origins(self.origins) - expected_origins = [({'url': o[b'url'], 'type': o[b'type']}, - {'url': o[b'url'], 'type': o[b'type']}) - for o in self.origins] - self.assertEqual(actual_origins, expected_origins) - - def test_process_origin_visits(self): - actual_ovs = self.publisher.process_origin_visits(self.origin_visits) - expected_ovs = [((ov['origin'], ov['visit']), ov) - for ov in self.expected_origin_visits] - self.assertEqual(actual_ovs, expected_ovs) - - def test_process_objects(self): - messages = { - 'content': self.contents, - 'revision': self.revisions, - 'release': self.releases, - 'origin': self.origins, - 'origin_visit': self.origin_visits, - } - - actual_objects = self.publisher.process_objects(messages) - - expected_contents = [(c['sha1'], c) for c in CONTENTS] - expected_revisions = [(c['id'], c) for c in REVISIONS] - expected_releases = [(c['id'], c) for c in RELEASES] - expected_origins = [(o, o) for o in ORIGINS] - expected_ovs = [((ov['origin'], ov['visit']), ov) - for ov in self.expected_origin_visits] - expected_objects = { - 'content': expected_contents, - 'revision': expected_revisions, - 'release': expected_releases, - 'origin': expected_origins, - 'origin_visit': expected_ovs, - } - - self.assertEqual(actual_objects, expected_objects) + Args: + journal_publisher (JournalPublisher): publisher to read and write data + kafka_consumer (KafkaConsumer): To read data from the publisher + kafka_producer (KafkaProducer): To send data to the publisher + + """ + # retrieve the object types we want to test + object_types = OBJECT_TYPE_KEYS.keys() + # synchronize the publisher's config with the test + conf = TEST_CONFIG.copy() + conf['object_types'] = object_types + # instantiate the publisher (not a fixture due to initialization) + p = publisher(kafka_server, config=conf) + + # Subscribe to the publisher's output topics + consumer_from_publisher.subscribe( + topics=['%s.%s' % (conf['final_prefix'], object_type) + for object_type in object_types]) + + # Now for each object type, we'll send data to the publisher and + # check that data is indeed fetched and reified in the publisher's + # output topics + for object_type in object_types: + assert_publish(p, consumer_from_publisher, + producer_to_publisher, object_type) diff --git a/swh/journal/tests/test_publisher.py b/swh/journal/tests/test_publisher_no_kafka.py copy from swh/journal/tests/test_publisher.py copy to swh/journal/tests/test_publisher_no_kafka.py --- a/swh/journal/tests/test_publisher.py +++ b/swh/journal/tests/test_publisher_no_kafka.py @@ -1,140 +1,29 @@ -# Copyright (C) 2018 The Software Heritage developers +# Copyright (C) 2018-2019 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information +import pytest import unittest -from swh.model.hashutil import hash_to_bytes -from swh.journal.publisher import JournalPublisher -from swh.storage.in_memory import Storage - -CONTENTS = [ - { - 'length': 3, - 'sha1': hash_to_bytes( - '34973274ccef6ab4dfaaf86599792fa9c3fe4689'), - 'sha1_git': b'foo', - 'blake2s256': b'bar', - 'sha256': b'baz', - 'status': 'visible', - }, -] - -COMMITTER = [ - { - 'id': 1, - 'fullname': 'foo', - }, - { - 'id': 2, - 'fullname': 'bar', - } -] - -REVISIONS = [ - { - 'id': hash_to_bytes('7026b7c1a2af56521e951c01ed20f255fa054238'), - 'message': b'hello', - 'date': { - 'timestamp': { - 'seconds': 1234567891, - 'microseconds': 0, - }, - 'offset': 120, - 'negative_utc': None, - }, - 'committer': COMMITTER[0], - 'author': COMMITTER[0], - 'committer_date': None, - }, - { - 'id': hash_to_bytes('368a48fe15b7db2383775f97c6b247011b3f14f4'), - 'message': b'hello again', - 'date': { - 'timestamp': { - 'seconds': 1234567892, - 'microseconds': 0, - }, - 'offset': 120, - 'negative_utc': None, - }, - 'committer': COMMITTER[1], - 'author': COMMITTER[1], - 'committer_date': None, - }, -] - -RELEASES = [ - { - 'id': hash_to_bytes('d81cc0710eb6cf9efd5b920a8453e1e07157b6cd'), - 'name': b'v0.0.1', - 'date': { - 'timestamp': { - 'seconds': 1234567890, - 'microseconds': 0, - }, - 'offset': 120, - 'negative_utc': None, - }, - 'author': COMMITTER[0], - }, -] - -ORIGINS = [ - { - 'url': 'https://somewhere.org/den/fox', - 'type': 'git', - }, - { - 'url': 'https://overtherainbow.org/fox/den', - 'type': 'svn', - } -] - -ORIGIN_VISITS = [ - { - 'date': '2013-05-07T04:20:39.369271+00:00', - }, - { - 'date': '2018-11-27T17:20:39.000000+00:00', - } -] - -TEST_CONFIG = { - 'brokers': ['localhost'], - 'temporary_prefix': 'swh.tmp_journal.new', - 'final_prefix': 'swh.journal.objects', - 'consumer_id': 'swh.journal.test.publisher', - 'publisher_id': 'swh.journal.test.publisher', - 'object_types': ['content'], - 'max_messages': 3, -} - - -class JournalPublisherTest(JournalPublisher): - def _prepare_storage(self, config): - self.storage = Storage() - self.storage.content_add({'data': b'42', **c} for c in CONTENTS) - self.storage.revision_add(REVISIONS) - self.storage.release_add(RELEASES) - origins = self.storage.origin_add(ORIGINS) - origin_visits = [] - for i, ov in enumerate(ORIGIN_VISITS): - origin_id = origins[i]['id'] - ov = self.storage.origin_visit_add(origin_id, ov['date']) - origin_visits.append(ov) - self.origins = origins - self.origin_visits = origin_visits - - print("publisher.origin-visits", self.origin_visits) +from .conftest import ( + JournalPublisherTest, TEST_CONFIG, + CONTENTS, REVISIONS, RELEASES, ORIGINS +) +from swh.journal.publisher import MANDATORY_KEYS class JournalPublisherNoKafkaInMemoryStorage(JournalPublisherTest): """A journal publisher with: - no kafka dependency - in-memory storage + """ + def check_config(self, config): + """No need to check the configuration here as we do not use kafka + + """ + pass def _prepare_journal(self, config): """No journal for now @@ -143,7 +32,10 @@ pass -class TestPublisher(unittest.TestCase): +class TestPublisherNoKafka(unittest.TestCase): + """This tests only the part not using any kafka instance + + """ def setUp(self): self.publisher = JournalPublisherNoKafkaInMemoryStorage(TEST_CONFIG) self.contents = [{b'sha1': c['sha1']} for c in CONTENTS] @@ -221,3 +113,39 @@ } self.assertEqual(actual_objects, expected_objects) + + +class JournalPublisherCheckTest(JournalPublisherTest): + """A journal publisher with: + - no kafka dependency + - in-memory storage + + """ + def _prepare_journal(self, config): + """No journal for now + + """ + pass + + +def test_check_config_ok(): + """Instantiate a publisher with the right config is fine + + """ + publisher = JournalPublisherCheckTest(TEST_CONFIG) + assert publisher is not None + + +def test_check_config_ko(): + """Instantiate a publisher with the wrong config should raise + + """ + for k in MANDATORY_KEYS: + conf = TEST_CONFIG.copy() + conf.pop(k) + with pytest.raises(ValueError) as e: + JournalPublisherCheckTest(conf) + + error = ('Configuration error: The following keys must be' + ' provided: %s' % (','.join([k]), )) + assert e.value.args[0] == error diff --git a/tox.ini b/tox.ini --- a/tox.ini +++ b/tox.ini @@ -6,6 +6,7 @@ .[testing] pytest-cov commands = + ./setup.py develop pytest --cov=swh --cov-branch {posargs} [testenv:flake8]