search_test.go

// This file is part of arduino-cli.
//
// Copyright 2023 ARDUINO SA (http://www.arduino.cc/)
//
// This software is released under the GNU General Public License version 3,
// which covers the main part of arduino-cli.
// The terms of this license can be found at:
// https://www.gnu.org/licenses/gpl-3.0.en.html
//
// You can be released from the requirements of the above licenses by purchasing
// a commercial license. Buying such a license is mandatory if you want to
// modify or otherwise use the software for commercial activities involving the
// Arduino software without disclosing the source code of your own applications.
// To purchase a commercial license, send an email to license@arduino.cc.

package lib

import (
	"strings"
	"testing"

	"github.com/arduino/arduino-cli/arduino/libraries/librariesmanager"
	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
	paths "github.com/arduino/go-paths-helper"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

var customIndexPath = paths.New("testdata", "test1")
var fullIndexPath = paths.New("testdata", "full")
var qualifiedSearchIndexPath = paths.New("testdata", "qualified_search")

func TestSearchLibrary(t *testing.T) {
	lm := librariesmanager.NewLibraryManager(customIndexPath, nil)
	lm.LoadIndex()

	resp := searchLibrary(&rpc.LibrarySearchRequest{SearchArgs: "test"}, lm)
	assert := assert.New(t)
	assert.Equal(resp.GetStatus(), rpc.LibrarySearchStatus_LIBRARY_SEARCH_STATUS_SUCCESS)
	assert.Equal(len(resp.GetLibraries()), 2)
	assert.True(strings.Contains(resp.GetLibraries()[0].Name, "Test"))
	assert.True(strings.Contains(resp.GetLibraries()[1].Name, "Test"))
}

func TestSearchLibrarySimilar(t *testing.T) {
	lm := librariesmanager.NewLibraryManager(customIndexPath, nil)
	lm.LoadIndex()

	resp := searchLibrary(&rpc.LibrarySearchRequest{SearchArgs: "arduino"}, lm)
	assert := assert.New(t)
	assert.Equal(resp.GetStatus(), rpc.LibrarySearchStatus_LIBRARY_SEARCH_STATUS_SUCCESS)
	assert.Equal(len(resp.GetLibraries()), 2)
	libs := map[string]*rpc.SearchedLibrary{}
	for _, l := range resp.GetLibraries() {
		libs[l.Name] = l
	}
	assert.Contains(libs, "ArduinoTestPackage")
	assert.Contains(libs, "Arduino")
}

func TestSearchLibraryFields(t *testing.T) {
	lm := librariesmanager.NewLibraryManager(fullIndexPath, nil)
	lm.LoadIndex()

	query := func(q string) []string {
		libs := []string{}
		for _, lib := range searchLibrary(&rpc.LibrarySearchRequest{SearchArgs: q}, lm).Libraries {
			libs = append(libs, lib.Name)
		}
		return libs
	}

	res := query("SparkFun_u-blox_GNSS")
	require.Len(t, res, 3)
	require.Equal(t, "SparkFun u-blox Arduino Library", res[0])
	require.Equal(t, "SparkFun u-blox GNSS Arduino Library", res[1])
	require.Equal(t, "SparkFun u-blox SARA-R5 Arduino Library", res[2])

	res = query("SparkFun u-blox GNSS")
	require.Len(t, res, 3)
	require.Equal(t, "SparkFun u-blox Arduino Library", res[0])
	require.Equal(t, "SparkFun u-blox GNSS Arduino Library", res[1])
	require.Equal(t, "SparkFun u-blox SARA-R5 Arduino Library", res[2])

	res = query("painlessMesh")
	require.Len(t, res, 1)
	require.Equal(t, "Painless Mesh", res[0])

	res = query("cristian maglie")
	require.Len(t, res, 2)
	require.Equal(t, "Arduino_ConnectionHandler", res[0])
	require.Equal(t, "FlashStorage_SAMD", res[1])

	res = query("flashstorage")
	require.Len(t, res, 19)
	require.Equal(t, "FlashStorage", res[0])
}

func TestSearchLibraryWithQualifiers(t *testing.T) {
	lm := librariesmanager.NewLibraryManager(qualifiedSearchIndexPath, nil)
	lm.LoadIndex()

	query := func(q string) []string {
		libs := []string{}
		for _, lib := range searchLibrary(&rpc.LibrarySearchRequest{SearchArgs: q}, lm).Libraries {
			libs = append(libs, lib.Name)
		}
		return libs
	}

	res := query("mesh")
	require.Len(t, res, 4)

	res = query("name:Mesh")
	require.Len(t, res, 3)

	res = query("name=Mesh")
	require.Len(t, res, 0)

	// Space not in double-quoted string
	res = query("name=Painless Mesh")
	require.Len(t, res, 0)

	// Embedded space in double-quoted string
	res = query("name=\"Painless Mesh\"")
	require.Len(t, res, 1)
	require.Equal(t, "Painless Mesh", res[0])

	// No closing double-quote - still tokenizes with embedded space
	res = query("name:\"Painless Mesh")
	require.Len(t, res, 1)

	// Malformed double-quoted string with escaped first double-quote
	res = query("name:\\\"Painless Mesh\"")
	require.Len(t, res, 0)

	res = query("name:mesh author:TMRh20")
	require.Len(t, res, 1)
	require.Equal(t, "RF24Mesh", res[0])

	res = query("mesh dependencies:ArduinoJson")
	require.Len(t, res, 1)
	require.Equal(t, "Painless Mesh", res[0])

	res = query("architectures:esp author=\"Suraj I.\"")
	require.Len(t, res, 1)
	require.Equal(t, "esp8266-framework", res[0])

	res = query("mesh esp")
	require.Len(t, res, 2)

	res = query("mesh esp paragraph:wifi")
	require.Len(t, res, 1)
	require.Equal(t, "esp8266-framework", res[0])

	// Unknown qualifier should revert to original matching
	res = query("std::array")
	require.Len(t, res, 1)
	require.Equal(t, "Array", res[0])

	res = query("data storage")
	require.Len(t, res, 1)
	require.Equal(t, "Pushdata_ESP8266_SSL", res[0])

	res = query("category:\"data storage\"")
	require.Len(t, res, 1)
	require.Equal(t, "Array", res[0])

	res = query("maintainer:@")
	require.Len(t, res, 4)

	res = query("sentence:\"A library for NRF24L01(+) devices mesh.\"")
	require.Len(t, res, 1)
	require.Equal(t, "RF24Mesh", res[0])

	res = query("types=contributed")
	require.Len(t, res, 7)

	res = query("version:1.0")
	require.Len(t, res, 3)

	res = query("version=1.2.1")
	require.Len(t, res, 1)
	require.Equal(t, "Array", res[0])

	// Non-SSL URLs
	res = query("website:http://")
	require.Len(t, res, 1)
	require.Equal(t, "RF24Mesh", res[0])

	// Literal double-quote
	res = query("sentence:\\\"")
	require.Len(t, res, 1)
	require.Equal(t, "RTCtime", res[0])

	res = query("license=MIT")
	require.Len(t, res, 2)

	// Empty string
	res = query("license=\"\"")
	require.Len(t, res, 5)

	res = query("provides:painlessmesh.h")
	require.Len(t, res, 1)
	require.Equal(t, "Painless Mesh", res[0])
}