File size: 11,240 Bytes
097eaf0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
package com.firecrawl;

import com.firecrawl.client.FirecrawlClient;
import com.firecrawl.errors.FirecrawlException;
import com.firecrawl.models.*;
import okhttp3.OkHttpClient;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable;

import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.concurrent.TimeUnit;

import static org.junit.jupiter.api.Assertions.*;

/**
 * Integration tests for the Firecrawl Java SDK.
 *
 * <p>These tests require a valid FIRECRAWL_API_KEY environment variable.
 * Run with: FIRECRAWL_API_KEY=fc-xxx ./gradlew test
 */
class FirecrawlClientTest {

    @Test
    void testBuilderRequiresApiKey() {
        assertThrows(FirecrawlException.class, () ->
                FirecrawlClient.builder().apiKey("").build()
        );
    }

    @Test
    void testBuilderRejectsExplicitNullApiKey() {
        assertThrows(FirecrawlException.class, () ->
                FirecrawlClient.builder().apiKey(null).build()
        );
    }

    @Test
    void testBuilderAcceptsApiKey() {
        // Should not throw — just validates construction
        FirecrawlClient client = FirecrawlClient.builder()
                .apiKey("fc-test-key")
                .build();
        assertNotNull(client);
    }

    @Test
    void testBuilderAcceptsCustomHttpClient() {
        OkHttpClient custom = new OkHttpClient.Builder()
                .connectTimeout(10, TimeUnit.SECONDS)
                .readTimeout(10, TimeUnit.SECONDS)
                .build();

        FirecrawlClient client = FirecrawlClient.builder()
                .apiKey("fc-test-key")
                .httpClient(custom)
                .build();
        assertNotNull(client);
    }

    @Test
    void testScrapeOptionsBuilder() {
        QueryFormat queryFormat = QueryFormat.builder()
                .prompt("What is Firecrawl?")
                .mode(QueryFormat.Mode.DIRECT_QUOTE)
                .build();

        ScrapeOptions options = ScrapeOptions.builder()
                .formats(List.of("markdown", "html", "video", queryFormat))
                .onlyMainContent(true)
                .timeout(30000)
                .mobile(false)
                .build();

        assertEquals(List.of("markdown", "html", "video", queryFormat), options.getFormats());
        assertEquals("query", queryFormat.getType());
        assertEquals(QueryFormat.Mode.DIRECT_QUOTE, queryFormat.getMode());
        assertTrue(options.getOnlyMainContent());
        assertEquals(30000, options.getTimeout());
        assertFalse(options.getMobile());
    }

    @Test
    void testQuestionAndHighlightsFormats() {
        QuestionFormat questionFormat = QuestionFormat.builder()
                .question("What is Firecrawl?")
                .build();
        HighlightsFormat highlightsFormat = HighlightsFormat.builder()
                .query("What is Firecrawl?")
                .build();

        ScrapeOptions options = ScrapeOptions.builder()
                .formats(List.of(questionFormat, highlightsFormat))
                .build();

        assertEquals(List.of(questionFormat, highlightsFormat), options.getFormats());
        assertEquals("question", questionFormat.getType());
        assertEquals("What is Firecrawl?", questionFormat.getQuestion());
        assertEquals("highlights", highlightsFormat.getType());
        assertEquals("What is Firecrawl?", highlightsFormat.getQuery());
    }

    @Test
    void testCrawlOptionsBuilder() {
        CrawlOptions options = CrawlOptions.builder()
                .limit(100)
                .maxDiscoveryDepth(3)
                .sitemap("include")
                .excludePaths(List.of("/admin/*"))
                .build();

        assertEquals(100, options.getLimit());
        assertEquals(3, options.getMaxDiscoveryDepth());
        assertEquals("include", options.getSitemap());
        assertEquals(List.of("/admin/*"), options.getExcludePaths());
    }

    @Test
    void testAgentOptionsRequiresPrompt() {
        assertThrows(IllegalArgumentException.class, () ->
                AgentOptions.builder().build()
        );
    }

    @Test
    void testWebhookConfigRequiresUrl() {
        assertThrows(IllegalArgumentException.class, () ->
                WebhookConfig.builder().build()
        );
    }

    @Test
    void testScrapeOptionsToBuilder() {
        ScrapeOptions original = ScrapeOptions.builder()
                .formats(List.of("markdown"))
                .timeout(5000)
                .build();

        ScrapeOptions modified = original.toBuilder()
                .timeout(10000)
                .build();

        assertEquals(5000, original.getTimeout());
        assertEquals(10000, modified.getTimeout());
        assertEquals(List.of("markdown"), modified.getFormats());
    }

    @Test
    void testBrowserExecuteRequiresSessionId() {
        FirecrawlClient client = FirecrawlClient.builder()
                .apiKey("fc-test-key")
                .build();
        assertThrows(NullPointerException.class, () ->
                client.browserExecute(null, "echo test")
        );
    }

    @Test
    void testInteractRequiresJobId() {
        FirecrawlClient client = FirecrawlClient.builder()
                .apiKey("fc-test-key")
                .build();
        assertThrows(NullPointerException.class, () ->
                client.interact(null, "console.log('hi')")
        );
    }

    @Test
    void testInteractRequiresCode() {
        FirecrawlClient client = FirecrawlClient.builder()
                .apiKey("fc-test-key")
                .build();
        assertThrows(NullPointerException.class, () ->
                client.interact("job-id", null)
        );
    }

    @Test
    void testBrowserDeleteRequiresSessionId() {
        FirecrawlClient client = FirecrawlClient.builder()
                .apiKey("fc-test-key")
                .build();
        assertThrows(NullPointerException.class, () ->
                client.deleteBrowser(null)
        );
    }

    @Test
    void testStopInteractiveBrowserRequiresJobId() {
        FirecrawlClient client = FirecrawlClient.builder()
                .apiKey("fc-test-key")
                .build();
        assertThrows(NullPointerException.class, () ->
                client.stopInteractiveBrowser(null)
        );
    }

    @Test
    void testParseFileBuilder() {
        ParseFile file = ParseFile.builder()
                .filename("upload.html")
                .content("<html><body>hello</body></html>".getBytes(StandardCharsets.UTF_8))
                .contentType("text/html")
                .build();

        assertEquals("upload.html", file.getFilename());
        assertEquals("text/html", file.getContentType());
        assertTrue(file.getContent().length > 0);
        byte[] firstRead = file.getContent();
        firstRead[0] = 'X';
        assertNotEquals(firstRead[0], file.getContent()[0]);
    }

    @Test
    void testParseRequiresFile() {
        FirecrawlClient client = FirecrawlClient.builder()
                .apiKey("fc-test-key")
                .build();
        assertThrows(NullPointerException.class, () ->
                client.parse(null)
        );
    }

    @Test
    void testParseOptionsRejectsChangeTrackingFormat() {
        assertThrows(IllegalArgumentException.class, () ->
                ParseOptions.builder()
                        .formats(List.of("markdown", "changeTracking"))
                        .build()
        );
    }

    @Test
    void testParseOptionsRejectsVideoFormat() {
        assertThrows(IllegalArgumentException.class, () ->
                ParseOptions.builder()
                        .formats(List.of("video"))
                        .build()
        );
    }

    // ================================================================
    // E2E TESTS (require FIRECRAWL_API_KEY)
    // ================================================================

    @Test
    @EnabledIfEnvironmentVariable(named = "FIRECRAWL_API_KEY", matches = ".*\\S.*")
    void testScrapeE2E() {
        FirecrawlClient client = FirecrawlClient.fromEnv();
        Document doc = client.scrape("https://example.com",
                ScrapeOptions.builder()
                        .formats(List.of("markdown"))
                        .build());

        assertNotNull(doc);
        assertNotNull(doc.getMarkdown());
        assertFalse(doc.getMarkdown().isEmpty());
    }

    @Test
    @EnabledIfEnvironmentVariable(named = "FIRECRAWL_API_KEY", matches = ".*\\S.*")
    void testMapE2E() {
        FirecrawlClient client = FirecrawlClient.fromEnv();
        MapData data = client.map("https://example.com",
                MapOptions.builder()
                        .limit(10)
                        .build());

        assertNotNull(data);
        assertNotNull(data.getLinks());
    }

    @Test
    @EnabledIfEnvironmentVariable(named = "FIRECRAWL_API_KEY", matches = ".*\\S.*")
    void testCrawlE2E() {
        FirecrawlClient client = FirecrawlClient.fromEnv();
        CrawlJob job = client.crawl("https://example.com",
                CrawlOptions.builder()
                        .limit(3)
                        .build(),
                2, 60);

        assertNotNull(job);
        assertEquals("completed", job.getStatus());
        assertNotNull(job.getData());
        assertFalse(job.getData().isEmpty());
    }

    @Test
    @EnabledIfEnvironmentVariable(named = "FIRECRAWL_API_KEY", matches = ".*\\S.*")
    void testSearchE2E() {
        FirecrawlClient client = FirecrawlClient.fromEnv();
        SearchData data = client.search("firecrawl web scraping",
                SearchOptions.builder()
                        .limit(5)
                        .build());

        assertNotNull(data);
    }

    @Test
    @EnabledIfEnvironmentVariable(named = "FIRECRAWL_API_KEY", matches = ".*\\S.*")
    void testConcurrencyE2E() {
        FirecrawlClient client = FirecrawlClient.fromEnv();
        ConcurrencyCheck check = client.getConcurrency();

        assertNotNull(check);
        assertTrue(check.getMaxConcurrency() > 0);
    }

    @Test
    @EnabledIfEnvironmentVariable(named = "FIRECRAWL_API_KEY", matches = ".*\\S.*")
    void testCreditUsageE2E() {
        FirecrawlClient client = FirecrawlClient.fromEnv();
        CreditUsage usage = client.getCreditUsage();

        assertNotNull(usage);
    }

    @Test
    @EnabledIfEnvironmentVariable(named = "FIRECRAWL_API_KEY", matches = ".*\\S.*")
    void testParseE2E() {
        FirecrawlClient client = FirecrawlClient.fromEnv();
        ParseFile file = ParseFile.builder()
                .filename("java-parse-e2e.html")
                .content("<!DOCTYPE html><html><body><h1>Java SDK Parse E2E</h1></body></html>".getBytes(StandardCharsets.UTF_8))
                .contentType("text/html")
                .build();

        Document doc = client.parse(file, ParseOptions.builder()
                .formats(List.of("markdown"))
                .build());

        assertNotNull(doc);
        assertNotNull(doc.getMarkdown());
        assertFalse(doc.getMarkdown().isEmpty());
        assertTrue(doc.getMarkdown().contains("Java SDK Parse E2E"));
    }
}