Proxmox role testing with molecule

Get Help
,
1

Hello,

I wrote a small role for installing a guest on proxmox and would like to test it with molecule. I would like to test it in an existing proxmox cluster.
I’m wondering how to do it? It seems molecule expects some kind of container as test environment, where proxmox is installed inside?
Would be interrested in a good tutorial or at least in an example how to handle this test scenario.
Thanks a lot!
Thomas

2

Hi there!

You don’t have to run proxmox inside the container (I don’t think it will work as well as it does). You have multiple options going forward:

  • Provide a PVE node externally for the role to use/abuse in order to test. Be sure to add logic to molecule to clean up after itself/before it starts the test to ensure the PVE node is sane.
  • Use a different method of creating the test node. You’re not limited to using podman/docker containers. As long as you’re able to script it with Ansible, you can have molecule run a playbook in order to create your testenvironment on a different PVE node, use terraform etc.
    See the docs here for more information: Playbook Testing - Ansible Molecule. In this example they still use podman, but if you change the commands they used to deploy, for example a KVM with a PVE image on it, that’s possible as well!

Good luck!

1 Like
3

Seems I missed a lot of documentation :innocent:
Thanks a lot! I found some ideas how to solve it.

4

Now, I created a configuration for testing with molecule with two scenarios (The same role “pve_guest” with two different variable sets):

pve_guest/
├── README.md
├── defaults
│   └── main.yml
├── meta
│   └── main.yml
├── molecule
│   ├── default
│   │   ├── cleanup.yml
│   │   ├── create.yml
│   │   ├── destroy.yml
│   │   ├── molecule.yml
│   │   └── verify.yml
│   ├── inventory
│   │   └── inventory.yml
│   ├── requirements.yml
│   └── sc01
│       ├── cleanup.yml -> ../default/cleanup.yml
│       ├── converge.yml
│       ├── converge_01.yml
│       ├── molecule.yml
│       ├── verify.yml
│       └── verify_01.yml
├── tasks
│   ├── cleanup_guests.yml
│   ├── create_lxc.yml
│   ├── create_qemu.yml
│   └── main.yml
└── vars
    └── main.yml

I can run the test:

[root@ansible-dev-container pve_guest]# molecule --version
molecule 25.9.0 using python 3.13 
    ansible:2.19.2
    default:25.9.0 from molecule

[root@ansible-dev-container pve_guest]# molecule test --report --command-borders
INFO     default ➜ discovery: scenario test matrix: dependency, cleanup, create, cleanup, destroy
INFO     default ➜ create: Executing
  ┌──────────────────────────────────────────────────────────────────────────────────
  │ ansible-playbook --inventory /root/.ansible/tmp/molecule.IqEM.default/inventory
  │   --skip-tags molecule-notest,notest
  │   --inventory=../inventory/ /workspaces/ansible/roles/pve_guest/molecule/default/create.yml
  │ 
  │ 
  │ PLAY [Create (default)] ********************************************************
  │ 
  │ TASK [Debug] *******************************************************************
  │ ok: [test-pve-guest] => {
  │     "msg": "test-pve-guest"
  │ }
  │ 
  │ PLAY RECAP *********************************************************************
  │ test-pve-guest             : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
  │ 
  └─ Return code: 0 ─────────────────────────────────────────────────────────────────
INFO     default ➜ create: Executed: Successful
INFO     default ➜ prerun: Performing prerun with role_name_check=0...
INFO     default ➜ dependency: Executing
  ┌──────────────────────────────────────────────────────────────────────────────────
  │ ansible-galaxy install
  │   --role-file molecule/requirements.yml
  │ 
  │ Starting galaxy collection install process
  │ Nothing to do. All requested collections are already installed. If you want to reinstall them, consider using `--force`.
  └─ Return code: 0 ─────────────────────────────────────────────────────────────────
INFO     default ➜ dependency: Dependency completed successfully.
  ┌──────────────────────────────────────────────────────────────────────────────────
  │ ansible-galaxy collection
  │   install
  │   --requirements-file molecule/requirements.yml
  │ 
  │ Starting galaxy collection install process
  │ Nothing to do. All requested collections are already installed. If you want to reinstall them, consider using `--force`.
  └─ Return code: 0 ─────────────────────────────────────────────────────────────────
INFO     default ➜ dependency: Dependency completed successfully.
INFO     default ➜ dependency: Executed: Successful
INFO     default ➜ cleanup: Executing
  ┌──────────────────────────────────────────────────────────────────────────────────
  │ ansible-playbook --inventory /root/.ansible/tmp/molecule.IqEM.default/inventory
  │   --skip-tags molecule-notest,notest
  │   --inventory=../inventory/ /workspaces/ansible/roles/pve_guest/molecule/default/cleanup.yml
  │ 
  │ 
  │ PLAY [Cleanup (default)] *******************************************************
  │ 
  │ TASK [Debug] *******************************************************************
  │ ok: [test-pve-guest] => {
  │     "msg": "test-pve-guest"
  │ }
  │ 
  │ PLAY RECAP *********************************************************************
  │ test-pve-guest             : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
  │ 
  └─ Return code: 0 ─────────────────────────────────────────────────────────────────
INFO     default ➜ cleanup: Executed: Successful
INFO     default ➜ cleanup: Executing
  ┌──────────────────────────────────────────────────────────────────────────────────
  │ ansible-playbook --inventory /root/.ansible/tmp/molecule.IqEM.default/inventory
  │   --skip-tags molecule-notest,notest
  │   --inventory=../inventory/ /workspaces/ansible/roles/pve_guest/molecule/default/cleanup.yml
  │ 
  │ 
  │ PLAY [Cleanup (default)] *******************************************************
  │ 
  │ TASK [Debug] *******************************************************************
  │ ok: [test-pve-guest] => {
  │     "msg": "test-pve-guest"
  │ }
  │ 
  │ PLAY RECAP *********************************************************************
  │ test-pve-guest             : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
  │ 
  └─ Return code: 0 ─────────────────────────────────────────────────────────────────
INFO     default ➜ cleanup: Executed: Successful
INFO     default ➜ destroy: Executing
  ┌──────────────────────────────────────────────────────────────────────────────────
  │ ansible-playbook --inventory /root/.ansible/tmp/molecule.IqEM.default/inventory
  │   --skip-tags molecule-notest,notest
  │   --inventory=../inventory/ /workspaces/ansible/roles/pve_guest/molecule/default/destroy.yml
  │ 
  │ 
  │ PLAY [Destroy (default)] *******************************************************
  │ 
  │ TASK [Debug] *******************************************************************
  │ ok: [test-pve-guest] => {
  │     "msg": "test-pve-guest"
  │ }
  │ 
  │ PLAY RECAP *********************************************************************
  │ test-pve-guest             : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
  │ 
  └─ Return code: 0 ─────────────────────────────────────────────────────────────────
INFO     default ➜ destroy: Executed: Successful
INFO     Molecule executed 3 scenarios (3 successful)

DETAILS                                                                        
default ➜ create: Executed: Successful

default ➜ dependency: Executed: Successful
default ➜ cleanup: Executed: Successful
default ➜ cleanup: Executed: Successful

default ➜ destroy: Executed: Successful

SCENARIO RECAP                                                                 
default                   : actions=1  successful=1  disabled=0  skipped=0  missing=0  failed=0
default                   : actions=3  successful=2  disabled=0  skipped=0  missing=0  failed=0
default                   : actions=1  successful=1  disabled=0  skipped=0  missing=0  failed=0

[root@ansible-dev-container pve_guest]#

If I run the “sc01” scenario with

molecule test -s sc01 --report --command-borders

then only the “create” and “destroy” playbook are used from the default scenario; the configuration (molecule.yml) and all other plays are not available. Is this correct? Or is there a mistake in my configuration?

My configuration:

[root@ansible-dev-container pve_guest]# cat molecule/default/molecule.yml 
# code: language=ansible

---
# Dependency management (download roles/collections)
dependency:
  name: galaxy
  options:
    ignore-certs: false
    ignore-errors: false
    role-file: molecule/requirements.yml
    requirements-file: molecule/requirements.yml

ansible:
  cfg:
    defaults:
      host_key_checking: false
      inventory: ../inventory/
  env:
    ANSIBLE_DEPRECATION_WARNINGS: "0"  # mute the DEFAULT_MANAGED_STR warning (See changelog ansible 2.19)
  executor:
    backend: ansible-playbook
    args:
      ansible_playbook:
        - --inventory=../inventory/

scenario:
  test_sequence:
    - dependency
    - cleanup
    - create
    - cleanup
    - destroy

shared_state: true


[root@ansible-dev-container pve_guest]# cat molecule/sc01/molecule.yml 
# code: language=ansible

---
# Dependency management (download roles/collections)
dependency:
  name: galaxy
  options:
    ignore-certs: false
    ignore-errors: false
    role-file: molecule/requirements.yml
    requirements-file: molecule/requirements.yml

ansible:
  cfg:
    defaults:
      host_key_checking: false
      inventory: ../inventory/
  env:
    ANSIBLE_DEPRECATION_WARNINGS: "0"  # mute the DEFAULT_MANAGED_STR warning (See changelog ansible 2.19)
  executor:
    backend: ansible-playbook
    args:
      ansible_playbook:
        - --inventory=../inventory/

scenario:  test_sequence:
    - create
    - dependency
    - syntax
    - cleanup
    - converge
    - idempotence
    - verify
    - cleanup
    - converge converge_01.yml
    - idempotence converge_01.yml
    - verify verify_01.yml
    - cleanup
    - destroy

shared_state: true
[root@ansible-dev-container pve_guest]#

Thanks a lot for your help!
Thomas

5

A few hours try & error later: The cleanup.yml from the default scenario can be used in this way:

# pve_guest/molecule/sc01/molecule.yml
---
ansible:
  playbooks:
    cleanup: ../default/cleanup.yml

scenario:
  test_sequence:
    - create
    - syntax
    - cleanup
    - converge
    - idempotence
    - verify
    - cleanup
    - destroy
6

And a central ansible configuration is possible as well, but a bit weired.
The config.yml must be placed in ~/.config/molecule.config.yml or in <git_root>/.config/molecule/config.yml.

But there is still a miracle.

Structure is now:

pve_guest/
├── .ansible
│   ├── collections
│   └── roles
├── .config
│   └── molecule
│       └── config.yml
├── .git
│   └── ...
├── README.md
├── defaults
│   └── main.yml
├── meta
│   └── main.yml
├── molecule
│   ├── default
│   │   ├── cleanup.yml
│   │   ├── create.yml
│   │   ├── destroy.yml
│   │   ├── molecule.yml
│   │   └── verify.yml
│   ├── inventory
│   │   └── inventory.yml
│   ├── requirements.yml
│   └── sc01
│       ├── converge.yml
│       ├── molecule.yml
│       └── verify.yml
├── tasks
│   ├── cleanup_guests.yml
│   ├── create_lxc.yml
│   ├── create_qemu.yml
│   └── main.yml
└── vars
    └── main.yml

The config.yml:

---
# Dependency management (download roles/collections)
dependency:
  name: galaxy
  options:
    ignore-certs: false
    ignore-errors: false
    role-file: molecule/requirements.yml
    requirements-file: molecule/requirements.yml

ansible:
  cfg:
    defaults:
      host_key_checking: false
      deprecation_warnings: false
      # inventory: "inventory/" ## <= funktioniert nicht, da BasisDir unklar

  # env:
    # ANSIBLE_DEPRECATION_WARNINGS: "0"  # mute the DEFAULT_MANAGED_STR warning (See changelog ansible 2.19)

  executor:
    backend: ansible-playbook
    args:
      ansible_playbook:
        - --inventory=../inventory/

The ansible => cfg => defaults => inventory setting did not work, but the playbook arg --inventory is working.
Which path should I use here to get the first setting working?

Thanks a lot,
Thomas

7

CC @DevTools molecule ansible-molecule

Some feedback on latest Molecule. Looks like the new version of Molecule being used here :slightly_smiling_face: