nixpkgs/pkgs/tools/networking/bandwhich/default.nix
Vlad M b7f3957dd2
Merge pull request #285103 from emilylange/bandwhich
bandwhich: add shell completions and man page, add `meta.changelog`
2024-02-16 12:54:20 +02:00

62 lines
1.9 KiB
Nix

{ lib, stdenv, fetchFromGitHub, rustPlatform, Security, installShellFiles }:
rustPlatform.buildRustPackage rec {
pname = "bandwhich";
version = "0.22.2";
src = fetchFromGitHub {
owner = "imsnif";
repo = pname;
rev = "v${version}";
hash = "sha256-/uG1xjhxnIkS3rq7Tv1q1v8X7p1baDB8OiSEV9OLyfo=";
};
cargoLock = {
lockFile = ./Cargo.lock;
outputHashes = {
"packet-builder-0.7.0" = "sha256-KxNrnLZ/z3JJ3E1pCTJF9tNXI7XYNRc6ooTUz3avpjw=";
};
};
checkFlags = [
# failing in upstream CI
"--skip=tests::cases::ui::layout_under_50_width_under_50_height"
];
nativeBuildInputs = [ installShellFiles ];
buildInputs = lib.optional stdenv.isDarwin Security;
# 10 passed; 47 failed https://hydra.nixos.org/build/148943783/nixlog/1
doCheck = !stdenv.isDarwin;
preConfigure = ''
export BANDWHICH_GEN_DIR=_shell-files
mkdir -p $BANDWHICH_GEN_DIR
'';
postInstall = ''
installManPage $BANDWHICH_GEN_DIR/bandwhich.1
installShellCompletion $BANDWHICH_GEN_DIR/bandwhich.{bash,fish} \
--zsh $BANDWHICH_GEN_DIR/_bandwhich
'';
meta = with lib; {
description = "A CLI utility for displaying current network utilization";
longDescription = ''
bandwhich sniffs a given network interface and records IP packet size, cross
referencing it with the /proc filesystem on linux or lsof on MacOS. It is
responsive to the terminal window size, displaying less info if there is
no room for it. It will also attempt to resolve ips to their host name in
the background using reverse DNS on a best effort basis.
'';
homepage = "https://github.com/imsnif/bandwhich";
changelog = "https://github.com/imsnif/bandwhich/blob/${src.rev}/CHANGELOG.md";
license = licenses.mit;
maintainers = with maintainers; [ Br1ght0ne figsoda ];
platforms = platforms.unix;
mainProgram = "bandwhich";
};
}