+ F401,

+ F821,

+ F841,

+ S101,

+ S404,

+ S602,

+ S603,

+---

+version: 2

+updates:

+ - package-ecosystem: pip

+ directory: /

+ schedule:

+ interval: daily

+ labels:

+ - skip-changelog

+ versioning-strategy: lockfile-only

+ - package-ecosystem: "github-actions"

+ directory: "/"

+ schedule:

+ interval: daily

+ labels:

+ - "skip-changelog"

+ - name: Switch to using Python 3.9 by default

+ uses: actions/setup-python@v4

+ cache: "pip"

+ python-version: 3.9

+ uses: actions/checkout@v3

+ python-version: "3.9"

+ python-version: "3.10"

+ unit: false

+ skip_vagrant: true

+ - tox_env: packaging

+ os: ubuntu-22.04

+ python-version: "3.11"

+ python-version: "3.9"

+ - tox_env: py311

+ os: macos-10.15

+ python-version: "3.11"

+ PYTEST_REQPASS: 24

+ uses: actions/setup-python@v4

+ cache: "pip"

+ - name: Enable vagrant box caching

+ uses: actions/cache@v3

+ with:

+ path: |

+ ~/.vagrant.d/boxes

+ key: ${{ runner.os }}-${{ matrix.tox_env }}-vagrantbox-${{ hashFiles('tests/tools/create_dummy_box.sh', 'tests/test_vagrant*py', '**/Vagrantfile', 'tests/vagrantfiles/*Vagrantfile') }}

+

+ uses: actions/cache@v3

+ uses: codecov/codecov-action@v3

+ uses: actions/upload-artifact@v3

+ skip:

+ - pip-compile

+ rev: v3.0.0-alpha.4

+ rev: v4.4.0

+ rev: 22.10.0

+ rev: 6.0.0

+ rev: v0.991

+ rev: v2.15.8

+ - repo: https://github.com/jazzband/pip-tools

+ rev: 6.11.0

+ hooks:

+ - id: pip-compile

+ entry: pip-compile --resolver=backtracking -q --no-annotate --output-file=requirements.txt pyproject.toml --extra test --strip-extras

+ language: python

+ files: ^(requirements\.txt|pyproject\.toml)$

+ alias: deps

+ language_version: "3.9" # minimal we support officially

+ additional_dependencies:

+ - pip>=22.3.1

+ - id: pip-compile

+ entry: pip-compile --resolver=backtracking -q --no-annotate --output-file=requirements.txt pyproject.toml --extra test --strip-extras --upgrade

+ language: python

+ files: ^(requirements\.txt|pyproject\.toml)$

+ alias: up

+ stages: [manual]

+ language_version: "3.9" # minimal we support officially

+ additional_dependencies:

+ - pip>=22.3.1

+- Python 3.9 or newer.

+[GitHub](https://github.com/pycontribs/python-vagrant).

+Please see [CHANGELOG.md](CHANGELOG.md) and

+[Releases](https://github.com/pycontribs/python-vagrant/releases)

+for a detailed list of updates, contributions and authors.

+python-vagrant (1.1.0-1) unstable; urgency=medium

+

+ * New upstream version 1.1.0

+

+ -- Hans-Christoph Steiner <hans@eds.org> Mon, 06 Feb 2023 01:08:42 +0100

+

+python-vagrant (0.5.15-4) unstable; urgency=medium

+

+ [ Ondřej Nový ]

+ * Bump Standards-Version to 4.4.1.

+ * d/control: Update Maintainer field with new Debian Python Team

+ contact address.

+ * d/control: Update Vcs-* fields with new Debian Python Team Salsa

+ layout.

+

+ [ Debian Janitor ]

+ * Set upstream metadata fields: Bug-Database, Bug-Submit, Repository,

+ Repository-Browse.

+ * Bump debhelper from old 12 to 13.

+ * Update standards version to 4.5.1, no changes needed.

+

+ -- Sandro Tosi <morph@debian.org> Sat, 04 Jun 2022 16:02:05 -0400

+

+ "setuptools >= 61.0", # PEP-621

+ "setuptools_scm[toml] >= 7.0.0",

+[project]

+# https://peps.python.org/pep-0621/#readme

+requires-python = ">=3.9"

+dynamic = ["version"]

+name = "python-vagrant"

+description = "Python bindings for interacting with Vagrant virtual machines."

+readme = "README.md"

+authors = [{ "name" = "Todd Francis DeLuca", "email" = "todddeluca@yahoo.com" }]

+maintainers = [

+ { "name" = "Sorin Sbarnea", "email" = "sorin.sbarnea@gmail.com" }

+]

+license = { text = "MIT" }

+classifiers = [

+ "Development Status :: 4 - Beta",

+ "License :: OSI Approved :: MIT License",

+ "Operating System :: OS Independent",

+ "Programming Language :: Python :: 3.9",

+ "Programming Language :: Python :: 3.10",

+ "Programming Language :: Python :: 3.11",

+ "Topic :: Utilities",

+]

+keywords = ["box", "vagrant", "vagrantfile", "virtual-machine", "virtualbox"]

+

+[project.urls]

+homepage = "https://github.com/pycontribs/python-vagrant"

+repository = "https://github.com/pycontribs/python-vagrant"

+changelog = "https://github.com/pycontribs/python-vagrant/releases"

+

+[project.optional-dependencies]

+test = [

+ "coverage>=6.3",

+ "pytest-cov>=3.0.0",

+ "pytest>=7.0.0",

+ "pytest-plus>=0.2",

+]

+

+[tool.mypy]

+python_version = 3.9

+color_output = true

+error_summary = true

+check_untyped_defs = true

+disallow_untyped_calls = true

+# disallow_untyped_defs = True

+# disallow_any_generics = True

+# disallow_any_unimported = True

+# warn_redundant_casts = True

+# warn_return_any = True

+# warn_unused_configs = True

+# site-packages is here to help vscode mypy integration getting confused

+exclude = "(build|test/local-content|site-packages)"

+

+[tool.pylint.IMPORTS]

+preferred-modules = ["py:pathlib", "unittest:pytest"]

+

+[tool.pylint.MASTER]

+# pylint defaults + f,fh,v,id

+good-names = "i,j,k,_,f,fh,v,id,T"

+

+[tool.pylint."MESSAGES CONTROL"]

+disable = [

+ # On purpose disabled as we rely on black

+ "line-too-long",

+ # TODO(ssbarnea): remove temporary skips adding during initial adoption:

+ "consider-using-f-string",

+ "duplicate-code",

+ "invalid-name",

+ "missing-function-docstring",

+ "no-else-return",

+ "no-self-use",

+ "preferred-module",

+ "protected-access",

+ "too-many-arguments",

+ "too-many-branches",

+ "too-many-lines",

+ "too-many-public-methods",

+ "too-many-statements",

+ "unused-variable",

+]

+

+addopts = ["-p", "no:pytest_cov"]

+# 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.

+#

+# This file is autogenerated by pip-compile with Python 3.9

+# by the following command:

+#

+# pip-compile --extra=test --no-annotate --output-file=requirements.txt --resolver=backtracking --strip-extras pyproject.toml

+#

+attrs==22.1.0

+coverage==6.5.0

+exceptiongroup==1.0.4

+iniconfig==1.1.1

+more-itertools==9.0.0

+packaging==22.0

+pluggy==1.0.0

+pytest==7.2.0

+pytest-cov==4.0.0

+pytest-plus==0.2

+tomli==2.0.1

+import typing

+from typing import Dict, Iterator, List, Optional, Union

+def which(program) -> Optional[str]: # noqa C901

+ def is_exe(fpath) -> bool:

+def get_vagrant_executable() -> Optional[str]:

+GlobalStatus = collections.namedtuple(

+ "GlobalStatus", ["id", "state", "provider", "home"]

+)

+def make_file_cm(filename, mode="a") -> typing.Callable[[], typing.ContextManager]:

+ ) -> None:

+ self._cached_conf: Dict[str, Optional[Dict[str, str]]] = {}

+ self._vagrant_exe: Optional[str] = None # cache vagrant executable path

+ def version(self) -> str:

+ def init(self, box_name=None, box_url=None) -> None:

+ ) -> Optional[Iterator[str]]:

+ def provision(self, vm_name=None, provision_with=None) -> None:

+ ) -> Optional[Iterator[str]]:

+ def suspend(self, vm_name=None) -> None:

+ def resume(self, vm_name=None) -> None:

+ def halt(self, vm_name=None, force=False) -> None:

+ def destroy(self, vm_name=None) -> None:

+ def status(self, vm_name=None) -> List[Status]:

+ def global_status(self, prune=False):

+ """

+ Return the results of a `vagrant global-status` call as a list of one or more

+ GlobalStatus objects. A GlobalStatus contains the following attributes:

+

+ - id: The VM id.

+ - state: The state of the underlying guest machine (i.e. VM).

+ - provider: the name of the VM provider, e.g. 'virtualbox'. None

+ if no provider is output by vagrant.

+ - home: the path to the machine vagrantfile for the VM

+ """

+ # machine-readable output are CSV lines

+ cmd = ["global-status", "--machine-readable"]

+ if prune is True:

+ cmd.append("--prune")

+ output = self._run_vagrant_command(cmd)

+ return self._parse_global_status(output)

+

+ def _normalize_status(self, status, provider) -> str:

+ def _parse_status(self, output) -> List[Status]:

+ def _parse_global_status(self, output: str) -> List[GlobalStatus]:

+ """

+ Unit testing is so much easier when Vagrant is removed from the

+ equation.

+ """

+ parsed = self._parse_machine_readable_output(output)

+ statuses = []

+ vm_id = state = provider = home = None

+ for timestamp, target, kind, data in parsed:

+ if kind == "machine-id":

+ vm_id = data

+ elif kind == "provider-name":

+ provider = data

+ elif kind == "machine-home":

+ home = data

+ elif kind == "state":

+ state = data

+ if vm_id and provider and home and state:

+ state = self._normalize_status(state, provider)

+ status = GlobalStatus(

+ id=vm_id, state=state, provider=provider, home=home

+ )

+ statuses.append(status)

+ vm_id = state = provider = home = None

+ return statuses

+

+ def conf(self, ssh_config=None, vm_name=None) -> Dict[str, str]:

+ conf = self._cached_conf.get(vm_name)

+ if conf is None or ssh_config is not None:

+ return conf

+ def ssh_config(self, vm_name=None) -> str:

+ def user(self, vm_name=None) -> Optional[str]:

+ def hostname(self, vm_name=None) -> Optional[str]:

+ def port(self, vm_name=None) -> Optional[str]:

+ def keyfile(self, vm_name=None) -> Optional[str]:

+ def user_hostname(self, vm_name=None) -> str:

+ This string is suitable for use in an ssh command. If user is None

+ hostname = self.hostname(vm_name=vm_name)

+ if hostname is None:

+ raise ValueError("Missing hostname for vm_name={vm_name!r}")

+ return user_prefix + hostname

+ def user_hostname_port(self, vm_name=None) -> str:

+ hostname = self.hostname(vm_name=vm_name)

+ if hostname is None:

+ raise ValueError("Missing hostname for vm_name={vm_name!r}")

+ return user_prefix + hostname + port_suffix

+ def box_add(self, name, url, provider=None, force=False) -> None:

+ def box_list(self) -> List[Box]:

+ def ssh(self, vm_name=None, command=None, extra_ssh_args=None) -> str:

+ def _parse_box_list(self, output) -> List[Box]:

+ def box_update(self, name, provider) -> None:

+ def box_remove(self, name, provider) -> None:

+ def validate(self, directory) -> subprocess.CompletedProcess:

+ def _parse_plugin_list(self, output) -> List[Plugin]:

+ def _parse_machine_readable_output(self, output: str) -> List[List[str]]:

+ def _parse_config(self, ssh_config: str) -> Dict[str, str]:

+ def _make_vagrant_command(self, args: List[Union[str, None]]) -> List[str]:

+ # environments, this quietly removes it from the arguments list

+ def _call_vagrant_command(self, args) -> None:

+ def _run_vagrant_command(self, args) -> str:

+ def _stream_vagrant_command(self, args) -> Iterator[str]:

+ stdout = typing.cast(typing.IO, p.stdout)

+ with stdout:

+ for line in iter(stdout.readline, b""):

+ def _run_sandbox_command(self, args) -> str:

+ def sandbox_commit(self, vm_name=None) -> None:

+ def sandbox_off(self, vm_name=None) -> None:

+ def sandbox_on(self, vm_name=None) -> None:

+ def sandbox_rollback(self, vm_name=None) -> None:

+ def sandbox_status(self, vm_name=None) -> str:

+ def _parse_vagrant_sandbox_status(self, vagrant_output) -> str:

+Python 2/3 compatibility module.

+def decode(value: bytes) -> str:

+ return value.decode(locale.getpreferredencoding()) if not PY2 else value # type: ignore

+from typing import Dict, List, Optional

+ vagrant_root: Optional[str] = None

+ def assertBoxStatus(self, box: str, status: str) -> None:

+ def assertBoxUp(self, box: str) -> None:

+ def assertBoxSuspended(self, box: str) -> None:

+ def assertBoxHalted(self, box: str) -> None:

+ def assertBoxNotCreated(self, box: str) -> None:

+ def setUpOnce(self) -> None:

+ def tearDownOnce(self) -> None:

+ def restore_box_states(self) -> None:

+import typing

+from typing import Generator, List, Optional

+ Defaults to virtualbox.

+VAGRANT_EXE = typing.cast(str, vagrant.get_vagrant_executable())

+def list_box_names() -> List[str]:

+def test_parse_global_status(vm_dir):

+ """

+ Test the parsing the output of the `vagrant global-status` command.

+ """

+ listing = """1651503808,,metadata,machine-count,2

+1651503808,,machine-id,9ec0e5d

+1651503808,,provider-name,libvirt

+1651503808,,machine-home,/tmp

+1651503808,,state,preparing

+1651503808,,machine-id,61395ad

+1651503808,,provider-name,libvirt

+1651503808,,machine-home,/home/rtp/.cache/molecule/sbd/default

+1651503808,,state,running

+1651504022,,ui,info,id

+1651504022,,ui,info,name

+1651504022,,ui,info,provider

+1651504022,,ui,info,state

+1651504022,,ui,info,directory

+1651504022,,ui,info,

+1651504022,,ui,info,-------------------------------------------------------------------------------------------------------------

+1651504022,,ui,info,9ec0e5d

+1651504022,,ui,info,bionic

+1651504022,,ui,info,libvirt

+1651504022,,ui,info,preparing

+1651504022,,ui,info,/tmp

+1651504022,,ui,info,

+1651504022,,ui,info,61395ad

+1651504022,,ui,info,instance-sbd-default

+1651504022,,ui,info,libvirt

+1651504022,,ui,info,running

+1651504022,,ui,info,/home/rtp/.cache/molecule/sbd/default

+1651504022,,ui,info,

+11651504022,,ui,info, \\nThe above shows information about all known Vagrant environments\\non this machine...

+"""

+ # Can compare tuples to GlobalStatus class b/c GlobalStatus is a collections.namedtuple.

+ goal = [

+ ("9ec0e5d", "preparing", "libvirt", "/tmp"),

+ ("61395ad", "running", "libvirt", "/home/rtp/.cache/molecule/sbd/default"),

+ ]

+ v = vagrant.Vagrant(vm_dir)

+ parsed = v._parse_global_status(listing)

+ assert (

+ goal == parsed

+ ), "The parsing of the test listing did not match the goal.\nlisting={!r}\ngoal={!r}\nparsed_listing={!r}".format(

+ listing, goal, parsed

+ )

+

+

+ for line in v.up(stream_output=True): # type: ignore

+ for line in v.reload(stream_output=True): # type: ignore

+def _execute_command_in_vm(v, command) -> str:

+def _write_test_file(v, file_contents) -> None:

+def _read_test_file(v) -> Optional[str]:

+def _plugin_installed(v, plugin_name) -> bool:

+def get_vagrant_root(test_vagrant_root_path) -> str:

+PROVIDER="$1"

+TMPDIR="$(mktemp -d)"

+if [ -f "${DIR}/dummy-${PROVIDER}.box" ]; then

+cd "${TMPDIR}" || exit 1

+echo "{ \"provider\": \"${PROVIDER}\"}" > metadata.json

+tar czf "${DIR}/dummy-${PROVIDER}.box" .

+cd "${DIR}" || exit 1

+rm -rvf "${TMPDIR}"

+minversion = 4.0.2

+ tox>=4.0.2

+ # temporary disabled due to problem with tox v4

+ # tox-extra>=1.0.1a0

+ PYTEST_*

+ COVERAGE_FILE = {env:COVERAGE_FILE:{toxworkdir}/.coverage.{envname}}

+ PIP_CONSTRAINT = requirements.txt

+ git

+ sh

+ */create_dummy_box.sh

+[testenv:deps]

+description = Bump all test dependencies

+# we reuse the lint environment

+envdir = {toxworkdir}/lint

+skip_install = true

+deps =

+ {[testenv:lint]deps}

+setenv =

+ # without his upgrade would likely not do anything

+ PIP_CONSTRAINT = /dev/null

+commands_pre =

+commands =

+ pre-commit run --all-files --show-diff-on-failure --hook-stage manual up

+ # Update pre-commit hooks

+ pre-commit autoupdate

+ # We fail if files are modified at the end

+ git diff --exit-code

+

+setenv =

+ PIP_CONSTRAINT = /dev/null

+commands_pre =

+ build >= 0.9.0