Implement changelog builder (#15)

Author: endorama

cmd/build.go

@@ -0,0 +1,40 @@
+// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+// or more contributor license agreements. Licensed under the Elastic License 2.0;
+// you may not use this file except in compliance with the Elastic License 2.0.
+
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/elastic/elastic-agent-changelog-tool/internal/changelog"
+	"github.com/spf13/afero"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+)
+
+func BuildCmd(fs afero.Fs) *cobra.Command {
+
+	buildCmd := &cobra.Command{
+		Use:  "build",
+		Long: "Create changelog from fragments",
+		Args: func(cmd *cobra.Command, args []string) error {
+			return nil
+		},
+		RunE: func(cmd *cobra.Command, args []string) error {
+			filename := viper.GetString("changelog_filename")
+			src := viper.GetString("fragment_location")
+			dest := viper.GetString("changelog_destination")
+
+			b := changelog.NewBuilder(fs, filename, "8.2.1", src, dest)
+
+			if err := b.Build(); err != nil {
+				return fmt.Errorf("cannot build changelog: %w", err)
+			}
+
+			return nil
+		},
+	}
+
+	return buildCmd
+}

cmd/build_test.go

@@ -0,0 +1,51 @@
+// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+// or more contributor license agreements. Licensed under the Elastic License 2.0;
+// you may not use this file except in compliance with the Elastic License 2.0.
+
+package cmd_test
+
+import (
+	"bytes"
+	"fmt"
+	"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/spf13/afero"
+	"github.com/spf13/viper"
+	"github.com/stretchr/testify/require"
+	"gopkg.in/yaml.v3"
+)
+
+func TestBuildCmd_default(t *testing.T) {
+	testFs := afero.NewMemMapFs()
+	c := fragment.NewCreator(testFs, viper.GetString("fragment_location"))
+	err := c.Create("foo")
+	require.Nil(t, err)
+	// NOTE: sleeping to produce different fragment's timestamps
+	time.Sleep(1 * time.Second)
+	err = c.Create("bar")
+	require.Nil(t, err)
+
+	cmd := cmd.BuildCmd(testFs)
+
+	b := new(bytes.Buffer)
+	cmd.SetOut(b)
+
+	err = cmd.Execute()
+	require.Nil(t, err)
+
+	content, err := afero.ReadFile(testFs, viper.GetString("changelog_destination"))
+	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.Len(t, ch.Entries, 2)
+}

go.mod

@@ -10,6 +10,7 @@ require (
 	github.com/spf13/viper v1.10.1
 	github.com/stretchr/testify v1.7.0
 	golang.org/x/oauth2 v0.0.0-20211104180415-d3ed0bb246c8
+	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
 )
 
 require (
@@ -36,5 +37,4 @@ require (
 	google.golang.org/protobuf v1.27.1 // indirect
 	gopkg.in/ini.v1 v1.66.2 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
-	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
 )

internal/changelog/builder.go

@@ -0,0 +1,81 @@
+// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+// or more contributor license agreements. Licensed under the Elastic License 2.0;
+// you may not use this file except in compliance with the Elastic License 2.0.
+
+package changelog
+
+import (
+	"errors"
+	"fmt"
+	"log"
+	"os"
+	"path"
+
+	"github.com/elastic/elastic-agent-changelog-tool/internal/changelog/fragment"
+	"github.com/spf13/afero"
+	"gopkg.in/yaml.v3"
+)
+
+type Builder struct {
+	changelog Changelog
+	filename  string
+	fs        afero.Fs
+	// src is the source location to gather changelog fragments
+	src string
+	// dest is the destination location where the changelog is written to
+	dest string
+}
+
+func NewBuilder(fs afero.Fs, filename, version, src, dest string) *Builder {
+	return &Builder{
+		changelog: Changelog{Version: version},
+		filename:  filename,
+		fs:        fs,
+		src:       src,
+		dest:      dest,
+	}
+}
+
+var changelogFilePerm = os.FileMode(0660)
+var errNoFragments = errors.New("no fragments found in the source folder")
+
+func (b Builder) Build() error {
+	log.Printf("building changelog for version: %s\n", b.changelog.Version)
+	log.Printf("collecting fragments from %s\n", b.src)
+
+	var files []string
+	err := afero.Walk(b.fs, b.src, func(path string, info os.FileInfo, err error) error {
+		if info, err := b.fs.Stat(path); err == nil && !info.IsDir() {
+			files = append(files, path)
+		} else {
+			return err
+		}
+
+		return nil
+	})
+	if err != nil {
+		return fmt.Errorf("cannot walk path %s: %w", b.src, err)
+	}
+
+	if len(files) == 0 {
+		return errNoFragments
+	}
+
+	for _, file := range files {
+		log.Printf("parsing %s", file)
+
+		f, err := fragment.Load(b.fs, file)
+		if err != nil {
+			return fmt.Errorf("cannot load fragment from file %s: %w", file, err)
+		}
+
+		b.changelog.Entries = append(b.changelog.Entries, EntryFromFragment(f))
+	}
+
+	data, err := yaml.Marshal(&b.changelog)
+	if err != nil {
+		return fmt.Errorf("cannot marshall changelog: %w", err)
+	}
+
+	return afero.WriteFile(b.fs, path.Join(b.dest, b.filename), data, changelogFilePerm)
+}

internal/changelog/changelog.go

@@ -0,0 +1,10 @@
+// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+// or more contributor license agreements. Licensed under the Elastic License 2.0;
+// you may not use this file except in compliance with the Elastic License 2.0.
+
+package changelog
+
+type Changelog struct {
+	Version string  `yaml:"version"`
+	Entries []Entry `yaml:"entries"`
+}

internal/changelog/entry.go

@@ -0,0 +1,66 @@
+// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+// or more contributor license agreements. Licensed under the Elastic License 2.0;
+// you may not use this file except in compliance with the Elastic License 2.0.
+
+package changelog
+
+import "github.com/elastic/elastic-agent-changelog-tool/internal/changelog/fragment"
+
+type FragmentFileInfo struct {
+	Name     string `yaml:"name"`
+	Checksum string `yaml:"checksum"`
+}
+
+type Entry struct {
+	Summary     string           `yaml:"summary"`
+	Description string           `yaml:"description"`
+	Kind        Kind             `yaml:"kind"`
+	LinkedPR    int              `yaml:"pr"`
+	LinkedIssue int              `yaml:"issue"`
+	Timestamp   int64            `yaml:"timestamp"`
+	File        FragmentFileInfo `yaml:"file"`
+}
+
+// EntriesFromFragment returns one or more entries based on the fragment File.
+// A single Fragment can contain multiple Changelog entries.
+func EntryFromFragment(f fragment.File) Entry {
+	e := Entry{
+		Summary:     f.Fragment.Summary,
+		Description: f.Fragment.Description,
+		Kind:        kind2kind(f),
+		LinkedPR:    f.Fragment.Pr,
+		LinkedIssue: f.Fragment.Issue,
+		Timestamp:   f.Timestamp,
+		File: FragmentFileInfo{
+			Name:     f.Name,
+			Checksum: f.Checksum(),
+		},
+	}
+
+	return e
+}
+
+func kind2kind(f fragment.File) Kind {
+	switch f.Fragment.Kind {
+	case string(BreakingChange):
+		return BreakingChange
+	case string(BugFix):
+		return BugFix
+	case string(Deprecation):
+		return Deprecation
+	case string(Enhancement):
+		return Enhancement
+	case string(Feature):
+		return Feature
+	case string(KnownIssue):
+		return KnownIssue
+	case string(Security):
+		return Security
+	case string(Upgrade):
+		return Upgrade
+	case string(Other):
+		return Other
+	default:
+		return Unknown
+	}
+}

internal/changelog/entry_test.go

@@ -0,0 +1,127 @@
+// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+// or more contributor license agreements. Licensed under the Elastic License 2.0;
+// you may not use this file except in compliance with the Elastic License 2.0.
+
+package changelog_test
+
+import (
+	"path"
+	"testing"
+
+	"github.com/elastic/elastic-agent-changelog-tool/internal/changelog"
+	"github.com/elastic/elastic-agent-changelog-tool/internal/changelog/fragment"
+	"github.com/spf13/afero"
+	"github.com/spf13/viper"
+	"github.com/stretchr/testify/require"
+)
+
+func loadEntries(t *testing.T, fixture string) (fragment.File, changelog.Entry) {
+	fs := afero.NewCopyOnWriteFs(afero.NewOsFs(), afero.NewMemMapFs())
+
+	viper.Set("fragment_location", "testdata")
+
+	f1, err := fragment.Load(fs, path.Join(viper.GetString("fragment_location"), fixture))
+	require.Nil(t, err)
+
+	return f1, changelog.EntryFromFragment(f1)
+}
+
+func TestEntriesFromFragment_breaking(t *testing.T) {
+	fixture := "1648040928-breaking-change.yaml"
+	f, e := loadEntries(t, fixture)
+	require.Equal(t, e.File.Name, fixture)
+	require.Equal(t, e.File.Checksum, f.Checksum())
+	require.Equal(t, e.Timestamp, f.Timestamp)
+	require.Equal(t, e.Kind, changelog.BreakingChange)
+	require.Equal(t, e.Summary, f.Fragment.Summary)
+}
+
+func TestEntriesFromFragment_deprecation(t *testing.T) {
+	fixture := "1648040928-bug-fix.yaml"
+	f, e := loadEntries(t, fixture)
+	require.Equal(t, e.File.Name, fixture)
+	require.Equal(t, e.File.Checksum, f.Checksum())
+	require.Equal(t, e.Timestamp, f.Timestamp)
+	require.Equal(t, e.Kind, changelog.BugFix)
+	require.Equal(t, e.Summary, f.Fragment.Summary)
+}
+
+func TestEntriesFromFragment_bugfix(t *testing.T) {
+	fixture := "1648040928-deprecation.yaml"
+	f, e := loadEntries(t, fixture)
+	require.Equal(t, e.File.Name, fixture)
+	require.Equal(t, e.File.Checksum, f.Checksum())
+	require.Equal(t, e.Timestamp, f.Timestamp)
+	require.Equal(t, e.Kind, changelog.Deprecation)
+	require.Equal(t, e.Summary, f.Fragment.Summary)
+}
+
+func TestEntriesFromFragment_enhancement(t *testing.T) {
+	fixture := "1648040928-enhancement.yaml"
+	f, e := loadEntries(t, fixture)
+	require.Equal(t, e.File.Name, fixture)
+	require.Equal(t, e.File.Checksum, f.Checksum())
+	require.Equal(t, e.Timestamp, f.Timestamp)
+	require.Equal(t, e.Kind, changelog.Enhancement)
+	require.Equal(t, e.Summary, f.Fragment.Summary)
+}
+
+func TestEntriesFromFragment_feature(t *testing.T) {
+	fixture := "1648040928-feature.yaml"
+	f, e := loadEntries(t, fixture)
+	require.Equal(t, e.File.Name, fixture)
+	require.Equal(t, e.File.Checksum, f.Checksum())
+	require.Equal(t, e.Timestamp, f.Timestamp)
+	require.Equal(t, e.Kind, changelog.Feature)
+	require.Equal(t, e.Summary, f.Fragment.Summary)
+}
+
+func TestEntriesFromFragment_knownissue(t *testing.T) {
+	fixture := "1648040928-known-issue.yaml"
+	f, e := loadEntries(t, fixture)
+	require.Equal(t, e.File.Name, fixture)
+	require.Equal(t, e.File.Checksum, f.Checksum())
+	require.Equal(t, e.Timestamp, f.Timestamp)
+	require.Equal(t, e.Kind, changelog.KnownIssue)
+	require.Equal(t, e.Summary, f.Fragment.Summary)
+
+}
+func TestEntriesFromFragment_security(t *testing.T) {
+	fixture := "1648040928-security.yaml"
+	f, e := loadEntries(t, fixture)
+	require.Equal(t, e.File.Name, fixture)
+	require.Equal(t, e.File.Checksum, f.Checksum())
+	require.Equal(t, e.Timestamp, f.Timestamp)
+	require.Equal(t, e.Kind, changelog.Security)
+	require.Equal(t, e.Summary, f.Fragment.Summary)
+
+}
+func TestEntriesFromFragment_upgrade(t *testing.T) {
+	fixture := "1648040928-upgrade.yaml"
+	f, e := loadEntries(t, fixture)
+	require.Equal(t, e.File.Name, fixture)
+	require.Equal(t, e.File.Checksum, f.Checksum())
+	require.Equal(t, e.Timestamp, f.Timestamp)
+	require.Equal(t, e.Kind, changelog.Upgrade)
+	require.Equal(t, e.Summary, f.Fragment.Summary)
+
+}
+func TestEntriesFromFragment_other(t *testing.T) {
+	fixture := "1648040928-other.yaml"
+	f, e := loadEntries(t, fixture)
+	require.Equal(t, e.File.Name, fixture)
+	require.Equal(t, e.File.Checksum, f.Checksum())
+	require.Equal(t, e.Timestamp, f.Timestamp)
+	require.Equal(t, e.Kind, changelog.Other)
+	require.Equal(t, e.Summary, f.Fragment.Summary)
+}
+
+func TestEntriesFromFragment_unknown(t *testing.T) {
+	fixture := "1648040928-unknown.yaml"
+	f, e := loadEntries(t, fixture)
+	require.Equal(t, e.File.Name, fixture)
+	require.Equal(t, e.File.Checksum, f.Checksum())
+	require.Equal(t, e.Timestamp, f.Timestamp)
+	require.Equal(t, e.Kind, changelog.Unknown)
+	require.Equal(t, e.Summary, f.Fragment.Summary)
+}