Add support for merged YAML return from linter

validate.go

@@ -73,6 +73,31 @@ func (s *ValidateService) Lint(content string, options ...RequestOptionFunc) (*L
 	return l, resp, nil
 }
 
+// LintWithMergedYAML validates .gitlab-ci.yml content and returns the merged YAML
+//
+// GitLab API docs: https://docs.gitlab.com/ce/api/lint.html
+func (s *ValidateService) LintWithMergedYAML(content string, options ...RequestOptionFunc) (*LintResult, *Response, error) {
+	var opts struct {
+		Content           string `url:"content,omitempty" json:"content,omitempty"`
+		IncludeMergedYAML bool   `url:"include_merged_yaml,omitempty" json:"include_merged_yaml,omitempty"`
+	}
+	opts.Content = content
+	opts.IncludeMergedYAML = true
+
+	req, err := s.client.NewRequest(http.MethodPost, "ci/lint", &opts, options)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	l := new(LintResult)
+	resp, err := s.client.Do(req, l)
+	if err != nil {
+		return nil, resp, err
+	}
+
+	return l, resp, nil
+}
+
 // ProjectNamespaceLintOptions represents the available ProjectNamespaceLint() options.
 //
 // GitLab API docs:

validate_test.go

@@ -73,7 +73,70 @@ func TestValidate(t *testing.T) {
 			})
 
 			got, _, err := client.Validate.Lint(tc.content)
+			if err != nil {
+				t.Errorf("Validate returned error: %v", err)
+			}
+
+			want := tc.want
+			if !reflect.DeepEqual(got, want) {
+				t.Errorf("Validate returned \ngot:\n%v\nwant:\n%v", Stringify(got), Stringify(want))
+			}
+		})
+	}
+}
+
+func TestValidateWithMergedYAML(t *testing.T) {
+	testCases := []struct {
+		description string
+		content     string
+		response    string
+		want        *LintResult
+	}{
+		{
+			description: "valid",
+			content: `
+				build1:
+					stage: build
+					script:
+						- echo "Do your build here"`,
+			response: `{
+				"status": "valid",
+				"errors": [],
+				"merged_yaml":"---\nbuild1:\n    stage: build\n    script:\n    - echo\"Do your build here\""
+			}`,
+			want: &LintResult{
+				Status:     "valid",
+				MergedYaml: "---\nbuild1:\n    stage: build\n    script:\n    - echo\"Do your build here\"",
+				Errors:     []string{},
+			},
+		},
+		{
+			description: "invalid",
+			content: `
+				build1:
+					- echo "Do your build here"`,
+			response: `{
+				"status": "invalid",
+				"errors": ["error message when content is invalid"]
+			}`,
+			want: &LintResult{
+				Status: "invalid",
+				Errors: []string{"error message when content is invalid"},
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.description, func(t *testing.T) {
+			mux, server, client := setup(t)
+			defer teardown(server)
 
+			mux.HandleFunc("/api/v4/ci/lint", func(w http.ResponseWriter, r *http.Request) {
+				testMethod(t, r, http.MethodPost)
+				fmt.Fprint(w, tc.response)
+			})
+
+			got, _, err := client.Validate.LintWithMergedYAML(tc.content)
 			if err != nil {
 				t.Errorf("Validate returned error: %v", err)
 			}
@@ -136,7 +199,6 @@ func TestValidateProject(t *testing.T) {
 
 			opt := &ProjectLintOptions{}
 			got, _, err := client.Validate.ProjectLint(1, opt)
-
 			if err != nil {
 				t.Errorf("Validate returned error: %v", err)
 			}
@@ -207,7 +269,6 @@ func TestValidateProjectNamespace(t *testing.T) {
 			})
 
 			got, _, err := client.Validate.ProjectNamespaceLint(1, tc.request)
-
 			if err != nil {
 				t.Errorf("Validate returned error: %v", err)
 			}