feat: Update go-licenses, add CI (#2)

Author: erezrokah

.github/workflows/build.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v5
         with:
-          go-version: 1.23
+          go-version-file: go.mod
         id: go
 
       - name: Run GoReleaser

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: Test
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+
+      - name: Run Test
+        run: go install github.com/google/go-licenses/v2 && go test ./...

README.md

@@ -1,8 +1,10 @@
-This script scans the licenses of all the dependencies of modules in a given directory, and reports if any of them forbidden, notice, reciprocal or restricted types. 
+# License Scanner
+
+This script scans the licenses of all the dependencies of modules in a given directory, and reports if any of them forbidden, notice, reciprocal or restricted types.
 
 From this directory, can be run with:
 
+```bash
+go run . check .
+go run . report .
 ```
-go run main.go check .
-go run main.go report .
-```

__snapshots__/main_test.snap

@@ -0,0 +1,14 @@
+
+[TestReport - 1]
+/-/-/-/
+hub-title: Licenses
+/-/-/-/
+
+The following tools / packages are used in this plugin:
+
+| Name | License |
+|------|---------|
+| github.com/spf13/cobra | Apache-2.0 |
+| github.com/spf13/pflag | BSD-3-Clause |
+| golang.org/x/sync/errgroup | BSD-3-Clause |
+---

go.mod

@@ -3,34 +3,39 @@ module github.com/cloudquery/licenser
 go 1.23.0
 
 require (
-	github.com/google/go-licenses v1.6.0
-	github.com/spf13/cobra v1.6.0
+	github.com/gkampitakis/go-snaps v0.5.7
+	github.com/google/go-licenses/v2 v2.0.0-alpha.1
+	github.com/spf13/cobra v1.7.0
+	github.com/stretchr/testify v1.8.1
 	golang.org/x/sync v0.10.0
 )
 
 require (
-	github.com/emirpasic/gods v1.12.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/gkampitakis/ciinfo v0.3.0 // indirect
+	github.com/gkampitakis/go-diff v1.3.2 // indirect
 	github.com/go-logr/logr v1.2.0 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
-	github.com/google/licenseclassifier v0.0.0-20210722185704-3043a050f148 // indirect
-	github.com/inconshreveable/mousetrap v1.0.1 // indirect
-	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
-	github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd // indirect
-	github.com/mitchellh/go-homedir v1.1.0 // indirect
-	github.com/otiai10/copy v1.6.0 // indirect
+	github.com/google/licenseclassifier/v2 v2.0.0 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/kr/pretty v0.3.1 // indirect
+	github.com/kr/text v0.2.0 // indirect
+	github.com/maruel/natural v1.1.1 // indirect
+	github.com/otiai10/copy v1.10.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/rogpeppe/go-internal v1.12.0 // indirect
 	github.com/sergi/go-diff v1.2.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/src-d/gcfg v1.4.0 // indirect
-	github.com/xanzy/ssh-agent v0.2.1 // indirect
-	go.opencensus.io v0.23.0 // indirect
-	golang.org/x/crypto v0.30.0 // indirect
+	github.com/tidwall/gjson v1.17.0 // indirect
+	github.com/tidwall/match v1.1.1 // indirect
+	github.com/tidwall/pretty v1.2.1 // indirect
+	github.com/tidwall/sjson v1.2.5 // indirect
+	go.opencensus.io v0.24.0 // indirect
 	golang.org/x/mod v0.17.0 // indirect
 	golang.org/x/net v0.25.0 // indirect
 	golang.org/x/sys v0.28.0 // indirect
 	golang.org/x/text v0.21.0 // indirect
 	golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d // indirect
-	gopkg.in/src-d/go-billy.v4 v4.3.2 // indirect
-	gopkg.in/src-d/go-git.v4 v4.13.1 // indirect
-	gopkg.in/warnings.v0 v0.1.2 // indirect
-	k8s.io/klog/v2 v2.80.1 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	k8s.io/klog/v2 v2.90.1 // indirect
 )

go.sum

@@ -67,6 +67,9 @@ func generateLicensesReport(dir string) error {
 		return err
 	}
 
+	if err := os.MkdirAll("docs", 0755); err != nil {
+		return err
+	}
 	file, err := os.Create("docs/_licenses.md")
 	if err != nil {
 		return err
@@ -95,7 +98,7 @@ func findGoModDirs(rootDir string) ([]string, error) {
 	return dirs, nil
 }
 
-func main() {
+func rootCmd() *cobra.Command {
 	g := new(errgroup.Group)
 	g.SetLimit(10)
 
@@ -171,5 +174,12 @@ func main() {
 	cmd.AddCommand(checkCmd)
 	cmd.AddCommand(reportCmd)
 
-	cmd.Execute()
+	return &cmd
+}
+
+func main() {
+	cmd := rootCmd()
+	if err := cmd.Execute(); err != nil {
+		log.Fatalf("Error executing command: %v\n", err)
+	}
 }

main.go

@@ -0,0 +1,27 @@
+package main
+
+import (
+	"os"
+	"testing"
+
+	"github.com/gkampitakis/go-snaps/snaps"
+	"github.com/stretchr/testify/require"
+)
+
+func TestCheck(t *testing.T) {
+	cmd := rootCmd()
+	cmd.SetArgs([]string{"check", "."})
+	err := cmd.Execute()
+	require.NoError(t, err)
+}
+
+func TestReport(t *testing.T) {
+	cmd := rootCmd()
+	cmd.SetArgs([]string{"report", "."})
+	err := cmd.Execute()
+	require.NoError(t, err)
+	content, err := os.ReadFile("docs/_licenses.md")
+	require.NoError(t, err)
+	snaps.MatchSnapshot(t, string(content))
+	defer os.Remove("docs/_licenses.md")
+}

main_test.go

@@ -4,5 +4,5 @@
 package tools
 
 import (
-	_ "github.com/google/go-licenses"
+	_ "github.com/google/go-licenses/v2"
 )