feat: add support for .snyk in for OSS, Container and IaC products (#…

…562)
snyk · Jul 10, 2024 · 4adb2b3 · 4adb2b3
1 parent 3a2cfaa
commit 4adb2b3
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Snyk Security Changelog
 
+## [2.8.9]
+### Added
+- Updated Open Source, Containers and IaC products to include `.snyk` in the list of supported build files.
+- When a `.snyk` file changes, the OSS cache will be dropped triggering a scan.
+
+Related PRs:
+- [Language Server PR #563](https://github.com/snyk/snyk-ls/pull/563)
+
 ## [2.8.8]
 ### Added
 - renders code actions and code lenses for OpenSource scans via the LS

diff --git a/src/main/kotlin/snyk/container/ContainerBulkFileListener.kt b/src/main/kotlin/snyk/container/ContainerBulkFileListener.kt
@@ -42,7 +42,7 @@ class ContainerBulkFileListener : SnykBulkFileListener() {
                     .flatMap { it.workloadImages }
                     .map { it.virtualFile }
                 // if file was cached before - we should update cache even if it's none k8s file anymore
-                if (containerFilesCached.contains(virtualFile)) return@filter true
+                if (containerFilesCached.contains(virtualFile) || isDotSnykFile(virtualFile)) return@filter true
 
                 val psiFile = findPsiFileIgnoringExceptions(virtualFile, project) ?: return@filter false
                 YAMLImageExtractor.isKubernetes(psiFile)
@@ -51,22 +51,29 @@ class ContainerBulkFileListener : SnykBulkFileListener() {
         }
     }
 
+    private fun isDotSnykFile(virtualFile: VirtualFile) = virtualFile.name.endsWith(".snyk")
+
     private fun updateContainerCache(
         containerRelatedVirtualFilesAffected: List<VirtualFile>,
         project: Project
     ) {
         if (containerRelatedVirtualFilesAffected.isEmpty()) return
         log.debug("update Container cache for $containerRelatedVirtualFilesAffected")
+
+        val isDotSnyk = containerRelatedVirtualFilesAffected.any(::isDotSnykFile)
+
         val snykCachedResults = getSnykCachedResults(project)
         val currentContainerResult = snykCachedResults?.currentContainerResult ?: return
         val containerIssuesForImages = currentContainerResult.allCliIssues ?: return
 
         val newContainerIssuesForImagesList = containerIssuesForImages.map { issuesForImage ->
-            if (issuesForImage.workloadImages.any { containerRelatedVirtualFilesAffected.contains(it.virtualFile) }) {
+            if (issuesForImage.workloadImages.any { containerRelatedVirtualFilesAffected.contains(it.virtualFile) } || isDotSnyk) {
                 makeObsolete(issuesForImage)
             } else {
                 issuesForImage
             }
+
+
         }
 
         val newContainerCache = ContainerResult(newContainerIssuesForImagesList, currentContainerResult.errors)

diff --git a/src/main/kotlin/snyk/iac/IacBulkFileListener.kt b/src/main/kotlin/snyk/iac/IacBulkFileListener.kt
@@ -38,7 +38,7 @@ class IacBulkFileListener : SnykBulkFileListener() {
         val allIacIssuesForFiles = currentIacResult.allCliIssues ?: return
 
         val iacRelatedVFsAffected = virtualFilesAffected
-            .filter { iacFileExtensions.contains(it.extension) }
+            .filter { scanInvalidatingFiles.contains(it.extension) }
             .filter { ProjectRootManager.getInstance(project).fileIndex.isInContent(it) }
 
         allIacIssuesForFiles
@@ -66,11 +66,12 @@ class IacBulkFileListener : SnykBulkFileListener() {
 
     companion object {
         // see https://github.com/snyk/snyk/blob/master/src/lib/iac/constants.ts#L7
-        private val iacFileExtensions = listOf(
+        private val scanInvalidatingFiles = listOf(
             "yaml",
             "yml",
             "json",
-            "tf"
+            "tf",
+            ".snyk"
         )
     }
 }
diff --git a/src/main/kotlin/snyk/oss/OssBulkFileListener.kt b/src/main/kotlin/snyk/oss/OssBulkFileListener.kt
@@ -68,7 +68,7 @@ class OssBulkFileListener : SnykBulkFileListener() {
         val snykCachedResults = getSnykCachedResults(project)
         if (snykCachedResults?.currentOssResults != null) {
             val buildFileChanged = virtualFilesAffected
-                .filter { supportedBuildFiles.contains(it.name) }
+                .filter { scanInvalidatingFiles.contains(it.name) }
                 .find { ProjectRootManager.getInstance(project).fileIndex.isInContent(it) }
             if (buildFileChanged != null) {
                 snykCachedResults.currentOssResults = null
@@ -88,7 +88,7 @@ class OssBulkFileListener : SnykBulkFileListener() {
 
     companion object {
         // see https://github.com/snyk/snyk/blob/master/src/lib/detect.ts#L10
-        private val supportedBuildFiles = listOf(
+        private val scanInvalidatingFiles = listOf(
             "yarn.lock",
             "package-lock.json",
             "package.json",
@@ -111,7 +111,8 @@ class OssBulkFileListener : SnykBulkFileListener() {
             "Podfile",
             "Podfile.lock",
             "pyproject.toml",
-            "poetry.lock"
+            "poetry.lock",
+            ".snyk"
         )
     }
 }