Some packages can have an invalid version string in their changelog
which raises a ValueError when attempting to parse it in the
get_intrinsic_package_metadata method of the loader.

As a consequence each package release with such bogus entry in the
changelog was discarded from the snapshot created by the loader.

So prefer to get the raw string version instead of parsing it to
workaround that issue.

Fix #1493.

This pushes options from cli to the Nar class. This also bootstraps tests reusing
existing test cases from before (using the nix binary).

Refs. swh/meta#4979

This also exposes a `swh nar` cli.

```
$ Usage: swh nar [OPTIONS] DIRECTORY

  Compute NAR hashes on a directory.

Options:
  -x, --exclude-vcs               exclude version control directories
  -H, --hash-algo [sha256|sha1]
  -f, --format-output [hex|base32|base64]
  --debug / --no-debug
  -h, --help                      Show this message and exit.
```

Refs. swh/meta#4979

After switching to the PyData Sphinx theme, the very large table
with the loader specification became too wide to be readable.
These changes make the table scrollable again, remove the right sidebar,
highlight the name column and add stripe to rows.

They are stopgap measure as such a table might not the best way to
present this information.

Version number of a pubdev package containing a dash character fails
to be parsed by packaging.parse_version.

So ensure to split version number by dash to extract parsable part
in it and fix loading of such packages.

Resolves #4741

GitLab will display the content of the README file when browsing the
repository. But in case the file is a symlink, it will display the
path pointed by the symlink. There is a 6 year old issue about this:
https://gitlab.com/gitlab-org/gitlab/-/issues/15093

We can workaround the issue by having the content at the root of the
repository and a symlink to this file in the `docs/` directory.

Tested in swh-py-template!27

Jérémy Bobbio (Lunar) authored 2 years ago and vlorentz committed 2 years ago

Related to swh/meta#4959

Related to swh/meta#4960

This fixes python 3.7 support due to poetry, a dependency of isort, that
removed support for that Python version in a recent release.

There is code in swh/loader/cli.py, and swh-loader-metadata will need
to import cli.py, causing mypy to complain when py.typed is missing.

This introduces a `create_partial_snapshot` parameter to the base loader constructor.
When activated, during each call of the `store_data` method, if there are more data to
fetch, this will create a partial snapshot (and an associated visit status).

The final loop behaves as before, create the last visit with status 'full' targeting the
final snapshot.

The main difference between the 2 behaviors is that an ingestion with that parameter on
is more verbose in terms of origin_visit_status. This, in turn, allows to be incremental
in subsequent visits for the same origin. This may especially be interesting for cases
when loading fail due to out of hand resources issues (e.g. large svn or git
repositories).

Related to T3625

Release 22.0 of packaging module can no longer parse invalid Python version
number, an exception is now raised.

Conda loader used the keys of the packages dict as version numbers to sort,
which are in the form "<arch>/<version>-<build>", but those cannot be parsed
anymore.

So extract intrinsic version numbers of packages instead to sort the list of
versions.

Also update snapshot release names to "<version>-<build>-<arch>" as each
release for a given architecture targets a different directory.

Release 22.0 of packaging module can no longer parse invalid Python version
number, an exception is now raised.

RPM loader used the keys of the packages dict as version numbers to sort,
which are in the form "<distribution>/<edition>/<package_version_number>",
but those cannot be parsed anymore.

So use intrinsic version numbers of packages instead to sort the list of
versions.

In order to remove warnings about /apidoc/*.rst files being included
multiple times in toc when building full swh documentation, prefer to
include module indices only when building standalone package documentation.

Also include them the proper sphinx way.

Related to T4496

The loader make an http api call to retrieve package related versions.
It then download tar.gz archive for each version.

This got migrated in the sole swh-loader-git module using it.

Related to D7868

Some maven artifacts do not have any sha1 sums computed but rather md5
ones so handle these edge cases to still check download integrity of
jar files.

Use mocked network requests to get jar and pom files instead of
reading them from the datadir directory.

It enables to avoid downloading and processing a release archive for
a CPAN module if it has already been archived by Software Heritage.

Related to T2833

provided by the lister extra_loader_arguments

Use artifacts and rubygems_metadata to get list of versions, artifacts checksums and extrinsic metadata url
Add an EXTID manifest
Set metadata from extrinsic metadata

Raphaël Gomès authored 2 years ago and Franck Bret committed 2 years ago

Reviewers: #reviewers, anlambert

Subscribers: anlambert

Maniphest Tasks: T4581

Differential Revision: https://forge.softwareheritage.org/D8569

As a follow up of Puppet lister evolution D8762, manage artifacts as lists
Remove description from release message

Related T4580

For each origin it takes advantage of 'artifacts' data send through
'extra_loader_arguments' of the conda lister, providing versions,
archive url, checksum, etc.
Author extracted from intrinsic metadata.

Related T4579

- pre-commit from 4.1.0 to 4.3.0,
- codespell from 2.2.1 to 2.2.2,
- black from 22.3.0 to 22.10.0 and
- flake8 from 4.0.1 to 5.0.4. Also freeze flake8 dependencies.

Also change flake8's repo config to github (the gitlab mirror
being outdated).

Fetch extrinsic metadata by computing URLs from the metadata provided
by the lister and store them as release extrinsic metadata.

Related to T2833

Parsing perl module metadata files trigger a lot of errors due to badly
formatted JSON or YAML and module author info is already provided by
the cpan lister as extra loader arguments so remove that no longer
needed metadata parsing step.

Related to T2833

Artifacts info for a package are now provided as loader arguments so
no need to query metacpan Web API anymore to get list of versions
and their related info.

Related to T2833

Module description is not related to a particular release so we
should not add it in release message.

The loader get enough information from extrinsic metadata to build a release object, checking intrinsic metadata was more error prone than useful.

It should fix some Sentry reported errors.

Remove 'information' and adapt release message

Adapt loader specifications documentation

Related T4465, T4530, T4583

"nar" computation checks can happen on files too.

This also deduplicate tests code on content and directory ones.

Related to T3781

Prior to this commit, there was a discrepancy between the hash mismatch computations
with "standard" and "nar" computations. This commit fixes the gap between those.

When a hash mismatch occurs, either "nar" or "standard", the issue is caught and the
next mirror url is checked. At the end of it all, if nothing is loaded and errors
exist, this is raised. This fails the visit.

This also adds the missing tests.

Related to T3781

The lister now provides the "checksums_computation". This is either "standard" (for most
cases as in bare checksums on the object retrieved) or "nar" for some edge case. In that
case the computation is delegated to the "nix-store" command (which should be present in
the system running the loading).

This adapts the directory loader to deal with this case.

No work has been done for the ContentLoader yet besides failing the case if a call
happens with such case.

Related to T3781

Add a dedicated fixture implementing loader task creation check for
a given lister and listed origin and use it in tasks tests for
available loaders.

Also remove redundant tests performing the same checks as that
new fixture.

Related to T3781

Previous regexp does not seem to work anymore so use a simpler one.