Add Option for Pre-Scan command [IDE-908] #764

bastiandoetsch · 2025-01-30T08:35:52Z

Description

add command that is called before a scan
refactor: move dependency-less test helpers to package testsupport

Checklist

Tests added and all succeed
Linted
README.md updated, if user-facing
License file updated, if new 3rd-party dependency is introduced

ShawkyZ · 2025-01-30T12:00:47Z

domain/snyk/scanner/scanner.go

+					err := sc.executePreScanCommand(ctx, sc.c, s.Product(), folderPath, notReferenceScan)
+					if err != nil {
+						logger.Err(err).Str("path", folderPath).Send()
+					}


I would trigger it only in case of fullscan.

I noticed a problem here while reviewing this. The reference scan is waiting on wd scan to succeed before triggering the go routine.

I created this PR
#766

ShawkyZ · 2025-01-30T12:01:33Z

domain/snyk/scanner/scanner.go

+						logger.Err(err).Str("path", folderPath).Send()
+					}
+
+					if notReferenceScan {


why? It's a reference scan.
reason for this condition is to make sure we are running in a full scan and not a partial one. So only in this case a reference scan would be needed

ShawkyZ · 2025-01-30T12:02:20Z

domain/snyk/scanner/scanner.go

+	folderConfig := c.FolderConfig(workDir)
+	commandConfig := folderConfig.ScanCommandConfig
+
+	if commandConfig == nil || commandConfig[p].PreScanCommand == "" || commandConfig[p].PreScanOnlyReferenceFolder && notReferenceScan {


can we abstract this with a func that returns a prescan command and takes the product as an input?

ShawkyZ · 2025-01-30T12:03:07Z

domain/snyk/scanner/scanner_test.go

@@ -124,3 +128,28 @@ func TestScan_whenProductScannerEnabled_SendsInProgress(t *testing.T) {

 	assert.NotEmpty(t, mockScanNotifier.InProgressCalls())
 }
+
+func TestDelegatingConcurrentScanner_executePreScanCommand(t *testing.T) {
+	c := testutil.UnitTest(t)


ShawkyZ · 2025-01-30T12:03:52Z

infrastructure/oss/cli_scanner.go


 	if len(additionalParameters) > 0 {
 		for _, parameter := range additionalParameters {
 			// if the sdk needs additional parameters, add them (Python plugin, I look at you. Yes, you)
 			// the given parameters take precedence, meaning, a given python configuration will overrule
 			// the automatically determined config
-			isDuplicateParam := storedConfig.SliceContainsParam(commandLineArgs, parameter) || storedConfig.SliceContainsParam(folderConfigArgs, parameter)
+			isDuplicateParam := storedConfig.SliceContainsParam(commandLineArgs, parameter)


yup that's cleaner

ShawkyZ · 2025-01-30T12:05:44Z

internal/testsupport/environment.go

@@ -1,5 +1,5 @@
 /*
- * © 2022 Snyk Limited All rights reserved.
+ * © 2022-2025 Snyk Limited


fix copyright date

ShawkyZ · 2025-01-30T12:05:49Z

internal/testsupport/files.go

@@ -1,5 +1,5 @@
 /*
- * © 2022 Snyk Limited All rights reserved.
+ * © 2022-2025 Snyk Limited


ShawkyZ · 2025-01-30T12:06:09Z

internal/testsupport/json_rpc_recorder.go

@@ -1,5 +1,5 @@
 /*
- * © 2022 Snyk Limited All rights reserved.
+ * © 2022-2025 Snyk Limited


ShawkyZ · 2025-01-30T12:06:57Z

internal/types/lsp.go

+// parameter PreScanOnlyReferenceFolder / PostScanOnlyReferenceFolder is set.
+// Else it will run for all scans.
+type ScanCommandConfig struct {
+	PreScanCommand              string `json:"command,omitempty"`


curious if we will ever have the case that the command should run in both cases.
I can't think of one though.

I also find this much more readable than the Pair type that we discussed earlier.

refactor: move dependency-less test helpers to package testsupport

43d58e1

bastiandoetsch requested a review from a team as a code owner January 30, 2025 08:35

bastiandoetsch had a problem deploying to Standard January 30, 2025 08:35 — with GitHub Actions Failure

bastiandoetsch had a problem deploying to MT1 January 30, 2025 08:35 — with GitHub Actions Failure

bastiandoetsch had a problem deploying to MT3 January 30, 2025 08:35 — with GitHub Actions Failure

bastiandoetsch marked this pull request as draft January 30, 2025 08:36

bastiandoetsch had a problem deploying to Standard January 30, 2025 08:56 — with GitHub Actions Failure

bastiandoetsch had a problem deploying to MT1 January 30, 2025 08:56 — with GitHub Actions Error

bastiandoetsch had a problem deploying to MT3 January 30, 2025 08:56 — with GitHub Actions Failure

chore: add lint-fix target to makefile

48d0dca

bastiandoetsch force-pushed the feat/IDE-908_add-option-for-pre-scan-command branch from c2a0c27 to 48d0dca Compare January 30, 2025 08:57

bastiandoetsch temporarily deployed to Standard January 30, 2025 08:57 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT1 January 30, 2025 08:57 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT3 January 30, 2025 08:57 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to Standard January 30, 2025 09:02 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT1 January 30, 2025 09:02 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT3 January 30, 2025 09:02 — with GitHub Actions Inactive

bastiandoetsch force-pushed the feat/IDE-908_add-option-for-pre-scan-command branch from 10a3980 to 67528a5 Compare January 30, 2025 09:02

bastiandoetsch temporarily deployed to Standard January 30, 2025 09:02 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT1 January 30, 2025 09:02 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT3 January 30, 2025 09:02 — with GitHub Actions Inactive

feat: add new folder config field to configure pre/post scan commands

21497fe

bastiandoetsch force-pushed the feat/IDE-908_add-option-for-pre-scan-command branch from 67528a5 to 21497fe Compare January 30, 2025 09:05

bastiandoetsch temporarily deployed to Standard January 30, 2025 09:05 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT1 January 30, 2025 09:05 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT3 January 30, 2025 09:05 — with GitHub Actions Inactive

chore: lint-fix

84fe169

bastiandoetsch temporarily deployed to Standard January 30, 2025 09:05 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT1 January 30, 2025 09:05 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT3 January 30, 2025 09:05 — with GitHub Actions Inactive

feat: add ExecutePreScanCommand impl

1c2d757

bastiandoetsch temporarily deployed to Standard January 30, 2025 09:06 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT1 January 30, 2025 09:06 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT3 January 30, 2025 09:06 — with GitHub Actions Inactive

refactor: integrate updateArgs into prepareScanCommand

2f7d39d

bastiandoetsch temporarily deployed to Standard January 30, 2025 09:18 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT1 January 30, 2025 09:18 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT3 January 30, 2025 09:18 — with GitHub Actions Inactive

feat: execute pre-scan command on scan according to config

22acfa7

bastiandoetsch temporarily deployed to Standard January 30, 2025 10:43 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT1 January 30, 2025 10:43 — with GitHub Actions Inactive

bastiandoetsch temporarily deployed to MT3 January 30, 2025 10:43 — with GitHub Actions Inactive

ShawkyZ reviewed Jan 30, 2025

View reviewed changes

internal/testsupport/files.go

@@ -1,5 +1,5 @@

/*

* © 2022 Snyk Limited All rights reserved.

* © 2022-2025 Snyk Limited

Copy link

Contributor

ShawkyZ Jan 30, 2025

Choose a reason for hiding this comment

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

same

ShawkyZ reviewed Jan 30, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Option for Pre-Scan command [IDE-908] #764

Add Option for Pre-Scan command [IDE-908] #764

bastiandoetsch commented Jan 30, 2025

ShawkyZ Jan 30, 2025 •

edited

Loading

ShawkyZ Jan 30, 2025

ShawkyZ Jan 30, 2025

ShawkyZ Jan 30, 2025 •

edited

Loading

ShawkyZ Jan 30, 2025

ShawkyZ Jan 30, 2025

ShawkyZ Jan 30, 2025

ShawkyZ Jan 30, 2025

ShawkyZ Jan 30, 2025

ShawkyZ Jan 30, 2025

ShawkyZ Jan 30, 2025

Add Option for Pre-Scan command [IDE-908] #764

Are you sure you want to change the base?

Add Option for Pre-Scan command [IDE-908] #764

Conversation

bastiandoetsch commented Jan 30, 2025

Description

Checklist

ShawkyZ Jan 30, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ShawkyZ Jan 30, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ShawkyZ Jan 30, 2025 •

edited

Loading

ShawkyZ Jan 30, 2025 •

edited

Loading