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

Add golang purl service #316

Merged
merged 15 commits into from
Mar 14, 2024
Merged

Add golang purl service #316

merged 15 commits into from
Mar 14, 2024

Conversation

TG1999
Copy link
Contributor

@TG1999 TG1999 commented Mar 1, 2024

Fixes: #259

Added a /api/to_purl/go endpoint to get a golang purl from a go import string or a package string in go.mod file

Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Copy link
Member

@keshav-space keshav-space left a comment

Choose a reason for hiding this comment

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

Thanks @TG1999, few nits for your consideration.

],
responses={200: GoLangPurlResponseSerializer()},
)
class GolangPurlViewSet(viewsets.ViewSet):
Copy link
Member

Choose a reason for hiding this comment

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

Need some docsting. Being more explicit about the fact that the endpoint accepts a standard Go import string and returns the corresponding PackageURL will be helpful.

class ToGolangPurlTestCase(TestCase):

def test_to_golang_purl(self):
response = self.client.get("/api/to_purl/go", data={"go_package": "github.com/gorilla/mux@v1.7.3"}, follow=True)
Copy link
Member

Choose a reason for hiding this comment

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

AFAIK, github.com/gorilla/mux@v1.7.3 is not a valid import statement.
Does Go allow specifying a particular package version using an @ symbol in an import statement?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch, not a go import https://github.com/moby/moby/blob/6c10086976d07d4746e03dcfd188972a2f07e1c9/vendor.mod#L51 but *.mod files does have version representation like this? should I change the code in packageurl-python to accept this kind of inputs as well ?

Copy link
Member

Choose a reason for hiding this comment

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

should I change the code in packageurl-python to accept this kind of inputs as well ?

Update the code to also accept this would make sense. With proper documentation.

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

Good catch, not a go import https://github.com/moby/moby/blob/6c10086976d07d4746e03dcfd188972a2f07e1c9/vendor.mod#L51 but *.mod files does have version representation like this? should I change the code in packageurl-python to accept this kind of inputs as well ?

IMO it makes sense to support getting PURLs from both Go import and Go Manifest.
However, I'm not sure if we want to support obtaining PURLs from Go dependency management commands like...

go get github.com/gorilla/mux@v1.7.3

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@keshav-space so should we throw an error when we encounter any package like this ? when there is "@" in package, we should error out ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

@keshav-space so should we throw an error when we encounter any package like this ? when there is "@" in package, we should error out ?

If we don't support them in packageurl-python, then we should raise an error here.

Copy link
Member

@pombredanne pombredanne Mar 12, 2024

Choose a reason for hiding this comment

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

I think this is all OK and handled in the packageurl library. And we do not support the @ notation from a "go get"

Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Copy link
Member

@pombredanne pombredanne left a comment

Choose a reason for hiding this comment

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

We just need a bit of documentation and changelog and how to test this to complete the thing.

packagedb/to_purl.py Outdated Show resolved Hide resolved
packagedb/to_purl.py Outdated Show resolved Hide resolved
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Copy link
Member

@keshav-space keshav-space left a comment

Choose a reason for hiding this comment

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

@TG1999 LGTM, few nits for your consideration.

packagedb/to_purl.py Outdated Show resolved Hide resolved
packagedb/to_purl.py Outdated Show resolved Hide resolved
TG1999 and others added 2 commits March 14, 2024 18:58
Co-authored-by: Keshav Priyadarshi <git@keshav.space>
Co-authored-by: Keshav Priyadarshi <git@keshav.space>
@TG1999 TG1999 merged commit 0a5d5a1 into main Mar 14, 2024
3 of 7 checks passed
@TG1999 TG1999 deleted the add_golang_purl_service branch March 15, 2024 11:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

go2purl: Go package to Go PURL
3 participants