Add ansible-lint support

.gitignore

@@ -139,3 +139,6 @@ cython_debug/
 /dist/
 /.pids
 /.pants.workdir.file_lock*
+
+# IDEs
+/.idea/

helloansible/BUILD.pants

@@ -1,13 +1,15 @@
-ansible_sources(
-    name="libansible",
-    sources=["**/*"],
-)
-
 ansible_deployment(
     name="helloansible",
-    dependencies=[":libansible"],
+    dependencies=[""],
     playbook="playbook.yml",
     # inventory="", # TODO: Could this be setup like the Docker registries? in pants.toml
     # tags="", # TODO: Might need a different name to not overlap
     # timeout="",
 )
+
+ansible_deployment(
+    name="helloansible_with_tags",
+    dependencies=[""],
+    playbook="playbook.yml",
+    ansible_playbook_args=["--tags", "hihello"],
+)

helloansible/hello/collection/BUILD

@@ -0,0 +1,4 @@
+ansible_collection(
+	name="hello.collection",
+	dependencies=[""],
+)

helloansible/hello/collection/README.md

@@ -0,0 +1,3 @@
+# Ansible Collection - hello.collection
+
+Documentation for the collection.

helloansible/hello/collection/galaxy.yml

@@ -0,0 +1,19 @@
+### REQUIRED
+namespace: hello
+name: collection
+version: 1.0.0
+readme: README.md
+authors:
+- your name <[email protected]>
+### OPTIONAL but strongly recommended
+description: your collection description
+license:
+- GPL-2.0-or-later
+license_file: ''
+tags: []
+dependencies: {}
+repository: http://example.com/repository
+documentation: http://docs.example.com
+homepage: http://example.com
+issues: http://example.com/issue/tracker
+build_ignore: []

helloansible/hello/collection/playbooks/playbook.yml

@@ -0,0 +1,6 @@
+---
+- hosts: localhost
+  tasks:
+    - name: Create an error in the collection lints
+      ansible.builtin.shell: ls
+      register: shell_result

helloansible/hello/collection/plugins/README.md

@@ -0,0 +1 @@
+# Collections Plugins Directory

helloansible/hello/collection/roles/hellorole/BUILD

@@ -0,0 +1,4 @@
+ansible_role(
+	name="helloansiblerole",
+	dependencies=[""],
+)

helloansible/hello/collection/roles/hellorole/README.md

@@ -0,0 +1,4 @@
+Role Name
+=========
+
+A brief description of the role goes here.

helloansible/hello/collection/roles/hellorole/defaults/main.yml

@@ -0,0 +1,2 @@
+---
+# defaults file for hellorole

helloansible/hello/collection/roles/hellorole/handlers/main.yml

@@ -0,0 +1,5 @@
+---
+- name: trigger handler
+  debug:
+    msg: |
+      handler triggered

helloansible/hello/collection/roles/hellorole/meta/main.yml

@@ -0,0 +1,8 @@
+galaxy_info:
+  author: your name
+  description: your role description
+  company: your company (optional)
+  license: license (GPL-2.0-or-later, MIT, etc)
+  min_ansible_version: 2.1
+  galaxy_tags: []
+dependencies: []

helloansible/hello/collection/roles/hellorole/tasks/main.yml

@@ -0,0 +1,17 @@
+---
+- name: display in role
+  debug:
+    msg: |
+      Hello from role
+
+- name: trigger error in ansible-lint
+  shell: >-
+    echo "hello from shell in role"
+
+- name: trigger handler to test that handlers are included
+  debug:
+    msg: |
+      trigger handler in role
+  changed_when: true
+  notify:
+    - "trigger handler"

helloansible/hello/collection/roles/hellorole/tests/inventory

@@ -0,0 +1,2 @@
+localhost
+

helloansible/hello/collection/roles/hellorole/tests/test.yml

@@ -0,0 +1,5 @@
+---
+- hosts: localhost
+  remote_user: root
+  roles:
+    - hellorole

helloansible/hello/collection/roles/hellorole/vars/main.yml

@@ -0,0 +1,2 @@
+---
+# vars file for hellorole

helloansible/other_playbook.yml

@@ -0,0 +1,11 @@
+---
+- name: other playbook
+  hosts: localhost
+  connection: local
+  gather_facts: false
+
+  tasks:
+    - name: log from other playbook
+      debug:
+        msg: >-
+          Hello I am in another playbook

helloansible/playbook.yml

@@ -3,3 +3,17 @@
   roles:
     - role: example
     - role: collectionexample
+
+  tasks:
+    - name: A do-nothing shell command
+      ansible.builtin.shell: ls
+      register: shell_result
+
+    - name: Print out the results of the shell command
+      ansible.builtin.debug:
+        var: shell_result
+
+    - name: include some tasks from context
+      include_tasks: tasks/main.yml
+
+- import_playbook: other_playbook.yml

helloansible/tasks/main.yml

@@ -0,0 +1,5 @@
+---
+- name: log from tasks folder
+  debug:
+    msg: >-
+      Hello I am in the tasks folder

pants-plugins/experimental/ansible/BUILD

@@ -1 +1,11 @@
+file(
+	name="helloansible", source="helloansible.test.toml"
+)
+
+
 python_sources()
+python_tests(
+	name="tests",
+	dependencies=[":helloansible"]
+
+)

pants-plugins/experimental/ansible/README.md

@@ -3,16 +3,11 @@
 ## How to use
 
 In your `BUILD` file, use the new `ansible_sources` to pull in the entire target directory and `ansible_deployment` to support the new `./pants deploy` goal:
-
-```python
-ansible_sources(
-    name="libansible",
-    sources=["**/*"],
-)
 
+```python
 ansible_deployment(
     name="helloansible",
-    dependencies=[":libansible"],
+    dependencies=[""],
     playbook="playbook.yml",
     #inventory="", # TODO: Could this be setup like the Docker registries? in pants.toml
     #tags="", # TODO: Might need a different name to not overlap

pants-plugins/experimental/ansible/deploy.py

@@ -15,9 +15,9 @@
 from pants.engine.fs import EMPTY_DIGEST, Digest
 from pants.engine.goal import Goal, GoalSubsystem
 from pants.engine.process import FallibleProcessResult
-from pants.engine.rules import Get, collect_rules, goal_rule
+from pants.engine.rules import Get, Rule, collect_rules, goal_rule
 from pants.engine.target import FieldSet
-from pants.engine.unions import union
+from pants.engine.unions import UnionRule, union
 from pants.util.logging import LogLevel
 from pants.util.memo import memoized_property
 from pants.util.meta import frozen_after_init
@@ -158,13 +158,11 @@ async def deploy(
     )
 
     field_set = target_roots_to_deployment_field_sets.field_sets[0]
-    _ = await Get(
-        DeployResults, DeploymentFieldSet, field_set
-    )  # TODO: Make Flake happy
-    # request = await Get(DeployResults, DeploymentFieldSet, field_set)
+    request = await Get(DeployResults, DeploymentFieldSet, field_set)
     # TODO: Do something with the result
+    logger.info(request)
     return Deploy(exit_code=0)
 
 
-def rules():
+def rules() -> Iterable[Rule | UnionRule]:
     return collect_rules()

pants-plugins/experimental/ansible/helloansible.test.toml

@@ -0,0 +1,24 @@
+"helloansible/playbook.yml" = "---\n- hosts: localhost\n  roles:\n    - role: example\n    - role: collectionexample\n\n  tasks:\n    - name: A do-nothing shell command\n      ansible.builtin.shell: ls\n      register: shell_result\n\n    - name: Print out the results of the shell command\n      ansible.builtin.debug:\n        var: shell_result\n\n    - name: include some tasks from context\n      include_tasks: tasks/main.yml\n\n- import_playbook: other_playbook.yml\n"
+"helloansible/requirements.yml" = "---\ncollections:\n  # With just the collection name\n  - community.docker\n"
+"helloansible/other_playbook.yml" = "---\n- name: other playbook\n  hosts: localhost\n  connection: local\n  gather_facts: false\n\n  tasks:\n    - name: log from other playbook\n      debug:\n        msg: >-\n          Hello I am in another playbook\n"
+"helloansible/BUILD.pants" = "ansible_deployment(\n    name=\"helloansible\",\n    dependencies=[\"\"],\n    playbook=\"playbook.yml\",\n    # inventory=\"\", # TODO: Could this be setup like the Docker registries? in pants.toml\n    # tags=\"\", # TODO: Might need a different name to not overlap\n    # timeout=\"\",\n)\n\nansible_deployment(\n    name=\"helloansible_with_tags\",\n    dependencies=[\"\"],\n    playbook=\"playbook.yml\",\n    ansible_playbook_args=[\"--tags\", \"hihello\"],\n)\n"
+"helloansible/roles/collectionexample/tasks/main.yml" = "---\n- name: Get info on docker host\n  community.docker.docker_host_info:\n  register: docker_result\n\n- name: Print out the results of the docker command\n  ansible.builtin.debug:\n    var: docker_result\n\n"
+"helloansible/roles/example/tasks/main.yml" = "---\n- name: A do-nothing shell command\n  ansible.builtin.shell: ls\n  register: shell_result\n\n- name: Print out the results of the shell command\n  ansible.builtin.debug:\n    var: shell_result\n\n"
+"helloansible/tasks/main.yml" = "---\n- name: log from tasks folder\n  debug:\n    msg: >-\n      Hello I am in the tasks folder\n"
+"helloansible/hello/BUILD" = ""
+"helloansible/hello/collection/BUILD" = "ansible_collection(\n\tname=\"hello.collection\",\n\tdependencies=[\"\"],\n)"
+"helloansible/hello/collection/README.md" = "# Ansible Collection - hello.collection\n\nDocumentation for the collection.\n"
+"helloansible/hello/collection/galaxy.yml" = "### REQUIRED\nnamespace: hello\nname: collection\nversion: 1.0.0\nreadme: README.md\nauthors:\n- your name <[email protected]>\n### OPTIONAL but strongly recommended\ndescription: your collection description\nlicense:\n- GPL-2.0-or-later\nlicense_file: ''\ntags: []\ndependencies: {}\nrepository: http://example.com/repository\ndocumentation: http://docs.example.com\nhomepage: http://example.com\nissues: http://example.com/issue/tracker\nbuild_ignore: []\n"
+"helloansible/hello/collection/plugins/README.md" = "# Collections Plugins Directory\n"
+"helloansible/hello/collection/playbooks/playbook.yml" = "---\n- hosts: localhost\n  tasks:\n    - name: Create an error in the collection lints\n      ansible.builtin.shell: ls\n      register: shell_result\n"
+"helloansible/hello/collection/roles/BUILD" = ""
+"helloansible/hello/collection/roles/hellorole/BUILD" = "ansible_role(\n\tname=\"helloansiblerole\",\n\tdependencies=[\"\"],\n)"
+"helloansible/hello/collection/roles/hellorole/README.md" = "Role Name\n=========\n\nA brief description of the role goes here.\n"
+"helloansible/hello/collection/roles/hellorole/defaults/main.yml" = "---\n# defaults file for hellorole\n"
+"helloansible/hello/collection/roles/hellorole/vars/main.yml" = "---\n# vars file for hellorole\n"
+"helloansible/hello/collection/roles/hellorole/meta/main.yml" = "galaxy_info:\n  author: your name\n  description: your role description\n  company: your company (optional)\n  license: license (GPL-2.0-or-later, MIT, etc)\n  min_ansible_version: 2.1\n  galaxy_tags: []\ndependencies: []\n"
+"helloansible/hello/collection/roles/hellorole/tasks/main.yml" = "---\n- name: display in role\n  debug:\n    msg: |\n      Hello from role\n\n- name: trigger error in ansible-lint\n  shell: >-\n    echo \"hello from shell in role\"\n\n- name: trigger handler to test that handlers are included\n  debug:\n    msg: |\n      trigger handler in role\n  changed_when: true\n  notify:\n    - \"trigger handler\"\n"
+"helloansible/hello/collection/roles/hellorole/handlers/main.yml" = "---\n- name: trigger handler\n  debug:\n    msg: |\n      handler triggered\n"
+"helloansible/hello/collection/roles/hellorole/tests/test.yml" = "---\n- hosts: localhost\n  remote_user: root\n  roles:\n    - hellorole\n"
+"helloansible/hello/collection/roles/hellorole/tests/inventory" = "localhost\n\n"
+"helloansible/inventories/localhost" = "[localhost]\n"

pants-plugins/experimental/ansible/register.py

@@ -5,9 +5,9 @@
 from experimental.ansible.deploy import rules as deploy_rules
 from experimental.ansible.rules import rules as ansible_rules
 from experimental.ansible.target_types import (
+    AnsibleCollection,
     AnsibleDeployment,
-    AnsibleSourcesGeneratorTarget,
-    AnsibleSourceTarget,
+    AnsibleRole,
 )
 from pants.engine.rules import Rule
 from pants.engine.target import Target
@@ -22,8 +22,4 @@ def rules() -> Iterable[Rule | UnionRule]:
 
 
 def target_types() -> Iterable[type[Target]]:
-    return (
-        AnsibleDeployment,
-        AnsibleSourceTarget,
-        AnsibleSourcesGeneratorTarget,
-    )
+    return (AnsibleDeployment, AnsibleRole, AnsibleCollection)