Fetcher testing by roberth · Pull Request #136022 · NixOS/nixpkgs

roberth · 2021-08-28T08:34:27Z

Motivation for this change

Make maintenance easier on the fetchers and avoid problems.

The packageTests attribute will serve two purposes:

for ofborg: allow it to build tests in a __functor attrset like fetchgit
for hydra, potentially, build the package tests. Enabling these is not part of this PR.

Closes #133739

Refs #128749 #135881 or really all of topic: fetch

Things done

roberth · 2021-08-28T09:05:34Z

Not picked up automatically by ofborg, as expected. So,

@GrahamcOfBorg build packageTests.fetchgit

nixos-discourse · 2021-09-16T17:34:27Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-ready-for-review/3032/593

Artturin · 2021-09-19T16:33:21Z

probably needs documentation in doc/builders/fetchers.chapter.md?

Artturin · 2021-09-19T17:09:04Z

can't get this to work

diff --git a/pkgs/build-support/fetchfirefoxaddon/tests.nix b/pkgs/build-support/fetchfirefoxaddon/tests.nix
new file mode 100644
index 00000000000..05ee43aba29
--- /dev/null
+++ b/pkgs/build-support/fetchfirefoxaddon/tests.nix
@@ -0,0 +1,10 @@
+{ invalidateFetcherByDrvHash, fetchFirefoxAddon, ... }:
+
+{
+  simple = invalidateFetcherByDrvHash fetchFirefoxAddon {
+    name = "image-search-options";
+    # Chosen because its only 147KB
+    url = "https://addons.mozilla.org/firefox/downloads/file/3059971/image_search_options-3.0.12-fx.xpi";
+    sha256 = "1h768ljlh3pi23l27qp961v1hd0nbj2vasgy11bmcrlqp40zgvnr";
+  };
+}
diff --git a/pkgs/top-level/all-packages.nix b/pkgs/top-level/all-packages.nix
index 161c48a3d48..d14a587eb11 100644
--- a/pkgs/top-level/all-packages.nix
+++ b/pkgs/top-level/all-packages.nix
@@ -516,7 +516,10 @@ with pkgs;
 
   fetchhg = callPackage ../build-support/fetchhg { };
 
-  fetchFirefoxAddon = callPackage ../build-support/fetchfirefoxaddon {};
+  fetchFirefoxAddon = callPackage ../build-support/fetchfirefoxaddon { }
+    // {
+      tests = callPackages ../build-support/fetchfirefoxaddon/tests.nix;
+  };
 
   # `fetchurl' downloads a file from the network.
   fetchurl = if stdenv.buildPlatform != stdenv.hostPlatform

nix-repl> packageTests.fetchgit
{ recurseForDerivations = true; simple = «derivation /nix/store/5rl9by8nifg2k25rzp3yw5fdj303r6qn-nix-source-salted-v839ywjgprrp.drv»; }

nix-repl> packageTests.fetchFirefoxAddon
error: value is a function while a set was expected

roberth · 2021-09-19T17:58:44Z

Diffception.

-+      tests = callPackages ../build-support/fetchfirefoxaddon/tests.nix;
++      tests = callPackages ../build-support/fetchfirefoxaddon/tests.nix { };

I also fall into this trap every now and then, fwiw.

documentation

yes.

roberth

I've cleaned up some minor docs issues while I was at it. I hope those will not hinder this pr.

roberth · 2021-09-19T18:33:51Z

doc/builders/fetchers.chapter.md


 `fetchpatch` works very similarly to `fetchurl` with the same arguments expected. It expects patch files as a source and performs normalization on them before computing the checksum. For example it will remove comments or other unstable parts that are sometimes added by version control systems and can change over time.

-Other fetcher functions allow you to add source code directly from a VCS such as subversion or git. These are mostly straightforward nambes based on the name of the command used with the VCS system. Because they give you a working repository, they act most like `fetchzip`.


This was 90% stating the obvious. I've preserved the essence of the last sentence.

roberth · 2021-09-19T18:34:42Z

doc/builders/fetchers.chapter.md

-When using Nix, you will frequently need to download source code and other files from the internet. Nixpkgs comes with a few helper functions that allow you to fetch fixed-output derivations in a structured way.
+When using Nix, you will frequently need to download source code and other files from the internet. For this purpose, Nix provides the [_fixed output derivation_](https://nixos.org/manual/nix/stable/#fixed-output-drvs) feature and Nixpkgs provides various functions that implement the actual fetching from various protocols and services.

-The two fetcher primitives are `fetchurl` and `fetchzip`. Both of these have two required arguments, a URL and a hash. The hash is typically `sha256`, although many more hash algorithms are supported. Nixpkgs contributors are currently recommended to use `sha256`. This hash will be used by Nix to identify your source. A typical usage of fetchurl is provided below.


The two fetcher primitives

There's no such thing.

The rest in the fetchurl section.

Artturin · 2021-09-19T19:01:20Z

will having all the expressions in packageTests.X slow something(eval?) down
would it be possible to only have the ones that have tests be there

is packageTests even needed since
nix build ".#fetchgit.tests.simple" works?

nix-build doesn't work like thatnix-build -A fetchgit.tests.simple

roberth · 2021-09-19T19:38:34Z

will having all the expressions in packageTests.X slow something(eval?) down

This adds about as much overhead as a package would. In most use cases it would go unnoticed like any other package. In cases where the whole of Nixpkgs is traversed, those traversals look for the recurseForDerivations attribute, which is unset inside packageTests, causing it to be skipped. This works for nix-build (which shouldn't be used on all of Nixpkgs anyway) and it works for Hydra/release.nix. In this case, the attribute names are shallow-copied into memory once more, but this is still insignificant and the same happens for pkgsStatic etc.

Artturin · 2021-09-21T02:03:08Z

@ofborg eval

Artturin · 2021-09-21T02:03:38Z

How would one run all the packageTests?

roberth · 2021-09-21T07:55:16Z

@Artturin you generally wouldn't, if you mean literally all.

@GrahamcOfBorg build packageTests.fetchgit

This reverts commit 87b3740. packageTests wasn't inherently wrong, but I am not fully convinced that it is necessary. Specifically, it would only be used by: - `nix-build`, which is going to be a legacy command in the mid term - ofborg, perhaps, not even implemented whereas the following use cases do not need it: - `nix build` (experimental command with a future, unlike `nix-build`) - `release.nix` (Hydra), might use similar logic but not reuse this Further, considering that this is only necessary for tests of functions, I am hesitant to introduce it. Meanwhile, it should not hinder the rest of the PR.

roberth · 2021-09-21T12:32:00Z

I've removed packageTests. To quote the commit message:

packageTests wasn't inherently wrong, but I am not fully convinced
that it is necessary. Specifically, it would only be used by:

nix-build, which is going to be a legacy command in the mid term
ofborg, perhaps, not even implemented

whereas the following use cases do not need it:

nix build (experimental command with a future, unlike nix-build)
release.nix (Hydra), might use similar logic but not reuse this

Further, considering that this is only necessary for tests of
functions, I am hesitant to introduce it.
Meanwhile, it should not hinder the rest of the PR.

roberth · 2021-09-21T12:33:27Z

Not sure if I tested this or just assumed it still uses nix-build and suffers from its functor problem.

@GrahamcOfBorg build fetchgit.tests

roberth · 2021-09-21T12:36:45Z

Confirmed. Ofborg tries to autocall the functor instead of using the attribute.

Cannot nix-instantiate `fetchgit.tests' because:
error: cannot auto-call a function that has an argument without a default value ('url')

I'll leave ofborg out of scope for now and merge this when ofborg is done.

roberth added 3 commits August 28, 2021 10:28

invalidateFetcherByDrvHash: init

6ea8d10

fetchgit.tests: init

0fa3d10

Add packageTests

87b3740

github-actions bot added the 6.topic: fetch Fetchers (e.g. fetchgit, fetchsvn, ...) label Aug 28, 2021

roberth added 6.topic: developer experience nixpkgs development workflow 6.topic: testing Tooling for automated testing of packages and modules labels Aug 28, 2021

roberth mentioned this pull request Aug 28, 2021

Repeatable fetcher tests #133739

Closed

ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux. labels Aug 28, 2021

This was referenced Aug 28, 2021

fetchNodeModules: init #128749

Closed

Run passthru.tests on hydra #136026

Open

roberth mentioned this pull request Sep 7, 2021

nixos/tests: ensure nix can fetch data from sandbox #135689

Closed

12 tasks

Artturin mentioned this pull request Sep 8, 2021

fetchipfs: support api/v0/get #136688

Closed

12 tasks

roberth added 2 commits September 19, 2021 19:33

doc/builders/fetchers: Document FOD caveats

f74b160

doc/builders/fetchers: Explain invalidateFetcherByDrvHash

b502de6

invalidateFetcherByDrvHash move docs to manual

ac78ae8

roberth force-pushed the fetcher-testing branch from a9e5891 to ac78ae8 Compare September 19, 2021 18:29

github-actions bot added the 8.has: documentation This PR adds or changes documentation label Sep 19, 2021

roberth commented Sep 19, 2021

View reviewed changes

Artturin approved these changes Sep 21, 2021

View reviewed changes

roberth mentioned this pull request Sep 21, 2021

Testing functions with "passthru" tests. NixOS/ofborg#578

Open

roberth merged commit 1648346 into NixOS:master Sep 21, 2021

Artturin mentioned this pull request Sep 22, 2021

fetchfirefoxaddon: add simple test #138869

Merged

12 tasks

roberth mentioned this pull request Oct 6, 2021

prefetch-yarn-deps, fetchYarnDeps: init #140701

Merged

6 tasks

roberth mentioned this pull request Mar 1, 2022

optionally dont run functors when finding along an attrpath NixOS/nix#6184

Closed


		`fetchpatch` works very similarly to `fetchurl` with the same arguments expected. It expects patch files as a source and performs normalization on them before computing the checksum. For example it will remove comments or other unstable parts that are sometimes added by version control systems and can change over time.

		Other fetcher functions allow you to add source code directly from a VCS such as subversion or git. These are mostly straightforward nambes based on the name of the command used with the VCS system. Because they give you a working repository, they act most like `fetchzip`.

Uh oh!

Conversation

roberth commented Aug 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation for this change

Things done

Uh oh!

roberth commented Aug 28, 2021

Uh oh!

nixos-discourse commented Sep 16, 2021

Uh oh!

Artturin commented Sep 19, 2021

Uh oh!

Artturin commented Sep 19, 2021

Uh oh!

roberth commented Sep 19, 2021

Uh oh!

roberth left a comment

Choose a reason for hiding this comment

Uh oh!

roberth Sep 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

roberth Sep 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Artturin commented Sep 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

roberth commented Sep 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Artturin commented Sep 21, 2021

Uh oh!

Artturin commented Sep 21, 2021

Uh oh!

roberth commented Sep 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

roberth commented Sep 21, 2021

Uh oh!

roberth commented Sep 21, 2021

Uh oh!

roberth commented Sep 21, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

roberth commented Aug 28, 2021 •

edited

Loading

roberth Sep 19, 2021 •

edited

Loading

roberth Sep 19, 2021 •

edited

Loading

Artturin commented Sep 19, 2021 •

edited

Loading

roberth commented Sep 19, 2021 •

edited

Loading

roberth commented Sep 21, 2021 •

edited

Loading