Skip to content

fix: python exhortignore - when there is a version mismatch #73

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
Nov 1, 2023
Merged

fix: python exhortignore - when there is a version mismatch #73

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
16 changes: 13 additions & 3 deletions src/providers/python_pip.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,10 @@ function getIgnoredDependencies(requirementTxtContent) {
*
* @param {string} requirementTxtContent content of requirments.txt in string
* @param {Sbom} sbom object to filter out from it exhortignore dependencies.
* @param {{Object}} opts - various options and settings for the application
* @private
*/
function handleIgnoredDependencies(requirementTxtContent, sbom) {
function handleIgnoredDependencies(requirementTxtContent, sbom,opts ={}) {
let ignoredDeps = getIgnoredDependencies(requirementTxtContent)
let ignoredDepsVersion = ignoredDeps
.filter(dep => !dep.toString().includes(dummyVersionNotation) )
Expand All @@ -130,7 +131,16 @@ function handleIgnoredDependencies(requirementTxtContent, sbom) {
.filter(dep => dep.toString().includes(dummyVersionNotation))
.map(dep => dep.name)
sbom.filterIgnoredDeps(ignoredDepsNoVersions)
sbom.filterIgnoredDepsIncludingVersion(ignoredDepsVersion)
let matchManifestVersions = getCustom("MATCH_MANIFEST_VERSIONS","true",opts);
if(matchManifestVersions === "true") {
sbom.filterIgnoredDepsIncludingVersion(ignoredDepsVersion)
}
else
{
// in case of version mismatch, need to parse the name of package from the purl, and remove the package name from sbom according to name only
// without version
sbom.filterIgnoredDeps(ignoredDepsVersion.map((dep) => dep.split("@")[0].split("pkg:pypi/")[1]))
}
}

/** get python and pip binaries, python3/pip3 get precedence if exists on the system path
Expand Down Expand Up @@ -178,7 +188,7 @@ function createSbomStackAnalysis(manifest, opts = {}) {
addAllDependencies(sbom.getRoot(),dep,sbom)
})
let requirementTxtContent = fs.readFileSync(manifest).toString();
handleIgnoredDependencies(requirementTxtContent,sbom)
handleIgnoredDependencies(requirementTxtContent,sbom,opts)
// In python there is no root component, then we must remove the dummy root we added, so the sbom json will be accepted by exhort backend
sbom.removeRootComponent()
return sbom.getAsJsonString()
Expand Down