about summary refs log tree commit diff
path: root/nixpkgs/pkgs/tools/admin/ansible/lint.nix
diff options
context:
space:
mode:
Diffstat (limited to 'nixpkgs/pkgs/tools/admin/ansible/lint.nix')
-rw-r--r--nixpkgs/pkgs/tools/admin/ansible/lint.nix91
1 files changed, 91 insertions, 0 deletions
diff --git a/nixpkgs/pkgs/tools/admin/ansible/lint.nix b/nixpkgs/pkgs/tools/admin/ansible/lint.nix
new file mode 100644
index 000000000000..fbac95d019ba
--- /dev/null
+++ b/nixpkgs/pkgs/tools/admin/ansible/lint.nix
@@ -0,0 +1,91 @@
+{ lib
+, python3
+, fetchPypi
+, ansible
+}:
+
+python3.pkgs.buildPythonApplication rec {
+  pname = "ansible-lint";
+  version = "6.21.1";
+  format = "pyproject";
+
+  src = fetchPypi {
+    inherit pname version;
+    hash = "sha256-Bf/G38jzy79W9/l3CzQ2/HkJutXB11Rw76BkUx8C324=";
+  };
+
+  postPatch = ''
+    # it is fine if lint tools are missing
+    substituteInPlace conftest.py \
+      --replace "sys.exit(1)" ""
+  '';
+
+  nativeBuildInputs = with python3.pkgs; [
+    setuptools
+    setuptools-scm
+  ];
+
+  propagatedBuildInputs = with python3.pkgs; [
+    # https://github.com/ansible/ansible-lint/blob/master/.config/requirements.in
+    ansible-core
+    ansible-compat
+    black
+    filelock
+    jsonschema
+    packaging
+    pyyaml
+    rich
+    ruamel-yaml
+    subprocess-tee
+    wcmatch
+    yamllint
+  ];
+
+  # tests can't be easily run without installing things from ansible-galaxy
+  doCheck = false;
+
+  nativeCheckInputs = with python3.pkgs; [
+    flaky
+    pytest-xdist
+    pytestCheckHook
+  ];
+
+  preCheck = ''
+    # ansible wants to write to $HOME and crashes if it can't
+    export HOME=$(mktemp -d)
+    export PATH=$PATH:${lib.makeBinPath [ ansible ]}
+
+    # create a working ansible-lint executable
+    export PATH=$PATH:$PWD/src/ansiblelint
+    ln -rs src/ansiblelint/__main__.py src/ansiblelint/ansible-lint
+    patchShebangs src/ansiblelint/__main__.py
+
+    # create symlink like in the git repo so test_included_tasks does not fail
+    ln -s ../roles examples/playbooks/roles
+  '';
+
+  disabledTests = [
+    # requires network
+    "test_cli_auto_detect"
+    "test_install_collection"
+    "test_prerun_reqs_v1"
+    "test_prerun_reqs_v2"
+    "test_require_collection_wrong_version"
+    # re-execs ansible-lint which does not works correct
+    "test_custom_kinds"
+    "test_run_inside_role_dir"
+    "test_run_multiple_role_path_no_trailing_slash"
+    "test_runner_exclude_globs"
+    "test_discover_lintables_umlaut"
+  ];
+
+  makeWrapperArgs = [ "--prefix PATH : ${lib.makeBinPath [ ansible ]}" ];
+
+  meta = with lib; {
+    description = "Best practices checker for Ansible";
+    homepage = "https://github.com/ansible/ansible-lint";
+    changelog = "https://github.com/ansible/ansible-lint/releases/tag/v${version}";
+    license = licenses.mit;
+    maintainers = with maintainers; [ sengaya ];
+  };
+}