-
Notifications
You must be signed in to change notification settings - Fork 169
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move the logic for selecting a license template based on user input into a standalone func (fetchTemplate), and add test cases for all code paths. Delay parsing predefined license templates. This allows the new fetchTemplate method to modify these templates before returning in the future (to add SPDX license information). Add tests to ensure that these templates must always parse properly. Rename copyrightData type to licenseData, since we will soon begin to add more than just copyright data here (SPDX ID). Rename prefix func to executeTemplate, since this better describes what the function is doing. These are all refactoring and cleanup changes; no behavioral changes.
- Loading branch information
1 parent
6d92264
commit c2fdf83
Showing
4 changed files
with
167 additions
and
47 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| Copyright {{.Year}} {{.Holder}} | ||
|
|
||
| Custom License Template |
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,102 @@ | ||
| // Copyright 2018 Google LLC | ||
| // | ||
| // 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 main | ||
|
|
||
| import ( | ||
| "errors" | ||
| "html/template" | ||
| "os" | ||
| "testing" | ||
| ) | ||
|
|
||
| func init() { | ||
| // ensure that pre-defined templates must parse | ||
| template.Must(template.New("").Parse(tmplApache)) | ||
| template.Must(template.New("").Parse(tmplMIT)) | ||
| template.Must(template.New("").Parse(tmplBSD)) | ||
| template.Must(template.New("").Parse(tmplMPL)) | ||
| } | ||
|
|
||
| func TestFetchTemplate(t *testing.T) { | ||
| tests := []struct { | ||
| description string // test case description | ||
| license string // license passed to fetchTemplate | ||
| templateFile string // templatefile passed to fetchTemplate | ||
| wantTemplate string // expected returned template | ||
| wantErr error // expected returned error | ||
| }{ | ||
| { | ||
| "non-existant template file", | ||
| "", | ||
| "/does/not/exist", | ||
| "", | ||
| os.ErrNotExist, | ||
| }, | ||
| { | ||
| "custom template file", | ||
| "", | ||
| "testdata/custom.tpl", | ||
| "Copyright {{.Year}} {{.Holder}}\n\nCustom License Template\n", | ||
| nil, | ||
| }, | ||
| { | ||
| "unknown license", | ||
| "unknown", | ||
| "", | ||
| "", | ||
| errors.New(`unknown license: "unknown"`), | ||
| }, | ||
| { | ||
| "apache license template", | ||
| "apache", | ||
| "", | ||
| tmplApache, | ||
| nil, | ||
| }, | ||
| { | ||
| "mit license template", | ||
| "mit", | ||
| "", | ||
| tmplMIT, | ||
| nil, | ||
| }, | ||
| { | ||
| "bsd license template", | ||
| "bsd", | ||
| "", | ||
| tmplBSD, | ||
| nil, | ||
| }, | ||
| { | ||
| "mpl license template", | ||
| "mpl", | ||
| "", | ||
| tmplMPL, | ||
| nil, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.description, func(t *testing.T) { | ||
| tpl, err := fetchTemplate(tt.license, tt.templateFile) | ||
| if tt.wantErr != nil && (err == nil || (!errors.Is(err, tt.wantErr) && err.Error() != tt.wantErr.Error())) { | ||
| t.Fatalf("fetchTemplate(%q, %q) returned error: %#v, want %#v", tt.license, tt.templateFile, err, tt.wantErr) | ||
| } | ||
| if tpl != tt.wantTemplate { | ||
| t.Errorf("fetchTemplate(%q, %q) returned template: %q, want %q", tt.license, tt.templateFile, tpl, tt.wantTemplate) | ||
| } | ||
| }) | ||
| } | ||
| } |