Merge branch 'main' into vagrant_validate

Author: ssbarnea

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+# We are limited to 4 usernames, if we ever exceed this limit we will rethink it
+github: [ssbarnea, konstruktoid]

.github/workflows/tox.yml

@@ -25,6 +25,11 @@ jobs:
           - macos-10.15
         unit: ["true"]
         include:
+          - tox_env: lint
+            os: ubuntu-20.04
+            python-version: "3.10"
+            unit: false
+            skip_vagrant: true
           - tox_env: packaging
             os: ubuntu-20.04
             python-version: 3.8
@@ -82,16 +87,14 @@ jobs:
       - name: "tox -e ${{ matrix.tox_env }}"
         run: python3 -m tox
 
-      - name: Combine coverage data
-        if: ${{ matrix.unit }}
-        # produce a single .coverage file at repo root
-        run: coverage combine .tox/.coverage.*
-
       - name: Upload coverage data
-        if: ${{ matrix.unit }}
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v2
         with:
+          directory: .tox
+          files: "coverage-*.xml"
           name: ${{ matrix.tox_env }}
+          verbose: true # optional (default = false)
+        if: ${{ startsWith(matrix.tox_env, 'py') }}
 
       - name: Archive logs
         uses: actions/upload-artifact@v2

.gitignore

@@ -16,3 +16,4 @@ Vagrantfile
 /dist/
 /python_vagrant.egg-info/
 *.egg-info/
+*.box

README.md

@@ -35,11 +35,10 @@ backwards-compatible features or bug fixes are added.
 
 ## Requirements
 
-- Vagrant 1.4 or greater (currently tested with 1.7.2). Using the latest
-  version of Vagrant is strongly recommended.
+- Vagrant 2.2 or greater. Using the latest version of Vagrant is strongly
+  recommended.
 - Vagrant requires VirtualBox, VMWare, or another supported provider.
-- Python 2.7 (the only version this package has been tested with.) or Python
-  3.3 or higher.
+- Python 3.8 or newer.
 - The Sahara gem for Vagrant is optional. It will allow you to use
   `SandboxVagrant`.
 
@@ -56,7 +55,7 @@ Download and install python-vagrant:
 Clone and install python-vagrant
 
     cd ~
-    git clone git@github.com:todddeluca/python-vagrant.git
+    git clone git@github.com:pycontribs/python-vagrant.git
     cd python-vagrant
     python setup.py install
 

codecov.yml

@@ -0,0 +1,10 @@
+---
+codecov:
+  require_ci_to_pass: true
+comment: false
+coverage:
+  status:
+    patch: false
+    project:
+      default:
+        threshold: 0.5%

pytest.ini

@@ -0,0 +1,9 @@
+[pytest]
+# do not add options here as this will likely break either console runs or IDE
+# integration like vscode or pycharm
+addopts =
+    # https://code.visualstudio.com/docs/python/testing
+    # coverage is re-enabled in `tox.ini`. That approach is safer than
+    # `--no-cov` which prevents activation from tox.ini and which also fails
+    # when plugin is effectively missing.
+    -p no:pytest_cov

setup.cfg

@@ -39,6 +39,8 @@ python_requires = >=3.8
 
 [options.extras_require]
 test =
+    coverage>=6.3
+    pytest-cov>=3.0.0
     pytest>=7.0.0
 
 [options.package_data]

tests/test_vagrant.py

@@ -51,6 +51,9 @@
 TEST_BOX_URL = "generic/alpine315"
 TEST_BOX_NAME = TEST_BOX_URL
 TEST_PROVIDER = "virtualbox"
+TEST_DUMMY_BOX_URL = os.path.join(
+    os.path.dirname(os.path.abspath(__file__)), "tools", f"dummy-{TEST_PROVIDER}.box"
+)
 # temp dir for testing.
 
 
@@ -77,7 +80,11 @@ def fixture_test_dir() -> Generator[str, None, None]:
     # Removes the directory created initially, runs once after the last test
     sys.stderr.write("module teardown()\n")
     if my_dir is not None:
-        subprocess.check_call("vagrant destroy -f", cwd=my_dir, shell=True)
+        try:
+            subprocess.check_call("vagrant destroy -f", cwd=my_dir, shell=True)
+        except subprocess.CalledProcessError:
+            pass
+
         shutil.rmtree(my_dir)
 
 
@@ -459,7 +466,7 @@ def test_boxesvm(test_dir):
         b.name for b in v.box_list()
     ], "There should be no dummy box before it's added."
     # Add a box
-    v.box_add(box_name, TEST_BOX_URL)
+    v.box_add(box_name, TEST_DUMMY_BOX_URL)
 
     # Test that there is a dummy box listed
     box_listing = v.box_list()
@@ -600,7 +607,7 @@ def test_streaming_output(vm_dir):
     """
     Test streaming output of up or reload.
     """
-    test_string = "Waiting for machine to boot."
+    test_string = "Machine already provisioned"
     v = vagrant.Vagrant(vm_dir)
 
     with pytest.raises(subprocess.CalledProcessError):

tests/tools/create_dummy_box.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+set -euxo pipefail
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+if [ $# -ne 1 ]; then
+	echo "Missing provider" >&2
+	exit 1
+fi
+
+if [ -f "$DIR/dummy.box" ]; then
+	echo "Box already created"
+	exit 0
+fi
+
+PROVIDER="$1"
+TMPDIR=`mktemp -d`
+cd "$TMPDIR"
+echo "{ \"provider\": \"$PROVIDER\"}" > metadata.json
+tar czf "$DIR/dummy-$PROVIDER.box" .
+cd "$DIR"
+rm -rf "$TMPDIR"

tox.ini

@@ -1,26 +1,50 @@
 [tox]
 envlist =
+    lint
     packaging
     py
 # needed by PEP-517 projects:
 isolated_build = True
 minversion = 3.24.5
+requires =
+  # fail build if git reports dirty after test run
+  tox-extra
 
 [testenv]
 deps =
-  .[test]
+  --editable .[test]
+commands_pre =
+  {toxinidir}/tests/tools/create_dummy_box.sh virtualbox
+  {toxinidir}/tests/tools/create_dummy_box.sh libvirt
 commands =
-  pytest {posargs}
+  pytest {posargs:\
+    -p pytest_cov \
+    --cov vagrant \
+    --cov "{envsitepackagesdir}/vagrant" \
+    --cov-report term-missing:skip-covered \
+    --cov-report=xml:{toxworkdir}/coverage-{envname}.xml \
+    --no-cov-on-fail \
+  }
 passenv =
     # Pass HOME to the test environment as it is required by
     # vagrant. Otherwise error happens due to missing HOME env variable.
     HOME
+setenv =
+    COVERAGE_FILE = {env:COVERAGE_FILE:{toxworkdir}/.coverage.{envname}}
 allowlist_externals =
     sh
 
 [testenv:dev]
 commands = {posargs}
 
+[testenv:lint]
+description = Run all linters
+deps =
+  pre-commit>=2.6.0
+skip_install = true
+commands =
+  {envpython} -m pre_commit run --all-files --show-diff-on-failure {posargs:}
+
 [testenv:packaging]
 description =
   Build package, verify metadata, install package and assert behavior when ansible is missing.