Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

11.2 KB
Raw Blame
//
//  Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
//

package tool

import (
	"encoding/json"
	"net/http"
	"net/http/httptest"
	"net/url"
	"strings"
	"testing"

	"ragflow/internal/tokenizer"
)

const cannedScholarHTML = `<html><body>
<div class="gs_r gs_or gs_scl" style="display:none"></div>
<div class="gs_r">
  <div class="gs_ri">
    <h3 class="gs_rt">
      <a href="https://example.com/paper1">Attention is all you need</a>
    </h3>
    <div class="gs_a">Ashish Vaswani, Noam Shazeer, Niki Parmar - NeurIPS 2017</div>
    <div class="gs_rs">The dominant sequence transduction models are based on complex recurrent or convolutional neural networks.</div>
  </div>
</div>
<div class="gs_r">
  <div class="gs_ri">
    <h3 class="gs_rt">
      <a href="https://example.com/paper2">BERT: Pre-training of Deep Bidirectional Transformers</a>
    </h3>
    <div class="gs_a">Jacob Devlin, Ming-Wei Chang - NAACL 2019</div>
    <div class="gs_rs">We introduce a new language representation model called BERT.</div>
  </div>
</div>
</body></html>`

func TestGoogleScholar_BuildURL(t *testing.T) {
	t.Parallel()

	cases := []struct {
		name       string
		query      string
		topN       int
		sortBy     string
		yearLow    int
		yearHigh   int
		patents    *bool
		wantNum    string
		wantHost   string
		wantQuery  string
		wantParams map[string]string
	}{
		{
			name:      "default",
			query:     "transformer",
			wantNum:   "12",
			wantHost:  "scholar.google.com",
			wantQuery: "transformer",
		},
		{
			name:      "explicit high",
			query:     "x",
			topN:      99,
			wantNum:   "99",
			wantHost:  "scholar.google.com",
			wantQuery: "x",
		},
		{
			name:      "explicit",
			query:     "a b",
			topN:      3,
			wantNum:   "3",
			wantHost:  "scholar.google.com",
			wantQuery: "a b",
		},
		{
			name:       "sort by date",
			query:      "test",
			topN:       5,
			sortBy:     "date",
			wantNum:    "5",
			wantHost:   "scholar.google.com",
			wantQuery:  "test",
			wantParams: map[string]string{"scisbd": "1"},
		},
		{
			name:       "year range",
			query:      "ml",
			topN:       10,
			yearLow:    2020,
			yearHigh:   2024,
			wantNum:    "10",
			wantHost:   "scholar.google.com",
			wantQuery:  "ml",
			wantParams: map[string]string{"as_ylo": "2020", "as_yhi": "2024"},
		},
		{
			name:       "exclude patents",
			query:      "ai",
			topN:       5,
			patents:    boolPtr(false),
			wantNum:    "5",
			wantHost:   "scholar.google.com",
			wantQuery:  "ai",
			wantParams: map[string]string{"as_sdt": "1,33", "as_vis": ""},
		},
		{
			name:      "include patents (default)",
			query:     "nlp",
			topN:      5,
			patents:   boolPtr(true),
			wantNum:   "5",
			wantHost:  "scholar.google.com",
			wantQuery: "nlp",
		},
		{
			name:      "all params combined",
			query:     "deep learning",
			topN:      8,
			sortBy:    "date",
			yearLow:   2019,
			yearHigh:  2023,
			patents:   boolPtr(false),
			wantNum:   "8",
			wantHost:  "scholar.google.com",
			wantQuery: "deep learning",
			wantParams: map[string]string{
				"scisbd": "1",
				"as_ylo": "2019",
				"as_yhi": "2023",
				"as_sdt": "1,33",
				"as_vis": "",
			},
		},
	}
	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			t.Parallel()
			got := buildGoogleScholarURL(tc.query, tc.topN, tc.sortBy, tc.yearLow, tc.yearHigh, tc.patents)
			u, err := url.Parse(got)
			if err != nil {
				t.Fatalf("url.Parse(%q): %v", got, err)
			}
			if u.Host != tc.wantHost {
				t.Errorf("host = %q, want %q", u.Host, tc.wantHost)
			}
			if u.Path != "/scholar" {
				t.Errorf("path = %q, want /scholar", u.Path)
			}
			q := u.Query()
			if q.Get("q") != tc.wantQuery {
				t.Errorf("q = %q, want %q", q.Get("q"), tc.wantQuery)
			}
			if q.Get("num") != tc.wantNum {
				t.Errorf("num = %q, want %q", q.Get("num"), tc.wantNum)
			}
			for k, v := range tc.wantParams {
				if q.Get(k) != v {
					t.Errorf("%s = %q, want %q", k, q.Get(k), v)
				}
			}
		})
	}
}

func TestGoogleScholar_ParseResults(t *testing.T) {
	t.Parallel()
	ctx := t.Context()

	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.Header().Set("Content-Type", "text/html; charset=UTF-8")
		_, _ = w.Write([]byte(cannedScholarHTML))
	}))
	defer srv.Close()

	helper := NewHTTPHelper().WithClient(&http.Client{
		Transport: rewriteHostTransport(srv.URL),
	})
	tool := NewGoogleScholarToolWith(helper)
	out, err := tool.InvokableRun(ctx,
		`{"query":"transformer","top_n":5,"sort_by":"relevance","year_low":2020,"year_high":2024,"patents":true}`)
	if err != nil {
		t.Fatalf("InvokableRun: %v", err)
	}

	var env googleScholarEnvelope
	if jerr := json.Unmarshal([]byte(out), &env); jerr != nil {
		t.Fatalf("output is not valid JSON: %v (raw=%s)", jerr, out)
	}
	if env.Error != "" {
		t.Errorf("Error = %q, want empty", env.Error)
	}
	if len(env.Results) != 2 {
		t.Fatalf("Results len = %d, want 2", len(env.Results))
	}
	if !strings.Contains(env.Results[0].Title, "Attention") {
		t.Errorf("Results[0].Title = %q, want to contain Attention", env.Results[0].Title)
	}
	if env.Results[0].Link != "https://example.com/paper1" {
		t.Errorf("Results[0].Link = %q, want https://example.com/paper1", env.Results[0].Link)
	}
	if !strings.Contains(env.Results[0].Authors, "Vaswani") {
		t.Errorf("Results[0].Authors = %q, want to contain Vaswani", env.Results[0].Authors)
	}
	if env.Results[0].Year != "2017" {
		t.Errorf("Results[0].Year = %q, want 2017", env.Results[0].Year)
	}
	if !strings.Contains(env.Results[0].Snippet, "sequence transduction") {
		t.Errorf("Results[0].Snippet = %q, want snippet", env.Results[0].Snippet)
	}
	if env.Results[1].Year != "2019" {
		t.Errorf("Results[1].Year = %q, want 2019", env.Results[1].Year)
	}
}

func TestGoogleScholar_EmptyQuery(t *testing.T) {
	t.Parallel()
	ctx := t.Context()

	tool := NewGoogleScholarTool()
	out, err := tool.InvokableRun(ctx, `{"query":""}`)
	if err != nil {
		t.Fatalf("InvokableRun(empty): %v", err)
	}
	var envelope googleScholarEnvelope
	if err = json.Unmarshal([]byte(out), &envelope); err != nil || len(envelope.Results) != 0 {
		t.Fatalf("empty result = %s / %v", out, err)
	}
}

func TestGoogleScholar_Info(t *testing.T) {
	t.Parallel()
	ctx := t.Context()

	tool := NewGoogleScholarTool()
	info, err := tool.Info(ctx)
	if err != nil {
		t.Fatalf("Info: %v", err)
	}
	if info.Name != "google_scholar_search" {
		t.Errorf("Name = %q, want google_scholar_search", info.Name)
	}
	if !strings.Contains(info.Desc, "Scholar") {
		t.Errorf("Desc = %q, want to mention Scholar", info.Desc)
	}
}

func TestGoogleScholar_ComponentReferencesAndValidation(t *testing.T) {
	t.Parallel()
	ctx := t.Context()

	built, err := BuildByName("google_scholar", map[string]any{
		"top_n":    float64(7),
		"sort_by":  "date",
		"year_low": float64(2020),
		"patents":  false,
		"outputs":  map[string]any{"json": map[string]any{}},
	})
	if err != nil {
		t.Fatalf("BuildByName: %v", err)
	}
	scholar := built.(*GoogleScholarTool)
	if scholar.defaults.TopN != 7 || scholar.defaults.SortBy != "date" || scholar.defaults.YearLow != 2020 || scholar.defaults.Patents == nil || *scholar.defaults.Patents {
		t.Fatalf("defaults = %+v", scholar.defaults)
	}
	for _, params := range []map[string]any{{"top_n": 0}, {"top_n": 1.5}, {"sort_by": "newest"}, {"patents": "yes"}} {
		if _, err := BuildByName("google_scholar", params); err == nil {
			t.Fatalf("BuildByName(%#v) succeeded", params)
		}
	}
	spec := scholar.ComponentSpec()
	if query, ok := spec.InputForm["query"].(map[string]any); !ok || query["type"] != "line" {
		t.Fatalf("query input form = %#v", spec.InputForm["query"])
	}
	envelope := map[string]any{"results": []any{map[string]any{
		"title": "Paper", "link": "https://paper.example", "authors": "A Author", "year": "2024", "snippet": "Abstract",
	}}}
	chunks, docAggs := scholar.BuildReferences(ctx, envelope)
	if len(chunks) != 1 || len(docAggs) != 1 || !strings.Contains(chunks[0]["content"].(string), "Authors: A Author") {
		t.Fatalf("references = %#v / %#v", chunks, docAggs)
	}
	outputs := scholar.BuildComponentOutputs(envelope)
	if results, ok := outputs["json"].([]any); !ok || len(results) != 1 {
		t.Fatalf("json output = %#v", outputs["json"])
	}
	if !strings.Contains(outputs["formalized_content"].(string), "Snippet: Abstract") {
		t.Fatalf("formalized_content = %q", outputs["formalized_content"])
	}
	if _, exists := envelope["chunks"]; exists {
		t.Fatalf("output conversion mutated envelope: %#v", envelope)
	}
}

func TestRenderGoogleScholarReferencesStopsBeforeOverBudgetBlock(t *testing.T) {
	t.Parallel()

	chunks := []map[string]any{
		{"id": "1", "document_name": "First", "url": "https://first.example", "content": "first reference content"},
		{"id": "2", "document_name": "Second", "url": "https://second.example", "content": "second reference content"},
	}
	firstBlock := renderGoogleScholarReferences(chunks[:1], 0)
	firstTokens := tokenizer.NumTokensFromString(firstBlock)
	maxTokens := (firstTokens*100 + 96) / 97
	if got := renderGoogleScholarReferences(chunks, maxTokens); got != firstBlock {
		t.Fatalf("rendered = %q, want only first block %q", got, firstBlock)
	}
	if got := renderGoogleScholarReferences(chunks, 1); got != "" {
		t.Fatalf("over-budget first block was appended: %q", got)
	}
	if got := renderGoogleScholarReferences(chunks, 0); !strings.Contains(got, "Title: First") || !strings.Contains(got, "Title: Second") {
		t.Fatalf("unlimited rendering dropped blocks: %q", got)
	}
}

func TestGoogleScholar_MergesNodeLevelDefaults(t *testing.T) {
	t.Parallel()
	ctx := t.Context()

	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		q := r.URL.Query()
		if q.Get("q") != "rag" {
			t.Errorf("q = %q, want rag", q.Get("q"))
		}
		if q.Get("num") != "7" {
			t.Errorf("num = %q, want 7", q.Get("num"))
		}
		if q.Get("scisbd") != "1" {
			t.Errorf("scisbd = %q, want 1", q.Get("scisbd"))
		}
		if q.Get("as_ylo") != "2020" {
			t.Errorf("as_ylo = %q, want 2020", q.Get("as_ylo"))
		}
		if q.Get("as_yhi") != "2024" {
			t.Errorf("as_yhi = %q, want 2024", q.Get("as_yhi"))
		}
		if q.Get("as_sdt") != "1,33" {
			t.Errorf("as_sdt = %q, want 1,33", q.Get("as_sdt"))
		}
		if q.Has("as_vis") {
			t.Errorf("as_vis = %q, want unset", q.Get("as_vis"))
		}
		w.Header().Set("Content-Type", "text/html; charset=UTF-8")
		_, _ = w.Write([]byte(cannedScholarHTML))
	}))
	defer srv.Close()

	helper := NewHTTPHelper().WithClient(&http.Client{
		Transport: rewriteHostTransport(srv.URL),
	})
	tool := NewGoogleScholarToolWithDefaults(helper, googleScholarParams{
		Query:    "rag",
		TopN:     7,
		SortBy:   "date",
		YearLow:  2020,
		YearHigh: 2024,
		Patents:  boolPtr(false),
	})
	_, err := tool.InvokableRun(ctx, `{}`)
	if err != nil {
		t.Fatalf("InvokableRun with defaults: %v", err)
	}
}