Add LSP tests for definition / type definition

private/buf/buflsp/definition_test.go

@@ -0,0 +1,199 @@
+// Copyright 2020-2025 Buf Technologies, Inc.
+//
+// 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 buflsp_test
+
+import (
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.lsp.dev/protocol"
+	"go.lsp.dev/uri"
+)
+
+func TestDefinition(t *testing.T) {
+	t.Parallel()
+
+	ctx := t.Context()
+
+	testProtoPath, err := filepath.Abs("testdata/definition/definition.proto")
+	require.NoError(t, err)
+
+	typesProtoPath, err := filepath.Abs("testdata/definition/types.proto")
+	require.NoError(t, err)
+
+	clientJSONConn, testURI := setupLSPServer(t, testProtoPath)
+	typesURI := uri.New(typesProtoPath)
+
+	tests := []struct {
+		name               string
+		line               uint32
+		character          uint32
+		expectedDefURI     protocol.URI
+		expectedDefLine    uint32
+		expectedDefCharMin uint32
+		expectedDefCharMax uint32
+		expectNoDefinition bool
+	}{
+		{
+			name:               "definition_of_account_type_reference",
+			line:               12, // Line with "AccountType type = 2;"
+			character:          2,  // On "AccountType" type
+			expectedDefURI:     testURI,
+			expectedDefLine:    49, // enum AccountType definition
+			expectedDefCharMin: 5,
+			expectedDefCharMax: 16,
+		},
+		{
+			name:               "definition_of_person_type_reference",
+			line:               15, // Line with "Person owner = 3;"
+			character:          2,  // On "Person" type
+			expectedDefURI:     testURI,
+			expectedDefLine:    25, // message Person definition
+			expectedDefCharMin: 8,
+			expectedDefCharMax: 14,
+		},
+		{
+			name:               "definition_of_address_type_reference",
+			line:               33, // Line with "Address address = 3;"
+			character:          2,  // On "Address" type
+			expectedDefURI:     testURI,
+			expectedDefLine:    37, // message Address definition
+			expectedDefCharMin: 8,
+			expectedDefCharMax: 15,
+		},
+		{
+			name:               "definition_of_country_code_reference",
+			line:               45, // Line with "CountryCode country = 3;"
+			character:          2,  // On "CountryCode" type
+			expectedDefURI:     testURI,
+			expectedDefLine:    61, // enum CountryCode definition
+			expectedDefCharMin: 5,
+			expectedDefCharMax: 16,
+		},
+		{
+			name:               "definition_of_rpc_request_type",
+			line:               75, // Line with "rpc GetAccount(GetAccountRequest)"
+			character:          18, // On "GetAccountRequest"
+			expectedDefURI:     testURI,
+			expectedDefLine:    82, // message GetAccountRequest definition
+			expectedDefCharMin: 8,
+			expectedDefCharMax: 25,
+		},
+		{
+			name:               "definition_of_rpc_response_type",
+			line:               75, // Line with "returns (GetAccountResponse)"
+			character:          45, // On "GetAccountResponse"
+			expectedDefURI:     testURI,
+			expectedDefLine:    88, // message GetAccountResponse definition
+			expectedDefCharMin: 8,
+			expectedDefCharMax: 26,
+		},
+		{
+			name:               "definition_of_account_field_in_request",
+			line:               96, // Line with "Account account = 1;" in CreateAccountRequest
+			character:          2,  // On "Account" type
+			expectedDefURI:     testURI,
+			expectedDefLine:    7, // message Account definition
+			expectedDefCharMin: 8,
+			expectedDefCharMax: 15,
+		},
+		{
+			name:               "definition_of_field_name",
+			line:               12, // Line with "AccountType type = 2;"
+			character:          14, // On "type" field name
+			expectedDefURI:     testURI,
+			expectedDefLine:    12,
+			expectedDefCharMin: 14,
+			expectedDefCharMax: 18,
+		},
+		{
+			name:               "definition_of_service",
+			line:               73, // Line with "service AccountService {"
+			character:          8,  // On "AccountService"
+			expectedDefURI:     testURI,
+			expectedDefLine:    73,
+			expectedDefCharMin: 8,
+			expectedDefCharMax: 22,
+		},
+		{
+			name:               "definition_of_status_imported_type",
+			line:               18, // Line with "Status status = 4;"
+			character:          2,  // On "Status" type
+			expectedDefURI:     typesURI,
+			expectedDefLine:    5, // enum Status definition in types.proto
+			expectedDefCharMin: 5,
+			expectedDefCharMax: 11,
+		},
+		{
+			name:               "definition_of_timestamp_imported_type",
+			line:               21, // Line with "Timestamp created_at = 5;"
+			character:          2,  // On "Timestamp" type
+			expectedDefURI:     typesURI,
+			expectedDefLine:    17, // message Timestamp definition in types.proto
+			expectedDefCharMin: 8,
+			expectedDefCharMax: 17,
+		},
+		{
+			name:               "definition_of_syntax_keyword",
+			line:               0, // Line with "syntax = "proto3";"
+			character:          0, // On "syntax"
+			expectNoDefinition: true,
+		},
+		{
+			name:               "definition_of_package_keyword",
+			line:               2, // Line with "package definition.v1;"
+			character:          0, // On "package"
+			expectNoDefinition: true,
+		},
+		{
+			name:               "definition_of_package_name",
+			line:               2, // Line with "package definition.v1;"
+			character:          8, // On "definition"
+			expectNoDefinition: true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+			var locations []protocol.Location
+			_, defErr := clientJSONConn.Call(ctx, protocol.MethodTextDocumentDefinition, protocol.DefinitionParams{
+				TextDocumentPositionParams: protocol.TextDocumentPositionParams{
+					TextDocument: protocol.TextDocumentIdentifier{
+						URI: testURI,
+					},
+					Position: protocol.Position{
+						Line:      tt.line,
+						Character: tt.character,
+					},
+				},
+			}, &locations)
+			require.NoError(t, defErr)
+
+			if tt.expectNoDefinition {
+				assert.Empty(t, locations, "expected no definition locations")
+			} else {
+				require.Len(t, locations, 1, "expected exactly one definition location")
+				location := locations[0]
+				assert.Equal(t, tt.expectedDefURI, location.URI)
+				assert.Equal(t, tt.expectedDefLine, location.Range.Start.Line)
+				assert.GreaterOrEqual(t, location.Range.Start.Character, tt.expectedDefCharMin)
+				assert.LessOrEqual(t, location.Range.Start.Character, tt.expectedDefCharMax)
+			}
+		})
+	}
+}

private/buf/buflsp/hover_test.go

@@ -26,10 +26,6 @@ import (
 func TestHover(t *testing.T) {
 	t.Parallel()
 
-	// if runtime.GOOS == "windows" {
-	// 	t.Skip("Skipping on Windows")
-	// }
-
 	ctx := t.Context()
 
 	testProtoPath, err := filepath.Abs("testdata/hover/test.proto")

private/buf/buflsp/testdata/definition/buf.yaml

@@ -0,0 +1,9 @@
+version: v2
+modules:
+  - path: .
+lint:
+  use:
+    - STANDARD
+breaking:
+  use:
+    - FILE

private/buf/buflsp/testdata/definition/definition.proto

@@ -0,0 +1,107 @@
+syntax = "proto3";
+
+package definition.v1;
+
+import "types.proto";
+
+// Account represents a user account.
+message Account {
+  // The account ID.
+  string id = 1;
+
+  // The account type.
+  AccountType type = 2;
+
+  // The account owner.
+  Person owner = 3;
+
+  // The account status.
+  Status status = 4;
+
+  // The creation timestamp.
+  Timestamp created_at = 5;
+}
+
+// Person represents an individual.
+message Person {
+  // The person's name.
+  string name = 1;
+
+  // The person's email.
+  string email = 2;
+
+  // The person's address.
+  Address address = 3;
+}
+
+// Address represents a physical address.
+message Address {
+  // The street address.
+  string street = 1;
+
+  // The city.
+  string city = 2;
+
+  // The country code.
+  CountryCode country = 3;
+}
+
+// AccountType represents the type of account.
+enum AccountType {
+  // The account type is not specified.
+  ACCOUNT_TYPE_UNSPECIFIED = 0;
+
+  // A personal account.
+  ACCOUNT_TYPE_PERSONAL = 1;
+
+  // A business account.
+  ACCOUNT_TYPE_BUSINESS = 2;
+}
+
+// CountryCode represents an ISO country code.
+enum CountryCode {
+  // The country code is not specified.
+  COUNTRY_CODE_UNSPECIFIED = 0;
+
+  // United States.
+  COUNTRY_CODE_US = 1;
+
+  // Canada.
+  COUNTRY_CODE_CA = 2;
+}
+
+// AccountService provides operations for managing accounts.
+service AccountService {
+  // GetAccount retrieves an account by ID.
+  rpc GetAccount(GetAccountRequest) returns (GetAccountResponse);
+
+  // CreateAccount creates a new account.
+  rpc CreateAccount(CreateAccountRequest) returns (CreateAccountResponse);
+}
+
+// GetAccountRequest is the request for GetAccount.
+message GetAccountRequest {
+  // The account ID to retrieve.
+  string account_id = 1;
+}
+
+// GetAccountResponse is the response for GetAccount.
+message GetAccountResponse {
+  // The retrieved account.
+  Account account = 1;
+}
+
+// CreateAccountRequest is the request for CreateAccount.
+message CreateAccountRequest {
+  // The account to create.
+  Account account = 1;
+
+  // The account type.
+  AccountType type = 2;
+}
+
+// CreateAccountResponse is the response for CreateAccount.
+message CreateAccountResponse {
+  // The created account.
+  Account account = 1;
+}

private/buf/buflsp/testdata/definition/types.proto

@@ -0,0 +1,24 @@
+syntax = "proto3";
+
+package definition.v1;
+
+// Status represents the status of an entity.
+enum Status {
+  // The status is not specified.
+  STATUS_UNSPECIFIED = 0;
+
+  // The entity is active.
+  STATUS_ACTIVE = 1;
+
+  // The entity is inactive.
+  STATUS_INACTIVE = 2;
+}
+
+// Timestamp represents a point in time.
+message Timestamp {
+  // Seconds since epoch.
+  int64 seconds = 1;
+
+  // Nanoseconds.
+  int32 nanos = 2;
+}

private/buf/buflsp/testdata/type_definition/buf.yaml

@@ -0,0 +1,9 @@
+version: v2
+modules:
+  - path: .
+lint:
+  use:
+    - STANDARD
+breaking:
+  use:
+    - FILE