diff --git a/docs/extrinsic-metadata-specification.rst b/docs/extrinsic-metadata-specification.rst index d83476be..63927299 100644 --- a/docs/extrinsic-metadata-specification.rst +++ b/docs/extrinsic-metadata-specification.rst @@ -1,184 +1,185 @@ :orphan: .. _extrinsic-metadata-specification: Extrinsic metadata specification ================================ :term:`Extrinsic metadata` is information about software that is not part of the source code itself but still closely related to the software. Typical sources for extrinsic metadata are: the hosting place of a repository, which can offer metadata via its web view or API; external registries like collaborative curation initiatives; and out-of-band information available at source code archival time. Since they are not part of the source code, a dedicated mechanism to fetch and store them is needed. This specification assumes the reader is familiar with Software Heritage's :ref:`architecture` and :ref:`data-model`. Metadata sources ---------------- Authorities ^^^^^^^^^^^ Metadata authorities are entities that provide metadata about an :term:`origin`. Metadata authorities include: code hosting places, :term:`deposit` submitters, and registries (eg. Wikidata). An authority is uniquely defined by these properties: * its type, representing the kind of authority, which is one of these values: - * `deposit`, for metadata pushed to Software Heritage at the same time - as a software artifact - * `forge`, for metadata pulled from the same source as the one hosting - the software artifacts (which includes package managers) - * `registry`, for metadata pulled from a third-party + * `deposit`, for metadata pushed to Software Heritage at the same time + as a software artifact + * `forge`, for metadata pulled from the same source as the one hosting + the software artifacts (which includes package managers) + * `registry`, for metadata pulled from a third-party * its URL, which unambiguously identifies an instance of the authority type. Examples: =============== ================================= type url =============== ================================= deposit https://hal.archives-ouvertes.fr/ deposit https://hal.inria.fr/ deposit https://software.intel.com/ forge https://gitlab.com/ forge https://gitlab.inria.fr/ forge https://0xacab.org/ forge https://github.com/ registry https://www.wikidata.org/ registry https://swmath.org/ registry https://ascl.net/ =============== ================================= Metadata fetchers ^^^^^^^^^^^^^^^^^ Metadata fetchers are software components used to fetch metadata from a metadata authority, and ingest them into the Software Heritage archive. A metadata fetcher is uniquely defined by these properties: * its type * its version Examples: * :term:`loaders `, which may either discover metadata as a side-effect of loading source code, or be dedicated to fetching metadata. * :term:`listers `, which may discover metadata as a side-effect of discovering origins. * :term:`deposit` submitters, which push metadata to SWH from a third-party; usually at the same time as a :term:`software artifact` * crawlers, which fetch metadata from an authority in a way that is none of the above (eg. by querying a specific API of the origin's forge). Storage API ----------- Authorities and metadata fetchers ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The :term:`storage` API offers these endpoints to manipulate metadata authorities and metadata fetchers: * ``metadata_authority_add(type, url, metadata)`` which adds a new metadata authority to the storage. * ``metadata_authority_get(type, url)`` which looks up a known authority (there is at most one) and if it is known, returns a dictionary with keys ``type``, ``url``, and ``metadata``. * ``metadata_fetcher_add(name, version, metadata)`` which adds a new metadata fetcher to the storage. * ``metadata_fetcher_get(name, version)`` which looks up a known fetcher (there is at most one) and if it is known, returns a dictionary with keys ``name``, ``version``, and ``metadata``. These `metadata` fields contain JSON-encodable dictionaries with information about the authority/fetcher, in a format specific to each authority/fetcher. With authority, the `metadata` field is reserved for information describing and qualifying the authority. With fetchers, the `metadata` field is reserved for configuration metadata and other technical usage. Origin metadata ^^^^^^^^^^^^^^^ Extrinsic metadata are stored in SWH's :term:`storage database`. The storage API offers three endpoints to manipulate origin metadata: * Adding metadata:: origin_metadata_add(origin_url, discovery_date, authority, fetcher, format, metadata) which adds a new `metadata` byte string obtained from a given authority and associated to the origin. `discovery_date` is a Python datetime. `authority` must be a dict containing keys `type` and `url`, and `fetcher` a dict containing keys `name` and `version`. The authority and fetcher must be known to the storage before using this endpoint. `format` is a text field indicating the format of the content of the `metadata` byte string. * Getting latest metadata:: origin_metadata_get_latest(origin_url, authority) where `authority` must be a dict containing keys `type` and `url`, which returns a dictionary corresponding to the latest metadata entry added from this origin, in the format:: { + 'origin_url': ..., 'authority': {'type': ..., 'url': ...}, 'fetcher': {'name': ..., 'version': ...}, 'discovery_date': ..., 'format': '...', 'metadata': b'...' } * Getting all metadata:: origin_metadata_get(origin_url, authority, after, limit) which returns a list of dictionaries, one for each metadata item deposited, corresponding to the given origin and obtained from the specified authority. `authority` must be a dict containing keys `type` and `url`. Each of these dictionaries is in the following format:: { 'authority': {'type': ..., 'url': ...}, 'fetcher': {'name': ..., 'version': ...}, 'discovery_date': ..., 'format': '...', 'metadata': b'...' } The parameters ``after`` and ``limit`` are used for pagination based on the order defined by the ``discovery_date``. ``metadata`` is a bytes array (eventually encoded using Base64). Its format is specific to each authority; and is treated as an opaque value by the storage. Unifying these various formats into a common language is outside the scope of this specification. diff --git a/sql/upgrades/149.sql b/sql/upgrades/149.sql new file mode 100644 index 00000000..b95a765a --- /dev/null +++ b/sql/upgrades/149.sql @@ -0,0 +1,105 @@ +-- SWH DB schema upgrade +-- from_version: 148 +-- to_version: 149 +-- description: Implement extrinsic origin-metadata specification + +-- latest schema version +insert into dbversion(version, release, description) + values(149, now(), 'Work In Progress'); + +-- metadata_fetcher + +alter table tool + rename to metadata_fetcher; +comment on table metadata_fetcher is 'Tools used to retrieve metadata'; + +alter table metadata_fetcher + rename column configuration to metadata; + +comment on column metadata_fetcher.id is 'Internal identifier of the fetcher'; +comment on column metadata_fetcher.name is 'Fetcher name'; +comment on column metadata_fetcher.version is 'Fetcher version'; +comment on column metadata_fetcher.metadata is 'Extra information about the fetcher'; + +alter index tool_pkey + rename to metadata_fetcher_pkey; +create unique index metadata_fetcher_name_version + on metadata_fetcher(name, version); + +drop index tool_tool_name_tool_version_tool_configuration_idx; + -- was an index on (name, version, configuration) + -- this is the name in production; in new setups it would be called tool_name_version_configuration_idx + -- drop index tool_name_version_configuration_idx; + +-- metadata_authority + +alter table metadata_provider + rename to metadata_authority; +comment on table metadata_authority is 'Metadata authority information'; + +drop index metadata_provider_provider_name_provider_url_idx; + -- was an index on (provider_name, provider_url) + +alter table metadata_authority + drop column provider_name; +alter table metadata_authority + rename column provider_type to type; +alter table metadata_authority + rename column provider_url to url; + +comment on column metadata_authority.id is 'Internal identifier of the authority'; +comment on column metadata_authority.type is 'Type of authority (deposit/forge/registry)'; +comment on column metadata_authority.url is 'Authority''s uri'; +comment on column metadata_authority.metadata is 'Other metadata about authority'; + +alter index metadata_provider_pkey + rename to metadata_authority_pkey; +alter index metadata_provider_type_url + rename to metadata_authority_type_url; + +-- origin_metadata + +alter table origin_metadata + rename column provider_id to authority_id; +alter table origin_metadata + rename column tool_id to fetcher_id; +alter table origin_metadata + add column format text default 'sword-v2-atom-codemeta-v2-in-json'; +alter table origin_metadata + rename column metadata to metadata_jsonb; +alter table origin_metadata + add column metadata bytea; + +-- migrates metadata_jsonb (a jsonb) to metadata (a bytea) +--update origin_metadata +-- set metadata=metadata_jsonb::text::bytea; +update origin_metadata + set metadata=convert_to(metadata_jsonb::text, 'utf-8'); + +create index origin_metadata_origin_authority_date + on origin_metadata(origin_id, authority_id, discovery_date); + +drop index origin_metadata_origin_id_provider_id_tool_id_idx; + -- was an index on (origin_id, provider_id, tool_id) + +alter table origin_metadata + drop column metadata_jsonb; + +comment on column origin_metadata.authority_id is 'the metadata provider: github, openhub, deposit, etc.'; +comment on column origin_metadata.fetcher_id is 'the tool used for extracting metadata: loaders, crawlers, etc.'; +comment on column origin_metadata.format is 'name of the format of metadata, used by readers to interpret it.'; +comment on column origin_metadata.metadata is 'original metadata in opaque format'; + + +-- cleanup unused functions + +drop function swh_mktemp_tool; +drop function swh_tool_add; + +drop function swh_origin_metadata_get_by_origin(text); +drop function swh_origin_metadata_get_by_provider_type(text, text); + +drop function swh_origin_metadata_get_by_origin(int); +drop function swh_origin_metadata_get_by_provider_type(int, text); + +drop type origin_metadata_signature; diff --git a/swh/storage/cassandra/cql.py b/swh/storage/cassandra/cql.py index 4d81f963..5b0b29a5 100644 --- a/swh/storage/cassandra/cql.py +++ b/swh/storage/cassandra/cql.py @@ -1,838 +1,904 @@ # Copyright (C) 2019-2020 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 datetime import functools import json import logging import random from typing import ( Any, Callable, Dict, Iterable, Iterator, List, Optional, Tuple, TypeVar, ) from cassandra import CoordinationFailure from cassandra.cluster import Cluster, EXEC_PROFILE_DEFAULT, ExecutionProfile, ResultSet from cassandra.policies import DCAwareRoundRobinPolicy, TokenAwarePolicy from cassandra.query import PreparedStatement, BoundStatement from tenacity import ( retry, stop_after_attempt, wait_random_exponential, retry_if_exception_type, ) from swh.model.model import ( Sha1Git, TimestampWithTimezone, Timestamp, Person, Content, SkippedContent, OriginVisit, OriginVisitStatus, Origin, ) from .common import Row, TOKEN_BEGIN, TOKEN_END, hash_url from .schema import CREATE_TABLES_QUERIES, HASH_ALGORITHMS logger = logging.getLogger(__name__) _execution_profiles = { EXEC_PROFILE_DEFAULT: ExecutionProfile( load_balancing_policy=TokenAwarePolicy(DCAwareRoundRobinPolicy()) ), } # Configuration for cassandra-driver's access to servers: # * hit the right server directly when sending a query (TokenAwarePolicy), # * if there's more than one, then pick one at random that's in the same # datacenter as the client (DCAwareRoundRobinPolicy) def create_keyspace( hosts: List[str], keyspace: str, port: int = 9042, *, durable_writes=True ): cluster = Cluster(hosts, port=port, execution_profiles=_execution_profiles) session = cluster.connect() extra_params = "" if not durable_writes: extra_params = "AND durable_writes = false" session.execute( """CREATE KEYSPACE IF NOT EXISTS "%s" WITH REPLICATION = { 'class' : 'SimpleStrategy', 'replication_factor' : 1 } %s; """ % (keyspace, extra_params) ) session.execute('USE "%s"' % keyspace) for query in CREATE_TABLES_QUERIES: session.execute(query) T = TypeVar("T") def _prepared_statement(query: str) -> Callable[[Callable[..., T]], Callable[..., T]]: """Returns a decorator usable on methods of CqlRunner, to inject them with a 'statement' argument, that is a prepared statement corresponding to the query. This only works on methods of CqlRunner, as preparing a statement requires a connection to a Cassandra server.""" def decorator(f): @functools.wraps(f) def newf(self, *args, **kwargs) -> T: if f.__name__ not in self._prepared_statements: statement: PreparedStatement = self._session.prepare(query) self._prepared_statements[f.__name__] = statement return f( self, *args, **kwargs, statement=self._prepared_statements[f.__name__] ) return newf return decorator def _prepared_insert_statement(table_name: str, columns: List[str]): """Shorthand for using `_prepared_statement` for `INSERT INTO` statements.""" return _prepared_statement( "INSERT INTO %s (%s) VALUES (%s)" % (table_name, ", ".join(columns), ", ".join("?" for _ in columns),) ) def _prepared_exists_statement(table_name: str): """Shorthand for using `_prepared_statement` for queries that only check which ids in a list exist in the table.""" return _prepared_statement(f"SELECT id FROM {table_name} WHERE id IN ?") class CqlRunner: """Class managing prepared statements and building queries to be sent to Cassandra.""" def __init__(self, hosts: List[str], keyspace: str, port: int): self._cluster = Cluster( hosts, port=port, execution_profiles=_execution_profiles ) self._session = self._cluster.connect(keyspace) self._cluster.register_user_type( keyspace, "microtimestamp_with_timezone", TimestampWithTimezone ) self._cluster.register_user_type(keyspace, "microtimestamp", Timestamp) self._cluster.register_user_type(keyspace, "person", Person) self._prepared_statements: Dict[str, PreparedStatement] = {} ########################## # Common utility functions ########################## MAX_RETRIES = 3 @retry( wait=wait_random_exponential(multiplier=1, max=10), stop=stop_after_attempt(MAX_RETRIES), retry=retry_if_exception_type(CoordinationFailure), ) def _execute_with_retries(self, statement, args) -> ResultSet: return self._session.execute(statement, args, timeout=1000.0) @_prepared_statement( "UPDATE object_count SET count = count + ? " "WHERE partition_key = 0 AND object_type = ?" ) def _increment_counter( self, object_type: str, nb: int, *, statement: PreparedStatement ) -> None: self._execute_with_retries(statement, [nb, object_type]) def _add_one(self, statement, object_type: str, obj, keys: List[str]) -> None: self._increment_counter(object_type, 1) self._execute_with_retries(statement, [getattr(obj, key) for key in keys]) def _get_random_row(self, statement) -> Optional[Row]: """Takes a prepared statement of the form "SELECT * FROM WHERE token() > ? LIMIT 1" and uses it to return a random row""" token = random.randint(TOKEN_BEGIN, TOKEN_END) rows = self._execute_with_retries(statement, [token]) if not rows: # There are no row with a greater token; wrap around to get # the row with the smallest token rows = self._execute_with_retries(statement, [TOKEN_BEGIN]) if rows: return rows.one() else: return None def _missing(self, statement, ids): res = self._execute_with_retries(statement, [ids]) found_ids = {id_ for (id_,) in res} return [id_ for id_ in ids if id_ not in found_ids] ########################## # 'content' table ########################## _content_pk = ["sha1", "sha1_git", "sha256", "blake2s256"] _content_keys = [ "sha1", "sha1_git", "sha256", "blake2s256", "length", "ctime", "status", ] def _content_add_finalize(self, statement: BoundStatement) -> None: """Returned currified by content_add_prepare, to be called when the content row should be added to the primary table.""" self._execute_with_retries(statement, None) self._increment_counter("content", 1) @_prepared_insert_statement("content", _content_keys) def content_add_prepare( self, content, *, statement ) -> Tuple[int, Callable[[], None]]: """Prepares insertion of a Content to the main 'content' table. Returns a token (to be used in secondary tables), and a function to be called to perform the insertion in the main table.""" statement = statement.bind( [getattr(content, key) for key in self._content_keys] ) # Type used for hashing keys (usually, it will be # cassandra.metadata.Murmur3Token) token_class = self._cluster.metadata.token_map.token_class # Token of the row when it will be inserted. This is equivalent to # "SELECT token({', '.join(self._content_pk)}) FROM content WHERE ..." # after the row is inserted; but we need the token to insert in the # index tables *before* inserting to the main 'content' table token = token_class.from_key(statement.routing_key).value assert TOKEN_BEGIN <= token <= TOKEN_END # Function to be called after the indexes contain their respective # row finalizer = functools.partial(self._content_add_finalize, statement) return (token, finalizer) @_prepared_statement( "SELECT * FROM content WHERE " + " AND ".join(map("%s = ?".__mod__, HASH_ALGORITHMS)) ) def content_get_from_pk( self, content_hashes: Dict[str, bytes], *, statement ) -> Optional[Row]: rows = list( self._execute_with_retries( statement, [content_hashes[algo] for algo in HASH_ALGORITHMS] ) ) assert len(rows) <= 1 if rows: return rows[0] else: return None @_prepared_statement( "SELECT * FROM content WHERE token(" + ", ".join(_content_pk) + ") = ?" ) def content_get_from_token(self, token, *, statement) -> Iterable[Row]: return self._execute_with_retries(statement, [token]) @_prepared_statement( "SELECT * FROM content WHERE token(%s) > ? LIMIT 1" % ", ".join(_content_pk) ) def content_get_random(self, *, statement) -> Optional[Row]: return self._get_random_row(statement) @_prepared_statement( ( "SELECT token({0}) AS tok, {1} FROM content " "WHERE token({0}) >= ? AND token({0}) <= ? LIMIT ?" ).format(", ".join(_content_pk), ", ".join(_content_keys)) ) def content_get_token_range( self, start: int, end: int, limit: int, *, statement ) -> Row: return self._execute_with_retries(statement, [start, end, limit]) ########################## # 'content_by_*' tables ########################## @_prepared_statement( "SELECT sha1_git FROM content_by_sha1_git " "WHERE sha1_git IN ?" ) def content_missing_by_sha1_git( self, ids: List[bytes], *, statement ) -> List[bytes]: return self._missing(statement, ids) def content_index_add_one(self, algo: str, content: Content, token: int) -> None: """Adds a row mapping content[algo] to the token of the Content in the main 'content' table.""" query = ( f"INSERT INTO content_by_{algo} ({algo}, target_token) " f"VALUES (%s, %s)" ) self._execute_with_retries(query, [content.get_hash(algo), token]) def content_get_tokens_from_single_hash( self, algo: str, hash_: bytes ) -> Iterable[int]: assert algo in HASH_ALGORITHMS query = f"SELECT target_token FROM content_by_{algo} WHERE {algo} = %s" return (tok for (tok,) in self._execute_with_retries(query, [hash_])) ########################## # 'skipped_content' table ########################## _skipped_content_pk = ["sha1", "sha1_git", "sha256", "blake2s256"] _skipped_content_keys = [ "sha1", "sha1_git", "sha256", "blake2s256", "length", "ctime", "status", "reason", "origin", ] _magic_null_pk = b"" """ NULLs (or all-empty blobs) are not allowed in primary keys; instead use a special value that can't possibly be a valid hash. """ def _skipped_content_add_finalize(self, statement: BoundStatement) -> None: """Returned currified by skipped_content_add_prepare, to be called when the content row should be added to the primary table.""" self._execute_with_retries(statement, None) self._increment_counter("skipped_content", 1) @_prepared_insert_statement("skipped_content", _skipped_content_keys) def skipped_content_add_prepare( self, content, *, statement ) -> Tuple[int, Callable[[], None]]: """Prepares insertion of a Content to the main 'skipped_content' table. Returns a token (to be used in secondary tables), and a function to be called to perform the insertion in the main table.""" # Replace NULLs (which are not allowed in the partition key) with # an empty byte string content = content.to_dict() for key in self._skipped_content_pk: if content[key] is None: content[key] = self._magic_null_pk statement = statement.bind( [content.get(key) for key in self._skipped_content_keys] ) # Type used for hashing keys (usually, it will be # cassandra.metadata.Murmur3Token) token_class = self._cluster.metadata.token_map.token_class # Token of the row when it will be inserted. This is equivalent to # "SELECT token({', '.join(self._content_pk)}) # FROM skipped_content WHERE ..." # after the row is inserted; but we need the token to insert in the # index tables *before* inserting to the main 'skipped_content' table token = token_class.from_key(statement.routing_key).value assert TOKEN_BEGIN <= token <= TOKEN_END # Function to be called after the indexes contain their respective # row finalizer = functools.partial(self._skipped_content_add_finalize, statement) return (token, finalizer) @_prepared_statement( "SELECT * FROM skipped_content WHERE " + " AND ".join(map("%s = ?".__mod__, HASH_ALGORITHMS)) ) def skipped_content_get_from_pk( self, content_hashes: Dict[str, bytes], *, statement ) -> Optional[Row]: rows = list( self._execute_with_retries( statement, [ content_hashes[algo] or self._magic_null_pk for algo in HASH_ALGORITHMS ], ) ) assert len(rows) <= 1 if rows: # TODO: convert _magic_null_pk back to None? return rows[0] else: return None ########################## # 'skipped_content_by_*' tables ########################## def skipped_content_index_add_one( self, algo: str, content: SkippedContent, token: int ) -> None: """Adds a row mapping content[algo] to the token of the SkippedContent in the main 'skipped_content' table.""" query = ( f"INSERT INTO skipped_content_by_{algo} ({algo}, target_token) " f"VALUES (%s, %s)" ) self._execute_with_retries( query, [content.get_hash(algo) or self._magic_null_pk, token] ) ########################## # 'revision' table ########################## _revision_keys = [ "id", "date", "committer_date", "type", "directory", "message", "author", "committer", "synthetic", "metadata", ] @_prepared_exists_statement("revision") def revision_missing(self, ids: List[bytes], *, statement) -> List[bytes]: return self._missing(statement, ids) @_prepared_insert_statement("revision", _revision_keys) def revision_add_one(self, revision: Dict[str, Any], *, statement) -> None: self._execute_with_retries( statement, [revision[key] for key in self._revision_keys] ) self._increment_counter("revision", 1) @_prepared_statement("SELECT id FROM revision WHERE id IN ?") def revision_get_ids(self, revision_ids, *, statement) -> ResultSet: return self._execute_with_retries(statement, [revision_ids]) @_prepared_statement("SELECT * FROM revision WHERE id IN ?") def revision_get(self, revision_ids, *, statement) -> ResultSet: return self._execute_with_retries(statement, [revision_ids]) @_prepared_statement("SELECT * FROM revision WHERE token(id) > ? LIMIT 1") def revision_get_random(self, *, statement) -> Optional[Row]: return self._get_random_row(statement) ########################## # 'revision_parent' table ########################## _revision_parent_keys = ["id", "parent_rank", "parent_id"] @_prepared_insert_statement("revision_parent", _revision_parent_keys) def revision_parent_add_one( self, id_: Sha1Git, parent_rank: int, parent_id: Sha1Git, *, statement ) -> None: self._execute_with_retries(statement, [id_, parent_rank, parent_id]) @_prepared_statement("SELECT parent_id FROM revision_parent WHERE id = ?") def revision_parent_get(self, revision_id: Sha1Git, *, statement) -> ResultSet: return self._execute_with_retries(statement, [revision_id]) ########################## # 'release' table ########################## _release_keys = [ "id", "target", "target_type", "date", "name", "message", "author", "synthetic", ] @_prepared_exists_statement("release") def release_missing(self, ids: List[bytes], *, statement) -> List[bytes]: return self._missing(statement, ids) @_prepared_insert_statement("release", _release_keys) def release_add_one(self, release: Dict[str, Any], *, statement) -> None: self._execute_with_retries( statement, [release[key] for key in self._release_keys] ) self._increment_counter("release", 1) @_prepared_statement("SELECT * FROM release WHERE id in ?") def release_get(self, release_ids: List[str], *, statement) -> None: return self._execute_with_retries(statement, [release_ids]) @_prepared_statement("SELECT * FROM release WHERE token(id) > ? LIMIT 1") def release_get_random(self, *, statement) -> Optional[Row]: return self._get_random_row(statement) ########################## # 'directory' table ########################## _directory_keys = ["id"] @_prepared_exists_statement("directory") def directory_missing(self, ids: List[bytes], *, statement) -> List[bytes]: return self._missing(statement, ids) @_prepared_insert_statement("directory", _directory_keys) def directory_add_one(self, directory_id: Sha1Git, *, statement) -> None: """Called after all calls to directory_entry_add_one, to commit/finalize the directory.""" self._execute_with_retries(statement, [directory_id]) self._increment_counter("directory", 1) @_prepared_statement("SELECT * FROM directory WHERE token(id) > ? LIMIT 1") def directory_get_random(self, *, statement) -> Optional[Row]: return self._get_random_row(statement) ########################## # 'directory_entry' table ########################## _directory_entry_keys = ["directory_id", "name", "type", "target", "perms"] @_prepared_insert_statement("directory_entry", _directory_entry_keys) def directory_entry_add_one(self, entry: Dict[str, Any], *, statement) -> None: self._execute_with_retries( statement, [entry[key] for key in self._directory_entry_keys] ) @_prepared_statement("SELECT * FROM directory_entry " "WHERE directory_id IN ?") def directory_entry_get(self, directory_ids, *, statement) -> ResultSet: return self._execute_with_retries(statement, [directory_ids]) ########################## # 'snapshot' table ########################## _snapshot_keys = ["id"] @_prepared_exists_statement("snapshot") def snapshot_missing(self, ids: List[bytes], *, statement) -> List[bytes]: return self._missing(statement, ids) @_prepared_insert_statement("snapshot", _snapshot_keys) def snapshot_add_one(self, snapshot_id: Sha1Git, *, statement) -> None: self._execute_with_retries(statement, [snapshot_id]) self._increment_counter("snapshot", 1) @_prepared_statement("SELECT * FROM snapshot " "WHERE id = ?") def snapshot_get(self, snapshot_id: Sha1Git, *, statement) -> ResultSet: return self._execute_with_retries(statement, [snapshot_id]) @_prepared_statement("SELECT * FROM snapshot WHERE token(id) > ? LIMIT 1") def snapshot_get_random(self, *, statement) -> Optional[Row]: return self._get_random_row(statement) ########################## # 'snapshot_branch' table ########################## _snapshot_branch_keys = ["snapshot_id", "name", "target_type", "target"] @_prepared_insert_statement("snapshot_branch", _snapshot_branch_keys) def snapshot_branch_add_one(self, branch: Dict[str, Any], *, statement) -> None: self._execute_with_retries( statement, [branch[key] for key in self._snapshot_branch_keys] ) @_prepared_statement( "SELECT ascii_bins_count(target_type) AS counts " "FROM snapshot_branch " "WHERE snapshot_id = ? " ) def snapshot_count_branches(self, snapshot_id: Sha1Git, *, statement) -> ResultSet: return self._execute_with_retries(statement, [snapshot_id]) @_prepared_statement( "SELECT * FROM snapshot_branch " "WHERE snapshot_id = ? AND name >= ?" "LIMIT ?" ) def snapshot_branch_get( self, snapshot_id: Sha1Git, from_: bytes, limit: int, *, statement ) -> None: return self._execute_with_retries(statement, [snapshot_id, from_, limit]) ########################## # 'origin' table ########################## origin_keys = ["sha1", "url", "type", "next_visit_id"] @_prepared_statement( "INSERT INTO origin (sha1, url, next_visit_id) " "VALUES (?, ?, 1) IF NOT EXISTS" ) def origin_add_one(self, origin: Origin, *, statement) -> None: self._execute_with_retries(statement, [hash_url(origin.url), origin.url]) self._increment_counter("origin", 1) @_prepared_statement("SELECT * FROM origin WHERE sha1 = ?") def origin_get_by_sha1(self, sha1: bytes, *, statement) -> ResultSet: return self._execute_with_retries(statement, [sha1]) def origin_get_by_url(self, url: str) -> ResultSet: return self.origin_get_by_sha1(hash_url(url)) @_prepared_statement( f'SELECT token(sha1) AS tok, {", ".join(origin_keys)} ' f"FROM origin WHERE token(sha1) >= ? LIMIT ?" ) def origin_list(self, start_token: int, limit: int, *, statement) -> ResultSet: return self._execute_with_retries(statement, [start_token, limit]) @_prepared_statement("SELECT * FROM origin") def origin_iter_all(self, *, statement) -> ResultSet: return self._execute_with_retries(statement, []) @_prepared_statement("SELECT next_visit_id FROM origin WHERE sha1 = ?") def _origin_get_next_visit_id(self, origin_sha1: bytes, *, statement) -> int: rows = list(self._execute_with_retries(statement, [origin_sha1])) assert len(rows) == 1 # TODO: error handling return rows[0].next_visit_id @_prepared_statement( "UPDATE origin SET next_visit_id=? " "WHERE sha1 = ? IF next_visit_id=?" ) def origin_generate_unique_visit_id(self, origin_url: str, *, statement) -> int: origin_sha1 = hash_url(origin_url) next_id = self._origin_get_next_visit_id(origin_sha1) while True: res = list( self._execute_with_retries( statement, [next_id + 1, origin_sha1, next_id] ) ) assert len(res) == 1 if res[0].applied: # No data race return next_id else: # Someone else updated it before we did, let's try again next_id = res[0].next_visit_id # TODO: abort after too many attempts return next_id ########################## # 'origin_visit' table ########################## _origin_visit_keys = [ "origin", "visit", "type", "date", "status", "metadata", "snapshot", ] _origin_visit_update_keys = ["type", "date", "status", "metadata", "snapshot"] @_prepared_statement("SELECT * FROM origin_visit " "WHERE origin = ? AND visit > ?") def _origin_visit_get_no_limit( self, origin_url: str, last_visit: int, *, statement ) -> ResultSet: return self._execute_with_retries(statement, [origin_url, last_visit]) @_prepared_statement( "SELECT * FROM origin_visit " "WHERE origin = ? AND visit > ? LIMIT ?" ) def _origin_visit_get_limit( self, origin_url: str, last_visit: int, limit: int, *, statement ) -> ResultSet: return self._execute_with_retries(statement, [origin_url, last_visit, limit]) def origin_visit_get( self, origin_url: str, last_visit: Optional[int], limit: Optional[int] ) -> ResultSet: if last_visit is None: last_visit = -1 if limit is None: return self._origin_visit_get_no_limit(origin_url, last_visit) else: return self._origin_visit_get_limit(origin_url, last_visit, limit) @_prepared_insert_statement("origin_visit", _origin_visit_keys) def origin_visit_add_one(self, visit: OriginVisit, *, statement) -> None: self._add_one(statement, "origin_visit", visit, self._origin_visit_keys) _origin_visit_status_keys = [ "origin", "visit", "date", "status", "snapshot", "metadata", ] @_prepared_insert_statement("origin_visit_status", _origin_visit_status_keys) def origin_visit_status_add_one( self, visit_update: OriginVisitStatus, *, statement ) -> None: assert self._origin_visit_status_keys[-1] == "metadata" keys = self._origin_visit_status_keys metadata = json.dumps(visit_update.metadata) self._execute_with_retries( statement, [getattr(visit_update, key) for key in keys[:-1]] + [metadata] ) def _format_origin_visit_status_row( self, visit_status: ResultSet ) -> Dict[str, Any]: """Format a row visit_status into an origin_visit_status dict """ return { **visit_status._asdict(), "origin": visit_status.origin, "date": visit_status.date.replace(tzinfo=datetime.timezone.utc), "metadata": ( json.loads(visit_status.metadata) if visit_status.metadata else None ), } @_prepared_statement( "SELECT * FROM origin_visit_status " "WHERE origin = ? AND visit = ? " "ORDER BY date DESC " "LIMIT 1" ) def origin_visit_status_get_latest( self, origin: str, visit: int, *, statement ) -> Optional[Dict[str, Any]]: """Given an origin visit id, return its latest origin_visit_status """ rows = list(self._execute_with_retries(statement, [origin, visit])) if rows: return self._format_origin_visit_status_row(rows[0]) else: return None @_prepared_statement( "UPDATE origin_visit SET " + ", ".join("%s = ?" % key for key in _origin_visit_update_keys) + " WHERE origin = ? AND visit = ?" ) def origin_visit_upsert(self, visit: OriginVisit, *, statement) -> None: args: List[Any] = [] for column in self._origin_visit_update_keys: if column == "metadata": args.append(json.dumps(visit.metadata)) else: args.append(getattr(visit, column)) self._execute_with_retries(statement, args + [visit.origin, visit.visit]) # TODO: check if there is already one self._increment_counter("origin_visit", 1) @_prepared_statement("SELECT * FROM origin_visit " "WHERE origin = ? AND visit = ?") def origin_visit_get_one( self, origin_url: str, visit_id: int, *, statement ) -> Optional[Row]: # TODO: error handling rows = list(self._execute_with_retries(statement, [origin_url, visit_id])) if rows: return rows[0] else: return None @_prepared_statement("SELECT * FROM origin_visit " "WHERE origin = ?") def origin_visit_get_all(self, origin_url: str, *, statement) -> ResultSet: return self._execute_with_retries(statement, [origin_url]) @_prepared_statement("SELECT * FROM origin_visit WHERE token(origin) >= ?") def _origin_visit_iter_from(self, min_token: int, *, statement) -> Iterator[Row]: yield from self._execute_with_retries(statement, [min_token]) @_prepared_statement("SELECT * FROM origin_visit WHERE token(origin) < ?") def _origin_visit_iter_to(self, max_token: int, *, statement) -> Iterator[Row]: yield from self._execute_with_retries(statement, [max_token]) def origin_visit_iter(self, start_token: int) -> Iterator[Row]: """Returns all origin visits in order from this token, and wraps around the token space.""" yield from self._origin_visit_iter_from(start_token) yield from self._origin_visit_iter_to(start_token) ########################## - # 'tool' table + # 'metadata_authority' table ########################## - _tool_keys = ["id", "name", "version", "configuration"] + _metadata_authority_keys = ["url", "type", "metadata"] - @_prepared_insert_statement("tool_by_uuid", _tool_keys) - def tool_by_uuid_add_one(self, tool: Dict[str, Any], *, statement) -> None: - self._execute_with_retries(statement, [tool[key] for key in self._tool_keys]) + @_prepared_insert_statement("metadata_authority", _metadata_authority_keys) + def metadata_authority_add(self, url, type, metadata, *, statement): + return self._execute_with_retries(statement, [url, type, metadata]) - @_prepared_insert_statement("tool", _tool_keys) - def tool_add_one(self, tool: Dict[str, Any], *, statement) -> None: - self._execute_with_retries(statement, [tool[key] for key in self._tool_keys]) - self._increment_counter("tool", 1) + @_prepared_statement("SELECT * from metadata_authority WHERE type = ? AND url = ?") + def metadata_authority_get(self, type, url, *, statement) -> Optional[Row]: + return next(iter(self._execute_with_retries(statement, [type, url])), None) + + ########################## + # 'metadata_fetcher' table + ########################## + + _metadata_fetcher_keys = ["name", "version", "metadata"] + + @_prepared_insert_statement("metadata_fetcher", _metadata_fetcher_keys) + def metadata_fetcher_add(self, name, version, metadata, *, statement): + return self._execute_with_retries(statement, [name, version, metadata]) @_prepared_statement( - "SELECT id FROM tool " "WHERE name = ? AND version = ? " "AND configuration = ?" + "SELECT * from metadata_fetcher WHERE name = ? AND version = ?" ) - def tool_get_one_uuid( - self, name: str, version: str, configuration: Dict[str, Any], *, statement - ) -> Optional[str]: - rows = list( - self._execute_with_retries(statement, [name, version, configuration]) + def metadata_fetcher_get(self, name, version, *, statement) -> Optional[Row]: + return next(iter(self._execute_with_retries(statement, [name, version])), None) + + ########################## + # 'origin_metadata' table + ########################## + + _origin_metadata_keys = [ + "origin", + "authority_type", + "authority_url", + "discovery_date", + "fetcher_name", + "fetcher_version", + "format", + "metadata", + ] + + @_prepared_insert_statement("origin_metadata", _origin_metadata_keys) + def origin_metadata_add( + self, + origin, + authority_type, + authority_url, + discovery_date, + fetcher_name, + fetcher_version, + format, + metadata, + *, + statement, + ): + return self._execute_with_retries( + statement, + [ + origin, + authority_type, + authority_url, + discovery_date, + fetcher_name, + fetcher_version, + format, + metadata, + ], + ) + + @_prepared_statement( + "SELECT * from origin_metadata " + "WHERE origin=? AND authority_url=? AND discovery_date>=? " + "AND authority_type=?" + ) + def origin_metadata_get_after( + self, origin, authority_type, authority_url, after, *, statement + ): + return self._execute_with_retries( + statement, [origin, authority_url, after, authority_type] + ) + + @_prepared_statement( + "SELECT * from origin_metadata " + "WHERE origin=? AND authority_url=? AND authority_type=?" + ) + def origin_metadata_get( + self, origin, authority_type, authority_url, *, statement + ) -> Iterable[Row]: + return self._execute_with_retries( + statement, [origin, authority_url, authority_type] ) - if rows: - assert len(rows) == 1 - return rows[0].id - else: - return None ########################## # Miscellaneous ########################## @_prepared_statement("SELECT uuid() FROM revision LIMIT 1;") def check_read(self, *, statement): self._execute_with_retries(statement, []) @_prepared_statement( "SELECT object_type, count FROM object_count " "WHERE partition_key=0" ) def stat_counters(self, *, statement) -> ResultSet: return self._execute_with_retries(statement, []) diff --git a/swh/storage/cassandra/schema.py b/swh/storage/cassandra/schema.py index e50f7426..d2f69dbc 100644 --- a/swh/storage/cassandra/schema.py +++ b/swh/storage/cassandra/schema.py @@ -1,240 +1,257 @@ # Copyright (C) 2019-2020 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 CREATE_TABLES_QUERIES = """ CREATE OR REPLACE FUNCTION ascii_bins_count_sfunc ( state tuple>, -- (nb_none, map) bin_name ascii ) CALLED ON NULL INPUT RETURNS tuple> LANGUAGE java AS $$ if (bin_name == null) { state.setInt(0, state.getInt(0) + 1); } else { Map counters = state.getMap( 1, String.class, Integer.class); Integer nb = counters.get(bin_name); if (nb == null) { nb = 0; } counters.put(bin_name, nb + 1); state.setMap(1, counters, String.class, Integer.class); } return state; $$ ; CREATE OR REPLACE AGGREGATE ascii_bins_count ( ascii ) SFUNC ascii_bins_count_sfunc STYPE tuple> INITCOND (0, {}) ; CREATE TYPE IF NOT EXISTS microtimestamp ( seconds bigint, microseconds int ); CREATE TYPE IF NOT EXISTS microtimestamp_with_timezone ( timestamp frozen, offset smallint, negative_utc boolean ); CREATE TYPE IF NOT EXISTS person ( fullname blob, name blob, email blob ); CREATE TABLE IF NOT EXISTS content ( sha1 blob, sha1_git blob, sha256 blob, blake2s256 blob, length bigint, ctime timestamp, -- creation time, i.e. time of (first) injection into the storage status ascii, PRIMARY KEY ((sha1, sha1_git, sha256, blake2s256)) ); CREATE TABLE IF NOT EXISTS skipped_content ( sha1 blob, sha1_git blob, sha256 blob, blake2s256 blob, length bigint, ctime timestamp, -- creation time, i.e. time of (first) injection into the storage status ascii, reason text, origin text, PRIMARY KEY ((sha1, sha1_git, sha256, blake2s256)) ); CREATE TABLE IF NOT EXISTS revision ( id blob PRIMARY KEY, date microtimestamp_with_timezone, committer_date microtimestamp_with_timezone, type ascii, directory blob, -- source code "root" directory message blob, author person, committer person, synthetic boolean, -- true iff revision has been created by Software Heritage metadata text -- extra metadata as JSON(tarball checksums, -- extra commit information, etc...) ); CREATE TABLE IF NOT EXISTS revision_parent ( id blob, parent_rank int, -- parent position in merge commits, 0-based parent_id blob, PRIMARY KEY ((id), parent_rank) ); CREATE TABLE IF NOT EXISTS release ( id blob PRIMARY KEY, target_type ascii, target blob, date microtimestamp_with_timezone, name blob, message blob, author person, synthetic boolean, -- true iff release has been created by Software Heritage ); CREATE TABLE IF NOT EXISTS directory ( id blob PRIMARY KEY, ); CREATE TABLE IF NOT EXISTS directory_entry ( directory_id blob, name blob, -- path name, relative to containing dir target blob, perms int, -- unix-like permissions type ascii, -- target type PRIMARY KEY ((directory_id), name) ); CREATE TABLE IF NOT EXISTS snapshot ( id blob PRIMARY KEY, ); -- For a given snapshot_id, branches are sorted by their name, -- allowing easy pagination. CREATE TABLE IF NOT EXISTS snapshot_branch ( snapshot_id blob, name blob, target_type ascii, target blob, PRIMARY KEY ((snapshot_id), name) ); CREATE TABLE IF NOT EXISTS origin_visit ( origin text, visit bigint, date timestamp, type text, status ascii, metadata text, snapshot blob, PRIMARY KEY ((origin), visit) ); CREATE TABLE IF NOT EXISTS origin_visit_status ( origin text, visit bigint, date timestamp, status ascii, metadata text, snapshot blob, PRIMARY KEY ((origin), visit, date) ); CREATE TABLE IF NOT EXISTS origin ( sha1 blob PRIMARY KEY, url text, type text, next_visit_id int, -- We need integer visit ids for compatibility with the pgsql -- storage, so we're using lightweight transactions with this trick: -- https://stackoverflow.com/a/29391877/539465 ); -CREATE TABLE IF NOT EXISTS tool_by_uuid ( - id timeuuid PRIMARY KEY, - name ascii, - version ascii, - configuration blob, +CREATE TABLE IF NOT EXISTS metadata_authority ( + url text, + type ascii, + metadata text, + PRIMARY KEY ((url), type) ); -CREATE TABLE IF NOT EXISTS tool ( - id timeuuid, +CREATE TABLE IF NOT EXISTS metadata_fetcher ( name ascii, version ascii, - configuration blob, - PRIMARY KEY ((name, version, configuration)) -) + metadata text, + PRIMARY KEY ((name), version) +); + + +CREATE TABLE IF NOT EXISTS origin_metadata ( + origin text, + authority_type text, + authority_url text, + discovery_date timestamp, + fetcher_name ascii, + fetcher_version ascii, + format ascii, + metadata blob, + PRIMARY KEY ((origin), authority_type, authority_url, discovery_date, + fetcher_name, fetcher_version), + -- for now, authority_url could be in the partition key; but leaving + -- in the partition key allows listing authorities with metadata on an + -- origin if we ever need to do it. +); CREATE TABLE IF NOT EXISTS object_count ( partition_key smallint, -- Constant, must always be 0 object_type ascii, count counter, PRIMARY KEY ((partition_key), object_type) ); """.split( "\n\n" ) CONTENT_INDEX_TEMPLATE = """ -- Secondary table, used for looking up "content" from a single hash CREATE TABLE IF NOT EXISTS content_by_{main_algo} ( {main_algo} blob, target_token bigint, -- value of token(pk) on the "primary" table PRIMARY KEY (({main_algo}), target_token) ); CREATE TABLE IF NOT EXISTS skipped_content_by_{main_algo} ( {main_algo} blob, target_token bigint, -- value of token(pk) on the "primary" table PRIMARY KEY (({main_algo}), target_token) ); """ TABLES = ( "skipped_content content revision revision_parent release " "directory directory_entry snapshot snapshot_branch " - "origin_visit origin tool_by_uuid tool object_count " - "origin_visit_status" + "origin_visit origin origin_metadata object_count " + "origin_visit_status metadata_authority " + "metadata_fetcher" ).split() HASH_ALGORITHMS = ["sha1", "sha1_git", "sha256", "blake2s256"] for main_algo in HASH_ALGORITHMS: CREATE_TABLES_QUERIES.extend( CONTENT_INDEX_TEMPLATE.format( main_algo=main_algo, other_algos=", ".join( [algo for algo in HASH_ALGORITHMS if algo != main_algo] ), ).split("\n\n") ) TABLES.append("content_by_%s" % main_algo) TABLES.append("skipped_content_by_%s" % main_algo) diff --git a/swh/storage/cassandra/storage.py b/swh/storage/cassandra/storage.py index 725ce7e1..5e5bfe79 100644 --- a/swh/storage/cassandra/storage.py +++ b/swh/storage/cassandra/storage.py @@ -1,1116 +1,1167 @@ # Copyright (C) 2019-2020 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 datetime +import itertools import json import random import re from typing import Any, Dict, List, Iterable, Optional, Union -import uuid import attr import dateutil from swh.model.model import ( Revision, Release, Directory, DirectoryEntry, Content, SkippedContent, OriginVisit, OriginVisitStatus, Snapshot, Origin, ) from swh.model.hashutil import DEFAULT_ALGORITHMS from swh.storage.objstorage import ObjStorage from swh.storage.writer import JournalWriter from swh.storage.validate import convert_validation_exceptions from swh.storage.utils import now from ..exc import StorageArgumentException, HashCollision from .common import TOKEN_BEGIN, TOKEN_END from .converters import ( revision_to_db, revision_from_db, release_to_db, release_from_db, ) from .cql import CqlRunner from .schema import HASH_ALGORITHMS # Max block size of contents to return BULK_BLOCK_CONTENT_LEN_MAX = 10000 class CassandraStorage: def __init__(self, hosts, keyspace, objstorage, port=9042, journal_writer=None): self._cql_runner = CqlRunner(hosts, keyspace, port) self.journal_writer = JournalWriter(journal_writer) self.objstorage = ObjStorage(objstorage) def check_config(self, *, check_write): self._cql_runner.check_read() return True def _content_get_from_hash(self, algo, hash_) -> Iterable: """From the name of a hash algorithm and a value of that hash, looks up the "hash -> token" secondary table (content_by_{algo}) to get tokens. Then, looks up the main table (content) to get all contents with that token, and filters out contents whose hash doesn't match.""" found_tokens = self._cql_runner.content_get_tokens_from_single_hash(algo, hash_) for token in found_tokens: # Query the main table ('content'). res = self._cql_runner.content_get_from_token(token) for row in res: # re-check the the hash (in case of murmur3 collision) if getattr(row, algo) == hash_: yield row def _content_add(self, contents: List[Content], with_data: bool) -> Dict: # Filter-out content already in the database. contents = [ c for c in contents if not self._cql_runner.content_get_from_pk(c.to_dict()) ] self.journal_writer.content_add(contents) if with_data: # First insert to the objstorage, if the endpoint is # `content_add` (as opposed to `content_add_metadata`). # TODO: this should probably be done in concurrently to inserting # in index tables (but still before the main table; so an entry is # only added to the main table after everything else was # successfully inserted. summary = self.objstorage.content_add( c for c in contents if c.status != "absent" ) content_add_bytes = summary["content:add:bytes"] content_add = 0 for content in contents: content_add += 1 # Check for sha1 or sha1_git collisions. This test is not atomic # with the insertion, so it won't detect a collision if both # contents are inserted at the same time, but it's good enough. # # The proper way to do it would probably be a BATCH, but this # would be inefficient because of the number of partitions we # need to affect (len(HASH_ALGORITHMS)+1, which is currently 5) for algo in {"sha1", "sha1_git"}: collisions = [] # Get tokens of 'content' rows with the same value for # sha1/sha1_git rows = self._content_get_from_hash(algo, content.get_hash(algo)) for row in rows: if getattr(row, algo) != content.get_hash(algo): # collision of token(partition key), ignore this # row continue for algo in HASH_ALGORITHMS: if getattr(row, algo) != content.get_hash(algo): # This hash didn't match; discard the row. collisions.append( {algo: getattr(row, algo) for algo in HASH_ALGORITHMS} ) if collisions: collisions.append(content.hashes()) raise HashCollision(algo, content.get_hash(algo), collisions) (token, insertion_finalizer) = self._cql_runner.content_add_prepare(content) # Then add to index tables for algo in HASH_ALGORITHMS: self._cql_runner.content_index_add_one(algo, content, token) # Then to the main table insertion_finalizer() summary = { "content:add": content_add, } if with_data: summary["content:add:bytes"] = content_add_bytes return summary def content_add(self, content: Iterable[Content]) -> Dict: contents = [attr.evolve(c, ctime=now()) for c in content] return self._content_add(list(contents), with_data=True) def content_update(self, content, keys=[]): raise NotImplementedError( "content_update is not supported by the Cassandra backend" ) def content_add_metadata(self, content: Iterable[Content]) -> Dict: return self._content_add(list(content), with_data=False) def content_get(self, content): if len(content) > BULK_BLOCK_CONTENT_LEN_MAX: raise StorageArgumentException( "Sending at most %s contents." % BULK_BLOCK_CONTENT_LEN_MAX ) yield from self.objstorage.content_get(content) def content_get_partition( self, partition_id: int, nb_partitions: int, limit: int = 1000, page_token: str = None, ): if limit is None: raise StorageArgumentException("limit should not be None") # Compute start and end of the range of tokens covered by the # requested partition partition_size = (TOKEN_END - TOKEN_BEGIN) // nb_partitions range_start = TOKEN_BEGIN + partition_id * partition_size range_end = TOKEN_BEGIN + (partition_id + 1) * partition_size # offset the range start according to the `page_token`. if page_token is not None: if not (range_start <= int(page_token) <= range_end): raise StorageArgumentException("Invalid page_token.") range_start = int(page_token) # Get the first rows of the range rows = self._cql_runner.content_get_token_range(range_start, range_end, limit) rows = list(rows) if len(rows) == limit: next_page_token: Optional[str] = str(rows[-1].tok + 1) else: next_page_token = None return { "contents": [row._asdict() for row in rows if row.status != "absent"], "next_page_token": next_page_token, } def content_get_metadata(self, contents: List[bytes]) -> Dict[bytes, List[Dict]]: result: Dict[bytes, List[Dict]] = {sha1: [] for sha1 in contents} for sha1 in contents: # Get all (sha1, sha1_git, sha256, blake2s256) whose sha1 # matches the argument, from the index table ('content_by_sha1') for row in self._content_get_from_hash("sha1", sha1): content_metadata = row._asdict() content_metadata.pop("ctime") result[content_metadata["sha1"]].append(content_metadata) return result def content_find(self, content): # Find an algorithm that is common to all the requested contents. # It will be used to do an initial filtering efficiently. filter_algos = list(set(content).intersection(HASH_ALGORITHMS)) if not filter_algos: raise StorageArgumentException( "content keys must contain at least one of: " "%s" % ", ".join(sorted(HASH_ALGORITHMS)) ) common_algo = filter_algos[0] results = [] rows = self._content_get_from_hash(common_algo, content[common_algo]) for row in rows: # Re-check all the hashes, in case of collisions (either of the # hash of the partition key, or the hashes in it) for algo in HASH_ALGORITHMS: if content.get(algo) and getattr(row, algo) != content[algo]: # This hash didn't match; discard the row. break else: # All hashes match, keep this row. results.append( { **row._asdict(), "ctime": row.ctime.replace(tzinfo=datetime.timezone.utc), } ) return results def content_missing(self, content, key_hash="sha1"): for cont in content: res = self.content_find(cont) if not res: yield cont[key_hash] if any(c["status"] == "missing" for c in res): yield cont[key_hash] def content_missing_per_sha1(self, contents): return self.content_missing([{"sha1": c for c in contents}]) def content_missing_per_sha1_git(self, contents): return self.content_missing( [{"sha1_git": c for c in contents}], key_hash="sha1_git" ) def content_get_random(self): return self._cql_runner.content_get_random().sha1_git def _skipped_content_get_from_hash(self, algo, hash_) -> Iterable: """From the name of a hash algorithm and a value of that hash, looks up the "hash -> token" secondary table (skipped_content_by_{algo}) to get tokens. Then, looks up the main table (content) to get all contents with that token, and filters out contents whose hash doesn't match.""" found_tokens = self._cql_runner.skipped_content_get_tokens_from_single_hash( algo, hash_ ) for token in found_tokens: # Query the main table ('content'). res = self._cql_runner.skipped_content_get_from_token(token) for row in res: # re-check the the hash (in case of murmur3 collision) if getattr(row, algo) == hash_: yield row def _skipped_content_add(self, contents: Iterable[SkippedContent]) -> Dict: # Filter-out content already in the database. contents = [ c for c in contents if not self._cql_runner.skipped_content_get_from_pk(c.to_dict()) ] self.journal_writer.skipped_content_add(contents) for content in contents: # Compute token of the row in the main table (token, insertion_finalizer) = self._cql_runner.skipped_content_add_prepare( content ) # Then add to index tables for algo in HASH_ALGORITHMS: self._cql_runner.skipped_content_index_add_one(algo, content, token) # Then to the main table insertion_finalizer() return {"skipped_content:add": len(contents)} def skipped_content_add(self, content: Iterable[SkippedContent]) -> Dict: contents = [attr.evolve(c, ctime=now()) for c in content] return self._skipped_content_add(contents) def skipped_content_missing(self, contents): for content in contents: if not self._cql_runner.skipped_content_get_from_pk(content): yield {algo: content[algo] for algo in DEFAULT_ALGORITHMS} def directory_add(self, directories: Iterable[Directory]) -> Dict: directories = list(directories) # Filter out directories that are already inserted. missing = self.directory_missing([dir_.id for dir_ in directories]) directories = [dir_ for dir_ in directories if dir_.id in missing] self.journal_writer.directory_add(directories) for directory in directories: # Add directory entries to the 'directory_entry' table for entry in directory.entries: self._cql_runner.directory_entry_add_one( {**entry.to_dict(), "directory_id": directory.id} ) # Add the directory *after* adding all the entries, so someone # calling snapshot_get_branch in the meantime won't end up # with half the entries. self._cql_runner.directory_add_one(directory.id) return {"directory:add": len(missing)} def directory_missing(self, directories): return self._cql_runner.directory_missing(directories) def _join_dentry_to_content(self, dentry): keys = ( "status", "sha1", "sha1_git", "sha256", "length", ) ret = dict.fromkeys(keys) ret.update(dentry.to_dict()) if ret["type"] == "file": content = self.content_find({"sha1_git": ret["target"]}) if content: content = content[0] for key in keys: ret[key] = content[key] return ret def _directory_ls(self, directory_id, recursive, prefix=b""): if self.directory_missing([directory_id]): return rows = list(self._cql_runner.directory_entry_get([directory_id])) for row in rows: # Build and yield the directory entry dict entry = row._asdict() del entry["directory_id"] entry = DirectoryEntry.from_dict(entry) ret = self._join_dentry_to_content(entry) ret["name"] = prefix + ret["name"] ret["dir_id"] = directory_id yield ret if recursive and ret["type"] == "dir": yield from self._directory_ls( ret["target"], True, prefix + ret["name"] + b"/" ) def directory_entry_get_by_path(self, directory, paths): return self._directory_entry_get_by_path(directory, paths, b"") def _directory_entry_get_by_path(self, directory, paths, prefix): if not paths: return contents = list(self.directory_ls(directory)) if not contents: return def _get_entry(entries, name): """Finds the entry with the requested name, prepends the prefix (to get its full path), and returns it. If no entry has that name, returns None.""" for entry in entries: if entry["name"] == name: entry = entry.copy() entry["name"] = prefix + entry["name"] return entry first_item = _get_entry(contents, paths[0]) if len(paths) == 1: return first_item if not first_item or first_item["type"] != "dir": return return self._directory_entry_get_by_path( first_item["target"], paths[1:], prefix + paths[0] + b"/" ) def directory_ls(self, directory, recursive=False): yield from self._directory_ls(directory, recursive) def directory_get_random(self): return self._cql_runner.directory_get_random().id def revision_add(self, revisions: Iterable[Revision]) -> Dict: revisions = list(revisions) # Filter-out revisions already in the database missing = self.revision_missing([rev.id for rev in revisions]) revisions = [rev for rev in revisions if rev.id in missing] self.journal_writer.revision_add(revisions) for revision in revisions: revobject = revision_to_db(revision) if revobject: # Add parents first for (rank, parent) in enumerate(revobject["parents"]): self._cql_runner.revision_parent_add_one( revobject["id"], rank, parent ) # Then write the main revision row. # Writing this after all parents were written ensures that # read endpoints don't return a partial view while writing # the parents self._cql_runner.revision_add_one(revobject) return {"revision:add": len(revisions)} def revision_missing(self, revisions): return self._cql_runner.revision_missing(revisions) def revision_get(self, revisions): rows = self._cql_runner.revision_get(revisions) revs = {} for row in rows: # TODO: use a single query to get all parents? # (it might have lower latency, but requires more code and more # bandwidth, because revision id would be part of each returned # row) parent_rows = self._cql_runner.revision_parent_get(row.id) # parent_rank is the clustering key, so results are already # sorted by rank. parents = [row.parent_id for row in parent_rows] rev = revision_from_db(row, parents=parents) revs[rev.id] = rev.to_dict() for rev_id in revisions: yield revs.get(rev_id) def _get_parent_revs(self, rev_ids, seen, limit, short): if limit and len(seen) >= limit: return rev_ids = [id_ for id_ in rev_ids if id_ not in seen] if not rev_ids: return seen |= set(rev_ids) # We need this query, even if short=True, to return consistent # results (ie. not return only a subset of a revision's parents # if it is being written) if short: rows = self._cql_runner.revision_get_ids(rev_ids) else: rows = self._cql_runner.revision_get(rev_ids) for row in rows: # TODO: use a single query to get all parents? # (it might have less latency, but requires less code and more # bandwidth (because revision id would be part of each returned # row) parent_rows = self._cql_runner.revision_parent_get(row.id) # parent_rank is the clustering key, so results are already # sorted by rank. parents = [row.parent_id for row in parent_rows] if short: yield (row.id, parents) else: rev = revision_from_db(row, parents=parents) yield rev.to_dict() yield from self._get_parent_revs(parents, seen, limit, short) def revision_log(self, revisions, limit=None): seen = set() yield from self._get_parent_revs(revisions, seen, limit, False) def revision_shortlog(self, revisions, limit=None): seen = set() yield from self._get_parent_revs(revisions, seen, limit, True) def revision_get_random(self): return self._cql_runner.revision_get_random().id def release_add(self, releases: Iterable[Release]) -> Dict: missing = self.release_missing([rel.id for rel in releases]) releases = [rel for rel in releases if rel.id in missing] self.journal_writer.release_add(releases) for release in releases: if release: self._cql_runner.release_add_one(release_to_db(release)) return {"release:add": len(missing)} def release_missing(self, releases): return self._cql_runner.release_missing(releases) def release_get(self, releases): rows = self._cql_runner.release_get(releases) rels = {} for row in rows: release = release_from_db(row) rels[row.id] = release.to_dict() for rel_id in releases: yield rels.get(rel_id) def release_get_random(self): return self._cql_runner.release_get_random().id def snapshot_add(self, snapshots: Iterable[Snapshot]) -> Dict: missing = self._cql_runner.snapshot_missing([snp.id for snp in snapshots]) snapshots = [snp for snp in snapshots if snp.id in missing] for snapshot in snapshots: self.journal_writer.snapshot_add([snapshot]) # Add branches for (branch_name, branch) in snapshot.branches.items(): if branch is None: target_type = None target = None else: target_type = branch.target_type.value target = branch.target self._cql_runner.snapshot_branch_add_one( { "snapshot_id": snapshot.id, "name": branch_name, "target_type": target_type, "target": target, } ) # Add the snapshot *after* adding all the branches, so someone # calling snapshot_get_branch in the meantime won't end up # with half the branches. self._cql_runner.snapshot_add_one(snapshot.id) return {"snapshot:add": len(snapshots)} def snapshot_missing(self, snapshots): return self._cql_runner.snapshot_missing(snapshots) def snapshot_get(self, snapshot_id): return self.snapshot_get_branches(snapshot_id) def snapshot_get_by_origin_visit(self, origin, visit): try: visit = self.origin_visit_get_by(origin, visit) except IndexError: return None return self.snapshot_get(visit["snapshot"]) def snapshot_get_latest(self, origin, allowed_statuses=None): visit = self.origin_visit_get_latest( origin, allowed_statuses=allowed_statuses, require_snapshot=True ) if visit: assert visit["snapshot"] if self._cql_runner.snapshot_missing([visit["snapshot"]]): raise StorageArgumentException("Visit references unknown snapshot") return self.snapshot_get_branches(visit["snapshot"]) def snapshot_count_branches(self, snapshot_id): if self._cql_runner.snapshot_missing([snapshot_id]): # Makes sure we don't fetch branches for a snapshot that is # being added. return None rows = list(self._cql_runner.snapshot_count_branches(snapshot_id)) assert len(rows) == 1 (nb_none, counts) = rows[0].counts counts = dict(counts) if nb_none: counts[None] = nb_none return counts def snapshot_get_branches( self, snapshot_id, branches_from=b"", branches_count=1000, target_types=None ): if self._cql_runner.snapshot_missing([snapshot_id]): # Makes sure we don't fetch branches for a snapshot that is # being added. return None branches = [] while len(branches) < branches_count + 1: new_branches = list( self._cql_runner.snapshot_branch_get( snapshot_id, branches_from, branches_count + 1 ) ) if not new_branches: break branches_from = new_branches[-1].name new_branches_filtered = new_branches # Filter by target_type if target_types: new_branches_filtered = [ branch for branch in new_branches_filtered if branch.target is not None and branch.target_type in target_types ] branches.extend(new_branches_filtered) if len(new_branches) < branches_count + 1: break if len(branches) > branches_count: last_branch = branches.pop(-1).name else: last_branch = None branches = { branch.name: {"target": branch.target, "target_type": branch.target_type,} if branch.target else None for branch in branches } return { "id": snapshot_id, "branches": branches, "next_branch": last_branch, } def snapshot_get_random(self): return self._cql_runner.snapshot_get_random().id def object_find_by_sha1_git(self, ids): results = {id_: [] for id_ in ids} missing_ids = set(ids) # Mind the order, revision is the most likely one for a given ID, # so we check revisions first. queries = [ ("revision", self._cql_runner.revision_missing), ("release", self._cql_runner.release_missing), ("content", self._cql_runner.content_missing_by_sha1_git), ("directory", self._cql_runner.directory_missing), ] for (object_type, query_fn) in queries: found_ids = missing_ids - set(query_fn(missing_ids)) for sha1_git in found_ids: results[sha1_git].append( {"sha1_git": sha1_git, "type": object_type,} ) missing_ids.remove(sha1_git) if not missing_ids: # We found everything, skipping the next queries. break return results def origin_get(self, origins): if isinstance(origins, dict): # Old API return_single = True origins = [origins] else: return_single = False if any("id" in origin for origin in origins): raise StorageArgumentException("Origin ids are not supported.") results = [self.origin_get_one(origin) for origin in origins] if return_single: assert len(results) == 1 return results[0] else: return results def origin_get_one(self, origin: Dict[str, Any]) -> Optional[Dict[str, Any]]: if "id" in origin: raise StorageArgumentException("Origin ids are not supported.") if "url" not in origin: raise StorageArgumentException("Missing origin url") rows = self._cql_runner.origin_get_by_url(origin["url"]) rows = list(rows) if rows: assert len(rows) == 1 result = rows[0]._asdict() return { "url": result["url"], } else: return None def origin_get_by_sha1(self, sha1s): results = [] for sha1 in sha1s: rows = self._cql_runner.origin_get_by_sha1(sha1) if rows: results.append({"url": rows.one().url}) else: results.append(None) return results def origin_list(self, page_token: Optional[str] = None, limit: int = 100) -> dict: # Compute what token to begin the listing from start_token = TOKEN_BEGIN if page_token: start_token = int(page_token) if not (TOKEN_BEGIN <= start_token <= TOKEN_END): raise StorageArgumentException("Invalid page_token.") rows = self._cql_runner.origin_list(start_token, limit) rows = list(rows) if len(rows) == limit: next_page_token: Optional[str] = str(rows[-1].tok + 1) else: next_page_token = None return { "origins": [{"url": row.url} for row in rows], "next_page_token": next_page_token, } def origin_search( self, url_pattern, offset=0, limit=50, regexp=False, with_visit=False ): # TODO: remove this endpoint, swh-search should be used instead. origins = self._cql_runner.origin_iter_all() if regexp: pat = re.compile(url_pattern) origins = [orig for orig in origins if pat.search(orig.url)] else: origins = [orig for orig in origins if url_pattern in orig.url] if with_visit: origins = [orig for orig in origins if orig.next_visit_id > 1] return [{"url": orig.url,} for orig in origins[offset : offset + limit]] def origin_add(self, origins: Iterable[Origin]) -> List[Dict]: results = [] for origin in origins: self.origin_add_one(origin) results.append(origin.to_dict()) return results def origin_add_one(self, origin: Origin) -> str: known_origin = self.origin_get_one(origin.to_dict()) if known_origin: origin_url = known_origin["url"] else: self.journal_writer.origin_add([origin]) self._cql_runner.origin_add_one(origin) origin_url = origin.url return origin_url def origin_visit_add( self, origin_url: str, date: Union[str, datetime.datetime], type: str ) -> OriginVisit: if isinstance(date, str): # FIXME: Converge on iso8601 at some point date = dateutil.parser.parse(date) elif not isinstance(date, datetime.datetime): raise StorageArgumentException("Date must be a datetime or a string") if not self.origin_get_one({"url": origin_url}): raise StorageArgumentException("Unknown origin %s", origin_url) visit_id = self._cql_runner.origin_generate_unique_visit_id(origin_url) visit_state = "ongoing" with convert_validation_exceptions(): visit = OriginVisit.from_dict( { "origin": origin_url, "date": date, "type": type, "status": visit_state, "snapshot": None, "metadata": None, "visit": visit_id, } ) self.journal_writer.origin_visit_add([visit]) self._cql_runner.origin_visit_add_one(visit) with convert_validation_exceptions(): visit_status = OriginVisitStatus( origin=origin_url, visit=visit_id, date=date, status=visit_state, snapshot=None, metadata=None, ) self._origin_visit_status_add(visit_status) return visit def _origin_visit_status_add(self, visit_status: OriginVisitStatus) -> None: """Add an origin visit status""" self._cql_runner.origin_visit_status_add_one(visit_status) def origin_visit_update( self, origin: str, visit_id: int, status: str, metadata: Optional[Dict] = None, snapshot: Optional[bytes] = None, date: Optional[datetime.datetime] = None, ): origin_url = origin # TODO: rename the argument # Get the existing data of the visit visit_ = self.origin_visit_get_by(origin_url, visit_id) if not visit_: raise StorageArgumentException("This origin visit does not exist.") with convert_validation_exceptions(): visit = OriginVisit.from_dict(visit_) updates: Dict[str, Any] = {"status": status} if metadata and metadata != visit.metadata: updates["metadata"] = metadata if snapshot and snapshot != visit.snapshot: updates["snapshot"] = snapshot with convert_validation_exceptions(): visit = attr.evolve(visit, **updates) self.journal_writer.origin_visit_update([visit]) last_visit_update = self._origin_visit_get_updated(visit.origin, visit.visit) assert last_visit_update is not None with convert_validation_exceptions(): visit_status = OriginVisitStatus( origin=origin_url, visit=visit_id, date=date or now(), status=status, snapshot=snapshot or last_visit_update["snapshot"], metadata=metadata or last_visit_update["metadata"], ) self._origin_visit_status_add(visit_status) def _origin_visit_merge( self, visit: Dict[str, Any], visit_status: Dict[str, Any] ) -> Dict[str, Any]: """Merge origin_visit and visit_status together. """ return OriginVisit.from_dict( { # default to the values in visit **visit, # override with the last update **visit_status, # visit['origin'] is the URL (via a join), while # visit_status['origin'] is only an id. "origin": visit["origin"], # but keep the date of the creation of the origin visit "date": visit["date"], } ).to_dict() def _origin_visit_apply_last_status(self, visit: Dict[str, Any]) -> Dict[str, Any]: """Retrieve the latest visit status information for the origin visit. Then merge it with the visit and return it. """ visit_status = self._cql_runner.origin_visit_status_get_latest( visit["origin"], visit["visit"] ) assert visit_status is not None return self._origin_visit_merge(visit, visit_status) def _origin_visit_get_updated(self, origin: str, visit_id: int) -> Dict[str, Any]: """Retrieve origin visit and latest origin visit status and merge them into an origin visit. """ row_visit = self._cql_runner.origin_visit_get_one(origin, visit_id) assert row_visit is not None visit = self._format_origin_visit_row(row_visit) return self._origin_visit_apply_last_status(visit) def origin_visit_upsert(self, visits: Iterable[OriginVisit]) -> None: for visit in visits: if visit.visit is None: raise StorageArgumentException(f"Missing visit id for visit {visit}") self.journal_writer.origin_visit_upsert(visits) for visit in visits: assert visit.visit is not None self._cql_runner.origin_visit_upsert(visit) with convert_validation_exceptions(): visit_status = OriginVisitStatus( origin=visit.origin, visit=visit.visit, date=now(), status=visit.status, snapshot=visit.snapshot, metadata=visit.metadata, ) self._origin_visit_status_add(visit_status) @staticmethod def _format_origin_visit_row(visit): return { **visit._asdict(), "origin": visit.origin, "date": visit.date.replace(tzinfo=datetime.timezone.utc), "metadata": (json.loads(visit.metadata) if visit.metadata else None), } def origin_visit_get( self, origin: str, last_visit: Optional[int] = None, limit: Optional[int] = None ) -> Iterable[Dict[str, Any]]: rows = self._cql_runner.origin_visit_get(origin, last_visit, limit) for row in rows: visit = self._format_origin_visit_row(row) yield self._origin_visit_apply_last_status(visit) def origin_visit_find_by_date( self, origin: str, visit_date: datetime.datetime ) -> Optional[Dict[str, Any]]: # Iterator over all the visits of the origin # This should be ok for now, as there aren't too many visits # per origin. rows = list(self._cql_runner.origin_visit_get_all(origin)) def key(visit): dt = visit.date.replace(tzinfo=datetime.timezone.utc) - visit_date return (abs(dt), -visit.visit) if rows: row = min(rows, key=key) visit = self._format_origin_visit_row(row) return self._origin_visit_apply_last_status(visit) return None def origin_visit_get_by(self, origin: str, visit: int) -> Optional[Dict[str, Any]]: row = self._cql_runner.origin_visit_get_one(origin, visit) if row: visit_ = self._format_origin_visit_row(row) return self._origin_visit_apply_last_status(visit_) return None def origin_visit_get_latest( self, origin: str, allowed_statuses: Optional[List[str]] = None, require_snapshot: bool = False, ) -> Optional[Dict[str, Any]]: # TODO: Do not fetch all visits rows = self._cql_runner.origin_visit_get_all(origin) latest_visit = None for row in rows: visit = self._format_origin_visit_row(row) updated_visit = self._origin_visit_apply_last_status(visit) if allowed_statuses and updated_visit["status"] not in allowed_statuses: continue if require_snapshot and updated_visit["snapshot"] is None: continue # updated_visit is a candidate if latest_visit is not None: if updated_visit["date"] < latest_visit["date"]: continue if updated_visit["visit"] < latest_visit["visit"]: continue latest_visit = updated_visit return latest_visit def origin_visit_get_random(self, type: str) -> Optional[Dict[str, Any]]: back_in_the_day = now() - datetime.timedelta(weeks=12) # 3 months back # Random position to start iteration at start_token = random.randint(TOKEN_BEGIN, TOKEN_END) # Iterator over all visits, ordered by token(origins) then visit_id rows = self._cql_runner.origin_visit_iter(start_token) for row in rows: visit = self._format_origin_visit_row(row) visit_status = self._origin_visit_apply_last_status(visit) if ( visit_status["date"] > back_in_the_day and visit_status["status"] == "full" ): return visit_status else: return None - def tool_add(self, tools): - inserted = [] - for tool in tools: - tool = tool.copy() - tool_json = tool.copy() - tool_json["configuration"] = json.dumps( - tool["configuration"], sort_keys=True - ).encode() - id_ = self._cql_runner.tool_get_one_uuid(**tool_json) - if not id_: - id_ = uuid.uuid1() - tool_json["id"] = id_ - self._cql_runner.tool_by_uuid_add_one(tool_json) - self._cql_runner.tool_add_one(tool_json) - tool["id"] = id_ - inserted.append(tool) - return inserted - - def tool_get(self, tool): - id_ = self._cql_runner.tool_get_one_uuid( - tool["name"], - tool["version"], - json.dumps(tool["configuration"], sort_keys=True).encode(), - ) - if id_: - tool = tool.copy() - tool["id"] = id_ - return tool - else: - return None - def stat_counters(self): rows = self._cql_runner.stat_counters() keys = ( "content", "directory", "origin", "origin_visit", "release", "revision", "skipped_content", "snapshot", ) stats = {key: 0 for key in keys} stats.update({row.object_type: row.count for row in rows}) return stats def refresh_stat_counters(self): pass - def origin_metadata_add(self, origin_url, ts, provider, tool, metadata): - # TODO - raise NotImplementedError("not yet supported for Cassandra") + def origin_metadata_add( + self, + origin_url: str, + discovery_date: datetime.datetime, + authority: Dict[str, Any], + fetcher: Dict[str, Any], + format: str, + metadata: bytes, + ) -> None: + if not isinstance(origin_url, str): + raise StorageArgumentException( + "origin_id must be str, not %r" % (origin_url,) + ) + if not self._cql_runner.metadata_authority_get(**authority): + raise StorageArgumentException(f"Unknown authority {authority}") + if not self._cql_runner.metadata_fetcher_get(**fetcher): + raise StorageArgumentException(f"Unknown fetcher {fetcher}") + + self._cql_runner.origin_metadata_add( + origin_url, + authority["type"], + authority["url"], + discovery_date, + fetcher["name"], + fetcher["version"], + format, + metadata, + ) - def origin_metadata_get_by(self, origin_url, provider_type=None): - # TODO - raise NotImplementedError("not yet supported for Cassandra") + def origin_metadata_get( + self, + origin_url: str, + authority: Dict[str, str], + after: Optional[datetime.datetime] = None, + limit: Optional[int] = None, + ) -> List[Dict[str, Any]]: + if not isinstance(origin_url, str): + raise TypeError("origin_url must be str, not %r" % (origin_url,)) + + if after is None: + entries = self._cql_runner.origin_metadata_get( + origin_url, authority["type"], authority["url"] + ) + else: + entries = self._cql_runner.origin_metadata_get_after( + origin_url, authority["type"], authority["url"], after + ) - def metadata_provider_add( - self, provider_name, provider_type, provider_url, metadata - ): - # TODO - raise NotImplementedError("not yet supported for Cassandra") + if limit: + entries = itertools.islice(entries, 0, limit) - def metadata_provider_get(self, provider_id): - # TODO - raise NotImplementedError("not yet supported for Cassandra") + results = [] + for entry in entries: + discovery_date = entry.discovery_date.replace(tzinfo=datetime.timezone.utc) + results.append( + { + "origin_url": entry.origin, + "authority": { + "type": entry.authority_type, + "url": entry.authority_url, + }, + "fetcher": { + "name": entry.fetcher_name, + "version": entry.fetcher_version, + }, + "discovery_date": discovery_date, + "format": entry.format, + "metadata": entry.metadata, + } + ) + return results + + def metadata_fetcher_add( + self, name: str, version: str, metadata: Dict[str, Any] + ) -> None: + self._cql_runner.metadata_fetcher_add(name, version, json.dumps(metadata)) + + def metadata_fetcher_get(self, name: str, version: str) -> Optional[Dict[str, Any]]: + fetcher = self._cql_runner.metadata_fetcher_get(name, version) + if fetcher: + return { + "name": fetcher.name, + "version": fetcher.version, + "metadata": json.loads(fetcher.metadata), + } + else: + return None - def metadata_provider_get_by(self, provider): - # TODO - raise NotImplementedError("not yet supported for Cassandra") + def metadata_authority_add( + self, type: str, url: str, metadata: Dict[str, Any] + ) -> None: + self._cql_runner.metadata_authority_add(url, type, json.dumps(metadata)) + + def metadata_authority_get(self, type: str, url: str) -> Optional[Dict[str, Any]]: + authority = self._cql_runner.metadata_authority_get(type, url) + if authority: + return { + "type": authority.type, + "url": authority.url, + "metadata": json.loads(authority.metadata), + } + else: + return None def clear_buffers(self, object_types: Optional[Iterable[str]] = None) -> None: """Do nothing """ return None def flush(self, object_types: Optional[Iterable[str]] = None) -> Dict: return {} diff --git a/swh/storage/db.py b/swh/storage/db.py index 9564ba58..25580994 100644 --- a/swh/storage/db.py +++ b/swh/storage/db.py @@ -1,1232 +1,1223 @@ # Copyright (C) 2015-2020 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 datetime import random import select - from typing import Any, Dict, Optional, Tuple from swh.core.db import BaseDb from swh.core.db.db_utils import stored_procedure, jsonize from swh.core.db.db_utils import execute_values_generator from swh.model.model import OriginVisit, OriginVisitStatus, SHA1_SIZE class Db(BaseDb): """Proxy to the SWH DB, with wrappers around stored procedures """ def mktemp_dir_entry(self, entry_type, cur=None): self._cursor(cur).execute( "SELECT swh_mktemp_dir_entry(%s)", (("directory_entry_%s" % entry_type),) ) @stored_procedure("swh_mktemp_revision") def mktemp_revision(self, cur=None): pass @stored_procedure("swh_mktemp_release") def mktemp_release(self, cur=None): pass @stored_procedure("swh_mktemp_snapshot_branch") def mktemp_snapshot_branch(self, cur=None): pass def register_listener(self, notify_queue, cur=None): """Register a listener for NOTIFY queue `notify_queue`""" self._cursor(cur).execute("LISTEN %s" % notify_queue) def listen_notifies(self, timeout): """Listen to notifications for `timeout` seconds""" if select.select([self.conn], [], [], timeout) == ([], [], []): return else: self.conn.poll() while self.conn.notifies: yield self.conn.notifies.pop(0) @stored_procedure("swh_content_add") def content_add_from_temp(self, cur=None): pass @stored_procedure("swh_directory_add") def directory_add_from_temp(self, cur=None): pass @stored_procedure("swh_skipped_content_add") def skipped_content_add_from_temp(self, cur=None): pass @stored_procedure("swh_revision_add") def revision_add_from_temp(self, cur=None): pass @stored_procedure("swh_release_add") def release_add_from_temp(self, cur=None): pass def content_update_from_temp(self, keys_to_update, cur=None): cur = self._cursor(cur) cur.execute( """select swh_content_update(ARRAY[%s] :: text[])""" % keys_to_update ) content_get_metadata_keys = [ "sha1", "sha1_git", "sha256", "blake2s256", "length", "status", ] content_add_keys = content_get_metadata_keys + ["ctime"] skipped_content_keys = [ "sha1", "sha1_git", "sha256", "blake2s256", "length", "reason", "status", "origin", ] def content_get_metadata_from_sha1s(self, sha1s, cur=None): cur = self._cursor(cur) yield from execute_values_generator( cur, """ select t.sha1, %s from (values %%s) as t (sha1) inner join content using (sha1) """ % ", ".join(self.content_get_metadata_keys[1:]), ((sha1,) for sha1 in sha1s), ) def content_get_range(self, start, end, limit=None, cur=None): """Retrieve contents within range [start, end]. """ cur = self._cursor(cur) query = """select %s from content where %%s <= sha1 and sha1 <= %%s order by sha1 limit %%s""" % ", ".join( self.content_get_metadata_keys ) cur.execute(query, (start, end, limit)) yield from cur content_hash_keys = ["sha1", "sha1_git", "sha256", "blake2s256"] def content_missing_from_list(self, contents, cur=None): cur = self._cursor(cur) keys = ", ".join(self.content_hash_keys) equality = " AND ".join( ("t.%s = c.%s" % (key, key)) for key in self.content_hash_keys ) yield from execute_values_generator( cur, """ SELECT %s FROM (VALUES %%s) as t(%s) WHERE NOT EXISTS ( SELECT 1 FROM content c WHERE %s ) """ % (keys, keys, equality), (tuple(c[key] for key in self.content_hash_keys) for c in contents), ) def content_missing_per_sha1(self, sha1s, cur=None): cur = self._cursor(cur) yield from execute_values_generator( cur, """ SELECT t.sha1 FROM (VALUES %s) AS t(sha1) WHERE NOT EXISTS ( SELECT 1 FROM content c WHERE c.sha1 = t.sha1 )""", ((sha1,) for sha1 in sha1s), ) def content_missing_per_sha1_git(self, contents, cur=None): cur = self._cursor(cur) yield from execute_values_generator( cur, """ SELECT t.sha1_git FROM (VALUES %s) AS t(sha1_git) WHERE NOT EXISTS ( SELECT 1 FROM content c WHERE c.sha1_git = t.sha1_git )""", ((sha1,) for sha1 in contents), ) def skipped_content_missing(self, contents, cur=None): if not contents: return [] cur = self._cursor(cur) query = """SELECT * FROM (VALUES %s) AS t (%s) WHERE not exists (SELECT 1 FROM skipped_content s WHERE s.sha1 is not distinct from t.sha1::sha1 and s.sha1_git is not distinct from t.sha1_git::sha1 and s.sha256 is not distinct from t.sha256::bytea);""" % ( (", ".join("%s" for _ in contents)), ", ".join(self.content_hash_keys), ) cur.execute( query, [tuple(cont[key] for key in self.content_hash_keys) for cont in contents], ) yield from cur def snapshot_exists(self, snapshot_id, cur=None): """Check whether a snapshot with the given id exists""" cur = self._cursor(cur) cur.execute("""SELECT 1 FROM snapshot where id=%s""", (snapshot_id,)) return bool(cur.fetchone()) def snapshot_missing_from_list(self, snapshots, cur=None): cur = self._cursor(cur) yield from execute_values_generator( cur, """ SELECT id FROM (VALUES %s) as t(id) WHERE NOT EXISTS ( SELECT 1 FROM snapshot d WHERE d.id = t.id ) """, ((id,) for id in snapshots), ) def snapshot_add(self, snapshot_id, cur=None): """Add a snapshot from the temporary table""" cur = self._cursor(cur) cur.execute("""SELECT swh_snapshot_add(%s)""", (snapshot_id,)) snapshot_count_cols = ["target_type", "count"] def snapshot_count_branches(self, snapshot_id, cur=None): cur = self._cursor(cur) query = """\ SELECT %s FROM swh_snapshot_count_branches(%%s) """ % ", ".join( self.snapshot_count_cols ) cur.execute(query, (snapshot_id,)) yield from cur snapshot_get_cols = ["snapshot_id", "name", "target", "target_type"] def snapshot_get_by_id( self, snapshot_id, branches_from=b"", branches_count=None, target_types=None, cur=None, ): cur = self._cursor(cur) query = """\ SELECT %s FROM swh_snapshot_get_by_id(%%s, %%s, %%s, %%s :: snapshot_target[]) """ % ", ".join( self.snapshot_get_cols ) cur.execute(query, (snapshot_id, branches_from, branches_count, target_types)) yield from cur def snapshot_get_by_origin_visit(self, origin_url, visit_id, cur=None): cur = self._cursor(cur) query = """\ SELECT snapshot FROM origin_visit INNER JOIN origin ON origin.id = origin_visit.origin WHERE origin.url=%s AND origin_visit.visit=%s; """ cur.execute(query, (origin_url, visit_id)) ret = cur.fetchone() if ret: return ret[0] def snapshot_get_random(self, cur=None): return self._get_random_row_from_table("snapshot", ["id"], "id", cur) content_find_cols = [ "sha1", "sha1_git", "sha256", "blake2s256", "length", "ctime", "status", ] def content_find( self, sha1=None, sha1_git=None, sha256=None, blake2s256=None, cur=None ): """Find the content optionally on a combination of the following checksums sha1, sha1_git, sha256 or blake2s256. Args: sha1: sha1 content git_sha1: the sha1 computed `a la git` sha1 of the content sha256: sha256 content blake2s256: blake2s256 content Returns: The tuple (sha1, sha1_git, sha256, blake2s256) if found or None. """ cur = self._cursor(cur) checksum_dict = { "sha1": sha1, "sha1_git": sha1_git, "sha256": sha256, "blake2s256": blake2s256, } where_parts = [] args = [] # Adds only those keys which have value other than None for algorithm in checksum_dict: if checksum_dict[algorithm] is not None: args.append(checksum_dict[algorithm]) where_parts.append(algorithm + "= %s") query = " AND ".join(where_parts) cur.execute( """SELECT %s FROM content WHERE %s """ % (",".join(self.content_find_cols), query), args, ) content = cur.fetchall() return content def content_get_random(self, cur=None): return self._get_random_row_from_table("content", ["sha1_git"], "sha1_git", cur) def directory_missing_from_list(self, directories, cur=None): cur = self._cursor(cur) yield from execute_values_generator( cur, """ SELECT id FROM (VALUES %s) as t(id) WHERE NOT EXISTS ( SELECT 1 FROM directory d WHERE d.id = t.id ) """, ((id,) for id in directories), ) directory_ls_cols = [ "dir_id", "type", "target", "name", "perms", "status", "sha1", "sha1_git", "sha256", "length", ] def directory_walk_one(self, directory, cur=None): cur = self._cursor(cur) cols = ", ".join(self.directory_ls_cols) query = "SELECT %s FROM swh_directory_walk_one(%%s)" % cols cur.execute(query, (directory,)) yield from cur def directory_walk(self, directory, cur=None): cur = self._cursor(cur) cols = ", ".join(self.directory_ls_cols) query = "SELECT %s FROM swh_directory_walk(%%s)" % cols cur.execute(query, (directory,)) yield from cur def directory_entry_get_by_path(self, directory, paths, cur=None): """Retrieve a directory entry by path. """ cur = self._cursor(cur) cols = ", ".join(self.directory_ls_cols) query = "SELECT %s FROM swh_find_directory_entry_by_path(%%s, %%s)" % cols cur.execute(query, (directory, paths)) data = cur.fetchone() if set(data) == {None}: return None return data def directory_get_random(self, cur=None): return self._get_random_row_from_table("directory", ["id"], "id", cur) def revision_missing_from_list(self, revisions, cur=None): cur = self._cursor(cur) yield from execute_values_generator( cur, """ SELECT id FROM (VALUES %s) as t(id) WHERE NOT EXISTS ( SELECT 1 FROM revision r WHERE r.id = t.id ) """, ((id,) for id in revisions), ) revision_add_cols = [ "id", "date", "date_offset", "date_neg_utc_offset", "committer_date", "committer_date_offset", "committer_date_neg_utc_offset", "type", "directory", "message", "author_fullname", "author_name", "author_email", "committer_fullname", "committer_name", "committer_email", "metadata", "synthetic", ] revision_get_cols = revision_add_cols + ["parents"] def origin_visit_add(self, origin, ts, type, cur=None): """Add a new origin_visit for origin origin at timestamp ts with status 'ongoing'. Args: origin: origin concerned by the visit ts: the date of the visit type: type of loader for the visit Returns: The new visit index step for that origin """ cur = self._cursor(cur) self._cursor(cur).execute( "SELECT swh_origin_visit_add(%s, %s, %s)", (origin, ts, type) ) return cur.fetchone()[0] origin_visit_status_cols = [ "origin", "visit", "date", "status", "snapshot", "metadata", ] def origin_visit_status_add( self, visit_status: OriginVisitStatus, cur=None ) -> None: """Add new origin visit status """ assert self.origin_visit_status_cols[0] == "origin" assert self.origin_visit_status_cols[-1] == "metadata" cols = self.origin_visit_status_cols[1:-1] cur = self._cursor(cur) cur.execute( f"WITH origin_id as (select id from origin where url=%s) " f"INSERT INTO origin_visit_status " f"(origin, {', '.join(cols)}, metadata) " f"VALUES ((select id from origin_id), " f"{', '.join(['%s']*len(cols))}, %s) " f"ON CONFLICT (origin, visit, date) do nothing", [visit_status.origin] + [getattr(visit_status, key) for key in cols] + [jsonize(visit_status.metadata)], ) def origin_visit_update(self, origin_id, visit_id, updates, cur=None): """Update origin_visit's status.""" cur = self._cursor(cur) update_cols = [] values = [] where = ["origin.id = origin_visit.origin", "origin.url=%s", "visit=%s"] where_values = [origin_id, visit_id] if "status" in updates: update_cols.append("status=%s") values.append(updates.pop("status")) if "metadata" in updates: update_cols.append("metadata=%s") values.append(jsonize(updates.pop("metadata"))) if "snapshot" in updates: update_cols.append("snapshot=%s") values.append(updates.pop("snapshot")) assert not updates, "Unknown fields: %r" % updates query = """UPDATE origin_visit SET {update_cols} FROM origin WHERE {where}""".format( **{"update_cols": ", ".join(update_cols), "where": " AND ".join(where)} ) cur.execute(query, (*values, *where_values)) def origin_visit_upsert(self, origin_visit: OriginVisit, cur=None) -> None: # doing an extra query like this is way simpler than trying to join # the origin id in the query below ov = origin_visit origin_id = next(self.origin_id_get_by_url([ov.origin])) cur = self._cursor(cur) query = """INSERT INTO origin_visit ({cols}) VALUES ({values}) ON CONFLICT ON CONSTRAINT origin_visit_pkey DO UPDATE SET {updates}""".format( cols=", ".join(self.origin_visit_get_cols), values=", ".join("%s" for col in self.origin_visit_get_cols), updates=", ".join( "{0}=excluded.{0}".format(col) for col in self.origin_visit_get_cols ), ) cur.execute( query, ( origin_id, ov.visit, ov.date, ov.type, ov.status, ov.metadata, ov.snapshot, ), ) origin_visit_get_cols = [ "origin", "visit", "date", "type", "status", "metadata", "snapshot", ] origin_visit_select_cols = [ "origin.url AS origin", "visit", "date", "origin_visit.type AS type", "status", "metadata", "snapshot", ] def _make_origin_visit_status(self, row: Tuple[Any]) -> Optional[Dict[str, Any]]: """Make an origin_visit_status dict out of a row """ if not row: return None return dict(zip(self.origin_visit_status_cols, row)) def origin_visit_status_get_latest( self, origin: str, visit: int, cur=None ) -> Optional[Dict[str, Any]]: """Given an origin visit id, return its latest origin_visit_status """ cols = self.origin_visit_status_cols cur = self._cursor(cur) cur.execute( f"SELECT {', '.join(cols)} " f"FROM origin_visit_status ovs " f"INNER JOIN origin o on o.id=ovs.origin " f"WHERE o.url=%s AND ovs.visit=%s" f"ORDER BY ovs.date DESC LIMIT 1", (origin, visit), ) row = cur.fetchone() return self._make_origin_visit_status(row) def origin_visit_get_all(self, origin_id, last_visit=None, limit=None, cur=None): """Retrieve all visits for origin with id origin_id. Args: origin_id: The occurrence's origin Yields: The visits for that origin """ cur = self._cursor(cur) if last_visit: extra_condition = "and visit > %s" args = (origin_id, last_visit, limit) else: extra_condition = "" args = (origin_id, limit) query = """\ SELECT %s FROM origin_visit INNER JOIN origin ON origin.id = origin_visit.origin WHERE origin.url=%%s %s order by visit asc limit %%s""" % ( ", ".join(self.origin_visit_select_cols), extra_condition, ) cur.execute(query, args) yield from cur def origin_visit_get(self, origin_id, visit_id, cur=None): """Retrieve information on visit visit_id of origin origin_id. Args: origin_id: the origin concerned visit_id: The visit step for that origin Returns: The origin_visit information """ cur = self._cursor(cur) query = """\ SELECT %s FROM origin_visit INNER JOIN origin ON origin.id = origin_visit.origin WHERE origin.url = %%s AND visit = %%s """ % ( ", ".join(self.origin_visit_select_cols) ) cur.execute(query, (origin_id, visit_id)) r = cur.fetchall() if not r: return None return r[0] def origin_visit_find_by_date(self, origin, visit_date, cur=None): cur = self._cursor(cur) cur.execute( "SELECT * FROM swh_visit_find_by_date(%s, %s)", (origin, visit_date) ) rows = cur.fetchall() if rows: visit = dict(zip(self.origin_visit_get_cols, rows[0])) visit["origin"] = origin return visit def origin_visit_exists(self, origin_id, visit_id, cur=None): """Check whether an origin visit with the given ids exists""" cur = self._cursor(cur) query = "SELECT 1 FROM origin_visit where origin = %s AND visit = %s" cur.execute(query, (origin_id, visit_id)) return bool(cur.fetchone()) def origin_visit_get_latest( self, origin_id, allowed_statuses=None, require_snapshot=False, cur=None ): """Retrieve the most recent origin_visit of the given origin, with optional filters. Args: origin_id: the origin concerned allowed_statuses: the visit statuses allowed for the returned visit require_snapshot (bool): If True, only a visit with a known snapshot will be returned. Returns: The origin_visit information, or None if no visit matches. """ cur = self._cursor(cur) query_parts = [ "SELECT %s" % ", ".join(self.origin_visit_select_cols), "FROM origin_visit", "INNER JOIN origin ON origin.id = origin_visit.origin", ] query_parts.append("WHERE origin.url = %s") if require_snapshot: query_parts.append("AND snapshot is not null") if allowed_statuses: query_parts.append( cur.mogrify("AND status IN %s", (tuple(allowed_statuses),)).decode() ) query_parts.append("ORDER BY date DESC, visit DESC LIMIT 1") query = "\n".join(query_parts) cur.execute(query, (origin_id,)) r = cur.fetchone() if not r: return None return r def origin_visit_get_random(self, type, cur=None): """Randomly select one origin visit that was full and in the last 3 months """ cur = self._cursor(cur) columns = ",".join(self.origin_visit_select_cols) query = f"""with visits as ( select * from origin_visit where origin_visit.status='full' and origin_visit.type=%s and origin_visit.date > now() - '3 months'::interval ) select {columns} from visits as origin_visit inner join origin on origin_visit.origin=origin.id where random() < 0.1 limit 1 """ cur.execute(query, (type,)) return cur.fetchone() @staticmethod def mangle_query_key(key, main_table): if key == "id": return "t.id" if key == "parents": return """ ARRAY( SELECT rh.parent_id::bytea FROM revision_history rh WHERE rh.id = t.id ORDER BY rh.parent_rank )""" if "_" not in key: return "%s.%s" % (main_table, key) head, tail = key.split("_", 1) if head in ("author", "committer") and tail in ( "name", "email", "id", "fullname", ): return "%s.%s" % (head, tail) return "%s.%s" % (main_table, key) def revision_get_from_list(self, revisions, cur=None): cur = self._cursor(cur) query_keys = ", ".join( self.mangle_query_key(k, "revision") for k in self.revision_get_cols ) yield from execute_values_generator( cur, """ SELECT %s FROM (VALUES %%s) as t(sortkey, id) LEFT JOIN revision ON t.id = revision.id LEFT JOIN person author ON revision.author = author.id LEFT JOIN person committer ON revision.committer = committer.id ORDER BY sortkey """ % query_keys, ((sortkey, id) for sortkey, id in enumerate(revisions)), ) def revision_log(self, root_revisions, limit=None, cur=None): cur = self._cursor(cur) query = """SELECT %s FROM swh_revision_log(%%s, %%s) """ % ", ".join( self.revision_get_cols ) cur.execute(query, (root_revisions, limit)) yield from cur revision_shortlog_cols = ["id", "parents"] def revision_shortlog(self, root_revisions, limit=None, cur=None): cur = self._cursor(cur) query = """SELECT %s FROM swh_revision_list(%%s, %%s) """ % ", ".join( self.revision_shortlog_cols ) cur.execute(query, (root_revisions, limit)) yield from cur def revision_get_random(self, cur=None): return self._get_random_row_from_table("revision", ["id"], "id", cur) def release_missing_from_list(self, releases, cur=None): cur = self._cursor(cur) yield from execute_values_generator( cur, """ SELECT id FROM (VALUES %s) as t(id) WHERE NOT EXISTS ( SELECT 1 FROM release r WHERE r.id = t.id ) """, ((id,) for id in releases), ) object_find_by_sha1_git_cols = ["sha1_git", "type"] def object_find_by_sha1_git(self, ids, cur=None): cur = self._cursor(cur) yield from execute_values_generator( cur, """ WITH t (sha1_git) AS (VALUES %s), known_objects as (( select id as sha1_git, 'release'::object_type as type, object_id from release r where exists (select 1 from t where t.sha1_git = r.id) ) union all ( select id as sha1_git, 'revision'::object_type as type, object_id from revision r where exists (select 1 from t where t.sha1_git = r.id) ) union all ( select id as sha1_git, 'directory'::object_type as type, object_id from directory d where exists (select 1 from t where t.sha1_git = d.id) ) union all ( select sha1_git as sha1_git, 'content'::object_type as type, object_id from content c where exists (select 1 from t where t.sha1_git = c.sha1_git) )) select t.sha1_git as sha1_git, k.type from t left join known_objects k on t.sha1_git = k.sha1_git """, ((id,) for id in ids), ) def stat_counters(self, cur=None): cur = self._cursor(cur) cur.execute("SELECT * FROM swh_stat_counters()") yield from cur def origin_add(self, url, cur=None): """Insert a new origin and return the new identifier.""" insert = """INSERT INTO origin (url) values (%s) RETURNING url""" cur.execute(insert, (url,)) return cur.fetchone()[0] origin_cols = ["url"] def origin_get_by_url(self, origins, cur=None): """Retrieve origin `(type, url)` from urls if found.""" cur = self._cursor(cur) query = """SELECT %s FROM (VALUES %%s) as t(url) LEFT JOIN origin ON t.url = origin.url """ % ",".join( "origin." + col for col in self.origin_cols ) yield from execute_values_generator(cur, query, ((url,) for url in origins)) def origin_get_by_sha1(self, sha1s, cur=None): """Retrieve origin urls from sha1s if found.""" cur = self._cursor(cur) query = """SELECT %s FROM (VALUES %%s) as t(sha1) LEFT JOIN origin ON t.sha1 = digest(origin.url, 'sha1') """ % ",".join( "origin." + col for col in self.origin_cols ) yield from execute_values_generator(cur, query, ((sha1,) for sha1 in sha1s)) def origin_id_get_by_url(self, origins, cur=None): """Retrieve origin `(type, url)` from urls if found.""" cur = self._cursor(cur) query = """SELECT id FROM (VALUES %s) as t(url) LEFT JOIN origin ON t.url = origin.url """ for row in execute_values_generator(cur, query, ((url,) for url in origins)): yield row[0] origin_get_range_cols = ["id", "url"] def origin_get_range(self, origin_from=1, origin_count=100, cur=None): """Retrieve ``origin_count`` origins whose ids are greater or equal than ``origin_from``. Origins are sorted by id before retrieving them. Args: origin_from (int): the minimum id of origins to retrieve origin_count (int): the maximum number of origins to retrieve """ cur = self._cursor(cur) query = """SELECT %s FROM origin WHERE id >= %%s ORDER BY id LIMIT %%s """ % ",".join( self.origin_get_range_cols ) cur.execute(query, (origin_from, origin_count)) yield from cur def _origin_query( self, url_pattern, count=False, offset=0, limit=50, regexp=False, with_visit=False, cur=None, ): """ Method factorizing query creation for searching and counting origins. """ cur = self._cursor(cur) if count: origin_cols = "COUNT(*)" else: origin_cols = ",".join(self.origin_cols) query = """SELECT %s FROM origin WHERE """ if with_visit: query += """ EXISTS ( SELECT 1 FROM origin_visit INNER JOIN snapshot ON snapshot=snapshot.id WHERE origin=origin.id ) AND """ query += "url %s %%s " if not count: query += "ORDER BY id OFFSET %%s LIMIT %%s" if not regexp: query = query % (origin_cols, "ILIKE") query_params = ("%" + url_pattern + "%", offset, limit) else: query = query % (origin_cols, "~*") query_params = (url_pattern, offset, limit) if count: query_params = (query_params[0],) cur.execute(query, query_params) def origin_search( self, url_pattern, offset=0, limit=50, regexp=False, with_visit=False, cur=None ): """Search for origins whose urls contain a provided string pattern or match a provided regular expression. The search is performed in a case insensitive way. Args: url_pattern (str): the string pattern to search for in origin urls offset (int): number of found origins to skip before returning results limit (int): the maximum number of found origins to return regexp (bool): if True, consider the provided pattern as a regular expression and returns origins whose urls match it with_visit (bool): if True, filter out origins with no visit """ self._origin_query( url_pattern, offset=offset, limit=limit, regexp=regexp, with_visit=with_visit, cur=cur, ) yield from cur def origin_count(self, url_pattern, regexp=False, with_visit=False, cur=None): """Count origins whose urls contain a provided string pattern or match a provided regular expression. The pattern search in origin urls is performed in a case insensitive way. Args: url_pattern (str): the string pattern to search for in origin urls regexp (bool): if True, consider the provided pattern as a regular expression and returns origins whose urls match it with_visit (bool): if True, filter out origins with no visit """ self._origin_query( url_pattern, count=True, regexp=regexp, with_visit=with_visit, cur=cur ) return cur.fetchone()[0] release_add_cols = [ "id", "target", "target_type", "date", "date_offset", "date_neg_utc_offset", "name", "comment", "synthetic", "author_fullname", "author_name", "author_email", ] release_get_cols = release_add_cols def release_get_from_list(self, releases, cur=None): cur = self._cursor(cur) query_keys = ", ".join( self.mangle_query_key(k, "release") for k in self.release_get_cols ) yield from execute_values_generator( cur, """ SELECT %s FROM (VALUES %%s) as t(sortkey, id) LEFT JOIN release ON t.id = release.id LEFT JOIN person author ON release.author = author.id ORDER BY sortkey """ % query_keys, ((sortkey, id) for sortkey, id in enumerate(releases)), ) def release_get_random(self, cur=None): return self._get_random_row_from_table("release", ["id"], "id", cur) - def origin_metadata_add(self, origin, ts, provider, tool, metadata, cur=None): + origin_metadata_get_cols = [ + "origin.url", + "discovery_date", + "metadata_authority.type", + "metadata_authority.url", + "metadata_fetcher.name", + "metadata_fetcher.version", + "format", + "metadata", + ] + + def origin_metadata_add( + self, + origin: str, + discovery_date: datetime.datetime, + authority: int, + fetcher: int, + format: str, + metadata: bytes, + cur=None, + ) -> None: """ Add an origin_metadata for the origin at ts with provider, tool and metadata. Args: - origin (int): the origin's id for which the metadata is added - ts (datetime): time when the metadata was found - provider (int): the metadata provider identifier - tool (int): the tool's identifier used to extract metadata - metadata (jsonb): the metadata retrieved at the time and location - - Returns: - id (int): the origin_metadata unique id - + origin: the origin's id for which the metadata is added + discovery_date: time when the metadata was found + authority: the metadata provider identifier + fetcher: the tool's identifier used to extract metadata + format: the format of the metadata + metadata: the metadata retrieved at the time and location """ cur = self._cursor(cur) insert = """INSERT INTO origin_metadata (origin_id, discovery_date, - provider_id, tool_id, metadata) - SELECT id, %s, %s, %s, %s FROM origin WHERE url = %s""" - cur.execute(insert, (ts, provider, tool, jsonize(metadata), origin)) - - origin_metadata_get_cols = [ - "origin_url", - "discovery_date", - "tool_id", - "metadata", - "provider_id", - "provider_name", - "provider_type", - "provider_url", - ] - - def origin_metadata_get_by(self, origin_url, provider_type=None, cur=None): - """Retrieve all origin_metadata entries for one origin_url + authority_id, fetcher_id, format, metadata) + SELECT id, %s, %s, %s, %s, %s FROM origin WHERE url = %s""" + cur.execute( + insert, + (discovery_date, authority, fetcher, format, jsonize(metadata), origin), + ) - """ + def origin_metadata_get( + self, + origin_url: str, + authority: int, + after: Optional[datetime.datetime], + limit: Optional[int], + cur=None, + ): cur = self._cursor(cur) - if not provider_type: - query = """SELECT %s - FROM swh_origin_metadata_get_by_origin( - %%s)""" % ( - ",".join(self.origin_metadata_get_cols) - ) + assert self.origin_metadata_get_cols[-1] == "metadata" + query_parts = [ + f"SELECT {', '.join(self.origin_metadata_get_cols[0:-1])}, " + f" origin_metadata.metadata AS metadata " + f"FROM origin_metadata " + f"INNER JOIN metadata_authority " + f" ON (metadata_authority.id=authority_id) " + f"INNER JOIN metadata_fetcher ON (metadata_fetcher.id=fetcher_id) " + f"INNER JOIN origin ON (origin.id=origin_metadata.origin_id) " + f"WHERE origin.url=%s AND authority_id=%s" + ] + args = [origin_url, authority] - cur.execute(query, (origin_url,)) + if after: + query_parts.append("AND discovery_date >= %s") + args.append(after) - else: - query = """SELECT %s - FROM swh_origin_metadata_get_by_provider_type( - %%s, %%s)""" % ( - ",".join(self.origin_metadata_get_cols) - ) + query_parts.append("ORDER BY discovery_date") - cur.execute(query, (origin_url, provider_type)) + if limit: + query_parts.append("LIMIT %s") + args.append(limit) + cur.execute(" ".join(query_parts), args) yield from cur - tool_cols = ["id", "name", "version", "configuration"] - - @stored_procedure("swh_mktemp_tool") - def mktemp_tool(self, cur=None): - pass + metadata_fetcher_cols = ["name", "version", "metadata"] - def tool_add_from_temp(self, cur=None): + def metadata_fetcher_add( + self, name: str, version: str, metadata: bytes, cur=None + ) -> None: cur = self._cursor(cur) - cur.execute("SELECT %s from swh_tool_add()" % (",".join(self.tool_cols),)) - yield from cur + cur.execute( + "INSERT INTO metadata_fetcher (name, version, metadata) " + "VALUES (%s, %s, %s) ON CONFLICT DO NOTHING", + (name, version, jsonize(metadata)), + ) - def tool_get(self, name, version, configuration, cur=None): + def metadata_fetcher_get(self, name: str, version: str, cur=None): cur = self._cursor(cur) cur.execute( - """select %s - from tool - where name=%%s and - version=%%s and - configuration=%%s""" - % (",".join(self.tool_cols)), - (name, version, configuration), + f"SELECT {', '.join(self.metadata_fetcher_cols)} " + f"FROM metadata_fetcher " + f"WHERE name=%s AND version=%s", + (name, version), ) - return cur.fetchone() - metadata_provider_cols = [ - "id", - "provider_name", - "provider_type", - "provider_url", - "metadata", - ] - - def metadata_provider_add( - self, - provider_name: str, - provider_type: str, - provider_url: str, - metadata: Dict, - cur=None, - ) -> int: - """Insert a new provider and return the new identifier.""" + def metadata_fetcher_get_id( + self, name: str, version: str, cur=None + ) -> Optional[int]: cur = self._cursor(cur) - insert = """ - INSERT INTO metadata_provider (provider_name, provider_type, - provider_url, metadata) values (%s, %s, %s, %s) - ON CONFLICT(provider_type, provider_url) do nothing - """ cur.execute( - insert, (provider_name, provider_type, provider_url, jsonize(metadata)) - ) - row = self.metadata_provider_get_by_composite_key( - provider_type, provider_url, cur=cur + "SELECT id FROM metadata_fetcher WHERE name=%s AND version=%s", + (name, version), ) - return row[0] + row = cur.fetchone() + if row: + return row[0] + else: + return None - def metadata_provider_get_by_composite_key( - self, provider_type: str, provider_url: str, cur=None - ) -> Tuple: - """Retrieve metadata provider by its composite primary key. + metadata_authority_cols = ["type", "url", "metadata"] - """ + def metadata_authority_add( + self, type: str, url: str, metadata: bytes, cur=None + ) -> None: cur = self._cursor(cur) cur.execute( - """select %s - from metadata_provider - where provider_type=%%s and provider_url=%%s""" - % (",".join(self.metadata_provider_cols)), - (provider_type, provider_url,), + "INSERT INTO metadata_authority (type, url, metadata) " + "VALUES (%s, %s, %s) ON CONFLICT DO NOTHING", + (type, url, jsonize(metadata)), ) - return cur.fetchone() - def metadata_provider_get(self, provider_id, cur=None): + def metadata_authority_get(self, type: str, url: str, cur=None): cur = self._cursor(cur) cur.execute( - """select %s - from metadata_provider - where id=%%s """ - % (",".join(self.metadata_provider_cols)), - (provider_id,), + f"SELECT {', '.join(self.metadata_authority_cols)} " + f"FROM metadata_authority " + f"WHERE type=%s AND url=%s", + (type, url), ) - return cur.fetchone() - def metadata_provider_get_by(self, provider_name, provider_url, cur=None): + def metadata_authority_get_id(self, type: str, url: str, cur=None) -> Optional[int]: cur = self._cursor(cur) cur.execute( - """select %s - from metadata_provider - where provider_name=%%s and - provider_url=%%s""" - % (",".join(self.metadata_provider_cols)), - (provider_name, provider_url), + "SELECT id FROM metadata_authority WHERE type=%s AND url=%s", (type, url) ) - - return cur.fetchone() + row = cur.fetchone() + if row: + return row[0] + else: + return None def _get_random_row_from_table(self, table_name, cols, id_col, cur=None): random_sha1 = bytes(random.randint(0, 255) for _ in range(SHA1_SIZE)) cur = self._cursor(cur) query = """ (SELECT {cols} FROM {table} WHERE {id_col} >= %s ORDER BY {id_col} LIMIT 1) UNION (SELECT {cols} FROM {table} WHERE {id_col} < %s ORDER BY {id_col} DESC LIMIT 1) LIMIT 1 """.format( cols=", ".join(cols), table=table_name, id_col=id_col ) cur.execute(query, (random_sha1, random_sha1)) row = cur.fetchone() if row: return row[0] diff --git a/swh/storage/in_memory.py b/swh/storage/in_memory.py index 4a00e044..844439c4 100644 --- a/swh/storage/in_memory.py +++ b/swh/storage/in_memory.py @@ -1,1161 +1,1196 @@ # Copyright (C) 2015-2020 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 re import bisect import dateutil import collections import copy import datetime import itertools import random from collections import defaultdict from datetime import timedelta from typing import ( Any, Callable, Dict, Generic, + Hashable, Iterable, Iterator, List, Optional, Tuple, TypeVar, Union, ) import attr from swh.model.model import ( BaseContent, Content, SkippedContent, Directory, Revision, Release, Snapshot, OriginVisit, OriginVisitStatus, Origin, SHA1_SIZE, ) from swh.model.hashutil import DEFAULT_ALGORITHMS, hash_to_bytes, hash_to_hex from swh.storage.objstorage import ObjStorage from swh.storage.validate import convert_validation_exceptions from swh.storage.utils import now from .exc import StorageArgumentException, HashCollision from .converters import origin_url_to_sha1 from .utils import get_partition_bounds_bytes from .writer import JournalWriter # Max block size of contents to return BULK_BLOCK_CONTENT_LEN_MAX = 10000 SortedListItem = TypeVar("SortedListItem") SortedListKey = TypeVar("SortedListKey") class SortedList(collections.UserList, Generic[SortedListKey, SortedListItem]): data: List[Tuple[SortedListKey, SortedListItem]] # https://github.com/python/mypy/issues/708 # key: Callable[[SortedListItem], SortedListKey] def __init__( self, data: List[SortedListItem] = None, key: Optional[Callable[[SortedListItem], SortedListKey]] = None, ): if key is None: def key(item): return item assert key is not None # for mypy super().__init__(sorted((key(x), x) for x in data or [])) self.key: Callable[[SortedListItem], SortedListKey] = key def add(self, item: SortedListItem): k = self.key(item) bisect.insort(self.data, (k, item)) def __iter__(self) -> Iterator[SortedListItem]: for (k, item) in self.data: yield item def iter_from(self, start_key: SortedListKey) -> Iterator[SortedListItem]: """Returns an iterator over all the elements whose key is greater or equal to `start_key`. (This is an efficient equivalent to: `(x for x in L if key(x) >= start_key)`) """ from_index = bisect.bisect_left(self.data, (start_key,)) for (k, item) in itertools.islice(self.data, from_index, None): yield item class InMemoryStorage: def __init__(self, journal_writer=None): self.reset() self.journal_writer = JournalWriter(journal_writer) def reset(self): self._contents = {} self._content_indexes = defaultdict(lambda: defaultdict(set)) self._skipped_contents = {} self._skipped_content_indexes = defaultdict(lambda: defaultdict(set)) self._directories = {} self._revisions = {} self._releases = {} self._snapshots = {} self._origins = {} self._origins_by_id = [] self._origins_by_sha1 = {} self._origin_visits = {} self._origin_visit_statuses: Dict[Tuple[str, int], List[OriginVisitStatus]] = {} self._persons = [] - self._origin_metadata = defaultdict(list) - self._tools = {} - self._metadata_providers = {} - self._objects = defaultdict(list) + # {origin_url: {authority: [metadata]}} + self._origin_metadata: Dict[ + str, Dict[Hashable, SortedList[datetime.datetime, Dict[str, Any]]] + ] = defaultdict( + lambda: defaultdict(lambda: SortedList(key=lambda x: x["discovery_date"])) + ) # noqa + + self._metadata_fetchers: Dict[Hashable, Dict[str, Any]] = {} + self._metadata_authorities: Dict[Hashable, Dict[str, Any]] = {} + self._objects = defaultdict(list) self._sorted_sha1s = SortedList[bytes, bytes]() self.objstorage = ObjStorage({"cls": "memory", "args": {}}) def check_config(self, *, check_write): return True def _content_add(self, contents: Iterable[Content], with_data: bool) -> Dict: self.journal_writer.content_add(contents) content_add = 0 - content_add_bytes = 0 if with_data: summary = self.objstorage.content_add( c for c in contents if c.status != "absent" ) content_add_bytes = summary["content:add:bytes"] for content in contents: key = self._content_key(content) if key in self._contents: continue for algorithm in DEFAULT_ALGORITHMS: hash_ = content.get_hash(algorithm) if hash_ in self._content_indexes[algorithm] and ( algorithm not in {"blake2s256", "sha256"} ): colliding_content_hashes = [] # Add the already stored contents for content_hashes_set in self._content_indexes[algorithm][hash_]: hashes = dict(content_hashes_set) colliding_content_hashes.append(hashes) # Add the new colliding content colliding_content_hashes.append(content.hashes()) raise HashCollision(algorithm, hash_, colliding_content_hashes) for algorithm in DEFAULT_ALGORITHMS: hash_ = content.get_hash(algorithm) self._content_indexes[algorithm][hash_].add(key) self._objects[content.sha1_git].append(("content", content.sha1)) self._contents[key] = content self._sorted_sha1s.add(content.sha1) self._contents[key] = attr.evolve(self._contents[key], data=None) content_add += 1 summary = { "content:add": content_add, } if with_data: summary["content:add:bytes"] = content_add_bytes return summary def content_add(self, content: Iterable[Content]) -> Dict: content = [attr.evolve(c, ctime=now()) for c in content] return self._content_add(content, with_data=True) def content_update(self, content, keys=[]): self.journal_writer.content_update(content) for cont_update in content: cont_update = cont_update.copy() sha1 = cont_update.pop("sha1") for old_key in self._content_indexes["sha1"][sha1]: old_cont = self._contents.pop(old_key) for algorithm in DEFAULT_ALGORITHMS: hash_ = old_cont.get_hash(algorithm) self._content_indexes[algorithm][hash_].remove(old_key) new_cont = attr.evolve(old_cont, **cont_update) new_key = self._content_key(new_cont) self._contents[new_key] = new_cont for algorithm in DEFAULT_ALGORITHMS: hash_ = new_cont.get_hash(algorithm) self._content_indexes[algorithm][hash_].add(new_key) def content_add_metadata(self, content: Iterable[Content]) -> Dict: return self._content_add(content, with_data=False) def content_get(self, content): # FIXME: Make this method support slicing the `data`. if len(content) > BULK_BLOCK_CONTENT_LEN_MAX: raise StorageArgumentException( "Sending at most %s contents." % BULK_BLOCK_CONTENT_LEN_MAX ) yield from self.objstorage.content_get(content) def content_get_range(self, start, end, limit=1000): if limit is None: raise StorageArgumentException("limit should not be None") sha1s = ( (sha1, content_key) for sha1 in self._sorted_sha1s.iter_from(start) for content_key in self._content_indexes["sha1"][sha1] ) matched = [] next_content = None for sha1, key in sha1s: if sha1 > end: break if len(matched) >= limit: next_content = sha1 break matched.append(self._contents[key].to_dict()) return { "contents": matched, "next": next_content, } def content_get_partition( self, partition_id: int, nb_partitions: int, limit: int = 1000, page_token: str = None, ): if limit is None: raise StorageArgumentException("limit should not be None") (start, end) = get_partition_bounds_bytes( partition_id, nb_partitions, SHA1_SIZE ) if page_token: start = hash_to_bytes(page_token) if end is None: end = b"\xff" * SHA1_SIZE result = self.content_get_range(start, end, limit) result2 = { "contents": result["contents"], "next_page_token": None, } if result["next"]: result2["next_page_token"] = hash_to_hex(result["next"]) return result2 def content_get_metadata(self, contents: List[bytes]) -> Dict[bytes, List[Dict]]: result: Dict = {sha1: [] for sha1 in contents} for sha1 in contents: if sha1 in self._content_indexes["sha1"]: objs = self._content_indexes["sha1"][sha1] # only 1 element as content_add_metadata would have raised a # hash collision otherwise for key in objs: d = self._contents[key].to_dict() del d["ctime"] if "data" in d: del d["data"] result[sha1].append(d) return result def content_find(self, content): if not set(content).intersection(DEFAULT_ALGORITHMS): raise StorageArgumentException( "content keys must contain at least one of: %s" % ", ".join(sorted(DEFAULT_ALGORITHMS)) ) found = [] for algo in DEFAULT_ALGORITHMS: hash = content.get(algo) if hash and hash in self._content_indexes[algo]: found.append(self._content_indexes[algo][hash]) if not found: return [] keys = list(set.intersection(*found)) return [self._contents[key].to_dict() for key in keys] def content_missing(self, content, key_hash="sha1"): for cont in content: for (algo, hash_) in cont.items(): if algo not in DEFAULT_ALGORITHMS: continue if hash_ not in self._content_indexes.get(algo, []): yield cont[key_hash] break else: for result in self.content_find(cont): if result["status"] == "missing": yield cont[key_hash] def content_missing_per_sha1(self, contents): for content in contents: if content not in self._content_indexes["sha1"]: yield content def content_missing_per_sha1_git(self, contents): for content in contents: if content not in self._content_indexes["sha1_git"]: yield content def content_get_random(self): return random.choice(list(self._content_indexes["sha1_git"])) def _skipped_content_add(self, contents: List[SkippedContent]) -> Dict: self.journal_writer.skipped_content_add(contents) summary = {"skipped_content:add": 0} missing_contents = self.skipped_content_missing([c.hashes() for c in contents]) missing = {self._content_key(c) for c in missing_contents} contents = [c for c in contents if self._content_key(c) in missing] for content in contents: key = self._content_key(content) for algo in DEFAULT_ALGORITHMS: if content.get_hash(algo): self._skipped_content_indexes[algo][content.get_hash(algo)].add(key) self._skipped_contents[key] = content summary["skipped_content:add"] += 1 return summary def skipped_content_add(self, content: Iterable[SkippedContent]) -> Dict: content = [attr.evolve(c, ctime=now()) for c in content] return self._skipped_content_add(content) def skipped_content_missing(self, contents): for content in contents: matches = list(self._skipped_contents.values()) for (algorithm, key) in self._content_key(content): if algorithm == "blake2s256": continue # Filter out skipped contents with the same hash matches = [ match for match in matches if match.get_hash(algorithm) == key ] # if none of the contents match if not matches: yield {algo: content[algo] for algo in DEFAULT_ALGORITHMS} def directory_add(self, directories: Iterable[Directory]) -> Dict: directories = [dir_ for dir_ in directories if dir_.id not in self._directories] self.journal_writer.directory_add(directories) count = 0 for directory in directories: count += 1 self._directories[directory.id] = directory self._objects[directory.id].append(("directory", directory.id)) return {"directory:add": count} def directory_missing(self, directories): for id in directories: if id not in self._directories: yield id def _join_dentry_to_content(self, dentry): keys = ( "status", "sha1", "sha1_git", "sha256", "length", ) ret = dict.fromkeys(keys) ret.update(dentry) if ret["type"] == "file": # TODO: Make it able to handle more than one content content = self.content_find({"sha1_git": ret["target"]}) if content: content = content[0] for key in keys: ret[key] = content[key] return ret def _directory_ls(self, directory_id, recursive, prefix=b""): if directory_id in self._directories: for entry in self._directories[directory_id].entries: ret = self._join_dentry_to_content(entry.to_dict()) ret["name"] = prefix + ret["name"] ret["dir_id"] = directory_id yield ret if recursive and ret["type"] == "dir": yield from self._directory_ls( ret["target"], True, prefix + ret["name"] + b"/" ) def directory_ls(self, directory, recursive=False): yield from self._directory_ls(directory, recursive) def directory_entry_get_by_path(self, directory, paths): return self._directory_entry_get_by_path(directory, paths, b"") def directory_get_random(self): if not self._directories: return None return random.choice(list(self._directories)) def _directory_entry_get_by_path(self, directory, paths, prefix): if not paths: return contents = list(self.directory_ls(directory)) if not contents: return def _get_entry(entries, name): for entry in entries: if entry["name"] == name: entry = entry.copy() entry["name"] = prefix + entry["name"] return entry first_item = _get_entry(contents, paths[0]) if len(paths) == 1: return first_item if not first_item or first_item["type"] != "dir": return return self._directory_entry_get_by_path( first_item["target"], paths[1:], prefix + paths[0] + b"/" ) def revision_add(self, revisions: Iterable[Revision]) -> Dict: revisions = [rev for rev in revisions if rev.id not in self._revisions] self.journal_writer.revision_add(revisions) count = 0 for revision in revisions: revision = attr.evolve( revision, committer=self._person_add(revision.committer), author=self._person_add(revision.author), ) self._revisions[revision.id] = revision self._objects[revision.id].append(("revision", revision.id)) count += 1 return {"revision:add": count} def revision_missing(self, revisions): for id in revisions: if id not in self._revisions: yield id def revision_get(self, revisions): for id in revisions: if id in self._revisions: yield self._revisions.get(id).to_dict() else: yield None def _get_parent_revs(self, rev_id, seen, limit): if limit and len(seen) >= limit: return if rev_id in seen or rev_id not in self._revisions: return seen.add(rev_id) yield self._revisions[rev_id].to_dict() for parent in self._revisions[rev_id].parents: yield from self._get_parent_revs(parent, seen, limit) def revision_log(self, revisions, limit=None): seen = set() for rev_id in revisions: yield from self._get_parent_revs(rev_id, seen, limit) def revision_shortlog(self, revisions, limit=None): yield from ( (rev["id"], rev["parents"]) for rev in self.revision_log(revisions, limit) ) def revision_get_random(self): return random.choice(list(self._revisions)) def release_add(self, releases: Iterable[Release]) -> Dict: releases = [rel for rel in releases if rel.id not in self._releases] self.journal_writer.release_add(releases) count = 0 for rel in releases: if rel.author: self._person_add(rel.author) self._objects[rel.id].append(("release", rel.id)) self._releases[rel.id] = rel count += 1 return {"release:add": count} def release_missing(self, releases): yield from (rel for rel in releases if rel not in self._releases) def release_get(self, releases): for rel_id in releases: if rel_id in self._releases: yield self._releases[rel_id].to_dict() else: yield None def release_get_random(self): return random.choice(list(self._releases)) def snapshot_add(self, snapshots: Iterable[Snapshot]) -> Dict: count = 0 snapshots = (snap for snap in snapshots if snap.id not in self._snapshots) for snapshot in snapshots: self.journal_writer.snapshot_add([snapshot]) sorted_branch_names = sorted(snapshot.branches) self._snapshots[snapshot.id] = (snapshot, sorted_branch_names) self._objects[snapshot.id].append(("snapshot", snapshot.id)) count += 1 return {"snapshot:add": count} def snapshot_missing(self, snapshots): for id in snapshots: if id not in self._snapshots: yield id def snapshot_get(self, snapshot_id): return self.snapshot_get_branches(snapshot_id) def snapshot_get_by_origin_visit(self, origin, visit): origin_url = self._get_origin_url(origin) if not origin_url: return if origin_url not in self._origins or visit > len( self._origin_visits[origin_url] ): return None visit = self._origin_visit_get_updated(origin_url, visit) snapshot_id = visit.snapshot if snapshot_id: return self.snapshot_get(snapshot_id) else: return None def snapshot_get_latest(self, origin, allowed_statuses=None): origin_url = self._get_origin_url(origin) if not origin_url: return visit = self.origin_visit_get_latest( origin_url, allowed_statuses=allowed_statuses, require_snapshot=True ) if visit and visit["snapshot"]: snapshot = self.snapshot_get(visit["snapshot"]) if not snapshot: raise StorageArgumentException( "last origin visit references an unknown snapshot" ) return snapshot def snapshot_count_branches(self, snapshot_id): (snapshot, _) = self._snapshots[snapshot_id] return collections.Counter( branch.target_type.value if branch else None for branch in snapshot.branches.values() ) def snapshot_get_branches( self, snapshot_id, branches_from=b"", branches_count=1000, target_types=None ): res = self._snapshots.get(snapshot_id) if res is None: return None (snapshot, sorted_branch_names) = res from_index = bisect.bisect_left(sorted_branch_names, branches_from) if target_types: next_branch = None branches = {} for branch_name in sorted_branch_names[from_index:]: branch = snapshot.branches[branch_name] if branch and branch.target_type.value in target_types: if len(branches) < branches_count: branches[branch_name] = branch else: next_branch = branch_name break else: # As there is no 'target_types', we can do that much faster to_index = from_index + branches_count returned_branch_names = sorted_branch_names[from_index:to_index] branches = { branch_name: snapshot.branches[branch_name] for branch_name in returned_branch_names } if to_index >= len(sorted_branch_names): next_branch = None else: next_branch = sorted_branch_names[to_index] branches = { name: branch.to_dict() if branch else None for (name, branch) in branches.items() } return { "id": snapshot_id, "branches": branches, "next_branch": next_branch, } def snapshot_get_random(self): return random.choice(list(self._snapshots)) def object_find_by_sha1_git(self, ids): ret = {} for id_ in ids: objs = self._objects.get(id_, []) ret[id_] = [{"sha1_git": id_, "type": obj[0],} for obj in objs] return ret def _convert_origin(self, t): if t is None: return None return t.to_dict() def origin_get(self, origins): if isinstance(origins, dict): # Old API return_single = True origins = [origins] else: return_single = False # Sanity check to be error-compatible with the pgsql backend if any("id" in origin for origin in origins) and not all( "id" in origin for origin in origins ): raise StorageArgumentException( 'Either all origins or none at all should have an "id".' ) if any("url" in origin for origin in origins) and not all( "url" in origin for origin in origins ): raise StorageArgumentException( "Either all origins or none at all should have " 'an "url" key.' ) results = [] for origin in origins: result = None if "url" in origin: if origin["url"] in self._origins: result = self._origins[origin["url"]] else: raise StorageArgumentException("Origin must have an url.") results.append(self._convert_origin(result)) if return_single: assert len(results) == 1 return results[0] else: return results def origin_get_by_sha1(self, sha1s): return [self._convert_origin(self._origins_by_sha1.get(sha1)) for sha1 in sha1s] def origin_get_range(self, origin_from=1, origin_count=100): origin_from = max(origin_from, 1) if origin_from <= len(self._origins_by_id): max_idx = origin_from + origin_count - 1 if max_idx > len(self._origins_by_id): max_idx = len(self._origins_by_id) for idx in range(origin_from - 1, max_idx): origin = self._convert_origin(self._origins[self._origins_by_id[idx]]) yield {"id": idx + 1, **origin} def origin_list(self, page_token: Optional[str] = None, limit: int = 100) -> dict: origin_urls = sorted(self._origins) if page_token: from_ = bisect.bisect_left(origin_urls, page_token) else: from_ = 0 result = { "origins": [ {"url": origin_url} for origin_url in origin_urls[from_ : from_ + limit] ] } if from_ + limit < len(origin_urls): result["next_page_token"] = origin_urls[from_ + limit] return result def origin_search( self, url_pattern, offset=0, limit=50, regexp=False, with_visit=False ): origins = map(self._convert_origin, self._origins.values()) if regexp: pat = re.compile(url_pattern) origins = [orig for orig in origins if pat.search(orig["url"])] else: origins = [orig for orig in origins if url_pattern in orig["url"]] if with_visit: filtered_origins = [] for orig in origins: visits = ( self._origin_visit_get_updated(ov.origin, ov.visit) for ov in self._origin_visits[orig["url"]] ) for ov in visits: if ov.snapshot and ov.snapshot in self._snapshots: filtered_origins.append(orig) break else: filtered_origins = origins return filtered_origins[offset : offset + limit] def origin_count(self, url_pattern, regexp=False, with_visit=False): return len( self.origin_search( url_pattern, regexp=regexp, with_visit=with_visit, limit=len(self._origins), ) ) def origin_add(self, origins: Iterable[Origin]) -> List[Dict]: origins = copy.deepcopy(list(origins)) for origin in origins: self.origin_add_one(origin) return [origin.to_dict() for origin in origins] def origin_add_one(self, origin: Origin) -> str: if origin.url not in self._origins: self.journal_writer.origin_add([origin]) # generate an origin_id because it is needed by origin_get_range. # TODO: remove this when we remove origin_get_range origin_id = len(self._origins) + 1 self._origins_by_id.append(origin.url) assert len(self._origins_by_id) == origin_id self._origins[origin.url] = origin self._origins_by_sha1[origin_url_to_sha1(origin.url)] = origin self._origin_visits[origin.url] = [] self._objects[origin.url].append(("origin", origin.url)) return origin.url def origin_visit_add( self, origin_url: str, date: Union[str, datetime.datetime], type: str ) -> OriginVisit: if isinstance(date, str): # FIXME: Converge on iso8601 at some point date = dateutil.parser.parse(date) elif not isinstance(date, datetime.datetime): raise StorageArgumentException("Date must be a datetime or a string") origin = self.origin_get({"url": origin_url}) if not origin: # Cannot add a visit without an origin raise StorageArgumentException("Unknown origin %s", origin_url) if origin_url in self._origins: origin = self._origins[origin_url] # visit ids are in the range [1, +inf[ visit_id = len(self._origin_visits[origin_url]) + 1 status = "ongoing" with convert_validation_exceptions(): visit = OriginVisit( origin=origin_url, date=date, type=type, # TODO: Remove when we remove those fields from the model status=status, snapshot=None, metadata=None, visit=visit_id, ) self._origin_visits[origin_url].append(visit) assert visit.visit is not None visit_key = (origin_url, visit.visit) with convert_validation_exceptions(): visit_update = OriginVisitStatus( origin=origin_url, visit=visit_id, date=date, status=status, snapshot=None, metadata=None, ) self._origin_visit_statuses[visit_key] = [visit_update] self._objects[visit_key].append(("origin_visit", None)) self.journal_writer.origin_visit_add([visit]) # return last visit return visit def origin_visit_update( self, origin: str, visit_id: int, status: str, metadata: Optional[Dict] = None, snapshot: Optional[bytes] = None, date: Optional[datetime.datetime] = None, ): origin_url = self._get_origin_url(origin) if origin_url is None: raise StorageArgumentException("Unknown origin.") try: visit = self._origin_visits[origin_url][visit_id - 1] except IndexError: raise StorageArgumentException("Unknown visit_id for this origin") from None # Retrieve the previous visit status assert visit.visit is not None visit_key = (origin_url, visit.visit) last_visit_update = max( self._origin_visit_statuses[visit_key], key=lambda v: v.date ) with convert_validation_exceptions(): visit_update = OriginVisitStatus( origin=origin_url, visit=visit_id, date=date or now(), status=status, snapshot=snapshot or last_visit_update.snapshot, metadata=metadata or last_visit_update.metadata, ) self._origin_visit_statuses[visit_key].append(visit_update) self.journal_writer.origin_visit_update( [self._origin_visit_get_updated(origin_url, visit_id)] ) self._origin_visits[origin_url][visit_id - 1] = visit def origin_visit_upsert(self, visits: Iterable[OriginVisit]) -> None: for visit in visits: if visit.visit is None: raise StorageArgumentException(f"Missing visit id for visit {visit}") self.journal_writer.origin_visit_upsert(visits) date = now() for visit in visits: assert visit.visit is not None origin_url = visit.origin origin = self.origin_get({"url": origin_url}) if not origin: # Cannot add a visit without an origin raise StorageArgumentException("Unknown origin %s", origin_url) if origin_url in self._origins: origin = self._origins[origin_url] # visit ids are in the range [1, +inf[ assert visit.visit is not None visit_key = (origin_url, visit.visit) with convert_validation_exceptions(): visit_update = OriginVisitStatus( origin=origin_url, visit=visit.visit, date=date, status=visit.status, snapshot=visit.snapshot, metadata=visit.metadata, ) self._origin_visit_statuses.setdefault(visit_key, []) while len(self._origin_visits[origin_url]) <= visit.visit: self._origin_visits[origin_url].append(None) self._origin_visits[origin_url][visit.visit - 1] = visit self._origin_visit_statuses[visit_key].append(visit_update) self._objects[visit_key].append(("origin_visit", None)) def _origin_visit_get_updated(self, origin: str, visit_id: int) -> OriginVisit: """Merge origin visit and latest origin visit status """ assert visit_id >= 1 visit = self._origin_visits[origin][visit_id - 1] assert visit is not None visit_key = (origin, visit_id) visit_update = max(self._origin_visit_statuses[visit_key], key=lambda v: v.date) return OriginVisit.from_dict( { # default to the values in visit **visit.to_dict(), # override with the last update **visit_update.to_dict(), # but keep the date of the creation of the origin visit "date": visit.date, } ) def origin_visit_get( self, origin: str, last_visit: Optional[int] = None, limit: Optional[int] = None ) -> Iterable[Dict[str, Any]]: origin_url = self._get_origin_url(origin) if origin_url in self._origin_visits: visits = self._origin_visits[origin_url] if last_visit is not None: visits = visits[last_visit:] if limit is not None: visits = visits[:limit] for visit in visits: if not visit: continue visit_id = visit.visit visit_update = self._origin_visit_get_updated(origin_url, visit_id) assert visit_update is not None yield visit_update.to_dict() def origin_visit_find_by_date( self, origin: str, visit_date: datetime.datetime ) -> Optional[Dict[str, Any]]: origin_url = self._get_origin_url(origin) if origin_url in self._origin_visits: visits = self._origin_visits[origin_url] visit = min(visits, key=lambda v: (abs(v.date - visit_date), -v.visit)) visit_update = self._origin_visit_get_updated(origin, visit.visit) assert visit_update is not None return visit_update.to_dict() return None def origin_visit_get_by(self, origin: str, visit: int) -> Optional[Dict[str, Any]]: origin_url = self._get_origin_url(origin) if origin_url in self._origin_visits and visit <= len( self._origin_visits[origin_url] ): visit_update = self._origin_visit_get_updated(origin_url, visit) assert visit_update is not None return visit_update.to_dict() return None def origin_visit_get_latest( self, origin: str, allowed_statuses: Optional[List[str]] = None, require_snapshot: bool = False, ) -> Optional[Dict[str, Any]]: ori = self._origins.get(origin) if not ori: return None visits = self._origin_visits[ori.url] visits = [ self._origin_visit_get_updated(visit.origin, visit.visit) for visit in visits if visit is not None ] if allowed_statuses is not None: visits = [visit for visit in visits if visit.status in allowed_statuses] if require_snapshot: visits = [visit for visit in visits if visit.snapshot] visit = max(visits, key=lambda v: (v.date, v.visit), default=None) if visit is None: return None return visit.to_dict() def _select_random_origin_visit_by_type(self, type: str) -> str: while True: url = random.choice(list(self._origin_visits.keys())) random_origin_visits = self._origin_visits[url] if random_origin_visits[0].type == type: return url def origin_visit_get_random(self, type: str) -> Optional[Dict[str, Any]]: url = self._select_random_origin_visit_by_type(type) random_origin_visits = copy.deepcopy(self._origin_visits[url]) random_origin_visits.reverse() back_in_the_day = now() - timedelta(weeks=12) # 3 months back # This should be enough for tests for visit in random_origin_visits: updated_visit = self._origin_visit_get_updated(url, visit.visit) assert updated_visit is not None if updated_visit.date > back_in_the_day and updated_visit.status == "full": return updated_visit.to_dict() else: return None def stat_counters(self): keys = ( "content", "directory", "origin", "origin_visit", "person", "release", "revision", "skipped_content", "snapshot", ) stats = {key: 0 for key in keys} stats.update( collections.Counter( obj_type for (obj_type, obj_id) in itertools.chain(*self._objects.values()) ) ) return stats def refresh_stat_counters(self): pass - def origin_metadata_add(self, origin_url, ts, provider, tool, metadata): + def origin_metadata_add( + self, + origin_url: str, + discovery_date: datetime.datetime, + authority: Dict[str, Any], + fetcher: Dict[str, Any], + format: str, + metadata: bytes, + ) -> None: if not isinstance(origin_url, str): - raise TypeError("origin_id must be str, not %r" % (origin_url,)) - - if isinstance(ts, str): - ts = dateutil.parser.parse(ts) + raise StorageArgumentException( + "origin_id must be str, not %r" % (origin_url,) + ) + authority_key = self._metadata_authority_key(authority) + if authority_key not in self._metadata_authorities: + raise StorageArgumentException(f"Unknown authority {authority}") + fetcher_key = self._metadata_fetcher_key(fetcher) + if fetcher_key not in self._metadata_fetchers: + raise StorageArgumentException(f"Unknown fetcher {fetcher}") origin_metadata = { "origin_url": origin_url, - "discovery_date": ts, - "tool_id": tool, + "discovery_date": discovery_date, + "authority": authority_key, + "fetcher": fetcher_key, + "format": format, "metadata": metadata, - "provider_id": provider, } - self._origin_metadata[origin_url].append(origin_metadata) + self._origin_metadata[origin_url][authority_key].add(origin_metadata) return None - def origin_metadata_get_by(self, origin_url, provider_type=None): + def origin_metadata_get( + self, + origin_url: str, + authority: Dict[str, str], + after: Optional[datetime.datetime] = None, + limit: Optional[int] = None, + ) -> List[Dict[str, Any]]: if not isinstance(origin_url, str): raise TypeError("origin_url must be str, not %r" % (origin_url,)) - metadata = [] - for item in self._origin_metadata[origin_url]: - item = copy.deepcopy(item) - provider = self.metadata_provider_get(item["provider_id"]) - for attr_name in ("name", "type", "url"): - item["provider_" + attr_name] = provider["provider_" + attr_name] - metadata.append(item) - return metadata - - def tool_add(self, tools): - inserted = [] - for tool in tools: - key = self._tool_key(tool) - assert "id" not in tool - record = copy.deepcopy(tool) - record["id"] = key # TODO: remove this - if key not in self._tools: - self._tools[key] = record - inserted.append(copy.deepcopy(self._tools[key])) - - return inserted - - def tool_get(self, tool): - return self._tools.get(self._tool_key(tool)) - - def metadata_provider_add( - self, provider_name, provider_type, provider_url, metadata - ): - provider = { - "provider_name": provider_name, - "provider_type": provider_type, - "provider_url": provider_url, + + authority_key = self._metadata_authority_key(authority) + + if after is None: + entries = iter(self._origin_metadata[origin_url][authority_key]) + else: + entries = self._origin_metadata[origin_url][authority_key].iter_from(after) + if limit: + entries = itertools.islice(entries, 0, limit) + + results = [] + for entry in entries: + authority = self._metadata_authorities[entry["authority"]] + fetcher = self._metadata_fetchers[entry["fetcher"]] + results.append( + { + **entry, + "authority": {"type": authority["type"], "url": authority["url"],}, + "fetcher": { + "name": fetcher["name"], + "version": fetcher["version"], + }, + } + ) + return results + + def metadata_fetcher_add( + self, name: str, version: str, metadata: Dict[str, Any] + ) -> None: + fetcher = { + "name": name, + "version": version, "metadata": metadata, } - key = self._metadata_provider_key(provider) - provider["id"] = key - self._metadata_providers[key] = provider - return key + key = self._metadata_fetcher_key(fetcher) + if key not in self._metadata_fetchers: + self._metadata_fetchers[key] = fetcher + + def metadata_fetcher_get(self, name: str, version: str) -> Optional[Dict[str, Any]]: + return self._metadata_fetchers.get( + self._metadata_fetcher_key({"name": name, "version": version}) + ) - def metadata_provider_get(self, provider_id): - return self._metadata_providers.get(provider_id) + def metadata_authority_add( + self, type: str, url: str, metadata: Dict[str, Any] + ) -> None: + authority = { + "type": type, + "url": url, + "metadata": metadata, + } + key = self._metadata_authority_key(authority) + self._metadata_authorities[key] = authority - def metadata_provider_get_by(self, provider): - key = self._metadata_provider_key(provider) - return self._metadata_providers.get(key) + def metadata_authority_get(self, type: str, url: str) -> Optional[Dict[str, Any]]: + return self._metadata_authorities.get( + self._metadata_authority_key({"type": type, "url": url}) + ) def _get_origin_url(self, origin): if isinstance(origin, str): return origin else: raise TypeError("origin must be a string.") def _person_add(self, person): key = ("person", person.fullname) if key not in self._objects: person_id = len(self._persons) + 1 self._persons.append(person) self._objects[key].append(("person", person_id)) else: person_id = self._objects[key][0][1] person = self._persons[person_id - 1] return person @staticmethod def _content_key(content): """ A stable key and the algorithm for a content""" if isinstance(content, BaseContent): content = content.to_dict() return tuple((key, content.get(key)) for key in sorted(DEFAULT_ALGORITHMS)) @staticmethod - def _tool_key(tool): - return "%r %r %r" % ( - tool["name"], - tool["version"], - tuple(sorted(tool["configuration"].items())), - ) + def _metadata_fetcher_key(fetcher: Dict) -> Hashable: + return (fetcher["name"], fetcher["version"]) @staticmethod - def _metadata_provider_key(provider): - return "%r %r" % (provider["provider_name"], provider["provider_url"]) + def _metadata_authority_key(authority: Dict) -> Hashable: + return (authority["type"], authority["url"]) def diff_directories(self, from_dir, to_dir, track_renaming=False): raise NotImplementedError("InMemoryStorage.diff_directories") def diff_revisions(self, from_rev, to_rev, track_renaming=False): raise NotImplementedError("InMemoryStorage.diff_revisions") def diff_revision(self, revision, track_renaming=False): raise NotImplementedError("InMemoryStorage.diff_revision") def clear_buffers(self, object_types: Optional[Iterable[str]] = None) -> None: """Do nothing """ return None def flush(self, object_types: Optional[Iterable[str]] = None) -> Dict: return {} diff --git a/swh/storage/interface.py b/swh/storage/interface.py index 6728c010..e36f5aa8 100644 --- a/swh/storage/interface.py +++ b/swh/storage/interface.py @@ -1,1321 +1,1319 @@ # Copyright (C) 2015-2020 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 datetime from typing import Any, Dict, Iterable, List, Optional, Union from swh.core.api import remote_api_endpoint from swh.model.model import ( Content, Directory, Origin, OriginVisit, Revision, Release, Snapshot, SkippedContent, ) def deprecated(f): f.deprecated_endpoint = True return f class StorageInterface: @remote_api_endpoint("check_config") def check_config(self, *, check_write): """Check that the storage is configured and ready to go.""" ... @remote_api_endpoint("content/add") def content_add(self, content: Iterable[Content]) -> Dict: """Add content blobs to the storage Args: contents (iterable): iterable of dictionaries representing individual pieces of content to add. Each dictionary has the following keys: - data (bytes): the actual content - length (int): content length - one key for each checksum algorithm in :data:`swh.model.hashutil.ALGORITHMS`, mapped to the corresponding checksum - status (str): one of visible, hidden Raises: The following exceptions can occur: - HashCollision in case of collision - Any other exceptions raise by the db In case of errors, some of the content may have been stored in the DB and in the objstorage. Since additions to both idempotent, that should not be a problem. Returns: Summary dict with the following keys and associated values: content:add: New contents added content:add:bytes: Sum of the contents' length data """ ... @remote_api_endpoint("content/update") def content_update(self, content, keys=[]): """Update content blobs to the storage. Does nothing for unknown contents or skipped ones. Args: content (iterable): iterable of dictionaries representing individual pieces of content to update. Each dictionary has the following keys: - data (bytes): the actual content - length (int): content length (default: -1) - one key for each checksum algorithm in :data:`swh.model.hashutil.ALGORITHMS`, mapped to the corresponding checksum - status (str): one of visible, hidden, absent keys (list): List of keys (str) whose values needs an update, e.g., new hash column """ ... @remote_api_endpoint("content/add_metadata") def content_add_metadata(self, content: Iterable[Content]) -> Dict: """Add content metadata to the storage (like `content_add`, but without inserting to the objstorage). Args: content (iterable): iterable of dictionaries representing individual pieces of content to add. Each dictionary has the following keys: - length (int): content length (default: -1) - one key for each checksum algorithm in :data:`swh.model.hashutil.ALGORITHMS`, mapped to the corresponding checksum - status (str): one of visible, hidden, absent - reason (str): if status = absent, the reason why - origin (int): if status = absent, the origin we saw the content in - ctime (datetime): time of insertion in the archive Returns: Summary dict with the following key and associated values: content:add: New contents added skipped_content:add: New skipped contents (no data) added """ ... @remote_api_endpoint("content/data") def content_get(self, content): """Retrieve in bulk contents and their data. This generator yields exactly as many items than provided sha1 identifiers, but callers should not assume this will always be true. It may also yield `None` values in case an object was not found. Args: content: iterables of sha1 Yields: Dict[str, bytes]: Generates streams of contents as dict with their raw data: - sha1 (bytes): content id - data (bytes): content's raw data Raises: ValueError in case of too much contents are required. cf. BULK_BLOCK_CONTENT_LEN_MAX """ ... @deprecated @remote_api_endpoint("content/range") def content_get_range(self, start, end, limit=1000): """Retrieve contents within range [start, end] bound by limit. Note that this function may return more than one blob per hash. The limit is enforced with multiplicity (ie. two blobs with the same hash will count twice toward the limit). Args: **start** (bytes): Starting identifier range (expected smaller than end) **end** (bytes): Ending identifier range (expected larger than start) **limit** (int): Limit result (default to 1000) Returns: a dict with keys: - contents [dict]: iterable of contents in between the range. - next (bytes): There remains content in the range starting from this next sha1 """ ... @remote_api_endpoint("content/partition") def content_get_partition( self, partition_id: int, nb_partitions: int, limit: int = 1000, page_token: str = None, ): """Splits contents into nb_partitions, and returns one of these based on partition_id (which must be in [0, nb_partitions-1]) There is no guarantee on how the partitioning is done, or the result order. Args: partition_id (int): index of the partition to fetch nb_partitions (int): total number of partitions to split into limit (int): Limit result (default to 1000) page_token (Optional[str]): opaque token used for pagination. Returns: a dict with keys: - contents (List[dict]): iterable of contents in the partition. - **next_page_token** (Optional[str]): opaque token to be used as `page_token` for retrieving the next page. if absent, there is no more pages to gather. """ ... @remote_api_endpoint("content/metadata") def content_get_metadata(self, contents: List[bytes]) -> Dict[bytes, List[Dict]]: """Retrieve content metadata in bulk Args: content: iterable of content identifiers (sha1) Returns: a dict with keys the content's sha1 and the associated value either the existing content's metadata or None if the content does not exist. """ ... @remote_api_endpoint("content/missing") def content_missing(self, content, key_hash="sha1"): """List content missing from storage Args: content ([dict]): iterable of dictionaries whose keys are either 'length' or an item of :data:`swh.model.hashutil.ALGORITHMS`; mapped to the corresponding checksum (or length). key_hash (str): name of the column to use as hash id result (default: 'sha1') Returns: iterable ([bytes]): missing content ids (as per the key_hash column) Raises: TODO: an exception when we get a hash collision. """ ... @remote_api_endpoint("content/missing/sha1") def content_missing_per_sha1(self, contents): """List content missing from storage based only on sha1. Args: contents: Iterable of sha1 to check for absence. Returns: iterable: missing ids Raises: TODO: an exception when we get a hash collision. """ ... @remote_api_endpoint("content/missing/sha1_git") def content_missing_per_sha1_git(self, contents): """List content missing from storage based only on sha1_git. Args: contents (Iterable): An iterable of content id (sha1_git) Yields: missing contents sha1_git """ ... @remote_api_endpoint("content/present") def content_find(self, content): """Find a content hash in db. Args: content: a dictionary representing one content hash, mapping checksum algorithm names (see swh.model.hashutil.ALGORITHMS) to checksum values Returns: a triplet (sha1, sha1_git, sha256) if the content exist or None otherwise. Raises: ValueError: in case the key of the dictionary is not sha1, sha1_git nor sha256. """ ... @remote_api_endpoint("content/get_random") def content_get_random(self): """Finds a random content id. Returns: a sha1_git """ ... @remote_api_endpoint("content/skipped/add") def skipped_content_add(self, content: Iterable[SkippedContent]) -> Dict: """Add contents to the skipped_content list, which contains (partial) information about content missing from the archive. Args: contents (iterable): iterable of dictionaries representing individual pieces of content to add. Each dictionary has the following keys: - length (Optional[int]): content length (default: -1) - one key for each checksum algorithm in :data:`swh.model.hashutil.ALGORITHMS`, mapped to the corresponding checksum; each is optional - status (str): must be "absent" - reason (str): the reason why the content is absent - origin (int): if status = absent, the origin we saw the content in Raises: The following exceptions can occur: - HashCollision in case of collision - Any other exceptions raise by the backend In case of errors, some content may have been stored in the DB and in the objstorage. Since additions to both idempotent, that should not be a problem. Returns: Summary dict with the following key and associated values: skipped_content:add: New skipped contents (no data) added """ ... @remote_api_endpoint("content/skipped/missing") def skipped_content_missing(self, contents): """List skipped_content missing from storage Args: content: iterable of dictionaries containing the data for each checksum algorithm. Returns: iterable: missing signatures """ ... @remote_api_endpoint("directory/add") def directory_add(self, directories: Iterable[Directory]) -> Dict: """Add directories to the storage Args: directories (iterable): iterable of dictionaries representing the individual directories to add. Each dict has the following keys: - id (sha1_git): the id of the directory to add - entries (list): list of dicts for each entry in the directory. Each dict has the following keys: - name (bytes) - type (one of 'file', 'dir', 'rev'): type of the directory entry (file, directory, revision) - target (sha1_git): id of the object pointed at by the directory entry - perms (int): entry permissions Returns: Summary dict of keys with associated count as values: directory:add: Number of directories actually added """ ... @remote_api_endpoint("directory/missing") def directory_missing(self, directories): """List directories missing from storage Args: directories (iterable): an iterable of directory ids Yields: missing directory ids """ ... @remote_api_endpoint("directory/ls") def directory_ls(self, directory, recursive=False): """Get entries for one directory. Args: - directory: the directory to list entries from. - recursive: if flag on, this list recursively from this directory. Returns: List of entries for such directory. If `recursive=True`, names in the path of a dir/file not at the root are concatenated with a slash (`/`). """ ... @remote_api_endpoint("directory/path") def directory_entry_get_by_path(self, directory, paths): """Get the directory entry (either file or dir) from directory with path. Args: - directory: sha1 of the top level directory - paths: path to lookup from the top level directory. From left (top) to right (bottom). Returns: The corresponding directory entry if found, None otherwise. """ ... @remote_api_endpoint("directory/get_random") def directory_get_random(self): """Finds a random directory id. Returns: a sha1_git """ ... @remote_api_endpoint("revision/add") def revision_add(self, revisions: Iterable[Revision]) -> Dict: """Add revisions to the storage Args: revisions (Iterable[dict]): iterable of dictionaries representing the individual revisions to add. Each dict has the following keys: - **id** (:class:`sha1_git`): id of the revision to add - **date** (:class:`dict`): date the revision was written - **committer_date** (:class:`dict`): date the revision got added to the origin - **type** (one of 'git', 'tar'): type of the revision added - **directory** (:class:`sha1_git`): the directory the revision points at - **message** (:class:`bytes`): the message associated with the revision - **author** (:class:`Dict[str, bytes]`): dictionary with keys: name, fullname, email - **committer** (:class:`Dict[str, bytes]`): dictionary with keys: name, fullname, email - **metadata** (:class:`jsonb`): extra information as dictionary - **synthetic** (:class:`bool`): revision's nature (tarball, directory creates synthetic revision`) - **parents** (:class:`list[sha1_git]`): the parents of this revision date dictionaries have the form defined in :mod:`swh.model`. Returns: Summary dict of keys with associated count as values revision:add: New objects actually stored in db """ ... @remote_api_endpoint("revision/missing") def revision_missing(self, revisions): """List revisions missing from storage Args: revisions (iterable): revision ids Yields: missing revision ids """ ... @remote_api_endpoint("revision") def revision_get(self, revisions): """Get all revisions from storage Args: revisions: an iterable of revision ids Returns: iterable: an iterable of revisions as dictionaries (or None if the revision doesn't exist) """ ... @remote_api_endpoint("revision/log") def revision_log(self, revisions, limit=None): """Fetch revision entry from the given root revisions. Args: revisions: array of root revision to lookup limit: limitation on the output result. Default to None. Yields: List of revision log from such revisions root. """ ... @remote_api_endpoint("revision/shortlog") def revision_shortlog(self, revisions, limit=None): """Fetch the shortlog for the given revisions Args: revisions: list of root revisions to lookup limit: depth limitation for the output Yields: a list of (id, parents) tuples. """ ... @remote_api_endpoint("revision/get_random") def revision_get_random(self): """Finds a random revision id. Returns: a sha1_git """ ... @remote_api_endpoint("release/add") def release_add(self, releases: Iterable[Release]) -> Dict: """Add releases to the storage Args: releases (Iterable[dict]): iterable of dictionaries representing the individual releases to add. Each dict has the following keys: - **id** (:class:`sha1_git`): id of the release to add - **revision** (:class:`sha1_git`): id of the revision the release points to - **date** (:class:`dict`): the date the release was made - **name** (:class:`bytes`): the name of the release - **comment** (:class:`bytes`): the comment associated with the release - **author** (:class:`Dict[str, bytes]`): dictionary with keys: name, fullname, email the date dictionary has the form defined in :mod:`swh.model`. Returns: Summary dict of keys with associated count as values release:add: New objects contents actually stored in db """ ... @remote_api_endpoint("release/missing") def release_missing(self, releases): """List releases missing from storage Args: releases: an iterable of release ids Returns: a list of missing release ids """ ... @remote_api_endpoint("release") def release_get(self, releases): """Given a list of sha1, return the releases's information Args: releases: list of sha1s Yields: dicts with the same keys as those given to `release_add` (or ``None`` if a release does not exist) """ ... @remote_api_endpoint("release/get_random") def release_get_random(self): """Finds a random release id. Returns: a sha1_git """ ... @remote_api_endpoint("snapshot/add") def snapshot_add(self, snapshots: Iterable[Snapshot]) -> Dict: """Add snapshots to the storage. Args: snapshot ([dict]): the snapshots to add, containing the following keys: - **id** (:class:`bytes`): id of the snapshot - **branches** (:class:`dict`): branches the snapshot contains, mapping the branch name (:class:`bytes`) to the branch target, itself a :class:`dict` (or ``None`` if the branch points to an unknown object) - **target_type** (:class:`str`): one of ``content``, ``directory``, ``revision``, ``release``, ``snapshot``, ``alias`` - **target** (:class:`bytes`): identifier of the target (currently a ``sha1_git`` for all object kinds, or the name of the target branch for aliases) Raises: ValueError: if the origin or visit id does not exist. Returns: Summary dict of keys with associated count as values snapshot:add: Count of object actually stored in db """ ... @remote_api_endpoint("snapshot/missing") def snapshot_missing(self, snapshots): """List snapshots missing from storage Args: snapshots (iterable): an iterable of snapshot ids Yields: missing snapshot ids """ ... @remote_api_endpoint("snapshot") def snapshot_get(self, snapshot_id): """Get the content, possibly partial, of a snapshot with the given id The branches of the snapshot are iterated in the lexicographical order of their names. .. warning:: At most 1000 branches contained in the snapshot will be returned for performance reasons. In order to browse the whole set of branches, the method :meth:`snapshot_get_branches` should be used instead. Args: snapshot_id (bytes): identifier of the snapshot Returns: dict: a dict with three keys: * **id**: identifier of the snapshot * **branches**: a dict of branches contained in the snapshot whose keys are the branches' names. * **next_branch**: the name of the first branch not returned or :const:`None` if the snapshot has less than 1000 branches. """ ... @remote_api_endpoint("snapshot/by_origin_visit") def snapshot_get_by_origin_visit(self, origin, visit): """Get the content, possibly partial, of a snapshot for the given origin visit The branches of the snapshot are iterated in the lexicographical order of their names. .. warning:: At most 1000 branches contained in the snapshot will be returned for performance reasons. In order to browse the whole set of branches, the method :meth:`snapshot_get_branches` should be used instead. Args: origin (int): the origin identifier visit (int): the visit identifier Returns: dict: None if the snapshot does not exist; a dict with three keys otherwise: * **id**: identifier of the snapshot * **branches**: a dict of branches contained in the snapshot whose keys are the branches' names. * **next_branch**: the name of the first branch not returned or :const:`None` if the snapshot has less than 1000 branches. """ ... @remote_api_endpoint("snapshot/latest") def snapshot_get_latest(self, origin, allowed_statuses=None): """Get the content, possibly partial, of the latest snapshot for the given origin, optionally only from visits that have one of the given allowed_statuses The branches of the snapshot are iterated in the lexicographical order of their names. .. warning:: At most 1000 branches contained in the snapshot will be returned for performance reasons. In order to browse the whole set of branches, the method :meth:`snapshot_get_branches` should be used instead. Args: origin (str): the origin's URL allowed_statuses (list of str): list of visit statuses considered to find the latest snapshot for the visit. For instance, ``allowed_statuses=['full']`` will only consider visits that have successfully run to completion. Returns: dict: a dict with three keys: * **id**: identifier of the snapshot * **branches**: a dict of branches contained in the snapshot whose keys are the branches' names. * **next_branch**: the name of the first branch not returned or :const:`None` if the snapshot has less than 1000 branches. """ ... @remote_api_endpoint("snapshot/count_branches") def snapshot_count_branches(self, snapshot_id): """Count the number of branches in the snapshot with the given id Args: snapshot_id (bytes): identifier of the snapshot Returns: dict: A dict whose keys are the target types of branches and values their corresponding amount """ ... @remote_api_endpoint("snapshot/get_branches") def snapshot_get_branches( self, snapshot_id, branches_from=b"", branches_count=1000, target_types=None ): """Get the content, possibly partial, of a snapshot with the given id The branches of the snapshot are iterated in the lexicographical order of their names. Args: snapshot_id (bytes): identifier of the snapshot branches_from (bytes): optional parameter used to skip branches whose name is lesser than it before returning them branches_count (int): optional parameter used to restrain the amount of returned branches target_types (list): optional parameter used to filter the target types of branch to return (possible values that can be contained in that list are `'content', 'directory', 'revision', 'release', 'snapshot', 'alias'`) Returns: dict: None if the snapshot does not exist; a dict with three keys otherwise: * **id**: identifier of the snapshot * **branches**: a dict of branches contained in the snapshot whose keys are the branches' names. * **next_branch**: the name of the first branch not returned or :const:`None` if the snapshot has less than `branches_count` branches after `branches_from` included. """ ... @remote_api_endpoint("snapshot/get_random") def snapshot_get_random(self): """Finds a random snapshot id. Returns: a sha1_git """ ... @remote_api_endpoint("origin/visit/add") def origin_visit_add( self, origin_url: str, date: Union[str, datetime.datetime], type: str ) -> OriginVisit: """Add an origin_visit for the origin at ts with status 'ongoing'. Args: origin_url: visited origin identifier (its URL) date: timestamp of such visit type: the type of loader used for the visit (hg, git, ...) Raises: StorageArgumentException if the date is mistyped, or the origin is unknown. Returns: dict: dictionary with keys origin and visit where: - origin: origin object - visit: the visit object for the new visit occurrence """ ... @remote_api_endpoint("origin/visit/update") def origin_visit_update( self, origin: str, visit_id: int, status: str, metadata: Optional[Dict] = None, snapshot: Optional[bytes] = None, date: Optional[datetime.datetime] = None, ): """Update an origin_visit's status. Args: origin (str): visited origin's URL visit_id: Visit's id status: Visit's new status metadata: Data associated to the visit snapshot (sha1_git): identifier of the snapshot to add to the visit date: Update date Returns: None """ ... @remote_api_endpoint("origin/visit/upsert") def origin_visit_upsert(self, visits: Iterable[OriginVisit]) -> None: """Add a origin_visits with a specific id and with all its data. If there is already an origin_visit with the same `(origin_id, visit_id)`, overwrites it. Args: visits: iterable of dicts with keys: - **origin**: dict with keys either `id` or `url` - **visit**: origin visit id - **date**: timestamp of such visit - **status**: Visit's new status - **metadata**: Data associated to the visit - **snapshot**: identifier of the snapshot to add to the visit """ ... @remote_api_endpoint("origin/visit/get") def origin_visit_get( self, origin: str, last_visit: Optional[int] = None, limit: Optional[int] = None ) -> Iterable[Dict[str, Any]]: """Retrieve all the origin's visit's information. Args: origin: The visited origin last_visit: Starting point from which listing the next visits Default to None limit: Number of results to return from the last visit. Default to None Yields: List of visits. """ ... @remote_api_endpoint("origin/visit/find_by_date") def origin_visit_find_by_date( self, origin: str, visit_date: datetime.datetime ) -> Optional[Dict[str, Any]]: """Retrieves the origin visit whose date is closest to the provided timestamp. In case of a tie, the visit with largest id is selected. Args: origin: origin (URL) visit_date: expected visit date Returns: A visit """ ... @remote_api_endpoint("origin/visit/getby") def origin_visit_get_by(self, origin: str, visit: int) -> Optional[Dict[str, Any]]: """Retrieve origin visit's information. Args: origin: origin (URL) visit: visit id Returns: The information on that particular (origin, visit) or None if it does not exist """ ... @remote_api_endpoint("origin/visit/get_latest") def origin_visit_get_latest( self, origin: str, allowed_statuses: Optional[List[str]] = None, require_snapshot: bool = False, ) -> Optional[Dict[str, Any]]: """Get the latest origin visit for the given origin, optionally looking only for those with one of the given allowed_statuses or for those with a known snapshot. Args: origin: origin URL allowed_statuses: list of visit statuses considered to find the latest visit. For instance, ``allowed_statuses=['full']`` will only consider visits that have successfully run to completion. require_snapshot: If True, only a visit with a snapshot will be returned. Returns: dict: a dict with the following keys: - **origin**: the URL of the origin - **visit**: origin visit id - **type**: type of loader used for the visit - **date**: timestamp of such visit - **status**: Visit's new status - **metadata**: Data associated to the visit - **snapshot** (Optional[sha1_git]): identifier of the snapshot associated to the visit """ ... @remote_api_endpoint("origin/visit/get_random") def origin_visit_get_random(self, type: str) -> Optional[Dict[str, Any]]: """Randomly select one successful origin visit with made in the last 3 months. Returns: dict representing an origin visit, in the same format as :py:meth:`origin_visit_get`. """ ... @remote_api_endpoint("object/find_by_sha1_git") def object_find_by_sha1_git(self, ids): """Return the objects found with the given ids. Args: ids: a generator of sha1_gits Returns: dict: a mapping from id to the list of objects found. Each object found is itself a dict with keys: - sha1_git: the input id - type: the type of object found """ ... @remote_api_endpoint("origin/get") def origin_get(self, origins): """Return origins, either all identified by their ids or all identified by tuples (type, url). If the url is given and the type is omitted, one of the origins with that url is returned. Args: origin: a list of dictionaries representing the individual origins to find. These dicts have the key url: - url (bytes): the url the origin points to Returns: dict: the origin dictionary with the keys: - id: origin's id - url: origin's url Raises: ValueError: if the url or the id don't exist. """ ... @remote_api_endpoint("origin/get_sha1") def origin_get_by_sha1(self, sha1s): """Return origins, identified by the sha1 of their URLs. Args: sha1s (list[bytes]): a list of sha1s Yields: dicts containing origin information as returned by :meth:`swh.storage.storage.Storage.origin_get`, or None if an origin matching the sha1 is not found. """ ... @deprecated @remote_api_endpoint("origin/get_range") def origin_get_range(self, origin_from=1, origin_count=100): """Retrieve ``origin_count`` origins whose ids are greater or equal than ``origin_from``. Origins are sorted by id before retrieving them. Args: origin_from (int): the minimum id of origins to retrieve origin_count (int): the maximum number of origins to retrieve Yields: dicts containing origin information as returned by :meth:`swh.storage.storage.Storage.origin_get`. """ ... @remote_api_endpoint("origin/list") def origin_list(self, page_token: Optional[str] = None, limit: int = 100) -> dict: """Returns the list of origins Args: page_token: opaque token used for pagination. limit: the maximum number of results to return Returns: dict: dict with the following keys: - **next_page_token** (str, optional): opaque token to be used as `page_token` for retrieving the next page. if absent, there is no more pages to gather. - **origins** (List[dict]): list of origins, as returned by `origin_get`. """ ... @remote_api_endpoint("origin/search") def origin_search( self, url_pattern, offset=0, limit=50, regexp=False, with_visit=False ): """Search for origins whose urls contain a provided string pattern or match a provided regular expression. The search is performed in a case insensitive way. Args: url_pattern (str): the string pattern to search for in origin urls offset (int): number of found origins to skip before returning results limit (int): the maximum number of found origins to return regexp (bool): if True, consider the provided pattern as a regular expression and return origins whose urls match it with_visit (bool): if True, filter out origins with no visit Yields: dicts containing origin information as returned by :meth:`swh.storage.storage.Storage.origin_get`. """ ... @deprecated @remote_api_endpoint("origin/count") def origin_count(self, url_pattern, regexp=False, with_visit=False): """Count origins whose urls contain a provided string pattern or match a provided regular expression. The pattern search in origin urls is performed in a case insensitive way. Args: url_pattern (str): the string pattern to search for in origin urls regexp (bool): if True, consider the provided pattern as a regular expression and return origins whose urls match it with_visit (bool): if True, filter out origins with no visit Returns: int: The number of origins matching the search criterion. """ ... @remote_api_endpoint("origin/add_multi") def origin_add(self, origins: Iterable[Origin]) -> List[Dict]: """Add origins to the storage Args: origins: list of dictionaries representing the individual origins, with the following keys: - type: the origin type ('git', 'svn', 'deb', ...) - url (bytes): the url the origin points to Returns: list: given origins as dict updated with their id """ ... @remote_api_endpoint("origin/add") def origin_add_one(self, origin: Origin) -> str: """Add origin to the storage Args: origin: dictionary representing the individual origin to add. This dict has the following keys: - type (FIXME: enum TBD): the origin type ('git', 'wget', ...) - url (bytes): the url the origin points to Returns: the id of the added origin, or of the identical one that already exists. """ ... def stat_counters(self): """compute statistics about the number of tuples in various tables Returns: dict: a dictionary mapping textual labels (e.g., content) to integer values (e.g., the number of tuples in table content) """ ... def refresh_stat_counters(self): """Recomputes the statistics for `stat_counters`.""" ... @remote_api_endpoint("origin/metadata/add") - def origin_metadata_add(self, origin_url, ts, provider, tool, metadata): - """ Add an origin_metadata for the origin at ts with provenance and - metadata. + def origin_metadata_add( + self, + origin_url: str, + discovery_date: datetime.datetime, + authority: Dict[str, Any], + fetcher: Dict[str, Any], + format: str, + metadata: bytes, + ) -> None: + """Add an origin_metadata for the origin at discovery_date, + obtained using the `fetcher` from the `authority`. + + The authority and fetcher must be known to the storage before + using this endpoint. Args: - origin_url (str): the origin url for which the metadata is added - ts (datetime): timestamp of the found metadata - provider (int): the provider of metadata (ex:'hal') - tool (int): tool used to extract metadata - metadata (jsonb): the metadata retrieved at the time and location + discovery_date: when the metadata was fetched. + authority: a dict containing keys `type` and `url`. + fetcher: a dict containing keys `name` and `version`. + format: text field indicating the format of the content of the + metadata: blob of raw metadata """ ... @remote_api_endpoint("origin/metadata/get") - def origin_metadata_get_by(self, origin_url, provider_type=None): + def origin_metadata_get( + self, + origin_url: str, + authority: Dict[str, str], + after: Optional[datetime.datetime] = None, + limit: Optional[int] = None, + ) -> List[Dict[str, Any]]: """Retrieve list of all origin_metadata entries for the origin_id Args: - origin_url (str): the origin's URL - provider_type (str): (optional) type of provider + origin_url: the origin's URL + authority: a dict containing keys `type` and `url`. + after: minimum discovery_date for a result to be returned + limit: maximum number of results to be returned Returns: - list of dicts: the origin_metadata dictionary with the keys: + list of dicts in the format: + + .. code-block: python - - origin_id (int): origin's id - - discovery_date (datetime): timestamp of discovery - - tool_id (int): metadata's extracting tool - - metadata (jsonb) - - provider_id (int): metadata's provider - - provider_name (str) - - provider_type (str) - - provider_url (str) + { + 'authority': {'type': ..., 'url': ...}, + 'fetcher': {'name': ..., 'version': ...}, + 'discovery_date': ..., + 'format': '...', + 'metadata': b'...' + } """ ... - @remote_api_endpoint("tool/add") - def tool_add(self, tools): - """Add new tools to the storage. - - Args: - tools (iterable of :class:`dict`): Tool information to add to - storage. Each tool is a :class:`dict` with the following keys: + @remote_api_endpoint("fetcher/add") + def metadata_fetcher_add( + self, name: str, version: str, metadata: Dict[str, Any] + ) -> None: + """Add a new metadata fetcher to the storage. - - name (:class:`str`): name of the tool - - version (:class:`str`): version of the tool - - configuration (:class:`dict`): configuration of the tool, - must be json-encodable + `name` and `version` together are a unique identifier of this + fetcher; and `metadata` is an arbitrary dict of JSONable data + with information about this fetcher. - Returns: - :class:`dict`: All the tools inserted in storage - (including the internal ``id``). The order of the list is not - guaranteed to match the order of the initial list. + Args: + name: the name of the fetcher + version: version of the fetcher """ ... - @remote_api_endpoint("tool/data") - def tool_get(self, tool): - """Retrieve tool information. + @remote_api_endpoint("fetcher/get") + def metadata_fetcher_get(self, name: str, version: str) -> Optional[Dict[str, Any]]: + """Retrieve information about a fetcher Args: - tool (dict): Tool information we want to retrieve from storage. - The dicts have the same keys as those used in :func:`tool_add`. + name: the name of the fetcher + version: version of the fetcher Returns: - dict: The full tool information if it exists (``id`` included), - None otherwise. + dictionary with keys `name`, `version`, and `metadata`; or None + if the fetcher is not known """ ... - @remote_api_endpoint("provider/add") - def metadata_provider_add( - self, provider_name, provider_type, provider_url, metadata - ): - """Add a metadata provider. + @remote_api_endpoint("authority/add") + def metadata_authority_add( + self, type: str, url: str, metadata: Dict[str, Any] + ) -> None: + """Add a metadata authority Args: - provider_name (str): Its name - provider_type (str): Its type (eg. `'deposit-client'`) - provider_url (str): Its URL + type: one of "deposit", "forge", or "registry" + url: unique URI identifying the authority metadata: JSON-encodable object - - Returns: - int: an identifier of the provider - """ - ... - - @remote_api_endpoint("provider/get") - def metadata_provider_get(self, provider_id): - """Get a metadata provider - - Args: - provider_id: Its identifier, as given by `metadata_provider_add`. - - Returns: - dict: same as `metadata_provider_add`; - or None if it does not exist. """ ... - @remote_api_endpoint("provider/getby") - def metadata_provider_get_by(self, provider): - """Get a metadata provider + @remote_api_endpoint("authority/get") + def metadata_authority_get(self, type: str, url: str) -> Optional[Dict[str, Any]]: + """Retrieve information about an authority Args: - provider (dict): A dictionary with keys: - * provider_name: Its name - * provider_url: Its URL + type: one of "deposit", "forge", or "registry" + url: unique URI identifying the authority Returns: - dict: same as `metadata_provider_add`; - or None if it does not exist. + dictionary with keys `type`, `url`, and `metadata`; or None + if the authority is not known """ ... @deprecated @remote_api_endpoint("algos/diff_directories") def diff_directories(self, from_dir, to_dir, track_renaming=False): """Compute the list of file changes introduced between two arbitrary directories (insertion / deletion / modification / renaming of files). Args: from_dir (bytes): identifier of the directory to compare from to_dir (bytes): identifier of the directory to compare to track_renaming (bool): whether or not to track files renaming Returns: A list of dict describing the introduced file changes (see :func:`swh.storage.algos.diff.diff_directories` for more details). """ ... @deprecated @remote_api_endpoint("algos/diff_revisions") def diff_revisions(self, from_rev, to_rev, track_renaming=False): """Compute the list of file changes introduced between two arbitrary revisions (insertion / deletion / modification / renaming of files). Args: from_rev (bytes): identifier of the revision to compare from to_rev (bytes): identifier of the revision to compare to track_renaming (bool): whether or not to track files renaming Returns: A list of dict describing the introduced file changes (see :func:`swh.storage.algos.diff.diff_directories` for more details). """ ... @deprecated @remote_api_endpoint("algos/diff_revision") def diff_revision(self, revision, track_renaming=False): """Compute the list of file changes introduced by a specific revision (insertion / deletion / modification / renaming of files) by comparing it against its first parent. Args: revision (bytes): identifier of the revision from which to compute the list of files changes track_renaming (bool): whether or not to track files renaming Returns: A list of dict describing the introduced file changes (see :func:`swh.storage.algos.diff.diff_directories` for more details). """ ... @remote_api_endpoint("clear/buffer") def clear_buffers(self, object_types: Optional[Iterable[str]] = None) -> None: """For backend storages (pg, storage, in-memory), this is a noop operation. For proxy storages (especially filter, buffer), this is an operation which cleans internal state. """ @remote_api_endpoint("flush") def flush(self, object_types: Optional[Iterable[str]] = None) -> Dict: """For backend storages (pg, storage, in-memory), this is expected to be a noop operation. For proxy storages (especially buffer), this is expected to trigger actual writes to the backend. """ ... diff --git a/swh/storage/retry.py b/swh/storage/retry.py index eb118977..2d2c335e 100644 --- a/swh/storage/retry.py +++ b/swh/storage/retry.py @@ -1,178 +1,178 @@ # Copyright (C) 2019-2020 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 logging import traceback from datetime import datetime -from typing import Dict, Iterable, List, Optional, Union +from typing import Any, Dict, Iterable, Optional, Union from tenacity import ( retry, stop_after_attempt, wait_random_exponential, ) from swh.model.model import ( Content, SkippedContent, Directory, Revision, Release, Snapshot, Origin, OriginVisit, ) from swh.storage import get_storage from swh.storage.exc import StorageArgumentException logger = logging.getLogger(__name__) def should_retry_adding(retry_state) -> bool: """Retry if the error/exception is (probably) not about a caller error """ try: attempt = retry_state.outcome except AttributeError: # tenacity < 5.0 attempt = retry_state if attempt.failed: error = attempt.exception() if isinstance(error, StorageArgumentException): # Exception is due to an invalid argument return False else: # Other exception module = getattr(error, "__module__", None) if module: error_name = error.__module__ + "." + error.__class__.__name__ else: error_name = error.__class__.__name__ logger.warning( "Retry adding a batch", exc_info=False, extra={ "swh_type": "storage_retry", "swh_exception_type": error_name, "swh_exception": traceback.format_exc(), }, ) return True else: # No exception return False swh_retry = retry( retry=should_retry_adding, wait=wait_random_exponential(multiplier=1, max=10), stop=stop_after_attempt(3), ) class RetryingProxyStorage: """Storage implementation which retries adding objects when it specifically fails (hash collision, integrity error). """ def __init__(self, storage): self.storage = get_storage(**storage) def __getattr__(self, key): if key == "storage": raise AttributeError(key) return getattr(self.storage, key) @swh_retry def content_add(self, content: Iterable[Content]) -> Dict: return self.storage.content_add(content) @swh_retry def content_add_metadata(self, content: Iterable[Content]) -> Dict: return self.storage.content_add_metadata(content) @swh_retry def skipped_content_add(self, content: Iterable[SkippedContent]) -> Dict: return self.storage.skipped_content_add(content) @swh_retry def origin_add_one(self, origin: Origin) -> str: return self.storage.origin_add_one(origin) @swh_retry def origin_visit_add( self, origin_url: str, date: Union[datetime, str], type: str ) -> OriginVisit: return self.storage.origin_visit_add(origin_url, date, type) @swh_retry def origin_visit_update( self, origin: str, visit_id: int, status: Optional[str] = None, metadata: Optional[Dict] = None, snapshot: Optional[Dict] = None, ) -> Dict: return self.storage.origin_visit_update( origin, visit_id, status=status, metadata=metadata, snapshot=snapshot ) @swh_retry - def tool_add(self, tools: Iterable[Dict]) -> List[Dict]: - tools = list(tools) - return self.storage.tool_add(tools) + def metadata_fetcher_add( + self, name: str, version: str, metadata: Dict[str, Any] + ) -> None: + return self.storage.metadata_fetcher_add(name, version, metadata) @swh_retry - def metadata_provider_add( - self, provider_name: str, provider_type: str, provider_url: str, metadata: Dict - ) -> Union[str, int]: - return self.storage.metadata_provider_add( - provider_name, provider_type, provider_url, metadata - ) + def metadata_authority_add( + self, type: str, url: str, metadata: Dict[str, Any] + ) -> None: + return self.storage.metadata_authority_add(type, url, metadata) @swh_retry def origin_metadata_add( self, origin_url: str, - ts: Union[str, datetime], - provider_id: int, - tool_id: int, - metadata: Dict, + discovery_date: datetime, + authority: Dict[str, Any], + fetcher: Dict[str, Any], + format: str, + metadata: bytes, ) -> None: return self.storage.origin_metadata_add( - origin_url, ts, provider_id, tool_id, metadata + origin_url, discovery_date, authority, fetcher, format, metadata ) @swh_retry def directory_add(self, directories: Iterable[Directory]) -> Dict: return self.storage.directory_add(directories) @swh_retry def revision_add(self, revisions: Iterable[Revision]) -> Dict: return self.storage.revision_add(revisions) @swh_retry def release_add(self, releases: Iterable[Release]) -> Dict: return self.storage.release_add(releases) @swh_retry def snapshot_add(self, snapshots: Iterable[Snapshot]) -> Dict: return self.storage.snapshot_add(snapshots) def clear_buffers(self, object_types: Optional[Iterable[str]] = None) -> None: return self.storage.clear_buffers(object_types) def flush(self, object_types: Optional[Iterable[str]] = None) -> Dict: """Specific case for buffer proxy storage failing to flush data """ return self.storage.flush(object_types) diff --git a/swh/storage/sql/30-swh-schema.sql b/swh/storage/sql/30-swh-schema.sql index b9b74293..29842415 100644 --- a/swh/storage/sql/30-swh-schema.sql +++ b/swh/storage/sql/30-swh-schema.sql @@ -1,488 +1,489 @@ --- --- SQL implementation of the Software Heritage data model --- -- schema versions create table dbversion ( version int primary key, release timestamptz, description text ); comment on table dbversion is 'Details of current db version'; comment on column dbversion.version is 'SQL schema version'; comment on column dbversion.release is 'Version deployment timestamp'; comment on column dbversion.description is 'Release description'; -- latest schema version insert into dbversion(version, release, description) - values(148, now(), 'Work In Progress'); + values(149, now(), 'Work In Progress'); -- a SHA1 checksum create domain sha1 as bytea check (length(value) = 20); -- a Git object ID, i.e., a Git-style salted SHA1 checksum create domain sha1_git as bytea check (length(value) = 20); -- a SHA256 checksum create domain sha256 as bytea check (length(value) = 32); -- a blake2 checksum create domain blake2s256 as bytea check (length(value) = 32); -- UNIX path (absolute, relative, individual path component, etc.) create domain unix_path as bytea; -- a set of UNIX-like access permissions, as manipulated by, e.g., chmod create domain file_perms as int; -- Checksums about actual file content. Note that the content itself is not -- stored in the DB, but on external (key-value) storage. A single checksum is -- used as key there, but the other can be used to verify that we do not inject -- content collisions not knowingly. create table content ( sha1 sha1 not null, sha1_git sha1_git not null, sha256 sha256 not null, blake2s256 blake2s256, length bigint not null, ctime timestamptz not null default now(), -- creation time, i.e. time of (first) injection into the storage status content_status not null default 'visible', object_id bigserial ); comment on table content is 'Checksums of file content which is actually stored externally'; comment on column content.sha1 is 'Content sha1 hash'; comment on column content.sha1_git is 'Git object sha1 hash'; comment on column content.sha256 is 'Content Sha256 hash'; comment on column content.blake2s256 is 'Content blake2s hash'; comment on column content.length is 'Content length'; comment on column content.ctime is 'First seen time'; comment on column content.status is 'Content status (absent, visible, hidden)'; comment on column content.object_id is 'Content identifier'; -- An origin is a place, identified by an URL, where software source code -- artifacts can be found. We support different kinds of origins, e.g., git and -- other VCS repositories, web pages that list tarballs URLs (e.g., -- http://www.kernel.org), indirect tarball URLs (e.g., -- http://www.example.org/latest.tar.gz), etc. The key feature of an origin is -- that it can be *fetched* from (wget, git clone, svn checkout, etc.) to -- retrieve all the contained software. create table origin ( id bigserial not null, url text not null ); comment on column origin.id is 'Artifact origin id'; comment on column origin.url is 'URL of origin'; -- Content blobs observed somewhere, but not ingested into the archive for -- whatever reason. This table is separate from the content table as we might -- not have the sha1 checksum of skipped contents (for instance when we inject -- git repositories, objects that are too big will be skipped here, and we will -- only know their sha1_git). 'reason' contains the reason the content was -- skipped. origin is a nullable column allowing to find out which origin -- contains that skipped content. create table skipped_content ( sha1 sha1, sha1_git sha1_git, sha256 sha256, blake2s256 blake2s256, length bigint not null, ctime timestamptz not null default now(), status content_status not null default 'absent', reason text not null, origin bigint, object_id bigserial ); comment on table skipped_content is 'Content blobs observed, but not ingested in the archive'; comment on column skipped_content.sha1 is 'Skipped content sha1 hash'; comment on column skipped_content.sha1_git is 'Git object sha1 hash'; comment on column skipped_content.sha256 is 'Skipped content sha256 hash'; comment on column skipped_content.blake2s256 is 'Skipped content blake2s hash'; comment on column skipped_content.length is 'Skipped content length'; comment on column skipped_content.ctime is 'First seen time'; comment on column skipped_content.status is 'Skipped content status (absent, visible, hidden)'; comment on column skipped_content.reason is 'Reason for skipping'; comment on column skipped_content.origin is 'Origin table identifier'; comment on column skipped_content.object_id is 'Skipped content identifier'; -- A file-system directory. A directory is a list of directory entries (see -- tables: directory_entry_{dir,file}). -- -- To list the contents of a directory: -- 1. list the contained directory_entry_dir using array dir_entries -- 2. list the contained directory_entry_file using array file_entries -- 3. list the contained directory_entry_rev using array rev_entries -- 4. UNION -- -- Synonyms/mappings: -- * git: tree create table directory ( id sha1_git not null, dir_entries bigint[], -- sub-directories, reference directory_entry_dir file_entries bigint[], -- contained files, reference directory_entry_file rev_entries bigint[], -- mounted revisions, reference directory_entry_rev object_id bigserial -- short object identifier ); comment on table directory is 'Contents of a directory, synonymous to tree (git)'; comment on column directory.id is 'Git object sha1 hash'; comment on column directory.dir_entries is 'Sub-directories, reference directory_entry_dir'; comment on column directory.file_entries is 'Contained files, reference directory_entry_file'; comment on column directory.rev_entries is 'Mounted revisions, reference directory_entry_rev'; comment on column directory.object_id is 'Short object identifier'; -- A directory entry pointing to a (sub-)directory. create table directory_entry_dir ( id bigserial, target sha1_git not null, -- id of target directory name unix_path not null, -- path name, relative to containing dir perms file_perms not null -- unix-like permissions ); comment on table directory_entry_dir is 'Directory entry for directory'; comment on column directory_entry_dir.id is 'Directory identifier'; comment on column directory_entry_dir.target is 'Target directory identifier'; comment on column directory_entry_dir.name is 'Path name, relative to containing directory'; comment on column directory_entry_dir.perms is 'Unix-like permissions'; -- A directory entry pointing to a file content. create table directory_entry_file ( id bigserial, target sha1_git not null, -- id of target file name unix_path not null, -- path name, relative to containing dir perms file_perms not null -- unix-like permissions ); comment on table directory_entry_file is 'Directory entry for file'; comment on column directory_entry_file.id is 'File identifier'; comment on column directory_entry_file.target is 'Target file identifier'; comment on column directory_entry_file.name is 'Path name, relative to containing directory'; comment on column directory_entry_file.perms is 'Unix-like permissions'; -- A directory entry pointing to a revision. create table directory_entry_rev ( id bigserial, target sha1_git not null, -- id of target revision name unix_path not null, -- path name, relative to containing dir perms file_perms not null -- unix-like permissions ); comment on table directory_entry_rev is 'Directory entry for revision'; comment on column directory_entry_dir.id is 'Revision identifier'; comment on column directory_entry_dir.target is 'Target revision in identifier'; comment on column directory_entry_dir.name is 'Path name, relative to containing directory'; comment on column directory_entry_dir.perms is 'Unix-like permissions'; -- A person referenced by some source code artifacts, e.g., a VCS revision or -- release metadata. create table person ( id bigserial, name bytea, -- advisory: not null if we managed to parse a name email bytea, -- advisory: not null if we managed to parse an email fullname bytea not null -- freeform specification; what is actually used in the checksums -- will usually be of the form 'name ' ); comment on table person is 'Person referenced in code artifact release metadata'; comment on column person.id is 'Person identifier'; comment on column person.name is 'Name'; comment on column person.email is 'Email'; comment on column person.fullname is 'Full name (raw name)'; -- The state of a source code tree at a specific point in time. -- -- Synonyms/mappings: -- * git / subversion / etc: commit -- * tarball: a specific tarball -- -- Revisions are organized as DAGs. Each revision points to 0, 1, or more (in -- case of merges) parent revisions. Each revision points to a directory, i.e., -- a file-system tree containing files and directories. create table revision ( id sha1_git not null, date timestamptz, date_offset smallint, committer_date timestamptz, committer_date_offset smallint, type revision_type not null, directory sha1_git, -- source code 'root' directory message bytea, author bigint, committer bigint, synthetic boolean not null default false, -- true iff revision has been created by Software Heritage metadata jsonb, -- extra metadata (tarball checksums, extra commit information, etc...) object_id bigserial, date_neg_utc_offset boolean, committer_date_neg_utc_offset boolean ); comment on table revision is 'A revision represents the state of a source code tree at a specific point in time'; comment on column revision.id is 'Git-style SHA1 commit identifier'; comment on column revision.date is 'Author timestamp as UNIX epoch'; comment on column revision.date_offset is 'Author timestamp timezone, as minute offsets from UTC'; comment on column revision.date_neg_utc_offset is 'True indicates a -0 UTC offset on author timestamp'; comment on column revision.committer_date is 'Committer timestamp as UNIX epoch'; comment on column revision.committer_date_offset is 'Committer timestamp timezone, as minute offsets from UTC'; comment on column revision.committer_date_neg_utc_offset is 'True indicates a -0 UTC offset on committer timestamp'; comment on column revision.type is 'Type of revision'; comment on column revision.directory is 'Directory identifier'; comment on column revision.message is 'Commit message'; comment on column revision.author is 'Author identity'; comment on column revision.committer is 'Committer identity'; comment on column revision.synthetic is 'True iff revision has been synthesized by Software Heritage'; comment on column revision.metadata is 'Extra revision metadata'; comment on column revision.object_id is 'Non-intrinsic, sequential object identifier'; -- either this table or the sha1_git[] column on the revision table create table revision_history ( id sha1_git not null, parent_id sha1_git not null, parent_rank int not null default 0 -- parent position in merge commits, 0-based ); comment on table revision_history is 'Sequence of revision history with parent and position in history'; comment on column revision_history.id is 'Revision history git object sha1 checksum'; comment on column revision_history.parent_id is 'Parent revision git object identifier'; comment on column revision_history.parent_rank is 'Parent position in merge commits, 0-based'; -- Crawling history of software origins visited by Software Heritage. Each -- visit is a 3-way mapping between a software origin, a timestamp, and a -- snapshot object capturing the full-state of the origin at visit time. create table origin_visit ( origin bigint not null, visit bigint not null, date timestamptz not null, type text not null, -- remove those when done migrating the schema status origin_visit_state not null, metadata jsonb, snapshot sha1_git ); comment on column origin_visit.origin is 'Visited origin'; comment on column origin_visit.visit is 'Sequential visit number for the origin'; comment on column origin_visit.date is 'Visit timestamp'; comment on column origin_visit.type is 'Type of loader that did the visit (hg, git, ...)'; comment on column origin_visit.status is '(Deprecated) Visit status'; comment on column origin_visit.metadata is '(Deprecated) Optional origin visit metadata'; comment on column origin_visit.snapshot is '(Deprecated) Optional snapshot of the origin visit. It can be partial.'; -- Crawling history of software origin visits by Software Heritage. Each -- visit see its history change through new origin visit status updates create table origin_visit_status ( origin bigint not null, visit bigint not null, date timestamptz not null, status origin_visit_state not null, metadata jsonb, snapshot sha1_git ); comment on column origin_visit_status.origin is 'Origin concerned by the visit update'; comment on column origin_visit_status.visit is 'Visit concerned by the visit update'; comment on column origin_visit_status.date is 'Visit update timestamp'; comment on column origin_visit_status.status is 'Visit status (ongoing, failed, full)'; comment on column origin_visit_status.metadata is 'Optional origin visit metadata'; comment on column origin_visit_status.snapshot is 'Optional, possibly partial, snapshot of the origin visit. It can be partial.'; -- A snapshot represents the entire state of a software origin as crawled by -- Software Heritage. This table is a simple mapping between (public) intrinsic -- snapshot identifiers and (private) numeric sequential identifiers. create table snapshot ( object_id bigserial not null, -- PK internal object identifier id sha1_git not null -- snapshot intrinsic identifier ); comment on table snapshot is 'State of a software origin as crawled by Software Heritage'; comment on column snapshot.object_id is 'Internal object identifier'; comment on column snapshot.id is 'Intrinsic snapshot identifier'; -- Each snapshot associate "branch" names to other objects in the Software -- Heritage Merkle DAG. This table describes branches as mappings between names -- and target typed objects. create table snapshot_branch ( object_id bigserial not null, -- PK internal object identifier name bytea not null, -- branch name, e.g., "master" or "feature/drag-n-drop" target bytea, -- target object identifier, e.g., a revision identifier target_type snapshot_target -- target object type, e.g., "revision" ); comment on table snapshot_branch is 'Associates branches with objects in Heritage Merkle DAG'; comment on column snapshot_branch.object_id is 'Internal object identifier'; comment on column snapshot_branch.name is 'Branch name'; comment on column snapshot_branch.target is 'Target object identifier'; comment on column snapshot_branch.target_type is 'Target object type'; -- Mapping between snapshots and their branches. create table snapshot_branches ( snapshot_id bigint not null, -- snapshot identifier, ref. snapshot.object_id branch_id bigint not null -- branch identifier, ref. snapshot_branch.object_id ); comment on table snapshot_branches is 'Mapping between snapshot and their branches'; comment on column snapshot_branches.snapshot_id is 'Snapshot identifier'; comment on column snapshot_branches.branch_id is 'Branch identifier'; -- A "memorable" point in time in the development history of a software -- project. -- -- Synonyms/mappings: -- * git: tag (of the annotated kind, otherwise they are just references) -- * tarball: the release version number create table release ( id sha1_git not null, target sha1_git, date timestamptz, date_offset smallint, name bytea, comment bytea, author bigint, synthetic boolean not null default false, -- true iff release has been created by Software Heritage object_id bigserial, target_type object_type not null, date_neg_utc_offset boolean ); comment on table release is 'Details of a software release, synonymous with a tag (git) or version number (tarball)'; comment on column release.id is 'Release git identifier'; comment on column release.target is 'Target git identifier'; comment on column release.date is 'Release timestamp'; comment on column release.date_offset is 'Timestamp offset from UTC'; comment on column release.name is 'Name'; comment on column release.comment is 'Comment'; comment on column release.author is 'Author'; comment on column release.synthetic is 'Indicates if created by Software Heritage'; comment on column release.object_id is 'Object identifier'; comment on column release.target_type is 'Object type (''content'', ''directory'', ''revision'', ''release'', ''snapshot'')'; comment on column release.date_neg_utc_offset is 'True indicates -0 UTC offset for release timestamp'; -- Tools -create table tool +create table metadata_fetcher ( - id serial not null, - name text not null, - version text not null, - configuration jsonb + id serial not null, + name text not null, + version text not null, + metadata jsonb not null ); -comment on table tool is 'Tool information'; -comment on column tool.id is 'Tool identifier'; -comment on column tool.version is 'Tool name'; -comment on column tool.version is 'Tool version'; -comment on column tool.configuration is 'Tool configuration: command line, flags, etc...'; +comment on table metadata_fetcher is 'Tools used to retrieve metadata'; +comment on column metadata_fetcher.id is 'Internal identifier of the fetcher'; +comment on column metadata_fetcher.name is 'Fetcher name'; +comment on column metadata_fetcher.version is 'Fetcher version'; +comment on column metadata_fetcher.metadata is 'Extra information about the fetcher'; -create table metadata_provider +create table metadata_authority ( - id serial not null, - provider_name text not null, - provider_type text not null, - provider_url text, - metadata jsonb + id serial not null, + type text not null, + url text not null, + metadata jsonb not null ); -comment on table metadata_provider is 'Metadata provider information'; -comment on column metadata_provider.id is 'Provider''s identifier'; -comment on column metadata_provider.provider_name is 'Provider''s name'; -comment on column metadata_provider.provider_url is 'Provider''s url'; -comment on column metadata_provider.metadata is 'Other metadata about provider'; +comment on table metadata_authority is 'Metadata authority information'; +comment on column metadata_authority.id is 'Internal identifier of the authority'; +comment on column metadata_authority.type is 'Type of authority (deposit/forge/registry)'; +comment on column metadata_authority.url is 'Authority''s uri'; +comment on column metadata_authority.metadata is 'Other metadata about authority'; -- Discovery of metadata during a listing, loading, deposit or external_catalog of an origin -- also provides a translation to a defined json schema using a translation tool (tool_id) create table origin_metadata ( id bigserial not null, -- PK internal object identifier origin_id bigint not null, -- references origin(id) discovery_date timestamptz not null, -- when it was extracted - provider_id bigint not null, -- ex: 'hal', 'lister-github', 'loader-github' - tool_id bigint not null, - metadata jsonb not null + authority_id bigint not null, + fetcher_id bigint not null, + format text not null, + metadata bytea not null ); comment on table origin_metadata is 'keeps all metadata found concerning an origin'; comment on column origin_metadata.id is 'the origin_metadata object''s id'; comment on column origin_metadata.origin_id is 'the origin id for which the metadata was found'; comment on column origin_metadata.discovery_date is 'the date of retrieval'; -comment on column origin_metadata.provider_id is 'the metadata provider: github, openhub, deposit, etc.'; -comment on column origin_metadata.tool_id is 'the tool used for extracting metadata: lister-github, etc.'; -comment on column origin_metadata.metadata is 'metadata in json format but with original terms'; +comment on column origin_metadata.authority_id is 'the metadata provider: github, openhub, deposit, etc.'; +comment on column origin_metadata.fetcher_id is 'the tool used for extracting metadata: loaders, crawlers, etc.'; +comment on column origin_metadata.format is 'name of the format of metadata, used by readers to interpret it.'; +comment on column origin_metadata.metadata is 'original metadata in opaque format'; -- Keep a cache of object counts create table object_counts ( object_type text, -- table for which we're counting objects (PK) value bigint, -- count of objects in the table last_update timestamptz, -- last update for the object count in this table single_update boolean -- whether we update this table standalone (true) or through bucketed counts (false) ); comment on table object_counts is 'Cache of object counts'; comment on column object_counts.object_type is 'Object type (''content'', ''directory'', ''revision'', ''release'', ''snapshot'')'; comment on column object_counts.value is 'Count of objects in the table'; comment on column object_counts.last_update is 'Last update for object count'; comment on column object_counts.single_update is 'standalone (true) or bucketed counts (false)'; create table object_counts_bucketed ( line serial not null, -- PK object_type text not null, -- table for which we're counting objects identifier text not null, -- identifier across which we're bucketing objects bucket_start bytea, -- lower bound (inclusive) for the bucket bucket_end bytea, -- upper bound (exclusive) for the bucket value bigint, -- count of objects in the bucket last_update timestamptz -- last update for the object count in this bucket ); comment on table object_counts_bucketed is 'Bucketed count for objects ordered by type'; comment on column object_counts_bucketed.line is 'Auto incremented idenitfier value'; comment on column object_counts_bucketed.object_type is 'Object type (''content'', ''directory'', ''revision'', ''release'', ''snapshot'')'; comment on column object_counts_bucketed.identifier is 'Common identifier for bucketed objects'; comment on column object_counts_bucketed.bucket_start is 'Lower bound (inclusive) for the bucket'; comment on column object_counts_bucketed.bucket_end is 'Upper bound (exclusive) for the bucket'; comment on column object_counts_bucketed.value is 'Count of objects in the bucket'; comment on column object_counts_bucketed.last_update is 'Last update for the object count in this bucket'; diff --git a/swh/storage/sql/40-swh-func.sql b/swh/storage/sql/40-swh-func.sql index 52bb1794..e8978b46 100644 --- a/swh/storage/sql/40-swh-func.sql +++ b/swh/storage/sql/40-swh-func.sql @@ -1,1119 +1,1038 @@ create or replace function hash_sha1(text) returns text as $$ select encode(digest($1, 'sha1'), 'hex') $$ language sql strict immutable; comment on function hash_sha1(text) is 'Compute SHA1 hash as text'; -- create a temporary table called tmp_TBLNAME, mimicking existing table -- TBLNAME -- -- Args: -- tblname: name of the table to mimic create or replace function swh_mktemp(tblname regclass) returns void language plpgsql as $$ begin execute format(' create temporary table if not exists tmp_%1$I (like %1$I including defaults) on commit delete rows; alter table tmp_%1$I drop column if exists object_id; ', tblname); return; end $$; -- create a temporary table for directory entries called tmp_TBLNAME, -- mimicking existing table TBLNAME with an extra dir_id (sha1_git) -- column, and dropping the id column. -- -- This is used to create the tmp_directory_entry_ tables. -- -- Args: -- tblname: name of the table to mimic create or replace function swh_mktemp_dir_entry(tblname regclass) returns void language plpgsql as $$ begin execute format(' create temporary table if not exists tmp_%1$I (like %1$I including defaults, dir_id sha1_git) on commit delete rows; alter table tmp_%1$I drop column if exists id; ', tblname); return; end $$; -- create a temporary table for revisions called tmp_revisions, -- mimicking existing table revision, replacing the foreign keys to -- people with an email and name field -- create or replace function swh_mktemp_revision() returns void language sql as $$ create temporary table if not exists tmp_revision ( like revision including defaults, author_fullname bytea, author_name bytea, author_email bytea, committer_fullname bytea, committer_name bytea, committer_email bytea ) on commit delete rows; alter table tmp_revision drop column if exists author; alter table tmp_revision drop column if exists committer; alter table tmp_revision drop column if exists object_id; $$; -- create a temporary table for releases called tmp_release, -- mimicking existing table release, replacing the foreign keys to -- people with an email and name field -- create or replace function swh_mktemp_release() returns void language sql as $$ create temporary table if not exists tmp_release ( like release including defaults, author_fullname bytea, author_name bytea, author_email bytea ) on commit delete rows; alter table tmp_release drop column if exists author; alter table tmp_release drop column if exists object_id; $$; -- create a temporary table for the branches of a snapshot create or replace function swh_mktemp_snapshot_branch() returns void language sql as $$ create temporary table if not exists tmp_snapshot_branch ( name bytea not null, target bytea, target_type snapshot_target ) on commit delete rows; $$; --- create a temporary table for the tools -create or replace function swh_mktemp_tool() - returns void - language sql -as $$ - create temporary table if not exists tmp_tool ( - like tool including defaults - ) on commit delete rows; - alter table tmp_tool drop column if exists id; -$$; - -- a content signature is a set of cryptographic checksums that we use to -- uniquely identify content, for the purpose of verifying if we already have -- some content or not during content injection create type content_signature as ( sha1 sha1, sha1_git sha1_git, sha256 sha256, blake2s256 blake2s256 ); -- check which entries of tmp_skipped_content are missing from skipped_content -- -- operates in bulk: 0. swh_mktemp(skipped_content), 1. COPY to tmp_skipped_content, -- 2. call this function create or replace function swh_skipped_content_missing() returns setof content_signature language plpgsql as $$ begin return query select sha1, sha1_git, sha256, blake2s256 from tmp_skipped_content t where not exists (select 1 from skipped_content s where s.sha1 is not distinct from t.sha1 and s.sha1_git is not distinct from t.sha1_git and s.sha256 is not distinct from t.sha256); return; end $$; -- Look up content based on one or several different checksums. Return all -- content information if the content is found; a NULL row otherwise. -- -- At least one checksum should be not NULL. If several are not NULL, they will -- be AND-ed together in the lookup query. -- -- Note: this function is meant to be used to look up individual contents -- (e.g., for the web app), for batch lookup of missing content (e.g., to be -- added) see swh_content_missing create or replace function swh_content_find( sha1 sha1 default NULL, sha1_git sha1_git default NULL, sha256 sha256 default NULL, blake2s256 blake2s256 default NULL ) returns content language plpgsql as $$ declare con content; filters text[] := array[] :: text[]; -- AND-clauses used to filter content q text; begin if sha1 is not null then filters := filters || format('sha1 = %L', sha1); end if; if sha1_git is not null then filters := filters || format('sha1_git = %L', sha1_git); end if; if sha256 is not null then filters := filters || format('sha256 = %L', sha256); end if; if blake2s256 is not null then filters := filters || format('blake2s256 = %L', blake2s256); end if; if cardinality(filters) = 0 then return null; else q = format('select * from content where %s', array_to_string(filters, ' and ')); execute q into con; return con; end if; end $$; -- add tmp_content entries to content, skipping duplicates -- -- operates in bulk: 0. swh_mktemp(content), 1. COPY to tmp_content, -- 2. call this function create or replace function swh_content_add() returns void language plpgsql as $$ begin insert into content (sha1, sha1_git, sha256, blake2s256, length, status, ctime) select distinct sha1, sha1_git, sha256, blake2s256, length, status, ctime from tmp_content; return; end $$; -- add tmp_skipped_content entries to skipped_content, skipping duplicates -- -- operates in bulk: 0. swh_mktemp(skipped_content), 1. COPY to tmp_skipped_content, -- 2. call this function create or replace function swh_skipped_content_add() returns void language plpgsql as $$ begin insert into skipped_content (sha1, sha1_git, sha256, blake2s256, length, status, reason, origin) select distinct sha1, sha1_git, sha256, blake2s256, length, status, reason, origin from tmp_skipped_content where (coalesce(sha1, ''), coalesce(sha1_git, ''), coalesce(sha256, '')) in ( select coalesce(sha1, ''), coalesce(sha1_git, ''), coalesce(sha256, '') from swh_skipped_content_missing() ); -- TODO XXX use postgres 9.5 "UPSERT" support here, when available. -- Specifically, using "INSERT .. ON CONFLICT IGNORE" we can avoid -- the extra swh_content_missing() query here. return; end $$; -- Update content entries from temporary table. -- (columns are potential new columns added to the schema, this cannot be empty) -- create or replace function swh_content_update(columns_update text[]) returns void language plpgsql as $$ declare query text; tmp_array text[]; begin if array_length(columns_update, 1) = 0 then raise exception 'Please, provide the list of column names to update.'; end if; tmp_array := array(select format('%1$s=t.%1$s', unnest) from unnest(columns_update)); query = format('update content set %s from tmp_content t where t.sha1 = content.sha1', array_to_string(tmp_array, ', ')); execute query; return; end $$; comment on function swh_content_update(text[]) IS 'Update existing content''s columns'; -- check which entries of tmp_directory are missing from directory -- -- operates in bulk: 0. swh_mktemp(directory), 1. COPY to tmp_directory, -- 2. call this function create or replace function swh_directory_missing() returns setof sha1_git language plpgsql as $$ begin return query select id from tmp_directory t where not exists ( select 1 from directory d where d.id = t.id); return; end $$; create type directory_entry_type as enum('file', 'dir', 'rev'); -- Add tmp_directory_entry_* entries to directory_entry_* and directory, -- skipping duplicates in directory_entry_*. This is a generic function that -- works on all kind of directory entries. -- -- operates in bulk: 0. swh_mktemp_dir_entry('directory_entry_*'), 1 COPY to -- tmp_directory_entry_*, 2. call this function -- -- Assumption: this function is used in the same transaction that inserts the -- context directory in table "directory". create or replace function swh_directory_entry_add(typ directory_entry_type) returns void language plpgsql as $$ begin execute format(' insert into directory_entry_%1$s (target, name, perms) select distinct t.target, t.name, t.perms from tmp_directory_entry_%1$s t where not exists ( select 1 from directory_entry_%1$s i where t.target = i.target and t.name = i.name and t.perms = i.perms) ', typ); execute format(' with new_entries as ( select t.dir_id, array_agg(i.id) as entries from tmp_directory_entry_%1$s t inner join directory_entry_%1$s i using (target, name, perms) group by t.dir_id ) update tmp_directory as d set %1$s_entries = new_entries.entries from new_entries where d.id = new_entries.dir_id ', typ); return; end $$; -- Insert the data from tmp_directory, tmp_directory_entry_file, -- tmp_directory_entry_dir, tmp_directory_entry_rev into their final -- tables. -- -- Prerequisites: -- directory ids in tmp_directory -- entries in tmp_directory_entry_{file,dir,rev} -- create or replace function swh_directory_add() returns void language plpgsql as $$ begin perform swh_directory_entry_add('file'); perform swh_directory_entry_add('dir'); perform swh_directory_entry_add('rev'); insert into directory select * from tmp_directory t where not exists ( select 1 from directory d where d.id = t.id); return; end $$; -- a directory listing entry with all the metadata -- -- can be used to list a directory, and retrieve all the data in one go. create type directory_entry as ( dir_id sha1_git, -- id of the parent directory type directory_entry_type, -- type of entry target sha1_git, -- id of target name unix_path, -- path name, relative to containing dir perms file_perms, -- unix-like permissions status content_status, -- visible or absent sha1 sha1, -- content if sha1 if type is not dir sha1_git sha1_git, -- content's sha1 git if type is not dir sha256 sha256, -- content's sha256 if type is not dir length bigint -- content length if type is not dir ); -- List a single level of directory walked_dir_id -- FIXME: order by name is not correct. For git, we need to order by -- lexicographic order but as if a trailing / is present in directory -- name create or replace function swh_directory_walk_one(walked_dir_id sha1_git) returns setof directory_entry language sql stable as $$ with dir as ( select id as dir_id, dir_entries, file_entries, rev_entries from directory where id = walked_dir_id), ls_d as (select dir_id, unnest(dir_entries) as entry_id from dir), ls_f as (select dir_id, unnest(file_entries) as entry_id from dir), ls_r as (select dir_id, unnest(rev_entries) as entry_id from dir) (select dir_id, 'dir'::directory_entry_type as type, e.target, e.name, e.perms, NULL::content_status, NULL::sha1, NULL::sha1_git, NULL::sha256, NULL::bigint from ls_d left join directory_entry_dir e on ls_d.entry_id = e.id) union (select dir_id, 'file'::directory_entry_type as type, e.target, e.name, e.perms, c.status, c.sha1, c.sha1_git, c.sha256, c.length from ls_f left join directory_entry_file e on ls_f.entry_id = e.id left join content c on e.target = c.sha1_git) union (select dir_id, 'rev'::directory_entry_type as type, e.target, e.name, e.perms, NULL::content_status, NULL::sha1, NULL::sha1_git, NULL::sha256, NULL::bigint from ls_r left join directory_entry_rev e on ls_r.entry_id = e.id) order by name; $$; -- List recursively the revision directory arborescence create or replace function swh_directory_walk(walked_dir_id sha1_git) returns setof directory_entry language sql stable as $$ with recursive entries as ( select dir_id, type, target, name, perms, status, sha1, sha1_git, sha256, length from swh_directory_walk_one(walked_dir_id) union all select dir_id, type, target, (dirname || '/' || name)::unix_path as name, perms, status, sha1, sha1_git, sha256, length from (select (swh_directory_walk_one(dirs.target)).*, dirs.name as dirname from (select target, name from entries where type = 'dir') as dirs) as with_parent ) select dir_id, type, target, name, perms, status, sha1, sha1_git, sha256, length from entries $$; create or replace function swh_revision_walk(revision_id sha1_git) returns setof directory_entry language sql stable as $$ select dir_id, type, target, name, perms, status, sha1, sha1_git, sha256, length from swh_directory_walk((select directory from revision where id=revision_id)) $$; COMMENT ON FUNCTION swh_revision_walk(sha1_git) IS 'Recursively list the revision targeted directory arborescence'; -- Find a directory entry by its path create or replace function swh_find_directory_entry_by_path( walked_dir_id sha1_git, dir_or_content_path bytea[]) returns directory_entry language plpgsql as $$ declare end_index integer; paths bytea default ''; path bytea; res bytea[]; r record; begin end_index := array_upper(dir_or_content_path, 1); res[1] := walked_dir_id; for i in 1..end_index loop path := dir_or_content_path[i]; -- concatenate path for patching the name in the result record (if we found it) if i = 1 then paths = path; else paths := paths || '/' || path; -- concatenate paths end if; if i <> end_index then select * from swh_directory_walk_one(res[i] :: sha1_git) where name=path and type = 'dir' limit 1 into r; else select * from swh_directory_walk_one(res[i] :: sha1_git) where name=path limit 1 into r; end if; -- find the path if r is null then return null; else -- store the next dir to lookup the next local path from res[i+1] := r.target; end if; end loop; -- at this moment, r is the result. Patch its 'name' with the full path before returning it. r.name := paths; return r; end $$; -- List all revision IDs starting from a given revision, going back in time -- -- TODO ordering: should be breadth-first right now (what do we want?) -- TODO ordering: ORDER BY parent_rank somewhere? create or replace function swh_revision_list(root_revisions bytea[], num_revs bigint default NULL) returns table (id sha1_git, parents bytea[]) language sql stable as $$ with recursive full_rev_list(id) as ( (select id from revision where id = ANY(root_revisions)) union (select h.parent_id from revision_history as h join full_rev_list on h.id = full_rev_list.id) ), rev_list as (select id from full_rev_list limit num_revs) select rev_list.id as id, array(select rh.parent_id::bytea from revision_history rh where rh.id = rev_list.id order by rh.parent_rank ) as parent from rev_list; $$; -- List all the children of a given revision create or replace function swh_revision_list_children(root_revisions bytea[], num_revs bigint default NULL) returns table (id sha1_git, parents bytea[]) language sql stable as $$ with recursive full_rev_list(id) as ( (select id from revision where id = ANY(root_revisions)) union (select h.id from revision_history as h join full_rev_list on h.parent_id = full_rev_list.id) ), rev_list as (select id from full_rev_list limit num_revs) select rev_list.id as id, array(select rh.parent_id::bytea from revision_history rh where rh.id = rev_list.id order by rh.parent_rank ) as parent from rev_list; $$; -- Detailed entry for a revision create type revision_entry as ( id sha1_git, date timestamptz, date_offset smallint, date_neg_utc_offset boolean, committer_date timestamptz, committer_date_offset smallint, committer_date_neg_utc_offset boolean, type revision_type, directory sha1_git, message bytea, author_id bigint, author_fullname bytea, author_name bytea, author_email bytea, committer_id bigint, committer_fullname bytea, committer_name bytea, committer_email bytea, metadata jsonb, synthetic boolean, parents bytea[], object_id bigint ); -- "git style" revision log. Similar to swh_revision_list(), but returning all -- information associated to each revision, and expanding authors/committers create or replace function swh_revision_log(root_revisions bytea[], num_revs bigint default NULL) returns setof revision_entry language sql stable as $$ select t.id, r.date, r.date_offset, r.date_neg_utc_offset, r.committer_date, r.committer_date_offset, r.committer_date_neg_utc_offset, r.type, r.directory, r.message, a.id, a.fullname, a.name, a.email, c.id, c.fullname, c.name, c.email, r.metadata, r.synthetic, t.parents, r.object_id from swh_revision_list(root_revisions, num_revs) as t left join revision r on t.id = r.id left join person a on a.id = r.author left join person c on c.id = r.committer; $$; -- Detailed entry for a release create type release_entry as ( id sha1_git, target sha1_git, target_type object_type, date timestamptz, date_offset smallint, date_neg_utc_offset boolean, name bytea, comment bytea, synthetic boolean, author_id bigint, author_fullname bytea, author_name bytea, author_email bytea, object_id bigint ); -- Create entries in person from tmp_revision create or replace function swh_person_add_from_revision() returns void language plpgsql as $$ begin with t as ( select author_fullname as fullname, author_name as name, author_email as email from tmp_revision union select committer_fullname as fullname, committer_name as name, committer_email as email from tmp_revision ) insert into person (fullname, name, email) select distinct on (fullname) fullname, name, email from t where not exists ( select 1 from person p where t.fullname = p.fullname ); return; end $$; -- Create entries in revision from tmp_revision create or replace function swh_revision_add() returns void language plpgsql as $$ begin perform swh_person_add_from_revision(); insert into revision (id, date, date_offset, date_neg_utc_offset, committer_date, committer_date_offset, committer_date_neg_utc_offset, type, directory, message, author, committer, metadata, synthetic) select t.id, t.date, t.date_offset, t.date_neg_utc_offset, t.committer_date, t.committer_date_offset, t.committer_date_neg_utc_offset, t.type, t.directory, t.message, a.id, c.id, t.metadata, t.synthetic from tmp_revision t left join person a on a.fullname = t.author_fullname left join person c on c.fullname = t.committer_fullname; return; end $$; -- Create entries in person from tmp_release create or replace function swh_person_add_from_release() returns void language plpgsql as $$ begin with t as ( select distinct author_fullname as fullname, author_name as name, author_email as email from tmp_release where author_fullname is not null ) insert into person (fullname, name, email) select distinct on (fullname) fullname, name, email from t where not exists ( select 1 from person p where t.fullname = p.fullname ); return; end $$; -- Create entries in release from tmp_release create or replace function swh_release_add() returns void language plpgsql as $$ begin perform swh_person_add_from_release(); insert into release (id, target, target_type, date, date_offset, date_neg_utc_offset, name, comment, author, synthetic) select t.id, t.target, t.target_type, t.date, t.date_offset, t.date_neg_utc_offset, t.name, t.comment, a.id, t.synthetic from tmp_release t left join person a on a.fullname = t.author_fullname; return; end $$; -- add a new origin_visit for origin origin_id at date. -- -- Returns the new visit id. create or replace function swh_origin_visit_add(origin_url text, date timestamptz, type text) returns bigint language sql as $$ with origin_id as ( select id from origin where url = origin_url ), last_known_visit as ( select coalesce(max(visit), 0) as visit from origin_visit where origin = (select id from origin_id) ) insert into origin_visit (origin, date, type, visit, status) values ((select id from origin_id), date, type, (select visit from last_known_visit) + 1, 'ongoing') returning visit; $$; create or replace function swh_snapshot_add(snapshot_id sha1_git) returns void language plpgsql as $$ declare snapshot_object_id snapshot.object_id%type; begin select object_id from snapshot where id = snapshot_id into snapshot_object_id; if snapshot_object_id is null then insert into snapshot (id) values (snapshot_id) returning object_id into snapshot_object_id; insert into snapshot_branch (name, target_type, target) select name, target_type, target from tmp_snapshot_branch tmp where not exists ( select 1 from snapshot_branch sb where sb.name = tmp.name and sb.target = tmp.target and sb.target_type = tmp.target_type ) on conflict do nothing; insert into snapshot_branches (snapshot_id, branch_id) select snapshot_object_id, sb.object_id as branch_id from tmp_snapshot_branch tmp join snapshot_branch sb using (name, target, target_type) where tmp.target is not null and tmp.target_type is not null union select snapshot_object_id, sb.object_id as branch_id from tmp_snapshot_branch tmp join snapshot_branch sb using (name) where tmp.target is null and tmp.target_type is null and sb.target is null and sb.target_type is null; end if; truncate table tmp_snapshot_branch; end; $$; create type snapshot_result as ( snapshot_id sha1_git, name bytea, target bytea, target_type snapshot_target ); create or replace function swh_snapshot_get_by_id(id sha1_git, branches_from bytea default '', branches_count bigint default null, target_types snapshot_target[] default NULL) returns setof snapshot_result language sql stable as $$ select swh_snapshot_get_by_id.id as snapshot_id, name, target, target_type from snapshot_branches inner join snapshot_branch on snapshot_branches.branch_id = snapshot_branch.object_id where snapshot_id = (select object_id from snapshot where snapshot.id = swh_snapshot_get_by_id.id) and (target_types is null or target_type = any(target_types)) and name >= branches_from order by name limit branches_count $$; create type snapshot_size as ( target_type snapshot_target, count bigint ); create or replace function swh_snapshot_count_branches(id sha1_git) returns setof snapshot_size language sql stable as $$ SELECT target_type, count(name) from swh_snapshot_get_by_id(swh_snapshot_count_branches.id) group by target_type; $$; -- Absolute path: directory reference + complete path relative to it create type content_dir as ( directory sha1_git, path unix_path ); -- Find the containing directory of a given content, specified by sha1 -- (note: *not* sha1_git). -- -- Return a pair (dir_it, path) where path is a UNIX path that, from the -- directory root, reach down to a file with the desired content. Return NULL -- if no match is found. -- -- In case of multiple paths (i.e., pretty much always), an arbitrary one is -- chosen. create or replace function swh_content_find_directory(content_id sha1) returns content_dir language sql stable as $$ with recursive path as ( -- Recursively build a path from the requested content to a root -- directory. Each iteration returns a pair (dir_id, filename) where -- filename is relative to dir_id. Stops when no parent directory can -- be found. (select dir.id as dir_id, dir_entry_f.name as name, 0 as depth from directory_entry_file as dir_entry_f join content on content.sha1_git = dir_entry_f.target join directory as dir on dir.file_entries @> array[dir_entry_f.id] where content.sha1 = content_id limit 1) union all (select dir.id as dir_id, (dir_entry_d.name || '/' || path.name)::unix_path as name, path.depth + 1 from path join directory_entry_dir as dir_entry_d on dir_entry_d.target = path.dir_id join directory as dir on dir.dir_entries @> array[dir_entry_d.id] limit 1) ) select dir_id, name from path order by depth desc limit 1; $$; -- Find the visit of origin closest to date visit_date -- Breaks ties by selecting the largest visit id create or replace function swh_visit_find_by_date(origin_url text, visit_date timestamptz default NOW()) returns setof origin_visit language plpgsql stable as $$ declare origin_id bigint; begin select id into origin_id from origin where url=origin_url; return query with closest_two_visits as (( select ov, (date - visit_date), visit as interval from origin_visit ov where ov.origin = origin_id and ov.date >= visit_date order by ov.date asc, ov.visit desc limit 1 ) union ( select ov, (visit_date - date), visit as interval from origin_visit ov where ov.origin = origin_id and ov.date < visit_date order by ov.date desc, ov.visit desc limit 1 )) select (ov).* from closest_two_visits order by interval, visit limit 1; end $$; -- Object listing by object_id create or replace function swh_content_list_by_object_id( min_excl bigint, max_incl bigint ) returns setof content language sql stable as $$ select * from content where object_id > min_excl and object_id <= max_incl order by object_id; $$; create or replace function swh_revision_list_by_object_id( min_excl bigint, max_incl bigint ) returns setof revision_entry language sql stable as $$ with revs as ( select * from revision where object_id > min_excl and object_id <= max_incl ) select r.id, r.date, r.date_offset, r.date_neg_utc_offset, r.committer_date, r.committer_date_offset, r.committer_date_neg_utc_offset, r.type, r.directory, r.message, a.id, a.fullname, a.name, a.email, c.id, c.fullname, c.name, c.email, r.metadata, r.synthetic, array(select rh.parent_id::bytea from revision_history rh where rh.id = r.id order by rh.parent_rank) as parents, r.object_id from revs r left join person a on a.id = r.author left join person c on c.id = r.committer order by r.object_id; $$; create or replace function swh_release_list_by_object_id( min_excl bigint, max_incl bigint ) returns setof release_entry language sql stable as $$ with rels as ( select * from release where object_id > min_excl and object_id <= max_incl ) select r.id, r.target, r.target_type, r.date, r.date_offset, r.date_neg_utc_offset, r.name, r.comment, r.synthetic, p.id as author_id, p.fullname as author_fullname, p.name as author_name, p.email as author_email, r.object_id from rels r left join person p on p.id = r.author order by r.object_id; $$; --- end revision_metadata functions --- origin_metadata functions -create type origin_metadata_signature as ( - id bigint, - origin_url text, - discovery_date timestamptz, - tool_id bigint, - metadata jsonb, - provider_id integer, - provider_name text, - provider_type text, - provider_url text -); -create or replace function swh_origin_metadata_get_by_origin( - origin text) - returns setof origin_metadata_signature - language sql - stable -as $$ - select om.id as id, o.url as origin_url, discovery_date, tool_id, om.metadata, - mp.id as provider_id, provider_name, provider_type, provider_url - from origin_metadata as om - inner join metadata_provider mp on om.provider_id = mp.id - inner join origin o on om.origin_id = o.id - where o.url = origin - order by discovery_date desc; -$$; - -create or replace function swh_origin_metadata_get_by_provider_type( - origin_url text, - provider_type text) - returns setof origin_metadata_signature - language sql - stable -as $$ - select om.id as id, o.url as origin_url, discovery_date, tool_id, om.metadata, - mp.id as provider_id, provider_name, provider_type, provider_url - from origin_metadata as om - inner join metadata_provider mp on om.provider_id = mp.id - inner join origin o on om.origin_id = o.id - where o.url = origin_url - and mp.provider_type = provider_type - order by discovery_date desc; -$$; --- end origin_metadata functions - --- add tmp_tool entries to tool, --- skipping duplicates if any. --- --- operates in bulk: 0. create temporary tmp_tool, 1. COPY to --- it, 2. call this function to insert and filtering out duplicates -create or replace function swh_tool_add() - returns setof tool - language plpgsql -as $$ -begin - insert into tool(name, version, configuration) - select name, version, configuration from tmp_tool tmp - on conflict(name, version, configuration) do nothing; - - return query - select id, name, version, configuration - from tmp_tool join tool - using(name, version, configuration); - - return; -end -$$; - - -- simple counter mapping a textual label to an integer value create type counter as ( label text, value bigint ); -- return statistics about the number of tuples in various SWH tables -- -- Note: the returned values are based on postgres internal statistics -- (pg_class table), which are only updated daily (by autovacuum) or so create or replace function swh_stat_counters() returns setof counter language sql stable as $$ select object_type as label, value as value from object_counts where object_type in ( 'content', 'directory', 'directory_entry_dir', 'directory_entry_file', 'directory_entry_rev', 'origin', 'origin_visit', 'person', 'release', 'revision', 'revision_history', 'skipped_content', 'snapshot' ); $$; create or replace function swh_update_counter(object_type text) returns void language plpgsql as $$ begin execute format(' insert into object_counts (value, last_update, object_type) values ((select count(*) from %1$I), NOW(), %1$L) on conflict (object_type) do update set value = excluded.value, last_update = excluded.last_update', object_type); return; end; $$; create or replace function swh_update_counter_bucketed() returns void language plpgsql as $$ declare query text; line_to_update int; new_value bigint; begin select object_counts_bucketed.line, format( 'select count(%I) from %I where %s', coalesce(identifier, '*'), object_type, coalesce( concat_ws( ' and ', case when bucket_start is not null then format('%I >= %L', identifier, bucket_start) -- lower bound condition, inclusive end, case when bucket_end is not null then format('%I < %L', identifier, bucket_end) -- upper bound condition, exclusive end ), 'true' ) ) from object_counts_bucketed order by coalesce(last_update, now() - '1 month'::interval) asc limit 1 into line_to_update, query; execute query into new_value; update object_counts_bucketed set value = new_value, last_update = now() where object_counts_bucketed.line = line_to_update; END $$; create or replace function swh_update_counters_from_buckets() returns trigger language plpgsql as $$ begin with to_update as ( select object_type, sum(value) as value, max(last_update) as last_update from object_counts_bucketed ob1 where not exists ( select 1 from object_counts_bucketed ob2 where ob1.object_type = ob2.object_type and value is null ) group by object_type ) update object_counts set value = to_update.value, last_update = to_update.last_update from to_update where object_counts.object_type = to_update.object_type and object_counts.value != to_update.value; return null; end $$; create trigger update_counts_from_bucketed after insert or update on object_counts_bucketed for each row when (NEW.line % 256 = 0) execute procedure swh_update_counters_from_buckets(); diff --git a/swh/storage/sql/60-swh-indexes.sql b/swh/storage/sql/60-swh-indexes.sql index 2f3e49f1..7e9b0513 100644 --- a/swh/storage/sql/60-swh-indexes.sql +++ b/swh/storage/sql/60-swh-indexes.sql @@ -1,194 +1,191 @@ -- content create unique index concurrently content_pkey on content(sha1); create unique index concurrently on content(sha1_git); create index concurrently on content(sha256); create index concurrently on content(blake2s256); create index concurrently on content(ctime); -- TODO use a BRIN index here (postgres >= 9.5) create unique index concurrently on content(object_id); alter table content add primary key using index content_pkey; -- origin create unique index concurrently origin_pkey on origin(id); alter table origin add primary key using index origin_pkey; create index concurrently on origin using gin (url gin_trgm_ops); create index concurrently on origin using hash (url); create index concurrently on origin using btree(digest(url, 'sha1')); -- skipped_content alter table skipped_content add constraint skipped_content_sha1_sha1_git_sha256_key unique (sha1, sha1_git, sha256); create index concurrently on skipped_content(sha1); create index concurrently on skipped_content(sha1_git); create index concurrently on skipped_content(sha256); create index concurrently on skipped_content(blake2s256); create unique index concurrently on skipped_content(object_id); alter table skipped_content add constraint skipped_content_origin_fkey foreign key (origin) references origin(id) not valid; alter table skipped_content validate constraint skipped_content_origin_fkey; -- directory create unique index concurrently directory_pkey on directory(id); alter table directory add primary key using index directory_pkey; create index concurrently on directory using gin (dir_entries); create index concurrently on directory using gin (file_entries); create index concurrently on directory using gin (rev_entries); create unique index concurrently on directory(object_id); -- directory_entry_dir create unique index concurrently directory_entry_dir_pkey on directory_entry_dir(id); alter table directory_entry_dir add primary key using index directory_entry_dir_pkey; create unique index concurrently on directory_entry_dir(target, name, perms); -- directory_entry_file create unique index concurrently directory_entry_file_pkey on directory_entry_file(id); alter table directory_entry_file add primary key using index directory_entry_file_pkey; create unique index concurrently on directory_entry_file(target, name, perms); -- directory_entry_rev create unique index concurrently directory_entry_rev_pkey on directory_entry_rev(id); alter table directory_entry_rev add primary key using index directory_entry_rev_pkey; create unique index concurrently on directory_entry_rev(target, name, perms); -- person create unique index concurrently person_pkey on person(id); alter table person add primary key using index person_pkey; create unique index concurrently on person(fullname); create index concurrently on person(name); create index concurrently on person(email); -- revision create unique index concurrently revision_pkey on revision(id); alter table revision add primary key using index revision_pkey; alter table revision add constraint revision_author_fkey foreign key (author) references person(id) not valid; alter table revision validate constraint revision_author_fkey; alter table revision add constraint revision_committer_fkey foreign key (committer) references person(id) not valid; alter table revision validate constraint revision_committer_fkey; create index concurrently on revision(directory); create unique index concurrently on revision(object_id); -- revision_history create unique index concurrently revision_history_pkey on revision_history(id, parent_rank); alter table revision_history add primary key using index revision_history_pkey; create index concurrently on revision_history(parent_id); alter table revision_history add constraint revision_history_id_fkey foreign key (id) references revision(id) not valid; alter table revision_history validate constraint revision_history_id_fkey; -- snapshot create unique index concurrently snapshot_pkey on snapshot(object_id); alter table snapshot add primary key using index snapshot_pkey; create unique index concurrently on snapshot(id); -- snapshot_branch create unique index concurrently snapshot_branch_pkey on snapshot_branch(object_id); alter table snapshot_branch add primary key using index snapshot_branch_pkey; create unique index concurrently on snapshot_branch (target_type, target, name); alter table snapshot_branch add constraint snapshot_branch_target_check check ((target_type is null) = (target is null)) not valid; alter table snapshot_branch validate constraint snapshot_branch_target_check; alter table snapshot_branch add constraint snapshot_target_check check (target_type not in ('content', 'directory', 'revision', 'release', 'snapshot') or length(target) = 20) not valid; alter table snapshot_branch validate constraint snapshot_target_check; create unique index concurrently on snapshot_branch (name) where target_type is null and target is null; -- snapshot_branches create unique index concurrently snapshot_branches_pkey on snapshot_branches(snapshot_id, branch_id); alter table snapshot_branches add primary key using index snapshot_branches_pkey; alter table snapshot_branches add constraint snapshot_branches_snapshot_id_fkey foreign key (snapshot_id) references snapshot(object_id) not valid; alter table snapshot_branches validate constraint snapshot_branches_snapshot_id_fkey; alter table snapshot_branches add constraint snapshot_branches_branch_id_fkey foreign key (branch_id) references snapshot_branch(object_id) not valid; alter table snapshot_branches validate constraint snapshot_branches_branch_id_fkey; -- origin_visit create unique index concurrently origin_visit_pkey on origin_visit(origin, visit); alter table origin_visit add primary key using index origin_visit_pkey; create index concurrently on origin_visit(date); create index concurrently on origin_visit(type, status, date); alter table origin_visit add constraint origin_visit_origin_fkey foreign key (origin) references origin(id) not valid; alter table origin_visit validate constraint origin_visit_origin_fkey; -- origin_visit_status create unique index concurrently origin_visit_status_pkey on origin_visit_status(origin, visit, date); alter table origin_visit_status add primary key using index origin_visit_status_pkey; alter table origin_visit_status add constraint origin_visit_status_origin_visit_fkey foreign key (origin, visit) references origin_visit(origin, visit) not valid; alter table origin_visit_status validate constraint origin_visit_status_origin_visit_fkey; -- release create unique index concurrently release_pkey on release(id); alter table release add primary key using index release_pkey; create index concurrently on release(target, target_type); create unique index concurrently on release(object_id); alter table release add constraint release_author_fkey foreign key (author) references person(id) not valid; alter table release validate constraint release_author_fkey; -- if the author is null, then the date must be null alter table release add constraint release_author_date_check check ((date is null) or (author is not null)) not valid; alter table release validate constraint release_author_date_check; --- tool -create unique index tool_pkey on tool(id); -alter table tool add primary key using index tool_pkey; +-- metadata_fetcher +create unique index metadata_fetcher_pkey on metadata_fetcher(id); +alter table metadata_fetcher add primary key using index metadata_fetcher_pkey; -create unique index on tool(name, version, configuration); +create unique index metadata_fetcher_name_version on metadata_fetcher(name, version); --- metadata_provider -create unique index concurrently metadata_provider_pkey on metadata_provider(id); -alter table metadata_provider add primary key using index metadata_provider_pkey; +-- metadata_authority +create unique index concurrently metadata_authority_pkey on metadata_authority(id); +alter table metadata_authority add primary key using index metadata_authority_pkey; -create index concurrently on metadata_provider(provider_name, provider_url); -create unique index metadata_provider_type_url - on metadata_provider(provider_type, provider_url); +create unique index metadata_authority_type_url on metadata_authority(type, url); -- origin_metadata create unique index concurrently origin_metadata_pkey on origin_metadata(id); alter table origin_metadata add primary key using index origin_metadata_pkey; - -create index concurrently on origin_metadata(origin_id, provider_id, tool_id); +create index concurrently origin_metadata_origin_authority_date on origin_metadata(origin_id, authority_id, discovery_date); alter table origin_metadata add constraint origin_metadata_origin_fkey foreign key (origin_id) references origin(id) not valid; alter table origin_metadata validate constraint origin_metadata_origin_fkey; -alter table origin_metadata add constraint origin_metadata_provider_fkey foreign key (provider_id) references metadata_provider(id) not valid; -alter table origin_metadata validate constraint origin_metadata_provider_fkey; +alter table origin_metadata add constraint origin_metadata_authority_fkey foreign key (authority_id) references metadata_authority(id) not valid; +alter table origin_metadata validate constraint origin_metadata_authority_fkey; -alter table origin_metadata add constraint origin_metadata_tool_fkey foreign key (tool_id) references tool(id) not valid; -alter table origin_metadata validate constraint origin_metadata_tool_fkey; +alter table origin_metadata add constraint origin_metadata_fetcher_fkey foreign key (fetcher_id) references metadata_fetcher(id) not valid; +alter table origin_metadata validate constraint origin_metadata_fetcher_fkey; -- object_counts create unique index concurrently object_counts_pkey on object_counts(object_type); alter table object_counts add primary key using index object_counts_pkey; -- object_counts_bucketed create unique index concurrently object_counts_bucketed_pkey on object_counts_bucketed(line); alter table object_counts_bucketed add primary key using index object_counts_bucketed_pkey; diff --git a/swh/storage/storage.py b/swh/storage/storage.py index c90068cc..e16df246 100644 --- a/swh/storage/storage.py +++ b/swh/storage/storage.py @@ -1,1325 +1,1353 @@ # Copyright (C) 2015-2020 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 contextlib import datetime import itertools -import json from collections import defaultdict from contextlib import contextmanager from typing import Any, Dict, Iterable, List, Optional, Union import attr import dateutil.parser import psycopg2 import psycopg2.pool import psycopg2.errors from swh.model.model import ( Content, Directory, Origin, OriginVisit, OriginVisitStatus, Revision, Release, SkippedContent, Snapshot, SHA1_SIZE, ) from swh.model.hashutil import DEFAULT_ALGORITHMS, hash_to_bytes, hash_to_hex from swh.storage.objstorage import ObjStorage from swh.storage.validate import VALIDATION_EXCEPTIONS from swh.storage.utils import now from . import converters from .common import db_transaction_generator, db_transaction from .db import Db from .exc import StorageArgumentException, StorageDBError, HashCollision from .algos import diff from .metrics import timed, send_metric, process_metrics from .utils import get_partition_bounds_bytes, extract_collision_hash from .writer import JournalWriter # Max block size of contents to return BULK_BLOCK_CONTENT_LEN_MAX = 10000 EMPTY_SNAPSHOT_ID = hash_to_bytes("1a8893e6a86f444e8be8e7bda6cb34fb1735a00e") """Identifier for the empty snapshot""" VALIDATION_EXCEPTIONS = VALIDATION_EXCEPTIONS + [ psycopg2.errors.CheckViolation, psycopg2.errors.IntegrityError, psycopg2.errors.InvalidTextRepresentation, psycopg2.errors.NotNullViolation, psycopg2.errors.NumericValueOutOfRange, psycopg2.errors.UndefinedFunction, # (raised on wrong argument typs) ] """Exceptions raised by postgresql when validation of the arguments failed.""" @contextlib.contextmanager def convert_validation_exceptions(): """Catches postgresql errors related to invalid arguments, and re-raises a StorageArgumentException.""" try: yield except tuple(VALIDATION_EXCEPTIONS) as e: raise StorageArgumentException(str(e)) class Storage: """SWH storage proxy, encompassing DB and object storage """ def __init__( self, db, objstorage, min_pool_conns=1, max_pool_conns=10, journal_writer=None ): """ Args: db_conn: either a libpq connection string, or a psycopg2 connection obj_root: path to the root of the object storage """ try: if isinstance(db, psycopg2.extensions.connection): self._pool = None self._db = Db(db) else: self._pool = psycopg2.pool.ThreadedConnectionPool( min_pool_conns, max_pool_conns, db ) self._db = None except psycopg2.OperationalError as e: raise StorageDBError(e) self.journal_writer = JournalWriter(journal_writer) self.objstorage = ObjStorage(objstorage) def get_db(self): if self._db: return self._db else: return Db.from_pool(self._pool) def put_db(self, db): if db is not self._db: db.put_conn() @contextmanager def db(self): db = None try: db = self.get_db() yield db finally: if db: self.put_db(db) @timed @db_transaction() def check_config(self, *, check_write, db=None, cur=None): if not self.objstorage.check_config(check_write=check_write): return False # Check permissions on one of the tables if check_write: check = "INSERT" else: check = "SELECT" cur.execute("select has_table_privilege(current_user, 'content', %s)", (check,)) return cur.fetchone()[0] def _content_unique_key(self, hash, db): """Given a hash (tuple or dict), return a unique key from the aggregation of keys. """ keys = db.content_hash_keys if isinstance(hash, tuple): return hash return tuple([hash[k] for k in keys]) def _content_add_metadata(self, db, cur, content): """Add content to the postgresql database but not the object storage. """ # create temporary table for metadata injection db.mktemp("content", cur) db.copy_to( (c.to_dict() for c in content), "tmp_content", db.content_add_keys, cur ) # move metadata in place try: db.content_add_from_temp(cur) except psycopg2.IntegrityError as e: if e.diag.sqlstate == "23505" and e.diag.table_name == "content": message_detail = e.diag.message_detail if message_detail: hash_name, hash_id = extract_collision_hash(message_detail) collision_contents_hashes = [ c.hashes() for c in content if c.get_hash(hash_name) == hash_id ] else: constraint_to_hash_name = { "content_pkey": "sha1", "content_sha1_git_idx": "sha1_git", "content_sha256_idx": "sha256", } hash_name = constraint_to_hash_name.get(e.diag.constraint_name) hash_id = None collision_contents_hashes = None raise HashCollision( hash_name, hash_id, collision_contents_hashes ) from None else: raise @timed @process_metrics def content_add(self, content: Iterable[Content]) -> Dict: ctime = now() contents = [attr.evolve(c, ctime=ctime) for c in content] objstorage_summary = self.objstorage.content_add(contents) with self.db() as db: with db.transaction() as cur: missing = list( self.content_missing( map(Content.to_dict, contents), key_hash="sha1_git", db=db, cur=cur, ) ) contents = [c for c in contents if c.sha1_git in missing] self.journal_writer.content_add(contents) self._content_add_metadata(db, cur, contents) return { "content:add": len(contents), "content:add:bytes": objstorage_summary["content:add:bytes"], } @timed @db_transaction() def content_update(self, content, keys=[], db=None, cur=None): # TODO: Add a check on input keys. How to properly implement # this? We don't know yet the new columns. self.journal_writer.content_update(content) db.mktemp("content", cur) select_keys = list(set(db.content_get_metadata_keys).union(set(keys))) with convert_validation_exceptions(): db.copy_to(content, "tmp_content", select_keys, cur) db.content_update_from_temp(keys_to_update=keys, cur=cur) @timed @process_metrics @db_transaction() def content_add_metadata( self, content: Iterable[Content], db=None, cur=None ) -> Dict: contents = list(content) missing = self.content_missing( (c.to_dict() for c in contents), key_hash="sha1_git", db=db, cur=cur, ) contents = [c for c in contents if c.sha1_git in missing] self.journal_writer.content_add_metadata(contents) self._content_add_metadata(db, cur, contents) return { "content:add": len(contents), } @timed def content_get(self, content): # FIXME: Make this method support slicing the `data`. if len(content) > BULK_BLOCK_CONTENT_LEN_MAX: raise StorageArgumentException( "Send at maximum %s contents." % BULK_BLOCK_CONTENT_LEN_MAX ) yield from self.objstorage.content_get(content) @timed @db_transaction() def content_get_range(self, start, end, limit=1000, db=None, cur=None): if limit is None: raise StorageArgumentException("limit should not be None") contents = [] next_content = None for counter, content_row in enumerate( db.content_get_range(start, end, limit + 1, cur) ): content = dict(zip(db.content_get_metadata_keys, content_row)) if counter >= limit: # take the last commit for the next page starting from this next_content = content["sha1"] break contents.append(content) return { "contents": contents, "next": next_content, } @timed def content_get_partition( self, partition_id: int, nb_partitions: int, limit: int = 1000, page_token: str = None, ): if limit is None: raise StorageArgumentException("limit should not be None") (start, end) = get_partition_bounds_bytes( partition_id, nb_partitions, SHA1_SIZE ) if page_token: start = hash_to_bytes(page_token) if end is None: end = b"\xff" * SHA1_SIZE result = self.content_get_range(start, end, limit) result2 = { "contents": result["contents"], "next_page_token": None, } if result["next"]: result2["next_page_token"] = hash_to_hex(result["next"]) return result2 @timed @db_transaction(statement_timeout=500) def content_get_metadata( self, contents: List[bytes], db=None, cur=None ) -> Dict[bytes, List[Dict]]: result: Dict[bytes, List[Dict]] = {sha1: [] for sha1 in contents} for row in db.content_get_metadata_from_sha1s(contents, cur): content_meta = dict(zip(db.content_get_metadata_keys, row)) result[content_meta["sha1"]].append(content_meta) return result @timed @db_transaction_generator() def content_missing(self, content, key_hash="sha1", db=None, cur=None): keys = db.content_hash_keys if key_hash not in keys: raise StorageArgumentException("key_hash should be one of %s" % keys) key_hash_idx = keys.index(key_hash) if not content: return for obj in db.content_missing_from_list(content, cur): yield obj[key_hash_idx] @timed @db_transaction_generator() def content_missing_per_sha1(self, contents, db=None, cur=None): for obj in db.content_missing_per_sha1(contents, cur): yield obj[0] @timed @db_transaction_generator() def content_missing_per_sha1_git(self, contents, db=None, cur=None): for obj in db.content_missing_per_sha1_git(contents, cur): yield obj[0] @timed @db_transaction() def content_find(self, content, db=None, cur=None): if not set(content).intersection(DEFAULT_ALGORITHMS): raise StorageArgumentException( "content keys must contain at least one of: " "sha1, sha1_git, sha256, blake2s256" ) contents = db.content_find( sha1=content.get("sha1"), sha1_git=content.get("sha1_git"), sha256=content.get("sha256"), blake2s256=content.get("blake2s256"), cur=cur, ) return [dict(zip(db.content_find_cols, content)) for content in contents] @timed @db_transaction() def content_get_random(self, db=None, cur=None): return db.content_get_random(cur) @staticmethod def _skipped_content_normalize(d): d = d.copy() if d.get("status") is None: d["status"] = "absent" if d.get("length") is None: d["length"] = -1 return d @staticmethod def _skipped_content_validate(d): """Sanity checks on status / reason / length, that postgresql doesn't enforce.""" if d["status"] != "absent": raise StorageArgumentException( "Invalid content status: {}".format(d["status"]) ) if d.get("reason") is None: raise StorageArgumentException( "Must provide a reason if content is absent." ) if d["length"] < -1: raise StorageArgumentException("Content length must be positive or -1.") def _skipped_content_add_metadata(self, db, cur, content: Iterable[SkippedContent]): origin_ids = db.origin_id_get_by_url([cont.origin for cont in content], cur=cur) content = [ attr.evolve(c, origin=origin_id) for (c, origin_id) in zip(content, origin_ids) ] db.mktemp("skipped_content", cur) db.copy_to( [c.to_dict() for c in content], "tmp_skipped_content", db.skipped_content_keys, cur, ) # move metadata in place db.skipped_content_add_from_temp(cur) @timed @process_metrics @db_transaction() def skipped_content_add( self, content: Iterable[SkippedContent], db=None, cur=None ) -> Dict: ctime = now() content = [attr.evolve(c, ctime=ctime) for c in content] missing_contents = self.skipped_content_missing( (c.to_dict() for c in content), db=db, cur=cur, ) content = [ c for c in content if any( all( c.get_hash(algo) == missing_content.get(algo) for algo in DEFAULT_ALGORITHMS ) for missing_content in missing_contents ) ] self.journal_writer.skipped_content_add(content) self._skipped_content_add_metadata(db, cur, content) return { "skipped_content:add": len(content), } @timed @db_transaction_generator() def skipped_content_missing(self, contents, db=None, cur=None): contents = list(contents) for content in db.skipped_content_missing(contents, cur): yield dict(zip(db.content_hash_keys, content)) @timed @process_metrics @db_transaction() def directory_add( self, directories: Iterable[Directory], db=None, cur=None ) -> Dict: directories = list(directories) summary = {"directory:add": 0} dirs = set() dir_entries: Dict[str, defaultdict] = { "file": defaultdict(list), "dir": defaultdict(list), "rev": defaultdict(list), } for cur_dir in directories: dir_id = cur_dir.id dirs.add(dir_id) for src_entry in cur_dir.entries: entry = src_entry.to_dict() entry["dir_id"] = dir_id dir_entries[entry["type"]][dir_id].append(entry) dirs_missing = set(self.directory_missing(dirs, db=db, cur=cur)) if not dirs_missing: return summary self.journal_writer.directory_add( dir_ for dir_ in directories if dir_.id in dirs_missing ) # Copy directory ids dirs_missing_dict = ({"id": dir} for dir in dirs_missing) db.mktemp("directory", cur) db.copy_to(dirs_missing_dict, "tmp_directory", ["id"], cur) # Copy entries for entry_type, entry_list in dir_entries.items(): entries = itertools.chain.from_iterable( entries_for_dir for dir_id, entries_for_dir in entry_list.items() if dir_id in dirs_missing ) db.mktemp_dir_entry(entry_type) db.copy_to( entries, "tmp_directory_entry_%s" % entry_type, ["target", "name", "perms", "dir_id"], cur, ) # Do the final copy db.directory_add_from_temp(cur) summary["directory:add"] = len(dirs_missing) return summary @timed @db_transaction_generator() def directory_missing(self, directories, db=None, cur=None): for obj in db.directory_missing_from_list(directories, cur): yield obj[0] @timed @db_transaction_generator(statement_timeout=20000) def directory_ls(self, directory, recursive=False, db=None, cur=None): if recursive: res_gen = db.directory_walk(directory, cur=cur) else: res_gen = db.directory_walk_one(directory, cur=cur) for line in res_gen: yield dict(zip(db.directory_ls_cols, line)) @timed @db_transaction(statement_timeout=2000) def directory_entry_get_by_path(self, directory, paths, db=None, cur=None): res = db.directory_entry_get_by_path(directory, paths, cur) if res: return dict(zip(db.directory_ls_cols, res)) @timed @db_transaction() def directory_get_random(self, db=None, cur=None): return db.directory_get_random(cur) @timed @process_metrics @db_transaction() def revision_add(self, revisions: Iterable[Revision], db=None, cur=None) -> Dict: revisions = list(revisions) summary = {"revision:add": 0} revisions_missing = set( self.revision_missing( set(revision.id for revision in revisions), db=db, cur=cur ) ) if not revisions_missing: return summary db.mktemp_revision(cur) revisions_filtered = [ revision for revision in revisions if revision.id in revisions_missing ] self.journal_writer.revision_add(revisions_filtered) revisions_filtered = list(map(converters.revision_to_db, revisions_filtered)) parents_filtered: List[bytes] = [] with convert_validation_exceptions(): db.copy_to( revisions_filtered, "tmp_revision", db.revision_add_cols, cur, lambda rev: parents_filtered.extend(rev["parents"]), ) db.revision_add_from_temp(cur) db.copy_to( parents_filtered, "revision_history", ["id", "parent_id", "parent_rank"], cur, ) return {"revision:add": len(revisions_missing)} @timed @db_transaction_generator() def revision_missing(self, revisions, db=None, cur=None): if not revisions: return for obj in db.revision_missing_from_list(revisions, cur): yield obj[0] @timed @db_transaction_generator(statement_timeout=1000) def revision_get(self, revisions, db=None, cur=None): for line in db.revision_get_from_list(revisions, cur): data = converters.db_to_revision(dict(zip(db.revision_get_cols, line))) if not data["type"]: yield None continue yield data @timed @db_transaction_generator(statement_timeout=2000) def revision_log(self, revisions, limit=None, db=None, cur=None): for line in db.revision_log(revisions, limit, cur): data = converters.db_to_revision(dict(zip(db.revision_get_cols, line))) if not data["type"]: yield None continue yield data @timed @db_transaction_generator(statement_timeout=2000) def revision_shortlog(self, revisions, limit=None, db=None, cur=None): yield from db.revision_shortlog(revisions, limit, cur) @timed @db_transaction() def revision_get_random(self, db=None, cur=None): return db.revision_get_random(cur) @timed @process_metrics @db_transaction() def release_add(self, releases: Iterable[Release], db=None, cur=None) -> Dict: releases = list(releases) summary = {"release:add": 0} release_ids = set(release.id for release in releases) releases_missing = set(self.release_missing(release_ids, db=db, cur=cur)) if not releases_missing: return summary db.mktemp_release(cur) releases_filtered = [ release for release in releases if release.id in releases_missing ] self.journal_writer.release_add(releases_filtered) releases_filtered = list(map(converters.release_to_db, releases_filtered)) with convert_validation_exceptions(): db.copy_to(releases_filtered, "tmp_release", db.release_add_cols, cur) db.release_add_from_temp(cur) return {"release:add": len(releases_missing)} @timed @db_transaction_generator() def release_missing(self, releases, db=None, cur=None): if not releases: return for obj in db.release_missing_from_list(releases, cur): yield obj[0] @timed @db_transaction_generator(statement_timeout=500) def release_get(self, releases, db=None, cur=None): for release in db.release_get_from_list(releases, cur): data = converters.db_to_release(dict(zip(db.release_get_cols, release))) yield data if data["target_type"] else None @timed @db_transaction() def release_get_random(self, db=None, cur=None): return db.release_get_random(cur) @timed @process_metrics @db_transaction() def snapshot_add(self, snapshots: Iterable[Snapshot], db=None, cur=None) -> Dict: created_temp_table = False count = 0 for snapshot in snapshots: if not db.snapshot_exists(snapshot.id, cur): if not created_temp_table: db.mktemp_snapshot_branch(cur) created_temp_table = True with convert_validation_exceptions(): db.copy_to( ( { "name": name, "target": info.target if info else None, "target_type": ( info.target_type.value if info else None ), } for name, info in snapshot.branches.items() ), "tmp_snapshot_branch", ["name", "target", "target_type"], cur, ) self.journal_writer.snapshot_add([snapshot]) db.snapshot_add(snapshot.id, cur) count += 1 return {"snapshot:add": count} @timed @db_transaction_generator() def snapshot_missing(self, snapshots, db=None, cur=None): for obj in db.snapshot_missing_from_list(snapshots, cur): yield obj[0] @timed @db_transaction(statement_timeout=2000) def snapshot_get(self, snapshot_id, db=None, cur=None): return self.snapshot_get_branches(snapshot_id, db=db, cur=cur) @timed @db_transaction(statement_timeout=2000) def snapshot_get_by_origin_visit(self, origin, visit, db=None, cur=None): snapshot_id = db.snapshot_get_by_origin_visit(origin, visit, cur) if snapshot_id: return self.snapshot_get(snapshot_id, db=db, cur=cur) return None @timed @db_transaction(statement_timeout=4000) def snapshot_get_latest(self, origin, allowed_statuses=None, db=None, cur=None): if isinstance(origin, int): origin = self.origin_get({"id": origin}, db=db, cur=cur) if not origin: return origin = origin["url"] origin_visit = self.origin_visit_get_latest( origin, allowed_statuses=allowed_statuses, require_snapshot=True, db=db, cur=cur, ) if origin_visit and origin_visit["snapshot"]: snapshot = self.snapshot_get(origin_visit["snapshot"], db=db, cur=cur) if not snapshot: raise StorageArgumentException( "last origin visit references an unknown snapshot" ) return snapshot @timed @db_transaction(statement_timeout=2000) def snapshot_count_branches(self, snapshot_id, db=None, cur=None): return dict([bc for bc in db.snapshot_count_branches(snapshot_id, cur)]) @timed @db_transaction(statement_timeout=2000) def snapshot_get_branches( self, snapshot_id, branches_from=b"", branches_count=1000, target_types=None, db=None, cur=None, ): if snapshot_id == EMPTY_SNAPSHOT_ID: return { "id": snapshot_id, "branches": {}, "next_branch": None, } branches = {} next_branch = None fetched_branches = list( db.snapshot_get_by_id( snapshot_id, branches_from=branches_from, branches_count=branches_count + 1, target_types=target_types, cur=cur, ) ) for branch in fetched_branches[:branches_count]: branch = dict(zip(db.snapshot_get_cols, branch)) del branch["snapshot_id"] name = branch.pop("name") if branch == {"target": None, "target_type": None}: branch = None branches[name] = branch if len(fetched_branches) > branches_count: branch = dict(zip(db.snapshot_get_cols, fetched_branches[-1])) next_branch = branch["name"] if branches: return { "id": snapshot_id, "branches": branches, "next_branch": next_branch, } return None @timed @db_transaction() def snapshot_get_random(self, db=None, cur=None): return db.snapshot_get_random(cur) @timed @db_transaction() def origin_visit_add( self, origin_url: str, date: Union[str, datetime.datetime], type: str, db=None, cur=None, ) -> OriginVisit: if isinstance(date, str): # FIXME: Converge on iso8601 at some point date = dateutil.parser.parse(date) elif not isinstance(date, datetime.datetime): raise StorageArgumentException("Date must be a datetime or a string") origin = self.origin_get({"url": origin_url}, db=db, cur=cur) if not origin: # Cannot add a visit without an origin raise StorageArgumentException("Unknown origin %s", origin_url) with convert_validation_exceptions(): visit_id = db.origin_visit_add(origin_url, date, type, cur=cur) status = "ongoing" # We can write to the journal only after inserting to the # DB, because we want the id of the visit visit = OriginVisit.from_dict( { "origin": origin_url, "date": date, "type": type, "visit": visit_id, # TODO: Remove when we remove those fields from the model "status": status, "metadata": None, "snapshot": None, } ) with convert_validation_exceptions(): visit_status = OriginVisitStatus( origin=origin_url, visit=visit_id, date=date, status=status, snapshot=None, metadata=None, ) self._origin_visit_status_add(visit_status, db=db, cur=cur) self.journal_writer.origin_visit_add([visit]) send_metric("origin_visit:add", count=1, method_name="origin_visit") return visit def _origin_visit_status_add( self, origin_visit_status: OriginVisitStatus, db, cur ) -> None: """Add an origin visit status""" db.origin_visit_status_add(origin_visit_status, cur=cur) # TODO: write to the journal the origin visit status send_metric( "origin_visit_status:add", count=1, method_name="origin_visit_status" ) @timed @db_transaction() def origin_visit_update( self, origin: str, visit_id: int, status: str, metadata: Optional[Dict] = None, snapshot: Optional[bytes] = None, date: Optional[datetime.datetime] = None, db=None, cur=None, ): if not isinstance(origin, str): raise StorageArgumentException( "origin must be a string, not %r" % (origin,) ) origin_url = origin visit = db.origin_visit_get(origin_url, visit_id, cur=cur) if not visit: raise StorageArgumentException("Invalid visit_id for this origin.") visit = dict(zip(db.origin_visit_get_cols, visit)) updates: Dict[str, Any] = { "status": status, } if metadata and metadata != visit["metadata"]: updates["metadata"] = metadata if snapshot and snapshot != visit["snapshot"]: updates["snapshot"] = snapshot if updates: with convert_validation_exceptions(): updated_visit = OriginVisit.from_dict({**visit, **updates}) self.journal_writer.origin_visit_update([updated_visit]) # Write updates to origin visit (backward compatibility) db.origin_visit_update(origin, visit_id, updates) # Add new origin visit status last_visit_status = self._origin_visit_get_updated( origin, visit_id, db=db, cur=cur ) assert last_visit_status is not None with convert_validation_exceptions(): visit_status = OriginVisitStatus( origin=origin_url, visit=visit_id, date=date or now(), status=status, snapshot=snapshot or last_visit_status["snapshot"], metadata=metadata or last_visit_status["metadata"], ) self._origin_visit_status_add(visit_status, db=db, cur=cur) def _origin_visit_get_updated( self, origin: str, visit_id: int, db, cur ) -> Optional[Dict[str, Any]]: """Retrieve origin visit and latest origin visit status and merge them into an origin visit. """ row_visit = db.origin_visit_get(origin, visit_id) if row_visit is None: return None visit = dict(zip(db.origin_visit_get_cols, row_visit)) return self._origin_visit_apply_update(visit, db=db, cur=cur) def _origin_visit_apply_update( self, visit: Dict[str, Any], db, cur=None ) -> Dict[str, Any]: """Retrieve the latest visit status information for the origin visit. Then merge it with the visit and return it. """ visit_status = db.origin_visit_status_get_latest( visit["origin"], visit["visit"] ) return self._origin_visit_merge(visit, visit_status) def _origin_visit_merge( self, visit: Dict[str, Any], visit_status: Dict[str, Any] ) -> Dict[str, Any]: """Merge origin_visit and origin_visit_status together. """ return OriginVisit.from_dict( { # default to the values in visit **visit, # override with the last update **visit_status, # visit['origin'] is the URL (via a join), while # visit_status['origin'] is only an id. "origin": visit["origin"], # but keep the date of the creation of the origin visit "date": visit["date"], } ).to_dict() @timed @db_transaction() def origin_visit_upsert( self, visits: Iterable[OriginVisit], db=None, cur=None ) -> None: for visit in visits: if visit.visit is None: raise StorageArgumentException(f"Missing visit id for visit {visit}") self.journal_writer.origin_visit_upsert(visits) for visit in visits: # TODO: upsert them all in a single query assert visit.visit is not None db.origin_visit_upsert(visit, cur=cur) with convert_validation_exceptions(): visit_status = OriginVisitStatus( origin=visit.origin, visit=visit.visit, date=now(), status=visit.status, snapshot=visit.snapshot, metadata=visit.metadata, ) db.origin_visit_status_add(visit_status, cur=cur) @timed @db_transaction_generator(statement_timeout=500) def origin_visit_get( self, origin: str, last_visit: Optional[int] = None, limit: Optional[int] = None, db=None, cur=None, ) -> Iterable[Dict[str, Any]]: for line in db.origin_visit_get_all( origin, last_visit=last_visit, limit=limit, cur=cur ): data = dict(zip(db.origin_visit_get_cols, line)) yield data @timed @db_transaction(statement_timeout=500) def origin_visit_find_by_date( self, origin: str, visit_date: datetime.datetime, db=None, cur=None ) -> Optional[Dict[str, Any]]: visit = db.origin_visit_find_by_date(origin, visit_date, cur=cur) if visit: return visit return None @timed @db_transaction(statement_timeout=500) def origin_visit_get_by( self, origin: str, visit: int, db=None, cur=None ) -> Optional[Dict[str, Any]]: ori_visit = db.origin_visit_get(origin, visit, cur) if not ori_visit: return None return dict(zip(db.origin_visit_get_cols, ori_visit)) @timed @db_transaction(statement_timeout=4000) def origin_visit_get_latest( self, origin: str, allowed_statuses: Optional[List[str]] = None, require_snapshot: bool = False, db=None, cur=None, ) -> Optional[Dict[str, Any]]: origin_visit = db.origin_visit_get_latest( origin, allowed_statuses=allowed_statuses, require_snapshot=require_snapshot, cur=cur, ) if origin_visit: return dict(zip(db.origin_visit_get_cols, origin_visit)) return None @timed @db_transaction() def origin_visit_get_random( self, type: str, db=None, cur=None ) -> Optional[Dict[str, Any]]: result = db.origin_visit_get_random(type, cur) if result: return dict(zip(db.origin_visit_get_cols, result)) else: return None @timed @db_transaction(statement_timeout=2000) def object_find_by_sha1_git(self, ids, db=None, cur=None): ret = {id: [] for id in ids} for retval in db.object_find_by_sha1_git(ids, cur=cur): if retval[1]: ret[retval[0]].append( dict(zip(db.object_find_by_sha1_git_cols, retval)) ) return ret @timed @db_transaction(statement_timeout=500) def origin_get(self, origins, db=None, cur=None): if isinstance(origins, dict): # Old API return_single = True origins = [origins] elif len(origins) == 0: return [] else: return_single = False origin_urls = [origin["url"] for origin in origins] results = db.origin_get_by_url(origin_urls, cur) results = [dict(zip(db.origin_cols, result)) for result in results] if return_single: assert len(results) == 1 if results[0]["url"] is not None: return results[0] else: return None else: return [None if res["url"] is None else res for res in results] @timed @db_transaction_generator(statement_timeout=500) def origin_get_by_sha1(self, sha1s, db=None, cur=None): for line in db.origin_get_by_sha1(sha1s, cur): if line[0] is not None: yield dict(zip(db.origin_cols, line)) else: yield None @timed @db_transaction_generator() def origin_get_range(self, origin_from=1, origin_count=100, db=None, cur=None): for origin in db.origin_get_range(origin_from, origin_count, cur): yield dict(zip(db.origin_get_range_cols, origin)) @timed @db_transaction() def origin_list( self, page_token: Optional[str] = None, limit: int = 100, *, db=None, cur=None ) -> dict: page_token = page_token or "0" if not isinstance(page_token, str): raise StorageArgumentException("page_token must be a string.") origin_from = int(page_token) result: Dict[str, Any] = { "origins": [ dict(zip(db.origin_get_range_cols, origin)) for origin in db.origin_get_range(origin_from, limit, cur) ], } assert len(result["origins"]) <= limit if len(result["origins"]) == limit: result["next_page_token"] = str(result["origins"][limit - 1]["id"] + 1) for origin in result["origins"]: del origin["id"] return result @timed @db_transaction_generator() def origin_search( self, url_pattern, offset=0, limit=50, regexp=False, with_visit=False, db=None, cur=None, ): for origin in db.origin_search( url_pattern, offset, limit, regexp, with_visit, cur ): yield dict(zip(db.origin_cols, origin)) @timed @db_transaction() def origin_count( self, url_pattern, regexp=False, with_visit=False, db=None, cur=None ): return db.origin_count(url_pattern, regexp, with_visit, cur) @timed @db_transaction() def origin_add(self, origins: Iterable[Origin], db=None, cur=None) -> List[Dict]: origins = list(origins) for origin in origins: self.origin_add_one(origin, db=db, cur=cur) return [o.to_dict() for o in origins] @timed @db_transaction() def origin_add_one(self, origin: Origin, db=None, cur=None) -> str: origin_row = list(db.origin_get_by_url([origin.url], cur))[0] origin_url = dict(zip(db.origin_cols, origin_row))["url"] if origin_url: return origin_url self.journal_writer.origin_add([origin]) url = db.origin_add(origin.url, cur) send_metric("origin:add", count=1, method_name="origin_add_one") return url @db_transaction(statement_timeout=500) def stat_counters(self, db=None, cur=None): return {k: v for (k, v) in db.stat_counters()} @db_transaction() def refresh_stat_counters(self, db=None, cur=None): keys = [ "content", "directory", "directory_entry_dir", "directory_entry_file", "directory_entry_rev", "origin", "origin_visit", "person", "release", "revision", "revision_history", "skipped_content", "snapshot", ] for key in keys: cur.execute("select * from swh_update_counter(%s)", (key,)) @timed @db_transaction() def origin_metadata_add( - self, origin_url, ts, provider, tool, metadata, db=None, cur=None - ): - if isinstance(ts, str): - ts = dateutil.parser.parse(ts) - - db.origin_metadata_add(origin_url, ts, provider, tool, metadata, cur) + self, + origin_url: str, + discovery_date: datetime.datetime, + authority: Dict[str, Any], + fetcher: Dict[str, Any], + format: str, + metadata: bytes, + db=None, + cur=None, + ) -> None: + authority_id = db.metadata_authority_get_id( + authority["type"], authority["url"], cur + ) + if not authority_id: + raise StorageArgumentException(f"Unknown authority {authority}") + fetcher_id = db.metadata_fetcher_get_id( + fetcher["name"], fetcher["version"], cur + ) + if not fetcher_id: + raise StorageArgumentException(f"Unknown fetcher {fetcher}") + db.origin_metadata_add( + origin_url, discovery_date, authority_id, fetcher_id, format, metadata, cur + ) send_metric("origin_metadata:add", count=1, method_name="origin_metadata_add") @timed - @db_transaction_generator(statement_timeout=500) - def origin_metadata_get_by(self, origin_url, provider_type=None, db=None, cur=None): - for line in db.origin_metadata_get_by(origin_url, provider_type, cur): - yield dict(zip(db.origin_metadata_get_cols, line)) + @db_transaction(statement_timeout=500) + def origin_metadata_get( + self, + origin_url: str, + authority: Dict[str, str], + after: Optional[datetime.datetime] = None, + limit: Optional[int] = None, + db=None, + cur=None, + ) -> List[Dict[str, Any]]: + authority_id = db.metadata_authority_get_id( + authority["type"], authority["url"], cur + ) + if not authority_id: + return [] + results = [] + for line in db.origin_metadata_get(origin_url, authority_id, after, limit, cur): + row = dict(zip(db.origin_metadata_get_cols, line)) + results.append( + { + "origin_url": row.pop("origin.url"), + "authority": { + "type": row.pop("metadata_authority.type"), + "url": row.pop("metadata_authority.url"), + }, + "fetcher": { + "name": row.pop("metadata_fetcher.name"), + "version": row.pop("metadata_fetcher.version"), + }, + **row, + } + ) + return results @timed @db_transaction() - def tool_add(self, tools, db=None, cur=None): - db.mktemp_tool(cur) - with convert_validation_exceptions(): - db.copy_to(tools, "tmp_tool", ["name", "version", "configuration"], cur) - tools = db.tool_add_from_temp(cur) - - results = [dict(zip(db.tool_cols, line)) for line in tools] - send_metric("tool:add", count=len(results), method_name="tool_add") - return results + def metadata_fetcher_add( + self, name: str, version: str, metadata: Dict[str, Any], db=None, cur=None + ) -> None: + db.metadata_fetcher_add(name, version, metadata) + send_metric("metadata_fetcher:add", count=1, method_name="metadata_fetcher") @timed @db_transaction(statement_timeout=500) - def tool_get(self, tool, db=None, cur=None): - tool_conf = tool["configuration"] - if isinstance(tool_conf, dict): - tool_conf = json.dumps(tool_conf) - - idx = db.tool_get(tool["name"], tool["version"], tool_conf) - if not idx: + def metadata_fetcher_get( + self, name: str, version: str, db=None, cur=None + ) -> Optional[Dict[str, Any]]: + row = db.metadata_fetcher_get(name, version, cur=cur) + if not row: return None - return dict(zip(db.tool_cols, idx)) - - @timed - @db_transaction() - def metadata_provider_add( - self, provider_name, provider_type, provider_url, metadata, db=None, cur=None - ): - result = db.metadata_provider_add( - provider_name, provider_type, provider_url, metadata, cur - ) - send_metric("metadata_provider:add", count=1, method_name="metadata_provider") - return result + return dict(zip(db.metadata_fetcher_cols, row)) @timed @db_transaction() - def metadata_provider_get(self, provider_id, db=None, cur=None): - result = db.metadata_provider_get(provider_id) - if not result: - return None - return dict(zip(db.metadata_provider_cols, result)) + def metadata_authority_add( + self, type: str, url: str, metadata: Dict[str, Any], db=None, cur=None + ) -> None: + db.metadata_authority_add(type, url, metadata, cur) + send_metric("metadata_authority:add", count=1, method_name="metadata_authority") @timed @db_transaction() - def metadata_provider_get_by(self, provider, db=None, cur=None): - result = db.metadata_provider_get_by( - provider["provider_name"], provider["provider_url"] - ) - if not result: + def metadata_authority_get( + self, type: str, url: str, db=None, cur=None + ) -> Optional[Dict[str, Any]]: + row = db.metadata_authority_get(type, url, cur=cur) + if not row: return None - return dict(zip(db.metadata_provider_cols, result)) + return dict(zip(db.metadata_authority_cols, row)) @timed def diff_directories(self, from_dir, to_dir, track_renaming=False): return diff.diff_directories(self, from_dir, to_dir, track_renaming) @timed def diff_revisions(self, from_rev, to_rev, track_renaming=False): return diff.diff_revisions(self, from_rev, to_rev, track_renaming) @timed def diff_revision(self, revision, track_renaming=False): return diff.diff_revision(self, revision, track_renaming) def clear_buffers(self, object_types: Optional[Iterable[str]] = None) -> None: """Do nothing """ return None def flush(self, object_types: Optional[Iterable[str]] = None) -> Dict: return {} diff --git a/swh/storage/tests/conftest.py b/swh/storage/tests/conftest.py index 6e095d13..4bc8abb0 100644 --- a/swh/storage/tests/conftest.py +++ b/swh/storage/tests/conftest.py @@ -1,252 +1,252 @@ # 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 glob import pytest from typing import Union from pytest_postgresql import factories from pytest_postgresql.janitor import DatabaseJanitor, psycopg2, Version from os import path, environ from hypothesis import settings from typing import Dict import swh.storage from swh.core.utils import numfile_sortkey as sortkey from swh.model.tests.generate_testdata import gen_contents, gen_origins from swh.model.model import ( Content, Directory, Origin, OriginVisit, Release, Revision, SkippedContent, Snapshot, ) OBJECT_FACTORY = { "content": Content.from_dict, "directory": Directory.from_dict, "origin": Origin.from_dict, "origin_visit": OriginVisit.from_dict, "release": Release.from_dict, "revision": Revision.from_dict, "skipped_content": SkippedContent.from_dict, "snapshot": Snapshot.from_dict, } SQL_DIR = path.join(path.dirname(swh.storage.__file__), "sql") environ["LC_ALL"] = "C.UTF-8" DUMP_FILES = path.join(SQL_DIR, "*.sql") # define tests profile. Full documentation is at: # https://hypothesis.readthedocs.io/en/latest/settings.html#settings-profiles settings.register_profile("fast", max_examples=5, deadline=5000) settings.register_profile("slow", max_examples=20, deadline=5000) @pytest.fixture def swh_storage_backend_config(postgresql_proc, swh_storage_postgresql): yield { "cls": "local", "db": "postgresql://{user}@{host}:{port}/{dbname}".format( host=postgresql_proc.host, port=postgresql_proc.port, user="postgres", dbname="tests", ), "objstorage": {"cls": "memory", "args": {}}, "journal_writer": {"cls": "memory",}, } @pytest.fixture def swh_storage(swh_storage_backend_config): return swh.storage.get_storage(cls="validate", storage=swh_storage_backend_config) @pytest.fixture def swh_contents(swh_storage): contents = gen_contents(n=20) swh_storage.content_add([c for c in contents if c["status"] != "absent"]) swh_storage.skipped_content_add([c for c in contents if c["status"] == "absent"]) return contents @pytest.fixture def swh_origins(swh_storage): origins = gen_origins(n=100) swh_storage.origin_add(origins) return origins # the postgres_fact factory fixture below is mostly a copy of the code # from pytest-postgresql. We need a custom version here to be able to # specify our version of the DBJanitor we use. def postgresql_fact(process_fixture_name, db_name=None, dump_files=DUMP_FILES): @pytest.fixture def postgresql_factory(request): """ Fixture factory for PostgreSQL. :param FixtureRequest request: fixture request object :rtype: psycopg2.connection :returns: postgresql client """ config = factories.get_config(request) if not psycopg2: raise ImportError("No module named psycopg2. Please install it.") proc_fixture = request.getfixturevalue(process_fixture_name) # _, config = try_import('psycopg2', request) pg_host = proc_fixture.host pg_port = proc_fixture.port pg_user = proc_fixture.user pg_options = proc_fixture.options pg_db = db_name or config["dbname"] with SwhDatabaseJanitor( pg_user, pg_host, pg_port, pg_db, proc_fixture.version, dump_files=dump_files, ): connection = psycopg2.connect( dbname=pg_db, user=pg_user, host=pg_host, port=pg_port, options=pg_options, ) yield connection connection.close() return postgresql_factory swh_storage_postgresql = postgresql_fact("postgresql_proc") # This version of the DatabaseJanitor implement a different setup/teardown # behavior than than the stock one: instead of dropping, creating and # initializing the database for each test, it create and initialize the db only # once, then it truncate the tables. This is needed to have acceptable test # performances. class SwhDatabaseJanitor(DatabaseJanitor): def __init__( self, user: str, host: str, port: str, db_name: str, version: Union[str, float, Version], dump_files: str = DUMP_FILES, ) -> None: super().__init__(user, host, port, db_name, version) self.dump_files = sorted(glob.glob(dump_files), key=sortkey) def db_setup(self): with psycopg2.connect( dbname=self.db_name, user=self.user, host=self.host, port=self.port, ) as cnx: with cnx.cursor() as cur: for fname in self.dump_files: with open(fname) as fobj: sql = fobj.read().replace("concurrently", "").strip() if sql: cur.execute(sql) cnx.commit() def db_reset(self): with psycopg2.connect( dbname=self.db_name, user=self.user, host=self.host, port=self.port, ) as cnx: with cnx.cursor() as cur: cur.execute( "SELECT table_name FROM information_schema.tables " "WHERE table_schema = %s", ("public",), ) tables = set(table for (table,) in cur.fetchall()) for table in tables: cur.execute("truncate table %s cascade" % table) cur.execute( "SELECT sequence_name FROM information_schema.sequences " "WHERE sequence_schema = %s", ("public",), ) seqs = set(seq for (seq,) in cur.fetchall()) for seq in seqs: cur.execute("ALTER SEQUENCE %s RESTART;" % seq) cnx.commit() def init(self): with self.cursor() as cur: cur.execute( "SELECT COUNT(1) FROM pg_database WHERE datname=%s;", (self.db_name,) ) db_exists = cur.fetchone()[0] == 1 if db_exists: cur.execute( "UPDATE pg_database SET datallowconn=true " "WHERE datname = %s;", (self.db_name,), ) if db_exists: self.db_reset() else: with self.cursor() as cur: cur.execute('CREATE DATABASE "{}";'.format(self.db_name)) self.db_setup() def drop(self): pid_column = "pid" with self.cursor() as cur: cur.execute( "UPDATE pg_database SET datallowconn=false " "WHERE datname = %s;", (self.db_name,), ) cur.execute( "SELECT pg_terminate_backend(pg_stat_activity.{})" "FROM pg_stat_activity " "WHERE pg_stat_activity.datname = %s;".format(pid_column), (self.db_name,), ) @pytest.fixture def sample_data() -> Dict: """Pre-defined sample storage object data to manipulate Returns: Dict of data (keys: content, directory, revision, release, person, origin) """ from .storage_data import data return { "content": [data.cont, data.cont2], "content_metadata": [data.cont3], "skipped_content": [data.skipped_cont, data.skipped_cont2], "person": [data.person], "directory": [data.dir2, data.dir], "revision": [data.revision, data.revision2, data.revision3], "release": [data.release, data.release2, data.release3], "snapshot": [data.snapshot], "origin": [data.origin, data.origin2], - "tool": [data.metadata_tool], - "provider": [data.provider], + "fetcher": [data.metadata_fetcher], + "authority": [data.metadata_authority], "origin_metadata": [data.origin_metadata, data.origin_metadata2], } diff --git a/swh/storage/tests/storage_data.py b/swh/storage/tests/storage_data.py index 0a1b3135..a3174ea9 100644 --- a/swh/storage/tests/storage_data.py +++ b/swh/storage/tests/storage_data.py @@ -1,481 +1,520 @@ # Copyright (C) 2015-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 datetime from swh.model.hashutil import hash_to_bytes from swh.model import from_disk class StorageData: def __getattr__(self, key): try: v = globals()[key] except KeyError as e: raise AttributeError(e.args[0]) if hasattr(v, "copy"): return v.copy() return v data = StorageData() cont = { "data": b"42\n", "length": 3, "sha1": hash_to_bytes("34973274ccef6ab4dfaaf86599792fa9c3fe4689"), "sha1_git": hash_to_bytes("d81cc0710eb6cf9efd5b920a8453e1e07157b6cd"), "sha256": hash_to_bytes( "673650f936cb3b0a2f93ce09d81be10748b1b203c19e8176b4eefc1964a0cf3a" ), "blake2s256": hash_to_bytes( "d5fe1939576527e42cfd76a9455a2432fe7f56669564577dd93c4280e76d661d" ), "status": "visible", } cont2 = { "data": b"4242\n", "length": 5, "sha1": hash_to_bytes("61c2b3a30496d329e21af70dd2d7e097046d07b7"), "sha1_git": hash_to_bytes("36fade77193cb6d2bd826161a0979d64c28ab4fa"), "sha256": hash_to_bytes( "859f0b154fdb2d630f45e1ecae4a862915435e663248bb8461d914696fc047cd" ), "blake2s256": hash_to_bytes( "849c20fad132b7c2d62c15de310adfe87be94a379941bed295e8141c6219810d" ), "status": "visible", } cont3 = { "data": b"424242\n", "length": 7, "sha1": hash_to_bytes("3e21cc4942a4234c9e5edd8a9cacd1670fe59f13"), "sha1_git": hash_to_bytes("c932c7649c6dfa4b82327d121215116909eb3bea"), "sha256": hash_to_bytes( "92fb72daf8c6818288a35137b72155f507e5de8d892712ab96277aaed8cf8a36" ), "blake2s256": hash_to_bytes( "76d0346f44e5a27f6bafdd9c2befd304aff83780f93121d801ab6a1d4769db11" ), "status": "visible", "ctime": "2019-12-01 00:00:00Z", } contents = (cont, cont2, cont3) missing_cont = { "data": b"missing\n", "length": 8, "sha1": hash_to_bytes("f9c24e2abb82063a3ba2c44efd2d3c797f28ac90"), "sha1_git": hash_to_bytes("33e45d56f88993aae6a0198013efa80716fd8919"), "sha256": hash_to_bytes( "6bbd052ab054ef222c1c87be60cd191addedd24cc882d1f5f7f7be61dc61bb3a" ), "blake2s256": hash_to_bytes( "306856b8fd879edb7b6f1aeaaf8db9bbecc993cd7f776c333ac3a782fa5c6eba" ), "status": "absent", } skipped_cont = { "length": 1024 * 1024 * 200, "sha1_git": hash_to_bytes("33e45d56f88993aae6a0198013efa80716fd8920"), "sha1": hash_to_bytes("43e45d56f88993aae6a0198013efa80716fd8920"), "sha256": hash_to_bytes( "7bbd052ab054ef222c1c87be60cd191addedd24cc882d1f5f7f7be61dc61bb3a" ), "blake2s256": hash_to_bytes( "ade18b1adecb33f891ca36664da676e12c772cc193778aac9a137b8dc5834b9b" ), "reason": "Content too long", "status": "absent", "origin": "file:///dev/zero", } skipped_cont2 = { "length": 1024 * 1024 * 300, "sha1_git": hash_to_bytes("44e45d56f88993aae6a0198013efa80716fd8921"), "sha1": hash_to_bytes("54e45d56f88993aae6a0198013efa80716fd8920"), "sha256": hash_to_bytes( "8cbd052ab054ef222c1c87be60cd191addedd24cc882d1f5f7f7be61dc61bb3a" ), "blake2s256": hash_to_bytes( "9ce18b1adecb33f891ca36664da676e12c772cc193778aac9a137b8dc5834b9b" ), "reason": "Content too long", "status": "absent", } dir = { "id": hash_to_bytes("340133423253310030f531e632a733ff37c3a930"), "entries": [ { "name": b"foo", "type": "file", "target": hash_to_bytes("d81cc0710eb6cf9efd5b920a8453e1e07157b6cd"), # cont "perms": from_disk.DentryPerms.content, }, { "name": b"bar\xc3", "type": "dir", "target": b"12345678901234567890", "perms": from_disk.DentryPerms.directory, }, ], } dir2 = { "id": hash_to_bytes("340133423253310030f531e632a733ff37c3a935"), "entries": [ { "name": b"oof", "type": "file", "target": hash_to_bytes( # cont2 "36fade77193cb6d2bd826161a0979d64c28ab4fa" ), "perms": from_disk.DentryPerms.content, } ], } dir3 = { "id": hash_to_bytes("33e45d56f88993aae6a0198013efa80716fd8921"), "entries": [ { "name": b"foo", "type": "file", "target": hash_to_bytes("d81cc0710eb6cf9efd5b920a8453e1e07157b6cd"), # cont "perms": from_disk.DentryPerms.content, }, { "name": b"subdir", "type": "dir", "target": hash_to_bytes("340133423253310030f531e632a733ff37c3a930"), # dir "perms": from_disk.DentryPerms.directory, }, { "name": b"hello", "type": "file", "target": b"12345678901234567890", "perms": from_disk.DentryPerms.content, }, ], } dir4 = { "id": hash_to_bytes("33e45d56f88993aae6a0198013efa80716fd8922"), "entries": [ { "name": b"subdir1", "type": "dir", "target": hash_to_bytes("33e45d56f88993aae6a0198013efa80716fd8921"), # dir3 "perms": from_disk.DentryPerms.directory, }, ], } dierctories = (dir, dir2, dir3, dir4) minus_offset = datetime.timezone(datetime.timedelta(minutes=-120)) plus_offset = datetime.timezone(datetime.timedelta(minutes=120)) revision = { "id": b"56789012345678901234", "message": b"hello", "author": { "name": b"Nicolas Dandrimont", "email": b"nicolas@example.com", "fullname": b"Nicolas Dandrimont ", }, "date": { "timestamp": {"seconds": 1234567890, "microseconds": 0}, "offset": 120, "negative_utc": False, }, "committer": { "name": b"St\xc3fano Zacchiroli", "email": b"stefano@example.com", "fullname": b"St\xc3fano Zacchiroli ", }, "committer_date": { "timestamp": {"seconds": 1123456789, "microseconds": 0}, "offset": 0, "negative_utc": True, }, "parents": [b"01234567890123456789", b"23434512345123456789"], "type": "git", "directory": hash_to_bytes("340133423253310030f531e632a733ff37c3a930"), # dir "metadata": { "checksums": {"sha1": "tarball-sha1", "sha256": "tarball-sha256",}, "signed-off-by": "some-dude", "extra_headers": [ ["gpgsig", b"test123"], ["mergetags", [b"foo\\bar", b"\x22\xaf\x89\x80\x01\x00"]], ], }, "synthetic": True, } revision2 = { "id": b"87659012345678904321", "message": b"hello again", "author": { "name": b"Roberto Dicosmo", "email": b"roberto@example.com", "fullname": b"Roberto Dicosmo ", }, "date": { "timestamp": {"seconds": 1234567843, "microseconds": 220000,}, "offset": -720, "negative_utc": False, }, "committer": { "name": b"tony", "email": b"ar@dumont.fr", "fullname": b"tony ", }, "committer_date": { "timestamp": {"seconds": 1123456789, "microseconds": 0}, "offset": 0, "negative_utc": False, }, "parents": [b"01234567890123456789"], "type": "git", "directory": hash_to_bytes("340133423253310030f531e632a733ff37c3a935"), # dir2 "metadata": None, "synthetic": False, } revision3 = { "id": hash_to_bytes("7026b7c1a2af56521e951c01ed20f255fa054238"), "message": b"a simple revision with no parents this time", "author": { "name": b"Roberto Dicosmo", "email": b"roberto@example.com", "fullname": b"Roberto Dicosmo ", }, "date": { "timestamp": {"seconds": 1234567843, "microseconds": 220000,}, "offset": -720, "negative_utc": False, }, "committer": { "name": b"tony", "email": b"ar@dumont.fr", "fullname": b"tony ", }, "committer_date": { "timestamp": {"seconds": 1127351742, "microseconds": 0}, "offset": 0, "negative_utc": False, }, "parents": [], "type": "git", "directory": hash_to_bytes("340133423253310030f531e632a733ff37c3a935"), # dir2 "metadata": None, "synthetic": True, } revision4 = { "id": hash_to_bytes("368a48fe15b7db2383775f97c6b247011b3f14f4"), "message": b"parent of self.revision2", "author": { "name": b"me", "email": b"me@soft.heri", "fullname": b"me ", }, "date": { "timestamp": {"seconds": 1244567843, "microseconds": 220000,}, "offset": -720, "negative_utc": False, }, "committer": { "name": b"committer-dude", "email": b"committer@dude.com", "fullname": b"committer-dude ", }, "committer_date": { "timestamp": {"seconds": 1244567843, "microseconds": 220000,}, "offset": -720, "negative_utc": False, }, "parents": [hash_to_bytes("7026b7c1a2af56521e951c01ed20f255fa054238")], # revision3 "type": "git", "directory": hash_to_bytes("340133423253310030f531e632a733ff37c3a930"), # dir "metadata": None, "synthetic": False, } revisions = (revision, revision2, revision3, revision4) origin = { "url": "file:///dev/null", } origin2 = { "url": "file:///dev/zero", } origins = (origin, origin2) -provider = { - "name": "hal", - "type": "deposit-client", - "url": "http:///hal/inria", +metadata_authority = { + "type": "deposit", + "url": "http://hal.inria.example.com/", "metadata": {"location": "France"}, } +metadata_authority2 = { + "type": "registry", + "url": "http://wikidata.example.com/", + "metadata": {}, +} -metadata_tool = { +metadata_fetcher = { "name": "swh-deposit", "version": "0.0.1", - "configuration": {"sword_version": "2"}, + "metadata": {"sword_version": "2"}, +} +metadata_fetcher2 = { + "name": "swh-example", + "version": "0.0.1", + "metadata": {}, } date_visit1 = datetime.datetime(2015, 1, 1, 23, 0, 0, tzinfo=datetime.timezone.utc) type_visit1 = "git" date_visit2 = datetime.datetime(2017, 1, 1, 23, 0, 0, tzinfo=datetime.timezone.utc) type_visit2 = "hg" date_visit3 = datetime.datetime(2018, 1, 1, 23, 0, 0, tzinfo=datetime.timezone.utc) type_visit3 = "deb" release = { "id": b"87659012345678901234", "name": b"v0.0.1", "author": { "name": b"olasd", "email": b"nic@olasd.fr", "fullname": b"olasd ", }, "date": { "timestamp": {"seconds": 1234567890, "microseconds": 0}, "offset": 42, "negative_utc": False, }, "target": b"43210987654321098765", "target_type": "revision", "message": b"synthetic release", "synthetic": True, } release2 = { "id": b"56789012348765901234", "name": b"v0.0.2", "author": { "name": b"tony", "email": b"ar@dumont.fr", "fullname": b"tony ", }, "date": { "timestamp": {"seconds": 1634366813, "microseconds": 0}, "offset": -120, "negative_utc": False, }, "target": b"432109\xa9765432\xc309\x00765", "target_type": "revision", "message": b"v0.0.2\nMisc performance improvements + bug fixes", "synthetic": False, } release3 = { "id": b"87659012345678904321", "name": b"v0.0.2", "author": { "name": b"tony", "email": b"tony@ardumont.fr", "fullname": b"tony ", }, "date": { "timestamp": {"seconds": 1634336813, "microseconds": 0}, "offset": 0, "negative_utc": False, }, "target": b"87659012345678904321", # revision2 "target_type": "revision", "message": b"yet another synthetic release", "synthetic": True, } releases = (release, release2, release3) snapshot = { "id": hash_to_bytes("2498dbf535f882bc7f9a18fb16c9ad27fda7bab7"), "branches": { b"master": { "target": b"56789012345678901234", # revision "target_type": "revision", }, }, } empty_snapshot = { "id": hash_to_bytes("1a8893e6a86f444e8be8e7bda6cb34fb1735a00e"), "branches": {}, } complete_snapshot = { "id": hash_to_bytes("6e65b86363953b780d92b0a928f3e8fcdd10db36"), "branches": { b"directory": { "target": hash_to_bytes("1bd0e65f7d2ff14ae994de17a1e7fe65111dcad8"), "target_type": "directory", }, b"directory2": { "target": hash_to_bytes("1bd0e65f7d2ff14ae994de17a1e7fe65111dcad8"), "target_type": "directory", }, b"content": { "target": hash_to_bytes("fe95a46679d128ff167b7c55df5d02356c5a1ae1"), "target_type": "content", }, b"alias": {"target": b"revision", "target_type": "alias",}, b"revision": { "target": hash_to_bytes("aafb16d69fd30ff58afdd69036a26047f3aebdc6"), "target_type": "revision", }, b"release": { "target": hash_to_bytes("7045404f3d1c54e6473c71bbb716529fbad4be24"), "target_type": "release", }, b"snapshot": { "target": hash_to_bytes("1a8893e6a86f444e8be8e7bda6cb34fb1735a00e"), "target_type": "snapshot", }, b"dangling": None, }, } origin_metadata = { - "origin": origin, + "origin_url": origin["url"], "discovery_date": datetime.datetime( 2015, 1, 1, 23, 0, 0, tzinfo=datetime.timezone.utc ), - "provider": provider, - "tool": "swh-deposit", - "metadata": {"name": "test_origin_metadata", "version": "0.0.1"}, + "authority": { + "type": metadata_authority["type"], + "url": metadata_authority["url"], + }, + "fetcher": { + "name": metadata_fetcher["name"], + "version": metadata_fetcher["version"], + }, + "format": "json", + "metadata": b'{"foo": "bar"}', } origin_metadata2 = { - "origin": origin, + "origin_url": origin["url"], "discovery_date": datetime.datetime( 2017, 1, 1, 23, 0, 0, tzinfo=datetime.timezone.utc ), - "provider": provider, - "tool": "swh-deposit", - "metadata": {"name": "test_origin_metadata", "version": "0.0.1"}, + "authority": { + "type": metadata_authority["type"], + "url": metadata_authority["url"], + }, + "fetcher": { + "name": metadata_fetcher["name"], + "version": metadata_fetcher["version"], + }, + "format": "yaml", + "metadata": b"foo: bar", +} +origin_metadata3 = { + "origin_url": origin["url"], + "discovery_date": datetime.datetime( + 2017, 1, 1, 23, 0, 0, tzinfo=datetime.timezone.utc + ), + "authority": { + "type": metadata_authority2["type"], + "url": metadata_authority2["url"], + }, + "fetcher": { + "name": metadata_fetcher2["name"], + "version": metadata_fetcher2["version"], + }, + "format": "yaml", + "metadata": b"foo: bar", } person = { "name": b"John Doe", "email": b"john.doe@institute.org", "fullname": b"John Doe ", } diff --git a/swh/storage/tests/test_cassandra.py b/swh/storage/tests/test_cassandra.py index fb541288..181af743 100644 --- a/swh/storage/tests/test_cassandra.py +++ b/swh/storage/tests/test_cassandra.py @@ -1,419 +1,391 @@ # 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 from collections import namedtuple import datetime import os import signal import socket import subprocess import time import pytest from swh.storage import get_storage from swh.storage.cassandra import create_keyspace from swh.storage.cassandra.schema import TABLES, HASH_ALGORITHMS from swh.storage.tests.test_storage import TestStorage as _TestStorage from swh.storage.tests.test_storage import ( TestStorageGeneratedData as _TestStorageGeneratedData, ) from .storage_data import data CONFIG_TEMPLATE = """ data_file_directories: - {data_dir}/data commitlog_directory: {data_dir}/commitlog hints_directory: {data_dir}/hints saved_caches_directory: {data_dir}/saved_caches commitlog_sync: periodic commitlog_sync_period_in_ms: 1000000 partitioner: org.apache.cassandra.dht.Murmur3Partitioner endpoint_snitch: SimpleSnitch seed_provider: - class_name: org.apache.cassandra.locator.SimpleSeedProvider parameters: - seeds: "127.0.0.1" storage_port: {storage_port} native_transport_port: {native_transport_port} start_native_transport: true listen_address: 127.0.0.1 enable_user_defined_functions: true # speed-up by disabling period saving to disk key_cache_save_period: 0 row_cache_save_period: 0 trickle_fsync: false commitlog_sync_period_in_ms: 100000 """ def free_port(): sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) sock.bind(("127.0.0.1", 0)) port = sock.getsockname()[1] sock.close() return port def wait_for_peer(addr, port): wait_until = time.time() + 20 while time.time() < wait_until: try: sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) sock.connect((addr, port)) except ConnectionRefusedError: time.sleep(0.1) else: sock.close() return True return False @pytest.fixture(scope="session") def cassandra_cluster(tmpdir_factory): cassandra_conf = tmpdir_factory.mktemp("cassandra_conf") cassandra_data = tmpdir_factory.mktemp("cassandra_data") cassandra_log = tmpdir_factory.mktemp("cassandra_log") native_transport_port = free_port() storage_port = free_port() jmx_port = free_port() with open(str(cassandra_conf.join("cassandra.yaml")), "w") as fd: fd.write( CONFIG_TEMPLATE.format( data_dir=str(cassandra_data), storage_port=storage_port, native_transport_port=native_transport_port, ) ) if os.environ.get("LOG_CASSANDRA"): stdout = stderr = None else: stdout = stderr = subprocess.DEVNULL proc = subprocess.Popen( [ "/usr/sbin/cassandra", "-Dcassandra.config=file://%s/cassandra.yaml" % cassandra_conf, "-Dcassandra.logdir=%s" % cassandra_log, "-Dcassandra.jmx.local.port=%d" % jmx_port, "-Dcassandra-foreground=yes", ], start_new_session=True, env={ "MAX_HEAP_SIZE": "300M", "HEAP_NEWSIZE": "50M", "JVM_OPTS": "-Xlog:gc=error:file=%s/gc.log" % cassandra_log, }, stdout=stdout, stderr=stderr, ) running = wait_for_peer("127.0.0.1", native_transport_port) if running: yield (["127.0.0.1"], native_transport_port) if not running or os.environ.get("LOG_CASSANDRA"): with open(str(cassandra_log.join("debug.log"))) as fd: print(fd.read()) if not running: raise Exception("cassandra process stopped unexpectedly.") pgrp = os.getpgid(proc.pid) os.killpg(pgrp, signal.SIGKILL) class RequestHandler: def on_request(self, rf): if hasattr(rf.message, "query"): print() print(rf.message.query) @pytest.fixture(scope="session") def keyspace(cassandra_cluster): (hosts, port) = cassandra_cluster keyspace = os.urandom(10).hex() create_keyspace(hosts, keyspace, port) return keyspace # tests are executed using imported classes (TestStorage and # TestStorageGeneratedData) using overloaded swh_storage fixture # below @pytest.fixture def swh_storage_backend_config(cassandra_cluster, keyspace): (hosts, port) = cassandra_cluster storage_config = dict( cls="cassandra", hosts=hosts, port=port, keyspace=keyspace, journal_writer={"cls": "memory",}, objstorage={"cls": "memory", "args": {},}, ) yield storage_config storage = get_storage(**storage_config) for table in TABLES: storage._cql_runner._session.execute('TRUNCATE TABLE "%s"' % table) storage._cql_runner._cluster.shutdown() @pytest.mark.cassandra class TestCassandraStorage(_TestStorage): def test_content_add_murmur3_collision(self, swh_storage, mocker): """The Murmur3 token is used as link from index tables to the main table; and non-matching contents with colliding murmur3-hash are filtered-out when reading the main table. This test checks the content methods do filter out these collision. """ called = 0 # always return a token def mock_cgtfsh(algo, hash_): nonlocal called called += 1 assert algo in ("sha1", "sha1_git") return [123456] mocker.patch.object( swh_storage.storage._cql_runner, "content_get_tokens_from_single_hash", mock_cgtfsh, ) # For all tokens, always return data.cont Row = namedtuple("Row", HASH_ALGORITHMS) def mock_cgft(token): nonlocal called called += 1 return [Row(**{algo: data.cont[algo] for algo in HASH_ALGORITHMS})] mocker.patch.object( swh_storage.storage._cql_runner, "content_get_from_token", mock_cgft ) actual_result = swh_storage.content_add([data.cont2]) assert called == 4 assert actual_result == { "content:add": 1, "content:add:bytes": data.cont2["length"], } def test_content_get_metadata_murmur3_collision(self, swh_storage, mocker): """The Murmur3 token is used as link from index tables to the main table; and non-matching contents with colliding murmur3-hash are filtered-out when reading the main table. This test checks the content methods do filter out these collision. """ called = 0 # always return a token def mock_cgtfsh(algo, hash_): nonlocal called called += 1 assert algo in ("sha1", "sha1_git") return [123456] mocker.patch.object( swh_storage.storage._cql_runner, "content_get_tokens_from_single_hash", mock_cgtfsh, ) # For all tokens, always return data.cont and data.cont2 cols = list(set(data.cont) - {"data"}) Row = namedtuple("Row", cols + ["ctime"]) def mock_cgft(token): nonlocal called called += 1 return [ Row(ctime=42, **{col: cont[col] for col in cols}) for cont in [data.cont, data.cont2] ] mocker.patch.object( swh_storage.storage._cql_runner, "content_get_from_token", mock_cgft ) expected_cont = data.cont.copy() del expected_cont["data"] actual_result = swh_storage.content_get_metadata([data.cont["sha1"]]) assert called == 2 # but data.cont2 should be filtered out assert actual_result == {data.cont["sha1"]: [expected_cont]} def test_content_find_murmur3_collision(self, swh_storage, mocker): """The Murmur3 token is used as link from index tables to the main table; and non-matching contents with colliding murmur3-hash are filtered-out when reading the main table. This test checks the content methods do filter out these collision. """ called = 0 # always return a token def mock_cgtfsh(algo, hash_): nonlocal called called += 1 assert algo in ("sha1", "sha1_git") return [123456] mocker.patch.object( swh_storage.storage._cql_runner, "content_get_tokens_from_single_hash", mock_cgtfsh, ) # For all tokens, always return data.cont and data.cont2 cols = list(set(data.cont) - {"data"}) Row = namedtuple("Row", cols + ["ctime"]) def mock_cgft(token): nonlocal called called += 1 return [ Row(ctime=datetime.datetime.now(), **{col: cont[col] for col in cols}) for cont in [data.cont, data.cont2] ] mocker.patch.object( swh_storage.storage._cql_runner, "content_get_from_token", mock_cgft ) expected_cont = data.cont.copy() del expected_cont["data"] actual_result = swh_storage.content_find({"sha1": data.cont["sha1"]}) assert called == 2 # but data.cont2 should be filtered out del actual_result[0]["ctime"] assert actual_result == [expected_cont] @pytest.mark.skip("content_update is not yet implemented for Cassandra") def test_content_update(self): pass @pytest.mark.skip( 'The "person" table of the pgsql is a legacy thing, and not ' "supported by the cassandra backend." ) def test_person_fullname_unicity(self): pass @pytest.mark.skip( 'The "person" table of the pgsql is a legacy thing, and not ' "supported by the cassandra backend." ) def test_person_get(self): pass - @pytest.mark.skip("Not yet implemented") - def test_metadata_provider_add(self): - pass - - @pytest.mark.skip("Not yet implemented") - def test_metadata_provider_add_idempotent(self): - pass - - @pytest.mark.skip("Not yet implemented") - def test_metadata_provider_get(self): - pass - - @pytest.mark.skip("Not yet implemented") - def test_metadata_provider_get_by(self): - pass - - @pytest.mark.skip("Not yet implemented") - def test_origin_metadata_add(self): - pass - - @pytest.mark.skip("Not yet implemented") - def test_origin_metadata_get(self): - pass - - @pytest.mark.skip("Not yet implemented") - def test_origin_metadata_get_by_provider_type(self): - pass - @pytest.mark.skip("Not supported by Cassandra") def test_origin_count(self): pass @pytest.mark.cassandra class TestCassandraStorageGeneratedData(_TestStorageGeneratedData): @pytest.mark.skip("Not supported by Cassandra") def test_origin_count(self): pass @pytest.mark.skip("Not supported by Cassandra") def test_origin_get_range(self): pass @pytest.mark.skip("Not supported by Cassandra") def test_origin_get_range_from_zero(self): pass @pytest.mark.skip("Not supported by Cassandra") def test_generate_content_get_range_limit(self): pass @pytest.mark.skip("Not supported by Cassandra") def test_generate_content_get_range_no_limit(self): pass @pytest.mark.skip("Not supported by Cassandra") def test_generate_content_get_range(self): pass @pytest.mark.skip("Not supported by Cassandra") def test_generate_content_get_range_empty(self): pass @pytest.mark.skip("Not supported by Cassandra") def test_generate_content_get_range_limit_none(self): pass @pytest.mark.skip("Not supported by Cassandra") def test_generate_content_get_range_full(self): pass @pytest.mark.skip("Not supported by Cassandra") def test_origin_count_with_visit_no_visits(self): pass @pytest.mark.skip("Not supported by Cassandra") def test_origin_count_with_visit_with_visits_and_snapshot(self): pass @pytest.mark.skip("Not supported by Cassandra") def test_origin_count_with_visit_with_visits_no_snapshot(self): pass diff --git a/swh/storage/tests/test_retry.py b/swh/storage/tests/test_retry.py index 5b3f231f..df1c94c7 100644 --- a/swh/storage/tests/test_retry.py +++ b/swh/storage/tests/test_retry.py @@ -1,1039 +1,1039 @@ # Copyright (C) 2020 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 -from typing import Dict from unittest.mock import call import psycopg2 import pytest from swh.model.model import ( Content, Directory, Release, Revision, Snapshot, SkippedContent, Origin, ) from swh.storage import get_storage from swh.storage.exc import HashCollision, StorageArgumentException from .storage_data import date_visit1 @pytest.fixture def monkeypatch_sleep(monkeypatch, swh_storage): """In test context, we don't want to wait, make test faster """ from swh.storage.retry import RetryingProxyStorage for method_name, method in RetryingProxyStorage.__dict__.items(): if "_add" in method_name or "_update" in method_name: monkeypatch.setattr(method.retry, "sleep", lambda x: None) return monkeypatch @pytest.fixture def fake_hash_collision(sample_data): return HashCollision("sha1", "38762cf7f55934b34d179ae6a4c80cadccbb7f0a", []) @pytest.fixture def swh_storage(): storage_config = { "cls": "pipeline", "steps": [{"cls": "validate"}, {"cls": "retry"}, {"cls": "memory"},], } return get_storage(**storage_config) def test_retrying_proxy_storage_content_add(swh_storage, sample_data): """Standard content_add works as before """ sample_content = sample_data["content"][0] content = next(swh_storage.content_get([sample_content["sha1"]])) assert not content s = swh_storage.content_add([sample_content]) assert s == { "content:add": 1, "content:add:bytes": sample_content["length"], } content = next(swh_storage.content_get([sample_content["sha1"]])) assert content["sha1"] == sample_content["sha1"] def test_retrying_proxy_storage_content_add_with_retry( monkeypatch_sleep, swh_storage, sample_data, mocker, fake_hash_collision, ): """Multiple retries for hash collision and psycopg2 error but finally ok """ mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.content_add") mock_memory.side_effect = [ # first try goes ko fake_hash_collision, # second try goes ko psycopg2.IntegrityError("content already inserted"), # ok then! {"content:add": 1}, ] sample_content = sample_data["content"][0] content = next(swh_storage.content_get([sample_content["sha1"]])) assert not content s = swh_storage.content_add([sample_content]) assert s == {"content:add": 1} mock_memory.assert_has_calls( [ call([Content.from_dict(sample_content)]), call([Content.from_dict(sample_content)]), call([Content.from_dict(sample_content)]), ] ) def test_retrying_proxy_swh_storage_content_add_failure( swh_storage, sample_data, mocker ): """Unfiltered errors are raising without retry """ mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.content_add") mock_memory.side_effect = StorageArgumentException("Refuse to add content always!") sample_content = sample_data["content"][0] content = next(swh_storage.content_get([sample_content["sha1"]])) assert not content with pytest.raises(StorageArgumentException, match="Refuse to add"): swh_storage.content_add([sample_content]) assert mock_memory.call_count == 1 def test_retrying_proxy_storage_content_add_metadata(swh_storage, sample_data): """Standard content_add_metadata works as before """ sample_content = sample_data["content_metadata"][0] pk = sample_content["sha1"] content_metadata = swh_storage.content_get_metadata([pk]) assert not content_metadata[pk] s = swh_storage.content_add_metadata([sample_content]) assert s == { "content:add": 1, } content_metadata = swh_storage.content_get_metadata([pk]) assert len(content_metadata[pk]) == 1 assert content_metadata[pk][0]["sha1"] == pk def test_retrying_proxy_storage_content_add_metadata_with_retry( monkeypatch_sleep, swh_storage, sample_data, mocker, fake_hash_collision ): """Multiple retries for hash collision and psycopg2 error but finally ok """ mock_memory = mocker.patch( "swh.storage.in_memory.InMemoryStorage.content_add_metadata" ) mock_memory.side_effect = [ # first try goes ko fake_hash_collision, # second try goes ko psycopg2.IntegrityError("content_metadata already inserted"), # ok then! {"content:add": 1}, ] sample_content = sample_data["content_metadata"][0] s = swh_storage.content_add_metadata([sample_content]) assert s == {"content:add": 1} mock_memory.assert_has_calls( [ call([Content.from_dict(sample_content)]), call([Content.from_dict(sample_content)]), call([Content.from_dict(sample_content)]), ] ) def test_retrying_proxy_swh_storage_content_add_metadata_failure( swh_storage, sample_data, mocker ): """Unfiltered errors are raising without retry """ mock_memory = mocker.patch( "swh.storage.in_memory.InMemoryStorage.content_add_metadata" ) mock_memory.side_effect = StorageArgumentException( "Refuse to add content_metadata!" ) sample_content = sample_data["content_metadata"][0] pk = sample_content["sha1"] content_metadata = swh_storage.content_get_metadata([pk]) assert not content_metadata[pk] with pytest.raises(StorageArgumentException, match="Refuse to add"): swh_storage.content_add_metadata([sample_content]) assert mock_memory.call_count == 1 def test_retrying_proxy_storage_skipped_content_add(swh_storage, sample_data): """Standard skipped_content_add works as before """ sample_content = sample_data["skipped_content"][0] skipped_contents = list(swh_storage.skipped_content_missing([sample_content])) assert len(skipped_contents) == 1 s = swh_storage.skipped_content_add([sample_content]) assert s == { "skipped_content:add": 1, } skipped_content = list(swh_storage.skipped_content_missing([sample_content])) assert len(skipped_content) == 0 def test_retrying_proxy_storage_skipped_content_add_with_retry( monkeypatch_sleep, swh_storage, sample_data, mocker, fake_hash_collision ): """Multiple retries for hash collision and psycopg2 error but finally ok """ mock_memory = mocker.patch( "swh.storage.in_memory.InMemoryStorage.skipped_content_add" ) mock_memory.side_effect = [ # 1st & 2nd try goes ko fake_hash_collision, psycopg2.IntegrityError("skipped_content already inserted"), # ok then! {"skipped_content:add": 1}, ] sample_content = sample_data["skipped_content"][0] s = swh_storage.skipped_content_add([sample_content]) assert s == {"skipped_content:add": 1} mock_memory.assert_has_calls( [ call([SkippedContent.from_dict(sample_content)]), call([SkippedContent.from_dict(sample_content)]), call([SkippedContent.from_dict(sample_content)]), ] ) def test_retrying_proxy_swh_storage_skipped_content_add_failure( swh_storage, sample_data, mocker ): """Unfiltered errors are raising without retry """ mock_memory = mocker.patch( "swh.storage.in_memory.InMemoryStorage.skipped_content_add" ) mock_memory.side_effect = StorageArgumentException( "Refuse to add content_metadata!" ) sample_content = sample_data["skipped_content"][0] skipped_contents = list(swh_storage.skipped_content_missing([sample_content])) assert len(skipped_contents) == 1 with pytest.raises(StorageArgumentException, match="Refuse to add"): swh_storage.skipped_content_add([sample_content]) skipped_contents = list(swh_storage.skipped_content_missing([sample_content])) assert len(skipped_contents) == 1 assert mock_memory.call_count == 1 def test_retrying_proxy_swh_storage_origin_add_one(swh_storage, sample_data): """Standard origin_add_one works as before """ sample_origin = sample_data["origin"][0] origin = swh_storage.origin_get(sample_origin) assert not origin r = swh_storage.origin_add_one(sample_origin) assert r == sample_origin["url"] origin = swh_storage.origin_get(sample_origin) assert origin["url"] == sample_origin["url"] def test_retrying_proxy_swh_storage_origin_add_one_retry( monkeypatch_sleep, swh_storage, sample_data, mocker, fake_hash_collision ): """Multiple retries for hash collision and psycopg2 error but finally ok """ sample_origin = sample_data["origin"][1] mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.origin_add_one") mock_memory.side_effect = [ # first try goes ko fake_hash_collision, # second try goes ko psycopg2.IntegrityError("origin already inserted"), # ok then! sample_origin["url"], ] origin = swh_storage.origin_get(sample_origin) assert not origin r = swh_storage.origin_add_one(sample_origin) assert r == sample_origin["url"] mock_memory.assert_has_calls( [ call(Origin.from_dict(sample_origin)), call(Origin.from_dict(sample_origin)), call(Origin.from_dict(sample_origin)), ] ) def test_retrying_proxy_swh_storage_origin_add_one_failure( swh_storage, sample_data, mocker ): """Unfiltered errors are raising without retry """ mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.origin_add_one") mock_memory.side_effect = StorageArgumentException("Refuse to add origin always!") sample_origin = sample_data["origin"][0] origin = swh_storage.origin_get(sample_origin) assert not origin with pytest.raises(StorageArgumentException, match="Refuse to add"): swh_storage.origin_add_one(sample_origin) assert mock_memory.call_count == 1 def test_retrying_proxy_swh_storage_origin_visit_add(swh_storage, sample_data): """Standard origin_visit_add works as before """ sample_origin = sample_data["origin"][0] origin_url = swh_storage.origin_add_one(sample_origin) origin = list(swh_storage.origin_visit_get(origin_url)) assert not origin origin_visit = swh_storage.origin_visit_add(origin_url, date_visit1, "hg") assert origin_visit.origin == origin_url assert isinstance(origin_visit.visit, int) origin_visit = next(swh_storage.origin_visit_get(origin_url)) assert origin_visit["origin"] == origin_url assert isinstance(origin_visit["visit"], int) def test_retrying_proxy_swh_storage_origin_visit_add_retry( monkeypatch_sleep, swh_storage, sample_data, mocker, fake_hash_collision ): """Multiple retries for hash collision and psycopg2 error but finally ok """ sample_origin = sample_data["origin"][1] origin_url = swh_storage.origin_add_one(sample_origin) mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.origin_visit_add") mock_memory.side_effect = [ # first try goes ko fake_hash_collision, # second try goes ko psycopg2.IntegrityError("origin already inserted"), # ok then! {"origin": origin_url, "visit": 1}, ] origin = list(swh_storage.origin_visit_get(origin_url)) assert not origin r = swh_storage.origin_visit_add(origin_url, date_visit1, "git") assert r == {"origin": origin_url, "visit": 1} mock_memory.assert_has_calls( [ call(origin_url, date_visit1, "git"), call(origin_url, date_visit1, "git"), call(origin_url, date_visit1, "git"), ] ) def test_retrying_proxy_swh_storage_origin_visit_add_failure( swh_storage, sample_data, mocker ): """Unfiltered errors are raising without retry """ mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.origin_visit_add") mock_memory.side_effect = StorageArgumentException("Refuse to add origin always!") origin_url = sample_data["origin"][0]["url"] origin = list(swh_storage.origin_visit_get(origin_url)) assert not origin with pytest.raises(StorageArgumentException, match="Refuse to add"): swh_storage.origin_visit_add(origin_url, date_visit1, "svn") mock_memory.assert_has_calls( [call(origin_url, date_visit1, "svn"),] ) -def test_retrying_proxy_storage_tool_add(swh_storage, sample_data): - """Standard tool_add works as before +def test_retrying_proxy_storage_metadata_fetcher_add(swh_storage, sample_data): + """Standard metadata_fetcher_add works as before """ - sample_tool = sample_data["tool"][0] + fetcher = sample_data["fetcher"][0] - tool = swh_storage.tool_get(sample_tool) - assert not tool + metadata_fetcher = swh_storage.metadata_fetcher_get( + fetcher["name"], fetcher["version"] + ) + assert not metadata_fetcher - tools = swh_storage.tool_add([sample_tool]) - assert tools - tool = tools[0] - tool.pop("id") - assert tool == sample_tool + swh_storage.metadata_fetcher_add(**fetcher) - tool = swh_storage.tool_get(sample_tool) - tool.pop("id") - assert tool == sample_tool + actual_fetcher = swh_storage.metadata_fetcher_get( + fetcher["name"], fetcher["version"] + ) + assert actual_fetcher == fetcher -def test_retrying_proxy_storage_tool_add_with_retry( +def test_retrying_proxy_storage_metadata_fetcher_add_with_retry( monkeypatch_sleep, swh_storage, sample_data, mocker, fake_hash_collision ): """Multiple retries for hash collision and psycopg2 error but finally ok """ - sample_tool = sample_data["tool"][0] - mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.tool_add") + fetcher = sample_data["fetcher"][0] + mock_memory = mocker.patch( + "swh.storage.in_memory.InMemoryStorage.metadata_fetcher_add" + ) mock_memory.side_effect = [ # first try goes ko fake_hash_collision, # second try goes ko - psycopg2.IntegrityError("tool already inserted"), + psycopg2.IntegrityError("metadata_fetcher already inserted"), # ok then! - [sample_tool], + [fetcher], ] - tool = swh_storage.tool_get(sample_tool) - assert not tool + actual_fetcher = swh_storage.metadata_fetcher_get( + fetcher["name"], fetcher["version"] + ) + assert not actual_fetcher - tools = swh_storage.tool_add([sample_tool]) - assert tools == [sample_tool] + swh_storage.metadata_fetcher_add(**fetcher) mock_memory.assert_has_calls( - [call([sample_tool]), call([sample_tool]), call([sample_tool]),] + [ + call(fetcher["name"], fetcher["version"], fetcher["metadata"]), + call(fetcher["name"], fetcher["version"], fetcher["metadata"]), + call(fetcher["name"], fetcher["version"], fetcher["metadata"]), + ] ) -def test_retrying_proxy_swh_storage_tool_add_failure(swh_storage, sample_data, mocker): +def test_retrying_proxy_swh_storage_metadata_fetcher_add_failure( + swh_storage, sample_data, mocker +): """Unfiltered errors are raising without retry """ - mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.tool_add") - mock_memory.side_effect = StorageArgumentException("Refuse to add tool always!") + mock_memory = mocker.patch( + "swh.storage.in_memory.InMemoryStorage.metadata_fetcher_add" + ) + mock_memory.side_effect = StorageArgumentException( + "Refuse to add metadata_fetcher always!" + ) - sample_tool = sample_data["tool"][0] + fetcher = sample_data["fetcher"][0] - tool = swh_storage.tool_get(sample_tool) - assert not tool + actual_fetcher = swh_storage.metadata_fetcher_get( + fetcher["name"], fetcher["version"] + ) + assert not actual_fetcher with pytest.raises(StorageArgumentException, match="Refuse to add"): - swh_storage.tool_add([sample_tool]) + swh_storage.metadata_fetcher_add(**fetcher) assert mock_memory.call_count == 1 -def to_provider(provider: Dict) -> Dict: - return { - "provider_name": provider["name"], - "provider_url": provider["url"], - "provider_type": provider["type"], - "metadata": provider["metadata"], - } - - -def test_retrying_proxy_storage_metadata_provider_add(swh_storage, sample_data): - """Standard metadata_provider_add works as before +def test_retrying_proxy_storage_metadata_authority_add(swh_storage, sample_data): + """Standard metadata_authority_add works as before """ - provider = sample_data["provider"][0] - provider_get = to_provider(provider) + authority = sample_data["authority"][0] - provider = swh_storage.metadata_provider_get_by(provider_get) - assert not provider + assert not swh_storage.metadata_authority_get(authority["type"], authority["url"]) - provider_id = swh_storage.metadata_provider_add(**provider_get) - assert provider_id + swh_storage.metadata_authority_add(**authority) - actual_provider = swh_storage.metadata_provider_get(provider_id) - assert actual_provider - actual_provider_id = actual_provider.pop("id") - assert actual_provider_id == provider_id - assert actual_provider == provider_get + actual_authority = swh_storage.metadata_authority_get( + authority["type"], authority["url"] + ) + assert actual_authority == authority -def test_retrying_proxy_storage_metadata_provider_add_with_retry( +def test_retrying_proxy_storage_metadata_authority_add_with_retry( monkeypatch_sleep, swh_storage, sample_data, mocker, fake_hash_collision ): """Multiple retries for hash collision and psycopg2 error but finally ok """ - provider = sample_data["provider"][0] - provider_get = to_provider(provider) + authority = sample_data["authority"][0] mock_memory = mocker.patch( - "swh.storage.in_memory.InMemoryStorage.metadata_provider_add" + "swh.storage.in_memory.InMemoryStorage.metadata_authority_add" ) mock_memory.side_effect = [ # first try goes ko fake_hash_collision, # second try goes ko - psycopg2.IntegrityError("provider_id already inserted"), + psycopg2.IntegrityError("foo bar"), # ok then! - "provider_id", + None, ] - provider = swh_storage.metadata_provider_get_by(provider_get) - assert not provider + assert not swh_storage.metadata_authority_get(authority["type"], authority["url"]) - provider_id = swh_storage.metadata_provider_add(**provider_get) - assert provider_id == "provider_id" + swh_storage.metadata_authority_add(**authority) - provider_arg_names = ("provider_name", "provider_type", "provider_url", "metadata") - provider_args = [provider_get[key] for key in provider_arg_names] + authority_arg_names = ("type", "url", "metadata") + authority_args = [authority[key] for key in authority_arg_names] mock_memory.assert_has_calls( - [call(*provider_args), call(*provider_args), call(*provider_args),] + [call(*authority_args), call(*authority_args), call(*authority_args),] ) -def test_retrying_proxy_swh_storage_metadata_provider_add_failure( +def test_retrying_proxy_swh_storage_metadata_authority_add_failure( swh_storage, sample_data, mocker ): """Unfiltered errors are raising without retry """ mock_memory = mocker.patch( - "swh.storage.in_memory.InMemoryStorage.metadata_provider_add" + "swh.storage.in_memory.InMemoryStorage.metadata_authority_add" ) mock_memory.side_effect = StorageArgumentException( - "Refuse to add provider_id always!" + "Refuse to add authority_id always!" ) - provider = sample_data["provider"][0] - provider_get = to_provider(provider) + authority = sample_data["authority"][0] - provider_id = swh_storage.metadata_provider_get_by(provider_get) - assert not provider_id + swh_storage.metadata_authority_get(authority["type"], authority["url"]) with pytest.raises(StorageArgumentException, match="Refuse to add"): - swh_storage.metadata_provider_add(**provider_get) + swh_storage.metadata_authority_add(**authority) assert mock_memory.call_count == 1 def test_retrying_proxy_storage_origin_metadata_add(swh_storage, sample_data): """Standard origin_metadata_add works as before """ ori_meta = sample_data["origin_metadata"][0] - origin = ori_meta["origin"] - swh_storage.origin_add_one(origin) - provider_get = to_provider(ori_meta["provider"]) - provider_id = swh_storage.metadata_provider_add(**provider_get) + swh_storage.origin_add_one({"url": ori_meta["origin_url"]}) + swh_storage.metadata_authority_add(**sample_data["authority"][0]) + swh_storage.metadata_fetcher_add(**sample_data["fetcher"][0]) - origin_metadata = swh_storage.origin_metadata_get_by(origin["url"]) + origin_metadata = swh_storage.origin_metadata_get( + ori_meta["origin_url"], ori_meta["authority"] + ) assert not origin_metadata - swh_storage.origin_metadata_add( - origin["url"], - ori_meta["discovery_date"], - provider_id, - ori_meta["tool"], - ori_meta["metadata"], - ) + swh_storage.origin_metadata_add(**ori_meta) - origin_metadata = swh_storage.origin_metadata_get_by(origin["url"]) + origin_metadata = swh_storage.origin_metadata_get( + ori_meta["origin_url"], ori_meta["authority"] + ) assert origin_metadata def test_retrying_proxy_storage_origin_metadata_add_with_retry( monkeypatch_sleep, swh_storage, sample_data, mocker, fake_hash_collision ): """Multiple retries for hash collision and psycopg2 error but finally ok """ ori_meta = sample_data["origin_metadata"][0] - origin = ori_meta["origin"] - swh_storage.origin_add_one(origin) - provider_get = to_provider(ori_meta["provider"]) - provider_id = swh_storage.metadata_provider_add(**provider_get) + swh_storage.origin_add_one({"url": ori_meta["origin_url"]}) + swh_storage.metadata_authority_add(**sample_data["authority"][0]) + swh_storage.metadata_fetcher_add(**sample_data["fetcher"][0]) mock_memory = mocker.patch( "swh.storage.in_memory.InMemoryStorage.origin_metadata_add" ) mock_memory.side_effect = [ # first try goes ko fake_hash_collision, # second try goes ko - psycopg2.IntegrityError("provider_id already inserted"), + psycopg2.IntegrityError("foo bar"), # ok then! None, ] - url = origin["url"] - ts = ori_meta["discovery_date"] - tool_id = ori_meta["tool"] - metadata = ori_meta["metadata"] - # No exception raised as insertion finally came through - swh_storage.origin_metadata_add(url, ts, provider_id, tool_id, metadata) + swh_storage.origin_metadata_add(**ori_meta) mock_memory.assert_has_calls( [ # 3 calls, as long as error raised - call(url, ts, provider_id, tool_id, metadata), - call(url, ts, provider_id, tool_id, metadata), - call(url, ts, provider_id, tool_id, metadata), + call( + ori_meta["origin_url"], + ori_meta["discovery_date"], + ori_meta["authority"], + ori_meta["fetcher"], + ori_meta["format"], + ori_meta["metadata"], + ), + call( + ori_meta["origin_url"], + ori_meta["discovery_date"], + ori_meta["authority"], + ori_meta["fetcher"], + ori_meta["format"], + ori_meta["metadata"], + ), + call( + ori_meta["origin_url"], + ori_meta["discovery_date"], + ori_meta["authority"], + ori_meta["fetcher"], + ori_meta["format"], + ori_meta["metadata"], + ), ] ) def test_retrying_proxy_swh_storage_origin_metadata_add_failure( swh_storage, sample_data, mocker ): """Unfiltered errors are raising without retry """ mock_memory = mocker.patch( "swh.storage.in_memory.InMemoryStorage.origin_metadata_add" ) mock_memory.side_effect = StorageArgumentException("Refuse to add always!") ori_meta = sample_data["origin_metadata"][0] - origin = ori_meta["origin"] - swh_storage.origin_add_one(origin) - - url = origin["url"] - ts = ori_meta["discovery_date"] - provider_id = "provider_id" - tool_id = ori_meta["tool"] - metadata = ori_meta["metadata"] + swh_storage.origin_add_one({"url": ori_meta["origin_url"]}) with pytest.raises(StorageArgumentException, match="Refuse to add"): - swh_storage.origin_metadata_add(url, ts, provider_id, tool_id, metadata) + swh_storage.origin_metadata_add(**ori_meta) assert mock_memory.call_count == 1 def test_retrying_proxy_swh_storage_origin_visit_update(swh_storage, sample_data): """Standard origin_visit_update works as before """ sample_origin = sample_data["origin"][0] origin_url = swh_storage.origin_add_one(sample_origin) origin_visit = swh_storage.origin_visit_add(origin_url, date_visit1, "hg") ov = next(swh_storage.origin_visit_get(origin_url)) assert ov["origin"] == origin_url assert ov["visit"] == origin_visit.visit assert ov["status"] == "ongoing" assert ov["snapshot"] is None assert ov["metadata"] is None swh_storage.origin_visit_update(origin_url, origin_visit.visit, status="full") ov = next(swh_storage.origin_visit_get(origin_url)) assert ov["origin"] == origin_url assert ov["visit"] == origin_visit.visit assert ov["status"] == "full" assert ov["snapshot"] is None assert ov["metadata"] is None def test_retrying_proxy_swh_storage_origin_visit_update_retry( monkeypatch_sleep, swh_storage, sample_data, mocker, fake_hash_collision ): """Multiple retries for hash collision and psycopg2 error but finally ok """ sample_origin = sample_data["origin"][1] origin_url = sample_origin["url"] mock_memory = mocker.patch( "swh.storage.in_memory.InMemoryStorage.origin_visit_update" ) mock_memory.side_effect = [ # first try goes ko fake_hash_collision, # second try goes ko psycopg2.IntegrityError("origin already inserted"), # ok then! {"origin": origin_url, "visit": 1}, ] visit_id = 1 swh_storage.origin_visit_update(origin_url, visit_id, status="full") mock_memory.assert_has_calls( [ call(origin_url, visit_id, metadata=None, snapshot=None, status="full"), call(origin_url, visit_id, metadata=None, snapshot=None, status="full"), call(origin_url, visit_id, metadata=None, snapshot=None, status="full"), ] ) def test_retrying_proxy_swh_storage_origin_visit_update_failure( swh_storage, sample_data, mocker ): """Unfiltered errors are raising without retry """ mock_memory = mocker.patch( "swh.storage.in_memory.InMemoryStorage.origin_visit_update" ) mock_memory.side_effect = StorageArgumentException("Refuse to add origin always!") origin_url = sample_data["origin"][0]["url"] visit_id = 9 with pytest.raises(StorageArgumentException, match="Refuse to add"): swh_storage.origin_visit_update(origin_url, visit_id, "partial") assert mock_memory.call_count == 1 def test_retrying_proxy_storage_directory_add(swh_storage, sample_data): """Standard directory_add works as before """ sample_dir = sample_data["directory"][0] directory = swh_storage.directory_get_random() # no directory assert not directory s = swh_storage.directory_add([sample_dir]) assert s == { "directory:add": 1, } directory_id = swh_storage.directory_get_random() # only 1 assert directory_id == sample_dir["id"] def test_retrying_proxy_storage_directory_add_with_retry( monkeypatch_sleep, swh_storage, sample_data, mocker, fake_hash_collision ): """Multiple retries for hash collision and psycopg2 error but finally ok """ mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.directory_add") mock_memory.side_effect = [ # first try goes ko fake_hash_collision, # second try goes ko psycopg2.IntegrityError("directory already inserted"), # ok then! {"directory:add": 1}, ] sample_dir = sample_data["directory"][1] directory_id = swh_storage.directory_get_random() # no directory assert not directory_id s = swh_storage.directory_add([sample_dir]) assert s == { "directory:add": 1, } mock_memory.assert_has_calls( [ call([Directory.from_dict(sample_dir)]), call([Directory.from_dict(sample_dir)]), call([Directory.from_dict(sample_dir)]), ] ) def test_retrying_proxy_swh_storage_directory_add_failure( swh_storage, sample_data, mocker ): """Unfiltered errors are raising without retry """ mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.directory_add") mock_memory.side_effect = StorageArgumentException( "Refuse to add directory always!" ) sample_dir = sample_data["directory"][0] directory_id = swh_storage.directory_get_random() # no directory assert not directory_id with pytest.raises(StorageArgumentException, match="Refuse to add"): swh_storage.directory_add([sample_dir]) assert mock_memory.call_count == 1 def test_retrying_proxy_storage_revision_add(swh_storage, sample_data): """Standard revision_add works as before """ sample_rev = sample_data["revision"][0] revision = next(swh_storage.revision_get([sample_rev["id"]])) assert not revision s = swh_storage.revision_add([sample_rev]) assert s == { "revision:add": 1, } revision = next(swh_storage.revision_get([sample_rev["id"]])) assert revision["id"] == sample_rev["id"] def test_retrying_proxy_storage_revision_add_with_retry( monkeypatch_sleep, swh_storage, sample_data, mocker, fake_hash_collision ): """Multiple retries for hash collision and psycopg2 error but finally ok """ mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.revision_add") mock_memory.side_effect = [ # first try goes ko fake_hash_collision, # second try goes ko psycopg2.IntegrityError("revision already inserted"), # ok then! {"revision:add": 1}, ] sample_rev = sample_data["revision"][0] revision = next(swh_storage.revision_get([sample_rev["id"]])) assert not revision s = swh_storage.revision_add([sample_rev]) assert s == { "revision:add": 1, } mock_memory.assert_has_calls( [ call([Revision.from_dict(sample_rev)]), call([Revision.from_dict(sample_rev)]), call([Revision.from_dict(sample_rev)]), ] ) def test_retrying_proxy_swh_storage_revision_add_failure( swh_storage, sample_data, mocker ): """Unfiltered errors are raising without retry """ mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.revision_add") mock_memory.side_effect = StorageArgumentException("Refuse to add revision always!") sample_rev = sample_data["revision"][0] revision = next(swh_storage.revision_get([sample_rev["id"]])) assert not revision with pytest.raises(StorageArgumentException, match="Refuse to add"): swh_storage.revision_add([sample_rev]) assert mock_memory.call_count == 1 def test_retrying_proxy_storage_release_add(swh_storage, sample_data): """Standard release_add works as before """ sample_rel = sample_data["release"][0] release = next(swh_storage.release_get([sample_rel["id"]])) assert not release s = swh_storage.release_add([sample_rel]) assert s == { "release:add": 1, } release = next(swh_storage.release_get([sample_rel["id"]])) assert release["id"] == sample_rel["id"] def test_retrying_proxy_storage_release_add_with_retry( monkeypatch_sleep, swh_storage, sample_data, mocker, fake_hash_collision ): """Multiple retries for hash collision and psycopg2 error but finally ok """ mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.release_add") mock_memory.side_effect = [ # first try goes ko fake_hash_collision, # second try goes ko psycopg2.IntegrityError("release already inserted"), # ok then! {"release:add": 1}, ] sample_rel = sample_data["release"][0] release = next(swh_storage.release_get([sample_rel["id"]])) assert not release s = swh_storage.release_add([sample_rel]) assert s == { "release:add": 1, } mock_memory.assert_has_calls( [ call([Release.from_dict(sample_rel)]), call([Release.from_dict(sample_rel)]), call([Release.from_dict(sample_rel)]), ] ) def test_retrying_proxy_swh_storage_release_add_failure( swh_storage, sample_data, mocker ): """Unfiltered errors are raising without retry """ mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.release_add") mock_memory.side_effect = StorageArgumentException("Refuse to add release always!") sample_rel = sample_data["release"][0] release = next(swh_storage.release_get([sample_rel["id"]])) assert not release with pytest.raises(StorageArgumentException, match="Refuse to add"): swh_storage.release_add([sample_rel]) assert mock_memory.call_count == 1 def test_retrying_proxy_storage_snapshot_add(swh_storage, sample_data): """Standard snapshot_add works as before """ sample_snap = sample_data["snapshot"][0] snapshot = swh_storage.snapshot_get(sample_snap["id"]) assert not snapshot s = swh_storage.snapshot_add([sample_snap]) assert s == { "snapshot:add": 1, } snapshot = swh_storage.snapshot_get(sample_snap["id"]) assert snapshot["id"] == sample_snap["id"] def test_retrying_proxy_storage_snapshot_add_with_retry( monkeypatch_sleep, swh_storage, sample_data, mocker, fake_hash_collision ): """Multiple retries for hash collision and psycopg2 error but finally ok """ mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.snapshot_add") mock_memory.side_effect = [ # first try goes ko fake_hash_collision, # second try goes ko psycopg2.IntegrityError("snapshot already inserted"), # ok then! {"snapshot:add": 1}, ] sample_snap = sample_data["snapshot"][0] snapshot = swh_storage.snapshot_get(sample_snap["id"]) assert not snapshot s = swh_storage.snapshot_add([sample_snap]) assert s == { "snapshot:add": 1, } mock_memory.assert_has_calls( [ call([Snapshot.from_dict(sample_snap)]), call([Snapshot.from_dict(sample_snap)]), call([Snapshot.from_dict(sample_snap)]), ] ) def test_retrying_proxy_swh_storage_snapshot_add_failure( swh_storage, sample_data, mocker ): """Unfiltered errors are raising without retry """ mock_memory = mocker.patch("swh.storage.in_memory.InMemoryStorage.snapshot_add") mock_memory.side_effect = StorageArgumentException("Refuse to add snapshot always!") sample_snap = sample_data["snapshot"][0] snapshot = swh_storage.snapshot_get(sample_snap["id"]) assert not snapshot with pytest.raises(StorageArgumentException, match="Refuse to add"): swh_storage.snapshot_add([sample_snap]) assert mock_memory.call_count == 1 diff --git a/swh/storage/tests/test_storage.py b/swh/storage/tests/test_storage.py index 29b426b7..17a0e124 100644 --- a/swh/storage/tests/test_storage.py +++ b/swh/storage/tests/test_storage.py @@ -1,4068 +1,3793 @@ # Copyright (C) 2015-2020 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 copy from contextlib import contextmanager import datetime import inspect import itertools import math import queue import random import threading from collections import defaultdict from datetime import timedelta from unittest.mock import Mock import psycopg2 import pytest from hypothesis import given, strategies, settings, HealthCheck from typing import ClassVar, Optional from swh.model import from_disk, identifiers from swh.model.hashutil import hash_to_bytes from swh.model.model import ( Content, Directory, Origin, OriginVisit, Release, Revision, Snapshot, ) from swh.model.hypothesis_strategies import objects from swh.model.hashutil import hash_to_hex from swh.storage import get_storage from swh.storage.converters import origin_url_to_sha1 as sha1 from swh.storage.exc import HashCollision, StorageArgumentException from swh.storage.interface import StorageInterface from swh.storage.utils import content_hex_hashes from .storage_data import data @contextmanager def db_transaction(storage): with storage.db() as db: with db.transaction() as cur: yield db, cur def normalize_entity(entity): entity = copy.deepcopy(entity) for key in ("date", "committer_date"): if key in entity: entity[key] = identifiers.normalize_timestamp(entity[key]) return entity def transform_entries(dir_, *, prefix=b""): for ent in dir_["entries"]: yield { "dir_id": dir_["id"], "type": ent["type"], "target": ent["target"], "name": prefix + ent["name"], "perms": ent["perms"], "status": None, "sha1": None, "sha1_git": None, "sha256": None, "length": None, } def cmpdir(directory): return (directory["type"], directory["dir_id"]) def short_revision(revision): return [revision["id"], revision["parents"]] def assert_contents_ok( expected_contents, actual_contents, keys_to_check={"sha1", "data"} ): """Assert that a given list of contents matches on a given set of keys. """ for k in keys_to_check: expected_list = set([c.get(k) for c in expected_contents]) actual_list = set([c.get(k) for c in actual_contents]) assert actual_list == expected_list, k class LazyContent(Content): def with_data(self): return Content.from_dict({**self.to_dict(), "data": data.cont["data"]}) def now(): return datetime.datetime.now(tz=datetime.timezone.utc) class TestStorage: """Main class for Storage testing. This class is used as-is to test local storage (see TestLocalStorage below) and remote storage (see TestRemoteStorage in test_remote_storage.py. We need to have the two classes inherit from this base class separately to avoid nosetests running the tests from the base class twice. """ maxDiff = None # type: ClassVar[Optional[int]] def test_types(self, swh_storage_backend_config): """Checks all methods of StorageInterface are implemented by this backend, and that they have the same signature.""" # Create an instance of the protocol (which cannot be instantiated # directly, so this creates a subclass, then instantiates it) interface = type("_", (StorageInterface,), {})() storage = get_storage(**swh_storage_backend_config) assert "content_add" in dir(interface) missing_methods = [] for meth_name in dir(interface): if meth_name.startswith("_"): continue interface_meth = getattr(interface, meth_name) try: concrete_meth = getattr(storage, meth_name) except AttributeError: if not getattr(interface_meth, "deprecated_endpoint", False): # The backend is missing a (non-deprecated) endpoint missing_methods.append(meth_name) continue expected_signature = inspect.signature(interface_meth) actual_signature = inspect.signature(concrete_meth) assert expected_signature == actual_signature, meth_name assert missing_methods == [] def test_check_config(self, swh_storage): assert swh_storage.check_config(check_write=True) assert swh_storage.check_config(check_write=False) def test_content_add(self, swh_storage): cont = data.cont insertion_start_time = now() actual_result = swh_storage.content_add([cont]) insertion_end_time = now() assert actual_result == { "content:add": 1, "content:add:bytes": cont["length"], } assert list(swh_storage.content_get([cont["sha1"]])) == [ {"sha1": cont["sha1"], "data": cont["data"]} ] expected_cont = data.cont del expected_cont["data"] contents = [ obj for (obj_type, obj) in swh_storage.journal_writer.journal.objects if obj_type == "content" ] assert len(contents) == 1 for obj in contents: assert insertion_start_time <= obj.ctime assert obj.ctime <= insertion_end_time obj_d = obj.to_dict() del obj_d["ctime"] assert obj_d == expected_cont swh_storage.refresh_stat_counters() assert swh_storage.stat_counters()["content"] == 1 def test_content_add_from_generator(self, swh_storage): def _cnt_gen(): yield data.cont actual_result = swh_storage.content_add(_cnt_gen()) assert actual_result == { "content:add": 1, "content:add:bytes": data.cont["length"], } swh_storage.refresh_stat_counters() assert swh_storage.stat_counters()["content"] == 1 def test_content_add_from_lazy_content(self, swh_storage): lazy_content = LazyContent.from_dict({**data.cont, "data": b"nope",}) insertion_start_time = now() # bypass the validation proxy for now, to directly put a dict actual_result = swh_storage.storage.content_add([lazy_content]) insertion_end_time = now() assert actual_result == { "content:add": 1, "content:add:bytes": data.cont["length"], } # the fact that we retrieve the content object from the storage with # the correct 'data' field ensures it has been 'called' assert list(swh_storage.content_get([data.cont["sha1"]])) == [ {"sha1": data.cont["sha1"], "data": data.cont["data"]} ] expected_cont = data.cont del expected_cont["data"] contents = [ obj for (obj_type, obj) in swh_storage.journal_writer.journal.objects if obj_type == "content" ] assert len(contents) == 1 for obj in contents: assert insertion_start_time <= obj.ctime assert obj.ctime <= insertion_end_time obj_d = obj.to_dict() del obj_d["ctime"] assert obj_d == expected_cont swh_storage.refresh_stat_counters() assert swh_storage.stat_counters()["content"] == 1 def test_content_add_validation(self, swh_storage): cont = data.cont with pytest.raises(StorageArgumentException, match="status"): swh_storage.content_add([{**cont, "status": "absent"}]) with pytest.raises(StorageArgumentException, match="status"): swh_storage.content_add([{**cont, "status": "foobar"}]) with pytest.raises(StorageArgumentException, match="(?i)length"): swh_storage.content_add([{**cont, "length": -2}]) with pytest.raises(StorageArgumentException, match="reason"): swh_storage.content_add([{**cont, "reason": "foobar"}]) def test_skipped_content_add_validation(self, swh_storage): cont = data.cont.copy() del cont["data"] with pytest.raises(StorageArgumentException, match="status"): swh_storage.skipped_content_add([{**cont, "status": "visible"}]) with pytest.raises(StorageArgumentException, match="reason") as cm: swh_storage.skipped_content_add([{**cont, "status": "absent"}]) if type(cm.value) == psycopg2.IntegrityError: assert cm.exception.pgcode == psycopg2.errorcodes.NOT_NULL_VIOLATION def test_content_get_missing(self, swh_storage): cont = data.cont swh_storage.content_add([cont]) # Query a single missing content results = list(swh_storage.content_get([data.cont2["sha1"]])) assert results == [None] # Check content_get does not abort after finding a missing content results = list(swh_storage.content_get([data.cont["sha1"], data.cont2["sha1"]])) assert results == [{"sha1": cont["sha1"], "data": cont["data"]}, None] # Check content_get does not discard found countent when it finds # a missing content. results = list(swh_storage.content_get([data.cont2["sha1"], data.cont["sha1"]])) assert results == [None, {"sha1": cont["sha1"], "data": cont["data"]}] def test_content_add_different_input(self, swh_storage): cont = data.cont cont2 = data.cont2 actual_result = swh_storage.content_add([cont, cont2]) assert actual_result == { "content:add": 2, "content:add:bytes": cont["length"] + cont2["length"], } def test_content_add_twice(self, swh_storage): actual_result = swh_storage.content_add([data.cont]) assert actual_result == { "content:add": 1, "content:add:bytes": data.cont["length"], } assert len(swh_storage.journal_writer.journal.objects) == 1 actual_result = swh_storage.content_add([data.cont, data.cont2]) assert actual_result == { "content:add": 1, "content:add:bytes": data.cont2["length"], } assert 2 <= len(swh_storage.journal_writer.journal.objects) <= 3 assert len(swh_storage.content_find(data.cont)) == 1 assert len(swh_storage.content_find(data.cont2)) == 1 def test_content_add_collision(self, swh_storage): cont1 = data.cont # create (corrupted) content with same sha1{,_git} but != sha256 cont1b = cont1.copy() sha256_array = bytearray(cont1b["sha256"]) sha256_array[0] += 1 cont1b["sha256"] = bytes(sha256_array) with pytest.raises(HashCollision) as cm: swh_storage.content_add([cont1, cont1b]) exc = cm.value actual_algo = exc.algo assert actual_algo in ["sha1", "sha1_git", "blake2s256"] actual_id = exc.hash_id assert actual_id == hash_to_hex(cont1[actual_algo]) collisions = exc.args[2] assert len(collisions) == 2 assert collisions == [ content_hex_hashes(Content.from_dict(cont1).hashes()), content_hex_hashes(Content.from_dict(cont1b).hashes()), ] assert exc.colliding_content_hashes() == [ Content.from_dict(cont1).hashes(), Content.from_dict(cont1b).hashes(), ] def test_content_add_duplicate(self, swh_storage): swh_storage.content_add([data.cont, data.cont]) assert list(swh_storage.content_get([data.cont["sha1"]])) == [ {"sha1": data.cont["sha1"], "data": data.cont["data"]} ] def test_content_update(self, swh_storage): if hasattr(swh_storage, "storage"): swh_storage.journal_writer.journal = None # TODO, not supported cont = copy.deepcopy(data.cont) swh_storage.content_add([cont]) # alter the sha1_git for example cont["sha1_git"] = hash_to_bytes("3a60a5275d0333bf13468e8b3dcab90f4046e654") swh_storage.content_update([cont], keys=["sha1_git"]) results = swh_storage.content_get_metadata([cont["sha1"]]) del cont["data"] assert results == {cont["sha1"]: [cont]} def test_content_add_metadata(self, swh_storage): cont = data.cont del cont["data"] cont["ctime"] = now() actual_result = swh_storage.content_add_metadata([cont]) assert actual_result == { "content:add": 1, } expected_cont = cont.copy() del expected_cont["ctime"] assert swh_storage.content_get_metadata([cont["sha1"]]) == { cont["sha1"]: [expected_cont] } contents = [ obj for (obj_type, obj) in swh_storage.journal_writer.journal.objects if obj_type == "content" ] assert len(contents) == 1 for obj in contents: obj_d = obj.to_dict() del obj_d["ctime"] assert obj_d == expected_cont def test_content_add_metadata_different_input(self, swh_storage): cont = data.cont del cont["data"] cont["ctime"] = now() cont2 = data.cont2 del cont2["data"] cont2["ctime"] = now() actual_result = swh_storage.content_add_metadata([cont, cont2]) assert actual_result == { "content:add": 2, } def test_content_add_metadata_collision(self, swh_storage): cont1 = data.cont del cont1["data"] cont1["ctime"] = now() # create (corrupted) content with same sha1{,_git} but != sha256 cont1b = cont1.copy() sha1_git_array = bytearray(cont1b["sha256"]) sha1_git_array[0] += 1 cont1b["sha256"] = bytes(sha1_git_array) with pytest.raises(HashCollision) as cm: swh_storage.content_add_metadata([cont1, cont1b]) exc = cm.value actual_algo = exc.algo assert actual_algo in ["sha1", "sha1_git", "blake2s256"] actual_id = exc.hash_id assert actual_id == hash_to_hex(cont1[actual_algo]) collisions = exc.args[2] assert len(collisions) == 2 assert collisions == [ content_hex_hashes(Content.from_dict(cont1).hashes()), content_hex_hashes(Content.from_dict(cont1b).hashes()), ] assert exc.colliding_content_hashes() == [ Content.from_dict(cont1).hashes(), Content.from_dict(cont1b).hashes(), ] def test_skipped_content_add(self, swh_storage): cont = data.skipped_cont cont2 = data.skipped_cont2 cont2["blake2s256"] = None missing = list(swh_storage.skipped_content_missing([cont, cont2])) assert missing == [ { "sha1": cont["sha1"], "sha1_git": cont["sha1_git"], "blake2s256": cont["blake2s256"], "sha256": cont["sha256"], }, { "sha1": cont2["sha1"], "sha1_git": cont2["sha1_git"], "blake2s256": cont2["blake2s256"], "sha256": cont2["sha256"], }, ] actual_result = swh_storage.skipped_content_add([cont, cont, cont2]) assert 2 <= actual_result.pop("skipped_content:add") <= 3 assert actual_result == {} missing = list(swh_storage.skipped_content_missing([cont, cont2])) assert missing == [] def test_skipped_content_add_missing_hashes(self, swh_storage): cont = data.skipped_cont cont2 = data.skipped_cont2 cont["sha1_git"] = cont2["sha1_git"] = None missing = list(swh_storage.skipped_content_missing([cont, cont2])) assert len(missing) == 2 actual_result = swh_storage.skipped_content_add([cont, cont, cont2]) assert 2 <= actual_result.pop("skipped_content:add") <= 3 assert actual_result == {} missing = list(swh_storage.skipped_content_missing([cont, cont2])) assert missing == [] def test_skipped_content_missing_partial_hash(self, swh_storage): cont = data.skipped_cont cont2 = cont.copy() cont2["sha1_git"] = None missing = list(swh_storage.skipped_content_missing([cont, cont2])) assert len(missing) == 2 actual_result = swh_storage.skipped_content_add([cont]) assert actual_result.pop("skipped_content:add") == 1 assert actual_result == {} missing = list(swh_storage.skipped_content_missing([cont, cont2])) assert missing == [ { "sha1": cont2["sha1"], "sha1_git": cont2["sha1_git"], "blake2s256": cont2["blake2s256"], "sha256": cont2["sha256"], } ] @pytest.mark.property_based @settings(deadline=None) # this test is very slow @given( strategies.sets( elements=strategies.sampled_from(["sha256", "sha1_git", "blake2s256"]), min_size=0, ) ) def test_content_missing(self, swh_storage, algos): algos |= {"sha1"} cont2 = data.cont2 missing_cont = data.missing_cont swh_storage.content_add([cont2]) test_contents = [cont2] missing_per_hash = defaultdict(list) for i in range(256): test_content = missing_cont.copy() for hash in algos: test_content[hash] = bytes([i]) + test_content[hash][1:] missing_per_hash[hash].append(test_content[hash]) test_contents.append(test_content) assert set(swh_storage.content_missing(test_contents)) == set( missing_per_hash["sha1"] ) for hash in algos: assert set( swh_storage.content_missing(test_contents, key_hash=hash) ) == set(missing_per_hash[hash]) @pytest.mark.property_based @given( strategies.sets( elements=strategies.sampled_from(["sha256", "sha1_git", "blake2s256"]), min_size=0, ) ) def test_content_missing_unknown_algo(self, swh_storage, algos): algos |= {"sha1"} cont2 = data.cont2 missing_cont = data.missing_cont swh_storage.content_add([cont2]) test_contents = [cont2] missing_per_hash = defaultdict(list) for i in range(16): test_content = missing_cont.copy() for hash in algos: test_content[hash] = bytes([i]) + test_content[hash][1:] missing_per_hash[hash].append(test_content[hash]) test_content["nonexisting_algo"] = b"\x00" test_contents.append(test_content) assert set(swh_storage.content_missing(test_contents)) == set( missing_per_hash["sha1"] ) for hash in algos: assert set( swh_storage.content_missing(test_contents, key_hash=hash) ) == set(missing_per_hash[hash]) def test_content_missing_per_sha1(self, swh_storage): # given cont2 = data.cont2 missing_cont = data.missing_cont swh_storage.content_add([cont2]) # when gen = swh_storage.content_missing_per_sha1( [cont2["sha1"], missing_cont["sha1"]] ) # then assert list(gen) == [missing_cont["sha1"]] def test_content_missing_per_sha1_git(self, swh_storage): cont = data.cont cont2 = data.cont2 missing_cont = data.missing_cont swh_storage.content_add([cont, cont2]) contents = [cont["sha1_git"], cont2["sha1_git"], missing_cont["sha1_git"]] missing_contents = swh_storage.content_missing_per_sha1_git(contents) assert list(missing_contents) == [missing_cont["sha1_git"]] def test_content_get_partition(self, swh_storage, swh_contents): """content_get_partition paginates results if limit exceeded""" expected_contents = [c for c in swh_contents if c["status"] != "absent"] actual_contents = [] for i in range(16): actual_result = swh_storage.content_get_partition(i, 16) assert actual_result["next_page_token"] is None actual_contents.extend(actual_result["contents"]) assert_contents_ok(expected_contents, actual_contents, ["sha1"]) def test_content_get_partition_full(self, swh_storage, swh_contents): """content_get_partition for a single partition returns all available contents""" expected_contents = [c for c in swh_contents if c["status"] != "absent"] actual_result = swh_storage.content_get_partition(0, 1) assert actual_result["next_page_token"] is None actual_contents = actual_result["contents"] assert_contents_ok(expected_contents, actual_contents, ["sha1"]) def test_content_get_partition_empty(self, swh_storage, swh_contents): """content_get_partition when at least one of the partitions is empty""" expected_contents = { cont["sha1"] for cont in swh_contents if cont["status"] != "absent" } # nb_partitions = smallest power of 2 such that at least one of # the partitions is empty nb_partitions = 1 << math.floor(math.log2(len(swh_contents)) + 1) seen_sha1s = [] for i in range(nb_partitions): actual_result = swh_storage.content_get_partition( i, nb_partitions, limit=len(swh_contents) + 1 ) for cont in actual_result["contents"]: seen_sha1s.append(cont["sha1"]) # Limit is higher than the max number of results assert actual_result["next_page_token"] is None assert set(seen_sha1s) == expected_contents def test_content_get_partition_limit_none(self, swh_storage): """content_get_partition call with wrong limit input should fail""" with pytest.raises(StorageArgumentException) as e: swh_storage.content_get_partition(1, 16, limit=None) assert e.value.args == ("limit should not be None",) def test_generate_content_get_partition_pagination(self, swh_storage, swh_contents): """content_get_partition returns contents within range provided""" expected_contents = [c for c in swh_contents if c["status"] != "absent"] # retrieve contents actual_contents = [] for i in range(4): page_token = None while True: actual_result = swh_storage.content_get_partition( i, 4, limit=3, page_token=page_token ) actual_contents.extend(actual_result["contents"]) page_token = actual_result["next_page_token"] if page_token is None: break assert_contents_ok(expected_contents, actual_contents, ["sha1"]) def test_content_get_metadata(self, swh_storage): cont1 = data.cont cont2 = data.cont2 swh_storage.content_add([cont1, cont2]) actual_md = swh_storage.content_get_metadata([cont1["sha1"], cont2["sha1"]]) # we only retrieve the metadata cont1.pop("data") cont2.pop("data") assert actual_md[cont1["sha1"]] == [cont1] assert actual_md[cont2["sha1"]] == [cont2] assert len(actual_md.keys()) == 2 def test_content_get_metadata_missing_sha1(self, swh_storage): cont1 = data.cont cont2 = data.cont2 missing_cont = data.missing_cont swh_storage.content_add([cont1, cont2]) actual_contents = swh_storage.content_get_metadata([missing_cont["sha1"]]) assert actual_contents == {missing_cont["sha1"]: []} def test_content_get_random(self, swh_storage): swh_storage.content_add([data.cont, data.cont2, data.cont3]) assert swh_storage.content_get_random() in { data.cont["sha1_git"], data.cont2["sha1_git"], data.cont3["sha1_git"], } def test_directory_add(self, swh_storage): init_missing = list(swh_storage.directory_missing([data.dir["id"]])) assert [data.dir["id"]] == init_missing actual_result = swh_storage.directory_add([data.dir]) assert actual_result == {"directory:add": 1} assert list(swh_storage.journal_writer.journal.objects) == [ ("directory", Directory.from_dict(data.dir)) ] actual_data = list(swh_storage.directory_ls(data.dir["id"])) expected_data = list(transform_entries(data.dir)) assert sorted(expected_data, key=cmpdir) == sorted(actual_data, key=cmpdir) after_missing = list(swh_storage.directory_missing([data.dir["id"]])) assert after_missing == [] swh_storage.refresh_stat_counters() assert swh_storage.stat_counters()["directory"] == 1 def test_directory_add_from_generator(self, swh_storage): def _dir_gen(): yield data.dir actual_result = swh_storage.directory_add(directories=_dir_gen()) assert actual_result == {"directory:add": 1} assert list(swh_storage.journal_writer.journal.objects) == [ ("directory", Directory.from_dict(data.dir)) ] swh_storage.refresh_stat_counters() assert swh_storage.stat_counters()["directory"] == 1 def test_directory_add_validation(self, swh_storage): dir_ = copy.deepcopy(data.dir) dir_["entries"][0]["type"] = "foobar" with pytest.raises(StorageArgumentException, match="type.*foobar"): swh_storage.directory_add([dir_]) dir_ = copy.deepcopy(data.dir) del dir_["entries"][0]["target"] with pytest.raises(StorageArgumentException, match="target") as cm: swh_storage.directory_add([dir_]) if type(cm.value) == psycopg2.IntegrityError: assert cm.value.pgcode == psycopg2.errorcodes.NOT_NULL_VIOLATION def test_directory_add_twice(self, swh_storage): actual_result = swh_storage.directory_add([data.dir]) assert actual_result == {"directory:add": 1} assert list(swh_storage.journal_writer.journal.objects) == [ ("directory", Directory.from_dict(data.dir)) ] actual_result = swh_storage.directory_add([data.dir]) assert actual_result == {"directory:add": 0} assert list(swh_storage.journal_writer.journal.objects) == [ ("directory", Directory.from_dict(data.dir)) ] def test_directory_get_recursive(self, swh_storage): init_missing = list(swh_storage.directory_missing([data.dir["id"]])) assert init_missing == [data.dir["id"]] actual_result = swh_storage.directory_add([data.dir, data.dir2, data.dir3]) assert actual_result == {"directory:add": 3} assert list(swh_storage.journal_writer.journal.objects) == [ ("directory", Directory.from_dict(data.dir)), ("directory", Directory.from_dict(data.dir2)), ("directory", Directory.from_dict(data.dir3)), ] # List directory containing a file and an unknown subdirectory actual_data = list(swh_storage.directory_ls(data.dir["id"], recursive=True)) expected_data = list(transform_entries(data.dir)) assert sorted(expected_data, key=cmpdir) == sorted(actual_data, key=cmpdir) # List directory containing a file and an unknown subdirectory actual_data = list(swh_storage.directory_ls(data.dir2["id"], recursive=True)) expected_data = list(transform_entries(data.dir2)) assert sorted(expected_data, key=cmpdir) == sorted(actual_data, key=cmpdir) # List directory containing a known subdirectory, entries should # be both those of the directory and of the subdir actual_data = list(swh_storage.directory_ls(data.dir3["id"], recursive=True)) expected_data = list( itertools.chain( transform_entries(data.dir3), transform_entries(data.dir, prefix=b"subdir/"), ) ) assert sorted(expected_data, key=cmpdir) == sorted(actual_data, key=cmpdir) def test_directory_get_non_recursive(self, swh_storage): init_missing = list(swh_storage.directory_missing([data.dir["id"]])) assert init_missing == [data.dir["id"]] actual_result = swh_storage.directory_add([data.dir, data.dir2, data.dir3]) assert actual_result == {"directory:add": 3} assert list(swh_storage.journal_writer.journal.objects) == [ ("directory", Directory.from_dict(data.dir)), ("directory", Directory.from_dict(data.dir2)), ("directory", Directory.from_dict(data.dir3)), ] # List directory containing a file and an unknown subdirectory actual_data = list(swh_storage.directory_ls(data.dir["id"])) expected_data = list(transform_entries(data.dir)) assert sorted(expected_data, key=cmpdir) == sorted(actual_data, key=cmpdir) # List directory contaiining a single file actual_data = list(swh_storage.directory_ls(data.dir2["id"])) expected_data = list(transform_entries(data.dir2)) assert sorted(expected_data, key=cmpdir) == sorted(actual_data, key=cmpdir) # List directory containing a known subdirectory, entries should # only be those of the parent directory, not of the subdir actual_data = list(swh_storage.directory_ls(data.dir3["id"])) expected_data = list(transform_entries(data.dir3)) assert sorted(expected_data, key=cmpdir) == sorted(actual_data, key=cmpdir) def test_directory_entry_get_by_path(self, swh_storage): # given init_missing = list(swh_storage.directory_missing([data.dir3["id"]])) assert [data.dir3["id"]] == init_missing actual_result = swh_storage.directory_add([data.dir3, data.dir4]) assert actual_result == {"directory:add": 2} expected_entries = [ { "dir_id": data.dir3["id"], "name": b"foo", "type": "file", "target": data.cont["sha1_git"], "sha1": None, "sha1_git": None, "sha256": None, "status": None, "perms": from_disk.DentryPerms.content, "length": None, }, { "dir_id": data.dir3["id"], "name": b"subdir", "type": "dir", "target": data.dir["id"], "sha1": None, "sha1_git": None, "sha256": None, "status": None, "perms": from_disk.DentryPerms.directory, "length": None, }, { "dir_id": data.dir3["id"], "name": b"hello", "type": "file", "target": b"12345678901234567890", "sha1": None, "sha1_git": None, "sha256": None, "status": None, "perms": from_disk.DentryPerms.content, "length": None, }, ] # when (all must be found here) for entry, expected_entry in zip(data.dir3["entries"], expected_entries): actual_entry = swh_storage.directory_entry_get_by_path( data.dir3["id"], [entry["name"]] ) assert actual_entry == expected_entry # same, but deeper for entry, expected_entry in zip(data.dir3["entries"], expected_entries): actual_entry = swh_storage.directory_entry_get_by_path( data.dir4["id"], [b"subdir1", entry["name"]] ) expected_entry = expected_entry.copy() expected_entry["name"] = b"subdir1/" + expected_entry["name"] assert actual_entry == expected_entry # when (nothing should be found here since data.dir is not persisted.) for entry in data.dir["entries"]: actual_entry = swh_storage.directory_entry_get_by_path( data.dir["id"], [entry["name"]] ) assert actual_entry is None def test_directory_get_random(self, swh_storage): swh_storage.directory_add([data.dir, data.dir2, data.dir3]) assert swh_storage.directory_get_random() in { data.dir["id"], data.dir2["id"], data.dir3["id"], } def test_revision_add(self, swh_storage): init_missing = swh_storage.revision_missing([data.revision["id"]]) assert list(init_missing) == [data.revision["id"]] actual_result = swh_storage.revision_add([data.revision]) assert actual_result == {"revision:add": 1} end_missing = swh_storage.revision_missing([data.revision["id"]]) assert list(end_missing) == [] assert list(swh_storage.journal_writer.journal.objects) == [ ("revision", Revision.from_dict(data.revision)) ] # already there so nothing added actual_result = swh_storage.revision_add([data.revision]) assert actual_result == {"revision:add": 0} swh_storage.refresh_stat_counters() assert swh_storage.stat_counters()["revision"] == 1 def test_revision_add_from_generator(self, swh_storage): def _rev_gen(): yield data.revision actual_result = swh_storage.revision_add(_rev_gen()) assert actual_result == {"revision:add": 1} swh_storage.refresh_stat_counters() assert swh_storage.stat_counters()["revision"] == 1 def test_revision_add_validation(self, swh_storage): rev = copy.deepcopy(data.revision) rev["date"]["offset"] = 2 ** 16 with pytest.raises(StorageArgumentException, match="offset") as cm: swh_storage.revision_add([rev]) if type(cm.value) == psycopg2.DataError: assert cm.value.pgcode == psycopg2.errorcodes.NUMERIC_VALUE_OUT_OF_RANGE rev = copy.deepcopy(data.revision) rev["committer_date"]["offset"] = 2 ** 16 with pytest.raises(StorageArgumentException, match="offset") as cm: swh_storage.revision_add([rev]) if type(cm.value) == psycopg2.DataError: assert cm.value.pgcode == psycopg2.errorcodes.NUMERIC_VALUE_OUT_OF_RANGE rev = copy.deepcopy(data.revision) rev["type"] = "foobar" with pytest.raises(StorageArgumentException, match="(?i)type") as cm: swh_storage.revision_add([rev]) if type(cm.value) == psycopg2.DataError: assert cm.value.pgcode == psycopg2.errorcodes.INVALID_TEXT_REPRESENTATION def test_revision_add_twice(self, swh_storage): actual_result = swh_storage.revision_add([data.revision]) assert actual_result == {"revision:add": 1} assert list(swh_storage.journal_writer.journal.objects) == [ ("revision", Revision.from_dict(data.revision)) ] actual_result = swh_storage.revision_add([data.revision, data.revision2]) assert actual_result == {"revision:add": 1} assert list(swh_storage.journal_writer.journal.objects) == [ ("revision", Revision.from_dict(data.revision)), ("revision", Revision.from_dict(data.revision2)), ] def test_revision_add_name_clash(self, swh_storage): revision1 = data.revision revision2 = data.revision2 revision1["author"] = { "fullname": b"John Doe ", "name": b"John Doe", "email": b"john.doe@example.com", } revision2["author"] = { "fullname": b"John Doe ", "name": b"John Doe ", "email": b"john.doe@example.com ", } actual_result = swh_storage.revision_add([revision1, revision2]) assert actual_result == {"revision:add": 2} def test_revision_get_order(self, swh_storage): add_result = swh_storage.revision_add([data.revision, data.revision2]) assert add_result == {"revision:add": 2} # order 1 res1 = swh_storage.revision_get([data.revision["id"], data.revision2["id"]]) assert list(res1) == [data.revision, data.revision2] # order 2 res2 = swh_storage.revision_get([data.revision2["id"], data.revision["id"]]) assert list(res2) == [data.revision2, data.revision] def test_revision_log(self, swh_storage): # given # data.revision4 -is-child-of-> data.revision3 swh_storage.revision_add([data.revision3, data.revision4]) # when actual_results = list(swh_storage.revision_log([data.revision4["id"]])) # hack: ids generated for actual_result in actual_results: if "id" in actual_result["author"]: del actual_result["author"]["id"] if "id" in actual_result["committer"]: del actual_result["committer"]["id"] assert len(actual_results) == 2 # rev4 -child-> rev3 assert actual_results[0] == normalize_entity(data.revision4) assert actual_results[1] == normalize_entity(data.revision3) assert list(swh_storage.journal_writer.journal.objects) == [ ("revision", Revision.from_dict(data.revision3)), ("revision", Revision.from_dict(data.revision4)), ] def test_revision_log_with_limit(self, swh_storage): # given # data.revision4 -is-child-of-> data.revision3 swh_storage.revision_add([data.revision3, data.revision4]) actual_results = list(swh_storage.revision_log([data.revision4["id"]], 1)) # hack: ids generated for actual_result in actual_results: if "id" in actual_result["author"]: del actual_result["author"]["id"] if "id" in actual_result["committer"]: del actual_result["committer"]["id"] assert len(actual_results) == 1 assert actual_results[0] == data.revision4 def test_revision_log_unknown_revision(self, swh_storage): rev_log = list(swh_storage.revision_log([data.revision["id"]])) assert rev_log == [] def test_revision_shortlog(self, swh_storage): # given # data.revision4 -is-child-of-> data.revision3 swh_storage.revision_add([data.revision3, data.revision4]) # when actual_results = list(swh_storage.revision_shortlog([data.revision4["id"]])) assert len(actual_results) == 2 # rev4 -child-> rev3 assert list(actual_results[0]) == short_revision(data.revision4) assert list(actual_results[1]) == short_revision(data.revision3) def test_revision_shortlog_with_limit(self, swh_storage): # given # data.revision4 -is-child-of-> data.revision3 swh_storage.revision_add([data.revision3, data.revision4]) actual_results = list(swh_storage.revision_shortlog([data.revision4["id"]], 1)) assert len(actual_results) == 1 assert list(actual_results[0]) == short_revision(data.revision4) def test_revision_get(self, swh_storage): swh_storage.revision_add([data.revision]) actual_revisions = list( swh_storage.revision_get([data.revision["id"], data.revision2["id"]]) ) # when if "id" in actual_revisions[0]["author"]: del actual_revisions[0]["author"]["id"] # hack: ids are generated if "id" in actual_revisions[0]["committer"]: del actual_revisions[0]["committer"]["id"] assert len(actual_revisions) == 2 assert actual_revisions[0] == normalize_entity(data.revision) assert actual_revisions[1] is None def test_revision_get_no_parents(self, swh_storage): swh_storage.revision_add([data.revision3]) get = list(swh_storage.revision_get([data.revision3["id"]])) assert len(get) == 1 assert get[0]["parents"] == [] # no parents on this one def test_revision_get_random(self, swh_storage): swh_storage.revision_add([data.revision, data.revision2, data.revision3]) assert swh_storage.revision_get_random() in { data.revision["id"], data.revision2["id"], data.revision3["id"], } def test_release_add(self, swh_storage): init_missing = swh_storage.release_missing( [data.release["id"], data.release2["id"]] ) assert [data.release["id"], data.release2["id"]] == list(init_missing) actual_result = swh_storage.release_add([data.release, data.release2]) assert actual_result == {"release:add": 2} end_missing = swh_storage.release_missing( [data.release["id"], data.release2["id"]] ) assert list(end_missing) == [] assert list(swh_storage.journal_writer.journal.objects) == [ ("release", Release.from_dict(data.release)), ("release", Release.from_dict(data.release2)), ] # already present so nothing added actual_result = swh_storage.release_add([data.release, data.release2]) assert actual_result == {"release:add": 0} swh_storage.refresh_stat_counters() assert swh_storage.stat_counters()["release"] == 2 def test_release_add_from_generator(self, swh_storage): def _rel_gen(): yield data.release yield data.release2 actual_result = swh_storage.release_add(_rel_gen()) assert actual_result == {"release:add": 2} assert list(swh_storage.journal_writer.journal.objects) == [ ("release", Release.from_dict(data.release)), ("release", Release.from_dict(data.release2)), ] swh_storage.refresh_stat_counters() assert swh_storage.stat_counters()["release"] == 2 def test_release_add_no_author_date(self, swh_storage): release = data.release release["author"] = None release["date"] = None actual_result = swh_storage.release_add([release]) assert actual_result == {"release:add": 1} end_missing = swh_storage.release_missing([data.release["id"]]) assert list(end_missing) == [] assert list(swh_storage.journal_writer.journal.objects) == [ ("release", Release.from_dict(release)) ] def test_release_add_validation(self, swh_storage): rel = copy.deepcopy(data.release) rel["date"]["offset"] = 2 ** 16 with pytest.raises(StorageArgumentException, match="offset") as cm: swh_storage.release_add([rel]) if type(cm.value) == psycopg2.DataError: assert cm.value.pgcode == psycopg2.errorcodes.NUMERIC_VALUE_OUT_OF_RANGE rel = copy.deepcopy(data.release) rel["author"] = None with pytest.raises(StorageArgumentException, match="date") as cm: swh_storage.release_add([rel]) if type(cm.value) == psycopg2.IntegrityError: assert cm.value.pgcode == psycopg2.errorcodes.CHECK_VIOLATION def test_release_add_validation_type(self, swh_storage): rel = copy.deepcopy(data.release) rel["date"]["offset"] = "toto" with pytest.raises(StorageArgumentException): swh_storage.release_add([rel]) def test_release_add_twice(self, swh_storage): actual_result = swh_storage.release_add([data.release]) assert actual_result == {"release:add": 1} assert list(swh_storage.journal_writer.journal.objects) == [ ("release", Release.from_dict(data.release)) ] actual_result = swh_storage.release_add([data.release, data.release2]) assert actual_result == {"release:add": 1} assert list(swh_storage.journal_writer.journal.objects) == [ ("release", Release.from_dict(data.release)), ("release", Release.from_dict(data.release2)), ] def test_release_add_name_clash(self, swh_storage): release1 = data.release.copy() release2 = data.release2.copy() release1["author"] = { "fullname": b"John Doe ", "name": b"John Doe", "email": b"john.doe@example.com", } release2["author"] = { "fullname": b"John Doe ", "name": b"John Doe ", "email": b"john.doe@example.com ", } actual_result = swh_storage.release_add([release1, release2]) assert actual_result == {"release:add": 2} def test_release_get(self, swh_storage): # given swh_storage.release_add([data.release, data.release2]) # when actual_releases = list( swh_storage.release_get([data.release["id"], data.release2["id"]]) ) # then for actual_release in actual_releases: if "id" in actual_release["author"]: del actual_release["author"]["id"] # hack: ids are generated assert [normalize_entity(data.release), normalize_entity(data.release2)] == [ actual_releases[0], actual_releases[1], ] unknown_releases = list(swh_storage.release_get([data.release3["id"]])) assert unknown_releases[0] is None def test_release_get_order(self, swh_storage): add_result = swh_storage.release_add([data.release, data.release2]) assert add_result == {"release:add": 2} # order 1 res1 = swh_storage.release_get([data.release["id"], data.release2["id"]]) assert list(res1) == [data.release, data.release2] # order 2 res2 = swh_storage.release_get([data.release2["id"], data.release["id"]]) assert list(res2) == [data.release2, data.release] def test_release_get_random(self, swh_storage): swh_storage.release_add([data.release, data.release2, data.release3]) assert swh_storage.release_get_random() in { data.release["id"], data.release2["id"], data.release3["id"], } def test_origin_add_one(self, swh_storage): origin0 = swh_storage.origin_get(data.origin) assert origin0 is None id = swh_storage.origin_add_one(data.origin) actual_origin = swh_storage.origin_get({"url": data.origin["url"]}) assert actual_origin["url"] == data.origin["url"] id2 = swh_storage.origin_add_one(data.origin) assert id == id2 def test_origin_add(self, swh_storage): origin0 = swh_storage.origin_get([data.origin])[0] assert origin0 is None origin1, origin2 = swh_storage.origin_add([data.origin, data.origin2]) actual_origin = swh_storage.origin_get([{"url": data.origin["url"],}])[0] assert actual_origin["url"] == origin1["url"] actual_origin2 = swh_storage.origin_get([{"url": data.origin2["url"],}])[0] assert actual_origin2["url"] == origin2["url"] if "id" in actual_origin: del actual_origin["id"] del actual_origin2["id"] assert list(swh_storage.journal_writer.journal.objects) == [ ("origin", Origin.from_dict(actual_origin)), ("origin", Origin.from_dict(actual_origin2)), ] swh_storage.refresh_stat_counters() assert swh_storage.stat_counters()["origin"] == 2 def test_origin_add_from_generator(self, swh_storage): def _ori_gen(): yield data.origin yield data.origin2 origin1, origin2 = swh_storage.origin_add(_ori_gen()) actual_origin = swh_storage.origin_get([{"url": data.origin["url"],}])[0] assert actual_origin["url"] == origin1["url"] actual_origin2 = swh_storage.origin_get([{"url": data.origin2["url"],}])[0] assert actual_origin2["url"] == origin2["url"] if "id" in actual_origin: del actual_origin["id"] del actual_origin2["id"] assert list(swh_storage.journal_writer.journal.objects) == [ ("origin", Origin.from_dict(actual_origin)), ("origin", Origin.from_dict(actual_origin2)), ] swh_storage.refresh_stat_counters() assert swh_storage.stat_counters()["origin"] == 2 def test_origin_add_twice(self, swh_storage): add1 = swh_storage.origin_add([data.origin, data.origin2]) assert list(swh_storage.journal_writer.journal.objects) == [ ("origin", Origin.from_dict(data.origin)), ("origin", Origin.from_dict(data.origin2)), ] add2 = swh_storage.origin_add([data.origin, data.origin2]) assert list(swh_storage.journal_writer.journal.objects) == [ ("origin", Origin.from_dict(data.origin)), ("origin", Origin.from_dict(data.origin2)), ] assert add1 == add2 def test_origin_add_validation(self, swh_storage): """Incorrect formatted origin should fail the validation """ with pytest.raises(StorageArgumentException, match="url"): swh_storage.origin_add([{}]) with pytest.raises( StorageArgumentException, match="unexpected keyword argument" ): swh_storage.origin_add([{"ul": "mistyped url key"}]) def test_origin_get_legacy(self, swh_storage): assert swh_storage.origin_get(data.origin) is None swh_storage.origin_add_one(data.origin) actual_origin0 = swh_storage.origin_get({"url": data.origin["url"]}) assert actual_origin0["url"] == data.origin["url"] def test_origin_get(self, swh_storage): assert swh_storage.origin_get(data.origin) is None swh_storage.origin_add_one(data.origin) actual_origin0 = swh_storage.origin_get([{"url": data.origin["url"]}]) assert len(actual_origin0) == 1 assert actual_origin0[0]["url"] == data.origin["url"] def _generate_random_visits(self, nb_visits=100, start=0, end=7): """Generate random visits within the last 2 months (to avoid computations) """ visits = [] today = now() for weeks in range(nb_visits, 0, -1): hours = random.randint(0, 24) minutes = random.randint(0, 60) seconds = random.randint(0, 60) days = random.randint(0, 28) weeks = random.randint(start, end) date_visit = today - timedelta( weeks=weeks, hours=hours, minutes=minutes, seconds=seconds, days=days ) visits.append(date_visit) return visits def test_origin_visit_get_random(self, swh_storage): swh_storage.origin_add(data.origins) # Add some random visits within the selection range visits = self._generate_random_visits() visit_type = "git" # Add visits to those origins for origin in data.origins: origin_url = origin["url"] for date_visit in visits: visit = swh_storage.origin_visit_add( origin_url, date=date_visit, type=visit_type ) swh_storage.origin_visit_update( origin_url, visit_id=visit.visit, status="full" ) swh_storage.refresh_stat_counters() stats = swh_storage.stat_counters() assert stats["origin"] == len(data.origins) assert stats["origin_visit"] == len(data.origins) * len(visits) random_origin_visit = swh_storage.origin_visit_get_random(visit_type) assert random_origin_visit assert random_origin_visit["origin"] is not None original_urls = [o["url"] for o in data.origins] assert random_origin_visit["origin"] in original_urls def test_origin_visit_get_random_nothing_found(self, swh_storage): swh_storage.origin_add(data.origins) visit_type = "hg" # Add some visits outside of the random generation selection so nothing # will be found by the random selection visits = self._generate_random_visits(nb_visits=3, start=13, end=24) for origin in data.origins: origin_url = origin["url"] for date_visit in visits: visit = swh_storage.origin_visit_add( origin_url, date=date_visit, type=visit_type ) swh_storage.origin_visit_update(origin_url, visit.visit, status="full") random_origin_visit = swh_storage.origin_visit_get_random(visit_type) assert random_origin_visit is None def test_origin_get_by_sha1(self, swh_storage): assert swh_storage.origin_get(data.origin) is None swh_storage.origin_add_one(data.origin) origins = list(swh_storage.origin_get_by_sha1([sha1(data.origin["url"])])) assert len(origins) == 1 assert origins[0]["url"] == data.origin["url"] def test_origin_get_by_sha1_not_found(self, swh_storage): assert swh_storage.origin_get(data.origin) is None origins = list(swh_storage.origin_get_by_sha1([sha1(data.origin["url"])])) assert len(origins) == 1 assert origins[0] is None def test_origin_search_single_result(self, swh_storage): found_origins = list(swh_storage.origin_search(data.origin["url"])) assert len(found_origins) == 0 found_origins = list(swh_storage.origin_search(data.origin["url"], regexp=True)) assert len(found_origins) == 0 swh_storage.origin_add_one(data.origin) origin_data = {"url": data.origin["url"]} found_origins = list(swh_storage.origin_search(data.origin["url"])) assert len(found_origins) == 1 if "id" in found_origins[0]: del found_origins[0]["id"] assert found_origins[0] == origin_data found_origins = list( swh_storage.origin_search("." + data.origin["url"][1:-1] + ".", regexp=True) ) assert len(found_origins) == 1 if "id" in found_origins[0]: del found_origins[0]["id"] assert found_origins[0] == origin_data swh_storage.origin_add_one(data.origin2) origin2_data = {"url": data.origin2["url"]} found_origins = list(swh_storage.origin_search(data.origin2["url"])) assert len(found_origins) == 1 if "id" in found_origins[0]: del found_origins[0]["id"] assert found_origins[0] == origin2_data found_origins = list( swh_storage.origin_search( "." + data.origin2["url"][1:-1] + ".", regexp=True ) ) assert len(found_origins) == 1 if "id" in found_origins[0]: del found_origins[0]["id"] assert found_origins[0] == origin2_data def test_origin_search_no_regexp(self, swh_storage): swh_storage.origin_add_one(data.origin) swh_storage.origin_add_one(data.origin2) origin = swh_storage.origin_get({"url": data.origin["url"]}) origin2 = swh_storage.origin_get({"url": data.origin2["url"]}) # no pagination found_origins = list(swh_storage.origin_search("/")) assert len(found_origins) == 2 # offset=0 found_origins0 = list(swh_storage.origin_search("/", offset=0, limit=1)) # noqa assert len(found_origins0) == 1 assert found_origins0[0] in [origin, origin2] # offset=1 found_origins1 = list(swh_storage.origin_search("/", offset=1, limit=1)) # noqa assert len(found_origins1) == 1 assert found_origins1[0] in [origin, origin2] # check both origins were returned assert found_origins0 != found_origins1 def test_origin_search_regexp_substring(self, swh_storage): swh_storage.origin_add_one(data.origin) swh_storage.origin_add_one(data.origin2) origin = swh_storage.origin_get({"url": data.origin["url"]}) origin2 = swh_storage.origin_get({"url": data.origin2["url"]}) # no pagination found_origins = list(swh_storage.origin_search("/", regexp=True)) assert len(found_origins) == 2 # offset=0 found_origins0 = list( swh_storage.origin_search("/", offset=0, limit=1, regexp=True) ) # noqa assert len(found_origins0) == 1 assert found_origins0[0] in [origin, origin2] # offset=1 found_origins1 = list( swh_storage.origin_search("/", offset=1, limit=1, regexp=True) ) # noqa assert len(found_origins1) == 1 assert found_origins1[0] in [origin, origin2] # check both origins were returned assert found_origins0 != found_origins1 def test_origin_search_regexp_fullstring(self, swh_storage): swh_storage.origin_add_one(data.origin) swh_storage.origin_add_one(data.origin2) origin = swh_storage.origin_get({"url": data.origin["url"]}) origin2 = swh_storage.origin_get({"url": data.origin2["url"]}) # no pagination found_origins = list(swh_storage.origin_search(".*/.*", regexp=True)) assert len(found_origins) == 2 # offset=0 found_origins0 = list( swh_storage.origin_search(".*/.*", offset=0, limit=1, regexp=True) ) # noqa assert len(found_origins0) == 1 assert found_origins0[0] in [origin, origin2] # offset=1 found_origins1 = list( swh_storage.origin_search(".*/.*", offset=1, limit=1, regexp=True) ) # noqa assert len(found_origins1) == 1 assert found_origins1[0] in [origin, origin2] # check both origins were returned assert found_origins0 != found_origins1 def test_origin_visit_add(self, swh_storage): # given origin_url = swh_storage.origin_add_one(data.origin2) date_visit = now() # Round to milliseconds before insertion, so equality doesn't fail # after a round-trip through a DB (eg. Cassandra) date_visit = date_visit.replace(microsecond=round(date_visit.microsecond, -3)) # when origin_visit = swh_storage.origin_visit_add( origin_url, type=data.type_visit1, date=date_visit ) expected_origin_visit = { "origin": origin_url, "date": date_visit, "visit": origin_visit.visit, "type": data.type_visit1, "status": "ongoing", "metadata": None, "snapshot": None, } assert origin_visit == OriginVisit.from_dict(expected_origin_visit) actual_origin_visits = list(swh_storage.origin_visit_get(origin_url)) assert expected_origin_visit in actual_origin_visits objects = list(swh_storage.journal_writer.journal.objects) assert ("origin", Origin.from_dict(data.origin2)) in objects assert ("origin_visit", OriginVisit.from_dict(expected_origin_visit)) in objects def test_origin_visit_get__unknown_origin(self, swh_storage): assert [] == list(swh_storage.origin_visit_get("foo")) def test_origin_visit_add_default_type(self, swh_storage): # given origin_url = swh_storage.origin_add_one(data.origin2) # when date_visit = now() date_visit2 = date_visit + datetime.timedelta(minutes=1) # Round to milliseconds before insertion, so equality doesn't fail # after a round-trip through a DB (eg. Cassandra) date_visit = date_visit.replace(microsecond=round(date_visit.microsecond, -3)) date_visit2 = date_visit2.replace( microsecond=round(date_visit2.microsecond, -3) ) origin_visit1 = swh_storage.origin_visit_add( origin_url, date=date_visit, type=data.type_visit1 ) origin_visit2 = swh_storage.origin_visit_add( origin_url, date=date_visit2, type=data.type_visit2 ) # then assert origin_visit1.origin == origin_url assert origin_visit1.visit is not None actual_origin_visits = list(swh_storage.origin_visit_get(origin_url)) expected_visits = [ { "origin": origin_url, "date": date_visit, "visit": origin_visit1.visit, "type": data.type_visit1, "status": "ongoing", "metadata": None, "snapshot": None, }, { "origin": origin_url, "date": date_visit2, "visit": origin_visit2.visit, "type": data.type_visit2, "status": "ongoing", "metadata": None, "snapshot": None, }, ] assert len(expected_visits) == len(actual_origin_visits) for visit in expected_visits: assert visit in actual_origin_visits objects = list(swh_storage.journal_writer.journal.objects) assert ("origin", Origin.from_dict(data.origin2)) in objects for visit in expected_visits: assert ("origin_visit", OriginVisit.from_dict(visit)) in objects def test_origin_visit_add_validation(self, swh_storage): origin_url = swh_storage.origin_add_one(data.origin2) with pytest.raises(StorageArgumentException) as cm: swh_storage.origin_visit_add(origin_url, date=[b"foo"], type="git") if type(cm.value) == psycopg2.ProgrammingError: assert cm.value.pgcode == psycopg2.errorcodes.UNDEFINED_FUNCTION def test_origin_visit_update(self, swh_storage): # given origin_url = swh_storage.origin_add_one(data.origin) origin_url2 = swh_storage.origin_add_one(data.origin2) # date_visit < date_visit2 date_visit = data.date_visit1 date_visit2 = data.date_visit2 # Round to milliseconds before insertion, so equality doesn't fail # after a round-trip through a DB (eg. Cassandra) date_visit = date_visit.replace(microsecond=round(date_visit.microsecond, -3)) date_visit2 = date_visit2.replace( microsecond=round(date_visit2.microsecond, -3) ) origin_visit1 = swh_storage.origin_visit_add( origin_url, date=date_visit, type=data.type_visit1 ) origin_visit2 = swh_storage.origin_visit_add( origin_url, date=date_visit2, type=data.type_visit2 ) origin_visit3 = swh_storage.origin_visit_add( origin_url2, date=date_visit2, type=data.type_visit3 ) # when visit1_metadata = { "contents": 42, "directories": 22, } swh_storage.origin_visit_update( origin_url, origin_visit1.visit, status="full", metadata=visit1_metadata ) swh_storage.origin_visit_update( origin_url2, origin_visit3.visit, status="partial" ) # then actual_origin_visits = list(swh_storage.origin_visit_get(origin_url)) expected_visits = [ { "origin": origin_url, "date": date_visit, "visit": origin_visit1.visit, "type": data.type_visit1, "status": "full", "metadata": visit1_metadata, "snapshot": None, }, { "origin": origin_url, "date": date_visit2, "visit": origin_visit2.visit, "type": data.type_visit2, "status": "ongoing", "metadata": None, "snapshot": None, }, ] for visit in expected_visits: assert visit in actual_origin_visits actual_origin_visits_bis = list( swh_storage.origin_visit_get(origin_url, limit=1) ) assert actual_origin_visits_bis == [ { "origin": origin_url, "date": date_visit, "visit": origin_visit1.visit, "type": data.type_visit1, "status": "full", "metadata": visit1_metadata, "snapshot": None, } ] actual_origin_visits_ter = list( swh_storage.origin_visit_get(origin_url, last_visit=origin_visit1.visit) ) assert actual_origin_visits_ter == [ { "origin": origin_url, "date": date_visit2, "visit": origin_visit2.visit, "type": data.type_visit2, "status": "ongoing", "metadata": None, "snapshot": None, } ] actual_origin_visits2 = list(swh_storage.origin_visit_get(origin_url2)) assert actual_origin_visits2 == [ { "origin": origin_url2, "date": date_visit2, "visit": origin_visit3.visit, "type": data.type_visit3, "status": "partial", "metadata": None, "snapshot": None, } ] data1 = { "origin": origin_url, "date": date_visit, "visit": origin_visit1.visit, "type": data.type_visit1, "status": "ongoing", "metadata": None, "snapshot": None, } data2 = { "origin": origin_url, "date": date_visit2, "visit": origin_visit2.visit, "type": data.type_visit2, "status": "ongoing", "metadata": None, "snapshot": None, } data3 = { "origin": origin_url2, "date": date_visit2, "visit": origin_visit3.visit, "type": data.type_visit3, "status": "ongoing", "metadata": None, "snapshot": None, } data4 = { "origin": origin_url, "date": date_visit, "visit": origin_visit1.visit, "type": data.type_visit1, "metadata": visit1_metadata, "status": "full", "snapshot": None, } data5 = { "origin": origin_url2, "date": date_visit2, "visit": origin_visit3.visit, "type": data.type_visit3, "status": "partial", "metadata": None, "snapshot": None, } objects = list(swh_storage.journal_writer.journal.objects) assert ("origin", Origin.from_dict(data.origin)) in objects assert ("origin", Origin.from_dict(data.origin2)) in objects assert ("origin_visit", OriginVisit.from_dict(data1)) in objects assert ("origin_visit", OriginVisit.from_dict(data2)) in objects assert ("origin_visit", OriginVisit.from_dict(data3)) in objects assert ("origin_visit", OriginVisit.from_dict(data4)) in objects assert ("origin_visit", OriginVisit.from_dict(data5)) in objects def test_origin_visit_update_validation(self, swh_storage): origin_url = swh_storage.origin_add_one(data.origin) visit = swh_storage.origin_visit_add( origin_url, date=data.date_visit2, type=data.type_visit2 ) with pytest.raises( (StorageArgumentException, ValueError), match="status" ) as cm: swh_storage.origin_visit_update(origin_url, visit.visit, status="foobar") if type(cm.value) == psycopg2.DataError: assert cm.value.pgcode == psycopg2.errorcodes.INVALID_TEXT_REPRESENTATION def test_origin_visit_find_by_date(self, swh_storage): # given origin_url = swh_storage.origin_add_one(data.origin) swh_storage.origin_visit_add( origin_url, date=data.date_visit2, type=data.type_visit1 ) origin_visit2 = swh_storage.origin_visit_add( origin_url, date=data.date_visit3, type=data.type_visit2 ) origin_visit3 = swh_storage.origin_visit_add( origin_url, date=data.date_visit2, type=data.type_visit3 ) # Simple case visit = swh_storage.origin_visit_find_by_date(origin_url, data.date_visit3) assert visit["visit"] == origin_visit2.visit # There are two visits at the same date, the latest must be returned visit = swh_storage.origin_visit_find_by_date(origin_url, data.date_visit2) assert visit["visit"] == origin_visit3.visit def test_origin_visit_find_by_date__unknown_origin(self, swh_storage): swh_storage.origin_visit_find_by_date("foo", data.date_visit2) def test_origin_visit_update_missing_snapshot(self, swh_storage): # given origin_url = swh_storage.origin_add_one(data.origin) origin_visit = swh_storage.origin_visit_add( origin_url, date=data.date_visit1, type=data.type_visit1 ) # when swh_storage.origin_visit_update( origin_url, origin_visit.visit, status="ongoing", snapshot=data.snapshot["id"], ) # snapshot does not exist yet # then actual_origin_visit = swh_storage.origin_visit_get_by( origin_url, origin_visit.visit ) assert actual_origin_visit["snapshot"] == data.snapshot["id"] # when swh_storage.snapshot_add([data.snapshot]) assert actual_origin_visit["snapshot"] == data.snapshot["id"] def test_origin_visit_get_by(self, swh_storage): origin_url = swh_storage.origin_add_one(data.origin) origin_url2 = swh_storage.origin_add_one(data.origin2) origin_visit1 = swh_storage.origin_visit_add( origin_url, date=data.date_visit2, type=data.type_visit2 ) swh_storage.snapshot_add([data.snapshot]) swh_storage.origin_visit_update( origin_url, origin_visit1.visit, status="ongoing", snapshot=data.snapshot["id"], ) # Add some other {origin, visit} entries swh_storage.origin_visit_add( origin_url, date=data.date_visit3, type=data.type_visit3 ) swh_storage.origin_visit_add( origin_url2, date=data.date_visit3, type=data.type_visit3 ) # when visit1_metadata = { "contents": 42, "directories": 22, } swh_storage.origin_visit_update( origin_url, origin_visit1.visit, status="full", metadata=visit1_metadata ) expected_origin_visit = origin_visit1.to_dict() expected_origin_visit.update( { "origin": origin_url, "visit": origin_visit1.visit, "date": data.date_visit2, "type": data.type_visit2, "metadata": visit1_metadata, "status": "full", "snapshot": data.snapshot["id"], } ) # when actual_origin_visit1 = swh_storage.origin_visit_get_by( origin_url, origin_visit1.visit ) # then assert actual_origin_visit1 == expected_origin_visit def test_origin_visit_get_by__unknown_origin(self, swh_storage): assert swh_storage.origin_visit_get_by("foo", 10) is None def test_origin_visit_upsert_new(self, swh_storage): # given origin_url = swh_storage.origin_add_one(data.origin2) # when swh_storage.origin_visit_upsert( [ OriginVisit.from_dict( { "origin": origin_url, "date": data.date_visit2, "visit": 123, "type": data.type_visit2, "status": "full", "metadata": None, "snapshot": None, } ), OriginVisit.from_dict( { "origin": origin_url, "date": "2018-01-01 23:00:00+00", "visit": 1234, "type": data.type_visit2, "status": "full", "metadata": None, "snapshot": None, } ), ] ) # then actual_origin_visits = list(swh_storage.origin_visit_get(origin_url)) assert actual_origin_visits == [ { "origin": origin_url, "date": data.date_visit2, "visit": 123, "type": data.type_visit2, "status": "full", "metadata": None, "snapshot": None, }, { "origin": origin_url, "date": data.date_visit3, "visit": 1234, "type": data.type_visit2, "status": "full", "metadata": None, "snapshot": None, }, ] data1 = { "origin": origin_url, "date": data.date_visit2, "visit": 123, "type": data.type_visit2, "status": "full", "metadata": None, "snapshot": None, } data2 = { "origin": origin_url, "date": data.date_visit3, "visit": 1234, "type": data.type_visit2, "status": "full", "metadata": None, "snapshot": None, } assert list(swh_storage.journal_writer.journal.objects) == [ ("origin", Origin.from_dict(data.origin2)), ("origin_visit", OriginVisit.from_dict(data1)), ("origin_visit", OriginVisit.from_dict(data2)), ] def test_origin_visit_upsert_existing(self, swh_storage): # given origin_url = swh_storage.origin_add_one(data.origin2) # when origin_visit1 = swh_storage.origin_visit_add( origin_url, date=data.date_visit2, type=data.type_visit1 ) swh_storage.origin_visit_upsert( [ OriginVisit.from_dict( { "origin": origin_url, "date": data.date_visit2, "visit": origin_visit1.visit, "type": data.type_visit1, "status": "full", "metadata": None, "snapshot": None, } ) ] ) # then assert origin_visit1.origin == origin_url assert origin_visit1.visit is not None actual_origin_visits = list(swh_storage.origin_visit_get(origin_url)) assert actual_origin_visits == [ { "origin": origin_url, "date": data.date_visit2, "visit": origin_visit1.visit, "type": data.type_visit1, "status": "full", "metadata": None, "snapshot": None, } ] data1 = { "origin": origin_url, "date": data.date_visit2, "visit": origin_visit1.visit, "type": data.type_visit1, "status": "ongoing", "metadata": None, "snapshot": None, } data2 = { "origin": origin_url, "date": data.date_visit2, "visit": origin_visit1.visit, "type": data.type_visit1, "status": "full", "metadata": None, "snapshot": None, } assert list(swh_storage.journal_writer.journal.objects) == [ ("origin", Origin.from_dict(data.origin2)), ("origin_visit", OriginVisit.from_dict(data1)), ("origin_visit", OriginVisit.from_dict(data2)), ] def test_origin_visit_upsert_missing_visit_id(self, swh_storage): # given origin_url = swh_storage.origin_add_one(data.origin2) # then with pytest.raises(StorageArgumentException, match="Missing visit id"): swh_storage.origin_visit_upsert( [ OriginVisit.from_dict( { "origin": origin_url, "date": data.date_visit2, "visit": None, # <- make the test raise "type": data.type_visit1, "status": "full", "metadata": None, "snapshot": None, } ) ] ) assert list(swh_storage.journal_writer.journal.objects) == [ ("origin", Origin.from_dict(data.origin2)) ] def test_origin_visit_get_by_no_result(self, swh_storage): swh_storage.origin_add([data.origin]) actual_origin_visit = swh_storage.origin_visit_get_by(data.origin["url"], 999) assert actual_origin_visit is None def test_origin_visit_get_latest(self, swh_storage): origin_url = swh_storage.origin_add_one(data.origin) ov1 = swh_storage.origin_visit_add( origin_url, date=data.date_visit1, type=data.type_visit1 ) ov2 = swh_storage.origin_visit_add( origin_url, date=data.date_visit2, type=data.type_visit2 ) # Add a visit with the same date as the previous one ov3 = swh_storage.origin_visit_add( origin_url, date=data.date_visit2, type=data.type_visit2 ) origin_visit1 = swh_storage.origin_visit_get_by(origin_url, ov1.visit) origin_visit2 = swh_storage.origin_visit_get_by(origin_url, ov2.visit) origin_visit3 = swh_storage.origin_visit_get_by(origin_url, ov3.visit) # Two visits, both with no snapshot assert origin_visit3 == swh_storage.origin_visit_get_latest(origin_url) assert ( swh_storage.origin_visit_get_latest(origin_url, require_snapshot=True) is None ) # Add snapshot to visit1; require_snapshot=True makes it return # visit1 and require_snapshot=False still returns visit2 swh_storage.snapshot_add([data.complete_snapshot]) swh_storage.origin_visit_update( origin_url, ov1.visit, status="ongoing", snapshot=data.complete_snapshot["id"], ) assert { **origin_visit1, "snapshot": data.complete_snapshot["id"], } == swh_storage.origin_visit_get_latest(origin_url, require_snapshot=True) assert origin_visit3 == swh_storage.origin_visit_get_latest(origin_url) # Status filter: all three visits are status=ongoing, so no visit # returned assert ( swh_storage.origin_visit_get_latest(origin_url, allowed_statuses=["full"]) is None ) # Mark the first visit as completed and check status filter again swh_storage.origin_visit_update(origin_url, ov1.visit, status="full") assert { **origin_visit1, "snapshot": data.complete_snapshot["id"], "status": "full", } == swh_storage.origin_visit_get_latest(origin_url, allowed_statuses=["full"]) assert origin_visit3 == swh_storage.origin_visit_get_latest(origin_url) # Add snapshot to visit2 and check that the new snapshot is returned swh_storage.snapshot_add([data.empty_snapshot]) swh_storage.origin_visit_update( origin_url, ov2.visit, status="ongoing", snapshot=data.empty_snapshot["id"] ) assert { **origin_visit2, "snapshot": data.empty_snapshot["id"], } == swh_storage.origin_visit_get_latest(origin_url, require_snapshot=True) assert origin_visit3 == swh_storage.origin_visit_get_latest(origin_url) # Check that the status filter is still working assert { **origin_visit1, "snapshot": data.complete_snapshot["id"], "status": "full", } == swh_storage.origin_visit_get_latest(origin_url, allowed_statuses=["full"]) # Add snapshot to visit3 (same date as visit2) swh_storage.snapshot_add([data.complete_snapshot]) swh_storage.origin_visit_update( origin_url, ov3.visit, status="ongoing", snapshot=data.complete_snapshot["id"], ) assert { **origin_visit1, "snapshot": data.complete_snapshot["id"], "status": "full", } == swh_storage.origin_visit_get_latest(origin_url, allowed_statuses=["full"]) assert { **origin_visit1, "snapshot": data.complete_snapshot["id"], "status": "full", } == swh_storage.origin_visit_get_latest( origin_url, allowed_statuses=["full"], require_snapshot=True ) assert { **origin_visit3, "snapshot": data.complete_snapshot["id"], } == swh_storage.origin_visit_get_latest(origin_url) assert { **origin_visit3, "snapshot": data.complete_snapshot["id"], } == swh_storage.origin_visit_get_latest(origin_url, require_snapshot=True) def test_person_fullname_unicity(self, swh_storage): # given (person injection through revisions for example) revision = data.revision # create a revision with same committer fullname but wo name and email revision2 = copy.deepcopy(data.revision2) revision2["committer"] = dict(revision["committer"]) revision2["committer"]["email"] = None revision2["committer"]["name"] = None swh_storage.revision_add([revision]) swh_storage.revision_add([revision2]) # when getting added revisions revisions = list(swh_storage.revision_get([revision["id"], revision2["id"]])) # then # check committers are the same assert revisions[0]["committer"] == revisions[1]["committer"] def test_snapshot_add_get_empty(self, swh_storage): origin_url = swh_storage.origin_add_one(data.origin) origin_visit1 = swh_storage.origin_visit_add( origin_url, date=data.date_visit1, type=data.type_visit1 ) visit_id = origin_visit1.visit actual_result = swh_storage.snapshot_add([data.empty_snapshot]) assert actual_result == {"snapshot:add": 1} swh_storage.origin_visit_update( origin_url, origin_visit1.visit, status="ongoing", snapshot=data.empty_snapshot["id"], ) by_id = swh_storage.snapshot_get(data.empty_snapshot["id"]) assert by_id == {**data.empty_snapshot, "next_branch": None} by_ov = swh_storage.snapshot_get_by_origin_visit(origin_url, visit_id) assert by_ov == {**data.empty_snapshot, "next_branch": None} data1 = { "origin": origin_url, "date": data.date_visit1, "visit": origin_visit1.visit, "type": data.type_visit1, "status": "ongoing", "metadata": None, "snapshot": None, } data2 = { "origin": origin_url, "date": data.date_visit1, "visit": origin_visit1.visit, "type": data.type_visit1, "status": "ongoing", "metadata": None, "snapshot": data.empty_snapshot["id"], } assert list(swh_storage.journal_writer.journal.objects) == [ ("origin", Origin.from_dict(data.origin)), ("origin_visit", OriginVisit.from_dict(data1)), ("snapshot", Snapshot.from_dict(data.empty_snapshot)), ("origin_visit", OriginVisit.from_dict(data2)), ] def test_snapshot_add_get_complete(self, swh_storage): origin_url = data.origin["url"] origin_url = swh_storage.origin_add_one(data.origin) origin_visit1 = swh_storage.origin_visit_add( origin_url, date=data.date_visit1, type=data.type_visit1 ) visit_id = origin_visit1.visit actual_result = swh_storage.snapshot_add([data.complete_snapshot]) swh_storage.origin_visit_update( origin_url, origin_visit1.visit, status="ongoing", snapshot=data.complete_snapshot["id"], ) assert actual_result == {"snapshot:add": 1} by_id = swh_storage.snapshot_get(data.complete_snapshot["id"]) assert by_id == {**data.complete_snapshot, "next_branch": None} by_ov = swh_storage.snapshot_get_by_origin_visit(origin_url, visit_id) assert by_ov == {**data.complete_snapshot, "next_branch": None} def test_snapshot_add_many(self, swh_storage): actual_result = swh_storage.snapshot_add( [data.snapshot, data.complete_snapshot] ) assert actual_result == {"snapshot:add": 2} assert { **data.complete_snapshot, "next_branch": None, } == swh_storage.snapshot_get(data.complete_snapshot["id"]) assert {**data.snapshot, "next_branch": None} == swh_storage.snapshot_get( data.snapshot["id"] ) swh_storage.refresh_stat_counters() assert swh_storage.stat_counters()["snapshot"] == 2 def test_snapshot_add_many_from_generator(self, swh_storage): def _snp_gen(): yield data.snapshot yield data.complete_snapshot actual_result = swh_storage.snapshot_add(_snp_gen()) assert actual_result == {"snapshot:add": 2} swh_storage.refresh_stat_counters() assert swh_storage.stat_counters()["snapshot"] == 2 def test_snapshot_add_many_incremental(self, swh_storage): actual_result = swh_storage.snapshot_add([data.complete_snapshot]) assert actual_result == {"snapshot:add": 1} actual_result2 = swh_storage.snapshot_add( [data.snapshot, data.complete_snapshot] ) assert actual_result2 == {"snapshot:add": 1} assert { **data.complete_snapshot, "next_branch": None, } == swh_storage.snapshot_get(data.complete_snapshot["id"]) assert {**data.snapshot, "next_branch": None} == swh_storage.snapshot_get( data.snapshot["id"] ) def test_snapshot_add_twice(self, swh_storage): actual_result = swh_storage.snapshot_add([data.empty_snapshot]) assert actual_result == {"snapshot:add": 1} assert list(swh_storage.journal_writer.journal.objects) == [ ("snapshot", Snapshot.from_dict(data.empty_snapshot)) ] actual_result = swh_storage.snapshot_add([data.snapshot]) assert actual_result == {"snapshot:add": 1} assert list(swh_storage.journal_writer.journal.objects) == [ ("snapshot", Snapshot.from_dict(data.empty_snapshot)), ("snapshot", Snapshot.from_dict(data.snapshot)), ] def test_snapshot_add_validation(self, swh_storage): snap = copy.deepcopy(data.snapshot) snap["branches"][b"foo"] = {"target_type": "revision"} with pytest.raises(StorageArgumentException, match="target"): swh_storage.snapshot_add([snap]) snap = copy.deepcopy(data.snapshot) snap["branches"][b"foo"] = {"target": b"\x42" * 20} with pytest.raises(StorageArgumentException, match="target_type"): swh_storage.snapshot_add([snap]) def test_snapshot_add_count_branches(self, swh_storage): actual_result = swh_storage.snapshot_add([data.complete_snapshot]) assert actual_result == {"snapshot:add": 1} snp_id = data.complete_snapshot["id"] snp_size = swh_storage.snapshot_count_branches(snp_id) expected_snp_size = { "alias": 1, "content": 1, "directory": 2, "release": 1, "revision": 1, "snapshot": 1, None: 1, } assert snp_size == expected_snp_size def test_snapshot_add_get_paginated(self, swh_storage): swh_storage.snapshot_add([data.complete_snapshot]) snp_id = data.complete_snapshot["id"] branches = data.complete_snapshot["branches"] branch_names = list(sorted(branches)) # Test branch_from snapshot = swh_storage.snapshot_get_branches(snp_id, branches_from=b"release") rel_idx = branch_names.index(b"release") expected_snapshot = { "id": snp_id, "branches": {name: branches[name] for name in branch_names[rel_idx:]}, "next_branch": None, } assert snapshot == expected_snapshot # Test branches_count snapshot = swh_storage.snapshot_get_branches(snp_id, branches_count=1) expected_snapshot = { "id": snp_id, "branches": {branch_names[0]: branches[branch_names[0]],}, "next_branch": b"content", } assert snapshot == expected_snapshot # test branch_from + branches_count snapshot = swh_storage.snapshot_get_branches( snp_id, branches_from=b"directory", branches_count=3 ) dir_idx = branch_names.index(b"directory") expected_snapshot = { "id": snp_id, "branches": { name: branches[name] for name in branch_names[dir_idx : dir_idx + 3] }, "next_branch": branch_names[dir_idx + 3], } assert snapshot == expected_snapshot def test_snapshot_add_get_filtered(self, swh_storage): origin_url = swh_storage.origin_add_one(data.origin) origin_visit1 = swh_storage.origin_visit_add( origin_url, date=data.date_visit1, type=data.type_visit1 ) swh_storage.snapshot_add([data.complete_snapshot]) swh_storage.origin_visit_update( origin_url, origin_visit1.visit, status="ongoing", snapshot=data.complete_snapshot["id"], ) snp_id = data.complete_snapshot["id"] branches = data.complete_snapshot["branches"] snapshot = swh_storage.snapshot_get_branches( snp_id, target_types=["release", "revision"] ) expected_snapshot = { "id": snp_id, "branches": { name: tgt for name, tgt in branches.items() if tgt and tgt["target_type"] in ["release", "revision"] }, "next_branch": None, } assert snapshot == expected_snapshot snapshot = swh_storage.snapshot_get_branches(snp_id, target_types=["alias"]) expected_snapshot = { "id": snp_id, "branches": { name: tgt for name, tgt in branches.items() if tgt and tgt["target_type"] == "alias" }, "next_branch": None, } assert snapshot == expected_snapshot def test_snapshot_add_get_filtered_and_paginated(self, swh_storage): swh_storage.snapshot_add([data.complete_snapshot]) snp_id = data.complete_snapshot["id"] branches = data.complete_snapshot["branches"] branch_names = list(sorted(branches)) # Test branch_from snapshot = swh_storage.snapshot_get_branches( snp_id, target_types=["directory", "release"], branches_from=b"directory2" ) expected_snapshot = { "id": snp_id, "branches": {name: branches[name] for name in (b"directory2", b"release")}, "next_branch": None, } assert snapshot == expected_snapshot # Test branches_count snapshot = swh_storage.snapshot_get_branches( snp_id, target_types=["directory", "release"], branches_count=1 ) expected_snapshot = { "id": snp_id, "branches": {b"directory": branches[b"directory"]}, "next_branch": b"directory2", } assert snapshot == expected_snapshot # Test branches_count snapshot = swh_storage.snapshot_get_branches( snp_id, target_types=["directory", "release"], branches_count=2 ) expected_snapshot = { "id": snp_id, "branches": { name: branches[name] for name in (b"directory", b"directory2") }, "next_branch": b"release", } assert snapshot == expected_snapshot # test branch_from + branches_count snapshot = swh_storage.snapshot_get_branches( snp_id, target_types=["directory", "release"], branches_from=b"directory2", branches_count=1, ) dir_idx = branch_names.index(b"directory2") expected_snapshot = { "id": snp_id, "branches": {branch_names[dir_idx]: branches[branch_names[dir_idx]],}, "next_branch": b"release", } assert snapshot == expected_snapshot def test_snapshot_add_get(self, swh_storage): origin_url = swh_storage.origin_add_one(data.origin) origin_visit1 = swh_storage.origin_visit_add( origin_url, date=data.date_visit1, type=data.type_visit1 ) visit_id = origin_visit1.visit swh_storage.snapshot_add([data.snapshot]) swh_storage.origin_visit_update( origin_url, origin_visit1.visit, status="ongoing", snapshot=data.snapshot["id"], ) by_id = swh_storage.snapshot_get(data.snapshot["id"]) assert by_id == {**data.snapshot, "next_branch": None} by_ov = swh_storage.snapshot_get_by_origin_visit(origin_url, visit_id) assert by_ov == {**data.snapshot, "next_branch": None} origin_visit_info = swh_storage.origin_visit_get_by(origin_url, visit_id) assert origin_visit_info["snapshot"] == data.snapshot["id"] def test_snapshot_add_nonexistent_visit(self, swh_storage): origin_url = swh_storage.origin_add_one(data.origin) # unknown visit visit_id = 54164461156 swh_storage.journal_writer.journal.objects[:] = [] swh_storage.snapshot_add([data.snapshot]) with pytest.raises(StorageArgumentException): swh_storage.origin_visit_update( origin_url, visit_id, status="ongoing", snapshot=data.snapshot["id"] ) assert list(swh_storage.journal_writer.journal.objects) == [ ("snapshot", Snapshot.from_dict(data.snapshot)) ] def test_snapshot_add_twice__by_origin_visit(self, swh_storage): origin_url = swh_storage.origin_add_one(data.origin) origin_visit1 = swh_storage.origin_visit_add( origin_url, date=data.date_visit1, type=data.type_visit1 ) visit1_id = origin_visit1.visit swh_storage.snapshot_add([data.snapshot]) swh_storage.origin_visit_update( origin_url, origin_visit1.visit, status="ongoing", snapshot=data.snapshot["id"], ) by_ov1 = swh_storage.snapshot_get_by_origin_visit(origin_url, visit1_id) assert by_ov1 == {**data.snapshot, "next_branch": None} origin_visit2 = swh_storage.origin_visit_add( origin_url, date=data.date_visit2, type=data.type_visit2 ) visit2_id = origin_visit2.visit swh_storage.snapshot_add([data.snapshot]) swh_storage.origin_visit_update( origin_url, origin_visit2.visit, status="ongoing", snapshot=data.snapshot["id"], ) by_ov2 = swh_storage.snapshot_get_by_origin_visit(origin_url, visit2_id) assert by_ov2 == {**data.snapshot, "next_branch": None} data1 = { "origin": origin_url, "date": data.date_visit1, "visit": origin_visit1.visit, "type": data.type_visit1, "status": "ongoing", "metadata": None, "snapshot": None, } data2 = { "origin": origin_url, "date": data.date_visit1, "visit": origin_visit1.visit, "type": data.type_visit1, "status": "ongoing", "metadata": None, "snapshot": data.snapshot["id"], } data3 = { "origin": origin_url, "date": data.date_visit2, "visit": origin_visit2.visit, "type": data.type_visit2, "status": "ongoing", "metadata": None, "snapshot": None, } data4 = { "origin": origin_url, "date": data.date_visit2, "visit": origin_visit2.visit, "type": data.type_visit2, "status": "ongoing", "metadata": None, "snapshot": data.snapshot["id"], } assert list(swh_storage.journal_writer.journal.objects) == [ ("origin", Origin.from_dict(data.origin)), ("origin_visit", OriginVisit.from_dict(data1)), ("snapshot", Snapshot.from_dict(data.snapshot)), ("origin_visit", OriginVisit.from_dict(data2)), ("origin_visit", OriginVisit.from_dict(data3)), ("origin_visit", OriginVisit.from_dict(data4)), ] def test_snapshot_get_latest(self, swh_storage): origin_url = swh_storage.origin_add_one(data.origin) origin_visit1 = swh_storage.origin_visit_add( origin_url, date=data.date_visit1, type=data.type_visit1 ) origin_visit2 = swh_storage.origin_visit_add( origin_url, date=data.date_visit2, type=data.type_visit2 ) # Add a visit with the same date as the previous one origin_visit3 = swh_storage.origin_visit_add( origin_url, date=data.date_visit2, type=data.type_visit3 ) # Two visits, both with no snapshot: latest snapshot is None assert swh_storage.snapshot_get_latest(origin_url) is None # Add snapshot to visit1, latest snapshot = visit 1 snapshot swh_storage.snapshot_add([data.complete_snapshot]) swh_storage.origin_visit_update( origin_url, origin_visit1.visit, status="ongoing", snapshot=data.complete_snapshot["id"], ) assert { **data.complete_snapshot, "next_branch": None, } == swh_storage.snapshot_get_latest(origin_url) # Status filter: all three visits are status=ongoing, so no snapshot # returned assert ( swh_storage.snapshot_get_latest(origin_url, allowed_statuses=["full"]) is None ) # Mark the first visit as completed and check status filter again swh_storage.origin_visit_update(origin_url, origin_visit1.visit, status="full") assert { **data.complete_snapshot, "next_branch": None, } == swh_storage.snapshot_get_latest(origin_url, allowed_statuses=["full"]) # Add snapshot to visit2 and check that the new snapshot is returned swh_storage.snapshot_add([data.empty_snapshot]) swh_storage.origin_visit_update( origin_url, origin_visit2.visit, status="ongoing", snapshot=data.empty_snapshot["id"], ) assert { **data.empty_snapshot, "next_branch": None, } == swh_storage.snapshot_get_latest(origin_url) # Check that the status filter is still working assert { **data.complete_snapshot, "next_branch": None, } == swh_storage.snapshot_get_latest(origin_url, allowed_statuses=["full"]) # Add snapshot to visit3 (same date as visit2) and check that # the new snapshot is returned swh_storage.snapshot_add([data.complete_snapshot]) swh_storage.origin_visit_update( origin_url, origin_visit3.visit, status="ongoing", snapshot=data.complete_snapshot["id"], ) assert { **data.complete_snapshot, "next_branch": None, } == swh_storage.snapshot_get_latest(origin_url) def test_snapshot_get_latest__missing_snapshot(self, swh_storage): origin_url = swh_storage.origin_add_one(data.origin) assert swh_storage.snapshot_get_latest(origin_url) is None origin_visit1 = swh_storage.origin_visit_add( origin_url, date=data.date_visit1, type=data.type_visit1 ) origin_visit2 = swh_storage.origin_visit_add( origin_url, date=data.date_visit2, type=data.type_visit2 ) # Two visits, both with no snapshot: latest snapshot is None assert swh_storage.snapshot_get_latest(origin_url) is None # Add unknown snapshot to visit1, check that the inconsistency is # detected swh_storage.origin_visit_update( origin_url, origin_visit1.visit, status="ongoing", snapshot=data.complete_snapshot["id"], ) with pytest.raises(Exception): # XXX: should the exception be more specific than this? swh_storage.snapshot_get_latest(origin_url) # Status filter: both visits are status=ongoing, so no snapshot # returned assert ( swh_storage.snapshot_get_latest(origin_url, allowed_statuses=["full"]) is None ) # Mark the first visit as completed and check status filter again swh_storage.origin_visit_update(origin_url, origin_visit1.visit, status="full") with pytest.raises(Exception): # XXX: should the exception be more specific than this? swh_storage.snapshot_get_latest(origin_url, allowed_statuses=["full"]), # Actually add the snapshot and check status filter again swh_storage.snapshot_add([data.complete_snapshot]) assert { **data.complete_snapshot, "next_branch": None, } == swh_storage.snapshot_get_latest(origin_url) # Add unknown snapshot to visit2 and check that the inconsistency # is detected swh_storage.origin_visit_update( origin_url, origin_visit2.visit, status="ongoing", snapshot=data.snapshot["id"], ) with pytest.raises(Exception): # XXX: should the exception be more specific than this? swh_storage.snapshot_get_latest(origin_url) # Actually add that snapshot and check that the new one is returned swh_storage.snapshot_add([data.snapshot]) assert { **data.snapshot, "next_branch": None, } == swh_storage.snapshot_get_latest(origin_url) def test_snapshot_get_random(self, swh_storage): swh_storage.snapshot_add( [data.snapshot, data.empty_snapshot, data.complete_snapshot] ) assert swh_storage.snapshot_get_random() in { data.snapshot["id"], data.empty_snapshot["id"], data.complete_snapshot["id"], } def test_snapshot_missing(self, swh_storage): snap = data.snapshot missing_snap = data.empty_snapshot snapshots = [snap["id"], missing_snap["id"]] swh_storage.snapshot_add([snap]) missing_snapshots = swh_storage.snapshot_missing(snapshots) assert list(missing_snapshots) == [missing_snap["id"]] def test_stat_counters(self, swh_storage): expected_keys = ["content", "directory", "origin", "revision"] # Initially, all counters are 0 swh_storage.refresh_stat_counters() counters = swh_storage.stat_counters() assert set(expected_keys) <= set(counters) for key in expected_keys: assert counters[key] == 0 # Add a content. Only the content counter should increase. swh_storage.content_add([data.cont]) swh_storage.refresh_stat_counters() counters = swh_storage.stat_counters() assert set(expected_keys) <= set(counters) for key in expected_keys: if key != "content": assert counters[key] == 0 assert counters["content"] == 1 # Add other objects. Check their counter increased as well. origin_url = swh_storage.origin_add_one(data.origin2) origin_visit1 = swh_storage.origin_visit_add( origin_url, date=data.date_visit2, type=data.type_visit2 ) swh_storage.snapshot_add([data.snapshot]) swh_storage.origin_visit_update( origin_url, origin_visit1.visit, status="ongoing", snapshot=data.snapshot["id"], ) swh_storage.directory_add([data.dir]) swh_storage.revision_add([data.revision]) swh_storage.release_add([data.release]) swh_storage.refresh_stat_counters() counters = swh_storage.stat_counters() assert counters["content"] == 1 assert counters["directory"] == 1 assert counters["snapshot"] == 1 assert counters["origin"] == 1 assert counters["origin_visit"] == 1 assert counters["revision"] == 1 assert counters["release"] == 1 assert counters["snapshot"] == 1 if "person" in counters: assert counters["person"] == 3 def test_content_find_ctime(self, swh_storage): cont = data.cont.copy() del cont["data"] ctime = now() cont["ctime"] = ctime swh_storage.content_add_metadata([cont]) actually_present = swh_storage.content_find({"sha1": cont["sha1"]}) # check ctime up to one second dt = actually_present[0]["ctime"] - ctime assert abs(dt.total_seconds()) <= 1 del actually_present[0]["ctime"] assert actually_present[0] == { "sha1": cont["sha1"], "sha256": cont["sha256"], "sha1_git": cont["sha1_git"], "blake2s256": cont["blake2s256"], "length": cont["length"], "status": "visible", } def test_content_find_with_present_content(self, swh_storage): # 1. with something to find cont = data.cont swh_storage.content_add([cont, data.cont2]) actually_present = swh_storage.content_find({"sha1": cont["sha1"]}) assert 1 == len(actually_present) actually_present[0].pop("ctime") assert actually_present[0] == { "sha1": cont["sha1"], "sha256": cont["sha256"], "sha1_git": cont["sha1_git"], "blake2s256": cont["blake2s256"], "length": cont["length"], "status": "visible", } # 2. with something to find actually_present = swh_storage.content_find({"sha1_git": cont["sha1_git"]}) assert 1 == len(actually_present) actually_present[0].pop("ctime") assert actually_present[0] == { "sha1": cont["sha1"], "sha256": cont["sha256"], "sha1_git": cont["sha1_git"], "blake2s256": cont["blake2s256"], "length": cont["length"], "status": "visible", } # 3. with something to find actually_present = swh_storage.content_find({"sha256": cont["sha256"]}) assert 1 == len(actually_present) actually_present[0].pop("ctime") assert actually_present[0] == { "sha1": cont["sha1"], "sha256": cont["sha256"], "sha1_git": cont["sha1_git"], "blake2s256": cont["blake2s256"], "length": cont["length"], "status": "visible", } # 4. with something to find actually_present = swh_storage.content_find( { "sha1": cont["sha1"], "sha1_git": cont["sha1_git"], "sha256": cont["sha256"], "blake2s256": cont["blake2s256"], } ) assert 1 == len(actually_present) actually_present[0].pop("ctime") assert actually_present[0] == { "sha1": cont["sha1"], "sha256": cont["sha256"], "sha1_git": cont["sha1_git"], "blake2s256": cont["blake2s256"], "length": cont["length"], "status": "visible", } def test_content_find_with_non_present_content(self, swh_storage): # 1. with something that does not exist missing_cont = data.missing_cont actually_present = swh_storage.content_find({"sha1": missing_cont["sha1"]}) assert actually_present == [] # 2. with something that does not exist actually_present = swh_storage.content_find( {"sha1_git": missing_cont["sha1_git"]} ) assert actually_present == [] # 3. with something that does not exist actually_present = swh_storage.content_find({"sha256": missing_cont["sha256"]}) assert actually_present == [] def test_content_find_with_duplicate_input(self, swh_storage): cont1 = data.cont duplicate_cont = cont1.copy() # Create fake data with colliding sha256 and blake2s256 sha1_array = bytearray(duplicate_cont["sha1"]) sha1_array[0] += 1 duplicate_cont["sha1"] = bytes(sha1_array) sha1git_array = bytearray(duplicate_cont["sha1_git"]) sha1git_array[0] += 1 duplicate_cont["sha1_git"] = bytes(sha1git_array) # Inject the data swh_storage.content_add([cont1, duplicate_cont]) finder = { "blake2s256": duplicate_cont["blake2s256"], "sha256": duplicate_cont["sha256"], } actual_result = list(swh_storage.content_find(finder)) cont1.pop("data") duplicate_cont.pop("data") actual_result[0].pop("ctime") actual_result[1].pop("ctime") expected_result = [cont1, duplicate_cont] for result in expected_result: assert result in actual_result def test_content_find_with_duplicate_sha256(self, swh_storage): cont1 = data.cont duplicate_cont = cont1.copy() # Create fake data with colliding sha256 for hashalgo in ("sha1", "sha1_git", "blake2s256"): value = bytearray(duplicate_cont[hashalgo]) value[0] += 1 duplicate_cont[hashalgo] = bytes(value) swh_storage.content_add([cont1, duplicate_cont]) finder = {"sha256": duplicate_cont["sha256"]} actual_result = list(swh_storage.content_find(finder)) assert len(actual_result) == 2 cont1.pop("data") duplicate_cont.pop("data") actual_result[0].pop("ctime") actual_result[1].pop("ctime") expected_result = [cont1, duplicate_cont] assert expected_result == sorted(actual_result, key=lambda x: x["sha1"]) # Find with both sha256 and blake2s256 finder = { "sha256": duplicate_cont["sha256"], "blake2s256": duplicate_cont["blake2s256"], } actual_result = list(swh_storage.content_find(finder)) assert len(actual_result) == 1 actual_result[0].pop("ctime") expected_result = [duplicate_cont] assert actual_result[0] == duplicate_cont def test_content_find_with_duplicate_blake2s256(self, swh_storage): cont1 = data.cont duplicate_cont = cont1.copy() # Create fake data with colliding sha256 and blake2s256 sha1_array = bytearray(duplicate_cont["sha1"]) sha1_array[0] += 1 duplicate_cont["sha1"] = bytes(sha1_array) sha1git_array = bytearray(duplicate_cont["sha1_git"]) sha1git_array[0] += 1 duplicate_cont["sha1_git"] = bytes(sha1git_array) sha256_array = bytearray(duplicate_cont["sha256"]) sha256_array[0] += 1 duplicate_cont["sha256"] = bytes(sha256_array) swh_storage.content_add([cont1, duplicate_cont]) finder = {"blake2s256": duplicate_cont["blake2s256"]} actual_result = list(swh_storage.content_find(finder)) cont1.pop("data") duplicate_cont.pop("data") actual_result[0].pop("ctime") actual_result[1].pop("ctime") expected_result = [cont1, duplicate_cont] for result in expected_result: assert result in actual_result # Find with both sha256 and blake2s256 finder = { "sha256": duplicate_cont["sha256"], "blake2s256": duplicate_cont["blake2s256"], } actual_result = list(swh_storage.content_find(finder)) actual_result[0].pop("ctime") expected_result = [duplicate_cont] assert expected_result == actual_result def test_content_find_bad_input(self, swh_storage): # 1. with bad input with pytest.raises(StorageArgumentException): swh_storage.content_find({}) # empty is bad # 2. with bad input with pytest.raises(StorageArgumentException): swh_storage.content_find({"unknown-sha1": "something"}) # not the right key def test_object_find_by_sha1_git(self, swh_storage): sha1_gits = [b"00000000000000000000"] expected = { b"00000000000000000000": [], } swh_storage.content_add([data.cont]) sha1_gits.append(data.cont["sha1_git"]) expected[data.cont["sha1_git"]] = [ {"sha1_git": data.cont["sha1_git"], "type": "content",} ] swh_storage.directory_add([data.dir]) sha1_gits.append(data.dir["id"]) expected[data.dir["id"]] = [{"sha1_git": data.dir["id"], "type": "directory",}] swh_storage.revision_add([data.revision]) sha1_gits.append(data.revision["id"]) expected[data.revision["id"]] = [ {"sha1_git": data.revision["id"], "type": "revision",} ] swh_storage.release_add([data.release]) sha1_gits.append(data.release["id"]) expected[data.release["id"]] = [ {"sha1_git": data.release["id"], "type": "release",} ] ret = swh_storage.object_find_by_sha1_git(sha1_gits) assert expected == ret - def test_tool_add(self, swh_storage): - tool = { - "name": "some-unknown-tool", - "version": "some-version", - "configuration": {"debian-package": "some-package"}, - } - - actual_tool = swh_storage.tool_get(tool) - assert actual_tool is None # does not exist - - # add it - actual_tools = swh_storage.tool_add([tool]) - - assert len(actual_tools) == 1 - actual_tool = actual_tools[0] - assert actual_tool is not None # now it exists - new_id = actual_tool.pop("id") - assert actual_tool == tool - - actual_tools2 = swh_storage.tool_add([tool]) - actual_tool2 = actual_tools2[0] - assert actual_tool2 is not None # now it exists - new_id2 = actual_tool2.pop("id") - - assert new_id == new_id2 - assert actual_tool == actual_tool2 - - def test_tool_add_multiple(self, swh_storage): - tool = { - "name": "some-unknown-tool", - "version": "some-version", - "configuration": {"debian-package": "some-package"}, - } - - actual_tools = list(swh_storage.tool_add([tool])) - assert len(actual_tools) == 1 - - new_tools = [ - tool, - {"name": "yet-another-tool", "version": "version", "configuration": {},}, - ] - - actual_tools = swh_storage.tool_add(new_tools) - assert len(actual_tools) == 2 - - # order not guaranteed, so we iterate over results to check - for tool in actual_tools: - _id = tool.pop("id") - assert _id is not None - assert tool in new_tools - - def test_tool_get_missing(self, swh_storage): - tool = { - "name": "unknown-tool", - "version": "3.1.0rc2-31-ga2cbb8c", - "configuration": {"command_line": "nomossa "}, - } - - actual_tool = swh_storage.tool_get(tool) - - assert actual_tool is None - - def test_tool_metadata_get_missing_context(self, swh_storage): - tool = { - "name": "swh-metadata-translator", - "version": "0.0.1", - "configuration": {"context": "unknown-context"}, - } - - actual_tool = swh_storage.tool_get(tool) - - assert actual_tool is None + def test_metadata_fetcher_add_get(self, swh_storage): + actual_fetcher = swh_storage.metadata_fetcher_get( + data.metadata_fetcher["name"], data.metadata_fetcher["version"] + ) + assert actual_fetcher is None # does not exist - def test_tool_metadata_get(self, swh_storage): - tool = { - "name": "swh-metadata-translator", - "version": "0.0.1", - "configuration": {"type": "local", "context": "npm"}, - } - expected_tool = swh_storage.tool_add([tool])[0] + swh_storage.metadata_fetcher_add(**data.metadata_fetcher) - # when - actual_tool = swh_storage.tool_get(tool) + res = swh_storage.metadata_fetcher_get( + data.metadata_fetcher["name"], data.metadata_fetcher["version"] + ) - # then - assert expected_tool == actual_tool + assert res is not data.metadata_fetcher + assert res == data.metadata_fetcher - def test_metadata_provider_get(self, swh_storage): - # given - no_provider = swh_storage.metadata_provider_get(6459456445615) - assert no_provider is None - # when - provider_id = swh_storage.metadata_provider_add( - data.provider["name"], - data.provider["type"], - data.provider["url"], - data.provider["metadata"], + def test_metadata_authority_add_get(self, swh_storage): + actual_authority = swh_storage.metadata_authority_get( + data.metadata_authority["type"], data.metadata_authority["url"] ) + assert actual_authority is None # does not exist - actual_provider = swh_storage.metadata_provider_get(provider_id) - expected_provider = { - "provider_name": data.provider["name"], - "provider_url": data.provider["url"], - } - # then - del actual_provider["id"] - assert actual_provider, expected_provider + swh_storage.metadata_authority_add(**data.metadata_authority) - def test_metadata_provider_get_by(self, swh_storage): - # given - no_provider = swh_storage.metadata_provider_get_by( - { - "provider_name": data.provider["name"], - "provider_url": data.provider["url"], - } - ) - assert no_provider is None - # when - provider_id = swh_storage.metadata_provider_add( - data.provider["name"], - data.provider["type"], - data.provider["url"], - data.provider["metadata"], + res = swh_storage.metadata_authority_get( + data.metadata_authority["type"], data.metadata_authority["url"] ) - actual_provider = swh_storage.metadata_provider_get_by( - { - "provider_name": data.provider["name"], - "provider_url": data.provider["url"], - } - ) - # then - assert provider_id, actual_provider["id"] + assert res is not data.metadata_authority + assert res == data.metadata_authority def test_origin_metadata_add(self, swh_storage): - # given origin = data.origin + fetcher = data.metadata_fetcher + authority = data.metadata_authority swh_storage.origin_add([origin])[0] - tools = swh_storage.tool_add([data.metadata_tool]) - tool = tools[0] + swh_storage.metadata_fetcher_add(**fetcher) + swh_storage.metadata_authority_add(**authority) - swh_storage.metadata_provider_add( - data.provider["name"], - data.provider["type"], - data.provider["url"], - data.provider["metadata"], - ) - provider = swh_storage.metadata_provider_get_by( - { - "provider_name": data.provider["name"], - "provider_url": data.provider["url"], - } - ) + swh_storage.origin_metadata_add(**data.origin_metadata) + swh_storage.origin_metadata_add(**data.origin_metadata2) - # when adding for the same origin 2 metadatas - n_om = len(list(swh_storage.origin_metadata_get_by(origin["url"]))) - swh_storage.origin_metadata_add( - origin["url"], - data.origin_metadata["discovery_date"], - provider["id"], - tool["id"], - data.origin_metadata["metadata"], - ) - swh_storage.origin_metadata_add( - origin["url"], - "2015-01-01 23:00:00+00", - provider["id"], - tool["id"], - data.origin_metadata2["metadata"], + swh_storage.origin_metadata_get(origin["url"], authority) + + assert [data.origin_metadata, data.origin_metadata2] == list( + sorted( + swh_storage.origin_metadata_get(origin["url"], authority), + key=lambda x: x["discovery_date"], + ) ) - n_actual_om = len(list(swh_storage.origin_metadata_get_by(origin["url"]))) - # then - assert n_actual_om == n_om + 2 def test_origin_metadata_get(self, swh_storage): - # given - origin_url = data.origin["url"] + authority = data.metadata_authority + fetcher = data.metadata_fetcher + authority2 = data.metadata_authority2 + fetcher2 = data.metadata_fetcher2 + origin_url1 = data.origin["url"] origin_url2 = data.origin2["url"] swh_storage.origin_add([data.origin]) swh_storage.origin_add([data.origin2]) - swh_storage.metadata_provider_add( - data.provider["name"], - data.provider["type"], - data.provider["url"], - data.provider["metadata"], - ) - provider = swh_storage.metadata_provider_get_by( - { - "provider_name": data.provider["name"], - "provider_url": data.provider["url"], - } - ) - tool = swh_storage.tool_add([data.metadata_tool])[0] - # when adding for the same origin 2 metadatas - swh_storage.origin_metadata_add( - origin_url, - data.origin_metadata["discovery_date"], - provider["id"], - tool["id"], - data.origin_metadata["metadata"], - ) - swh_storage.origin_metadata_add( - origin_url2, - data.origin_metadata2["discovery_date"], - provider["id"], - tool["id"], - data.origin_metadata2["metadata"], - ) - swh_storage.origin_metadata_add( - origin_url, - data.origin_metadata2["discovery_date"], - provider["id"], - tool["id"], - data.origin_metadata2["metadata"], - ) - all_metadatas = list( + origin1_metadata1 = data.origin_metadata + origin1_metadata2 = data.origin_metadata2 + origin1_metadata3 = data.origin_metadata3 + origin2_metadata = {**data.origin_metadata2, "origin_url": origin_url2} + + swh_storage.metadata_authority_add(**authority) + swh_storage.metadata_fetcher_add(**fetcher) + swh_storage.metadata_authority_add(**authority2) + swh_storage.metadata_fetcher_add(**fetcher2) + + swh_storage.origin_metadata_add(**origin1_metadata1) + swh_storage.origin_metadata_add(**origin1_metadata2) + swh_storage.origin_metadata_add(**origin1_metadata3) + swh_storage.origin_metadata_add(**origin2_metadata) + + assert [origin1_metadata1, origin1_metadata2] == list( sorted( - swh_storage.origin_metadata_get_by(origin_url), + swh_storage.origin_metadata_get(origin_url1, authority), key=lambda x: x["discovery_date"], ) ) - metadatas_for_origin2 = list(swh_storage.origin_metadata_get_by(origin_url2)) - expected_results = [ - { - "origin_url": origin_url, - "discovery_date": datetime.datetime( - 2015, 1, 1, 23, 0, tzinfo=datetime.timezone.utc - ), - "metadata": {"name": "test_origin_metadata", "version": "0.0.1"}, - "provider_id": provider["id"], - "provider_name": "hal", - "provider_type": "deposit-client", - "provider_url": "http:///hal/inria", - "tool_id": tool["id"], - }, - { - "origin_url": origin_url, - "discovery_date": datetime.datetime( - 2017, 1, 1, 23, 0, tzinfo=datetime.timezone.utc - ), - "metadata": {"name": "test_origin_metadata", "version": "0.0.1"}, - "provider_id": provider["id"], - "provider_name": "hal", - "provider_type": "deposit-client", - "provider_url": "http:///hal/inria", - "tool_id": tool["id"], - }, - ] - - # then - assert len(all_metadatas) == 2 - assert len(metadatas_for_origin2) == 1 - assert all_metadatas == expected_results - - def test_metadata_provider_add(self, swh_storage): - provider = { - "provider_name": "swMATH", - "provider_type": "registry", - "provider_url": "http://www.swmath.org/", - "metadata": { - "email": "contact@swmath.org", - "license": "All rights reserved", - }, - } - provider["id"] = provider_id = swh_storage.metadata_provider_add(**provider) - assert provider == swh_storage.metadata_provider_get_by( - {"provider_name": "swMATH", "provider_url": "http://www.swmath.org/"} - ) - assert provider == swh_storage.metadata_provider_get(provider_id) - - def test_metadata_provider_add_idempotent(self, swh_storage): - provider = { - "provider_name": "swMATH", - "provider_type": "registry", - "provider_url": "http://www.swmath.org/", - "metadata": { - "email": "contact@swmath.org", - "license": "All rights reserved", - }, - } - provider_id = swh_storage.metadata_provider_add(**provider) - expected_provider = {**provider, "id": provider_id} - assert expected_provider == swh_storage.metadata_provider_get_by( - {"provider_name": "swMATH", "provider_url": "http://www.swmath.org/"} - ) - assert expected_provider == swh_storage.metadata_provider_get(provider_id) - - provider_id2 = swh_storage.metadata_provider_add(**provider) - assert provider_id2 == provider_id - - def test_origin_metadata_get_by_provider_type(self, swh_storage): - # given - origin_url = data.origin["url"] - origin_url2 = data.origin2["url"] - swh_storage.origin_add([data.origin]) - swh_storage.origin_add([data.origin2]) - provider1_id = swh_storage.metadata_provider_add( - data.provider["name"], - data.provider["type"], - data.provider["url"], - data.provider["metadata"], - ) - provider1 = swh_storage.metadata_provider_get_by( - { - "provider_name": data.provider["name"], - "provider_url": data.provider["url"], - } + assert [origin1_metadata3] == list( + sorted( + swh_storage.origin_metadata_get(origin_url1, authority2), + key=lambda x: x["discovery_date"], + ) ) - assert provider1 == swh_storage.metadata_provider_get(provider1_id) - provider2_id = swh_storage.metadata_provider_add( - "swMATH", - "registry", - "http://www.swmath.org/", - {"email": "contact@swmath.org", "license": "All rights reserved"}, - ) - provider2 = swh_storage.metadata_provider_get_by( - {"provider_name": "swMATH", "provider_url": "http://www.swmath.org/"} + assert [origin2_metadata] == list( + swh_storage.origin_metadata_get(origin_url2, authority) ) - assert provider2 == swh_storage.metadata_provider_get(provider2_id) - - # using the only tool now inserted in the data.sql, but for this - # provider should be a crawler tool (not yet implemented) - tool = swh_storage.tool_add([data.metadata_tool])[0] - - # when adding for the same origin 2 metadatas - swh_storage.origin_metadata_add( - origin_url, - data.origin_metadata["discovery_date"], - provider1["id"], - tool["id"], - data.origin_metadata["metadata"], - ) - swh_storage.origin_metadata_add( - origin_url2, - data.origin_metadata2["discovery_date"], - provider2["id"], - tool["id"], - data.origin_metadata2["metadata"], - ) - provider_type = "registry" - m_by_provider = list( - swh_storage.origin_metadata_get_by(origin_url2, provider_type) - ) - for item in m_by_provider: - if "id" in item: - del item["id"] - expected_results = [ - { - "origin_url": origin_url2, - "discovery_date": datetime.datetime( - 2017, 1, 1, 23, 0, tzinfo=datetime.timezone.utc - ), - "metadata": {"name": "test_origin_metadata", "version": "0.0.1"}, - "provider_id": provider2["id"], - "provider_name": "swMATH", - "provider_type": provider_type, - "provider_url": "http://www.swmath.org/", - "tool_id": tool["id"], - } - ] - # then - - assert len(m_by_provider) == 1 - assert m_by_provider == expected_results class TestStorageGeneratedData: def test_generate_content_get(self, swh_storage, swh_contents): contents_with_data = [c for c in swh_contents if c["status"] != "absent"] # input the list of sha1s we want from storage get_sha1s = [c["sha1"] for c in contents_with_data] # retrieve contents actual_contents = list(swh_storage.content_get(get_sha1s)) assert None not in actual_contents assert_contents_ok(contents_with_data, actual_contents) def test_generate_content_get_metadata(self, swh_storage, swh_contents): # input the list of sha1s we want from storage expected_contents = [c for c in swh_contents if c["status"] != "absent"] get_sha1s = [c["sha1"] for c in expected_contents] # retrieve contents meta_contents = swh_storage.content_get_metadata(get_sha1s) assert len(list(meta_contents)) == len(get_sha1s) actual_contents = [] for contents in meta_contents.values(): actual_contents.extend(contents) keys_to_check = {"length", "status", "sha1", "sha1_git", "sha256", "blake2s256"} assert_contents_ok( expected_contents, actual_contents, keys_to_check=keys_to_check ) def test_generate_content_get_range(self, swh_storage, swh_contents): """content_get_range returns complete range""" present_contents = [c for c in swh_contents if c["status"] != "absent"] get_sha1s = sorted([c["sha1"] for c in swh_contents if c["status"] != "absent"]) start = get_sha1s[2] end = get_sha1s[-2] actual_result = swh_storage.content_get_range(start, end) assert actual_result["next"] is None actual_contents = actual_result["contents"] expected_contents = [c for c in present_contents if start <= c["sha1"] <= end] if expected_contents: assert_contents_ok(expected_contents, actual_contents, ["sha1"]) else: assert actual_contents == [] def test_generate_content_get_range_full(self, swh_storage, swh_contents): """content_get_range for a full range returns all available contents""" present_contents = [c for c in swh_contents if c["status"] != "absent"] start = b"0" * 40 end = b"f" * 40 actual_result = swh_storage.content_get_range(start, end) assert actual_result["next"] is None actual_contents = actual_result["contents"] expected_contents = [c for c in present_contents if start <= c["sha1"] <= end] if expected_contents: assert_contents_ok(expected_contents, actual_contents, ["sha1"]) else: assert actual_contents == [] def test_generate_content_get_range_empty(self, swh_storage, swh_contents): """content_get_range for an empty range returns nothing""" start = b"0" * 40 end = b"f" * 40 actual_result = swh_storage.content_get_range(end, start) assert actual_result["next"] is None assert len(actual_result["contents"]) == 0 def test_generate_content_get_range_limit_none(self, swh_storage): """content_get_range call with wrong limit input should fail""" with pytest.raises(StorageArgumentException) as e: swh_storage.content_get_range(start=None, end=None, limit=None) assert e.value.args == ("limit should not be None",) def test_generate_content_get_range_no_limit(self, swh_storage, swh_contents): """content_get_range returns contents within range provided""" # input the list of sha1s we want from storage get_sha1s = sorted([c["sha1"] for c in swh_contents if c["status"] != "absent"]) start = get_sha1s[0] end = get_sha1s[-1] # retrieve contents actual_result = swh_storage.content_get_range(start, end) actual_contents = actual_result["contents"] assert actual_result["next"] is None assert len(actual_contents) == len(get_sha1s) expected_contents = [c for c in swh_contents if c["status"] != "absent"] assert_contents_ok(expected_contents, actual_contents, ["sha1"]) def test_generate_content_get_range_limit(self, swh_storage, swh_contents): """content_get_range paginates results if limit exceeded""" contents_map = {c["sha1"]: c for c in swh_contents} # input the list of sha1s we want from storage get_sha1s = sorted([c["sha1"] for c in swh_contents if c["status"] != "absent"]) start = get_sha1s[0] end = get_sha1s[-1] # retrieve contents limited to n-1 results limited_results = len(get_sha1s) - 1 actual_result = swh_storage.content_get_range(start, end, limit=limited_results) actual_contents = actual_result["contents"] assert actual_result["next"] == get_sha1s[-1] assert len(actual_contents) == limited_results expected_contents = [contents_map[sha1] for sha1 in get_sha1s[:-1]] assert_contents_ok(expected_contents, actual_contents, ["sha1"]) # retrieve next part actual_results2 = swh_storage.content_get_range(start=end, end=end) assert actual_results2["next"] is None actual_contents2 = actual_results2["contents"] assert len(actual_contents2) == 1 assert_contents_ok([contents_map[get_sha1s[-1]]], actual_contents2, ["sha1"]) def test_origin_get_range_from_zero(self, swh_storage, swh_origins): actual_origins = list( swh_storage.origin_get_range(origin_from=0, origin_count=0) ) assert len(actual_origins) == 0 actual_origins = list( swh_storage.origin_get_range(origin_from=0, origin_count=1) ) assert len(actual_origins) == 1 assert actual_origins[0]["id"] == 1 assert actual_origins[0]["url"] == swh_origins[0]["url"] @pytest.mark.parametrize( "origin_from,origin_count", [(1, 1), (1, 10), (1, 20), (1, 101), (11, 0), (11, 10), (91, 11)], ) def test_origin_get_range( self, swh_storage, swh_origins, origin_from, origin_count ): actual_origins = list( swh_storage.origin_get_range( origin_from=origin_from, origin_count=origin_count ) ) origins_with_id = list(enumerate(swh_origins, start=1)) expected_origins = [ {"url": origin["url"], "id": origin_id,} for (origin_id, origin) in origins_with_id[ origin_from - 1 : origin_from + origin_count - 1 ] ] assert actual_origins == expected_origins @pytest.mark.parametrize("limit", [1, 7, 10, 100, 1000]) def test_origin_list(self, swh_storage, swh_origins, limit): returned_origins = [] page_token = None i = 0 while True: result = swh_storage.origin_list(page_token=page_token, limit=limit) assert len(result["origins"]) <= limit returned_origins.extend(origin["url"] for origin in result["origins"]) i += 1 page_token = result.get("next_page_token") if page_token is None: assert i * limit >= len(swh_origins) break else: assert len(result["origins"]) == limit expected_origins = [origin["url"] for origin in swh_origins] assert sorted(returned_origins) == sorted(expected_origins) ORIGINS = [ "https://github.com/user1/repo1", "https://github.com/user2/repo1", "https://github.com/user3/repo1", "https://gitlab.com/user1/repo1", "https://gitlab.com/user2/repo1", "https://forge.softwareheritage.org/source/repo1", ] def test_origin_count(self, swh_storage): swh_storage.origin_add([{"url": url} for url in self.ORIGINS]) assert swh_storage.origin_count("github") == 3 assert swh_storage.origin_count("gitlab") == 2 assert swh_storage.origin_count(".*user.*", regexp=True) == 5 assert swh_storage.origin_count(".*user.*", regexp=False) == 0 assert swh_storage.origin_count(".*user1.*", regexp=True) == 2 assert swh_storage.origin_count(".*user1.*", regexp=False) == 0 def test_origin_count_with_visit_no_visits(self, swh_storage): swh_storage.origin_add([{"url": url} for url in self.ORIGINS]) # none of them have visits, so with_visit=True => 0 assert swh_storage.origin_count("github", with_visit=True) == 0 assert swh_storage.origin_count("gitlab", with_visit=True) == 0 assert swh_storage.origin_count(".*user.*", regexp=True, with_visit=True) == 0 assert swh_storage.origin_count(".*user.*", regexp=False, with_visit=True) == 0 assert swh_storage.origin_count(".*user1.*", regexp=True, with_visit=True) == 0 assert swh_storage.origin_count(".*user1.*", regexp=False, with_visit=True) == 0 def test_origin_count_with_visit_with_visits_no_snapshot(self, swh_storage): swh_storage.origin_add([{"url": url} for url in self.ORIGINS]) origin_url = "https://github.com/user1/repo1" swh_storage.origin_visit_add(origin_url, date=now(), type="git") assert swh_storage.origin_count("github", with_visit=False) == 3 # it has a visit, but no snapshot, so with_visit=True => 0 assert swh_storage.origin_count("github", with_visit=True) == 0 assert swh_storage.origin_count("gitlab", with_visit=False) == 2 # these gitlab origins have no visit assert swh_storage.origin_count("gitlab", with_visit=True) == 0 assert ( swh_storage.origin_count("github.*user1", regexp=True, with_visit=False) == 1 ) assert ( swh_storage.origin_count("github.*user1", regexp=True, with_visit=True) == 0 ) assert swh_storage.origin_count("github", regexp=True, with_visit=True) == 0 def test_origin_count_with_visit_with_visits_and_snapshot(self, swh_storage): swh_storage.origin_add([{"url": url} for url in self.ORIGINS]) swh_storage.snapshot_add([data.snapshot]) origin_url = "https://github.com/user1/repo1" visit = swh_storage.origin_visit_add(origin_url, date=now(), type="git") swh_storage.origin_visit_update( origin_url, visit.visit, status="ongoing", snapshot=data.snapshot["id"] ) assert swh_storage.origin_count("github", with_visit=False) == 3 # github/user1 has a visit and a snapshot, so with_visit=True => 1 assert swh_storage.origin_count("github", with_visit=True) == 1 assert ( swh_storage.origin_count("github.*user1", regexp=True, with_visit=False) == 1 ) assert ( swh_storage.origin_count("github.*user1", regexp=True, with_visit=True) == 1 ) assert swh_storage.origin_count("github", regexp=True, with_visit=True) == 1 @settings(suppress_health_check=[HealthCheck.too_slow]) @given(strategies.lists(objects(), max_size=2)) def test_add_arbitrary(self, swh_storage, objects): for (obj_type, obj) in objects: obj = obj.to_dict() if obj_type == "origin_visit": origin_url = obj.pop("origin") swh_storage.origin_add_one({"url": origin_url}) if "visit" in obj: del obj["visit"] swh_storage.origin_visit_add(origin_url, obj["date"], obj["type"]) elif obj_type == "origin_visit_update": # internal object for now, they don't have a storage # endpoint yet continue else: if obj_type == "content" and obj["status"] == "absent": obj_type = "skipped_content" method = getattr(swh_storage, obj_type + "_add") try: method([obj]) except HashCollision: pass @pytest.mark.db class TestLocalStorage: """Test the local storage""" # This test is only relevant on the local storage, with an actual # objstorage raising an exception def test_content_add_objstorage_exception(self, swh_storage): swh_storage.objstorage.content_add = Mock( side_effect=Exception("mocked broken objstorage") ) with pytest.raises(Exception) as e: swh_storage.content_add([data.cont]) assert e.value.args == ("mocked broken objstorage",) missing = list(swh_storage.content_missing([data.cont])) assert missing == [data.cont["sha1"]] @pytest.mark.db class TestStorageRaceConditions: @pytest.mark.xfail def test_content_add_race(self, swh_storage): results = queue.Queue() def thread(): try: with db_transaction(swh_storage) as (db, cur): ret = swh_storage.content_add([data.cont], db=db, cur=cur) results.put((threading.get_ident(), "data", ret)) except Exception as e: results.put((threading.get_ident(), "exc", e)) t1 = threading.Thread(target=thread) t2 = threading.Thread(target=thread) t1.start() # this avoids the race condition # import time # time.sleep(1) t2.start() t1.join() t2.join() r1 = results.get(block=False) r2 = results.get(block=False) with pytest.raises(queue.Empty): results.get(block=False) assert r1[0] != r2[0] assert r1[1] == "data", "Got exception %r in Thread%s" % (r1[2], r1[0]) assert r2[1] == "data", "Got exception %r in Thread%s" % (r2[2], r2[0]) @pytest.mark.db class TestPgStorage: """This class is dedicated for the rare case where the schema needs to be altered dynamically. Otherwise, the tests could be blocking when ran altogether. """ def test_content_update_with_new_cols(self, swh_storage): swh_storage.journal_writer.journal = None # TODO, not supported with db_transaction(swh_storage) as (_, cur): cur.execute( """alter table content add column test text default null, add column test2 text default null""" ) cont = copy.deepcopy(data.cont2) swh_storage.content_add([cont]) cont["test"] = "value-1" cont["test2"] = "value-2" swh_storage.content_update([cont], keys=["test", "test2"]) with db_transaction(swh_storage) as (_, cur): cur.execute( """SELECT sha1, sha1_git, sha256, length, status, test, test2 FROM content WHERE sha1 = %s""", (cont["sha1"],), ) datum = cur.fetchone() assert datum == ( cont["sha1"], cont["sha1_git"], cont["sha256"], cont["length"], "visible", cont["test"], cont["test2"], ) with db_transaction(swh_storage) as (_, cur): cur.execute( """alter table content drop column test, drop column test2""" ) def test_content_add_db(self, swh_storage): cont = data.cont actual_result = swh_storage.content_add([cont]) assert actual_result == { "content:add": 1, "content:add:bytes": cont["length"], } if hasattr(swh_storage, "objstorage"): assert cont["sha1"] in swh_storage.objstorage.objstorage with db_transaction(swh_storage) as (_, cur): cur.execute( "SELECT sha1, sha1_git, sha256, length, status" " FROM content WHERE sha1 = %s", (cont["sha1"],), ) datum = cur.fetchone() assert datum == ( cont["sha1"], cont["sha1_git"], cont["sha256"], cont["length"], "visible", ) expected_cont = cont.copy() del expected_cont["data"] contents = [ obj for (obj_type, obj) in swh_storage.journal_writer.journal.objects if obj_type == "content" ] assert len(contents) == 1 for obj in contents: obj_d = obj.to_dict() del obj_d["ctime"] assert obj_d == expected_cont def test_content_add_metadata_db(self, swh_storage): cont = data.cont del cont["data"] cont["ctime"] = now() actual_result = swh_storage.content_add_metadata([cont]) assert actual_result == { "content:add": 1, } if hasattr(swh_storage, "objstorage"): assert cont["sha1"] not in swh_storage.objstorage.objstorage with db_transaction(swh_storage) as (_, cur): cur.execute( "SELECT sha1, sha1_git, sha256, length, status" " FROM content WHERE sha1 = %s", (cont["sha1"],), ) datum = cur.fetchone() assert datum == ( cont["sha1"], cont["sha1_git"], cont["sha256"], cont["length"], "visible", ) contents = [ obj for (obj_type, obj) in swh_storage.journal_writer.journal.objects if obj_type == "content" ] assert len(contents) == 1 for obj in contents: obj_d = obj.to_dict() assert obj_d == cont def test_skipped_content_add_db(self, swh_storage): cont = data.skipped_cont cont2 = data.skipped_cont2 cont2["blake2s256"] = None actual_result = swh_storage.skipped_content_add([cont, cont, cont2]) assert 2 <= actual_result.pop("skipped_content:add") <= 3 assert actual_result == {} with db_transaction(swh_storage) as (_, cur): cur.execute( "SELECT sha1, sha1_git, sha256, blake2s256, " "length, status, reason " "FROM skipped_content ORDER BY sha1_git" ) dbdata = cur.fetchall() assert len(dbdata) == 2 assert dbdata[0] == ( cont["sha1"], cont["sha1_git"], cont["sha256"], cont["blake2s256"], cont["length"], "absent", "Content too long", ) assert dbdata[1] == ( cont2["sha1"], cont2["sha1_git"], cont2["sha256"], cont2["blake2s256"], cont2["length"], "absent", "Content too long", ) def test_clear_buffers(self, swh_storage): """Calling clear buffers on real storage does nothing """ assert swh_storage.clear_buffers() is None def test_flush(self, swh_storage): """Calling clear buffers on real storage does nothing """ assert swh_storage.flush() == {}