molecule-testing

name	molecule-testing
description	Run and validate Ansible tests. Molecule commands, TDD workflow, layered scenarios, performance optimization.

Molecule Testing

Rules

1. Use molecule converge && molecule verify for day-to-day iteration. Full molecule test is for clean-state proof ONLY.
2. Keep baseline running between tests. 4-minute baseline costs on every run.
3. Molecule platform config MUST include all flavor groups from inventory/hosts.yml.
4. NEVER delete templates in cleanup. Template deletion forces ~820MB re-upload.
5. NEVER use graceful skips for required hardware (iGPU, IOMMU). Silent skips mask problems.
6. Fix broken images INDIVIDUALLY with per-feature scenarios before running full E2E. build-images.sh --only <target> (~2 min) + molecule test -s <type>-lxc (~5 min) is the fast loop.
7. Full E2E (molecule test) should be fast because images are already cached. If it takes 30+ minutes, the bake pipeline is broken (re-uploading or runtime-installing).
8. You have 6 Proxmox hosts — build images IN PARALLEL. Never serialize image builds across hosts.

Commands

source .venv/bin/activate
set -a; source test.env; set +a

molecule test          # full pipeline
molecule converge      # run playbook (preserves baseline)
molecule verify        # run assertions
molecule cleanup       # reset host

Environment Setup Patterns

38. CRITICAL: Always use set -a; source test.env; set +a before running molecule. This ensures all environment variables are exported and available to Ansible.

39. Variable export: The set -a flag automatically exports all variables from the sourced file, making them available to child processes.

40. Molecule env handling: Molecule provisioner uses ${VAR} syntax in molecule.yml. Environment variables must be properly exported for molecule to access them.

41. Previous bug: molecule test failed with "Could not resolve hostname none" because environment variables weren't exported. Solution: set -a && source test.env && set +a.

42. Test environment validation:

    # Verify environment is loaded
    echo "HOME_API_TOKEN: $HOME_API_TOKEN"
    echo "PRIMARY_HOST: $PRIMARY_HOST"
    
    # If base state established, use heartbeat system:
    curl -sf http://localhost:$WEBUI_PORT/api/fleet/health && echo "Fleet OK"
    
    # If pre-base-state (first run), verify Ansible access:
    ansible home -m ping
    

Baseline workflow

# FAST iteration (primary loop — use this 90% of the time)
molecule converge                  # build/update baseline
molecule verify                    # run assertions

# Per-image fix (when ONE image is broken)
./build-images.sh --host $PRIMARY_HOST --only pihole  # ~2-3 min
molecule test -s pihole-lxc        # per-feature only

# Layered scenario (after baseline exists)
molecule converge -s wireguard-lxc # run layered scenario
molecule verify -s wireguard-lxc

# Full E2E clean-state proof (LAST STEP — after all images pass)
molecule test

Pre-commit: molecule test

Fail-fast iteration rules

The 6 test hosts are a STRENGTH. Use them for parallel image builds. Never wait for a full E2E to discover a single-image bug.

1. Fix build-images.sh for the broken target
2. Rebuild that ONE image on 1 host (~2-3 min)
3. Run its per-feature molecule scenario (~5 min)
4. If it fails, go back to step 1. FAST loop.
5. Once all images pass individually, run full E2E once
6. If E2E passes, manual verification (Step 6 of work cycle)

Pipeline sequence

molecule test runs: dependency → cleanup → syntax → prepare → converge → verify

There is NO trailing cleanup or converge. The baseline is left running after verify. NEVER add cleanup or destroy to the end of the test_sequence — that tears down OpenWrt and makes mesh1 permanently unreachable.

The prepare phase starts the callhome API server and writes .state/callhome_url. The cleanup phase at the beginning resets the host from any previous run.

No lint phase — run ansible-lint && yamllint . separately.

Scenario types

Layered scenarios (e.g., openwrt-security):

• Assume baseline exists
• Converge only tagged plays
• Verify only feature assertions
• Cleanup only feature artifacts

Standalone scenarios (e.g., proxmox-igpu):

• Test single role
• No baseline dependency
• Cleanup restores host state

Pre-test checklist (MANDATORY BEFORE ANY MOLECULE COMMANDS)

set -a; source test.env; set +a
ssh root@$PRIMARY_HOST hostname
./build-images.sh

Early Validation Commands (RUN IMMEDIATELY)

Before any molecule work, ALWAYS verify environment:

# Verify environment variables are loaded
echo "HOME_API_TOKEN: $HOME_API_TOKEN"
echo "PRIMARY_HOST: $PRIMARY_HOST"

# If base state is already established, check the heartbeat system:
curl -sf http://localhost:$WEBUI_PORT/api/fleet/health && echo "Fleet OK"
curl -sf http://localhost:$WEBUI_PORT/api/nodes | python3 -m json.tool

# If pre-base-state (first run), verify Ansible management access:
ansible home -m ping

CRITICAL: If the SM API is not responding (and base state should be up), that means the heart stopped. Fix the SM. If any of these fail, DO NOT proceed with molecule commands.

When to Test (PROACTIVE TRIGGERS)

Test IMMEDIATELY when:

• Environment variables are changed or added
• New service role is created
• Container/VM provisioning code is modified
• Docker-in-LXC or container-specific patterns are used
• Any pct exec or container commands are added
• Variable scoping issues are suspected
• After ANY code changes that affect testing

Test IMMEDIATELY when you see:

• "Could not resolve hostname none" (environment not exported)
• "UNREACHABLE" during converge (SSH or host issues)
• Template deployment failures in containers
• Variable undefined errors (proxmox_vmid vs homeassistant_ct_id)
• Docker daemon access issues in containers

Platform groups

platforms:
  - name: home
    groups: [proxmox, router_nodes, vpn_nodes, wifi_nodes]
  - name: mesh1
    groups: [proxmox, lan_hosts, vpn_nodes, wifi_nodes]

All 4 hosts in default scenario. Without this, plays skip hosts.

Group reconstruction

Per-feature scenarios target dynamic groups. State does NOT persist across phases. MUST reconstruct at start of each phase:

- name: Reconstruct openwrt group
  hosts: router_nodes
  tasks:
    - include_tasks: ../../tasks/reconstruct_openwrt_group.yml

Task file detects OpenWrt LAN IP, auth method, builds SSH args, registers host.

Path resolution

Use role_path for project-relative paths:

src: "{{ role_path }}/../../images/{{ lxc_ct_template }}"

Proactive Skill Loading

When working on new service types, read relevant skills before writing code:

• LXC containers: lxc-container-patterns (provisioning, networking, Docker-in-LXC)
• Proxmox operations: proxmox-safety-rules, proxmox-system-safety
• Ansible development: ansible-conventions, ansible-shell-safety
• Service configuration: service-config-validation

Previous lesson: Docker-in-LXC configure play targeted the container dynamic group instead of the host group. The lxc-container-patterns skill now documents this pattern explicitly.

Performance optimization

• Set cache_valid_time: 86400 for apt tasks
• MINIMIZE pct_remote tasks. Each opens new SSH connection
• Consolidate pct config reads — one call per container

Hard-fail requirements

• iGPU: REQUIRED. Supports Intel (i915) and AMD (amdgpu)
• WiFi + IOMMU: REQUIRED for passthrough
• NIC count: OK to handle dynamically

Molecule env vars

Molecule provisioner.env uses ${VAR} syntax. NEVER use ${VAR:-default}.

Required: add to provisioner.env. Optional: do NOT add (role defaults use lookup('env', 'VAR')).

Raw heredoc pitfalls

ansible.builtin.raw: heredocs fail on Jinja2-like content:

• ${var:-default} — misinterpreted
• || true — can confuse parser
• [:space:] — colons conflict with YAML

Run ansible-playbook --syntax-check playbooks/site.yml after modifying raw:.

Diagnosing failures

1. Terminal: FAILED, fatal:, UNREACHABLE
2. Kernel: dmesg | grep -iE 'error|segfault|duplicate'
3. Interfaces: ip addr, ip route
4. Firewall: zone bindings, nftables
5. Protocol: test actual protocol (TCP/HTTP), not ICMP

Shell safety

ansible.builtin.shell:
  cmd: |
    set -o pipefail
    command1 | command2
  executable: /bin/bash

Exception: ansible.builtin.raw and BusyBox do NOT support pipefail.

Deprecated patterns

Use delegate_to: localhost instead of local_action. Use FQCNs: ansible.builtin.command.

Common failures

Symptom	Cause	Fix
UNREACHABLE during converge	SSH broken or host down	Check PRIMARY_HOST, verify SSH
community.proxmox not found	Collections missing	ansible-galaxy collection install -r requirements.yml
Bridge numbers keep incrementing	Cleanup didn't remove bridges	./cleanup.sh clean test.env
WiFi radios=0 after converge	PCI passthrough not cleaned up	Ensure cleanup unbinds vfio-pci, reloads modules, rescans PCI
Timeout waiting for SSH	Network restart dropped connection	Verify SSH args include ConnectTimeout=10, ServerAliveInterval=15
opkg update fails HTTPS	HTTPS not supported	Ensure sed -i 's|https://|http://|g' runs before opkg update
opkg update EPERM	Firewall zones stale after network restart	Restart firewall before outbound connections
MAC stored without colons in UCI	BusyBox tr -d '[:space:]' deletes :	Use tr -d ' \t\n\r'
GUI reachability fails on OpenWrt	BusyBox nc no -w flag	Use (echo QUIT | nc HOST PORT) </dev/null
VM reachable by IPv6 but not IPv4	Stale LAN-subnet IP on another bridge	Remove conflicting IPs from non-LAN bridges
ifreload -a no DHCP client	Separate inet dhcp file conflicts	Modify bridge stanza in-place
Route filter hides default route	ip route show default dev eth0 misses aliases	Use ip route show default without dev filter
igpu_available not defined in verify	Facts from converge not in verify

Permanent diagnostics rules

1. ALWAYS use changed_when: false and failed_when: false on diagnostic tasks
2. Register output and use debug: var: to display in logs
3. Include kernel-level checks (dmesg errors) at key milestones
4. Include actual protocol tests (TCP/HTTP), not just ICMP ping
5. Generalize ad-hoc debug tasks into permanent diagnostics before closing issues

Lint configuration

• ansible-lint: .ansible-lint — production profile, skips command-instead-of-module for Proxmox shell tasks
• yamllint: .yamllint.yml — 160-char lines, relaxed comment spacing
• Run manually: ansible-lint && yamllint .