/usr/share/gocode/src/github.com/jacobsa/oglemock/generate/generate.go is in golang-github-jacobsa-oglemock-dev 0.0~git20150428-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 | // Copyright 2012 Aaron Jacobs. All Rights Reserved.
// Author: aaronjjacobs@gmail.com (Aaron Jacobs)
//
// 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 generate implements code generation for mock classes. This is an
// implementation detail of the createmock command, which you probably want to
// use directly instead.
package generate
import (
"bytes"
"errors"
"go/ast"
"go/parser"
"go/printer"
"go/token"
"io"
"reflect"
"regexp"
"text/template"
)
const tmplStr = `
// This file was auto-generated using createmock. See the following page for
// more information:
//
// https://github.com/jacobsa/oglemock
//
package {{.Pkg}}
import (
{{range $identifier, $import := .Imports}}{{$identifier}} "{{$import}}"
{{end}}
)
{{range .Interfaces}}
{{$interfaceName := printf "Mock%s" .Name}}
{{$structName := printf "mock%s" .Name}}
type {{$interfaceName}} interface {
{{getTypeString .}}
oglemock.MockObject
}
type {{$structName}} struct {
controller oglemock.Controller
description string
}
func New{{printf "Mock%s" .Name}}(
c oglemock.Controller,
desc string) {{$interfaceName}} {
return &{{$structName}}{
controller: c,
description: desc,
}
}
func (m *{{$structName}}) Oglemock_Id() uintptr {
return uintptr(unsafe.Pointer(m))
}
func (m *{{$structName}}) Oglemock_Description() string {
return m.description
}
{{range getMethods .}}
{{$funcType := .Type}}
{{$inputTypes := getInputs $funcType}}
{{$outputTypes := getOutputs $funcType}}
func (m *{{$structName}}) {{.Name}}({{range $i, $type := $inputTypes}}p{{$i}} {{getInputTypeString $i $funcType}}, {{end}}) ({{range $i, $type := $outputTypes}}o{{$i}} {{getTypeString $type}}, {{end}}) {
// Get a file name and line number for the caller.
_, file, line, _ := runtime.Caller(1)
// Hand the call off to the controller, which does most of the work.
retVals := m.controller.HandleMethodCall(
m,
"{{.Name}}",
file,
line,
[]interface{}{ {{range $i, $type := $inputTypes}}p{{$i}}, {{end}} })
if len(retVals) != {{len $outputTypes}} {
panic(fmt.Sprintf("{{$structName}}.{{.Name}}: invalid return values: %v", retVals))
}
{{range $i, $type := $outputTypes}}
// o{{$i}} {{getTypeString $type}}
if retVals[{{$i}}] != nil {
o{{$i}} = retVals[{{$i}}].({{getTypeString $type}})
}
{{end}}
return
}
{{end}}
{{end}}
`
type tmplArg struct {
// The package of the generated code.
Pkg string
// Imports needed by the interfaces.
Imports importMap
// The set of interfaces to mock.
Interfaces []reflect.Type
}
var tmpl *template.Template
func init() {
extraFuncs := make(template.FuncMap)
extraFuncs["getMethods"] = getMethods
extraFuncs["getInputs"] = getInputs
extraFuncs["getOutputs"] = getOutputs
extraFuncs["getInputTypeString"] = getInputTypeString
extraFuncs["getTypeString"] = getTypeString
tmpl = template.New("code")
tmpl.Funcs(extraFuncs)
tmpl.Parse(tmplStr)
}
func getInputTypeString(i int, ft reflect.Type) string {
numInputs := ft.NumIn()
if i == numInputs-1 && ft.IsVariadic() {
return "..." + getTypeString(ft.In(i).Elem())
}
return getTypeString(ft.In(i))
}
func getTypeString(t reflect.Type) string {
return t.String()
}
func getMethods(it reflect.Type) []reflect.Method {
numMethods := it.NumMethod()
methods := make([]reflect.Method, numMethods)
for i := 0; i < numMethods; i++ {
methods[i] = it.Method(i)
}
return methods
}
func getInputs(ft reflect.Type) []reflect.Type {
numIn := ft.NumIn()
inputs := make([]reflect.Type, numIn)
for i := 0; i < numIn; i++ {
inputs[i] = ft.In(i)
}
return inputs
}
func getOutputs(ft reflect.Type) []reflect.Type {
numOut := ft.NumOut()
outputs := make([]reflect.Type, numOut)
for i := 0; i < numOut; i++ {
outputs[i] = ft.Out(i)
}
return outputs
}
// A map from import identifier to package to use that identifier for,
// containing elements for each import needed by a set of mocked interfaces.
type importMap map[string]string
var typePackageIdentifierRegexp = regexp.MustCompile(`^([\pL_0-9]+)\.[\pL_0-9]+$`)
// Add an import for the supplied type, without recursing.
func addImportForType(imports importMap, t reflect.Type) {
// If there is no package path, this is a built-in type and we don't need an
// import.
pkgPath := t.PkgPath()
if pkgPath == "" {
return
}
// Work around a bug in Go:
//
// http://code.google.com/p/go/issues/detail?id=2660
//
var errorPtr *error
if t == reflect.TypeOf(errorPtr).Elem() {
return
}
// Use the identifier that's part of the type's string representation as the
// import identifier. This means that we'll do the right thing for package
// "foo/bar" with declaration "package baz".
match := typePackageIdentifierRegexp.FindStringSubmatch(t.String())
if match == nil {
return
}
imports[match[1]] = pkgPath
}
// Add all necessary imports for the type, recursing as appropriate.
func addImportsForType(imports importMap, t reflect.Type) {
// Add any import needed for the type itself.
addImportForType(imports, t)
// Handle special cases where recursion is needed.
switch t.Kind() {
case reflect.Array, reflect.Chan, reflect.Ptr, reflect.Slice:
addImportsForType(imports, t.Elem())
case reflect.Func:
// Input parameters.
for i := 0; i < t.NumIn(); i++ {
addImportsForType(imports, t.In(i))
}
// Return values.
for i := 0; i < t.NumOut(); i++ {
addImportsForType(imports, t.Out(i))
}
case reflect.Map:
addImportsForType(imports, t.Key())
addImportsForType(imports, t.Elem())
}
}
// Add imports for each of the methods of the interface, but not the interface
// itself.
func addImportsForInterfaceMethods(imports importMap, it reflect.Type) {
// Handle each method.
for i := 0; i < it.NumMethod(); i++ {
m := it.Method(i)
addImportsForType(imports, m.Type)
}
}
// Given a set of interfaces, return a map from import identifier to package to
// use that identifier for, containing elements for each import needed by the
// mock versions of those interfaces.
func getImports(interfaces []reflect.Type) importMap {
imports := make(importMap)
for _, it := range interfaces {
addImportForType(imports, it)
addImportsForInterfaceMethods(imports, it)
}
// Make sure there are imports for other types used by the generated code
// itself.
imports["fmt"] = "fmt"
imports["oglemock"] = "github.com/jacobsa/oglemock"
imports["runtime"] = "runtime"
imports["unsafe"] = "unsafe"
return imports
}
// Given a set of interfaces to mock, write out source code for a package named
// `pkg` that contains mock implementations of those interfaces.
func GenerateMockSource(w io.Writer, pkg string, interfaces []reflect.Type) error {
// Sanity-check arguments.
if pkg == "" {
return errors.New("Package name must be non-empty.")
}
if len(interfaces) == 0 {
return errors.New("List of interfaces must be non-empty.")
}
// Make sure each type is indeed an interface.
for _, it := range interfaces {
if it.Kind() != reflect.Interface {
return errors.New("Invalid type: " + it.String())
}
}
// Create an appropriate template arg, then execute the template. Write the
// raw output into a buffer.
var arg tmplArg
arg.Pkg = pkg
arg.Imports = getImports(interfaces)
arg.Interfaces = interfaces
buf := new(bytes.Buffer)
if err := tmpl.Execute(buf, arg); err != nil {
return err
}
// Parse the output.
fset := token.NewFileSet()
astFile, err := parser.ParseFile(fset, pkg+".go", buf, parser.ParseComments)
if err != nil {
return errors.New("Error parsing generated code: " + err.Error())
}
// Sort the import lines in the AST in the same way that gofmt does.
ast.SortImports(fset, astFile)
// Pretty-print the AST, using the same options that gofmt does by default.
cfg := &printer.Config{
Mode: printer.UseSpaces | printer.TabIndent,
Tabwidth: 8,
}
if err = cfg.Fprint(w, fset, astFile); err != nil {
return errors.New("Error pretty printing: " + err.Error())
}
return nil
}
|