Support network names in Compose completion items

Signed-off-by: Remy Suen <[email protected]>

Author: rcjsuen

CHANGELOG.md

@@ -10,6 +10,7 @@ All notable changes to the Docker Language Server will be documented in this fil
   - updated Compose schema to the latest version ([#117](https://github.com/docker/docker-language-server/issues/117))
   - textDocument/completion
     - suggest dependent service names for the `depends_on` attribute ([#131](https://github.com/docker/docker-language-server/issues/131))
+    - suggest dependent networks names for the `networks` attribute ([#132](https://github.com/docker/docker-language-server/issues/132))
 
 ### Fixed
 

internal/compose/completion.go

@@ -156,13 +156,13 @@ func Completion(ctx context.Context, params *protocol.CompletionParams, doc docu
 	return &protocol.CompletionList{Items: items}, nil
 }
 
-func findServices(file *ast.File) []string {
+func findDependencies(file *ast.File, dependencyType string) []string {
 	services := []string{}
 	for _, documentNode := range file.Docs {
 		if mappingNode, ok := documentNode.Body.(*ast.MappingNode); ok {
 			for _, n := range mappingNode.Values {
 				if s, ok := n.Key.(*ast.StringNode); ok {
-					if s.Value == "services" {
+					if s.Value == dependencyType {
 						if mappingNode, ok := n.Value.(*ast.MappingNode); ok {
 							for _, service := range mappingNode.Values {
 								services = append(services, service.Key.GetToken().Value)
@@ -177,27 +177,33 @@ func findServices(file *ast.File) []string {
 }
 
 func dependencyCompletionItems(file *ast.File, path []*ast.MappingValueNode, params *protocol.CompletionParams, prefixLength protocol.UInteger) []protocol.CompletionItem {
-	if len(path) == 3 && path[2].Key.GetToken().Value == "depends_on" {
-		items := []protocol.CompletionItem{}
-		for _, service := range findServices(file) {
-			if service != path[1].Key.GetToken().Value {
-				item := protocol.CompletionItem{
-					Label: service,
-					TextEdit: protocol.TextEdit{
-						NewText: service,
-						Range: protocol.Range{
-							Start: protocol.Position{
-								Line:      params.Position.Line,
-								Character: params.Position.Character - prefixLength,
+	dependency := map[string]string{
+		"depends_on": "services",
+		"networks":   "networks",
+	}
+	for key, value := range dependency {
+		if len(path) == 3 && path[2].Key.GetToken().Value == key {
+			items := []protocol.CompletionItem{}
+			for _, service := range findDependencies(file, value) {
+				if service != path[1].Key.GetToken().Value {
+					item := protocol.CompletionItem{
+						Label: service,
+						TextEdit: protocol.TextEdit{
+							NewText: service,
+							Range: protocol.Range{
+								Start: protocol.Position{
+									Line:      params.Position.Line,
+									Character: params.Position.Character - prefixLength,
+								},
+								End: params.Position,
 							},
-							End: params.Position,
 						},
-					},
+					}
+					items = append(items, item)
 				}
-				items = append(items, item)
 			}
+			return items
 		}
-		return items
 	}
 	return nil
 }

internal/compose/completion_test.go

@@ -561,7 +561,7 @@ func serviceProperties(line, character, prefixLength protocol.UInteger) []protoc
 	}
 }
 
-func TestCompletion(t *testing.T) {
+func TestCompletion_Schema(t *testing.T) {
 	testCases := []struct {
 		name      string
 		content   string
@@ -1832,6 +1832,37 @@ networks:
 			character: 2,
 			list:      nil,
 		},
+	}
+
+	composeFileURI := fmt.Sprintf("file:///%v", strings.TrimPrefix(filepath.ToSlash(filepath.Join(os.TempDir(), "compose.yaml")), "/"))
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			doc := document.NewComposeDocument(uri.URI(composeFileURI), 1, []byte(tc.content))
+			list, err := Completion(context.Background(), &protocol.CompletionParams{
+				TextDocumentPositionParams: protocol.TextDocumentPositionParams{
+					TextDocument: protocol.TextDocumentIdentifier{URI: composeFileURI},
+					Position:     protocol.Position{Line: tc.line, Character: tc.character},
+				},
+			}, doc)
+			require.NoError(t, err)
+			if tc.list == nil {
+				require.Nil(t, list)
+			} else {
+				require.Equal(t, tc.list, list)
+			}
+		})
+	}
+}
+
+func TestCompletion_Custom(t *testing.T) {
+	testCases := []struct {
+		name      string
+		content   string
+		line      uint32
+		character uint32
+		list      *protocol.CompletionList
+	}{
 		{
 			name: "depends_on array items",
 			content: `
@@ -1906,6 +1937,95 @@ services:
     image: alpine
     depends_on:
       
+  test2:
+    image: alpine`,
+			line:      5,
+			character: 6,
+			list: &protocol.CompletionList{
+				Items: []protocol.CompletionItem{
+					{
+						Label:    "test2",
+						TextEdit: textEdit("test2", 5, 6, 0),
+					},
+				},
+			},
+		},
+		{
+			name: "networks array items",
+			content: `
+services:
+  test:
+    image: alpine
+    networks:
+      - 
+networks:
+  test2:
+    image: alpine`,
+			line:      5,
+			character: 8,
+			list: &protocol.CompletionList{
+				Items: []protocol.CompletionItem{
+					{
+						Label:    "test2",
+						TextEdit: textEdit("test2", 5, 8, 0),
+					},
+				},
+			},
+		},
+		{
+			name: "networks array items across two files",
+			content: `
+---
+services:
+  test:
+    image: alpine
+    networks:
+      - 
+---
+networks:
+  test2:`,
+			line:      6,
+			character: 8,
+			list: &protocol.CompletionList{
+				Items: []protocol.CompletionItem{
+					{
+						Label:    "test2",
+						TextEdit: textEdit("test2", 6, 8, 0),
+					},
+				},
+			},
+		},
+		{
+			name: "networks array items",
+			content: `
+services:
+  test:
+    image: alpine
+    networks:
+      - t
+networks:
+  test2:
+    image: alpine`,
+			line:      5,
+			character: 9,
+			list: &protocol.CompletionList{
+				Items: []protocol.CompletionItem{
+					{
+						Label:    "test2",
+						TextEdit: textEdit("test2", 5, 9, 1),
+					},
+				},
+			},
+		},
+		{
+			name: "networks service object",
+			content: `
+services:
+  test:
+    image: alpine
+    networks:
+      
+networks:
   test2:
     image: alpine`,
 			line:      5,