From c4e8e9ea61461be379839c29238686563f3a783c Mon Sep 17 00:00:00 2001 From: Steffen Scheib Date: Sun, 4 Feb 2024 22:13:51 +0100 Subject: [PATCH] Initial --- .ansible-lint | 29 +++ .github/workflows/ansible-galaxy.yml | 22 ++ .github/workflows/ansible-lint.yml | 15 ++ .pre-commit-config.yaml | 21 ++ .yamllint | 45 ++++ LICENSE | 339 +++++++++++++++++++++++++++ README.md | 88 +++++++ defaults/main.yml | 4 + meta/main.yml | 27 +++ tasks/assert.yml | 62 +++++ tasks/file_deployment.yml | 30 +++ tasks/main.yml | 12 + vars/main.yml | 7 + 13 files changed, 701 insertions(+) create mode 100644 .ansible-lint create mode 100644 .github/workflows/ansible-galaxy.yml create mode 100644 .github/workflows/ansible-lint.yml create mode 100644 .pre-commit-config.yaml create mode 100644 .yamllint create mode 100644 LICENSE create mode 100644 README.md create mode 100644 defaults/main.yml create mode 100644 meta/main.yml create mode 100644 tasks/assert.yml create mode 100644 tasks/file_deployment.yml create mode 100644 tasks/main.yml create mode 100644 vars/main.yml diff --git a/.ansible-lint b/.ansible-lint new file mode 100644 index 00000000..750e93fe --- /dev/null +++ b/.ansible-lint @@ -0,0 +1,29 @@ +--- +enable_list: + - 'args' + - 'empty-string-compare' + - 'no-log-password' + - 'no-same-owner' + - 'name[prefix]' + +kinds: + - yaml: '.ansible-lint' + - yaml: '.github/workflows/*.{yml,yaml}' + - yaml: '.pre-commit-config.yaml' + - yaml: '.yamllint' + - yaml: '**/*.{yml,yaml}' + +loop_var_prefix: '^(__|{role}_)' +max_block_depth: 20 +offline: true +profile: 'production' +skip_action_validation: false +skip_list: [] +task_name_prefix: '{stem} | ' +use_default_rules: true +var_naming_pattern: '^[a-z_][a-z0-9_]*$' +warn_list: + - 'experimental' +write_list: + - 'none' +... diff --git a/.github/workflows/ansible-galaxy.yml b/.github/workflows/ansible-galaxy.yml new file mode 100644 index 00000000..baec5938 --- /dev/null +++ b/.github/workflows/ansible-galaxy.yml @@ -0,0 +1,22 @@ +--- +name: 'Publish latest release to Ansible Galaxy' + +on: + push: + branches: + - 'main' + workflow_dispatch: {} + +jobs: + build: + name: 'Publish to Ansible Galaxy' + runs-on: 'ubuntu-latest' + steps: + - name: 'checkout' + uses: 'actions/checkout@v2' + - name: 'galaxy' + uses: 'robertdebock/galaxy-action@1.2.0' + with: + galaxy_api_key: '${{ secrets.galaxy_api_key }}' + git_branch: 'main' +... diff --git a/.github/workflows/ansible-lint.yml b/.github/workflows/ansible-lint.yml new file mode 100644 index 00000000..3584f4e6 --- /dev/null +++ b/.github/workflows/ansible-lint.yml @@ -0,0 +1,15 @@ +--- +name: 'ansible-lint' +on: + pull_request: + branches: ['main'] + workflow_dispatch: {} +jobs: + build: + name: 'Ansible Lint' + runs-on: 'ubuntu-latest' + steps: + - uses: 'actions/checkout@v4' + - name: 'Run ansible-lint' + uses: 'ansible/ansible-lint@main' +... diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 00000000..159ad455 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,21 @@ +--- +repos: + - repo: 'https://github.com/ansible/ansible-lint' + rev: 'v6.20.3' + hooks: + - name: 'Ansible-lint' + additional_dependencies: + # https://github.com/pre-commit/pre-commit/issues/1526 + # If you want to use specific version of ansible-core or ansible, feel + # free to override `additional_dependencies` in your own hook config + # file. + - 'ansible-core>=2.15' + always_run: true + description: 'This hook runs ansible-lint.' + entry: 'python3 -m ansiblelint -v --force-color' + id: 'ansible-lint' + language: 'python' + # do not pass files to ansible-lint, see: + # https://github.com/ansible/ansible-lint/issues/611 + pass_filenames: false +... diff --git a/.yamllint b/.yamllint new file mode 100644 index 00000000..34d70216 --- /dev/null +++ b/.yamllint @@ -0,0 +1,45 @@ +--- +extends: 'default' + +rules: + braces: + level: 'error' + max-spaces-inside: 1 + brackets: + level: 'error' + max-spaces-inside: 1 + colons: + level: 'error' + max-spaces-after: -1 + commas: + level: 'error' + max-spaces-after: -1 + comments: 'enable' + comments-indentation: 'enable' + document-end: 'enable' + document-start: 'enable' + empty-lines: + level: 'error' + max: 3 + empty-values: 'enable' + float-values: 'enable' + hyphens: 'enable' + indentation: 'enable' + key-duplicates: 'enable' + key-ordering: 'disable' + line-length: + max: 120 + new-line-at-end-of-file: 'enable' + new-lines: + type: 'unix' + octal-values: 'enable' + quoted-strings: 'enable' + trailing-spaces: 'enable' + truthy: 'enable' + +yaml-files: + - '*.yaml' + - '*.yml' + - '.yamllint' + - '.ansible.lint' +... diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..d159169d --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 index 00000000..5695c8c5 --- /dev/null +++ b/README.md @@ -0,0 +1,88 @@ + +file_deployment +========= +This is a *very* simple role that will copy files to the managed nodes using `ansible.builtin.copy`. + +Role Variables +-------------- +| variable | default | required | description | +| :--------------------------------- | :--------------------------- | :------- | :----------------------------------------------------------------------------- | +| `fd_files` | unset | true | Files to deploy. See below for an extended example how to define it | +| `fd_quiet_assert` | `false` | false | Whether to quiet the assert statements | + +## Variable `fd_files` + +An extended example of only the `fd_files` variable is illustrated down below: +``` +fd_files: + - src: 'sshd_motd' + dest: '/etc/motd' + owner: 'root' + group: 'root' + mode: '0644' + + - src: 'sshd_issue.net' + dest: '/etc/issue.net' + owner: 'root' + group: 'root' + mode: '0644' + + - content: >- + This is my text + dest: '/home/steffen/test' + owner: 'steffen' + group: 'steffen' + mode: '0400' +``` +The attributes `dest`, `owner`, `group` and `mode` are required as well as either `src` or `content`. These attributes are validated for their *existence*. The permission +attributes are deliberately enforced (althought `ansible.builtin.copy` does not require them) to avoid accidental unsafe file deployments which have too broad permissions. +This way, a user needs to consciously decide to set broad permissions. + +The variables are **not** validated whether they have the correct type, etc. The only validatation is the aforementioned existence of the attributes. + +This role supports all attributes of [`ansible.builtin.copy`](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/copy_module.html) which are supported at +the time of this writing (04.02.2024). + +Dependencies +------------ + +None + +Example Playbook +---------------- + +``` +--- +- name: 'Deploy files' + hosts: 'all' + gather_facts: false + roles: + - role: 'file_deployment' + vars: + fd_quiet_assert: false + fd_files: + - src: 'sshd_motd' + dest: '/etc/motd' + owner: 'root' + group: 'root' + mode: '0644' + + - src: 'sshd_issue.net' + dest: '/etc/issue.net' + owner: 'root' + group: 'root' + mode: '0644' + + - content: >- + This is my text + dest: '/home/steffen/test' + owner: 'steffen' + group: 'steffen' + mode: '0400' +... +``` + +License +------- + +GPL-2.0-or-later diff --git a/defaults/main.yml b/defaults/main.yml new file mode 100644 index 00000000..57be890f --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,4 @@ +--- +# Whether to quiet assert statements +_def_fd_quiet_assert: false +... diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 00000000..26498889 --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,27 @@ +--- +galaxy_info: + role_name: 'file_deployment' + namespace: 'sscheib' + author: 'Steffen Scheib' + description: 'Very simple role to deploy files' + issue_tracker_url: 'https://github.com/sscheib/ansible-role-file_deployment/issues' + license: 'GPL-2.0-or-later' + min_ansible_version: '2.12' + platforms: + - name: 'EL' + versions: + - '9' + - '8' + - '7' + + - name: 'Debian' + versions: + - 'bookworm' + - 'buster' + - 'bullseye' + + galaxy_tags: + - 'filedeployment' + - 'files' +dependencies: [] +... diff --git a/tasks/assert.yml b/tasks/assert.yml new file mode 100644 index 00000000..77f57ca1 --- /dev/null +++ b/tasks/assert.yml @@ -0,0 +1,62 @@ +--- +# NOTE: _fd_quiet_assert does not impact this task, as it first needs to be ensured that it actually is +# properly defined +- name: 'Ensure mandatory variables, as well as variables, which have a default value, are set (boolean)' + ansible.builtin.assert: + that: + - "lookup('ansible.builtin.vars', __t_var) is defined" + - "lookup('ansible.builtin.vars', __t_var) | bool | string == lookup('ansible.builtin.vars', __t_var) | string" + - "lookup('ansible.builtin.vars', __t_var) is boolean" + success_msg: "Variable '{{ __t_var }}' defined properly - value: '{{ lookup('ansible.builtin.vars', __t_var) }}'" + fail_msg: "Variable '{{ __t_var }}' failed to validate" + loop: + - '_fd_quiet_assert' + loop_control: + loop_var: '__t_var' + label: 'variable: {{ __t_var }}' + +- name: 'Ensure _fd_packages is defined properly' + ansible.builtin.assert: + that: + # dest is defined for all items + - >- + _fd_files | + selectattr('dest', 'undefined') | + length == 0 + + # owner is defined for all items + - >- + _fd_files | + selectattr('owner', 'undefined') | + length == 0 + + # group is defined for all items + - >- + _fd_files | + selectattr('group', 'undefined') | + length == 0 + + # mode is defined for all items + - >- + _fd_files | + selectattr('mode', 'undefined') | + length == 0 + + # ensure all files that don't have src defined, have content defined + - >- + _fd_files | + rejectattr('src', 'defined') | + selectattr('content', 'undefined') | + length == 0 + + # ensure all files that don't have content defined, have src defined + - >- + _fd_files | + rejectattr('content', 'defined') | + selectattr('src', 'undefined') | + length == 0 + + success_msg: 'Files are defined correctly' + fail_msg: 'One or more failed failed to validated correctly' + quiet: '{{ _fd_quiet_assert }}' +... diff --git a/tasks/file_deployment.yml b/tasks/file_deployment.yml new file mode 100644 index 00000000..fa29280a --- /dev/null +++ b/tasks/file_deployment.yml @@ -0,0 +1,30 @@ +--- +- name: 'file_deployment | Deploy file' + ansible.builtin.copy: + attributes: '{{ __t_file.attributes | default(omit) }}' + backup: '{{ __t_file.backup | default(omit) }}' + checksum: '{{ __t_file.checksum | default(omit) }}' + content: '{{ __t_file.content | default(omit) }}' + decrypt: '{{ __t_file.decrypt | default(omit) }}' + dest: '{{ __t_file.dest }}' + follow: '{{ __t_file.follow | default(omit) }}' + directory_mode: '{{ __t_file.directory_mode | default(omit) }}' + force: '{{ __t_file.force | default(omit) }}' + group: '{{ __t_file.group }}' + local_follow: '{{ __t_file.local_follow | default(false) }}' + mode: '{{ __t_file.mode }}' + owner: '{{ __t_file.owner }}' + remote_src: '{{ __t_file.remote_source | default(omit) }}' + selevel: '{{ __t_file.selevel | default(omit) }}' + serole: '{{ __t_file.serole | default(omit) }}' + setype: '{{ __t_file.setype | default(omit) }}' + seuser: '{{ __t_file.seuser | default(omit) }}' + src: '{{ __t_file.src | default(omit) }}' + unsafe_writes: '{{ __t_file.unsafe_writes | default(omit) }}' + validate: '{{ __t_file.validate | default(omit) }}' + become: true + loop: '{{ _fd_files }}' + loop_control: + loop_var: '__t_file' + label: '{{ __t_file.dest }}' +... diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 00000000..b73e528e --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,12 @@ +--- +- name: 'Include tasks to ensure all variables are defined properly' + ansible.builtin.include_tasks: + file: 'assert.yml' + +- name: 'Include tasks to deploy files' + ansible.builtin.include_tasks: + file: 'file_deployment.yml' + when: + - '_fd_files is defined' + - '_fd_files | length > 0' +... diff --git a/vars/main.yml b/vars/main.yml new file mode 100644 index 00000000..9c5be8ce --- /dev/null +++ b/vars/main.yml @@ -0,0 +1,7 @@ +--- +# Packages to install +_fd_files: '{{ fd_files | mandatory }}' + +# Whether to quiet assert statements +_fd_quiet_assert: '{{ fd_quiet_assert | default(_def_fd_quiet_assert) }}' +...