Merge pull request zaproxy#9012 from psiinon/sstruct-tests

SessionStructure - remove deprecated methods and add tests

Author: thc202

zap/gradle/japicmp.yaml

@@ -7,4 +7,9 @@ fieldExcludes: []
 classExcludes:
   - "org.parosproxy.paros.core.scanner.VariantAbstractRPCQuery$RPCParameter"
   - "org.parosproxy.paros.core.scanner.VariantJSONQuery$SimpleStringReader"
-methodExcludes: []
+methodExcludes:
+  - "org.zaproxy.zap.model.SessionStructure#addPath(org.parosproxy.paros.model.Session,org.parosproxy.paros.model.HistoryReference,org.parosproxy.paros.network.HttpMessage)"
+  - "org.zaproxy.zap.model.SessionStructure#addPath(org.parosproxy.paros.model.Session,org.parosproxy.paros.model.HistoryReference,org.parosproxy.paros.network.HttpMessage,boolean)"
+  - "org.zaproxy.zap.model.SessionStructure#find(long,org.apache.commons.httpclient.URI,java.lang.String,java.lang.String)"
+  - "org.zaproxy.zap.model.SessionStructure#getNodeName(org.parosproxy.paros.network.HttpMessage)"
+  - "org.zaproxy.zap.model.SessionStructure#getRootNode()"

zap/src/main/java/org/zaproxy/zap/model/SessionStructure.java

@@ -53,20 +53,6 @@ public class SessionStructure {
 
     private static final Logger LOGGER = LogManager.getLogger(SessionStructure.class);
 
-    /**
-     * Adds the message to the Sites tree
-     *
-     * @param session the session
-     * @param ref the history reference
-     * @param msg the message
-     * @return the node added to the Sites Tree
-     * @deprecated Use {@link #addPath(Model, HistoryReference, HttpMessage)}
-     */
-    @Deprecated
-    public static StructuralNode addPath(Session session, HistoryReference ref, HttpMessage msg) {
-        return addPath(session, ref, msg, false);
-    }
-
     /**
      * Adds the message to the Sites tree
      *
@@ -80,23 +66,6 @@ public static StructuralNode addPath(Model model, HistoryReference ref, HttpMess
         return addPath(model, ref, msg, false);
     }
 
-    /**
-     * Adds the message to the Sites tree
-     *
-     * @param session the session
-     * @param ref the history reference
-     * @param msg the message
-     * @param newOnly Only return a SiteNode if one was newly created
-     * @return the SiteNode that corresponds to the HttpMessage, or null if newOnly and the node
-     *     already exists
-     * @deprecated Use {@link #addPath(Model, HistoryReference, HttpMessage, boolean)}
-     */
-    @Deprecated
-    public static StructuralNode addPath(
-            Session session, HistoryReference ref, HttpMessage msg, boolean newOnly) {
-        return addPath(Model.getSingleton(), ref, msg, newOnly);
-    }
-
     /**
      * Adds the message to the Sites tree
      *
@@ -189,38 +158,6 @@ public static StructuralNode find(Model model, HttpMessage msg)
         return new StructuralTableNode(rs);
     }
 
-    /**
-     * Finds the node in the Site tree for the given request data
-     *
-     * @param sessionId the session id
-     * @param uri the URI
-     * @param method the method
-     * @param postData the POST data
-     * @return the site node or null if not found
-     * @throws DatabaseException
-     * @throws URIException
-     * @deprecated Use {@link #find(Model, URI, String, String)}
-     */
-    @Deprecated
-    public static StructuralNode find(long sessionId, URI uri, String method, String postData)
-            throws DatabaseException, URIException {
-        Model model = Model.getSingleton();
-        if (!Constant.isLowMemoryOptionSet()) {
-            SiteNode node = model.getSession().getSiteTree().findNode(uri, method, postData);
-            if (node == null) {
-                return null;
-            }
-            return new StructuralSiteNode(node);
-        }
-
-        String nodeName = getNodeName(model, uri, method, postData, null);
-        RecordStructure rs = model.getDb().getTableStructure().find(sessionId, nodeName, method);
-        if (rs == null) {
-            return null;
-        }
-        return new StructuralTableNode(rs);
-    }
-
     /**
      * Finds the node in the Site tree for the given request data
      *
@@ -284,19 +221,6 @@ private static String getNodeName(
         return nodeUrl;
     }
 
-    /**
-     * Returns the node name for the given message
-     *
-     * @param msg the message
-     * @return the node name
-     * @throws URIException
-     * @deprecated Use {@link #getNodeName(Model, HttpMessage)}
-     */
-    @Deprecated
-    public static String getNodeName(HttpMessage msg) throws URIException {
-        return getNodeName(Model.getSingleton(), msg);
-    }
-
     /**
      * Returns the node name for the given message
      *
@@ -697,17 +621,6 @@ private static String getScheme(URI uri) {
         return scheme.toLowerCase(Locale.ROOT);
     }
 
-    /**
-     * Returns the root node
-     *
-     * @return the root node
-     * @deprecated Use {@link #getRootNode(Model)}
-     */
-    @Deprecated
-    public static StructuralNode getRootNode() {
-        return getRootNode(Model.getSingleton());
-    }
-
     /**
      * Returns the root node
      *

zap/src/test/java/org/zaproxy/zap/model/SessionStructureUnitTest.java

@@ -472,14 +472,136 @@ void shouldReturnOverridenPathTree() throws Exception {
         }
     }
 
+    @Nested
+    static class NodeNameTests {
+
+        private Model model;
+        private Session session;
+        private VariantFactory factory;
+
+        HttpMessage getParams;
+        HttpMessage postParamsFormData;
+        HttpMessage postParamsJsonData;
+        HttpMessage postParamsXmlData;
+        HttpMessage postMultipartData;
+
+        @BeforeEach
+        void setup() throws Exception {
+            WithConfigsTest.setUpConstantMessages();
+            model = mock(Model.class);
+            session = new Session(model);
+            factory = new VariantFactory();
+            given(model.getSession()).willReturn(session);
+            given(model.getVariantFactory()).willReturn(factory);
+            getParams =
+                    new HttpMessage(new URI("https://www.example.com/aaa/bbb?aa=bb&cc=dd", false));
+            postParamsFormData =
+                    getPostMsgWithFormParams(
+                            "https://www.example.com/ccc", "aa=bb&cc=dd", "ee=ff&gg=ee");
+            postParamsJsonData =
+                    getPostMsg(
+                            "https://www.example.com/ccc",
+                            "aa=bb&cc=dd",
+                            "{\"aaa\":\"bbb\", \"ccc\":\"ddd\", \"eee\":\"fff\"}",
+                            "application/json");
+            postParamsXmlData =
+                    getPostMsg(
+                            "https://www.example.com/ccc",
+                            "aa=bb&cc=dd",
+                            "<aaa><bbb>BBB</bbb><ccc>CCC</ccc><ddd>DDD</ddd></aaa>",
+                            "text/xml");
+            Control.initSingletonForTesting(model);
+        }
+
+        @AfterEach
+        void cleanUp() {
+            Constant.messages = null;
+        }
+
+        @Test
+        void shouldGetNodeName() throws URIException {
+            assertThat(
+                    SessionStructure.getNodeName(model, getParams),
+                    is(equalTo("https://www.example.com/aaa/bbb (aa,cc)")));
+            assertThat(
+                    SessionStructure.getNodeName(model, postParamsFormData),
+                    is(equalTo("https://www.example.com/ccc (aa,cc)(ee,gg)")));
+            // FIXME should have the JSON key names
+            assertThat(
+                    SessionStructure.getNodeName(model, postParamsJsonData),
+                    is(equalTo("https://www.example.com/ccc (aa,cc)")));
+            // FIXME should have the XML key names
+            assertThat(
+                    SessionStructure.getNodeName(model, postParamsXmlData),
+                    is(equalTo("https://www.example.com/ccc (aa,cc)")));
+        }
+
+        @Test
+        void shouldGetLeafName1() throws URIException {
+            assertThat(
+                    SessionStructure.getLeafName(model, "test", getParams),
+                    is(equalTo("GET:test(aa,cc)")));
+            assertThat(
+                    SessionStructure.getLeafName(model, "test", postParamsFormData),
+                    is(equalTo("POST:test(aa,cc)(ee,gg)")));
+            // FIXME should have the JSON key names
+            assertThat(
+                    SessionStructure.getLeafName(model, "test", postParamsJsonData),
+                    is(
+                            equalTo(
+                                    "POST:test(aa,cc)({\"aaa\":\"bbb\", \"ccc\":\"ddd\", \"eee\":\"fff\"})")));
+            // FIXME should have the XML key names
+            assertThat(
+                    SessionStructure.getLeafName(model, "test", postParamsXmlData),
+                    is(equalTo("POST:test(aa,cc)(<aaa><bbb>BBB</bbb><ccc>CCC</ccc><ddd>DD...)")));
+        }
+
+        @Test
+        void shouldGetLeafName2() throws Exception {
+            assertThat(getLeafName2(getParams), is(equalTo("GET:test(aa,cc)")));
+            assertThat(getLeafName2(postParamsFormData), is(equalTo("POST:test(aa,cc)(ee,gg)")));
+            // FIXME should have the JSON key names
+            assertThat(
+                    getLeafName2(postParamsJsonData),
+                    is(
+                            equalTo(
+                                    "POST:test(aa,cc)({\"aaa\":\"bbb\", \"ccc\":\"ddd\", \"eee\":\"fff\"})")));
+            // FIXME should have the XML key names
+            assertThat(
+                    getLeafName2(postParamsXmlData),
+                    is(equalTo("POST:test(aa,cc)(<aaa><bbb>BBB</bbb><ccc>CCC</ccc><ddd>DD...)")));
+        }
+
+        String getLeafName2(HttpMessage msg) throws Exception {
+            return SessionStructure.getLeafName(
+                    model,
+                    "test",
+                    msg.getRequestHeader().getURI(),
+                    msg.getRequestHeader().getMethod(),
+                    msg.getRequestBody().toString());
+        }
+    }
+
     private void createPostMsgWithFormParams(String uri, String queryParams, String formParams)
             throws URIException {
-        msg.getRequestHeader().setMethod(HttpRequestHeader.POST);
+        msg = getPostMsgWithFormParams(uri, queryParams, formParams);
+    }
+
+    private static HttpMessage getPostMsgWithFormParams(
+            String uri, String queryParams, String formParams) throws URIException {
+        return getPostMsg(uri, queryParams, formParams, "application/x-www-form-urlencoded");
+    }
+
+    private static HttpMessage getPostMsg(
+            String uri, String queryParams, String formParams, String contentType)
+            throws URIException {
+        HttpMessage message = new HttpMessage();
+        message.getRequestHeader().setMethod(HttpRequestHeader.POST);
         queryParams = queryParams == null ? "" : "?" + queryParams;
-        msg.getRequestHeader().setURI(new URI(uri + queryParams, true));
-        msg.getRequestHeader()
-                .setHeader(HttpHeader.CONTENT_TYPE, "application/x-www-form-urlencoded");
-        msg.setRequestBody(formParams);
+        message.getRequestHeader().setURI(new URI(uri + queryParams, true));
+        message.getRequestHeader().setHeader(HttpHeader.CONTENT_TYPE, contentType);
+        message.setRequestBody(formParams);
+        return message;
     }
 
     public static final class PathTreeVariant implements Variant {