KO
|
EN
gitlite — search
Search
#javascript
#css
#html
#python
#html5
#typescript
#rust
#golang
#config
#github-config
#hacktoberfest
#docker
go-virtualbox
★ 75
Open GitHub ↗
VirtualBox wrappers in Go
Download README (.md)
Explore Similar Repositories
diffparser
:
Parse unified diffs with Java.
salt-dashboard
:
dashboard for saltstack
traffickingGrab
:
A project intended to fight human trafficking by using the web as a database
TextFiction
:
Z-Machine interpreter for Android
Bare.Game
:
An open source modern minimal game cross platform gaming library
// repository documentation
Was this content helpful?
★ 0
(0 ratings)
Select Rating:
★
★
★
★
★
Submit Feedback
Recent Feedback
×
Download README
Do you want to download the
README.md
file for
go-virtualbox
?
Download (.md)
# go-virtualbox 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** <!-- TOC depthFrom:2 depthTo:4 --> 1. [Status](#status) 2. [Usage](#usage) 1. [Library](#library) 2. [Commands](#commands) 3. [Documentation](#documentation) 3. [Building](#building) 4. [Testing](#testing) 1. [Preparation](#preparation) 2. [Run tests](#run-tests) 3. [Re-generate mock](#re-generate-mock) 5. [Caveats](#caveats) <!-- /TOC --> ## Status | Project | Status | Notes | |---------|--------|-------| | [Github Actions](https://github.com/features/actions) | [](https://github.com/terra-farm/go-virtualbox/actions) | | | [Go Report Card](https://goreportcard.com/) | [](https://goreportcard.com/report/github.com/terra-farm/go-virtualbox) | scan code with `gofmt`, `go vet`, `gocyclo`, `golint`, `ineffassign`, `license` and `misspell`. | | [GoDoc](http://godoc.org) | [](http://godoc.org/github.com/terra-farm/go-virtualbox) | | | Release | [](https://github.com/terra-farm/go-virtualbox/releases/latest) | | ## Usage ### Library The part of the library that manages guest properties can run both from the Host and the Guest. ```go err := virtualbox.SetGuestProperty("MyVM", "test_key", "test_val") val, err := GetGuestProperty(VM, "test_key") ``` See [GoDoc](https://godoc.org/github.com/terra-farm/go-virtualbox) for full details. ### Commands The [vbhostd](./cmd/vbhostd/README.md) 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: - Write `http://www.hp.com` will open the default browser as the given URL - Write `mailto:foo@bar.com?Cc=bar@foo.com` opens the default mailer pre-filling the recipient and carbon-copy recipient fields ### Documentation For the released version, see [GoDoc:terra-farm/go-virtualbox](https://godoc.org/github.com/terra-farm/go-virtualbox). To see the local documentation, run `godoc -http=:6060 &` and then `open http://localhost:6060/pkg/github.com/terra-farm/go-virtualbox/`. ## Building First install dependencies - [GoLang](https://golang.org/doc/install#install) - [GNU Make](https://www.gnu.org/software/make/) (Windows: via `choco install -y gnuwin32-make.portable) Get Go dependencies: `make deps` or: ```bash $ go get -v github.com/golang/dep/cmd/dep $ dep ensure -v ``` Then build: `make build` or: ```bash $ go build -v ./... ``` * `default` run everything in order * `deps` install dependencies (`dep` and others) * `build` run `go build ./...` * `test` run `go test ./...` * `lint` only run `gometalinter` linter ## Testing ### Preparation 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](https://www.vagrantup.com/intro/getting-started/). ```bash $ vagrant box add bento/ubuntu-16.04 # select virtualbox as provider $ vagrant up ``` Then run the tests ```bash $ export TEST_VM=go-virtualbox $ go test ``` ...or (on Windows): ```shell > set TEST_VM=go-virtualbox > go test ``` Once you are done with testing, run `vagrant halt` to same resources. ### Run tests As usual, run `go test`, or `go test -v`. To run one test in particular, run `go test --run TestGuestProperty`. ### Re-generate mock ```bash go generate ./... ``` ## 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](https://medium.com/@teivah/how-to-test-a-local-branch-with-go-mod-54df087fc9cc) on how to set up your environment to do this.
