qcp: init at 0.8.1 by terrorbyte · Pull Request #361923 · NixOS/nixpkgs

terrorbyte · 2024-12-05T00:56:44Z

Adds the qcp package. This package is an experimental high-performance remote file copy utility used for long-distance transfers.

Things done

Add a 👍 reaction to pull requests you find important.

crazyscot · 2025-02-11T18:47:33Z

FYI qcp 0.3.0 has been released. It is a breaking protocol change, dropping the dependency on capnp.

terrorbyte · 2025-02-12T03:13:27Z

I bumped to 0.3.0 and added the man page handling from our flake discussions.

Tert0 · 2025-02-14T19:55:32Z

Some suggestions:

diff --git a/pkgs/by-name/qc/qcp/package.nix b/pkgs/by-name/qc/qcp/package.nix
index 89ac71723a12..ae84c97df689 100644
--- a/pkgs/by-name/qc/qcp/package.nix
+++ b/pkgs/by-name/qc/qcp/package.nix
@@ -1,7 +1,9 @@
 {
   lib,
-  fetchFromGitHub,
   rustPlatform,
+  fetchFromGitHub,
+  versionCheckHook,
+  nix-update-script,
 }:
 
 rustPlatform.buildRustPackage rec {
@@ -10,31 +12,40 @@ rustPlatform.buildRustPackage rec {
 
   src = fetchFromGitHub {
     owner = "crazyscot";
-    repo = pname;
-    rev = "v${version}";
+    repo = "qcp";
+    tag = "v${version}";
     hash = "sha256-9nJ01OPAU60veLpL2BlSSUTMu/xdUBDVkV0YEFNQ3FU=";
   };
 
-  cargoHash = "sha256-7LfwJa64ZUE0i8/bMecMoxzykJvuINzXctopyh4Qlak=";
+  useFetchCargoVendor = true;
+  cargoHash = "sha256-vVlwhXaCumgwTcHjnGwD6mi+ZtZvqmtCWukQaPBQcsA=";
+
+  postInstall = ''
+    install -Dm644 $src/misc/qcp.1 $out/share/man/man1/qcp.1
+    install -Dm644 $src/misc/qcp_config.5 $out/share/man/man5/qcp_config.5
+    install -Dm644 $src/misc/20-qcp.conf $out/etc/sysctl.d/20-qcp.conf
+    install -Dm644 $src/misc/qcp.conf $out/etc/qcp.conf
+    install -Dm644 $src/README.md $out/share/doc/qcp/README.md
+    install -Dm644 $src/LICENSE $out/share/doc/qcp/LICENSE
+  '';
 
   checkFlags = [
     # SSH home directory tests will not work in nix sandbox
     "--skip=config::ssh::includes::test::home_dir"
   ];
 
+  nativeInstallCheckInputs = [ versionCheckHook ];
+  doInstallCheck = true;
+  versionCheckProgramArg = "--version";
+
+  passthru.updateScript = nix-update-script {};
+
   meta = {
-    description = "The QUIC Copier (qcp) is an experimental high-performance remote file copy utility for long-distance internet connections.";
+    description = "Experimental high-performance remote file copy utility for long-distance internet connections";
     homepage = "https://github.com/crazyscot/qcp";
-    license = lib.licenses.agpl3Only;
+    changelog = "https://github.com/crazyscot/qcp/releases/tag/v{version}";
+    license = lib.licenses.agpl3Plus;
     maintainers = with lib.maintainers; [ poptart ];
+    mainProgram = "qcp";
   };
-
-  postInstall = ''
-    install -Dm644 $src/misc/qcp.1 $out/share/man/man1/qcp.1
-    install -Dm644 $src/misc/qcp_config.5 $out/share/man/man5/qcp_config.5
-    install -Dm644 $src/misc/20-qcp.conf $out/etc/sysctl.d/20-qcp.conf
-    install -Dm644 $src/misc/qcp.conf $out/etc/qcp.conf
-    install -Dm644 $src/README.md $out/share/doc/qcp/README.md
-    install -Dm644 $src/LICENSE $out/share/doc/qcp/LICENSE
-  '';
 }

terrorbyte · 2025-02-14T20:39:43Z

These are great suggestions and this is my first time packaging a Rust program so I appreciate the feedback. Almost everything I agree with but one thing:

-    repo = pname;
-    rev = "v${version}";
+    repo = "qcp";
+    tag = "v${version}";

Did you intend to fully replace the rev with tag? I hadn't seen that become the norm and figured it'd break the older fetcher calls.

Tert0 · 2025-02-14T21:04:52Z

I am not aware of any downsides to using tag instead of rev.

rev corresponds to the Git commit hash or tag (e.g v1.0) that will be downloaded from Git. If you need to fetch a tag however, you should prefer to use the tag parameter which achieves this in a safer way with less boilerplate.

Source: https://nixos.org/manual/nixpkgs/stable/#fetchfromgithub

terrorbyte · 2025-02-17T17:08:01Z

Looks like my confusion is because rev has been a required argument up until about 2 months ago which this PR is not based off of so the builds were failing missing that argument. Let me rebase and see if the changes work as stated.

0xda157

please also squash everything into one commit

pkgs/by-name/qc/qcp/package.nix

crazyscot · 2025-03-25T20:20:37Z

Hello! Upstream author of qcp here. Darwin is not (yet) a supported platform, so I'm not surprised that the CI build failed there. Is darwin support essential for this PR to be accepted?

0xda157 · 2025-03-25T23:45:30Z

Is darwin support essential for this PR to be accepted?

It's fine is darwin isn't supported

terrorbyte · 2025-04-04T20:17:13Z

please also squash everything into one commit

Done. I also added a build required flag and bumped the version.

pkgs/by-name/qc/qcp/package.nix

0xda157 · 2025-04-04T20:19:00Z

pkgs/by-name/qc/qcp/package.nix

Suggested change

maintainers = with lib.maintainers; [ poptart ];

maintainers = with lib.maintainers; [ poptart ];

platforms = lib.platforms.linux;

actually it's fine to leave platforms as the default, even if it's untested upstream

0xda157

lgtm

terrorbyte · 2025-05-30T18:33:28Z

We got quite a bit out of sync with upstream so I decided to rebase again, so it may need another re-review.

timon-schelling · 2025-06-27T00:03:53Z

`nixpkgs-review` result

Generated using nixpkgs-review-gha

Command: nixpkgs-review pr 361923

Logs: https://github.com/timon-schelling/run-nixpkgs-review/actions/runs/15914872379

`x86_64-linux` (sandbox = true)

✅ 1 package built:

qcp

`aarch64-linux` (sandbox = true)

✅ 1 package built:

qcp

`x86_64-darwin` (sandbox = true)

❌ 1 package failed to build:

qcp

Error logs: `x86_64-darwin`

qcp

failures:
control::channel::test::happy_path
os::unix::test::test_buffers_gigantic_err
os::unix::test::test_buffers_small_ok
os::windows::test::test_buffers_gigantic_err
os::windows::test::test_buffers_small_ok
session::put::test::write_fail_dest_dir_missing
session::put::test::write_fail_io_error
session::put::test::write_fail_permissions
util::socket::test::bind_ipv6
util::socket::test::bind_range
util::socket::test::set_socket_bufsize_direct
util::socket::test::set_udp_buffer_sizes_large_fails
util::socket::test::set_udp_buffer_sizes_small_succeeds

test result: FAILED. 173 passed; 13 failed; 1 ignored; 0 measured; 7 filtered out; finished in 0.95s

error: test failed, to rerun pass -p qcp --lib

`aarch64-darwin` (sandbox = true)

❌ 1 package failed to build:

qcp

Error logs: `aarch64-darwin`

qcp

failures:
control::channel::test::happy_path
os::unix::test::test_buffers_gigantic_err
os::unix::test::test_buffers_small_ok
os::windows::test::test_buffers_gigantic_err
os::windows::test::test_buffers_small_ok
session::put::test::write_fail_dest_dir_missing
session::put::test::write_fail_io_error
session::put::test::write_fail_permissions
util::socket::test::bind_ipv6
util::socket::test::bind_range
util::socket::test::set_socket_bufsize_direct
util::socket::test::set_udp_buffer_sizes_large_fails
util::socket::test::set_udp_buffer_sizes_small_succeeds

test result: FAILED. 173 passed; 13 failed; 1 ignored; 0 measured; 7 filtered out; finished in 0.65s

error: test failed, to rerun pass -p qcp --lib

terrorbyte · 2025-07-11T16:51:13Z

nixpkgs-review result

Generated using nixpkgs-review-gha

Command: nixpkgs-review pr 361923

Logs: https://github.com/timon-schelling/run-nixpkgs-review/actions/runs/15914872379

x86_64-linux (sandbox = true)

✅ 1 package built:

aarch64-linux (sandbox = true)

✅ 1 package built:

x86_64-darwin (sandbox = true)

❌ 1 package failed to build:

Error logs: x86_64-darwin

aarch64-darwin (sandbox = true)

❌ 1 package failed to build:

Error logs: aarch64-darwin

I unfortunately do not have a Darwin/mac to test this with, but I applied some buildtime checks for skipping the tests and bumped versions again.

0xda157 · 2025-07-23T02:25:26Z

I'll run nixpkgs-review-gha again and it darwin isn't fixed you can just mark it as meta.broken = isDarwin

pkgs/by-name/qc/qcp/package.nix

0xda157 · 2025-07-23T02:37:21Z

`nixpkgs-review` result

Generated using nixpkgs-review-gha

Command: nixpkgs-review pr 361923

Logs: https://github.com/awwpotato/nixpkgs-review-gha/actions/runs/16460044796

`x86_64-linux`

✅ 1 package built:

qcp

`aarch64-linux`

✅ 1 package built:

qcp

`x86_64-darwin` (sandbox = true)

✅ 1 package built:

qcp

`aarch64-darwin` (sandbox = true)

✅ 1 package built:

qcp

0xda157 · 2025-07-23T18:59:22Z

everything should just be in one qcp: init at 0.4.2 commit, aside from that LGTM

terrorbyte · 2025-07-24T15:21:35Z

Done.

github-actions bot added 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. labels Dec 5, 2024

terrorbyte force-pushed the pkgs/terrorbyte/qcp branch from dc28357 to 586ab2d Compare December 31, 2024 21:46

terrorbyte changed the title ~~qcp: init at 0.1.3~~ qcp: init at 0.2.0 Dec 31, 2024

github-actions bot removed 10.rebuild-darwin: 1 This PR causes 1 package to rebuild on Darwin. 10.rebuild-linux: 1 This PR causes 1 package to rebuild on Linux. labels Dec 31, 2024

terrorbyte changed the title ~~qcp: init at 0.2.0~~ qcp: init at 0.2.1 Jan 25, 2025

github-actions bot added 10.rebuild-darwin: 1 This PR causes 1 package to rebuild on Darwin. 10.rebuild-linux: 1 This PR causes 1 package to rebuild on Linux. labels Jan 25, 2025

terrorbyte mentioned this pull request Feb 11, 2025

feat: add Nix flake crazyscot/qcp#63

Merged

terrorbyte force-pushed the pkgs/terrorbyte/qcp branch from 863e693 to a47177f Compare February 12, 2025 02:59

terrorbyte changed the title ~~qcp: init at 0.2.1~~ qcp: init at 0.3.0 Feb 12, 2025

terrorbyte force-pushed the pkgs/terrorbyte/qcp branch from a47177f to 9e193b4 Compare February 13, 2025 17:50

terrorbyte force-pushed the pkgs/terrorbyte/qcp branch from 5e09262 to f3cdeae Compare February 19, 2025 16:35

0xda157 suggested changes Mar 25, 2025

View reviewed changes

terrorbyte force-pushed the pkgs/terrorbyte/qcp branch from 8cf69a3 to cff99e7 Compare April 4, 2025 20:16

terrorbyte changed the title ~~qcp: init at 0.3.0~~ qcp: init at 0.3.3 Apr 4, 2025

0xda157 reviewed Apr 4, 2025

View reviewed changes

terrorbyte force-pushed the pkgs/terrorbyte/qcp branch from cff99e7 to 959a9f7 Compare April 4, 2025 20:29

0xda157 approved these changes Apr 4, 2025

View reviewed changes

wegank added the 12.approvals: 1 This PR was reviewed and approved by one person. label Apr 6, 2025

terrorbyte force-pushed the pkgs/terrorbyte/qcp branch from 959a9f7 to 19ff522 Compare May 30, 2025 18:32

terrorbyte changed the title ~~qcp: init at 0.3.3~~ qcp: init at 0.4.1 May 30, 2025

github-actions bot removed the 11.by: package-maintainer This PR was created by a maintainer of all the package it changes. label May 30, 2025

terrorbyte force-pushed the pkgs/terrorbyte/qcp branch from 19ff522 to 40d778d Compare July 11, 2025 16:50

terrorbyte changed the title ~~qcp: init at 0.4.1~~ qcp: init at 0.4.2 Jul 11, 2025

terrorbyte requested a review from 0xda157 July 21, 2025 23:44

0xda157 reviewed Jul 23, 2025

View reviewed changes

pkgs/by-name/qc/qcp/package.nix Outdated Show resolved Hide resolved

terrorbyte force-pushed the pkgs/terrorbyte/qcp branch from de6d1e4 to 3512da8 Compare July 24, 2025 15:21

terrorbyte force-pushed the pkgs/terrorbyte/qcp branch from 3512da8 to c668a8d Compare July 25, 2025 15:35

terrorbyte force-pushed the pkgs/terrorbyte/qcp branch from c668a8d to b181ded Compare August 29, 2025 22:19

terrorbyte changed the title ~~qcp: init at 0.4.2~~ qcp: init at 0.5.1 Aug 29, 2025

terrorbyte force-pushed the pkgs/terrorbyte/qcp branch from b181ded to 2d7b24f Compare November 29, 2025 19:22

terrorbyte changed the title ~~qcp: init at 0.5.1~~ qcp: init at 0.6.0 Nov 29, 2025

qcp: init at 0.8.1

e4a9d7e

terrorbyte force-pushed the pkgs/terrorbyte/qcp branch from 2d7b24f to e4a9d7e Compare January 13, 2026 00:41

terrorbyte changed the title ~~qcp: init at 0.6.0~~ qcp: init at 0.8.1 Jan 13, 2026

	maintainers = with lib.maintainers; [ poptart ];
	maintainers = with lib.maintainers; [ poptart ];
	platforms = lib.platforms.linux;

Uh oh!

Conversation

terrorbyte commented Dec 5, 2024

Things done

Uh oh!

crazyscot commented Feb 11, 2025

Uh oh!

terrorbyte commented Feb 12, 2025

Uh oh!

Tert0 commented Feb 14, 2025

Uh oh!

terrorbyte commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Tert0 commented Feb 14, 2025

Uh oh!

terrorbyte commented Feb 17, 2025

Uh oh!

0xda157 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

crazyscot commented Mar 25, 2025

Uh oh!

0xda157 commented Mar 25, 2025

Uh oh!

terrorbyte commented Apr 4, 2025

Uh oh!

Uh oh!

Uh oh!

0xda157 Apr 4, 2025

Choose a reason for hiding this comment

Uh oh!

0xda157 Apr 4, 2025

Choose a reason for hiding this comment

Uh oh!

0xda157 left a comment

Choose a reason for hiding this comment

Uh oh!

terrorbyte commented May 30, 2025

Uh oh!

timon-schelling commented Jun 27, 2025

nixpkgs-review result

x86_64-linux (sandbox = true)

aarch64-linux (sandbox = true)

x86_64-darwin (sandbox = true)

aarch64-darwin (sandbox = true)

Uh oh!

terrorbyte commented Jul 11, 2025

nixpkgs-review result

x86_64-linux (sandbox = true)

aarch64-linux (sandbox = true)

x86_64-darwin (sandbox = true)

aarch64-darwin (sandbox = true)

Uh oh!

0xda157 commented Jul 23, 2025

Uh oh!

Uh oh!

0xda157 commented Jul 23, 2025

nixpkgs-review result

x86_64-linux

aarch64-linux

x86_64-darwin (sandbox = true)

aarch64-darwin (sandbox = true)

Uh oh!

0xda157 commented Jul 23, 2025

Uh oh!

terrorbyte commented Jul 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

terrorbyte commented Feb 14, 2025 •

edited

Loading

`nixpkgs-review` result

`x86_64-linux` (sandbox = true)

`aarch64-linux` (sandbox = true)

`x86_64-darwin` (sandbox = true)

`aarch64-darwin` (sandbox = true)

`nixpkgs-review` result

`x86_64-linux` (sandbox = true)

`aarch64-linux` (sandbox = true)

`x86_64-darwin` (sandbox = true)

`aarch64-darwin` (sandbox = true)

`nixpkgs-review` result

`x86_64-linux`

`aarch64-linux`

`x86_64-darwin` (sandbox = true)

`aarch64-darwin` (sandbox = true)