swh.loader.svn.loader module

Loader in charge of injecting either new or existing svn mirrors to swh-storage.

class swh.loader.svn.loader.SvnLoader(storage: swh.storage.interface.StorageInterface, url: str, origin_url: Optional[str] = None, visit_date: Optional[datetime.datetime] = None, destination_path: Optional[str] = None, swh_revision: Optional[str] = None, start_from_scratch: bool = False, temp_directory: str = '/tmp', debug: bool = False, check_revision: int = 0, max_content_size: Optional[int] = None)

Bases: swh.loader.core.loader.BaseLoader

Swh svn loader.

The repository is either remote or local. The loader deals with update on an already previously loaded repository.

visit_type: Optional[str] = 'svn'

visit_date: Optional[datetime.datetime]

pre_cleanup()

Cleanup potential dangling files from prior runs (e.g. OOM killed tasks)

cleanup()

Clean up the svn repository’s working representation on disk.

swh_revision_hash_tree_at_svn_revision(revision)

Compute and return the hash tree at a given svn revision.

Parameters

rev (int) – the svn revision we want to check

Returns

The hash tree directory as bytes.

build_swh_revision(rev, commit, dir_id, parents)

Build the swh revision dictionary.

This adds:

• the ‘synthetic’ flag to true

• the ‘extra_headers’ containing the repository’s uuid and the svn revision number.

Parameters

• rev (int) – the svn revision number

• commit (dict) – the commit data: revision id, date, author, and message

• dir_id (bytes) – the upper tree’s hash identifier

• parents ([bytes]) – the parents’ identifiers

Returns

The swh revision corresponding to the svn revision.

check_history_not_altered(svnrepo, revision_start: int, swh_rev: swh.model.model.Revision) → bool

Given a svn repository, check if the history was modified in between visits.

start_from(start_from_scratch: bool = False) → Tuple[int, int, Dict[int, Tuple[bytes, ...]]]

Determine from where to start the loading.

Parameters

start_from_scratch – As opposed to start from the last snapshot

Returns

tuple (revision_start, revision_end, revision_parents)

Raises

• SvnLoaderHistoryAltered – When a hash divergence has been detected (should not happen)

• SvnLoaderUneventful – Nothing changed since last visit

process_svn_revisions(svnrepo, revision_start, revision_end, revision_parents) → Iterator[Tuple[List[swh.model.model.Content], List[swh.model.model.SkippedContent], List[swh.model.model.Directory], swh.model.model.Revision]]

Process svn revisions from revision_start to revision_end.

At each svn revision, apply new diffs and simultaneously compute swh hashes. This yields those computed swh hashes as a tuple (contents, directories, revision).

Note that at every self.check_revision, a supplementary check takes place to check for hash-tree divergence (related T570).

Yields

tuple (contents, directories, revision) of dict as a dictionary with keys, sha1_git, sha1, etc…

Raises

ValueError in case of a hash divergence detection –

prepare_origin_visit()

First step executed by the loader to prepare origin and visit references. Set/update self.origin, and optionally self.origin_url, self.visit_date.

prepare()

Second step executed by the loader to prepare some state needed by

the loader.

Raises

NotFound exception if the origin to ingest is not found.

fetch_data()

Fetching svn revision information.

This will apply svn revision as patch on disk, and at the same time, compute the swh hashes.

In effect, fetch_data fetches those data and compute the necessary swh objects. It’s then stored in the internal state instance variables (initialized in _prepare_state).

This is up to store_data to actually discuss with the storage to store those objects.

Returns

True to continue fetching data (next svn revision), False to stop.

Return type

bool

store_data()

We store the data accumulated in internal instance variable. If the iteration over the svn revisions is done, we create the snapshot and flush to storage the data.

This also resets the internal instance variable state.

generate_and_load_snapshot(revision: Optional[swh.model.model.Revision] = None, snapshot: Optional[swh.model.model.Snapshot] = None) → swh.model.model.Snapshot

Create the snapshot either from existing revision or snapshot.

Revision (supposedly new) has priority over the snapshot (supposedly existing one).

Parameters

• revision (dict) – Last revision seen if any (None by default)

• snapshot (dict) – Snapshot to use if any (None by default)

Returns

Optional[Snapshot] The newly created snapshot

load_status()

Detailed loading status.

Defaults to logging an eventful load.

Returns: a dictionary that is eventually passed back as the task’s

result to the scheduler, allowing tuning of the task recurrence mechanism.

visit_status()

Detailed visit status.

Defaults to logging a full visit.

origin: Optional[swh.model.model.Origin]

origin_metadata: Dict[str, Any]

loaded_snapshot_id: Optional[bytes]

class swh.loader.svn.loader.SvnLoaderFromDumpArchive(storage: swh.storage.interface.StorageInterface, url: str, archive_path: str, origin_url: Optional[str] = None, destination_path: Optional[str] = None, swh_revision: Optional[str] = None, start_from_scratch: bool = False, visit_date: Optional[datetime.datetime] = None, temp_directory: str = '/tmp', debug: bool = False, check_revision: int = 0, max_content_size: Optional[int] = None)

Bases: swh.loader.svn.loader.SvnLoader

Uncompress an archive containing an svn dump, mount the svn dump as an svn repository and load said repository.

prepare()

Second step executed by the loader to prepare some state needed by

the loader.

Raises

NotFound exception if the origin to ingest is not found.

cleanup()

Clean up the svn repository’s working representation on disk.

visit_date: Optional[datetime.datetime]

origin: Optional[swh.model.model.Origin]

origin_metadata: Dict[str, Any]

loaded_snapshot_id: Optional[bytes]

class swh.loader.svn.loader.SvnLoaderFromRemoteDump(storage: swh.storage.interface.StorageInterface, url: str, origin_url: Optional[str] = None, destination_path: Optional[str] = None, swh_revision: Optional[str] = None, start_from_scratch: bool = False, visit_date: Optional[datetime.datetime] = None, temp_directory: str = '/tmp', debug: bool = False, check_revision: int = 0, max_content_size: Optional[int] = None)

Bases: swh.loader.svn.loader.SvnLoader

Create a subversion repository dump using the svnrdump utility, mount it locally and load the repository from it.

get_last_loaded_svn_rev(svn_url: str) → int

Check if the svn repository has already been visited and return the last loaded svn revision number or -1 otherwise.

dump_svn_revisions(svn_url, last_loaded_svn_rev=- 1)

Generate a subversion dump file using the svnrdump tool. If the svnrdump command failed somehow, the produced dump file is analyzed to determine if a partial loading is still feasible.

prepare()

Second step executed by the loader to prepare some state needed by

the loader.

Raises

NotFound exception if the origin to ingest is not found.

cleanup()

Clean up the svn repository’s working representation on disk.

visit_status()

Detailed visit status.

Defaults to logging a full visit.

visit_date: Optional[datetime.datetime]

origin: Optional[swh.model.model.Origin]

origin_metadata: Dict[str, Any]

loaded_snapshot_id: Optional[bytes]