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.

Sign up for GitHub

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

🐛 Must compile for dependency:sources to work properly #368

Merged
merged 6 commits into from
Oct 11, 2023
Merged

🐛 Must compile for dependency:sources to work properly #368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f737724
Must compile for dependency:sources to work properly
jmle Oct 9, 2023
b62ee1f
Compile only if the project has submodules
jmle Oct 10, 2023
c0affda
Handle errors
jmle Oct 10, 2023
277d4d9
Refactor dependency fallback function
jmle Oct 11, 2023
430f489
DependencyManagement filed can have no children
jmle Oct 11, 2023
4d149f9
Use absolute path
jmle Oct 11, 2023
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
1 change: 1 addition & 0 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ require (
github.com/phayes/freeport v0.0.0-20220201140144-74d24b5ae9f5
github.com/sirupsen/logrus v1.9.0
github.com/spf13/cobra v1.7.0
github.com/vifraa/gopom v1.0.0
go.lsp.dev/uri v0.3.0
go.opentelemetry.io/otel/trace v1.11.2
google.golang.org/grpc v1.54.0
Expand Down
3 changes: 3 additions & 0 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,14 @@ github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSS
github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c=
github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
github.com/vifraa/gopom v1.0.0 h1:L9XlKbyvid8PAIK8nr0lihMApJQg/12OBvMA28BcWh0=
github.com/vifraa/gopom v1.0.0/go.mod h1:oPa1dcrGrtlO37WPDBm5SqHAT+wTgF8An1Q71Z6Vv4o=
go.lsp.dev/uri v0.3.0 h1:KcZJmh6nFIBeJzTugn5JTU6OOyG0lDOo3R9KwTxTYbo=
go.lsp.dev/uri v0.3.0/go.mod h1:P5sbO1IQR+qySTWOCnhnK7phBx+W3zbLqSMDJNTw88I=
go.opentelemetry.io/otel v1.11.2 h1:YBZcQlsVekzFsFbjygXMOXSs6pialIZxcjfO/mBDmR0=
Expand Down
102 changes: 65 additions & 37 deletions provider/internal/java/dependency.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,13 @@ import (
"os"
"os/exec"
"path/filepath"
"reflect"
"regexp"
"strings"

"github.com/antchfx/xmlquery"
"github.com/konveyor/analyzer-lsp/engine/labels"
"github.com/konveyor/analyzer-lsp/output/v1/konveyor"
"github.com/konveyor/analyzer-lsp/provider"
"github.com/vifraa/gopom"
"go.lsp.dev/uri"
)

Expand Down Expand Up @@ -57,12 +56,12 @@ func (p *javaServiceClient) GetDependencies(ctx context.Context) (map[uri.URI][]
} else {
ll, err = p.GetDependenciesDAG(ctx)
if err != nil {
p.log.Info("unable to get dependencies using fallback", "error", err)
return p.GetDependencyFallback(ctx)
p.log.Info("unable to get dependencies, using fallback", "error", err)
return p.GetDependenciesFallback(ctx, "")
}
if len(ll) == 0 {
p.log.Info("unable to get dependencies non found using fallback")
return p.GetDependencyFallback(ctx)
p.log.Info("unable to get dependencies (none found), using fallback")
return p.GetDependenciesFallback(ctx, "")
}
}
for f, ds := range ll {
Expand Down Expand Up @@ -97,52 +96,71 @@ func getMavenLocalRepoPath(mvnSettingsFile string) string {
return string(outb.String())
}

func (p *javaServiceClient) GetDependencyFallback(ctx context.Context) (map[uri.URI][]*provider.Dep, error) {
pomDependencyQuery := "//dependencies/dependency/*"
path := p.findPom()
file := uri.File(path)
func (p *javaServiceClient) GetDependenciesFallback(ctx context.Context, location string) (map[uri.URI][]*provider.Dep, error) {
deps := []*provider.Dep{}

absPath, err := filepath.Abs(path)
path, err := filepath.Abs(p.findPom())
if err != nil {
return nil, err
}

f, err := os.Open(absPath)
if err != nil {
return nil, err
if location != "" {
jmle marked this conversation as resolved.
Show resolved Hide resolved
path = location
}
doc, err := xmlquery.Parse(f)
pom, err := gopom.Parse(path)
if err != nil {
return nil, err
}
list, err := xmlquery.QueryAll(doc, pomDependencyQuery)
if err != nil {
return nil, err

// have to get both <dependencies> and <dependencyManagement> dependencies (if present)
var pomDeps []gopom.Dependency
if pom.Dependencies != nil {
pomDeps = append(pomDeps, *pom.Dependencies...)
}
deps := []*provider.Dep{}
dep := &provider.Dep{}
// TODO this is comedically janky
for _, node := range list {
if node.Data == "groupId" {
if dep.Name != "" {
deps = append(deps, dep)
dep = &provider.Dep{}
}
dep.Name = node.InnerText()
} else if node.Data == "artifactId" {
dep.Name += "." + node.InnerText()
jmle marked this conversation as resolved.
Show resolved Hide resolved
} else if node.Data == "version" {
dep.Version = node.InnerText()
if pom.DependencyManagement != nil {
if pom.DependencyManagement.Dependencies != nil {
pomDeps = append(pomDeps, *pom.DependencyManagement.Dependencies...)
}
// Ignore the others
}
if !reflect.DeepEqual(dep, provider.Dep{}) {
jmle marked this conversation as resolved.
Show resolved Hide resolved
dep.Labels = []string{fmt.Sprintf("%v=%v", provider.DepSourceLabel, javaDepSourceInternal)}
deps = append(deps, dep)

// add each dependency found
for _, d := range pomDeps {
dep := provider.Dep{}
dep.Name = fmt.Sprintf("%s.%s", *d.GroupID, *d.ArtifactID)
jmle marked this conversation as resolved.
Show resolved Hide resolved
if *d.Version != "" {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fabianvf wonder if this will make the version parser better?

if strings.Contains(*d.Version, "$") {
version := strings.TrimSuffix(strings.TrimPrefix(*d.Version, "${"), "}")
version = pom.Properties.Entries[version]
if version != "" {
dep.Version = version
}
} else {
dep.Version = *d.Version
}
}
deps = append(deps, &dep)
}

m := map[uri.URI][]*provider.Dep{}
m[file] = deps
m[uri.File(path)] = deps
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am a little worried about this change having side effects. is there a reason to move to a URI instead of the file path that is passed in?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the same, I just removed file := uri.File(path) above.

p.depsCache = m

// recursively find deps in submodules
if pom.Modules != nil {
for _, mod := range *pom.Modules {
mPath := fmt.Sprintf("%s/%s/pom.xml", filepath.Dir(path), mod)
moreDeps, err := p.GetDependenciesFallback(ctx, mPath)
if err != nil {
return nil, err
}

// add found dependencies to map
for depPath := range moreDeps {
m[depPath] = moreDeps[depPath]
}
}
}

return m, nil
}

Expand All @@ -160,11 +178,21 @@ func (p *javaServiceClient) GetDependenciesDAG(ctx context.Context) (map[uri.URI
defer os.Remove(f.Name())

moddir := filepath.Dir(path)

pom, err := gopom.Parse(path)
if err != nil {
return nil, err
}

args := []string{
"dependency:tree",
"-Djava.net.useSystemProxies=true",
fmt.Sprintf("-DoutputFile=%s", f.Name()),
}
if pom.Modules != nil {
args = append([]string{"compile"}, args...)
}

if p.mvnSettingsFile != "" {
args = append(args, "-s", p.mvnSettingsFile)
}
Expand Down
12 changes: 12 additions & 0 deletions provider/internal/java/provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import (
"github.com/konveyor/analyzer-lsp/jsonrpc2"
"github.com/konveyor/analyzer-lsp/lsp/protocol"
"github.com/konveyor/analyzer-lsp/provider"
"github.com/vifraa/gopom"
"go.lsp.dev/uri"
)

Expand Down Expand Up @@ -324,11 +325,22 @@ func resolveSourcesJars(ctx context.Context, log logr.Logger, location, mavenSet
return err
}
defer mvnOutput.Close()

pomPath := fmt.Sprintf("%s/pom.xml", location)
pom, err := gopom.Parse(pomPath)
if err != nil {
return err
}

args := []string{
"dependency:sources",
"-Djava.net.useSystemProxies=true",
fmt.Sprintf("-DoutputFile=%s", mvnOutput.Name()),
}
if pom.Modules != nil {
args = append([]string{"compile"}, args...)
}

if mavenSettings != "" {
args = append(args, "-s", mavenSettings)
}
Expand Down
Loading