kezhenxu94 commented on a change in pull request #50:
URL: https://github.com/apache/skywalking-eyes/pull/50#discussion_r681413428
##########
File path: pkg/license/identifier.go
##########
@@ -80,3 +80,10 @@ func Identify(pkgPath, content string) (string, error) {
return "", fmt.Errorf("cannot identify license content")
}
+
+var seemLicense = regexp.MustCompile(`(?i)licen[sc]e|copyright|copying`)
+
+// Seem determine whether the content of the file may be a license file
+func Seem(content string) bool {
+ return seemLicense.MatchString(content)
+}
Review comment:
Can you reuse `possibleLicenseFileName` in file `golang.go`? it may not
be a good idea to put `possibleLicenseFileName` in `identifier.go` but now
let's unify the 2 places, you can move `possibleLicenseFileName` into
`identifier.go` later.
##########
File path: pkg/deps/maven_test.go
##########
@@ -0,0 +1,139 @@
+//
+// Licensed to Apache Software Foundation (ASF) under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Apache Software Foundation (ASF) licenses this file to you 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 deps_test
+
+import (
+ "bufio"
+ "fmt"
+ "os"
+ "path/filepath"
+ "testing"
+
+ "github.com/apache/skywalking-eyes/license-eye/pkg/deps"
+)
+
+func TestCanResolve(t *testing.T) {
+ resolver := new(deps.MavenPomResolver)
+ for _, test := range []struct {
+ fileName string
+ exp bool
+ }{
+ {"pom.xml", true},
+ {"POM.XML", false},
+ {"log4j-1.2.12.pom", false},
+ {".pom", false},
+ } {
+ b := resolver.CanResolve(test.fileName)
+ if b != test.exp {
+ t.Errorf("MavenPomResolver.CanResolve(\"%v\") = %v,
want %v", test.fileName, b, test.exp)
+ }
+ }
+}
+
+func dump(fileName, content string) error {
+ file, err := os.OpenFile(fileName, os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
0666)
+ if err != nil {
+ return err
+ }
+ defer file.Close()
+
+ write := bufio.NewWriter(file)
+ _, err = write.WriteString(content)
+ if err != nil {
+ return err
+ }
+
+ write.Flush()
+ return nil
+}
+
+func TestResolve(t *testing.T) {
+ resolver := new(deps.MavenPomResolver)
+
+ tempDir := deps.NewTempDirGenerator()
+ path, err := tempDir.Create()
+ if err != nil {
+ t.Error(err)
+ return
+ }
+ defer tempDir.Destroy()
+
+ pomFile := filepath.Join(path, "pom.xml")
+
+ for _, test := range []struct {
+ pomContent string
+ cnt int
+ }{
+ {`<?xml version="1.0" encoding="UTF-8"?>
+ <project xmlns="http://maven.apache.org/POM/4.0.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd";>
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>apache</groupId>
+ <artifactId>skywalking-eyes</artifactId>
+ <version>1.0</version>
+
+ <dependencies>
+ <!-- https://mvnrepository.com/artifact/junit/junit -->
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <version>4.12</version>
+ </dependency>
+ <!--
https://mvnrepository.com/artifact/commons-logging/commons-logging -->
+ <dependency>
+ <groupId>commons-logging</groupId>
+ <artifactId>commons-logging</artifactId>
+ <version>1.2</version>
+ </dependency>
+ <!--
https://mvnrepository.com/artifact/org.apache.skywalking/skywalking-sharing-server-plugin
-->
+ <dependency>
+ <groupId>org.apache.skywalking</groupId>
+
<artifactId>skywalking-sharing-server-plugin</artifactId>
+ <version>8.6.0</version>
+ </dependency>
+ </dependencies>
+ </project>`, 107},
+ } {
+ dump(pomFile, test.pomContent)
+
+ if resolver.CanResolve(pomFile) {
+ report := deps.Report{}
+ if err := resolver.Resolve(pomFile, &report); err !=
nil {
+ t.Error(err)
+ return
+ }
+
+ if len(report.Resolved)+len(report.Skipped) != test.cnt
{
+ t.Errorf("the expected number of jar packages
is: %d, but actually: %d. result:\n%v", test.cnt,
len(report.Resolved)+len(report.Skipped), report.String())
+ }
+
+ if skipped := len(report.Skipped); skipped > 0 {
+ pkgs := make([]string, skipped)
+ for i, s := range report.Skipped {
+ pkgs[i] = s.Dependency
+ }
+
+ t.Errorf(
+ "there are %v dependencies in total,
failed to identify the licenses of following packages (%d):\n", test.cnt,
+ len(pkgs))
Review comment:
`t.Errorf` should ONLY be used when the error is unexpected.
In this test case, we expect that some of the dependencies are not
identified, right?
Anyway we should make the CI status passed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
