diff --git a/.ansible-lint b/.ansible-lint new file mode 100644 index 0000000..d83295a --- /dev/null +++ b/.ansible-lint @@ -0,0 +1,129 @@ +--- +# .ansible-lint + +profile: production # min, basic, moderate,safety, shared, production + +# Allows dumping of results in SARIF format +# sarif_file: result.sarif + +# exclude_paths included in this file are parsed relative to this file's location +# and not relative to the CWD of execution. CLI arguments passed to the --exclude +# option are parsed relative to the CWD of execution. +exclude_paths: + - .github/ + - .ansible-lint +# parseable: true +# quiet: true +# strict: true +# verbosity: 1 + +# Mock modules or roles in order to pass ansible-playbook --syntax-check +#mock_modules: +# - zuul_return +# note the foo.bar is invalid as being neither a module or a collection +# - fake_namespace.fake_collection.fake_module +# - fake_namespace.fake_collection.fake_module.fake_submodule +#mock_roles: +# - mocked_role +# - author.role_name # old standalone galaxy role +# - fake_namespace.fake_collection.fake_role # role within a collection + +# Enable checking of loop variable prefixes in roles +loop_var_prefix: "^(__|{role}_)" + +# Enforce variable names to follow pattern below, in addition to Ansible own +# requirements, like avoiding python identifiers. To disable add `var-naming` +# to skip_list. +var_naming_pattern: "^[a-z_][a-z0-9_]*$" + +use_default_rules: true +# Load custom rules from this specific folder +# rulesdir: +# - ./rule/directory/ + +# Ansible-lint is able to recognize and load skip rules stored inside +# `.ansible-lint-ignore` (or `.config/ansible-lint-ignore.txt`) files. +# To skip a rule just enter filename and tag, like "playbook.yml package-latest" +# on a new line. +# Optionally you can add comments after the tag, prefixed by "#". We discourage +# the use of skip_list below because that will hide violations from the output. +# When putting ignores inside the ignore file, they are marked as ignored, but +# still visible, making it easier to address later. +skip_list: + - risky-shell-pipe +# - skip_this_tag + +# Ansible-lint does not automatically load rules that have the 'opt-in' tag. +# You must enable opt-in rules by listing each rule 'id' below. +enable_list: + - args + - empty-string-compare # opt-in + - no-log-password # opt-in + - no-same-owner # opt-in + - name[prefix] # opt-in + - galaxy-version-incorrect # opt-in + # add yaml here if you want to avoid ignoring yaml checks when yamllint + # library is missing. Normally its absence just skips using that rule. + - yaml +# Report only a subset of tags and fully ignore any others +# tags: +# - jinja[spacing] + +# Ansible-lint does not fail on warnings from the rules or tags listed below +#warn_list: +# - skip_this_tag +# - experimental # experimental is included in the implicit list +# - role-name +# - yaml[document-start] # you can also use sub-rule matches + +# Some rules can transform files to fix (or make it easier to fix) identified +# errors. `ansible-lint --fix` will reformat YAML files and run these transforms. +# By default it will run all transforms (effectively `write_list: ["all"]`). +# You can disable running transforms by setting `write_list: ["none"]`. +# Or only enable a subset of rule transforms by listing rules/tags here. +# write_list: +# - all + +# Offline mode disables installation of requirements.yml and schema refreshing +offline: true + + # Define required Ansible's variables to satisfy syntax check + #extra_vars: + # foo: bar + # multiline_string_variable: | + # line1 + # line2 + # complex_variable: ":{;\t$()" + + # Uncomment to enforce action validation with tasks, usually is not + # needed as Ansible syntax check also covers it. + # skip_action_validation: false + + # List of additional kind:pattern to be added at the top of the default + # match list, first match determines the file kind. + #kinds: + # - playbook: "**/examples/*.{yml,yaml}" + # - galaxy: "**/folder/galaxy.yml" + # - tasks: "**/tasks/*.yml" + # - vars: "**/vars/*.yml" +# - meta: "**/meta/main.yml" +# - yaml: "**/*.yaml-too" + +# List of additional collections to allow in only-builtins rule. +# only_builtins_allow_collections: +# - example_ns.example_collection + +# List of additions modules to allow in only-builtins rule. +# only_builtins_allow_modules: +# - example_module + +# Allow setting custom prefix for name[prefix] rule +#task_name_prefix: "{stem} | " +# Complexity related settings + +# Limit the depth of the nested blocks: +# max_block_depth: 20 + +# Also recognize these versions of Ansible as supported: +# supported_ansible_also: +# - "2.14" diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml new file mode 100644 index 0000000..4505a53 --- /dev/null +++ b/.github/workflows/pull-request.yml @@ -0,0 +1,12 @@ +--- +name: Pull request + +on: pull_request + +jobs: + ansible-lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Run ansible-lint + uses: ansible/ansible-lint@main diff --git a/README.md b/README.md index c9f664d..8b9f48b 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,22 @@ Example Playbook roles: - { role: f500.php_composer, php_composer_install_path: /usr/local/bin/composer, php_composer_wrapper_enabled: no } +Linting +------- +Github actions will check this role with ansible-lint. To run this locally, you will need to follow the following steps: + +```bash +brew install ansible-lint +brew install yamllint +ansible-lint +``` + +to fix the linting errors, run: + +```bash +ansible-lint --fix +``` + License ------- diff --git a/defaults/main.yml b/defaults/main.yml index 8a43ad8..f34235a 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -2,11 +2,10 @@ php_composer_install_path: /usr/local/bin/composer.phar -php_composer_version: ~ - -php_composer_wrapper_enabled: yes +php_composer_version: +php_composer_wrapper_enabled: true php_composer_wrapper_path: /usr/local/bin/composer php_composer_wrapper_ini_directives: - allow_url_fopen: yes + allow_url_fopen: true disable_functions: "" memory_limit: -1 diff --git a/meta/main.yml b/meta/main.yml index 410e9e4..2e1ba33 100644 --- a/meta/main.yml +++ b/meta/main.yml @@ -3,15 +3,16 @@ galaxy_info: author: "Jasper N. Brouwer, Ramon de la Fuente" role_name: php_composer + namespace: "f500" description: Install Composer, the dependency manager for PHP company: Future500 license: LGPL-3.0 min_ansible_version: "1.4" platforms: - - name: Debian - versions: - - bullseye - - bookworm + - name: Debian + versions: + - bullseye + - bookworm galaxy_tags: - web - system diff --git a/tasks/main.yml b/tasks/main.yml index 5bef456..27f5ebb 100644 --- a/tasks/main.yml +++ b/tasks/main.yml @@ -1,42 +1,43 @@ --- - - name: Check if Composer is installed - stat: + ansible.builtin.stat: path: "{{ php_composer_install_path }}" register: php_composer_binary - name: Install packages needed to install Composer - apt: + ansible.builtin.apt: name: wget state: present when: not php_composer_binary.stat.exists - name: Create the install script - template: + ansible.builtin.template: src: composer-install.sh.j2 dest: /tmp/composer-install.sh - mode: 0755 + mode: "0755" when: not php_composer_binary.stat.exists - name: Install Composer - command: ./composer-install.sh + ansible.builtin.command: ./composer-install.sh args: chdir: /tmp when: not php_composer_binary.stat.exists + changed_when: false - name: Remove the install script - file: + ansible.builtin.file: path: /tmp/composer-install.sh state: absent when: not php_composer_binary.stat.exists - name: Move Composer to the install path - command: mv /tmp/composer.phar "{{ php_composer_install_path }}" + ansible.builtin.command: mv /tmp/composer.phar "{{ php_composer_install_path }}" when: not php_composer_binary.stat.exists + changed_when: false - name: Enable the wrapper - template: + ansible.builtin.template: src: composer.j2 dest: "{{ php_composer_wrapper_path }}" - mode: 0755 + mode: "0755" when: php_composer_wrapper_enabled | bool