Changelog builder improvements (#36)

Author: endorama

cmd/build.go

@@ -6,6 +6,7 @@ package cmd
 
 import (
 	"fmt"
+	"log"
 
 	"github.com/elastic/elastic-agent-changelog-tool/internal/changelog"
 	"github.com/spf13/afero"
@@ -26,7 +27,12 @@ func BuildCmd(fs afero.Fs) *cobra.Command {
 			src := viper.GetString("fragment_location")
 			dest := viper.GetString("changelog_destination")
 
-			b := changelog.NewBuilder(fs, filename, "8.2.1", src, dest)
+			version, err := cmd.Flags().GetString("version")
+			if err != nil {
+				return fmt.Errorf("error parsing flag 'version': %w", err)
+			}
+
+			b := changelog.NewBuilder(fs, filename, version, src, dest)
 
 			if err := b.Build(); err != nil {
 				return fmt.Errorf("cannot build changelog: %w", err)
@@ -36,5 +42,12 @@ func BuildCmd(fs afero.Fs) *cobra.Command {
 		},
 	}
 
+	buildCmd.Flags().String("version", "", "The version of the consolidated changelog being created")
+	err := buildCmd.MarkFlagRequired("version")
+	if err != nil {
+		// NOTE: the only case this error appear is when the flag is not defined
+		log.Fatal(err)
+	}
+
 	return buildCmd
 }

cmd/build_test.go

@@ -6,20 +6,26 @@ package cmd_test
 
 import (
 	"bytes"
+	"errors"
 	"fmt"
+	"io/ioutil"
+	"path"
 	"testing"
 	"time"
 
 	"github.com/elastic/elastic-agent-changelog-tool/cmd"
 	"github.com/elastic/elastic-agent-changelog-tool/internal/changelog"
 	"github.com/elastic/elastic-agent-changelog-tool/internal/changelog/fragment"
+	"github.com/elastic/elastic-agent-changelog-tool/internal/settings"
 	"github.com/spf13/afero"
 	"github.com/spf13/viper"
 	"github.com/stretchr/testify/require"
 	"gopkg.in/yaml.v3"
 )
 
-func TestBuildCmd_default(t *testing.T) {
+func TestBuildCmd(t *testing.T) {
+	settings.Init()
+
 	testFs := afero.NewMemMapFs()
 	c := fragment.NewCreator(testFs, viper.GetString("fragment_location"))
 	err := c.Create("foo")
@@ -31,21 +37,37 @@ func TestBuildCmd_default(t *testing.T) {
 
 	cmd := cmd.BuildCmd(testFs)
 
+	expectedVersion := "0.0.0"
+	cmd.SetArgs([]string{
+		fmt.Sprintf("--version=%s", expectedVersion),
+	})
+
 	b := new(bytes.Buffer)
 	cmd.SetOut(b)
 
 	err = cmd.Execute()
 	require.Nil(t, err)
 
-	content, err := afero.ReadFile(testFs, viper.GetString("changelog_destination"))
+	changelogFile := path.Join(viper.GetString("changelog_destination"), viper.GetString("changelog_filename"))
+	content, err := afero.ReadFile(testFs, changelogFile)
 	require.Nil(t, err)
 
 	ch := changelog.Changelog{}
 	err = yaml.Unmarshal(content, &ch)
 	require.Nil(t, err)
 
-	fmt.Println(ch)
-
-	require.Equal(t, "8.2.1", ch.Version)
+	require.Equal(t, expectedVersion, ch.Version)
 	require.Len(t, ch.Entries, 2)
 }
+
+func TestBuildCmd_missingFlag(t *testing.T) {
+	testFs := afero.NewMemMapFs()
+	cmd := cmd.BuildCmd(testFs)
+
+	cmd.SetOut(ioutil.Discard)
+	cmd.SetErr(ioutil.Discard)
+
+	err := cmd.Execute()
+	expectedErr := errors.New("required flag(s) \"version\" not set")
+	require.Error(t, expectedErr, err)
+}

internal/changelog/builder.go

@@ -77,5 +77,7 @@ func (b Builder) Build() error {
 		return fmt.Errorf("cannot marshall changelog: %w", err)
 	}
 
-	return afero.WriteFile(b.fs, path.Join(b.dest, b.filename), data, changelogFilePerm)
+	outFile := path.Join(b.dest, b.filename)
+	log.Printf("saving changelog in %s\n", outFile)
+	return afero.WriteFile(b.fs, outFile, data, changelogFilePerm)
 }