Merge pull request #5711 from thc202/spider/parsers-ctx

spider: expose the context to the parsers

addOns/spider/CHANGELOG.md

@@ -6,7 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 ### Added
-- Allow the parsers to obtain the user being used by/in the current spidering scan (Issue 7739).
+- Allow the parsers to obtain the context and user being used by/in the current spidering scan (Issue 8021 and 7739).
 
 ### Changed
 - Maintenance changes.

addOns/spider/src/main/java/org/zaproxy/addon/spider/Spider.java

@@ -650,6 +650,16 @@ public void resume() {
         }
     }
 
+    /**
+     * Gets the context that will be used in the scanning.
+     *
+     * @return the context
+     * @since 0.12.0
+     */
+    protected Context getScanContext() {
+        return scanContext;
+    }
+
     /**
      * Sets the spider so it will scan from the point of view of a user.
      *

addOns/spider/src/main/java/org/zaproxy/addon/spider/SpiderTask.java

@@ -379,6 +379,7 @@ static void processResource(Spider parent, int depth, HttpMessage message) {
                 new ParseContext(
                         parent.getSpiderParam(),
                         parent.getExtensionSpider().getValueGenerator(),
+                        parent.getScanContext(),
                         parent.getScanUser(),
                         message,
                         path,

addOns/spider/src/main/java/org/zaproxy/addon/spider/parser/ParseContext.java

@@ -23,6 +23,7 @@
 import net.htmlparser.jericho.Source;
 import org.parosproxy.paros.network.HttpMessage;
 import org.zaproxy.addon.spider.SpiderParam;
+import org.zaproxy.zap.model.Context;
 import org.zaproxy.zap.model.ValueGenerator;
 import org.zaproxy.zap.users.User;
 
@@ -37,6 +38,7 @@ public class ParseContext {
     private final ValueGenerator valueGenerator;
     private final HttpMessage httpMessage;
     private final String path;
+    private final Context context;
     private final User user;
     private final int depth;
     private String baseUrl;
@@ -59,14 +61,15 @@ public ParseContext(
             HttpMessage httpMessage,
             String path,
             int depth) {
-        this(spiderParam, valueGenerator, null, httpMessage, path, depth);
+        this(spiderParam, valueGenerator, null, null, httpMessage, path, depth);
     }
 
     /**
      * Constructs a {@code ParseContext} with the given values.
      *
      * @param spiderParam the spider options, must not be {@code null}.
      * @param valueGenerator the value generator, must not be {@code null}.
+     * @param context the context being used by/in the current spidering scan.
      * @param user the user being used by/in the current spidering scan.
      * @param httpMessage the message, must not be {@code null}.
      * @param path the path of the HTTP message.
@@ -78,12 +81,14 @@ public ParseContext(
     public ParseContext(
             SpiderParam spiderParam,
             ValueGenerator valueGenerator,
+            Context context,
             User user,
             HttpMessage httpMessage,
             String path,
             int depth) {
         this.spiderParam = Objects.requireNonNull(spiderParam);
         this.valueGenerator = Objects.requireNonNull(valueGenerator);
+        this.context = context;
         this.user = user;
         this.httpMessage = Objects.requireNonNull(httpMessage);
         this.path = path;
@@ -108,6 +113,16 @@ public ValueGenerator getValueGenerator() {
         return valueGenerator;
     }
 
+    /**
+     * Gets the context used by/in the spidering scan.
+     *
+     * @return the context, or {@code null}.
+     * @since 0.12.0
+     */
+    public Context getContext() {
+        return context;
+    }
+
     /**
      * Gets the user used by/in the spidering scan.
      *

addOns/spider/src/test/java/org/zaproxy/addon/spider/parser/ParseContextUnitTest.java

@@ -36,6 +36,7 @@
 import org.parosproxy.paros.network.HttpMessage;
 import org.parosproxy.paros.network.HttpRequestHeader;
 import org.zaproxy.addon.spider.SpiderParam;
+import org.zaproxy.zap.model.Context;
 import org.zaproxy.zap.model.ValueGenerator;
 import org.zaproxy.zap.network.HttpResponseBody;
 import org.zaproxy.zap.users.User;
@@ -45,6 +46,7 @@ class ParseContextUnitTest {
 
     private SpiderParam spiderParam;
     private ValueGenerator valueGenerator;
+    private Context context;
     private User user;
     private HttpMessage httpMessage;
     private String responseData;
@@ -58,6 +60,7 @@ class ParseContextUnitTest {
     void setup() throws Exception {
         spiderParam = mock(SpiderParam.class);
         valueGenerator = mock(ValueGenerator.class);
+        context = mock(Context.class);
         user = mock(User.class);
         httpMessage = mock(HttpMessage.class);
         responseData = "<html></html>";
@@ -96,9 +99,12 @@ private void assertInitialConstructorValues() {
     @Test
     void shouldCreateWithGivenAdditionalValues() {
         // Given / When
-        ctx = new ParseContext(spiderParam, valueGenerator, user, httpMessage, path, depth);
+        ctx =
+                new ParseContext(
+                        spiderParam, valueGenerator, context, user, httpMessage, path, depth);
         // Then
         assertInitialConstructorValues();
+        assertThat(ctx.getContext(), is(sameInstance(context)));
         assertThat(ctx.getUser(), is(sameInstance(user)));
     }