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
|
// Copyright 2017 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package main
import (
"bytes"
"flag"
"fmt"
"io/ioutil"
"path/filepath"
"strings"
"testing"
"google.golang.org/api/google-api-go-generator/internal/disco"
"google.golang.org/api/internal/version"
)
var updateGolden = flag.Bool("update_golden", false, "If true, causes TestAPIs to update golden files")
func TestAPIs(t *testing.T) {
*copyrightYear = "YEAR"
names := []string{
"any",
"arrayofarray-1",
"arrayofenum",
"arrayofmapofobjects",
"arrayofmapofstrings",
"blogger-3",
"floats",
"getwithoutbody",
"http-body",
"json-body",
"mapofany",
"mapofarrayofobjects",
"mapofint64strings",
"mapofobjects",
"mapofstrings-1",
"param-rename",
"quotednum",
"repeated",
"required-query",
"resource-named-service", // appengine/v1/appengine-api.json
"unfortunatedefaults",
"variants",
"wrapnewlines",
}
for _, name := range names {
t.Run(name, func(t *testing.T) {
api, err := apiFromFile(filepath.Join("testdata", name+".json"))
if err != nil {
t.Fatalf("Error loading API testdata/%s.json: %v", name, err)
}
clean, err := api.GenerateCode()
if err != nil {
t.Fatalf("Error generating code for %s: %v", name, err)
}
goldenFile := filepath.Join("testdata", name+".want")
if *updateGolden {
clean := strings.Replace(string(clean), fmt.Sprintf("gdcl/%s", version.Repo), "gdcl/00000000", -1)
if err := ioutil.WriteFile(goldenFile, []byte(clean), 0644); err != nil {
t.Fatal(err)
}
}
want, err := ioutil.ReadFile(goldenFile)
if err != nil {
t.Fatal(err)
}
wantStr := strings.Replace(string(want), "gdcl/00000000", fmt.Sprintf("gdcl/%s", version.Repo), -1)
if !bytes.Equal([]byte(wantStr), clean) {
tf, _ := ioutil.TempFile("", "api-"+name+"-got-json.")
if _, err := tf.Write(clean); err != nil {
t.Fatal(err)
}
if err := tf.Close(); err != nil {
t.Fatal(err)
}
// NOTE: update golden files with `go test -update_golden`
t.Errorf("Output for API %s differs: diff -u %s %s", name, goldenFile, tf.Name())
}
})
}
}
func TestScope(t *testing.T) {
tests := [][]string{
{
"https://www.googleapis.com/auth/somescope",
"SomescopeScope",
},
{
"https://mail.google.com/somescope",
"MailGoogleComSomescopeScope",
},
{
"https://mail.google.com/",
"MailGoogleComScope",
},
}
for _, test := range tests {
if got := scopeIdentifier(disco.Scope{ID: test[0]}); got != test[1] {
t.Errorf("scopeIdentifier(%q) got %q, want %q", test[0], got, test[1])
}
}
}
func TestDepunct(t *testing.T) {
tests := []struct {
needCap bool
in, want string
}{
{
needCap: true,
in: "part__description",
want: "Part__description",
},
{
needCap: true,
in: "Part_description",
want: "PartDescription",
},
{
needCap: false,
in: "part_description",
want: "partDescription",
},
{
needCap: false,
in: "part-description",
want: "partDescription",
},
{
needCap: false,
in: "part.description",
want: "partDescription",
},
{
needCap: false,
in: "part$description",
want: "partDescription",
},
{
needCap: false,
in: "part/description",
want: "partDescription",
},
{
needCap: true,
in: "Part__description_name",
want: "Part__descriptionName",
},
{
needCap: true,
in: "Part_description_name",
want: "PartDescriptionName",
},
{
needCap: true,
in: "Part__description__name",
want: "Part__description__name",
},
{
needCap: true,
in: "Part_description__name",
want: "PartDescription__name",
},
}
for _, test := range tests {
if got := depunct(test.in, test.needCap); got != test.want {
t.Errorf("depunct(%q,%v) = %q; want %q", test.in, test.needCap, got, test.want)
}
}
}
func TestRenameVersion(t *testing.T) {
tests := []struct {
version, want string
}{
{
version: "directory_v1",
want: "directory/v1",
},
{
version: "email_migration_v1",
want: "email_migration/v1",
},
{
version: "my_api_v1.2",
want: "my_api/v1.2",
},
}
for _, test := range tests {
if got := renameVersion(test.version); got != test.want {
t.Errorf("renameVersion(%q) = %q; want %q", test.version, got, test.want)
}
}
}
func TestSupportsPaging(t *testing.T) {
api, err := apiFromFile(filepath.Join("testdata", "paging.json"))
if err != nil {
t.Fatalf("Error loading API testdata/paging.json: %v", err)
}
api.PopulateSchemas()
res := api.doc.Resources[0]
for _, meth := range api.resourceMethods(res) {
_, _, got := meth.supportsPaging()
want := strings.HasPrefix(meth.m.Name, "yes")
if got != want {
t.Errorf("method %s supports paging: got %t, want %t", meth.m.Name, got, want)
}
}
}
func TestIsNewerRevision(t *testing.T) {
olderBytesPath, newerBytesPath := filepath.Join("testdata", "rev20200415.json"), filepath.Join("testdata", "rev20200416.json")
olderBytes, err := ioutil.ReadFile(olderBytesPath)
if err != nil {
t.Fatalf("ioutil.ReadFile(%q) = %v; want nil", olderBytesPath, err)
}
newerBytes, err := ioutil.ReadFile(newerBytesPath)
if err != nil {
t.Fatalf("ioutil.ReadFile(%q) = %v; want nil", newerBytesPath, err)
}
// newBytes > oldBytes
if err := isNewerRevision(olderBytes, newerBytes); err != nil {
t.Fatalf("isNewerRevision(%q, %q) = %v; want nil", string(olderBytes), string(newerBytes), err)
}
// newBytes == newBytes
if err := isNewerRevision(newerBytes, newerBytes); err != nil {
t.Fatalf("isNewerRevision(%q, %q) = %v; want nil", string(newerBytes), string(newerBytes), err)
}
// newBytes < newBytes
err = isNewerRevision(newerBytes, olderBytes)
if err == nil {
t.Fatalf("isNewerRevision(%q, %q) = nil; want %v", string(newerBytes), string(olderBytes), errOldRevision)
}
if err != errOldRevision {
t.Fatalf("got %v, want %v", err, errOldRevision)
}
}
func TestRemoveMarkdownLinks(t *testing.T) {
tests := []struct {
name string
input string
want string
}{
{name: "basic", input: "[name](link)", want: "name (link)"},
{name: "no link", input: "name", want: "name"},
{name: "empty string", input: "", want: ""},
{name: "sentence", input: "This [is](link) a test.", want: "This is (link) a test."},
{name: "two links", input: "This [is](link) a [test](link).", want: "This is (link) a test (link)."},
{name: "first incomplete link", input: "This [is] a [test](link).", want: "This [is] a test (link)."},
{name: "second incomplete link", input: "This [is](link) a (test).", want: "This is (link) a (test)."},
{name: "seperated", input: "This [is] (a) test.", want: "This [is] (a) test."},
{name: "don't process code blocks", input: "This is `[a](link)` test.", want: "This is `[a](link)` test."},
{name: "At start", input: "[This](link) is a test.", want: "This (link) is a test."},
{name: "At end ", input: "This is a [test.](link)", want: "This is a test. (link)"},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
if got := removeMarkdownLinks(tc.input); got != tc.want {
t.Errorf("removeMarkdownLinks(%q) = %q, want %q", tc.input, got, tc.want)
}
})
}
}
func TestAsComment_LongLink(t *testing.T) {
//input := "The specification of cohorts for a cohort report. Cohort reports create a time series of user retention for the cohort. For example, you could select the cohort of users that were acquired in the first week of September and follow that cohort for the next six weeks. Selecting the users acquired in the first week of September cohort is specified in the `cohort` object. Following that cohort for the next six weeks is specified in the `cohortsRange` object. For examples, see [Cohort Report Examples](https://developers.google.com/analytics/devguides/reporting/data/v1/advanced#cohort_report_examples). The report response could show a weekly time series where say your app has retained 60% of this cohort after three weeks and 25% of this cohort after six weeks. These two percentages can be calculated by the metric `cohortActiveUsers/cohortTotalUsers` and will be separate rows in the report."
input := "This make sure we don't split long links (http://example.com/really/really/really/really/really/really/really/really/really/really/really/long). We want them to show up well in godoc."
want := `// This make sure we don't split long links
// (http://example.com/really/really/really/really/really/really/really/really/really/really/really/long).
// We want them to show up well in godoc.
`
got := asComment("", input)
if got != want {
t.Errorf("got %q, want %q", got, want)
}
}
|