1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
|
// 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.
package gen
import (
"bytes"
"go/format"
"net/http"
"net/http/httptest"
"strings"
"testing"
qapischema "github.com/digitalocean/go-qemu/qapi-schema"
)
func TestGenerate(t *testing.T) {
tests := []struct {
name string
in []byte
out []byte
}{
{
name: "StructInfo",
in: []byte(`
##
# @StatusInfo:
#
# Information about VCPU run state
#
# @running: true if all VCPUs are runnable, false if not runnable
#
# @singlestep: true if VCPUs are in single-step mode
#
# @status: the virtual machine @RunState
#
# Since: 0.14.0
#
# Notes: @singlestep is enabled through the GDB stub
##
{ 'struct': 'StatusInfo',
'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
`),
out: []byte(`
// StatusInfo -> StatusInfo (struct)
// StatusInfo implements the "StatusInfo" QMP API type.
type StatusInfo struct {
Running bool 'json:"running"'
Singlestep bool 'json:"singlestep"'
Status RunState 'json:"status"'
}
`),
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Replace single quote with backtick to match generated Go
// source code
tt.out = bytes.TrimSpace(bytes.Replace(tt.out, []byte("'"), []byte("`"), -1))
// Do not check needed types, third parameter is false
source := testGenerate(t, tt.in, false)
if want, got := tt.out, source; !bytes.Contains(got, want) {
t.Fatalf("generated code does not match actual code:\n- want: %s\n- got: %s",
indent(string(want)), indent(string(got)))
}
})
}
}
func TestGenerateNeededTypes(t *testing.T) {
tests := []struct {
name string
in []byte
out []byte
}{
{
name: "no output: no command that uses StructInfo",
in: []byte(`
##
# @StatusInfo:
#
# Information about VCPU run state
#
# @running: true if all VCPUs are runnable, false if not runnable
#
# @singlestep: true if VCPUs are in single-step mode
#
# @status: the virtual machine @RunState
#
# Since: 0.14.0
#
# Notes: @singlestep is enabled through the GDB stub
##
{ 'struct': 'StatusInfo',
'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
`),
},
{
name: "StatusInfo with query-status command",
in: []byte(`
##
# @StatusInfo:
#
# Information about VCPU run state
#
# @running: true if all VCPUs are runnable, false if not runnable
#
# @singlestep: true if VCPUs are in single-step mode
#
# @status: the virtual machine @RunState
#
# Since: 0.14.0
#
# Notes: @singlestep is enabled through the GDB stub
##
{ 'struct': 'StatusInfo',
'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
##
# @query-status:
#
# Query the run status of all VCPUs
#
# Returns: @StatusInfo reflecting all VCPUs
#
# Since: 0.14.0
##
{ 'command': 'query-status', 'returns': 'StatusInfo' }
`),
out: []byte(`
// StatusInfo -> StatusInfo (struct)
// StatusInfo implements the "StatusInfo" QMP API type.
type StatusInfo struct {
Running bool 'json:"running"'
Singlestep bool 'json:"singlestep"'
Status RunState 'json:"status"'
}
// query-status -> QueryStatus (command)
// QueryStatus implements the "query-status" QMP API call.
func (m *Monitor) QueryStatus() (ret StatusInfo, err error) {
cmd := struct {
}{}
bs, err := json.Marshal(map[string]interface{}{
"execute": "query-status",
"arguments": cmd,
})
if err != nil {
return
}
bs, err = m.mon.Run(bs)
if err != nil {
return
}
res := struct {
Res json.RawMessage 'json:"return"'
}{}
if err = json.Unmarshal(bs, &res); err != nil {
return
}
if err = json.Unmarshal([]byte(res.Res), &ret); err != nil {
return
}
return
}`),
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Replace single quote with backtick to match generated Go
// source code
tt.out = bytes.TrimSpace(bytes.Replace(tt.out, []byte("'"), []byte("`"), -1))
// Check needed types, third parameter is true
source := testGenerate(t, tt.in, true)
if want, got := tt.out, source; !bytes.Contains(got, want) {
t.Fatalf("generated code does not match actual code:\n- want: %s\n- got: %s",
indent(string(want)), indent(string(got)))
}
})
}
}
func indent(s string) string {
return strings.Replace(s, "\n", "\n ", -1)
}
func testGenerate(t *testing.T, in []byte, checkNeededTypes bool) []byte {
s := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
_, _ = w.Write(in)
}))
defer s.Close()
data, err := getQAPI(s.URL)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
tree, err := qapischema.Parse(string(data))
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
tree, err = completeParseTree(tree, s.URL)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
symbols := lowerParseTree(tree)
need := symbols
if checkNeededTypes {
need = neededTypes(symbols)
}
bs, err := renderAPI("templates/", symbols, need)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
formatted, err := format.Source(bs)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
return formatted
}
|