undefect. CWE-407 — 63 sites patched across 27 ecosystems

Authors: russell@unturf.com · brackishbert@gmail.com · foxhop.net · TimeHexOn.com

Patches, unit tests, benchmarks, whitepaper, and outreach briefs.
Public domain — no copyright claimed. Use freely.

test/langtools/jdk/javadoc/doclet/testClassTree/TestClassTree.java

@@ -0,0 +1,140 @@
+/*
+ * Copyright (c) 2004, 2024, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @bug      4632553 4973607 8026567 8242564
+ * @summary  No need to include type name (class, interface, etc.) before
+ *           every single type in class tree.
+ *           Make sure class tree includes heirarchy for enums and annotation
+ *           types.
+ *           Make sure class tree handles undefined types in the class
+ *           hierarchy.
+ * @library  /tools/lib ../../lib
+ * @modules jdk.javadoc/jdk.javadoc.internal.tool
+ * @build    toolbox.ToolBox javadoc.tester.*
+ * @run main TestClassTree
+ */
+
+import java.io.IOException;
+import java.nio.file.Path;
+
+import javadoc.tester.JavadocTester;
+import toolbox.ToolBox;
+
+public class TestClassTree extends JavadocTester {
+
+    private final ToolBox tb = new ToolBox();
+
+    public static void main(String... args) throws Exception {
+        var tester = new TestClassTree();
+        tester.runTests();
+    }
+
+    /**
+     * Given badpkg package containing class ChildClass with UndefinedClass
+     *       base class, implementing UndefinedInterface and a defined
+     *       interface
+     * When the javadoc is generated with '--ignore-source-errors option'
+     * Then javadoc exits successfully
+     * And generates html for the ChildClass with UndefinedClass base class
+     * And UndefinedInterface is not present in html
+     */
+    @Test
+    public void testBadPkg(Path base) throws IOException {
+        Path src = base.resolve("src");
+        tb.writeJavaFiles(src,
+                """
+                    package badpkg;
+                    public class ChildClass extends UndefinedClass
+                        implements UndefinedInterface, Iterable {
+
+                    }
+                    """
+        );
+
+        javadoc("--ignore-source-errors",
+                "-d", base.resolve("badout").toString(),
+                "--no-platform-links",
+                "-sourcepath", src.toString(),
+                "badpkg");
+
+
+        checkExit(Exit.OK);
+        checkOutput("badpkg/package-tree.html", true,
+                """
+                    <li class="circle">badpkg.<a href="ChildClass.html" class="type-name-link" title="\
+                    class in badpkg">ChildClass</a> (implements java.lang.Iterable&lt;T&gt;)</li>
+                    """);
+        checkOutput("badpkg/ChildClass.html", true,
+                """
+                    <div class="type-signature"><span class="modifiers">public class </span>\
+                    <span class="element-name type-name-label">ChildClass</span>
+                    <span class="extends-implements">extends UndefinedClass
+                    implements java.lang.Iterable</span></div>
+                    """);
+        checkOutput("badpkg/ChildClass.html", false, "UndefinedInterface");
+    }
+
+    @Test
+    public void test() {
+        javadoc("-d", "out",
+                "--no-platform-links",
+                "-sourcepath", testSrc,
+                "pkg");
+        checkExit(Exit.OK);
+
+        checkOutput("pkg/package-tree.html", true,
+                """
+                    <ul>
+                    <li class="circle">pkg.<a href="ParentClass.html" class="type-name-link" title="\
+                    class in pkg">ParentClass</a>""",
+                """
+                    <h2 title="Annotation Interface Hierarchy">Annotation Interface Hierarchy</h2>
+                    <ul>
+                    <li class="circle">pkg.<a href="AnnotationType.html" class="type-name-link" titl\
+                    e="annotation interface in pkg">AnnotationType</a> (implements java.lang.annotat\
+                    ion.Annotation)</li>
+                    </ul>""",
+                """
+                    <h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2>
+                    <ul>
+                    <li class="circle">java.lang.Object
+                    <ul>
+                    <li class="circle">java.lang.Enum&lt;E&gt; (implements java.lang.Comparable&lt;T\
+                    &gt;, java.lang.constant.Constable, java.io.Serializable)
+                    <ul>
+                    <li class="circle">pkg.<a href="Coin.html" class="type-name-link" title="enum cl\
+                    ass in pkg">Coin</a></li>
+                    </ul>
+                    </li>
+                    </ul>
+                    </li>
+                    </ul>""");
+
+        checkOutput("pkg/package-tree.html", false,
+                """
+                    <li class="circle">class pkg.<a href=".ParentClass.html" class="type-name-link" \
+                    title="class in pkg">ParentClass</a></li>""");
+    }
+}