Merge pull request #268619 from tweag/lib-descriptions
[NixPkgs.git] / pkgs / development / tools / conftest / default.nix
blobe48d2d8ae8a2289cdbbf977faa8804c2c8ba70d6
1 { lib
2 , buildGoModule
3 , fetchFromGitHub
4 , installShellFiles
5 }:
7 buildGoModule rec {
8   pname = "conftest";
9   version = "0.46.0";
11   src = fetchFromGitHub {
12     owner = "open-policy-agent";
13     repo = "conftest";
14     rev = "refs/tags/v${version}";
15     hash = "sha256-51OGcic3clPYjj4bmiRVmViqJUEuwzkTtNl9U3OPAdI=";
16   };
17   vendorHash = "sha256-nDRg1gF6igE2FJ+s39j5EQ5/h9QkuSF2Bo9zxR3WkBE=";
19   ldflags = [
20     "-s"
21     "-w"
22     "-X github.com/open-policy-agent/conftest/internal/commands.version=${version}"
23   ];
25   nativeBuildInputs = [
26     installShellFiles
27   ];
29   preCheck = ''
30     export HOME="$(mktemp -d)"
31   '';
33   postInstall = ''
34     installShellCompletion --cmd conftest \
35       --bash <($out/bin/conftest completion bash) \
36       --fish <($out/bin/conftest completion fish) \
37       --zsh <($out/bin/conftest completion zsh)
38   '';
40   doInstallCheck = true;
41   installCheckPhase = ''
42     export HOME="$(mktemp -d)"
43     $out/bin/conftest --version | grep ${version} > /dev/null
44   '';
46   meta = with lib; {
47     description = "Write tests against structured configuration data";
48     downloadPage = "https://github.com/open-policy-agent/conftest";
49     homepage = "https://www.conftest.dev";
50     changelog = "https://github.com/open-policy-agent/conftest/releases/tag/v${version}";
51     license = licenses.asl20;
52     longDescription = ''
53       Conftest helps you write tests against structured configuration data.
54       Using Conftest you can write tests for your Kubernetes configuration,
55       Tekton pipeline definitions, Terraform code, Serverless configs or any
56       other config files.
58       Conftest uses the Rego language from Open Policy Agent for writing the
59       assertions. You can read more about Rego in 'How do I write policies' in
60       the Open Policy Agent documentation.
61     '';
62     maintainers = with maintainers; [ jk yurrriq ];
63   };