31 Commits

Author SHA1 Message Date
Arik Jones
beca098b0d cleanup: go module changes 2024-09-21 15:39:14 -05:00
Arik Jones (aider)
96ac2dbfc0 fix: set default rate limiter values to allow scraping 2024-09-21 15:30:58 -05:00
Arik Jones (aider)
6bc76ff9da fix: resolve undefined log errors in web.go 2024-09-21 15:28:02 -05:00
Arik Jones (aider)
41268853ba fix: add missing os package import in scraper.go 2024-09-21 15:27:00 -05:00
Arik Jones (aider)
a3f3f6e560 fix: update logger to use stdout for verbose output 2024-09-21 15:26:21 -05:00
Arik Jones (aider)
08e0e29463 feat: add logger setup in web command 2024-09-21 10:58:14 -05:00
Arik Jones (aider)
8f824d8990 feat: enhance logging in runWeb function for better debugging 2024-09-21 10:57:51 -05:00
Arik Jones (aider)
6f39dd6726 feat: enhance logging in scraper for better debugging 2024-09-21 10:57:10 -05:00
Arik Jones (aider)
67c62456fa feat: enhance logging for scraping process 2024-09-21 10:56:26 -05:00
Arik Jones (aider)
751ea5828d refactor: update ScrapeSites to handle base_url and allowed_paths 2024-09-21 10:55:01 -05:00
Arik Jones (aider)
7e4f4cdbb6 fix: update writeMultipleFiles function to handle multiple files 2024-09-19 16:37:07 -05:00
Arik Jones (aider)
f1f0bd3895 feat: add MaxDepth to URL-based configuration and use outputType directly 2024-09-19 16:36:24 -05:00
Arik Jones (aider)
57bbc5a1ac refactor: update writeMultipleFiles to create single output file 2024-09-19 16:35:46 -05:00
Arik Jones (aider)
32499abbc0 fix: improve URL parsing and title extraction in getFilenameFromContent 2024-09-19 16:33:55 -05:00
Arik Jones (aider)
237ed512fc fix: handle error from getFilenameFromContent in writeMultipleFiles 2024-09-19 16:32:30 -05:00
Arik Jones (aider)
7c8fcc3261 fix: update getFilenameFromContent to handle invalid URLs and use .rollup.md suffix 2024-09-19 16:31:43 -05:00
Arik Jones (aider)
30e11153f9 refactor: update getFilenameFromContent to remove http from filenames 2024-09-19 16:29:55 -05:00
Arik Jones (aider)
0219881f61 fix: remove unused import in cmd/web_test.go 2024-09-19 16:26:38 -05:00
Arik Jones (aider)
c77ae918c5 refactor: remove redundant variable declarations in test file 2024-09-19 16:25:30 -05:00
Arik Jones (aider)
1b696ce9c6 refactor: use wrapper functions for easier testing 2024-09-19 16:25:02 -05:00
Arik Jones (aider)
df1178cb03 test: refactor TestScrapeURL to use local mock functions 2024-09-19 16:24:23 -05:00
Arik Jones (aider)
c4831dfea2 fix: resolve compilation errors in web_test.go 2024-09-19 16:23:40 -05:00
Arik Jones (aider)
3c22d8034d fix: correct import path and update Config struct usage in test 2024-09-19 16:23:01 -05:00
Arik Jones (aider)
c7791814c9 fix: add missing imports and correct Config reference in files_test.go 2024-09-19 16:21:11 -05:00
Arik Jones (aider)
e184cef444 test: add unit tests for cmd and internal packages 2024-09-19 16:15:32 -05:00
Arik Jones (aider)
702665bb2e fix: import config package to resolve undefined error 2024-09-19 16:12:30 -05:00
Arik Jones (aider)
1d02cab585 fix: resolve type mismatch for PathOverrides in SiteConfig 2024-09-19 16:11:14 -05:00
Arik Jones (aider)
e3fddf101c fix: resolve undefined types and import issues in scraper.go 2024-09-19 16:10:06 -05:00
Arik Jones (aider)
569ff9924d feat: implement site-based scraping with path overrides 2024-09-19 16:06:55 -05:00
Arik Jones (aider)
1d38e4157c fix: add Scrape field to Config struct and create ScrapeConfig 2024-09-19 15:23:35 -05:00
Arik Jones (aider)
d44fabf783 feat: implement rate limiting for URL scraping 2024-09-19 15:22:02 -05:00
9 changed files with 975 additions and 99 deletions

147
cmd/files_test.go Normal file
View File

@@ -0,0 +1,147 @@
package cmd
import (
"os"
"path/filepath"
"strings"
"testing"
"github.com/tnypxl/rollup/internal/config"
)
func TestMatchGlob(t *testing.T) {
tests := []struct {
pattern string
path string
expected bool
}{
{"*.go", "file.go", true},
{"*.go", "file.txt", false},
{"**/*.go", "dir/file.go", true},
{"**/*.go", "dir/subdir/file.go", true},
{"dir/*.go", "dir/file.go", true},
{"dir/*.go", "otherdir/file.go", false},
}
for _, test := range tests {
result := matchGlob(test.pattern, test.path)
if result != test.expected {
t.Errorf("matchGlob(%q, %q) = %v; want %v", test.pattern, test.path, result, test.expected)
}
}
}
func TestIsCodeGenerated(t *testing.T) {
patterns := []string{"generated_*.go", "**/auto_*.go"}
tests := []struct {
path string
expected bool
}{
{"generated_file.go", true},
{"normal_file.go", false},
{"subdir/auto_file.go", true},
{"subdir/normal_file.go", false},
}
for _, test := range tests {
result := isCodeGenerated(test.path, patterns)
if result != test.expected {
t.Errorf("isCodeGenerated(%q, %v) = %v; want %v", test.path, patterns, result, test.expected)
}
}
}
func TestIsIgnored(t *testing.T) {
patterns := []string{"*.tmp", "**/*.log"}
tests := []struct {
path string
expected bool
}{
{"file.tmp", true},
{"file.go", false},
{"subdir/file.log", true},
{"subdir/file.txt", false},
}
for _, test := range tests {
result := isIgnored(test.path, patterns)
if result != test.expected {
t.Errorf("isIgnored(%q, %v) = %v; want %v", test.path, patterns, result, test.expected)
}
}
}
func TestRunRollup(t *testing.T) {
// Create a temporary directory for testing
tempDir, err := os.MkdirTemp("", "rollup_test")
if err != nil {
t.Fatalf("Failed to create temp dir: %v", err)
}
defer os.RemoveAll(tempDir)
// Create some test files
files := map[string]string{
"file1.go": "package main\n\nfunc main() {}\n",
"file2.txt": "This is a text file.\n",
"subdir/file3.go": "package subdir\n\nfunc Func() {}\n",
"subdir/file4.json": "{\"key\": \"value\"}\n",
}
for name, content := range files {
path := filepath.Join(tempDir, name)
err := os.MkdirAll(filepath.Dir(path), 0755)
if err != nil {
t.Fatalf("Failed to create directory: %v", err)
}
err = os.WriteFile(path, []byte(content), 0644)
if err != nil {
t.Fatalf("Failed to write file: %v", err)
}
}
// Set up test configuration
cfg = &config.Config{
FileTypes: []string{"go", "txt"},
Ignore: []string{"*.json"},
CodeGenerated: []string{},
}
path = tempDir
// Run the rollup
err = runRollup()
if err != nil {
t.Fatalf("runRollup() failed: %v", err)
}
// Check if the output file was created
outputFiles, err := filepath.Glob(filepath.Join(tempDir, "*.rollup.md"))
if err != nil {
t.Fatalf("Failed to glob output files: %v", err)
}
if len(outputFiles) != 1 {
t.Fatalf("Expected 1 output file, got %d", len(outputFiles))
}
// Read the content of the output file
content, err := os.ReadFile(outputFiles[0])
if err != nil {
t.Fatalf("Failed to read output file: %v", err)
}
// Check if the content includes the expected files
expectedContent := []string{
"# File: file1.go",
"# File: file2.txt",
"# File: subdir/file3.go",
}
for _, expected := range expectedContent {
if !strings.Contains(string(content), expected) {
t.Errorf("Output file does not contain expected content: %s", expected)
}
}
// Check if the ignored file is not included
if strings.Contains(string(content), "file4.json") {
t.Errorf("Output file contains ignored file: file4.json")
}
}

View File

@@ -2,6 +2,8 @@ package cmd
import ( import (
"fmt" "fmt"
"io/ioutil"
"log"
"net/url" "net/url"
"os" "os"
"regexp" "regexp"
@@ -9,6 +11,7 @@ import (
"time" "time"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"github.com/tnypxl/rollup/internal/config"
"github.com/tnypxl/rollup/internal/scraper" "github.com/tnypxl/rollup/internal/scraper"
) )
@@ -38,47 +41,93 @@ func init() {
} }
func runWeb(cmd *cobra.Command, args []string) error { func runWeb(cmd *cobra.Command, args []string) error {
scraperConfig.Verbose = verbose scraper.SetupLogger(verbose)
logger := log.New(os.Stdout, "WEB: ", log.LstdFlags)
if !verbose {
logger.SetOutput(ioutil.Discard)
}
logger.Printf("Starting web scraping process with verbose mode: %v", verbose)
scraperConfig.Verbose = verbose
// Use config if available, otherwise use command-line flags var siteConfigs []scraper.SiteConfig
var urlConfigs []scraper.URLConfig if len(cfg.Scrape.Sites) > 0 {
if len(urls) == 0 && len(cfg.Scrape.URLs) > 0 { logger.Printf("Using configuration from rollup.yml for %d sites", len(cfg.Scrape.Sites))
urlConfigs = make([]scraper.URLConfig, len(cfg.Scrape.URLs)) siteConfigs = make([]scraper.SiteConfig, len(cfg.Scrape.Sites))
for i, u := range cfg.Scrape.URLs { for i, site := range cfg.Scrape.Sites {
urlConfigs[i] = scraper.URLConfig{ siteConfigs[i] = scraper.SiteConfig{
URL: u.URL, BaseURL: site.BaseURL,
CSSLocator: u.CSSLocator, CSSLocator: site.CSSLocator,
ExcludeSelectors: u.ExcludeSelectors, ExcludeSelectors: site.ExcludeSelectors,
OutputAlias: u.OutputAlias, MaxDepth: site.MaxDepth,
} AllowedPaths: site.AllowedPaths,
} ExcludePaths: site.ExcludePaths,
} else { OutputAlias: site.OutputAlias,
urlConfigs = make([]scraper.URLConfig, len(urls)) PathOverrides: convertPathOverrides(site.PathOverrides),
for i, u := range urls { }
urlConfigs[i] = scraper.URLConfig{URL: u, CSSLocator: includeSelector} logger.Printf("Site %d configuration: BaseURL=%s, CSSLocator=%s, MaxDepth=%d, AllowedPaths=%v",
} i+1, site.BaseURL, site.CSSLocator, site.MaxDepth, site.AllowedPaths)
} }
} else {
logger.Printf("No sites defined in rollup.yml, falling back to URL-based configuration")
siteConfigs = make([]scraper.SiteConfig, len(urls))
for i, u := range urls {
siteConfigs[i] = scraper.SiteConfig{
BaseURL: u,
CSSLocator: includeSelector,
ExcludeSelectors: excludeSelectors,
MaxDepth: depth,
}
logger.Printf("URL %d configuration: BaseURL=%s, CSSLocator=%s, MaxDepth=%d",
i+1, u, includeSelector, depth)
}
}
if len(urlConfigs) == 0 { if len(siteConfigs) == 0 {
return fmt.Errorf("no URLs provided. Use --urls flag with comma-separated URLs or set 'scrape.urls' in the rollup.yml file") logger.Println("Error: No sites or URLs provided")
} return fmt.Errorf("no sites or URLs provided. Use --urls flag with comma-separated URLs or set 'scrape.sites' in the rollup.yml file")
}
scraperConfig := scraper.Config{ // Set default values for rate limiting
URLs: urlConfigs, defaultRequestsPerSecond := 1.0
OutputType: outputType, defaultBurstLimit := 3
Verbose: verbose,
}
scrapedContent, err := scraper.ScrapeMultipleURLs(scraperConfig) // Use default values if not set in the configuration
if err != nil { requestsPerSecond := cfg.Scrape.RequestsPerSecond
return fmt.Errorf("error scraping content: %v", err) if requestsPerSecond == 0 {
} requestsPerSecond = defaultRequestsPerSecond
}
burstLimit := cfg.Scrape.BurstLimit
if burstLimit == 0 {
burstLimit = defaultBurstLimit
}
if outputType == "single" { scraperConfig := scraper.Config{
return writeSingleFile(scrapedContent) Sites: siteConfigs,
} else { OutputType: outputType,
return writeMultipleFiles(scrapedContent) Verbose: verbose,
} Scrape: scraper.ScrapeConfig{
RequestsPerSecond: requestsPerSecond,
BurstLimit: burstLimit,
},
}
logger.Printf("Scraper configuration: OutputType=%s, RequestsPerSecond=%f, BurstLimit=%d",
outputType, requestsPerSecond, burstLimit)
logger.Println("Starting scraping process")
scrapedContent, err := scraper.ScrapeSites(scraperConfig)
if err != nil {
logger.Printf("Error occurred during scraping: %v", err)
return fmt.Errorf("error scraping content: %v", err)
}
logger.Printf("Scraping completed. Total content scraped: %d", len(scrapedContent))
if outputType == "single" {
logger.Println("Writing content to a single file")
return writeSingleFile(scrapedContent)
} else {
logger.Println("Writing content to multiple files")
return writeMultipleFiles(scrapedContent)
}
} }
func writeSingleFile(content map[string]string) error { func writeSingleFile(content map[string]string) error {
@@ -102,20 +151,26 @@ func writeSingleFile(content map[string]string) error {
func writeMultipleFiles(content map[string]string) error { func writeMultipleFiles(content map[string]string) error {
for url, c := range content { for url, c := range content {
filename := getFilenameFromContent(c, url) filename, err := getFilenameFromContent(c, url)
if err != nil {
return fmt.Errorf("error generating filename for %s: %v", url, err)
}
file, err := os.Create(filename) file, err := os.Create(filename)
if err != nil { if err != nil {
return fmt.Errorf("error creating output file %s: %v", filename, err) return fmt.Errorf("error creating output file %s: %v", filename, err)
} }
_, err = file.WriteString(fmt.Sprintf("# Content from %s\n\n%s", url, c)) _, err = file.WriteString(fmt.Sprintf("# Content from %s\n\n%s\n", url, c))
file.Close()
if err != nil { if err != nil {
file.Close()
return fmt.Errorf("error writing content to file %s: %v", filename, err) return fmt.Errorf("error writing content to file %s: %v", filename, err)
} }
file.Close()
fmt.Printf("Content from %s has been saved to %s\n", url, filename) fmt.Printf("Content from %s has been saved to %s\n", url, filename)
} }
return nil return nil
} }
@@ -136,13 +191,13 @@ func scrapeURL(urlStr string, depth int, visited map[string]bool) (string, error
visited[urlStr] = true visited[urlStr] = true
content, err := extractAndConvertContent(urlStr) content, err := testExtractAndConvertContent(urlStr)
if err != nil { if err != nil {
return "", err return "", err
} }
if depth > 0 { if depth > 0 {
links, err := scraper.ExtractLinks(urlStr) links, err := testExtractLinks(urlStr)
if err != nil { if err != nil {
return content, fmt.Errorf("error extracting links: %v", err) return content, fmt.Errorf("error extracting links: %v", err)
} }
@@ -160,6 +215,9 @@ func scrapeURL(urlStr string, depth int, visited map[string]bool) (string, error
return content, nil return content, nil
} }
var testExtractAndConvertContent = extractAndConvertContent
var testExtractLinks = scraper.ExtractLinks
func extractAndConvertContent(urlStr string) (string, error) { func extractAndConvertContent(urlStr string) (string, error) {
content, err := scraper.FetchWebpageContent(urlStr) content, err := scraper.FetchWebpageContent(urlStr)
if err != nil { if err != nil {
@@ -187,17 +245,32 @@ func extractAndConvertContent(urlStr string) (string, error) {
return header + markdown + "\n\n", nil return header + markdown + "\n\n", nil
} }
func getFilenameFromContent(content, url string) string { func getFilenameFromContent(content, urlStr string) (string, error) {
// Try to extract title from content // Try to extract title from content
titleStart := strings.Index(content, "<title>") titleStart := strings.Index(content, "<title>")
titleEnd := strings.Index(content, "</title>") titleEnd := strings.Index(content, "</title>")
if titleStart != -1 && titleEnd != -1 && titleEnd > titleStart { if titleStart != -1 && titleEnd != -1 && titleEnd > titleStart {
title := content[titleStart+7 : titleEnd] title := strings.TrimSpace(content[titleStart+7 : titleEnd])
return sanitizeFilename(title) + ".md" if title != "" {
return sanitizeFilename(title) + ".rollup.md", nil
}
} }
// If no title found, use the URL // If no title found or title is empty, use the URL
return sanitizeFilename(url) + ".md" parsedURL, err := url.Parse(urlStr)
if err != nil {
return "", fmt.Errorf("invalid URL: %v", err)
}
if parsedURL.Host == "" {
return "", fmt.Errorf("invalid URL: missing host")
}
filename := parsedURL.Host
if parsedURL.Path != "" && parsedURL.Path != "/" {
filename += strings.TrimSuffix(parsedURL.Path, "/")
}
return sanitizeFilename(filename) + ".rollup.md", nil
} }
func sanitizeFilename(name string) string { func sanitizeFilename(name string) string {
@@ -215,3 +288,15 @@ func sanitizeFilename(name string) string {
return name return name
} }
func convertPathOverrides(configOverrides []config.PathOverride) []scraper.PathOverride {
scraperOverrides := make([]scraper.PathOverride, len(configOverrides))
for i, override := range configOverrides {
scraperOverrides[i] = scraper.PathOverride{
Path: override.Path,
CSSLocator: override.CSSLocator,
ExcludeSelectors: override.ExcludeSelectors,
}
}
return scraperOverrides
}

154
cmd/web_test.go Normal file
View File

@@ -0,0 +1,154 @@
package cmd
import (
"testing"
"strings"
"github.com/tnypxl/rollup/internal/config"
)
func TestConvertPathOverrides(t *testing.T) {
configOverrides := []config.PathOverride{
{
Path: "/blog",
CSSLocator: "article",
ExcludeSelectors: []string{".ads", ".comments"},
},
{
Path: "/products",
CSSLocator: ".product-description",
ExcludeSelectors: []string{".related-items"},
},
}
scraperOverrides := convertPathOverrides(configOverrides)
if len(scraperOverrides) != len(configOverrides) {
t.Errorf("Expected %d overrides, got %d", len(configOverrides), len(scraperOverrides))
}
for i, override := range scraperOverrides {
if override.Path != configOverrides[i].Path {
t.Errorf("Expected Path %s, got %s", configOverrides[i].Path, override.Path)
}
if override.CSSLocator != configOverrides[i].CSSLocator {
t.Errorf("Expected CSSLocator %s, got %s", configOverrides[i].CSSLocator, override.CSSLocator)
}
if len(override.ExcludeSelectors) != len(configOverrides[i].ExcludeSelectors) {
t.Errorf("Expected %d ExcludeSelectors, got %d", len(configOverrides[i].ExcludeSelectors), len(override.ExcludeSelectors))
}
for j, selector := range override.ExcludeSelectors {
if selector != configOverrides[i].ExcludeSelectors[j] {
t.Errorf("Expected ExcludeSelector %s, got %s", configOverrides[i].ExcludeSelectors[j], selector)
}
}
}
}
func TestSanitizeFilename(t *testing.T) {
tests := []struct {
input string
expected string
}{
{"Hello, World!", "Hello_World"},
{"file/with/path", "file_with_path"},
{"file.with.dots", "file_with_dots"},
{"___leading_underscores___", "leading_underscores"},
{"", "untitled"},
{"!@#$%^&*()", "untitled"},
}
for _, test := range tests {
result := sanitizeFilename(test.input)
if result != test.expected {
t.Errorf("sanitizeFilename(%q) = %q; want %q", test.input, result, test.expected)
}
}
}
func TestGetFilenameFromContent(t *testing.T) {
tests := []struct {
content string
url string
expected string
expectErr bool
}{
{"<title>Test Page</title>", "http://example.com", "Test_Page.rollup.md", false},
{"No title here", "http://example.com/page", "example_com_page.rollup.md", false},
{"<title> Trim Me </title>", "http://example.com", "Trim_Me.rollup.md", false},
{"<title></title>", "http://example.com", "example_com.rollup.md", false},
{"<title> </title>", "http://example.com", "example_com.rollup.md", false},
{"Invalid URL", "not a valid url", "", true},
{"No host", "http://", "", true},
}
for _, test := range tests {
result, err := getFilenameFromContent(test.content, test.url)
if test.expectErr {
if err == nil {
t.Errorf("getFilenameFromContent(%q, %q) expected an error, but got none", test.content, test.url)
}
} else {
if err != nil {
t.Errorf("getFilenameFromContent(%q, %q) unexpected error: %v", test.content, test.url, err)
}
if result != test.expected {
t.Errorf("getFilenameFromContent(%q, %q) = %q; want %q", test.content, test.url, result, test.expected)
}
}
}
}
// Mock functions for testing
func mockExtractAndConvertContent(urlStr string) (string, error) {
return "Mocked content for " + urlStr, nil
}
func mockExtractLinks(urlStr string) ([]string, error) {
return []string{"http://example.com/link1", "http://example.com/link2"}, nil
}
func TestScrapeURL(t *testing.T) {
// Store the original functions
originalExtractAndConvertContent := testExtractAndConvertContent
originalExtractLinks := testExtractLinks
// Define mock functions
testExtractAndConvertContent = func(urlStr string) (string, error) {
return "Mocked content for " + urlStr, nil
}
testExtractLinks = func(urlStr string) ([]string, error) {
return []string{"http://example.com/link1", "http://example.com/link2"}, nil
}
// Defer the restoration of original functions
defer func() {
testExtractAndConvertContent = originalExtractAndConvertContent
testExtractLinks = originalExtractLinks
}()
tests := []struct {
url string
depth int
expectedCalls int
}{
{"http://example.com", 0, 1},
{"http://example.com", 1, 3},
{"http://example.com", 2, 3}, // Same as depth 1 because our mock only returns 2 links
}
for _, test := range tests {
visited := make(map[string]bool)
content, err := scrapeURL(test.url, test.depth, visited)
if err != nil {
t.Errorf("scrapeURL(%q, %d) returned error: %v", test.url, test.depth, err)
continue
}
if len(visited) != test.expectedCalls {
t.Errorf("scrapeURL(%q, %d) made %d calls, expected %d", test.url, test.depth, len(visited), test.expectedCalls)
}
expectedContent := "Mocked content for " + test.url
if !strings.Contains(content, expectedContent) {
t.Errorf("scrapeURL(%q, %d) content doesn't contain %q", test.url, test.depth, expectedContent)
}
}
}

2
go.mod
View File

@@ -5,6 +5,7 @@ go 1.23
require ( require (
github.com/JohannesKaufmann/html-to-markdown v1.6.0 github.com/JohannesKaufmann/html-to-markdown v1.6.0
github.com/spf13/cobra v1.8.1 github.com/spf13/cobra v1.8.1
golang.org/x/time v0.6.0
) )
require ( require (
@@ -21,7 +22,6 @@ require (
github.com/PuerkitoBio/goquery v1.9.2 github.com/PuerkitoBio/goquery v1.9.2
github.com/inconshreveable/mousetrap v1.1.0 // indirect github.com/inconshreveable/mousetrap v1.1.0 // indirect
github.com/playwright-community/playwright-go v0.4501.1 github.com/playwright-community/playwright-go v0.4501.1
github.com/russross/blackfriday/v2 v2.1.0
github.com/spf13/pflag v1.0.5 // indirect github.com/spf13/pflag v1.0.5 // indirect
gopkg.in/yaml.v2 v2.4.0 gopkg.in/yaml.v2 v2.4.0
) )

3
go.sum
View File

@@ -32,7 +32,6 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M= github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M=
github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA= github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA=
github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/sebdah/goldie/v2 v2.5.3 h1:9ES/mNN+HNUbNWpVAlrzuZ7jE+Nrczbj8uFRjM7624Y= github.com/sebdah/goldie/v2 v2.5.3 h1:9ES/mNN+HNUbNWpVAlrzuZ7jE+Nrczbj8uFRjM7624Y=
github.com/sebdah/goldie/v2 v2.5.3/go.mod h1:oZ9fp0+se1eapSRjfYbsV/0Hqhbuu3bJVvKI/NNtssI= github.com/sebdah/goldie/v2 v2.5.3/go.mod h1:oZ9fp0+se1eapSRjfYbsV/0Hqhbuu3bJVvKI/NNtssI=
@@ -103,6 +102,8 @@ golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
golang.org/x/time v0.6.0 h1:eTDhh4ZXt5Qf0augr54TN6suAUudPcawVZeIAPU7D4U=
golang.org/x/time v0.6.0/go.mod h1:3BpzKBy/shNhVucY/MWOyx10tF3SFh9QdLuxbVysPQM=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=

View File

@@ -15,15 +15,27 @@ type Config struct {
} }
type ScrapeConfig struct { type ScrapeConfig struct {
URLs []URLConfig `yaml:"urls"` Sites []SiteConfig `yaml:"sites"`
OutputType string `yaml:"output_type"` OutputType string `yaml:"output_type"`
RequestsPerSecond float64 `yaml:"requests_per_second"`
BurstLimit int `yaml:"burst_limit"`
} }
type URLConfig struct { type SiteConfig struct {
URL string `yaml:"url"` BaseURL string `yaml:"base_url"`
CSSLocator string `yaml:"css_locator"` CSSLocator string `yaml:"css_locator"`
ExcludeSelectors []string `yaml:"exclude_selectors"` ExcludeSelectors []string `yaml:"exclude_selectors"`
OutputAlias string `yaml:"output_alias"` MaxDepth int `yaml:"max_depth"`
AllowedPaths []string `yaml:"allowed_paths"`
ExcludePaths []string `yaml:"exclude_paths"`
OutputAlias string `yaml:"output_alias"`
PathOverrides []PathOverride `yaml:"path_overrides"`
}
type PathOverride struct {
Path string `yaml:"path"`
CSSLocator string `yaml:"css_locator"`
ExcludeSelectors []string `yaml:"exclude_selectors"`
} }
func Load(configPath string) (*Config, error) { func Load(configPath string) (*Config, error) {

View File

@@ -0,0 +1,120 @@
package config
import (
"os"
"reflect"
"testing"
)
func TestLoad(t *testing.T) {
// Create a temporary config file
content := []byte(`
file_types:
- go
- md
ignore:
- "*.tmp"
- "**/*.log"
code_generated:
- "generated_*.go"
scrape:
sites:
- base_url: "https://example.com"
css_locator: "main"
exclude_selectors:
- ".ads"
max_depth: 2
allowed_paths:
- "/blog"
exclude_paths:
- "/admin"
output_alias: "example"
path_overrides:
- path: "/special"
css_locator: ".special-content"
exclude_selectors:
- ".sidebar"
output_type: "single"
requests_per_second: 1.0
burst_limit: 5
`)
tmpfile, err := os.CreateTemp("", "config*.yml")
if err != nil {
t.Fatalf("Failed to create temp file: %v", err)
}
defer os.Remove(tmpfile.Name())
if _, err := tmpfile.Write(content); err != nil {
t.Fatalf("Failed to write to temp file: %v", err)
}
if err := tmpfile.Close(); err != nil {
t.Fatalf("Failed to close temp file: %v", err)
}
// Test loading the config
config, err := Load(tmpfile.Name())
if err != nil {
t.Fatalf("Load() failed: %v", err)
}
// Check if the loaded config matches the expected values
expectedConfig := &Config{
FileTypes: []string{"go", "md"},
Ignore: []string{"*.tmp", "**/*.log"},
CodeGenerated: []string{"generated_*.go"},
Scrape: ScrapeConfig{
Sites: []SiteConfig{
{
BaseURL: "https://example.com",
CSSLocator: "main",
ExcludeSelectors: []string{".ads"},
MaxDepth: 2,
AllowedPaths: []string{"/blog"},
ExcludePaths: []string{"/admin"},
OutputAlias: "example",
PathOverrides: []PathOverride{
{
Path: "/special",
CSSLocator: ".special-content",
ExcludeSelectors: []string{".sidebar"},
},
},
},
},
OutputType: "single",
RequestsPerSecond: 1.0,
BurstLimit: 5,
},
}
if !reflect.DeepEqual(config, expectedConfig) {
t.Errorf("Loaded config does not match expected config.\nGot: %+v\nWant: %+v", config, expectedConfig)
}
}
func TestDefaultConfigPath(t *testing.T) {
expected := "rollup.yml"
result := DefaultConfigPath()
if result != expected {
t.Errorf("DefaultConfigPath() = %q, want %q", result, expected)
}
}
func TestFileExists(t *testing.T) {
// Test with an existing file
tmpfile, err := os.CreateTemp("", "testfile")
if err != nil {
t.Fatalf("Failed to create temp file: %v", err)
}
defer os.Remove(tmpfile.Name())
if !FileExists(tmpfile.Name()) {
t.Errorf("FileExists(%q) = false, want true", tmpfile.Name())
}
// Test with a non-existing file
if FileExists("non_existing_file.txt") {
t.Errorf("FileExists(\"non_existing_file.txt\") = true, want false")
}
}

View File

@@ -5,13 +5,18 @@ import (
"io/ioutil" "io/ioutil"
"log" "log"
"math/rand" "math/rand"
"net/url"
"os"
"regexp" "regexp"
"strings" "strings"
"time" "time"
"sync"
"context"
"github.com/PuerkitoBio/goquery" "github.com/PuerkitoBio/goquery"
"github.com/playwright-community/playwright-go" "github.com/playwright-community/playwright-go"
md "github.com/JohannesKaufmann/html-to-markdown" md "github.com/JohannesKaufmann/html-to-markdown"
"golang.org/x/time/rate"
) )
var logger *log.Logger var logger *log.Logger
@@ -23,57 +28,240 @@ var (
// Config holds the scraper configuration // Config holds the scraper configuration
type Config struct { type Config struct {
URLs []URLConfig Sites []SiteConfig
OutputType string OutputType string
Verbose bool Verbose bool
Scrape ScrapeConfig
} }
// ScrapeMultipleURLs scrapes multiple URLs concurrently // ScrapeConfig holds the scraping-specific configuration
func ScrapeMultipleURLs(config Config) (map[string]string, error) { type ScrapeConfig struct {
results := make(chan struct { RequestsPerSecond float64
url string BurstLimit int
content string
err error
}, len(config.URLs))
for _, urlConfig := range config.URLs {
go func(cfg URLConfig) {
content, err := scrapeURL(cfg)
results <- struct {
url string
content string
err error
}{cfg.URL, content, err}
}(urlConfig)
}
scrapedContent := make(map[string]string)
for i := 0; i < len(config.URLs); i++ {
result := <-results
if result.err != nil {
logger.Printf("Error scraping %s: %v\n", result.url, result.err)
continue
}
scrapedContent[result.url] = result.content
}
return scrapedContent, nil
} }
func scrapeURL(config URLConfig) (string, error) { // SiteConfig holds configuration for a single site
content, err := FetchWebpageContent(config.URL) type SiteConfig struct {
if err != nil { BaseURL string
return "", err CSSLocator string
} ExcludeSelectors []string
MaxDepth int
AllowedPaths []string
ExcludePaths []string
OutputAlias string
PathOverrides []PathOverride
}
if config.CSSLocator != "" { // PathOverride holds path-specific overrides
content, err = ExtractContentWithCSS(content, config.CSSLocator, config.ExcludeSelectors) type PathOverride struct {
if err != nil { Path string
return "", err CSSLocator string
} ExcludeSelectors []string
} }
return ProcessHTMLContent(content, Config{}) func ScrapeSites(config Config) (map[string]string, error) {
logger.Println("Starting ScrapeSites function - Verbose mode is active")
results := make(chan struct {
url string
content string
err error
})
limiter := rate.NewLimiter(rate.Limit(config.Scrape.RequestsPerSecond), config.Scrape.BurstLimit)
logger.Printf("Rate limiter configured with %f requests per second and burst limit of %d\n", config.Scrape.RequestsPerSecond, config.Scrape.BurstLimit)
var wg sync.WaitGroup
totalURLs := 0
for _, site := range config.Sites {
logger.Printf("Processing site: %s\n", site.BaseURL)
wg.Add(1)
go func(site SiteConfig) {
defer wg.Done()
for _, path := range site.AllowedPaths {
fullURL := site.BaseURL + path
totalURLs++
logger.Printf("Queueing URL for scraping: %s\n", fullURL)
scrapeSingleURL(fullURL, site, config, results, limiter)
}
}(site)
}
go func() {
wg.Wait()
close(results)
logger.Println("All goroutines completed, results channel closed")
}()
scrapedContent := make(map[string]string)
for result := range results {
if result.err != nil {
logger.Printf("Error scraping %s: %v\n", result.url, result.err)
continue
}
logger.Printf("Successfully scraped content from %s (length: %d)\n", result.url, len(result.content))
scrapedContent[result.url] = result.content
}
logger.Printf("Total URLs processed: %d\n", totalURLs)
logger.Printf("Successfully scraped content from %d URLs\n", len(scrapedContent))
return scrapedContent, nil
}
func scrapeSingleURL(url string, site SiteConfig, config Config, results chan<- struct {
url string
content string
err error
}, limiter *rate.Limiter) {
logger.Printf("Starting to scrape URL: %s\n", url)
// Wait for rate limiter before making the request
err := limiter.Wait(context.Background())
if err != nil {
logger.Printf("Rate limiter error for %s: %v\n", url, err)
results <- struct {
url string
content string
err error
}{url, "", fmt.Errorf("rate limiter error: %v", err)}
return
}
cssLocator, excludeSelectors := getOverrides(url, site)
logger.Printf("Using CSS locator for %s: %s\n", url, cssLocator)
logger.Printf("Exclude selectors for %s: %v\n", url, excludeSelectors)
content, err := scrapeURL(url, cssLocator, excludeSelectors)
if err != nil {
logger.Printf("Error scraping %s: %v\n", url, err)
results <- struct {
url string
content string
err error
}{url, "", err}
return
}
if content == "" {
logger.Printf("Warning: Empty content scraped from %s\n", url)
} else {
logger.Printf("Successfully scraped content from %s (length: %d)\n", url, len(content))
}
results <- struct {
url string
content string
err error
}{url, content, nil}
}
func scrapeSite(site SiteConfig, config Config, results chan<- struct {
url string
content string
err error
}, limiter *rate.Limiter) {
visited := make(map[string]bool)
queue := []string{site.BaseURL}
for len(queue) > 0 {
url := queue[0]
queue = queue[1:]
if visited[url] {
continue
}
visited[url] = true
if !isAllowedURL(url, site) {
continue
}
// Wait for rate limiter before making the request
err := limiter.Wait(context.Background())
if err != nil {
results <- struct {
url string
content string
err error
}{url, "", fmt.Errorf("rate limiter error: %v", err)}
continue
}
cssLocator, excludeSelectors := getOverrides(url, site)
content, err := scrapeURL(url, cssLocator, excludeSelectors)
results <- struct {
url string
content string
err error
}{url, content, err}
if len(visited) < site.MaxDepth {
links, _ := ExtractLinks(url)
for _, link := range links {
if !visited[link] && isAllowedURL(link, site) {
queue = append(queue, link)
}
}
}
}
}
func isAllowedURL(urlStr string, site SiteConfig) bool {
parsedURL, err := url.Parse(urlStr)
if err != nil {
return false
}
baseURL, _ := url.Parse(site.BaseURL)
if parsedURL.Host != baseURL.Host {
return false
}
path := parsedURL.Path
for _, allowedPath := range site.AllowedPaths {
if strings.HasPrefix(path, allowedPath) {
for _, excludePath := range site.ExcludePaths {
if strings.HasPrefix(path, excludePath) {
return false
}
}
return true
}
}
return false
}
func getOverrides(urlStr string, site SiteConfig) (string, []string) {
parsedURL, _ := url.Parse(urlStr)
path := parsedURL.Path
for _, override := range site.PathOverrides {
if strings.HasPrefix(path, override.Path) {
if override.CSSLocator != "" {
return override.CSSLocator, override.ExcludeSelectors
}
return site.CSSLocator, override.ExcludeSelectors
}
}
return site.CSSLocator, site.ExcludeSelectors
}
func scrapeURL(url, cssLocator string, excludeSelectors []string) (string, error) {
content, err := FetchWebpageContent(url)
if err != nil {
return "", err
}
if cssLocator != "" {
content, err = ExtractContentWithCSS(content, cssLocator, excludeSelectors)
if err != nil {
return "", err
}
}
return ProcessHTMLContent(content, Config{})
} }
func getFilenameFromContent(content, url string) string { func getFilenameFromContent(content, url string) string {
@@ -106,7 +294,7 @@ type URLConfig struct {
// SetupLogger initializes the logger based on the verbose flag // SetupLogger initializes the logger based on the verbose flag
func SetupLogger(verbose bool) { func SetupLogger(verbose bool) {
if verbose { if verbose {
logger = log.New(log.Writer(), "SCRAPER: ", log.LstdFlags) logger = log.New(os.Stdout, "SCRAPER: ", log.LstdFlags)
} else { } else {
logger = log.New(ioutil.Discard, "", 0) logger = log.New(ioutil.Discard, "", 0)
} }

View File

@@ -0,0 +1,169 @@
package scraper
import (
"testing"
"net/http"
"net/http/httptest"
"strings"
)
func TestIsAllowedURL(t *testing.T) {
site := SiteConfig{
BaseURL: "https://example.com",
AllowedPaths: []string{"/blog", "/products"},
ExcludePaths: []string{"/admin", "/private"},
}
tests := []struct {
url string
expected bool
}{
{"https://example.com/blog/post1", true},
{"https://example.com/products/item1", true},
{"https://example.com/admin/dashboard", false},
{"https://example.com/private/data", false},
{"https://example.com/other/page", false},
{"https://othersite.com/blog/post1", false},
}
for _, test := range tests {
result := isAllowedURL(test.url, site)
if result != test.expected {
t.Errorf("isAllowedURL(%q) = %v, want %v", test.url, result, test.expected)
}
}
}
func TestGetOverrides(t *testing.T) {
site := SiteConfig{
CSSLocator: "main",
ExcludeSelectors: []string{".ads"},
PathOverrides: []PathOverride{
{
Path: "/special",
CSSLocator: ".special-content",
ExcludeSelectors: []string{".sidebar"},
},
},
}
tests := []struct {
url string
expectedLocator string
expectedExcludes []string
}{
{"https://example.com/normal", "main", []string{".ads"}},
{"https://example.com/special", ".special-content", []string{".sidebar"}},
{"https://example.com/special/page", ".special-content", []string{".sidebar"}},
}
for _, test := range tests {
locator, excludes := getOverrides(test.url, site)
if locator != test.expectedLocator {
t.Errorf("getOverrides(%q) locator = %q, want %q", test.url, locator, test.expectedLocator)
}
if !reflect.DeepEqual(excludes, test.expectedExcludes) {
t.Errorf("getOverrides(%q) excludes = %v, want %v", test.url, excludes, test.expectedExcludes)
}
}
}
func TestExtractContentWithCSS(t *testing.T) {
html := `
<html>
<body>
<main>
<h1>Main Content</h1>
<p>This is the main content.</p>
<div class="ads">Advertisement</div>
</main>
<aside>Sidebar content</aside>
</body>
</html>
`
tests := []struct {
includeSelector string
excludeSelectors []string
expected string
}{
{"main", nil, "<h1>Main Content</h1>\n<p>This is the main content.</p>\n<div class=\"ads\">Advertisement</div>"},
{"main", []string{".ads"}, "<h1>Main Content</h1>\n<p>This is the main content.</p>"},
{"aside", nil, "Sidebar content"},
}
for _, test := range tests {
result, err := ExtractContentWithCSS(html, test.includeSelector, test.excludeSelectors)
if err != nil {
t.Errorf("ExtractContentWithCSS() returned error: %v", err)
continue
}
if strings.TrimSpace(result) != strings.TrimSpace(test.expected) {
t.Errorf("ExtractContentWithCSS() = %q, want %q", result, test.expected)
}
}
}
func TestProcessHTMLContent(t *testing.T) {
html := `
<html>
<body>
<h1>Test Heading</h1>
<p>This is a <strong>test</strong> paragraph.</p>
<ul>
<li>Item 1</li>
<li>Item 2</li>
</ul>
</body>
</html>
`
expected := strings.TrimSpace(`
# Test Heading
This is a **test** paragraph.
- Item 1
- Item 2
`)
result, err := ProcessHTMLContent(html, Config{})
if err != nil {
t.Fatalf("ProcessHTMLContent() returned error: %v", err)
}
if strings.TrimSpace(result) != expected {
t.Errorf("ProcessHTMLContent() = %q, want %q", result, expected)
}
}
func TestExtractLinks(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "text/html")
w.Write([]byte(`
<html>
<body>
<a href="https://example.com/page1">Page 1</a>
<a href="https://example.com/page2">Page 2</a>
<a href="https://othersite.com">Other Site</a>
</body>
</html>
`))
}))
defer server.Close()
links, err := ExtractLinks(server.URL)
if err != nil {
t.Fatalf("ExtractLinks() returned error: %v", err)
}
expectedLinks := []string{
"https://example.com/page1",
"https://example.com/page2",
"https://othersite.com",
}
if !reflect.DeepEqual(links, expectedLinks) {
t.Errorf("ExtractLinks() = %v, want %v", links, expectedLinks)
}
}