Merge pull request #26 from scanoss/v0.10.1

V0.10.1

CHANGELOG.md

@@ -11,6 +11,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Upcoming changes...
 
+## [0.10.1] - 2025-02-20
+### Added
+- Add support to custom filtering rules
+- Change logic on remove rule. Mark file as non match instead of deleting the key.
+
 ## [0.10.0] - 2025-02-17
 ### Added
 - Add support to skip rule
@@ -109,4 +114,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [0.8.0]: https://github.com/scanoss/scanoss.java/compare/v0.7.1...v0.8.0
 [0.8.1]: https://github.com/scanoss/scanoss.java/compare/v0.8.0...v0.8.1
 [0.9.0]: https://github.com/scanoss/scanoss.java/compare/v0.8.1...v0.9.0
-[0.10.0]: https://github.com/scanoss/scanoss.java/compare/v0.9.0...v0.10.0
+[0.10.0]: https://github.com/scanoss/scanoss.java/compare/v0.9.0...v0.10.0
+[0.10.1]: https://github.com/scanoss/scanoss.java/compare/v0.10.0...v0.10.1

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.scanoss</groupId>
     <artifactId>scanoss</artifactId>
-    <version>0.10.0</version>
+    <version>0.10.1</version>
     <packaging>jar</packaging>
     <name>scanoss.java</name>
     <url>https://github.com/scanoss/scanoss.java</url>

src/main/java/com/scanoss/Scanner.java

@@ -107,17 +107,6 @@ public class Scanner {
     private Predicate<Path> fileFilter;
     private Predicate<Path> folderFilter;
 
-    //TODO: Once this Lombok PR is merged  https://github.com/projectlombok/lombok/pull/3723#pullrequestreview-2617412643
-    // Update Lombok dependency
-    public static class ScannerBuilder {
-        private ScannerBuilder folderFilter(Predicate<Path> folderFilter) {
-            return this;
-        }
-        private ScannerBuilder fileFilter(Predicate<Path> fileFilter) {
-            return this;
-        }
-    }
-
     @SuppressWarnings("unused")
     private Scanner(Boolean skipSnippets, Boolean allExtensions, Boolean obfuscate, Boolean hpsm,
                     Boolean hiddenFilesFolders, Boolean allFolders, Integer numThreads, Duration timeout,

src/main/java/com/scanoss/ScannerPostProcessor.java

@@ -266,6 +266,22 @@ private ScanFileDetails createUpdatedResultDetails(ScanFileDetails existingCompo
                 .build();
     }
 
+    /**
+     * Marks all components in the list as non-matching by replacing each component
+     * with a new instance that has MatchType.NONE while preserving the serverDetails
+     * Modifies the input list in place using List.replaceAll().
+     *
+     * @param components List of scan file details to be marked as non-matching
+     */
+    private void markComponentsAsNonMatch(List<ScanFileDetails> components) {
+        components.replaceAll(component ->
+                ScanFileDetails.builder()
+                        .matchType(MatchType.none)
+                        .serverDetails(component.getServerDetails())
+                        .build()
+        );
+    }
+
     /**
      * Applies remove rules to scan results, filtering out matches based on certain criteria.
      * <p>
@@ -281,7 +297,9 @@ private ScanFileDetails createUpdatedResultDetails(ScanFileDetails existingCompo
      */
     public void applyRemoveRules(@NonNull List<ScanFileResult> results, @NonNull List<RemoveRule> rules) {
         log.debug("Starting remove rules application to {} results", results.size());
-        results.removeIf(result -> matchesRemovalCriteria(result, rules));
+        results.stream()
+                .filter(result -> matchesRemovalCriteria(result, rules))
+                .forEach(result -> markComponentsAsNonMatch(result.getFileDetails()));
         log.debug("Remove rules application completed. Results remaining: {}", results.size());
     }
 

src/main/java/com/scanoss/filters/BaseFilter.java

@@ -48,6 +48,6 @@ protected BaseFilter(FilterConfig config) {
         this.config = config;
         this.gitIgnoreFilter = GitIgnoreFilter.builder().patterns(config.getGitIgnorePatterns()).build();
         this.antFilter = AntFilter.builder().patterns(config.getAntPatterns()).build();
-        this.baseSkipFilter = this.antFilter.get().or(this.gitIgnoreFilter.get());
+        this.baseSkipFilter = this.antFilter.get().or(this.gitIgnoreFilter.get()).or(this.config.getCustomFilter());
     }
 }

src/main/java/com/scanoss/filters/FilterConfig.java

@@ -24,8 +24,11 @@
 
 import lombok.Builder;
 import lombok.Getter;
+
+import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.function.Predicate;
 
 /**
  * Configuration class for the SCANOSS filtering system that defines various filtering rules and patterns.
@@ -51,4 +54,7 @@ public class FilterConfig {
 
     @Builder.Default
     private final Boolean allExtensions = false;
+
+    @Builder.Default
+    private final Predicate<Path> customFilter = path -> false;
 }

src/test/java/com/scanoss/TestScanner.java

@@ -358,4 +358,27 @@ public void TestScannerSkipAntPattern() {
 
         log.info("Finished {} -->", methodName);
     }
+
+    @Test
+    public void TestScannerCustomFilterConfig() {
+        String methodName = new Object() {
+        }.getClass().getEnclosingMethod().getName();
+        log.info("<-- Starting {}", methodName);
+
+        String f;
+        List<String> wfps;
+
+        log.info("Testing GitIgnore Pattern:  ");
+        f = "testing/data/folder-ends-with-nbproject";
+
+        FilterConfig filterConfig = FilterConfig.builder()
+                .customFilter(p -> true)
+                .build();
+
+        Scanner scanner = Scanner.builder().filterConfig(filterConfig).build();
+        wfps = scanner.wfpFolder(f);
+        assertTrue("There is no fingerprint since custom filter it's always true", wfps.isEmpty());
+
+        log.info("Finished {} -->", methodName);
+    }
 }

src/test/java/com/scanoss/TestScannerPostProcessor.java

@@ -24,6 +24,7 @@
 
 import com.google.gson.JsonObject;
 import com.scanoss.dto.ScanFileResult;
+import com.scanoss.dto.enums.MatchType;
 import com.scanoss.settings.Bom;
 import com.scanoss.settings.RemoveRule;
 import com.scanoss.settings.ReplaceRule;
@@ -73,6 +74,16 @@ public void Setup() throws URISyntaxException, IOException {
 
     }
 
+    private Boolean hasOnlyNonMatchingDetailsForPath(List<ScanFileResult> results, String path) {
+        Optional<ScanFileResult> r = results.stream().filter(result -> result.getFilePath().matches(path)).findFirst();
+
+        if (r.isEmpty()) {
+            fail(String.format("Should have found file %s", path));
+        }
+
+        return r.get().getFileDetails().stream().noneMatch(c -> c.getMatchType() != MatchType.none);
+
+    }
 
     /**
      * TESTING REMOVE RULES
@@ -94,7 +105,7 @@ public void TestRemoveRuleWithPathAndPurl() {
         List<ScanFileResult> results = scannerPostProcessor.process(sampleScanResults, bom);
 
         // Verify
-        assertEquals("Should have one result less after removal", sampleScanResults.size() - 1, results.size());
+        assertTrue(hasOnlyNonMatchingDetailsForPath(results, "CMSsite/admin/js/npm.js"));
         log.info("Finished {} -->", methodName);
     }
 
@@ -116,13 +127,7 @@ public void TestRemoveRuleWithPurlOnly() {
         // Process results
         List<ScanFileResult> results = scannerPostProcessor.process(sampleScanResults, bom);
 
-        // Verify
-        assertEquals("Size should decrease by 1 after removal",
-                sampleScanResults.size() - 1,
-                results.size());
-
-        assertFalse("Should remove file CMSsite/admin/js/npm.js",
-                results.stream().anyMatch(r -> r.getFilePath().matches("CMSsite/admin/js/npm.js")));
+        assertTrue(hasOnlyNonMatchingDetailsForPath(results, "CMSsite/admin/js/npm.js"));
 
         log.info("Finished {} -->", methodName);
     }
@@ -258,7 +263,7 @@ public void testRemoveRuleWithOverlappingLineRanges() {
         List<ScanFileResult> results = scannerPostProcessor.process(sampleScanResults, bom);
 
         // Verify - should remove because lines overlap
-        assertEquals("Should have one result less after removal", sampleScanResults.size() - 1, results.size());
+        assertTrue(hasOnlyNonMatchingDetailsForPath(results, "src/spdx.c"));
 
         log.info("Finished {} -->", methodName);
     }
@@ -289,7 +294,7 @@ public void testMultipleRemoveRulesWithMixedLineRanges() {
         // Process results
         List<ScanFileResult> results = scannerPostProcessor.process(sampleScanResults, bom);
 
-        assertEquals("Should have one result less after removal", sampleScanResults.size() - 1, results.size());
+        assertTrue(hasOnlyNonMatchingDetailsForPath(results, "src/spdx.c"));
 
         log.info("Finished {} -->", methodName);
     }