summaryrefslogtreecommitdiff
path: root/src/test/java/org/javacs/JavadocsTest.java
blob: 90e394c50085e02eb03e18f955f48ee4819e7f35 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
package org.javacs;

import static org.hamcrest.Matchers.*;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;

import com.sun.javadoc.RootDoc;
import java.io.IOException;
import java.nio.file.Paths;
import java.util.Collections;
import org.junit.Test;

public class JavadocsTest {

    private final Javadocs docs =
            new Javadocs(
                    Collections.singleton(Paths.get("src/test/test-project/workspace/src")), Collections.emptySet());

    @Test
    public void findSrcZip() {
        assertTrue("Can find src.zip", Javadocs.findSrcZip().isPresent());
    }

    @Test
    public void findSystemDoc() throws IOException {
        RootDoc root = docs.index("java.util.ArrayList");

        assertThat(root.classes(), not(emptyArray()));
    }

    /*
    @Test
    public void findMethodDoc() {
        assertTrue(
                "Found method",
                docs.methodDoc(
                                "org.javacs.docs.TrickyDocstring#example(java.lang.String,java.lang.String[],java.util.List)")
                        .isPresent());
    }

    @Test
    public void findParameterizedDoc() {
        assertTrue(
                "Found method",
                docs.methodDoc("org.javacs.docs.TrickyDocstring#parameterized(java.lang.Object)").isPresent());
    }

    @Test
    @Ignore // Blocked by emptyFileManager
    public void findInheritedDoc() {
        Optional<MethodDoc> found = docs.methodDoc("org.javacs.docs.SubDoc#method()");

        assertTrue("Found method", found.isPresent());

        Optional<String> docstring = found.flatMap(Javadocs::commentText);

        assertTrue("Has inherited doc", docstring.isPresent());
        assertThat("Inherited doc is not empty", docstring.get(), not(isEmptyOrNullString()));
    }

    @Test
    @Ignore // Doesn't work yet
    public void findInterfaceDoc() {
        Optional<MethodDoc> found = docs.methodDoc("org.javacs.docs.SubDoc#interfaceMethod()");

        assertTrue("Found method", found.isPresent());

        Optional<String> docstring = found.flatMap(Javadocs::commentText);

        assertTrue("Has inherited doc", docstring.isPresent());
        assertThat("Inherited doc is not empty", docstring.get(), not(isEmptyOrNullString()));
    }
    */
}