[skip ci] automated docs update

Co-authored-by: Robert Kaussow <xoxys@rknet.org>
Co-committed-by: Robert Kaussow <xoxys@rknet.org>

.gitignore

@@ -0,0 +1,11 @@
+# ---> Ansible
+*.retry
+plugins
+library
+
+# ---> Python
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+

.later.yml

@@ -0,0 +1,15 @@
+---
+ansible:
+  custom_modules:
+    - iptables_raw
+    - openssl_pkcs12
+    - proxmox_kvm
+    - ucr
+    - corenetworks_dns
+    - corenetworks_token
+
+rules:
+  exclude_files:
+    - "LICENSE*"
+    - "**/*.md"
+    - "**/*.ini"

.markdownlint.yml

@@ -0,0 +1,7 @@
+---
+default: True
+MD013: False
+MD041: False
+MD024: False
+MD004:
+  style: dash

.prettierignore

@@ -0,0 +1 @@
+LICENSE

.woodpecker/docs.yaml

@@ -0,0 +1,47 @@
+---
+when:
+  - event: [pull_request]
+  - event: [push, manual]
+    branch:
+      - ${CI_REPO_DEFAULT_BRANCH}
+
+steps:
+  - name: generate
+    image: quay.io/thegeeklab/ansible-doctor
+    environment:
+      ANSIBLE_DOCTOR_EXCLUDE_FILES: molecule/
+      ANSIBLE_DOCTOR_FORCE_OVERWRITE: "true"
+      ANSIBLE_DOCTOR_LOG_LEVEL: INFO
+      ANSIBLE_DOCTOR_ROLE_NAME: ${CI_REPO_NAME}
+      ANSIBLE_DOCTOR_TEMPLATE: readme
+
+  - name: format
+    image: quay.io/thegeeklab/alpine-tools
+    commands:
+      - prettier -w README.md
+
+  - name: diff
+    image: quay.io/thegeeklab/alpine-tools
+    commands:
+      - git diff --color=always README.md
+
+  - name: publish
+    image: quay.io/thegeeklab/wp-git-action
+    settings:
+      action:
+        - commit
+        - push
+      author_email: ci-bot@rknet.org
+      author_name: ci-bot
+      branch: main
+      message: "[skip ci] automated docs update"
+      netrc_machine: gitea.rknet.org
+      netrc_password:
+        from_secret: gitea_token
+    when:
+      - event: [push, manual]
+        branch:
+          - ${CI_REPO_DEFAULT_BRANCH}
+
+depends_on:
+  - test

.woodpecker/lint.yaml

@@ -0,0 +1,30 @@
+---
+when:
+  - event: [pull_request, tag]
+  - event: [push, manual]
+    branch:
+      - ${CI_REPO_DEFAULT_BRANCH}
+
+steps:
+  - name: ansible-later
+    image: quay.io/thegeeklab/ansible-later:4
+    commands:
+      - ansible-later
+    environment:
+      FORCE_COLOR: "1"
+
+  - name: python-format
+    image: docker.io/python:3.12
+    commands:
+      - pip install -qq ruff
+      - ruff format --check --diff .
+    environment:
+      PY_COLORS: "1"
+
+  - name: python-lint
+    image: docker.io/python:3.12
+    commands:
+      - pip install -qq ruff
+      - ruff .
+    environment:
+      PY_COLORS: "1"

.woodpecker/notify.yml

@@ -0,0 +1,26 @@
+---
+when:
+  - event: [tag]
+  - event: [push, manual]
+    branch:
+      - ${CI_REPO_DEFAULT_BRANCH}
+
+runs_on: [success, failure]
+
+steps:
+  - name: matrix
+    image: quay.io/thegeeklab/wp-matrix
+    settings:
+      homeserver:
+        from_secret: matrix_homeserver
+      password:
+        from_secret: matrix_password
+      roomid:
+        from_secret: matrix_roomid
+      username:
+        from_secret: matrix_username
+    when:
+      - status: [success, failure]
+
+depends_on:
+  - docs

.woodpecker/test.yaml

@@ -0,0 +1,25 @@
+---
+when:
+  - event: [pull_request, tag]
+  - event: [push, manual]
+    branch:
+      - ${CI_REPO_DEFAULT_BRANCH}
+
+variables:
+  - &molecule_base
+    image: quay.io/thegeeklab/molecule:6
+    group: molecule
+    secrets:
+      - source: molecule_hcloud_token
+        target: HCLOUD_TOKEN
+    environment:
+      PY_COLORS: "1"
+
+steps:
+  - name: molecule-default
+    <<: *molecule_base
+    commands:
+      - molecule test -s default
+
+depends_on:
+  - lint

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Robert Kaussow <mail@thegeeklab.de>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next
+paragraph) shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
+OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,78 @@
+# xoxys.smb
+
+[![Build Status](https://ci.rknet.org/api/badges/ansible/xoxys.smb/status.svg)](https://ci.rknet.org/repos/ansible/xoxys.smb)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?label=license)](https://gitea.rknet.org/ansible/xoxys.smb/src/branch/main/LICENSE)
+
+Mount a list of Samba shares.
+
+## Table of content
+
+- [Requirements](#requirements)
+- [Default Variables](#default-variables)
+  - [smb_packages](#smb_packages)
+  - [smb_shares](#smb_shares)
+- [Dependencies](#dependencies)
+- [License](#license)
+- [Author](#author)
+
+---
+
+## Requirements
+
+- Minimum Ansible version: `2.10`
+
+## Default Variables
+
+### smb_packages
+
+#### Default value
+
+```YAML
+smb_packages:
+  - cifs-utils
+```
+
+### smb_shares
+
+Mount defined samba shares. You can specify samba credentials with the
+`username` and `password` parameter. Given credentials will be used in a secrets file
+and saved to `/root/.smbcredentials/<name>` instead of the direct use in `/etc/fstab`.
+If secrets are defined for a list item, the secrest file will also be passed automatically
+to `mountopts`.
+
+The `state` parameter is related to the possible state values of Ansibles
+[mount](https://docs.ansible.com/ansible/latest/collections/ansible/posix/mount_module.html) module.
+
+#### Default value
+
+```YAML
+smb_shares: []
+```
+
+#### Example usage
+
+```YAML
+smb_shares:
+  - name: multimedia
+    source: //share.example.com/media
+    username: myuser
+    password: secure
+    mountpoint: /media/data
+    mountopts:
+      - acl
+      - uid=1000
+      - gid=1000
+    state: mounted
+```
+
+## Dependencies
+
+None.
+
+## License
+
+MIT
+
+## Author
+
+[Robert Kaussow](https://gitea.rknet.org/xoxys)

defaults/main.yml

@@ -0,0 +1,29 @@
+---
+smb_packages:
+  - cifs-utils
+
+# @var smb_shares:description: >
+# Mount defined samba shares. You can specify samba credentials with the
+# `username` and `password` parameter. Given credentials will be used in a secrets file
+# and saved to `/root/.smbcredentials/<name>` instead of the direct use in `/etc/fstab`.
+# If secrets are defined for a list item, the secrest file will also be passed automatically
+# to `mountopts`.
+#
+# The `state` parameter is related to the possible state values of Ansibles
+# [mount](https://docs.ansible.com/ansible/latest/collections/ansible/posix/mount_module.html) module.
+# @end
+
+# @var smb_shares:example: >
+# smb_shares:
+#   - name: multimedia
+#     source: //share.example.com/media
+#     username: myuser
+#     password: secure
+#     mountpoint: /media/data
+#     mountopts:
+#       - acl
+#       - uid=1000
+#       - gid=1000
+#     state: mounted
+# @end
+smb_shares: []

meta/main.yml

@@ -0,0 +1,26 @@
+---
+galaxy_info:
+  # @meta author:value: [Robert Kaussow](https://gitea.rknet.org/xoxys)
+  author: Robert Kaussow <mail@thegeeklab.de>
+  namespace: xoxys
+  role_name: smb
+  # @meta description: >
+  # [![Build Status](https://ci.rknet.org/api/badges/ansible/xoxys.smb/status.svg)](https://ci.rknet.org/repos/ansible/xoxys.smb)
+  # [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?label=license)](https://gitea.rknet.org/ansible/xoxys.smb/src/branch/main/LICENSE)
+  #
+  # Mount a list of Samba shares.
+  # @end
+  description: Mount a list of Samba shares
+  license: MIT
+  min_ansible_version: "2.10"
+  platforms:
+    - name: EL
+      versions:
+        - "9"
+  galaxy_tags:
+    - storage
+    - smb
+    - samba
+dependencies: []
+collections:
+  - community.general

molecule/default/converge.yml

@@ -0,0 +1,15 @@
+---
+- name: Converge
+  hosts: all
+  vars:
+    smb_shares:
+      - name: multimedia
+        source: //share.example.com/media
+        username: myuser
+        password: secure
+        mountpoint: /media/data
+        mountopts:
+          - acl
+        state: present
+  roles:
+    - role: xoxys.smb

molecule/default/molecule.yml

@@ -0,0 +1,17 @@
+---
+driver:
+  name: molecule_hetznercloud
+dependency:
+  name: galaxy
+  options:
+    role-file: molecule/requirements.yml
+    requirements-file: molecule/requirements.yml
+platforms:
+  - name: "rocky9-smb"
+    server_type: "cx11"
+    image: "rocky-9"
+provisioner:
+  name: ansible
+  log: False
+verifier:
+  name: testinfra

molecule/default/prepare.yml

@@ -0,0 +1,11 @@
+---
+- name: Prepare
+  hosts: all
+  gather_facts: False
+  tasks:
+    - name: Bootstrap Python for Ansible
+      ansible.builtin.raw: |
+        command -v python3 python ||
+        ((test -e /usr/bin/apt && (apt -y update && apt install -y python-minimal)) ||
+        echo "Warning: Python not boostrapped due to unknown platform.")
+      changed_when: False

molecule/default/tests/test_default.py

@@ -0,0 +1,19 @@
+import os
+
+import testinfra.utils.ansible_runner
+
+testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
+    os.environ["MOLECULE_INVENTORY_FILE"]
+).get_hosts("all")
+
+
+def test_smb_in_fstab(host):
+    fstab = host.file("/etc/fstab")
+    assert fstab.contains("//share.example.com/media")
+
+
+def test_smb_credentials(host):
+    credentials = host.file("/root/.smbcredentials/multimedia")
+    assert credentials.exists
+    assert credentials.contains("username=myuser")
+    assert credentials.contains("password=secure")

molecule/requirements.yml

@@ -0,0 +1,4 @@
+---
+collections: []
+
+roles: []

pyproject.toml

@@ -0,0 +1,17 @@
+[tool.ruff]
+exclude = [".git", "__pycache__"]
+
+line-length = 99
+indent-width = 4
+
+[tool.ruff.lint]
+ignore = ["W191", "E111", "E114", "E117", "S101", "S105"]
+select = ["F", "E", "I", "W", "S"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "lf"
+
+[tool.pytest.ini_options]
+filterwarnings = ["ignore::FutureWarning", "ignore::DeprecationWarning"]

tasks/main.yml

@@ -0,0 +1,35 @@
+---
+- name: Install requirements
+  ansible.builtin.package:
+    name: "{{ item }}"
+    state: present
+  loop: "{{ smb_packages }}"
+
+- name: Ensure credentials folder exist
+  ansible.builtin.file:
+    path: /root/.smbcredentials
+    owner: root
+    group: root
+    mode: "0600"
+    state: directory
+
+- name: Create secrets file
+  ansible.builtin.template:
+    src: "smbcredentials.j2"
+    dest: "/root/.smbcredentials/{{ item.name }}"
+    mode: "0600"
+  loop: "{{ smb_shares }}"
+  loop_control:
+    label: "/root/.smbcredentials/{{ item.name }}"
+  when: item.password is defined and item.password
+
+- name: Mount volume
+  ansible.posix.mount:
+    path: "{{ item.mountpoint }}"
+    src: "{{ item.source }}"
+    fstype: "cifs"
+    opts: "{{ ((item.mountopts | default([])) if not (item.password is defined and item.password) else ((item.mountopts | default([])) + ['credentials=/root/.smbcredentials/' + item.name])) | join(',') }}"
+    state: "{{ item.state | default('mounted') }}"
+  loop: "{{ smb_shares }}"
+  loop_control:
+    label: "mount: {{ item.source }} {{ item.mountpoint }} cifs {% if item.mountopts is defined %}{{ item.mountopts | join(',') }}{% endif %}"

templates/smbcredentials.j2

@@ -0,0 +1,2 @@
+username={{ item.username }}
+password={{ item.password }}