sources: generalizing download method

Before, the download method was defined in the inherited class of each
program. With the same kind of workflow redefined every time. This
contribution aims at making the workflow more clear and to generalize
what can be in the SourceService class.

The download worklow is as follow:
Setup -> Filter -> Prepare -> Download

The setup mainly step sets up caches. Where the download data will be
stored in the end.

The filter step is used to discard some of the items to download based
on some criterion. By default, it is used to verify if an item is
already in the cache using the item's checksum.

The Prepare step goes from each element and let the overloading step the
ability to alter each item before downloading it. This is used mainly
for the curl command which for rhel must generate the subscriptions.

Then the download step will call fetch_one for each item. Here the
download can be performed sequentially or in parallel depending on the
number of workers selected.
This commit is contained in:
Thomas Lavocat 2022-04-12 15:37:21 +02:00 committed by Thomas Lavocat
parent 0953cf64e0
commit 1de74ce2c9
5 changed files with 129 additions and 141 deletions

View file

@ -3,7 +3,9 @@ import contextlib
import os
import json
import tempfile
import concurrent.futures
from abc import abstractmethod
from typing import Dict, Tuple
from . import host
from .objectstore import ObjectStore
@ -51,6 +53,8 @@ class Source:
class SourceService(host.Service):
"""Source host service"""
max_workers = 1
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.cache = None
@ -58,8 +62,24 @@ class SourceService(host.Service):
self.tmpdir = None
@abc.abstractmethod
def download(self, items):
pass
def fetch_one(self, checksum, desc) -> None:
"""Performs the actual fetch of an element described by its checksum and its descriptor"""
def exists(self, checksum, _desc) -> bool:
"""Returns True if the item to download is in cache. """
return os.path.isfile(f"{self.cache}/{checksum}")
# pylint: disable=[no-self-use]
def transform(self, checksum, desc) -> Tuple:
"""Modify the input data before downloading. By default only transforms an item object to a Tupple."""
return checksum, desc
def download(self, items: Dict) -> None:
items = filter(lambda i: not self.exists(i[0], i[1]), items.items()) # discards items already in cache
items = map(lambda i: self.transform(i[0], i[1]), items) # prepare each item to be downloaded
with concurrent.futures.ThreadPoolExecutor(max_workers=self.max_workers) as executor:
for _ in executor.map(self.fetch_one, *zip(*items)):
pass
@property
@classmethod