nixpkgs/pkgs/tools/security/scorecard/default.nix
2024-09-11 11:57:42 -05:00

95 lines
2.7 KiB
Nix

{ lib
, buildGoModule
, fetchFromGitHub
, installShellFiles
, testers
, scorecard
}:
buildGoModule rec {
pname = "scorecard";
version = "5.0.0";
src = fetchFromGitHub {
owner = "ossf";
repo = pname;
rev = "v${version}";
hash = "sha256-9DuADuEIoZNwkvdKyqus2zNfIK31Jc3+bPW3/z8fvlc=";
# populate values otherwise taken care of by goreleaser,
# unfortunately these require us to use git. By doing
# this in postFetch we can delete .git afterwards and
# maintain better reproducibility of the src.
leaveDotGit = true;
postFetch = ''
cd "$out"
git rev-parse HEAD > $out/COMMIT
# 0000-00-00T00:00:00Z
date -u -d "@$(git log -1 --pretty=%ct)" "+%Y-%m-%dT%H:%M:%SZ" > $out/SOURCE_DATE_EPOCH
find "$out" -name .git -print0 | xargs -0 rm -rf
'';
};
vendorHash = "sha256-apOVAlGjaYSrW4qtUdDNgqwWxnVlBLhrefWEUvN4lzE=";
nativeBuildInputs = [ installShellFiles ];
subPackages = [ "." ];
ldflags = [
"-s"
"-w"
"-X sigs.k8s.io/release-utils/version.gitVersion=v${version}"
"-X sigs.k8s.io/release-utils/version.gitTreeState=clean"
];
# ldflags based on metadata from git and source
preBuild = ''
ldflags+=" -X sigs.k8s.io/release-utils/version.gitCommit=$(cat COMMIT)"
ldflags+=" -X sigs.k8s.io/release-utils/version.buildDate=$(cat SOURCE_DATE_EPOCH)"
'';
preCheck = ''
# Feed in all but the e2e tests for testing
# This is because subPackages above limits what is built to just what we
# want but also limits the tests
getGoDirs() {
go list ./... | grep -v e2e
}
# Ensure other e2e tests that have escaped the e2e dir dont run
export SKIP_GINKGO=1
'';
checkFlags = [
"-skip TestCollectDockerfilePinning/Non-pinned_dockerfile|TestMixedPinning"
];
postInstall = ''
installShellCompletion --cmd scorecard \
--bash <($out/bin/scorecard completion bash) \
--fish <($out/bin/scorecard completion fish) \
--zsh <($out/bin/scorecard completion zsh)
'';
doInstallCheck = true;
installCheckPhase = ''
runHook preInstallCheck
$out/bin/scorecard --help
$out/bin/scorecard version 2>&1 | grep "v${version}"
runHook postInstallCheck
'';
passthru.tests.version = testers.testVersion {
package = scorecard;
command = "scorecard version";
version = "v${version}";
};
meta = with lib; {
homepage = "https://github.com/ossf/scorecard";
changelog = "https://github.com/ossf/scorecard/releases/tag/v${version}";
description = "Security health metrics for Open Source";
mainProgram = "scorecard";
license = licenses.asl20;
maintainers = with maintainers; [ jk developer-guy ];
};
}