Merge pull request digitalocean#123 from digitalocean/qemu-domain-status-raw

qemu: modify Domain.Status to use raw.StatusInfo and raw.RunState types

Author: mdlayher

.travis.yml

@@ -3,12 +3,13 @@ go:
   - 1.7
 before_install:
   - go get github.com/golang/lint/golint
+  - go get golang.org/x/tools/cmd/stringer
 before_script:
   - go get -d ./...
 script:
   - ./scripts/licensecheck.sh
   - ./scripts/codegeneration.sh
   - go build ./...
-  - golint -set_exit_status ./...
+  - ./scripts/golint.sh
   - go vet ./...
   - go test -v ./...

domain.go

@@ -15,6 +15,9 @@
 // Package qemu provides an interface for interacting with running QEMU instances.
 package qemu
 
+//go:generate stringer -type=Status -output=string.gen.go
+//go:generate ./scripts/prependlicense.sh string.gen.go
+
 import (
 	"encoding/json"
 	"errors"
@@ -26,6 +29,7 @@ import (
 	"time"
 
 	"github.com/digitalocean/go-qemu/qmp"
+	"github.com/digitalocean/go-qemu/qmp/raw"
 )
 
 var (
@@ -269,48 +273,46 @@ func (d *Domain) ScreenDump() (io.ReadCloser, error) {
 }
 
 // Status represents the current status of the domain.
-type Status string
+type Status int
 
 // Status constants which indicate the status of a domain.
 const (
-	StatusDebug         Status = "debug"
-	StatusFinishMigrate Status = "finish-migrate"
-	StatusIOError       Status = "io-error"
-	StatusInMigrate     Status = "inmigrate"
-	StatusInternalError Status = "internal-error"
-	StatusPaused        Status = "paused"
-	StatusPostMigrate   Status = "postmigrate"
-	StatusPreLaunch     Status = "prelaunch"
-	StatusRestoreVM     Status = "restore-vm"
-	StatusRunning       Status = "running"
-	StatusSaveVM        Status = "save-vm"
-	StatusShutdown      Status = "shutdown"
-	StatusWatchdog      Status = "watchdog"
+	StatusDebug         Status = Status(raw.RunStateDebug)
+	StatusFinishMigrate Status = Status(raw.RunStateFinishMigrate)
+	StatusGuestPanicked Status = Status(raw.RunStateGuestPanicked)
+	StatusIOError       Status = Status(raw.RunStateIOError)
+	StatusInMigrate     Status = Status(raw.RunStateInmigrate)
+	StatusInternalError Status = Status(raw.RunStateInternalError)
+	StatusPaused        Status = Status(raw.RunStatePaused)
+	StatusPostMigrate   Status = Status(raw.RunStatePostmigrate)
+	StatusPreLaunch     Status = Status(raw.RunStatePrelaunch)
+	StatusRestoreVM     Status = Status(raw.RunStateRestoreVM)
+	StatusRunning       Status = Status(raw.RunStateRunning)
+	StatusSaveVM        Status = Status(raw.RunStateSaveVM)
+	StatusShutdown      Status = Status(raw.RunStateShutdown)
+	StatusSuspended     Status = Status(raw.RunStateSuspended)
+	StatusWatchdog      Status = Status(raw.RunStateWatchdog)
 )
 
 // Status returns the current status of the domain.
 func (d *Domain) Status() (Status, error) {
-	raw, err := d.Run(qmp.Command{Execute: "query-status"})
+	out, err := d.Run(qmp.Command{Execute: "query-status"})
 	if err != nil {
 		// libvirt returns an error if the domain is not running
 		if strings.Contains(err.Error(), "not running") {
 			return StatusShutdown, nil
 		}
 
-		return "", err
+		return 0, err
 	}
 
 	var response struct {
-		ID     string `json:"id"`
-		Return struct {
-			Running    bool   `json:"running"`
-			Singlestep bool   `json:"singlestep"`
-			Status     string `json:"status"`
-		} `json:"return"`
+		ID     string         `json:"id"`
+		Return raw.StatusInfo `json:"return"`
 	}
 
-	if err = json.Unmarshal(raw, &response); err != nil {
-		return "", err
+	if err = json.Unmarshal(out, &response); err != nil {
+		return 0, err
 	}
 
 	return Status(response.Return.Status), nil

domain_test.go

@@ -24,6 +24,7 @@ import (
 	"time"
 
 	"github.com/digitalocean/go-qemu/qmp"
+	"github.com/digitalocean/go-qemu/qmp/raw"
 )
 
 const defaultTestTimeout = 50 * time.Millisecond
@@ -415,12 +416,10 @@ func TestStatusRunning(t *testing.T) {
 				want, got)
 		}
 
-		type response struct {
-			Status Status
-		}
-
 		return success{
-			Return: response{Status: StatusRunning},
+			Return: raw.StatusInfo{
+				Status: raw.RunStateRunning,
+			},
 		}, nil
 	})
 	defer done()
@@ -442,12 +441,10 @@ func TestStatusShutdown(t *testing.T) {
 				want, got)
 		}
 
-		type response struct {
-			Status Status
-		}
-
 		return success{
-			Return: response{Status: StatusShutdown},
+			Return: raw.StatusInfo{
+				Status: raw.RunStateShutdown,
+			},
 		}, nil
 	})
 	defer done()

scripts/golint.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+# Verify that all files are correctly golint'd, with the exception of
+# generated code.
+EXIT=0
+GOLINT=$(golint ./... | grep -v ".gen.go")
+
+if [[ ! -z $GOLINT ]]; then
+	echo "$GOLINT"
+	EXIT=1
+fi
+
+exit $EXIT

scripts/prependlicense.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+# License block to be prepended to file
+read -r -d '' LICENSE <<EndOfLicense
+// Copyright 2016 The go-qemu Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+EndOfLicense
+
+if [ -z "$1" ]; then
+	echo "missing filename argument"
+	echo "usage: prependlicense.sh [filename]"
+	exit 1
+fi
+
+# Prepend license block to file
+echo -e "$LICENSE\n" | cat - $1 > .prependlicense && mv .prependlicense $1