goreleaser/internal/pipe/release/body_test.go

package release

import (
	"flag"
	"os"
	"testing"

	"github.com/goreleaser/goreleaser/internal/artifact"
	"github.com/goreleaser/goreleaser/pkg/config"
	"github.com/goreleaser/goreleaser/pkg/context"
	"github.com/stretchr/testify/require"
)

var update = flag.Bool("update", false, "update .golden files")

func TestDescribeBody(t *testing.T) {
	changelog := "feature1: description\nfeature2: other description"
	ctx := context.New(config.Project{})
	ctx.ReleaseNotes = changelog
	for _, d := range []string{
		"goreleaser/goreleaser:0.40.0",
		"goreleaser/goreleaser:latest",
		"goreleaser/godownloader:v0.1.0",
	} {
		ctx.Artifacts.Add(&artifact.Artifact{
			Name: d,
			Type: artifact.DockerImage,
		})
	}
	out, err := describeBody(ctx)
	require.NoError(t, err)

	golden := "testdata/release1.golden"
	if *update {
		_ = os.WriteFile(golden, out.Bytes(), 0o755)
	}
	bts, err := os.ReadFile(golden)
	require.NoError(t, err)
	require.Equal(t, string(bts), out.String())
}

func TestDescribeBodyWithDockerManifest(t *testing.T) {
	changelog := "feature1: description\nfeature2: other description"
	ctx := context.New(config.Project{})
	ctx.ReleaseNotes = changelog
	for _, d := range []string{
		"goreleaser/goreleaser:0.40.0",
		"goreleaser/goreleaser:latest",
		"goreleaser/godownloader:v0.1.0",
	} {
		ctx.Artifacts.Add(&artifact.Artifact{
			Name: d,
			Type: artifact.DockerManifest,
		})
	}
	for _, d := range []string{
		"goreleaser/goreleaser:0.40.0-amd64",
		"goreleaser/goreleaser:latest-amd64",
		"goreleaser/godownloader:v0.1.0-amd64",
		"goreleaser/goreleaser:0.40.0-arm64",
		"goreleaser/goreleaser:latest-arm64",
		"goreleaser/godownloader:v0.1.0-arm64",
	} {
		ctx.Artifacts.Add(&artifact.Artifact{
			Name: d,
			Type: artifact.DockerImage,
		})
	}
	out, err := describeBody(ctx)
	require.NoError(t, err)

	golden := "testdata/release3.golden"
	if *update {
		_ = os.WriteFile(golden, out.Bytes(), 0o755)
	}
	bts, err := os.ReadFile(golden)
	require.NoError(t, err)
	require.Equal(t, string(bts), out.String())
}

func TestDescribeBodyNoDockerImagesNoBrews(t *testing.T) {
	changelog := "feature1: description\nfeature2: other description"
	ctx := &context.Context{
		ReleaseNotes: changelog,
	}
	out, err := describeBody(ctx)
	require.NoError(t, err)

	golden := "testdata/release2.golden"
	if *update {
		_ = os.WriteFile(golden, out.Bytes(), 0o655)
	}
	bts, err := os.ReadFile(golden)
	require.NoError(t, err)

	require.Equal(t, string(bts), out.String())
}

func TestDontEscapeHTML(t *testing.T) {
	changelog := "<h1>test</h1>"
	ctx := context.New(config.Project{})
	ctx.ReleaseNotes = changelog

	out, err := describeBody(ctx)
	require.NoError(t, err)
	require.Contains(t, out.String(), changelog)
}