main.go 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254
  1. // Command aws-gen-gocli parses a JSON description of an AWS API and generates a
  2. // Go file containing a client for the API.
  3. //
  4. // aws-gen-gocli apis/s3/2006-03-03/api-2.json
  5. package main
  6. import (
  7. "flag"
  8. "fmt"
  9. "io/ioutil"
  10. "os"
  11. "path/filepath"
  12. "runtime/debug"
  13. "sort"
  14. "strings"
  15. "sync"
  16. "github.com/aws/aws-sdk-go/private/model/api"
  17. "github.com/aws/aws-sdk-go/private/util"
  18. )
  19. type generateInfo struct {
  20. *api.API
  21. PackageDir string
  22. }
  23. var excludeServices = map[string]struct{}{
  24. "importexport": {},
  25. }
  26. // newGenerateInfo initializes the service API's folder structure for a specific service.
  27. // If the SERVICES environment variable is set, and this service is not apart of the list
  28. // this service will be skipped.
  29. func newGenerateInfo(modelFile, svcPath, svcImportPath string) *generateInfo {
  30. g := &generateInfo{API: &api.API{SvcClientImportPath: svcImportPath}}
  31. g.API.Attach(modelFile)
  32. if _, ok := excludeServices[g.API.PackageName()]; ok {
  33. return nil
  34. }
  35. paginatorsFile := strings.Replace(modelFile, "api-2.json", "paginators-1.json", -1)
  36. if _, err := os.Stat(paginatorsFile); err == nil {
  37. g.API.AttachPaginators(paginatorsFile)
  38. } else if !os.IsNotExist(err) {
  39. fmt.Println("api-2.json error:", err)
  40. }
  41. docsFile := strings.Replace(modelFile, "api-2.json", "docs-2.json", -1)
  42. if _, err := os.Stat(docsFile); err == nil {
  43. g.API.AttachDocs(docsFile)
  44. } else {
  45. fmt.Println("docs-2.json error:", err)
  46. }
  47. waitersFile := strings.Replace(modelFile, "api-2.json", "waiters-2.json", -1)
  48. if _, err := os.Stat(waitersFile); err == nil {
  49. g.API.AttachWaiters(waitersFile)
  50. } else if !os.IsNotExist(err) {
  51. fmt.Println("waiters-2.json error:", err)
  52. }
  53. g.API.Setup()
  54. if svc := os.Getenv("SERVICES"); svc != "" {
  55. svcs := strings.Split(svc, ",")
  56. included := false
  57. for _, s := range svcs {
  58. if s == g.API.PackageName() {
  59. included = true
  60. break
  61. }
  62. }
  63. if !included {
  64. // skip this non-included service
  65. return nil
  66. }
  67. }
  68. // ensure the directory exists
  69. pkgDir := filepath.Join(svcPath, g.API.PackageName())
  70. os.MkdirAll(pkgDir, 0775)
  71. os.MkdirAll(filepath.Join(pkgDir, g.API.InterfacePackageName()), 0775)
  72. g.PackageDir = pkgDir
  73. return g
  74. }
  75. // Generates service api, examples, and interface from api json definition files.
  76. //
  77. // Flags:
  78. // -path alternative service path to write generated files to for each service.
  79. //
  80. // Env:
  81. // SERVICES comma separated list of services to generate.
  82. func main() {
  83. var svcPath, sessionPath, svcImportPath string
  84. flag.StringVar(&svcPath, "path", "service", "directory to generate service clients in")
  85. flag.StringVar(&sessionPath, "sessionPath", filepath.Join("aws", "session"), "generate session service client factories")
  86. flag.StringVar(&svcImportPath, "svc-import-path", "github.com/aws/aws-sdk-go/service", "namespace to generate service client Go code import path under")
  87. flag.Parse()
  88. files := []string{}
  89. for i := 0; i < flag.NArg(); i++ {
  90. file := flag.Arg(i)
  91. if strings.Contains(file, "*") {
  92. paths, _ := filepath.Glob(file)
  93. files = append(files, paths...)
  94. } else {
  95. files = append(files, file)
  96. }
  97. }
  98. for svcName := range excludeServices {
  99. if strings.Contains(os.Getenv("SERVICES"), svcName) {
  100. fmt.Printf("Service %s is not supported\n", svcName)
  101. os.Exit(1)
  102. }
  103. }
  104. sort.Strings(files)
  105. // Remove old API versions from list
  106. m := map[string]bool{}
  107. for i := range files {
  108. idx := len(files) - 1 - i
  109. parts := strings.Split(files[idx], string(filepath.Separator))
  110. svc := parts[len(parts)-3] // service name is 2nd-to-last component
  111. if m[svc] {
  112. files[idx] = "" // wipe this one out if we already saw the service
  113. }
  114. m[svc] = true
  115. }
  116. wg := sync.WaitGroup{}
  117. for i := range files {
  118. filename := files[i]
  119. if filename == "" { // empty file
  120. continue
  121. }
  122. genInfo := newGenerateInfo(filename, svcPath, svcImportPath)
  123. if genInfo == nil {
  124. continue
  125. }
  126. if _, ok := excludeServices[genInfo.API.PackageName()]; ok {
  127. // Skip services not yet supported.
  128. continue
  129. }
  130. wg.Add(1)
  131. go func(g *generateInfo, filename string) {
  132. defer wg.Done()
  133. writeServiceFiles(g, filename)
  134. }(genInfo, filename)
  135. }
  136. wg.Wait()
  137. }
  138. func writeServiceFiles(g *generateInfo, filename string) {
  139. defer func() {
  140. if r := recover(); r != nil {
  141. fmt.Fprintf(os.Stderr, "Error generating %s\n%s\n%s\n",
  142. filename, r, debug.Stack())
  143. }
  144. }()
  145. fmt.Printf("Generating %s (%s)...\n",
  146. g.API.PackageName(), g.API.Metadata.APIVersion)
  147. // write api.go and service.go files
  148. Must(writeAPIFile(g))
  149. Must(writeExamplesFile(g))
  150. Must(writeServiceFile(g))
  151. Must(writeInterfaceFile(g))
  152. Must(writeWaitersFile(g))
  153. }
  154. // Must will panic if the error passed in is not nil.
  155. func Must(err error) {
  156. if err != nil {
  157. panic(err)
  158. }
  159. }
  160. const codeLayout = `// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
  161. %s
  162. package %s
  163. %s
  164. `
  165. func writeGoFile(file string, layout string, args ...interface{}) error {
  166. return ioutil.WriteFile(file, []byte(util.GoFmt(fmt.Sprintf(layout, args...))), 0664)
  167. }
  168. // writeExamplesFile writes out the service example file.
  169. func writeExamplesFile(g *generateInfo) error {
  170. return writeGoFile(filepath.Join(g.PackageDir, "examples_test.go"),
  171. codeLayout,
  172. "",
  173. g.API.PackageName()+"_test",
  174. g.API.ExampleGoCode(),
  175. )
  176. }
  177. // writeServiceFile writes out the service initialization file.
  178. func writeServiceFile(g *generateInfo) error {
  179. return writeGoFile(filepath.Join(g.PackageDir, "service.go"),
  180. codeLayout,
  181. "",
  182. g.API.PackageName(),
  183. g.API.ServiceGoCode(),
  184. )
  185. }
  186. // writeInterfaceFile writes out the service interface file.
  187. func writeInterfaceFile(g *generateInfo) error {
  188. return writeGoFile(filepath.Join(g.PackageDir, g.API.InterfacePackageName(), "interface.go"),
  189. codeLayout,
  190. fmt.Sprintf("\n// Package %s provides an interface for the %s.",
  191. g.API.InterfacePackageName(), g.API.Metadata.ServiceFullName),
  192. g.API.InterfacePackageName(),
  193. g.API.InterfaceGoCode(),
  194. )
  195. }
  196. func writeWaitersFile(g *generateInfo) error {
  197. if len(g.API.Waiters) == 0 {
  198. return nil
  199. }
  200. return writeGoFile(filepath.Join(g.PackageDir, "waiters.go"),
  201. codeLayout,
  202. "",
  203. g.API.PackageName(),
  204. g.API.WaitersGoCode(),
  205. )
  206. }
  207. // writeAPIFile writes out the service api file.
  208. func writeAPIFile(g *generateInfo) error {
  209. return writeGoFile(filepath.Join(g.PackageDir, "api.go"),
  210. codeLayout,
  211. fmt.Sprintf("\n// Package %s provides a client for %s.",
  212. g.API.PackageName(), g.API.Metadata.ServiceFullName),
  213. g.API.PackageName(),
  214. g.API.APIGoCode(),
  215. )
  216. }