-
Notifications
You must be signed in to change notification settings - Fork 169
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for SPDX style headers #79
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,140 @@ | ||
| // 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 | ||
| spdx spdxFlag // spdx value passed to fetchTemplate | ||
| wantTemplate string // expected returned template | ||
| wantErr error // expected returned error | ||
| }{ | ||
| // custom template files | ||
| { | ||
| "non-existant template file", | ||
| "", | ||
| "/does/not/exist", | ||
| spdxOff, | ||
| "", | ||
| os.ErrNotExist, | ||
| }, | ||
| { | ||
| "custom template file", | ||
| "", | ||
| "testdata/custom.tpl", | ||
| spdxOff, | ||
| "Copyright {{.Year}} {{.Holder}}\n\nCustom License Template\n", | ||
| nil, | ||
| }, | ||
|
|
||
| { | ||
| "unknown license", | ||
| "unknown", | ||
| "", | ||
| spdxOff, | ||
| "", | ||
| errors.New(`unknown license: "unknown". Include the '-s' flag to request SPDX style headers using this license.`), | ||
| }, | ||
|
|
||
| // pre-defined license templates, no SPDX | ||
| { | ||
| "apache license template", | ||
| "Apache-2.0", | ||
| "", | ||
| spdxOff, | ||
| tmplApache, | ||
| nil, | ||
| }, | ||
| { | ||
| "mit license template", | ||
| "MIT", | ||
| "", | ||
| spdxOff, | ||
| tmplMIT, | ||
| nil, | ||
| }, | ||
| { | ||
| "bsd license template", | ||
| "bsd", | ||
| "", | ||
| spdxOff, | ||
| tmplBSD, | ||
| nil, | ||
| }, | ||
| { | ||
| "mpl license template", | ||
| "MPL-2.0", | ||
| "", | ||
| spdxOff, | ||
| tmplMPL, | ||
| nil, | ||
| }, | ||
|
|
||
| // SPDX variants | ||
| { | ||
| "apache license template with SPDX added", | ||
| "Apache-2.0", | ||
| "", | ||
| spdxOn, | ||
| tmplApache + spdxSuffix, | ||
| nil, | ||
| }, | ||
| { | ||
| "apache license template with SPDX only", | ||
| "Apache-2.0", | ||
| "", | ||
| spdxOnly, | ||
| tmplSPDX, | ||
| nil, | ||
| }, | ||
| { | ||
| "unknown license with SPDX only", | ||
| "unknown", | ||
| "", | ||
| spdxOnly, | ||
| tmplSPDX, | ||
| nil, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.description, func(t *testing.T) { | ||
| tpl, err := fetchTemplate(tt.license, tt.templateFile, tt.spdx) | ||
| 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) | ||
| } | ||
| }) | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should these two flag.Var lines go in the var block above where the other flags are defined?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no, custom flag parsing using
flag.Varcan't be done at initialization time in a var block. Same for the other *Var funcs,flag.StringVar,flag.IntVar, etc.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, makes sense