Adopt molecule-vagrant module (#67)

Author: ssbarnea

.ansible-lint

@@ -10,3 +10,6 @@ skip_list:
   - fqcn-builtins
   - yaml[line-length]
   - var-spacing
+
+mock_modules:
+  - vagrant # only until we publish community.vagrant collection

.github/workflows/tox.yml

@@ -34,7 +34,7 @@ jobs:
     runs-on: ubuntu-22.04
     needs: pre
     env:
-      PYTEST_REQPASS: 5
+      PYTEST_REQPASS: 6
     strategy:
       fail-fast: false
       matrix: ${{ fromJson(needs.pre.outputs.matrix) }}

bindep.txt

@@ -0,0 +1,36 @@
+# This is a cross-platform list tracking distribution packages needed by tests;
+# see https://docs.openstack.org/infra/bindep/ for additional information.
+
+build-essential [platform:dpkg]
+dnsmasq-base [platform:dpkg]
+ebtables [platform:dpkg]
+gcc [test platform:rpm]
+gcc-c++ [test platform:rpm]
+libselinux-python [platform:centos-7]
+libvirt [platform:rpm]
+libvirt-clients [platform:dpkg]
+libvirt-daemon [platform:dpkg]
+libvirt-daemon-kvm [platform:rpm]
+libvirt-daemon-system [platform:dpkg]
+libvirt-dev [platform:dpkg]
+libvirt-devel [platform:rpm]
+libguestfs-tools [platform:dpkg platform:rpm]
+libxml2-dev [platform:dpkg]
+libxslt-dev [platform:dpkg]
+make [platform:centos-7 platform:centos-8]
+pkg-config [platform:dpkg]
+python3 [test platform:dpkg platform:rpm !platform:centos-7]
+python3-devel [test platform:rpm !platform:centos-7]
+python3-dev [test platform:dpkg]
+python3-libselinux [test platform:rpm !platform:centos-7]
+python3-libvirt [test platform:rpm !platform:centos-7 platform:dpkg]
+python3-netifaces [test !platform:centos-7 platform:rpm]
+python36 [test !platform:dpkg !platform:centos-7 !platform:fedora-28]
+qemu-system [platform:dpkg]
+qemu-utils [platform:dpkg]
+qemu-kvm [platform:rpm]
+ruby-dev [platform:dpkg]
+ruby-devel [!platform:centos-7 !platform:centos-8 platform:rpm]
+ruby-libvirt [platform:dpkg]
+vagrant [platform:dpkg]
+zlib1g-dev [platform:dpkg]

doc/vagrant/README.rst

@@ -0,0 +1,180 @@
+***********************
+Molecule Vagrant Plugin
+***********************
+
+.. image:: https://badge.fury.io/py/molecule-vagrant.svg
+   :target: https://badge.fury.io/py/molecule-vagrant
+   :alt: PyPI Package
+
+.. image:: https://zuul-ci.org/gated.svg
+   :target: https://dashboard.zuul.ansible.com/t/ansible/builds?project=ansible-community/molecule-vagrant
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/python/black
+   :alt: Python Black Code Style
+
+.. image:: https://img.shields.io/badge/Code%20of%20Conduct-silver.svg
+   :target: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
+   :alt: Ansible Code of Conduct
+
+.. image:: https://img.shields.io/badge/Mailing%20lists-silver.svg
+   :target: https://docs.ansible.com/ansible/latest/community/communication.html#mailing-list-information
+   :alt: Ansible mailing lists
+
+.. image:: https://img.shields.io/badge/license-MIT-brightgreen.svg
+   :target: LICENSE
+   :alt: Repository License
+
+Molecule Vagrant is designed to allow use of Vagrant for provisioning of test
+resources.
+
+Supported Platforms
+===================
+
+This driver relies on vagrant command line which is known to be problematic
+to install on several platforms. We do our best to perform CI/CD testing on
+multiple platforms but some are disabled due to known bugs.
+
+* ✅ MacOS with VirtualBox - GitHub Actions
+* ✅ Fedora 32 with libvirt - Zuul
+* ✅ Ubuntu Bionic (18.04) with libvirt - Zuul
+* ❌ CentOS 8 with libvirt - Zuul DISABLED due to 1127_ and 11020_
+
+Please **do not file bugs for unsupported platforms**. You are welcomed to
+create PRs that fix untested platform, as long they do not break existing ones.
+
+.. _`1127`: https://github.com/vagrant-libvirt/vagrant-libvirt/issues/1127
+.. _`11020`: https://github.com/hashicorp/vagrant/issues/11020
+
+
+Documentation
+=============
+
+To use this plugin, you'll need to set the ``driver`` and ``platform``
+variables in your ``molecule.yml``. Here's a simple example using the
+`fedora/32-cloud-base`_ box:
+
+.. code-block:: yaml
+
+   driver:
+     name: vagrant
+
+   platforms:
+     - name: instance
+       box: fedora/32-cloud-base
+       memory: 512
+       cpus: 1
+
+Here's a full example with the libvirt provider:
+
+.. code-block:: yaml
+
+   driver:
+     name: vagrant
+     provider:
+       # Can be any supported provider (virtualbox, parallels, libvirt, etc)
+       # Defaults to virtualbox
+       name: libvirt
+     # Run vagrant up with --provision.
+     # Defaults to --no-provision)
+     provision: no
+     # vagrant-cachier configuration
+     # Defaults to 'machine'
+     # Any value different from 'machine' or 'box' will disable it
+     cachier: machine
+     # If set to false, set VAGRANT_NO_PARALLEL to '1'
+     # Defaults to true
+     parallel: true
+     # vagrant box to use by default
+     # Defaults to 'generic/alpine316'
+     default_box: 'generic/alpine316'
+
+   platforms:
+     - name: instance
+       # If specified, set host name to hostname, unless it's set to False and
+       # the host name won't be set. In all other cases (including default) use
+       # 'name' as host name.
+       hostname: foo.bar.com
+       # List of dictionaries mapped to `config.vm.network`
+       interfaces:
+         # `network_name` is the required identifier, all other keys map to
+         # arguments.
+         - auto_config: true
+           network_name: private_network
+           type: dhcp
+         - network_name: private_network
+           ip: 192.168.123.3
+         - network_name: forwarded_port
+           guest: 80
+           host: 8080
+       # List of raw Vagrant `config` options
+       instance_raw_config_args:
+         # use single quotes to avoid YAML parsing as dict due to ':'
+         - 'vm.synced_folder ".", "/vagrant", type: "rsync"'
+         # Run 'uname' a provisionning step **needs 'provision: true' to work**
+         - 'vm.provision :shell, inline: "uname"'
+       # Dictionary of `config` options. Note that string values need to be
+       # explicitly enclosed in quotes.
+       config_options:
+         ssh.keep_alive: yes
+         ssh.remote_user: 'vagrant'
+         synced_folder: true
+       box: fedora/32-cloud-base
+       box_version: 32.20200422.0
+       box_url:
+       memory: 512
+       cpus: 1
+       # Dictionary of options passed to the provider
+       provider_options:
+         video_type: 'vga'
+       # List of raw provider options
+       provider_raw_config_args:
+         - cpuset = '1-4,^3,6'
+
+.. _`fedora/32-cloud-base`: https://app.vagrantup.com/fedora/boxes/32-cloud-base
+
+
+More examples may be found in the ``molecule`` `scenarios directory`_.
+They're the scenarios used by the CI.
+
+
+.. _get-involved:
+
+Get Involved
+============
+
+* Join us in the ``#ansible-devtools`` channel on `Libera`_.
+* Join the discussion in `molecule-users Forum`_.
+* Join the community working group by checking the `wiki`_.
+* Want to know about releases, subscribe to `ansible-announce list`_.
+* For the full list of Ansible email Lists, IRC channels see the
+  `communication page`_.
+
+.. _`Libera`: https://web.libera.chat/?channel=#ansible-devtools
+.. _`molecule-users Forum`: https://groups.google.com/forum/#!forum/molecule-users
+.. _`wiki`: https://github.com/ansible/community/wiki/Molecule
+.. _`ansible-announce list`: https://groups.google.com/group/ansible-announce
+.. _`communication page`: https://docs.ansible.com/ansible/latest/community/communication.html
+.. _`scenarios directory`: https://github.com/ansible-community/molecule-vagrant/tree/main/molecule_vagrant/test/scenarios/molecule
+.. _authors:
+
+Authors
+=======
+
+Molecule Vagrant Plugin was created by Sorin Sbarnea based on code from
+Molecule.
+
+.. _license:
+
+License
+=======
+
+The `MIT`_ License.
+
+.. _`MIT`: https://github.com/ansible-community/molecule-vagrant/blob/main/LICENSE
+
+The logo is licensed under the `Creative Commons NoDerivatives 4.0 License`_.
+
+If you have some other use in mind, contact us.
+
+.. _`Creative Commons NoDerivatives 4.0 License`: https://creativecommons.org/licenses/by-nd/4.0/

pyproject.toml

@@ -74,6 +74,7 @@ azure = "molecule_plugins.azure.driver:Azure"
 docker = "molecule_plugins.docker.driver:Docker"
 ec2 = "molecule_plugins.ec2.driver:EC2"
 gce = "molecule_plugins.gce.driver:GCE"
+vagrant = "molecule_plugins.vagrant.driver:Vagrant"
 
 [tool.setuptools_scm]
 local_scheme = "no-local-version"

src/molecule_plugins/vagrant/__init__.py

@@ -0,0 +1,3 @@
+"""Plugin exports."""
+
+__name__ = __name__.split("_")[-1]

src/molecule_plugins/vagrant/cookiecutter/cookiecutter.json

@@ -0,0 +1,5 @@
+{
+    "molecule_directory": "molecule",
+    "role_name": "OVERRIDDEN",
+    "scenario_name": "OVERRIDDEN"
+}

src/molecule_plugins/vagrant/cookiecutter/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/INSTALL.rst

@@ -0,0 +1,23 @@
+*********************************
+Vagrant driver installation guide
+*********************************
+
+Requirements
+============
+
+* Vagrant
+* Virtualbox, Parallels, VMware Fusion, VMware Workstation or VMware Desktop
+
+Install
+=======
+
+Please refer to the `Virtual environment`_ documentation for installation best
+practices. If not using a virtual environment, please consider passing the
+widely recommended `'--user' flag`_ when invoking ``pip``.
+
+.. _Virtual environment: https://virtualenv.pypa.io/en/latest/
+.. _'--user' flag: https://packaging.python.org/tutorials/installing-packages/#installing-to-the-user-site
+
+.. code-block:: bash
+
+    $ pip install 'molecule-plugins[vagrant]'

src/molecule_plugins/vagrant/cookiecutter/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/converge.yml

@@ -0,0 +1,7 @@
+---
+- name: Converge
+  hosts: all
+  tasks:
+    - name: "Include {{ cookiecutter.role_name }}"
+      ansible.builtin.include_role:
+        name: "{{ cookiecutter.role_name }}"