-
Notifications
You must be signed in to change notification settings - Fork 113
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
4 changed files
with
195 additions
and
2 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| // Copyright 2018-2020 CERN | ||
| // | ||
| // 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. | ||
| // | ||
| // In applying this license, CERN does not waive the privileges and immunities | ||
| // granted to it by virtue of its status as an Intergovernmental Organization | ||
| // or submit itself to any jurisdiction. | ||
|
|
||
| /* | ||
| Package templates contains data-driven templates for path layouts. | ||
| Templates can use functions from the gitbub.com/Masterminds/sprig library. | ||
| All templates are cleaned with path.Clean(). | ||
| */ | ||
| package templates | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "path" | ||
| "text/template" | ||
|
|
||
| "github.com/Masterminds/sprig" | ||
| userpb "github.com/cs3org/go-cs3apis/cs3/identity/user/v1beta1" | ||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| // UserData contains the template placeholders for a user. | ||
| // For example {{.Username}} or {{.Id.Idp}} | ||
| type UserData struct { | ||
| *userpb.User | ||
| } | ||
|
|
||
| func WithUser(u *userpb.User, tpl string) string { | ||
| tpl = clean(tpl) | ||
| ut := newUserData(u) | ||
| // compile given template tpl | ||
| t, err := template.New("tpl").Funcs(sprig.TxtFuncMap()).Parse(tpl) | ||
| if err != nil { | ||
| err := errors.Wrap(err, fmt.Sprintf("error parsing template: user_template:%+v tpl:%s", ut, tpl)) | ||
| panic(err) | ||
| } | ||
| b := bytes.Buffer{} | ||
| if err := t.Execute(&b, u); err != nil { | ||
| err := errors.Wrap(err, fmt.Sprintf("error executing template: user_template:%+v tpl:%s", ut, tpl)) | ||
| panic(err) | ||
| } | ||
| return b.String() | ||
| } | ||
|
|
||
| func newUserData(u *userpb.User) *UserData { | ||
| ut := &UserData{User: u} | ||
| return ut | ||
| } | ||
|
|
||
| func clean(a string) string { | ||
| return path.Clean(a) | ||
| } |
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,105 @@ | ||
| // Copyright 2018-2020 CERN | ||
| // | ||
| // 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. | ||
| // | ||
| // In applying this license, CERN does not waive the privileges and immunities | ||
| // granted to it by virtue of its status as an Intergovernmental Organization | ||
| // or submit itself to any jurisdiction. | ||
|
|
||
| package templates | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| userpb "github.com/cs3org/go-cs3apis/cs3/identity/user/v1beta1" | ||
| ) | ||
|
|
||
| type testUnit struct { | ||
| expected string | ||
| template string | ||
| user *userpb.User | ||
| } | ||
|
|
||
| var tests = []*testUnit{ | ||
| &testUnit{ | ||
| expected: "alabasta", | ||
| user: &userpb.User{ | ||
| Username: "alabasta", | ||
| }, | ||
| template: "{{.Username}}", | ||
| }, | ||
| &testUnit{ | ||
| expected: "a/alabasta", | ||
| user: &userpb.User{ | ||
| Username: "alabasta", | ||
| }, | ||
| template: "{{substr 0 1 .Username}}/{{.Username}}", | ||
| }, | ||
| &testUnit{ | ||
| expected: "idp@opaque", | ||
| user: &userpb.User{ | ||
| Id: &userpb.UserId{ | ||
| Idp: "idp", | ||
| OpaqueId: "opaque", | ||
| }, | ||
| }, | ||
| template: "{{.Id.Idp}}@{{.Id.OpaqueId}}", | ||
| }, | ||
| &testUnit{ // test path clean | ||
| expected: "/alabasta", | ||
| user: &userpb.User{ | ||
| Username: "alabasta", | ||
| }, | ||
| template: "///{{.Username}}", | ||
| }, | ||
| } | ||
|
|
||
| func TestLayout(t *testing.T) { | ||
| for _, u := range tests { | ||
| got := WithUser(u.user, u.template) | ||
| if u.expected != got { | ||
| t.Fatal("expected: " + u.expected + " got: " + got) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func TestLayoutPanic(t *testing.T) { | ||
| assertPanic(t, testBadLayout) | ||
| } | ||
|
|
||
| func TestUserPanic(t *testing.T) { | ||
| assertPanic(t, testBadUser) | ||
| } | ||
|
|
||
| // should panic | ||
| func testBadLayout() { | ||
| layout := "{{ bad layout sintax" | ||
| user := &userpb.User{} | ||
| WithUser(user, layout) | ||
| } | ||
|
|
||
| //should panic | ||
| func testBadUser() { | ||
| layout := "{{ .DoesNotExist }}" | ||
| user := &userpb.User{} | ||
| WithUser(user, layout) | ||
| } | ||
|
|
||
| func assertPanic(t *testing.T, f func()) { | ||
| defer func() { | ||
| if r := recover(); r == nil { | ||
| t.Errorf("the code did not panic") | ||
| } | ||
| }() | ||
| f() | ||
| } |