Improve test box handling (#62)

* molecule_vagrant/test/: Allow to set vagrant box to use for tests

Currently, the vagrant boxes used can't be changed and are not all
the same, which means that during testing, different boxes are downloaded
and used.
As a solution, allow to set a box for every box, thanks to the new
TESTBOX environment variable. If not set, the current behaviour is not
changed.

Signed-off-by: Arnaud Patard <[email protected]>

* tools/test-setup.sh: Create a vagrant box from setup test image

The default image used by molecule-vagrant and the test-setup.sh
script are using the generic/alpine310 box. This box can be used
for testing molecule-vagrant too but using it will mean to download
python3 and rsync everytime a new test is started.
To avoid doing it, create a new vagrant box out of the freshly
started VM and using Vagrantfile provisionning to install python3
and rsync.
To avoid having to handle the vagrant insecure ssh key pubkey, set
config.ssh.insert_key to false.

Signed-off-by: Arnaud Patard <[email protected]>

* tox.ini: Use newly created test box

Use the vagrant box created with test-setup.sh to do the testing.
This should reduce testing time.

Since github actions are not using tools/test-setup.sh, configure
the tests to use generic/alpine310 in this case.

Signed-off-by: Arnaud Patard <[email protected]>

Author: apatard

.github/workflows/tox.yml

@@ -67,6 +67,8 @@ jobs:
         run: |
           echo "${{ matrix.PREFIX }} tox -e ${{ matrix.tox_env }}"
           ${{ matrix.PREFIX }} tox -e ${{ matrix.tox_env }}
+        env:
+          TESTBOX: "generic/alpine310"
 
   publish:
     name: Publish to PyPI registry

bindep.txt

@@ -14,6 +14,7 @@ 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]

molecule_vagrant/test/functional/test_func.py

@@ -54,13 +54,16 @@ def test_command_init_scenario(temp_dir):
         assert result.returncode == 0
 
         assert os.path.isdir(scenario_directory)
+        confpath = os.path.join(scenario_directory, "molecule.yml")
+        conf = util.safe_load_file(confpath)
+        env = os.environ
+        if "TESTBOX" in env:
+            conf["platforms"][0]["box"] = env["TESTBOX"]
         if not os.path.exists("/dev/kvm"):
-            confpath = os.path.join(scenario_directory, "molecule.yml")
-            conf = util.safe_load_file(confpath)
             conf["driver"]["provider"] = {"name": "libvirt"}
             for p in conf["platforms"]:
                 p["provider_options"] = {"driver": '"qemu"'}
-            util.write_file(confpath, util.safe_dump(conf))
+        util.write_file(confpath, util.safe_dump(conf))
 
         cmd = ["molecule", "--debug", "test", "-s", "test-scenario"]
         result = run_command(cmd)

molecule_vagrant/test/scenarios/molecule/config_options/molecule.yml

@@ -11,7 +11,7 @@ platforms:
       synced_folder: true
     provider_options:
       driver: "${VIRT_DRIVER:-'kvm'}"
-    box: centos/7
+    box: ${TESTBOX:-centos/7}
     instance_raw_config_args:
       - 'vm.synced_folder ".", "/vagrant", type: "rsync"'
 provisioner:

molecule_vagrant/test/scenarios/molecule/default/molecule.yml

@@ -7,7 +7,7 @@ driver:
     name: virtualbox
 platforms:
   - name: instance
-    box: generic/alpine310
+    box: ${TESTBOX:-generic/alpine310}
     provision: false
     options:
       linked_clone: false

molecule_vagrant/test/scenarios/molecule/multi-node/molecule.yml

@@ -7,7 +7,7 @@ driver:
     name: virtualbox
 platforms:
   - name: instance-1
-    box: debian/jessie64
+    box: ${TESTBOX:-debian/jessie64}
     interfaces:
       - auto_config: true
         network_name: private_network
@@ -25,7 +25,7 @@ platforms:
     instance_raw_config_args:
       - 'vm.synced_folder ".", "/vagrant", type: "rsync"'
   - name: instance-2
-    box: centos/7
+    box: ${TESTBOX:-centos/7}
     interfaces:
       - auto_config: true
         network_name: private_network

molecule_vagrant/test/scenarios/molecule/provider_config_options/molecule.yml

@@ -10,7 +10,7 @@ platforms:
     provider_options:
       nic_model_type: '"e1000"'
       driver: "${VIRT_DRIVER:-'kvm'}"
-    box: centos/7
+    box: ${TESTBOX:-centos/7}
 provisioner:
   name: ansible
 verifier:

molecule_vagrant/test/scenarios/molecule/vagrant_root/molecule.yml

@@ -7,7 +7,7 @@ driver:
     name: libvirt
 platforms:
   - name: instance
-    box: centos/7
+    box: ${TESTBOX:-centos/7}
     provider_options:
       driver: "${VIRT_DRIVER:-'kvm'}"
     provision: true

tools/Vagrantfile

@@ -7,4 +7,6 @@ Vagrant.configure("2") do |config|
     l.cpu_mode = 'custom'
     l.cpu_model = 'qemu64'
   end
+  config.vm.provision :shell, inline: "sudo apk add --no-progress --update python3 rsync"
+  config.ssh.insert_key = false
 end

tools/test-setup.sh

@@ -128,5 +128,8 @@ vagrant plugin list | tee >(grep -q "No plugins installed." && {
 cd $DIR
 
 # sudo su: dirty hack to make sure that usermod change has been taken into account
-sudo su -l "$(whoami)" -c "cd $(pwd) && timeout 300 vagrant up --no-tty --no-provision --debug"
+sudo su -l "$(whoami)" -c "cd $(pwd) && timeout 300 vagrant up --no-tty --debug"
+sudo su -l "$(whoami)" -c "cd $(pwd) && timeout 300 vagrant halt"
+sudo su -l "$(whoami)" -c "cd $(pwd) && timeout 300 vagrant package --output testbox.box"
+sudo su -l "$(whoami)" -c "cd $(pwd) && vagrant box add testbox.box --name testbox"
 sudo su -l "$(whoami)" -c "cd $(pwd) && vagrant destroy -f"

tox.ini

@@ -46,6 +46,7 @@ setenv =
     MOLECULE_NO_LOG=false
     _EXTRAS=-l --html={envlogdir}/reports.html --self-contained-html
     PYTEST_ADDOPTS={env:_EXTRAS} {env:PYTEST_ADDOPTS:}
+    TESTBOX={env:TESTBOX:testbox}
 passenv =
     CI
     CURL_CA_BUNDLE