firecrawl-api / apps /java-sdk /src /test /java /com /firecrawl /FirecrawlClientTest.java
s-eto-hub's picture
Commit de nettoyage des binaires
097eaf0
Raw History Blame Contribute Delete
11.2 kB
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"));
}
}