fix go to definition for local orbs

CircleCI-Public · Feb 1, 2024 · 43d9397 · 43d9397
1 parent efe1bb0
commit 43d9397
Show file tree

Hide file tree

Showing 4 changed files with 96 additions and 0 deletions.
diff --git a/pkg/ast/orb.go b/pkg/ast/orb.go
@@ -47,6 +47,7 @@ type OrbInfo struct {
 }
 
 type OrbParsedAttributes struct {
+	URI  protocol.URI
 	Name string
 
 	Commands           map[string]Command

diff --git a/pkg/parser/local_orb.go b/pkg/parser/local_orb.go
@@ -69,6 +69,7 @@ func (doc *YamlDocument) parseLocalOrb(name string, orbNode *sitter.Node, adding
 		Source:      orbContent,
 		Description: orbDoc.Description,
 		OrbParsedAttributes: ast.OrbParsedAttributes{
+			URI:  doc.URI,
 			Name: name,
 
 			Commands:           orbDoc.Commands,

diff --git a/pkg/parser/yamlparser.go b/pkg/parser/yamlparser.go
@@ -629,6 +629,7 @@ func (doc *YamlDocument) ToOrbParsedAttributes() ast.OrbParsedAttributes {
 
 func (doc *YamlDocument) FromOrbParsedAttributesToYamlDocument(orb ast.OrbParsedAttributes) YamlDocument {
 	return YamlDocument{
+		URI:          orb.URI,
 		LocalOrbName: orb.Name,
 
 		RootNode: doc.RootNode,

diff --git a/pkg/services/definition_test.go b/pkg/services/definition_test.go
@@ -9,8 +9,10 @@ import (
 
 	"github.com/CircleCI-Public/circleci-yaml-language-server/pkg/ast"
 	"github.com/CircleCI-Public/circleci-yaml-language-server/pkg/parser"
+	"github.com/CircleCI-Public/circleci-yaml-language-server/pkg/services/definition"
 	"github.com/CircleCI-Public/circleci-yaml-language-server/pkg/testHelpers"
 	utils "github.com/CircleCI-Public/circleci-yaml-language-server/pkg/utils"
+	"github.com/stretchr/testify/assert"
 	"go.lsp.dev/protocol"
 	"go.lsp.dev/uri"
 )
@@ -430,3 +432,94 @@ func TestDefinition(t *testing.T) {
 		})
 	}
 }
+
+func TestDefinitionForLocalOrbsCommand(t *testing.T) {
+	fileURI := uri.File("some-uri")
+	yaml := `version: 2.1
+
+orbs:
+  local:
+    commands:
+      cmd:
+        steps:
+          - run: echo << parameters.target >>
+    jobs:
+      job:
+        docker:
+          - image: cimg/node:21.6.1
+        steps:
+          - cmd`
+	context := testHelpers.GetDefaultLsContext()
+
+	doc, err := parser.ParseFromContent([]byte(yaml), context, fileURI, protocol.Position{})
+	assert.Nil(t, err)
+
+	def := definition.DefinitionStruct{Cache: utils.CreateCache(), Params: protocol.DefinitionParams{
+		TextDocumentPositionParams: protocol.TextDocumentPositionParams{
+			TextDocument: protocol.TextDocumentIdentifier{
+				URI: fileURI,
+			},
+			// Position is the job step `cmd`
+			Position: protocol.Position{
+				Line:      13,
+				Character: 14,
+			},
+		},
+	}, Doc: doc}
+	locations, err := def.Definition()
+	assert.Nil(t, err)
+	assert.Equal(t, locations, []protocol.Location{
+		{
+			URI: fileURI,
+			Range: protocol.Range{
+				Start: protocol.Position{Line: 5, Character: 6},
+				End:   protocol.Position{Line: 7, Character: 45},
+			},
+		},
+	})
+}
+
+func TestDefinitionForLocalOrbsExecutor(t *testing.T) {
+	fileURI := uri.File("some-uri")
+	yaml := `version: 2.1
+
+orbs:
+  local:
+    executors:
+      executor:
+        docker:
+          - image: cimg/base:2024.01
+    jobs:
+      job:
+        executor: executor
+        steps:
+          - run: echo "Hello World"`
+	context := testHelpers.GetDefaultLsContext()
+
+	doc, err := parser.ParseFromContent([]byte(yaml), context, fileURI, protocol.Position{})
+	assert.Nil(t, err)
+
+	def := definition.DefinitionStruct{Cache: utils.CreateCache(), Params: protocol.DefinitionParams{
+		TextDocumentPositionParams: protocol.TextDocumentPositionParams{
+			TextDocument: protocol.TextDocumentIdentifier{
+				URI: fileURI,
+			},
+			// Position is the job step `cmd`
+			Position: protocol.Position{
+				Line:      10,
+				Character: 24,
+			},
+		},
+	}, Doc: doc}
+	locations, err := def.Definition()
+	assert.Nil(t, err)
+	assert.Equal(t, locations, []protocol.Location{
+		{
+			URI: fileURI,
+			Range: protocol.Range{
+				Start: protocol.Position{Line: 5, Character: 6},
+				End:   protocol.Position{Line: 7, Character: 36},
+			},
+		},
+	})
+}