Skip to content

Changed the documents link from Synopsys to Blackduck #5384

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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 cmd/detectExecuteScan.go
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ func detectExecuteScan(config detectExecuteScanOptions, _ *telemetry.CustomData,
}

func runDetect(ctx context.Context, config detectExecuteScanOptions, utils detectUtils, influx *detectExecuteScanInflux) error {
// detect execution details, see https://synopsys.atlassian.net/wiki/spaces/INTDOCS/pages/88440888/Sample+Synopsys+Detect+Scan+Configuration+Scenarios+for+Black+Duck
// detect execution details, see https://documentation.blackduck.com/bundle/detect/page/runningdetect/basics/runningwithblackduck.html
err := getDetectScript(config, utils)
if err != nil {
return fmt.Errorf("failed to download 'detect.sh' script: %w", err)
Expand Down Expand Up @@ -633,7 +633,7 @@ func addDetectArgsImages(args []string, config detectExecuteScanOptions, utils d

args = append(args, fmt.Sprintf("--detect.docker.tar=./%s", imageTar))
args = append(args, "--detect.target.type=IMAGE")
// https://community.synopsys.com/s/article/Docker-image-scanning-CLI-examples-and-some-Q-As
// https://community.blackduck.com/s/article/Docker-image-scanning-CLI-examples-and-some-Q-As
args = append(args, "--detect.tools.excluded=DETECTOR")
args = append(args, "--detect.docker.passthrough.shared.dir.path.local=/opt/blackduck/blackduck-imageinspector/shared/")
args = append(args, "--detect.docker.passthrough.shared.dir.path.imageinspector=/opt/blackduck/blackduck-imageinspector/shared")
Expand Down
32 changes: 16 additions & 16 deletions cmd/detectExecuteScan_generated.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion documentation/docs/stages/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ You find details about this stage on the page [**Acceptance**](acceptance.md).

### Security

This stage can run security checks using Checkmarx, Synopsys Detect, Fortify and WhiteSource.
This stage can run security checks using Checkmarx, Black Duck Detect, Fortify and WhiteSource.

You find details about this stage on the page [**Security**](security.md).

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/steps/detectExecuteScan.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You need to store the API token for the Detect service as _'Secret text'_ creden

## Rapid scan

In addition to the full scan, Black Duck also offers a faster and easier scan option, called <a href="https://community.synopsys.com/s/document-item?bundleId=integrations-detect&topicId=downloadingandrunning%2Frapidscan.html&_LANG=enus" target="_blank">Rapid Scan</a>.
In addition to the full scan, Black Duck also offers a faster and easier scan option, called <a href="https://documentation.blackduck.com/bundle/detect/page/runningdetect/rapidscan.html" target="_blank">Rapid Scan</a>.
Its main advantage is speed. In most cases, the scan is completed in less than 30 seconds. It doesn't save any information on the Black Duck side.
The result can be found in the pipeline console.

Expand Down
4 changes: 2 additions & 2 deletions pkg/blackduck/blackduck.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import (
"github.com/pkg/errors"
)

// ReportsDirectory defines the subfolder for the Blackduck reports which are generated
// ReportsDirectory defines the subfolder for the BlackDuck reports which are generated
const ReportsDirectory = "blackduck"
const maxLimit = 50

Expand Down Expand Up @@ -330,7 +330,7 @@ func (b *Client) GetProjectVersion(projectName, projectVersion string) (*Project
}

//While sending a request to 'versions', get all 100 versions from that project by setting limit=100
//More than 100 project versions is currently not supported/recommended by Blackduck
//More than 100 project versions is currently not supported/recommended by BlackDuck
respBody, err := b.sendRequest("GET", versionPath, map[string]string{"offset": "0", "limit": "100"}, nil, headers)
if err != nil {
return nil, errors.Wrapf(err, "failed to get project version '%v:%v'", projectName, projectVersion)
Expand Down
4 changes: 2 additions & 2 deletions pkg/blackduck/reporting.go
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ func CreateSarifResultFile(vulns *Vulnerabilities, projectName, projectVersion,
Driver: format.Driver{
Name: "Black Duck",
Version: "unknown",
InformationUri: "https://community.synopsys.com/s/document-item?bundleId=integrations-detect&topicId=introduction.html&_LANG=enus",
InformationUri: "https://documentation.blackduck.com/bundle/detect/page/introduction.html",
Rules: rules,
},
}
Expand Down Expand Up @@ -250,7 +250,7 @@ func WriteSarifFile(sarif *format.SARIF, utils piperutils.FileUtils) ([]piperuti
log.SetErrorCategory(log.ErrorConfiguration)
return reportPaths, errors.Wrapf(err, "failed to write SARIF file")
}
reportPaths = append(reportPaths, piperutils.Path{Name: "Blackduck Detect Vulnerability SARIF file", Target: sarifReportPath})
reportPaths = append(reportPaths, piperutils.Path{Name: "BlackDuck Detect Vulnerability SARIF file", Target: sarifReportPath})

return reportPaths, nil
}
2 changes: 1 addition & 1 deletion pkg/reporting/pullRequestReport.go
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ type OtherViolation struct {
const rapidReportMdTemplate = `
{{if .Success}}:heavy_check_mark: **OSS related checks passed successfully**
:clipboard: OSS related checks executed by Black Duck - rapid scan passed successfully.
<h4><a href="https://sig-product-docs.synopsys.com/bundle/integrations-detect/page/runningdetect/rapidscan.html">RAPID SCAN</a></h4>
<h4><a href="https://documentation.blackduck.com/bundle/detect/page/runningdetect/rapidscan.html">RAPID SCAN</a></h4>

{{else}} :x: **OSS related checks failed**
:clipboard: Policies violated by added OSS components
Expand Down
2 changes: 1 addition & 1 deletion pkg/reporting/pullRequestReport_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ func TestCreateMarkdownReport(t *testing.T) {
components: &Components{},
expectedReport: "\n :heavy_check_mark: **OSS related checks passed successfully**\n :clipboard: OSS related checks executed by Black Duck " +
"- rapid scan passed successfully.\n" +
" <h4><a href=\"https://sig-product-docs.synopsys.com/bundle/integrations-detect/page/runningdetect/rapidscan.html\">" +
" <h4><a href=\"https://documentation.blackduck.com/bundle/detect/page/runningdetect/rapidscan.html\">" +
"RAPID SCAN</a></h4>\n\n\n",
},
}
Expand Down
Loading
Loading