【ルール説明・shared】no-relative-paths

こちらの記事はAnsible lint Advent Calendar 2022 24日目の記事になります。

今回はルール no-relative-paths について説明します。

no-relative-paths

no-relative-paths は ansible.builtin.copy モジュールおよび ansible.builtin.template モジュールにおいてsrcキーの要素に相対パスが含まれていないか検証します。

ansible.builtin.copy モジュールおよびansible.builtin.template モジュールでファイル操作を行う場合はファイルのパスの指定方法が決まっています。ansible.builtin.copy モジュールを利用してファイルをコピーする場合、ファイルはプロジェクトのfiles/ディレクトリ以下に置かれている事が想定されます。files/ディレクトリ以下以外のパスへファイルを置く場合、パスは絶対パスで指定します。また ansible.builtin.template モジュールを利用してファイル操作を行う場合はプロジェクトのtemplates/ディレクトリ以下にテンプレートファイルが置かれている事が想定されます。templates/ディレクトリ以下以外のパスへファイルを置く場合はパスは絶対パスで指定します。

問題のあるコードその１

srcが相対パスで指定されている

---
- name: Example playbook
  hosts: all
  tasks:
    - name: Template a file to /etc/file.conf
      ansible.builtin.template:
        src: ../my_templates/foo.j2 # <- 相対パスになっている
        dest: /etc/file.conf
        owner: bin
        group: wheel
        mode: "0644"

修正されたコードその１

プロジェクトのtemplatesディレクトリ内のパスを指定する

---
- name: Example playbook
  hosts: all
  tasks:
    - name: Template a file to /etc/file.conf
      ansible.builtin.template:
        src: foo.j2 # <- `templates`ディレクトリ内のパスを指定する
        dest: /etc/file.conf
        owner: bin
        group: wheel
        mode: "0644"

問題のあるコードその２

- name: Example playbook
  hosts: all
  vars:
    source_path: ../../my_templates/foo.j2 # <- 相対パスが指定されている
  tasks:
    - name: Copy a file to /etc/file.conf
      ansible.builtin.copy:
        src: "{{ source_path }}" # <- 変数が代入されている部分
        dest: /etc/foo.conf
        owner: foo
        group: foo
        mode: "0644"

修正されたコードその２

- name: Example playbook
  hosts: all
  vars:
    source_path: foo.j2 # <- filesディレクトリ内でのパスを指定する
  tasks:
    - name: Copy a file to /etc/file.conf
      ansible.builtin.copy:
        src: "{{ source_path }}" # <- 変数が代入されている部分
        dest: /etc/foo.conf
        owner: foo
        group: foo
        mode: "0644"

参考サイト

• no-relative-paths — Ansible Lint Documentation