Skip to content
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

chore(v2): add precommit checks and snapshot go-licenses/v2 dependencies for development #97

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions v2/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Copyright 2021 Google Inc.
#
# 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
#
# https://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.

precommit: FORCE tidy lint csv

csv: FORCE
go run . csv github.com/google/go-licenses/v2 | tee third_party/licenses.csv

lint: FORCE
# There's no need to lint third_party packages, so we explicitly list other packages here.
golint --set_exit_status . gocli/... tests/... licenses/...

tidy: FORCE
go mod tidy

FORCE: ;
60 changes: 60 additions & 0 deletions v2/check.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
// Copyright 2019 Google Inc. 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 main

import (
"context"
"fmt"
"os"

"github.com/google/go-licenses/v2/licenses"
"github.com/spf13/cobra"
)

var (
checkCmd = &cobra.Command{
Use: "check <package>",
Short: "Checks whether licenses for a package are not Forbidden.",
Args: cobra.MinimumNArgs(1),
RunE: checkMain,
}
)

func init() {
rootCmd.AddCommand(checkCmd)
}

func checkMain(_ *cobra.Command, args []string) error {
classifier, err := licenses.NewClassifier(confidenceThreshold)
if err != nil {
return err
}

libs, err := licenses.Libraries(context.Background(), classifier, args...)
if err != nil {
return err
}
for _, lib := range libs {
licenseName, licenseType, err := classifier.Identify(lib.LicensePath)
if err != nil {
return err
}
if licenseType == licenses.Forbidden {
fmt.Fprintf(os.Stderr, "Forbidden license type %s for library %v\n", licenseName, lib)
os.Exit(1)
}
}
return nil
}
99 changes: 99 additions & 0 deletions v2/csv.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
// Copyright 2019 Google Inc. 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 main

import (
"context"
"encoding/csv"
"os"
"strings"

"github.com/golang/glog"
"github.com/google/go-licenses/v2/licenses"
"github.com/spf13/cobra"
)

var (
csvCmd = &cobra.Command{
Use: "csv <package>",
Short: "Prints all licenses that apply to a Go package and its dependencies",
Args: cobra.MinimumNArgs(1),
RunE: csvMain,
}

gitRemotes []string
)

func init() {
csvCmd.Flags().StringArrayVar(&gitRemotes, "git_remote", []string{"origin", "upstream"}, "Remote Git repositories to try")

rootCmd.AddCommand(csvCmd)
}

func csvMain(_ *cobra.Command, args []string) error {
writer := csv.NewWriter(os.Stdout)

classifier, err := licenses.NewClassifier(confidenceThreshold)
if err != nil {
return err
}

libs, err := licenses.Libraries(context.Background(), classifier, args...)
if err != nil {
return err
}
for _, lib := range libs {
licenseURL := "Unknown"
licenseName := "Unknown"
if lib.LicensePath != "" {
// Find a URL for the license file, based on the URL of a remote for the Git repository.
var errs []string
repo, err := licenses.FindGitRepo(lib.LicensePath)
if err != nil {
// Can't find Git repo (possibly a Go Module?) - derive URL from lib name instead.
lURL, err := lib.FileURL(lib.LicensePath)
if err != nil {
errs = append(errs, err.Error())
} else {
licenseURL = lURL.String()
}
} else {
for _, remote := range gitRemotes {
url, err := repo.FileURL(lib.LicensePath, remote)
if err != nil {
errs = append(errs, err.Error())
continue
}
licenseURL = url.String()
break
}
}
if licenseURL == "Unknown" {
glog.Errorf("Error discovering URL for %q:\n- %s", lib.LicensePath, strings.Join(errs, "\n- "))
}
licenseName, _, err = classifier.Identify(lib.LicensePath)
if err != nil {
glog.Errorf("Error identifying license in %q: %v", lib.LicensePath, err)
licenseName = "Unknown"
}
}
// Remove the "*/vendor/" prefix from the library name for conciseness.
if err := writer.Write([]string{unvendor(lib.Name()), licenseURL, licenseName}); err != nil {
return err
}
}
writer.Flush()
return writer.Error()
}
13 changes: 7 additions & 6 deletions v2/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ module github.com/google/go-licenses/v2
go 1.15

require (
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/hashicorp/go-multierror v1.1.1
github.com/kr/pretty v0.1.0 // indirect
github.com/stretchr/testify v1.4.0
github.com/golang/glog v1.0.0
github.com/google/go-cmp v0.5.6
github.com/google/licenseclassifier v0.0.0-20210722185704-3043a050f148
github.com/otiai10/copy v1.7.0
github.com/spf13/cobra v1.3.0
github.com/stretchr/testify v1.7.0
golang.org/x/tools v0.1.5
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
gopkg.in/src-d/go-git.v4 v4.13.1
)
Loading