Skip to content

feat: extend PURL identifier support for query string parameters #180

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

Merged
merged 1 commit into from
Dec 30, 2024
Merged

feat: extend PURL identifier support for query string parameters #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions pkg/graph/parser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ type Query struct {

var (
simpleLexer = lexer.MustSimple([]lexer.SimpleRule{
{"Operator", `\b(?:and|or|xor)\b`}, // Prioritize operators
{"Ident", `[a-zA-Z][a-zA-Z0-9:/._@-]*`}, // Updated to handle colons, slashes, dots, underscores, hyphens, and @
{"Operator", `\b(?:and|or|xor)\b`}, // Prioritize operators
{"Ident", `[a-zA-Z][a-zA-Z0-9:/._@?=&+\-]*`}, // Updated to handle colons, slashes, dots, underscores, hyphens, and @
{"String", `"(?:\\.|[^"])*"`},
{"Whitespace", `[ \t\n\r]+`},
{"LBracket", `\[`},
Expand Down
50 changes: 45 additions & 5 deletions pkg/graph/parser_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@ import (
"github.com/RoaringBitmap/roaring"
)

// TestParseAndExecute tests basic queries on simple mock data.
// We extend these tests with queries that include qualifiers (e.g., ?type=jar).
func TestParseAndExecute(t *testing.T) {
storage := NewMockStorage()

// Create some mock nodes.
node1, err := AddNode(storage, "PACKAGE", nil, "pkg:generic/lib-A@1.0.0")
if err != nil {
t.Fatal(err)
Expand All @@ -26,6 +29,14 @@ func TestParseAndExecute(t *testing.T) {
t.Fatal(err)
}

// Create a node with a query-string in its purl.
nodeCamel, err := AddNode(storage, "PACKAGE", nil, "pkg:maven/org.apache.camel.quarkus/camel-quarkus-cassandraql-deployment@3.18.0-SNAPSHOT?type=jar")
if err != nil {
t.Fatal(err)
}

// Set up some dependencies.
// Node1 -> Node3 -> Node4
err = node1.SetDependency(storage, node3)
if err != nil {
t.Fatal(err)
Expand All @@ -39,6 +50,13 @@ func TestParseAndExecute(t *testing.T) {
t.Fatal(err)
}

// Make nodeCamel depend on node4 to verify a dependency query with a qualifier in the PURL.
err = nodeCamel.SetDependency(storage, node4)
if err != nil {
t.Fatal(err)
}

// Cache the results for quicker lookups.
if err := Cache(storage); err != nil {
t.Fatal(err)
}
Expand All @@ -53,13 +71,13 @@ func TestParseAndExecute(t *testing.T) {
{
name: "Simple dependents query",
script: "dependents PACKAGE pkg:generic/dep1@1.0.0",
want: roaring.BitmapOf(1, 2, 3),
want: roaring.BitmapOf(node1.ID, node2.ID, node3.ID),
defaultNodeName: "",
},
{
name: "Simple dependencies query",
script: "dependencies PACKAGE pkg:generic/lib-A@1.0.0",
want: roaring.BitmapOf(1, 3, 4),
want: roaring.BitmapOf(node1.ID, node3.ID, node4.ID),
defaultNodeName: "",
},
{
Expand All @@ -71,7 +89,7 @@ func TestParseAndExecute(t *testing.T) {
{
name: "Combine dependents and dependencies with OR",
script: "dependents PACKAGE pkg:generic/dep1@1.0.0 or dependencies PACKAGE pkg:generic/dep1@1.0.0",
want: roaring.BitmapOf(1, 2, 3, 4),
want: roaring.BitmapOf(node1.ID, node2.ID, node3.ID, node4.ID),
defaultNodeName: "",
},
{
Expand All @@ -81,11 +99,31 @@ func TestParseAndExecute(t *testing.T) {
defaultNodeName: "",
},
{
name: "Empty node name",
name: "Empty node name defaults to pkg:generic/lib-A@1.0.0",
script: "dependents PACKAGE or dependencies PACKAGE",
want: roaring.BitmapOf(1, 3, 4),
want: roaring.BitmapOf(node1.ID, node3.ID, node4.ID),
defaultNodeName: "pkg:generic/lib-A@1.0.0",
},

// New tests exercising qualifiers in the PURL.
{
name: "Dependencies query with ?type=jar qualifier",
script: "dependencies PACKAGE pkg:maven/org.apache.camel.quarkus/camel-quarkus-cassandraql-deployment@3.18.0-SNAPSHOT?type=jar",
want: roaring.BitmapOf(nodeCamel.ID, node4.ID),
defaultNodeName: "",
},
{
name: "Dependents query with ?type=jar qualifier",
script: "dependents PACKAGE pkg:maven/org.apache.camel.quarkus/camel-quarkus-cassandraql-deployment@3.18.0-SNAPSHOT?type=jar",
want: roaring.BitmapOf(nodeCamel.ID),
defaultNodeName: "",
},
{
name: "Invalid query with qualifier",
script: "invalid PACKAGE pkg:maven/org.apache.camel.quarkus/camel-quarkus-cassandraql@3.18.0-SNAPSHOT?type=jar",
wantErr: true,
defaultNodeName: "",
},
}

for _, tt := range tests {
Expand All @@ -102,11 +140,13 @@ func TestParseAndExecute(t *testing.T) {
if err != nil {
t.Fatal(err)
}

result, err := ParseAndExecute(tt.script, storage, tt.defaultNodeName, nodes, caches, true)
if (err != nil) != tt.wantErr {
t.Errorf("ParseAndExecute() error = %v, wantErr %v", err, tt.wantErr)
return
}

if !tt.wantErr && !result.Equals(tt.want) {
t.Errorf("ParseAndExecute() got = %v, want %v", result, tt.want)
}
Expand Down
Loading