Refactor…

Author: svanharmelen

fixtures_test.go

@@ -19,8 +19,9 @@ package gitlab
 const (
 	// exampleChangelogResponse provides fixture for Changelog tests.
 	exampleChangelogResponse = `{
-        "notes": "## 1.0.0 (2021-11-17)\n\n### feature (2 changes)\n\n- [Title 2](namespace13/project13@ad608eb642124f5b3944ac0ac772fecaf570a6bf) ([merge request](namespace13/project13!2))\n- [Title 1](namespace13/project13@3c6b80ff7034fa0d585314e1571cc780596ce3c8) ([merge request](namespace13/project13!1))\n"
-    }`
+    "notes": "## 1.0.0 (2021-11-17)\n\n### feature (2 changes)\n\n- [Title 2](namespace13/project13@ad608eb642124f5b3944ac0ac772fecaf570a6bf) ([merge request](namespace13/project13!2))\n- [Title 1](namespace13/project13@3c6b80ff7034fa0d585314e1571cc780596ce3c8) ([merge request](namespace13/project13!1))\n"
+  }`
+
 	// exampleCommitMessage provides fixture for a commit message.
 	exampleCommitMessage = "Merge branch 'some-feature' into 'master'\n\nRelease v1.0.0\n\nSee merge request jsmith/example!1"
 

repositories.go

@@ -330,3 +330,90 @@ func (s *RepositoriesService) MergeBase(pid interface{}, opt *MergeBaseOptions,
 
 	return c, resp, err
 }
+
+// AddChangelogOptions represents the available AddChangelog() options.
+//
+// GitLab API docs:
+// https://docs.gitlab.com/ee/api/repositories.html#add-changelog-data-to-a-changelog-file
+type AddChangelogOptions struct {
+	Version    *string  `url:"version,omitempty" json:"version,omitempty"`
+	Branch     *string  `url:"branch,omitempty" json:"branch,omitempty"`
+	ConfigFile *string  `url:"config_file,omitempty" json:"config_file,omitempty"`
+	Date       *ISOTime `url:"date,omitempty" json:"date,omitempty"`
+	File       *string  `url:"file,omitempty" json:"file,omitempty"`
+	From       *string  `url:"from,omitempty" json:"from,omitempty"`
+	Message    *string  `url:"message,omitempty" json:"message,omitempty"`
+	To         *string  `url:"to,omitempty" json:"to,omitempty"`
+	Trailer    *string  `url:"trailer,omitempty" json:"trailer,omitempty"`
+}
+
+// AddChangelog generates changelog data based on commits in a repository.
+//
+// Gitlab API docs:
+// https://docs.gitlab.com/ee/api/repositories.html#add-changelog-data-to-a-changelog-file
+func (s *RepositoriesService) AddChangelog(pid interface{}, opt *AddChangelogOptions, options ...RequestOptionFunc) (*Response, error) {
+	project, err := parseID(pid)
+	if err != nil {
+		return nil, err
+	}
+	u := fmt.Sprintf("projects/%s/repository/changelog", PathEscape(project))
+
+	req, err := s.client.NewRequest(http.MethodPost, u, opt, options)
+	if err != nil {
+		return nil, err
+	}
+
+	return s.client.Do(req, nil)
+}
+
+// ChangelogData represents the generated changelog data.
+//
+// GitLab API docs:
+// https://docs.gitlab.com/ee/api/repositories.html#generate-changelog-data
+type ChangelogData struct {
+	Notes string `json:"notes"`
+}
+
+func (c ChangelogData) String() string {
+	return Stringify(c)
+}
+
+// GenerateChangelogDataOptions represents the available GenerateChangelogData()
+// options.
+//
+// GitLab API docs:
+// https://docs.gitlab.com/ee/api/repositories.html#generate-changelog-data
+type GenerateChangelogDataOptions struct {
+	Version    *string  `url:"version,omitempty" json:"version,omitempty"`
+	ConfigFile *string  `url:"config_file,omitempty" json:"config_file,omitempty"`
+	Date       *ISOTime `url:"date,omitempty" json:"date,omitempty"`
+	From       *string  `url:"from,omitempty" json:"from,omitempty"`
+	To         *string  `url:"to,omitempty" json:"to,omitempty"`
+	Trailer    *string  `url:"trailer,omitempty" json:"trailer,omitempty"`
+}
+
+// GenerateChangelogData generates changelog data based on commits in a
+// repository, without committing them to a changelog file.
+//
+// Gitlab API docs:
+// https://docs.gitlab.com/ee/api/repositories.html#generate-changelog-data
+func (s *RepositoriesService) GenerateChangelogData(pid interface{}, opt GenerateChangelogDataOptions, options ...RequestOptionFunc) (*ChangelogData, *Response, error) {
+	project, err := parseID(pid)
+	if err != nil {
+		return nil, nil, err
+	}
+	u := fmt.Sprintf("projects/%s/repository/changelog", project)
+
+	req, err := s.client.NewRequest(http.MethodGet, u, opt, options)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	cd := new(ChangelogData)
+	resp, err := s.client.Do(req, cd)
+	if err != nil {
+		return nil, resp, err
+	}
+
+	return cd, resp, err
+}

repositories_changelog.go

@@ -5,6 +5,7 @@ import (
 	"net/http"
 	"testing"
 
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
@@ -388,3 +389,44 @@ func TestRepositoriesService_MergeBase(t *testing.T) {
 	require.Nil(t, c)
 	require.Equal(t, http.StatusNotFound, resp.StatusCode)
 }
+
+func TestAddChangelogData(t *testing.T) {
+	mux, client := setup(t)
+
+	mux.HandleFunc("/api/v4/projects/1/repository/changelog",
+		func(w http.ResponseWriter, r *http.Request) {
+			testMethod(t, r, http.MethodPost)
+			w.WriteHeader(http.StatusOK)
+		})
+
+	resp, err := client.Repositories.AddChangelog(
+		1,
+		&AddChangelogOptions{
+			Version: String("1.0.0"),
+		})
+	require.NoError(t, err)
+	assert.Equal(t, http.StatusOK, resp.StatusCode)
+}
+
+func TestGenerateChangelogData(t *testing.T) {
+	mux, client := setup(t)
+
+	mux.HandleFunc("/api/v4/projects/1/repository/changelog",
+		func(w http.ResponseWriter, r *http.Request) {
+			testMethod(t, r, http.MethodGet)
+			fmt.Fprint(w, exampleChangelogResponse)
+		})
+
+	want := &ChangelogData{
+		Notes: "## 1.0.0 (2021-11-17)\n\n### feature (2 changes)\n\n- [Title 2](namespace13/project13@ad608eb642124f5b3944ac0ac772fecaf570a6bf) ([merge request](namespace13/project13!2))\n- [Title 1](namespace13/project13@3c6b80ff7034fa0d585314e1571cc780596ce3c8) ([merge request](namespace13/project13!1))\n",
+	}
+
+	notes, _, err := client.Repositories.GenerateChangelogData(
+		1,
+		GenerateChangelogDataOptions{
+			Version: String("1.0.0"),
+		},
+	)
+	require.NoError(t, err)
+	assert.Equal(t, want, notes)
+}