├── LICENSE └── gen_mocks.go /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /gen_mocks.go: -------------------------------------------------------------------------------- 1 | package main // import "sourcegraph.com/sourcegraph/gen-mocks" 2 | 3 | import ( 4 | "bytes" 5 | "flag" 6 | "fmt" 7 | "go/ast" 8 | "go/build" 9 | "go/parser" 10 | "go/printer" 11 | "go/token" 12 | "io" 13 | "log" 14 | "os" 15 | "path/filepath" 16 | "regexp" 17 | "strings" 18 | 19 | "golang.org/x/tools/imports" 20 | ) 21 | 22 | var ( 23 | ifacePkgDir = flag.String("p", ".", "directory of package containing interface types") 24 | ifacePat = flag.String("i", ".+Service", "regexp pattern for selecting interface types by name") 25 | writeFiles = flag.Bool("w", false, "write over existing files in output directory (default: writes to stdout)") 26 | outDir = flag.String("o", ".", "output directory") 27 | outPkg = flag.String("outpkg", "", "output pkg name (default: same as input pkg)") 28 | namePrefix = flag.String("name_prefix", "Mock", "output: name prefix of mock impl types (e.g., T -> MockT)") 29 | noPassArgs = flag.String("no_pass_args", "", "don't pass args with this name from the interface method to the mock impl func") 30 | 31 | fset = token.NewFileSet() 32 | ) 33 | 34 | func main() { 35 | flag.Parse() 36 | log.SetFlags(0) 37 | 38 | bpkg, err := build.Import(*ifacePkgDir, ".", build.FindOnly) 39 | if err != nil { 40 | log.Fatal(err) 41 | } 42 | 43 | pat, err := regexp.Compile(*ifacePat) 44 | if err != nil { 45 | log.Fatal(err) 46 | } 47 | 48 | pkgs, err := parser.ParseDir(fset, *ifacePkgDir, nil, parser.AllErrors) 49 | if err != nil { 50 | log.Fatal(err) 51 | } 52 | 53 | for _, pkg := range pkgs { 54 | if pkg.Name == "main" || strings.HasSuffix(pkg.Name, "_test") { 55 | continue 56 | } 57 | 58 | ifaces, err := readIfaces(pkg, pat) 59 | if err != nil { 60 | log.Fatal(err) 61 | } 62 | if len(ifaces) == 0 { 63 | log.Printf("warning: package %q has no interface types matching %q", pkg.Name, *ifacePat) 64 | continue 65 | } 66 | 67 | var pkgName string 68 | if *outPkg == "" { 69 | pkgName = pkg.Name 70 | } else { 71 | pkgName = *outPkg 72 | } 73 | 74 | if err := writeMockImplFiles(*outDir, pkgName, pkg.Name, bpkg.ImportPath, ifaces); err != nil { 75 | log.Fatal(err) 76 | } 77 | } 78 | } 79 | 80 | // readIfaces returns a list of interface types in pkg that should be 81 | // mocked. 82 | func readIfaces(pkg *ast.Package, pat *regexp.Regexp) ([]*ast.TypeSpec, error) { 83 | var ifaces []*ast.TypeSpec 84 | ast.Walk(visitFn(func(node ast.Node) bool { 85 | switch node := node.(type) { 86 | case *ast.GenDecl: 87 | if node.Tok == token.TYPE { 88 | for _, spec := range node.Specs { 89 | tspec := spec.(*ast.TypeSpec) 90 | if _, ok := tspec.Type.(*ast.InterfaceType); !ok { 91 | continue 92 | } 93 | if name := tspec.Name.Name; pat.MatchString(name) { 94 | ifaces = append(ifaces, tspec) 95 | } 96 | } 97 | } 98 | return false 99 | default: 100 | return true 101 | } 102 | }), pkg) 103 | return ifaces, nil 104 | } 105 | 106 | type visitFn func(node ast.Node) (descend bool) 107 | 108 | func (v visitFn) Visit(node ast.Node) ast.Visitor { 109 | descend := v(node) 110 | if descend { 111 | return v 112 | } else { 113 | return nil 114 | } 115 | } 116 | 117 | func writeMockImplFiles(outDir, outPkg, ifacePkgName, ifacePkgPath string, svcIfaces []*ast.TypeSpec) error { 118 | if err := os.MkdirAll(outDir, 0700); err != nil { 119 | return err 120 | } 121 | decls := map[string][]ast.Decl{} // file -> decls 122 | for _, iface := range svcIfaces { 123 | filename := fset.Position(iface.Pos()).Filename 124 | filename = filepath.Join(outDir, strings.TrimSuffix(filepath.Base(filename), ".go")+"_mock.go") 125 | 126 | // mock method fields on struct 127 | var methFields []*ast.Field 128 | for _, methField := range iface.Type.(*ast.InterfaceType).Methods.List { 129 | if meth, ok := methField.Type.(*ast.FuncType); ok { 130 | methFields = append(methFields, &ast.Field{ 131 | Names: []*ast.Ident{ast.NewIdent(methField.Names[0].Name + "_")}, 132 | Type: omitNoPassArgs(meth), 133 | }) 134 | } 135 | } 136 | 137 | // struct implementation type 138 | mockTypeName := *namePrefix + iface.Name.Name 139 | implType := &ast.GenDecl{Tok: token.TYPE, Specs: []ast.Spec{&ast.TypeSpec{ 140 | Name: ast.NewIdent(mockTypeName), 141 | Type: &ast.StructType{Fields: &ast.FieldList{List: methFields}}, 142 | }}} 143 | decls[filename] = append(decls[filename], implType) 144 | 145 | // struct methods 146 | for _, methField := range iface.Type.(*ast.InterfaceType).Methods.List { 147 | if meth, ok := methField.Type.(*ast.FuncType); ok { 148 | synthesizeFieldNamesIfMissing(meth.Params) 149 | if ifacePkgName != outPkg { 150 | // TODO(sqs): check for import paths or dirs unequal, not pkg name 151 | qualifyPkgRefs(meth, ifacePkgName) 152 | } 153 | decls[filename] = append(decls[filename], &ast.FuncDecl{ 154 | Recv: &ast.FieldList{List: []*ast.Field{ 155 | { 156 | Names: []*ast.Ident{ast.NewIdent("s")}, 157 | Type: &ast.StarExpr{X: ast.NewIdent(mockTypeName)}, 158 | }, 159 | }}, 160 | Name: ast.NewIdent(methField.Names[0].Name), 161 | Type: meth, 162 | Body: &ast.BlockStmt{List: []ast.Stmt{ 163 | &ast.ReturnStmt{Results: []ast.Expr{ 164 | &ast.CallExpr{ 165 | Fun: &ast.SelectorExpr{ 166 | X: ast.NewIdent("s"), 167 | Sel: ast.NewIdent(methField.Names[0].Name + "_"), 168 | }, 169 | Args: fieldListToIdentList(meth.Params), 170 | Ellipsis: ellipsisIfNeeded(meth.Params), 171 | }, 172 | }}, 173 | }}, 174 | }) 175 | } 176 | } 177 | 178 | // compile-time implements checks 179 | var ifaceType ast.Expr 180 | if ifacePkgName == outPkg { 181 | ifaceType = ast.NewIdent(iface.Name.Name) 182 | } else { 183 | ifaceType = &ast.SelectorExpr{X: ast.NewIdent(ifacePkgName), Sel: ast.NewIdent(iface.Name.Name)} 184 | } 185 | decls[filename] = append(decls[filename], &ast.GenDecl{ 186 | Tok: token.VAR, 187 | Specs: []ast.Spec{ 188 | &ast.ValueSpec{ 189 | Names: []*ast.Ident{ast.NewIdent("_")}, 190 | Type: ifaceType, 191 | Values: []ast.Expr{ 192 | &ast.CallExpr{ 193 | Fun: &ast.ParenExpr{X: &ast.StarExpr{X: ast.NewIdent(mockTypeName)}}, 194 | Args: []ast.Expr{ast.NewIdent("nil")}, 195 | }, 196 | }, 197 | }, 198 | }, 199 | }) 200 | } 201 | 202 | for filename, decls := range decls { 203 | file := &ast.File{ 204 | Name: ast.NewIdent(outPkg), 205 | Decls: decls, 206 | } 207 | log.Println("#", filename) 208 | var w io.Writer 209 | if *writeFiles { 210 | f, err := os.Create(filename) 211 | if err != nil { 212 | return err 213 | } 214 | defer f.Close() 215 | w = f 216 | } else { 217 | w = os.Stdout 218 | } 219 | 220 | var buf bytes.Buffer 221 | if err := printer.Fprint(&buf, fset, file); err != nil { 222 | return err 223 | } 224 | 225 | // Always put blank lines between funcs. 226 | src := bytes.Replace(buf.Bytes(), []byte("}\nfunc"), []byte("}\n\nfunc"), -1) 227 | 228 | var err error 229 | src, err = imports.Process(filename, src, nil) 230 | if err != nil { 231 | return err 232 | } 233 | 234 | fmt.Fprintln(w, "// generated by gen-mocks; DO NOT EDIT") 235 | fmt.Fprintln(w) 236 | w.Write(src) 237 | } 238 | return nil 239 | } 240 | 241 | // qualifyPkgRefs qualifies all refs to non-package-qualified non-builtin types in f so that they refer to definitions in pkg. E.g., 'func(x MyType) -> func (x pkg.MyType)'. 242 | func qualifyPkgRefs(f *ast.FuncType, pkg string) { 243 | var qualify func(x ast.Expr) ast.Expr 244 | qualify = func(x ast.Expr) ast.Expr { 245 | switch y := x.(type) { 246 | case *ast.Ident: 247 | if ast.IsExported(y.Name) { 248 | return &ast.SelectorExpr{X: ast.NewIdent(pkg), Sel: y} 249 | } 250 | case *ast.StarExpr: 251 | y.X = qualify(y.X) 252 | case *ast.ArrayType: 253 | y.Elt = qualify(y.Elt) 254 | case *ast.MapType: 255 | y.Key = qualify(y.Key) 256 | y.Value = qualify(y.Value) 257 | } 258 | return x 259 | } 260 | for _, p := range f.Params.List { 261 | p.Type = qualify(p.Type) 262 | } 263 | for _, r := range f.Results.List { 264 | r.Type = qualify(r.Type) 265 | } 266 | } 267 | 268 | // synthesizeFieldNamesIfMissing adds synthesized variable names to fl 269 | // if it contains fields with no name. E.g., the field list in 270 | // `func(string, int)` would be converted to `func(v0 string, v1 271 | // int)`. 272 | func synthesizeFieldNamesIfMissing(fl *ast.FieldList) { 273 | for i, f := range fl.List { 274 | if len(f.Names) == 0 { 275 | f.Names = []*ast.Ident{ast.NewIdent(fmt.Sprintf("v%d", i))} 276 | } 277 | } 278 | } 279 | 280 | func fieldListToIdentList(fl *ast.FieldList) []ast.Expr { 281 | var fs []ast.Expr 282 | for _, f := range fl.List { 283 | for _, name := range f.Names { 284 | if *noPassArgs == name.Name { 285 | continue 286 | } 287 | x := ast.Expr(ast.NewIdent(name.Name)) 288 | fs = append(fs, x) 289 | } 290 | } 291 | return fs 292 | } 293 | 294 | func hasEllipsis(fl *ast.FieldList) bool { 295 | if fl.List == nil { 296 | return false 297 | } 298 | lastField := fl.List[len(fl.List)-1] 299 | if len(lastField.Names) > 0 && lastField.Names[0].Name == *noPassArgs { 300 | return false 301 | } 302 | _, ok := lastField.Type.(*ast.Ellipsis) 303 | return ok 304 | } 305 | 306 | func ellipsisIfNeeded(fl *ast.FieldList) token.Pos { 307 | if hasEllipsis(fl) { 308 | return 1 309 | } 310 | return 0 311 | } 312 | 313 | func omitNoPassArgs(ft *ast.FuncType) *ast.FuncType { 314 | tmp := *ft // copy 315 | ft = &tmp 316 | 317 | tmp2 := *ft.Params 318 | ft.Params = &tmp2 319 | var keepParams []*ast.Field 320 | for _, p := range ft.Params.List { 321 | if len(p.Names) == 1 && p.Names[0].Name == *noPassArgs { 322 | continue 323 | } 324 | keepParams = append(keepParams, p) 325 | } 326 | ft.Params.List = keepParams 327 | return ft 328 | } 329 | 330 | func astString(x ast.Expr) string { 331 | var buf bytes.Buffer 332 | if err := printer.Fprint(&buf, fset, x); err != nil { 333 | panic(err) 334 | } 335 | return buf.String() 336 | } 337 | --------------------------------------------------------------------------------