This is a wrapper package for Golang to interact with VirtualBox. The API is experimental at the moment and you should expect frequent changes. There is no compatibility guarantee between newer and older versions of Virtualbox.
Table of Contents
|Go Report Card||scan code with
The part of the library that manages guest properties can run both from the Host and the Guest.
err := virtualbox.SetGuestProperty("MyVM", "test_key", "test_val") val, err := GetGuestProperty(VM, "test_key")
See GoDoc for full details.
The vbhostd commands waits on the
vbhostd/* guest-properties pattern.
- When the guest writes a value on the
vbhostd/open, it causes the host to open the given location:
http://www.hp.comwill open the default browser as the given URL
mailto:firstname.lastname@example.org?Ccemail@example.com the default mailer pre-filling the recipient and carbon-copy recipient fields
For the released version, see GoDoc:terra-farm/go-virtualbox. To see the local documentation, run
godoc -http=:6060 & and then
First install dependencies
Get Go dependencies:
make deps or:
$ go get -v github.com/golang/dep/cmd/dep $ dep ensure -v
make build or:
$ go build -v ./...
defaultrun everything in order
depsinstall dependencies (
go build ./...
go test ./...
Tests run using mocked interfaces, unless the
TEST_VM environment variable is set, in order to test against real VirtualBox. You either need to have a pre-provisioned VirtualBox VM and to set its name using the
TEST_VM environment variable, or use Vagrant.
$ vagrant box add bento/ubuntu-16.04 # select virtualbox as provider $ vagrant up
Then run the tests
$ export TEST_VM=go-virtualbox $ go test
...or (on Windows):
> set TEST_VM=go-virtualbox > go test
Once you are done with testing, run
vagrant halt to same resources.
As usual, run
go test, or
go test -v. To run one test in particular,
go test --run TestGuestProperty.
mockgen -source=vbcmd.go -destination=mockvbcmd_test.go -package=virtualbox -mock_names=Command=MockCommand
Using local changes with your own project
If you have a project which depends on this library, you probably want to test your local changes of
go-virtualbox in your project.
See this article on how to set up your environment
to do this.