[chore][chloggen] Clean up terminology for unreleased directory (#368)

open-telemetry · Jul 18, 2023 · db501f8 · db501f8
1 parent ce6f067
commit db501f8
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 34 deletions.
diff --git a/chloggen/cmd/cmd_test.go b/chloggen/cmd/cmd_test.go
@@ -99,11 +99,11 @@ func setupTestDir(t *testing.T, entries []*chlog.Entry) chlog.Context {
 	ctx := chlog.New(t.TempDir())
 
 	// Create a known dummy changelog which may be updated by the test
-	changelogBytes, err := os.ReadFile(filepath.Join("testdata", "CHANGELOG.md"))
+	changelogBytes, err := os.ReadFile(filepath.Join("testdata", chlog.DefaultChangelogMD))
 	require.NoError(t, err)
 	require.NoError(t, os.WriteFile(ctx.ChangelogMD, changelogBytes, os.FileMode(0755)))
 
-	require.NoError(t, os.Mkdir(ctx.UnreleasedDir, os.FileMode(0755)))
+	require.NoError(t, os.Mkdir(ctx.ChloggenDir, os.FileMode(0755)))
 
 	// Copy the entry template, for tests that ensure it is not deleted
 	templateInRootDir := chlog.New("testdata").TemplateYAML
@@ -123,6 +123,6 @@ func writeEntryYAML(ctx chlog.Context, filename string, entry *chlog.Entry) erro
 	if err != nil {
 		return err
 	}
-	path := filepath.Join(ctx.UnreleasedDir, filename)
+	path := filepath.Join(ctx.ChloggenDir, filename)
 	return os.WriteFile(path, entryBytes, os.FileMode(0755))
 }
diff --git a/chloggen/cmd/new.go b/chloggen/cmd/new.go
@@ -39,7 +39,7 @@ var newCmd = &cobra.Command{
 }
 
 func initialize(ctx chlog.Context, filename string) error {
-	path := filepath.Join(ctx.UnreleasedDir, cleanFileName(filename))
+	path := filepath.Join(ctx.ChloggenDir, cleanFileName(filename))
 	var pathWithExt string
 	switch ext := filepath.Ext(path); ext {
 	case ".yaml":

diff --git a/chloggen/cmd/root.go b/chloggen/cmd/root.go
@@ -39,7 +39,7 @@ func initConfig() {
 	if chloggenDir == "" {
 		chloggenDir = ".chloggen"
 	}
-	chlogCtx = chlog.New(chlog.RepoRoot(), chlog.WithUnreleasedDir(chloggenDir))
+	chlogCtx = chlog.New(chlog.RepoRoot(), chlog.WithChloggenDir(chloggenDir))
 }
 
 func init() {

diff --git a/chloggen/cmd/update_test.go b/chloggen/cmd/update_test.go
@@ -98,7 +98,7 @@ func TestUpdateE2E(t *testing.T) {
 
 			require.Equal(t, string(expectedBytes), string(actualBytes))
 
-			remainingYAMLs, err := filepath.Glob(filepath.Join(ctx.UnreleasedDir, "*.yaml"))
+			remainingYAMLs, err := filepath.Glob(filepath.Join(ctx.ChloggenDir, "*.yaml"))
 			require.NoError(t, err)
 			if tc.dry {
 				require.Equal(t, 1+len(tc.entries), len(remainingYAMLs))

diff --git a/chloggen/cmd/validate.go b/chloggen/cmd/validate.go
@@ -32,7 +32,7 @@ var validateCmd = &cobra.Command{
 }
 
 func validate(ctx chlog.Context) error {
-	if _, err := os.Stat(ctx.UnreleasedDir); err != nil {
+	if _, err := os.Stat(ctx.ChloggenDir); err != nil {
 		return err
 	}
 
@@ -45,6 +45,6 @@ func validate(ctx chlog.Context) error {
 			return err
 		}
 	}
-	fmt.Printf("PASS: all files in %s/ are valid\n", ctx.UnreleasedDir)
+	fmt.Printf("PASS: all files in %s/ are valid\n", ctx.ChloggenDir)
 	return nil
 }
diff --git a/chloggen/internal/chlog/context.go b/chloggen/internal/chlog/context.go
@@ -21,34 +21,34 @@ import (
 )
 
 const (
-	changelogMD   = "CHANGELOG.md"
-	unreleasedDir = ".chloggen"
-	templateYAML  = "TEMPLATE.yaml"
+	DefaultChangelogMD  = "CHANGELOG.md"
+	DefaultChloggenDir  = ".chloggen"
+	DefaultTemplateYAML = "TEMPLATE.yaml"
 )
 
 // Context enables tests by allowing them to work in an test directory
 type Context struct {
-	rootDir       string
-	ChangelogMD   string
-	UnreleasedDir string
-	TemplateYAML  string
+	rootDir      string
+	ChangelogMD  string
+	ChloggenDir  string
+	TemplateYAML string
 }
 
 type Option func(*Context)
 
-func WithUnreleasedDir(unreleasedDir string) Option {
+func WithChloggenDir(chloggenDir string) Option {
 	return func(ctx *Context) {
-		ctx.UnreleasedDir = filepath.Join(ctx.rootDir, unreleasedDir)
-		ctx.TemplateYAML = filepath.Join(ctx.rootDir, unreleasedDir, templateYAML)
+		ctx.ChloggenDir = filepath.Join(ctx.rootDir, chloggenDir)
+		ctx.TemplateYAML = filepath.Join(ctx.rootDir, chloggenDir, DefaultTemplateYAML)
 	}
 }
 
 func New(rootDir string, options ...Option) Context {
 	ctx := Context{
-		rootDir:       rootDir,
-		ChangelogMD:   filepath.Join(rootDir, changelogMD),
-		UnreleasedDir: filepath.Join(rootDir, unreleasedDir),
-		TemplateYAML:  filepath.Join(rootDir, unreleasedDir, templateYAML),
+		rootDir:      rootDir,
+		ChangelogMD:  filepath.Join(rootDir, DefaultChangelogMD),
+		ChloggenDir:  filepath.Join(rootDir, DefaultChloggenDir),
+		TemplateYAML: filepath.Join(rootDir, DefaultChloggenDir, DefaultTemplateYAML),
 	}
 	for _, op := range options {
 		op(&ctx)

diff --git a/chloggen/internal/chlog/context_test.go b/chloggen/internal/chlog/context_test.go
@@ -25,19 +25,19 @@ func TestNew(t *testing.T) {
 	root := "/tmp"
 	ctx := New(root)
 	assert.Equal(t, root, ctx.rootDir)
-	assert.Equal(t, filepath.Join(root, unreleasedDir), ctx.UnreleasedDir)
-	assert.Equal(t, filepath.Join(root, changelogMD), ctx.ChangelogMD)
-	assert.Equal(t, filepath.Join(root, unreleasedDir, templateYAML), ctx.TemplateYAML)
+	assert.Equal(t, filepath.Join(root, DefaultChloggenDir), ctx.ChloggenDir)
+	assert.Equal(t, filepath.Join(root, DefaultChangelogMD), ctx.ChangelogMD)
+	assert.Equal(t, filepath.Join(root, DefaultChloggenDir, DefaultTemplateYAML), ctx.TemplateYAML)
 }
 
-func TestWithUnreleasedDir(t *testing.T) {
+func TestWithChloggenDir(t *testing.T) {
 	root := "/tmp"
-	unreleased := ".test"
-	ctx := New(root, WithUnreleasedDir(unreleased))
+	chloggenDir := ".test"
+	ctx := New(root, WithChloggenDir(chloggenDir))
 	assert.Equal(t, root, ctx.rootDir)
-	assert.Equal(t, filepath.Join(root, unreleased), ctx.UnreleasedDir)
-	assert.Equal(t, filepath.Join(root, changelogMD), ctx.ChangelogMD)
-	assert.Equal(t, filepath.Join(root, unreleased, templateYAML), ctx.TemplateYAML)
+	assert.Equal(t, filepath.Join(root, chloggenDir), ctx.ChloggenDir)
+	assert.Equal(t, filepath.Join(root, DefaultChangelogMD), ctx.ChangelogMD)
+	assert.Equal(t, filepath.Join(root, chloggenDir, DefaultTemplateYAML), ctx.TemplateYAML)
 }
 
 func TestRepoRoot(t *testing.T) {

diff --git a/chloggen/internal/chlog/entry.go b/chloggen/internal/chlog/entry.go
@@ -92,7 +92,7 @@ func (e Entry) String() string {
 }
 
 func ReadEntries(ctx Context) ([]*Entry, error) {
-	entryYAMLs, err := filepath.Glob(filepath.Join(ctx.UnreleasedDir, "*.yaml"))
+	entryYAMLs, err := filepath.Glob(filepath.Join(ctx.ChloggenDir, "*.yaml"))
 	if err != nil {
 		return nil, err
 	}
@@ -118,7 +118,7 @@ func ReadEntries(ctx Context) ([]*Entry, error) {
 }
 
 func DeleteEntries(ctx Context) error {
-	entryYAMLs, err := filepath.Glob(filepath.Join(ctx.UnreleasedDir, "*.yaml"))
+	entryYAMLs, err := filepath.Glob(filepath.Join(ctx.ChloggenDir, "*.yaml"))
 	if err != nil {
 		return err
 	}

diff --git a/chloggen/internal/chlog/entry_test.go b/chloggen/internal/chlog/entry_test.go
@@ -117,7 +117,7 @@ func TestEntry(t *testing.T) {
 
 func TestReadDeleteEntries(t *testing.T) {
 	tempDir := t.TempDir()
-	entriesDir := filepath.Join(tempDir, ".chloggen")
+	entriesDir := filepath.Join(tempDir, DefaultChloggenDir)
 	require.NoError(t, os.Mkdir(entriesDir, os.ModePerm))
 
 	entryA := Entry{