Merge pull request #36 from CYS4srl/testing

Unit testing

.github/workflows/maven-tests.yml

@@ -0,0 +1,30 @@
+name: Maven Tests
+
+on:
+  push:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up JDK 17
+      uses: actions/setup-java@v3
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+        cache: maven
+
+    - name: Test with Maven
+      run: mvn -B -Dmaven.test.failure.ignore=true test
+
+    - name: Surefire Report
+      uses: dorny/test-reporter@v1
+      if: always()
+      with:
+        name: Maven Tests
+        path: target/surefire-reports/*.xml
+        reporter: java-junit
+        fail-on-error: true

.gitignore

@@ -41,6 +41,7 @@ buildNumber.properties
 .classpath
 
 # manually added
+.attach_pid*
 out/
 *.iml
 src/build/

pom.xml

@@ -37,6 +37,24 @@
             <artifactId>maven-resources-plugin</artifactId>
             <version>3.3.1</version>
         </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <version>5.10.1</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <version>3.24.2</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.awaitility</groupId>
+            <artifactId>awaitility</artifactId>
+            <version>4.2.0</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>
@@ -98,6 +116,10 @@
                     </archive>
                 </configuration>
             </plugin>
+            <plugin>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>3.2.3</version>
+            </plugin>
         </plugins>
     </build>
 </project>

src/main/java/burp/BurpExtender.java

@@ -13,7 +13,7 @@ public class BurpExtender implements IBurpExtender {
     public void registerExtenderCallbacks(final IBurpExtenderCallbacks callbacks) {
         try {
             MainUI mainUI = new MainUI(callbacks);
-            mainUI.initialize();
+            mainUI.initializeUI();
 
             callbacks.setExtensionName(mainUI.getNameExtension());
 

src/main/java/com/cys4/sensitivediscoverer/MainUI.java

@@ -29,8 +29,10 @@ public class MainUI implements ITab {
     private final Properties configProperties;
     private final ScannerOptions scannerOptions;
     private JTabbedPane mainPanel;
+    private boolean interfaceInitialized;
 
     public MainUI(IBurpExtenderCallbacks callbacks) throws Exception {
+        this.interfaceInitialized = false;
         this.callbacks = callbacks;
 
         // setup stdout/stderr
@@ -50,18 +52,22 @@ public MainUI(IBurpExtenderCallbacks callbacks) throws Exception {
         this.extensionsRegexList = RegexSeeder.getExtensionRegexes();
     }
 
+    public boolean isInterfaceInitialized() {
+        return interfaceInitialized;
+    }
+
     public ScannerOptions getScannerOptions() {
         return scannerOptions;
     }
 
     /**
      * Main function that initializes the extension and creates the UI, asynchronously
      */
-    public void initialize() {
-        SwingUtilities.invokeLater(this::_initialize);
+    public void initializeUI() {
+        SwingUtilities.invokeLater(this::_initializeUI);
     }
 
-    private void _initialize() {
+    private void _initializeUI() {
         mainPanel = new JTabbedPane();
         LoggerTab loggerTab = new LoggerTab(this);
         mainPanel.addTab(loggerTab.getTabName(), loggerTab.getPanel());
@@ -72,6 +78,8 @@ private void _initialize() {
 
         callbacks.customizeUiComponent(mainPanel);
         callbacks.addSuiteTab(MainUI.this);
+
+        this.interfaceInitialized = true;
     }
 
     /**

src/main/java/com/cys4/sensitivediscoverer/RegexSeeder.java

@@ -34,7 +34,8 @@ private static List<RegexEntity> fill(String[] regexFiles) {
                         element.getDescription(),
                         element.getRegex(),
                         element.isActive(),
-                        ProxyItemSection.deserializeSections(element.getSections())))
+                        ProxyItemSection.deserializeSections(element.getSections()),
+                        element.getTests()))
                 .collect(Collectors.toList());
     }
 

src/main/java/com/cys4/sensitivediscoverer/model/JsonRegexEntity.java

@@ -14,6 +14,7 @@ public class JsonRegexEntity {
     private String regex;
     private String description;
     private List<String> sections;
+    private List<String> tests;
 
     public JsonRegexEntity() {
     }
@@ -33,4 +34,8 @@ public String getDescription() {
     public List<String> getSections() {
         return sections;
     }
+
+    public List<String> getTests() {
+        return tests;
+    }
 }

src/main/java/com/cys4/sensitivediscoverer/model/RegexEntity.java

@@ -5,6 +5,7 @@
 package com.cys4.sensitivediscoverer.model;
 
 import java.util.EnumSet;
+import java.util.List;
 import java.util.Objects;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -20,27 +21,34 @@ public class RegexEntity {
     private final transient Pattern regexCompiled;
     private final String description;
     private final EnumSet<ProxyItemSection> sections;
+    private final List<String> tests;
     private boolean active;
-
     public RegexEntity(String description, String regex) throws IllegalArgumentException {
-        this(description, regex, true, ProxyItemSection.getDefault());
+        this(description, regex, true, ProxyItemSection.getDefault(), null);
     }
 
     public RegexEntity(String description, String regex, boolean active) throws IllegalArgumentException {
-        this(description, regex, active, ProxyItemSection.getDefault());
+        this(description, regex, active, ProxyItemSection.getDefault(), null);
     }
 
     public RegexEntity(String description, String regex, boolean active, EnumSet<ProxyItemSection> sections) {
-        if (regex == null || regex.isBlank())
+        this(description, regex, active, sections, null);
+    }
+
+    public RegexEntity(String description, String regex, boolean active, EnumSet<ProxyItemSection> sections, List<String> tests) {
+        if (regex == null || regex.isBlank()) {
             throw new IllegalArgumentException(getLocaleString("exception-invalidRegex"));
-        if (sections == null)
+        }
+        if (sections == null) {
             throw new IllegalArgumentException(getLocaleString("exception-invalidSections"));
+        }
 
         this.active = active;
         this.description = description;
         this.regex = regex;
         this.regexCompiled = Pattern.compile(regex);
         this.sections = sections;
+        this.tests = tests;
     }
 
     public RegexEntity(RegexEntity entity) throws IllegalArgumentException {
@@ -59,6 +67,10 @@ public static Matcher checkRegexEntityFromCSV(String input) {
                 .matcher(input);
     }
 
+    public List<String> getTests() {
+        return tests;
+    }
+
     public boolean isActive() {
         return this.active;
     }