-
-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
268 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| // Copyright 2019 The Hugo Authors. All rights reserved. | ||
| // | ||
| // 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 hugolib | ||
|
|
||
| import ( | ||
| "strings" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestOpenAPI3(t *testing.T) { | ||
| const openapi3Yaml = `openapi: 3.0.0 | ||
| info: | ||
| title: Sample API | ||
| description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML. | ||
| version: 0.1.9 | ||
| servers: | ||
| - url: http://api.example.com/v1 | ||
| description: Optional server description, e.g. Main (production) server | ||
| - url: http://staging-api.example.com | ||
| description: Optional server description, e.g. Internal staging server for testing | ||
| paths: | ||
| /users: | ||
| get: | ||
| summary: Returns a list of users. | ||
| description: Optional extended description in CommonMark or HTML. | ||
| responses: | ||
| '200': # status code | ||
| description: A JSON array of user names | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: array | ||
| items: | ||
| type: string | ||
| ` | ||
|
|
||
| b := newTestSitesBuilder(t).Running() | ||
| b.WithSourceFile("assets/api/myapi.yaml", openapi3Yaml) | ||
|
|
||
| b.WithTemplatesAdded("index.html", ` | ||
| {{ $api := resources.Get "api/myapi.yaml" | openapi3.Unmarshal }} | ||
| API: {{ $api.Info.Title | safeHTML }} | ||
| `) | ||
|
|
||
| b.Build(BuildCfg{}) | ||
|
|
||
| b.AssertFileContent("public/index.html", `API: Sample API`) | ||
|
|
||
| b.EditFiles("assets/api/myapi.yaml", strings.Replace(openapi3Yaml, "Sample API", "Hugo API", -1)) | ||
|
|
||
| b.Build(BuildCfg{}) | ||
|
|
||
| b.AssertFileContent("public/index.html", `API: Hugo API`) | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| // Copyright 2020 The Hugo Authors. All rights reserved. | ||
| // | ||
| // 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 openapi3 | ||
|
|
||
| import ( | ||
| "github.com/gohugoio/hugo/deps" | ||
| "github.com/gohugoio/hugo/tpl/internal" | ||
| ) | ||
|
|
||
| const name = "openapi3" | ||
|
|
||
| func init() { | ||
| f := func(d *deps.Deps) *internal.TemplateFuncsNamespace { | ||
| ctx := New(d) | ||
|
|
||
| ns := &internal.TemplateFuncsNamespace{ | ||
| Name: name, | ||
| Context: func(args ...interface{}) interface{} { return ctx }, | ||
| } | ||
|
|
||
| ns.AddMethodMapping(ctx.Unmarshal, | ||
| nil, | ||
| [][2]string{}, | ||
| ) | ||
|
|
||
| return ns | ||
|
|
||
| } | ||
|
|
||
| internal.AddTemplateFuncsNamespace(f) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| // Copyright 2020 The Hugo Authors. All rights reserved. | ||
| // | ||
| // 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 openapi3 | ||
|
|
||
| import ( | ||
| "io/ioutil" | ||
|
|
||
| gyaml "github.com/ghodss/yaml" | ||
|
|
||
| "github.com/pkg/errors" | ||
|
|
||
| kopenapi3 "github.com/getkin/kin-openapi/openapi3" | ||
| "github.com/gohugoio/hugo/cache/namedmemcache" | ||
| "github.com/gohugoio/hugo/deps" | ||
| "github.com/gohugoio/hugo/parser/metadecoders" | ||
| "github.com/gohugoio/hugo/resources/resource" | ||
| ) | ||
|
|
||
| // New returns a new instance of the openapi3-namespaced template functions. | ||
| func New(deps *deps.Deps) *Namespace { | ||
| // TODO1 consolidate when merging that "other branch" -- but be aware of the keys. | ||
| cache := namedmemcache.New() | ||
| deps.BuildStartListeners.Add( | ||
| func() { | ||
| cache.Clear() | ||
| }) | ||
|
|
||
| return &Namespace{ | ||
| cache: cache, | ||
| deps: deps, | ||
| } | ||
| } | ||
|
|
||
| // Namespace provides template functions for the "openapi3". | ||
| type Namespace struct { | ||
| cache *namedmemcache.Cache | ||
| deps *deps.Deps | ||
| } | ||
|
|
||
| func (ns *Namespace) Unmarshal(r resource.UnmarshableResource) (*kopenapi3.Swagger, error) { | ||
|
|
||
| key := r.Key() | ||
| if key == "" { | ||
| return nil, errors.New("no Key set in Resource") | ||
| } | ||
|
|
||
| v, err := ns.cache.GetOrCreate(key, func() (interface{}, error) { | ||
| f := metadecoders.FormatFromMediaType(r.MediaType()) | ||
| if f == "" { | ||
| return nil, errors.Errorf("MIME %q not supported", r.MediaType()) | ||
| } | ||
|
|
||
| reader, err := r.ReadSeekCloser() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| defer reader.Close() | ||
|
|
||
| b, err := ioutil.ReadAll(reader) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| s := &kopenapi3.Swagger{} | ||
| switch f { | ||
| case metadecoders.YAML: | ||
| err = gyaml.Unmarshal(b, s) | ||
| default: | ||
| err = metadecoders.Default.UnmarshalTo(b, f, s) | ||
| } | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| err = kopenapi3.NewSwaggerLoader().ResolveRefsIn(s, nil) | ||
|
|
||
| return s, err | ||
| }) | ||
|
|
||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return v.(*kopenapi3.Swagger), nil | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.