Differential D7633 Diff 27718 swh/loader/metadata/tests/test_github.py

Changeset View

Standalone View

View Options

swh/loader/metadata/tests/test_github.py

This file was added.

# 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 pathlib import Path

from typing import Type

import pkg_resources

from swh.loader.core.metadata_fetchers import MetadataFetcherProtocol

from swh.loader.metadata import __version__

from swh.loader.metadata.github import GitHubMetadataFetcher

from swh.model.model import (

MetadataAuthority,

MetadataAuthorityType,

MetadataFetcher,

Origin,

RawExtrinsicMetadata,

)

from .test_base import DummyLoader

ORIGIN = Origin("https://github.com/octocat/Hello-World")

METADATA_AUTHORITY = MetadataAuthority(

type=MetadataAuthorityType.FORGE, url="https://github.com"

)

def expected_metadata(dt, datadir):

data_file_path = Path(datadir) / "https_api.github.com/repos_octocat_Hello-World"

with data_file_path.open("rb") as fd:

expected_metadata_bytes = fd.read()

return RawExtrinsicMetadata(

target=ORIGIN.swhid(),

discovery_date=dt,

authority=METADATA_AUTHORITY,

fetcher=MetadataFetcher(name="swh.loader.metadata.github", version=__version__),

format="application/vnd.github.v3+json",

metadata=expected_metadata_bytes,

)

def test_type() -> None:

# check with mypy

fetcher_cls: Type[MetadataFetcherProtocol]

fetcher_cls = GitHubMetadataFetcher

ardumontUnsubmitted

Not Done

you can drop it.

ardumont: you can drop it.

ardumontUnsubmitted

Not Done

ping?

(that's not for type this time, isn't it?)

ardumont: ping? (that's not for type this time, isn't it?)

vlorentzAuthorUnsubmitted

Done

it's still for flake8

vlorentz: it's still for flake8

print(fetcher_cls)

# check at runtime

fetcher = GitHubMetadataFetcher(

ORIGIN,

credentials=None,

lister_name="github",

lister_instance_name="",

)

assert isinstance(fetcher, MetadataFetcherProtocol)

def test_github_metadata(datadir, requests_mock_datadir, mocker):

now = datetime.datetime.now(tz=datetime.timezone.utc)

mocker.patch("swh.loader.metadata.base.now", return_value=now)

fetcher = GitHubMetadataFetcher(

ORIGIN, credentials=None, lister_name="github", lister_instance_name=""

)

assert fetcher.get_origin_metadata() == [expected_metadata(now, datadir)]

def test_github_metadata_from_loader(

swh_storage, mocker, datadir, requests_mock_datadir

# Fail early if this package is not fully installed

assert "github" in {

entry_point.name

for entry_point in pkg_resources.iter_entry_points("swh.loader.metadata")

}

now = datetime.datetime.now(tz=datetime.timezone.utc)

mocker.patch("swh.loader.metadata.base.now", return_value=now)

loader = DummyLoader(

storage=swh_storage,

origin_url=ORIGIN.url,

lister_name="github",

lister_instance_name="",

)

loader.load()

assert swh_storage.raw_extrinsic_metadata_get(

ORIGIN.swhid(), METADATA_AUTHORITY

ardumontUnsubmitted

Not Done

assert fetcher.get_origin_metadata() == [expected_metadata(now, datadir)]

- class DummyLoader(BaseLoader):

- """Base Loader to overload and simplify the base class (technical: to avoid repetition

- in other *Loader classes)"""

- visit_type = "git"

- def __init__(self, storage, *args, **kwargs):

- super().__init__(storage, ORIGIN.url, *args, **kwargs)

- def cleanup(self):

- pass

- def prepare(self, *args, **kwargs):

- pass

- def fetch_data(self):

- pass

- def get_snapshot_id(self):

- return None

- def store_data(self):

- pass

+ from .test_base import DummyLoader

def test_github_metadata_from_loader(

ardumont: ?

).results == [expected_metadata(now, datadir)]