sap-jenkins-library/pkg/documentation/generator/description_test.go

package generator

import (
	"testing"

	"github.com/SAP/jenkins-library/pkg/config"
	"github.com/stretchr/testify/assert"
)

func TestCreateStepName(t *testing.T) {
	tests := []struct {
		name  string
		input *config.StepData
		want  string
	}{
		{
			name: "simple step name section",
			input: &config.StepData{
				Metadata: config.StepMetadata{Name: "teststep", Description: "TestDescription"},
			},
			want: "# teststep\n\nTestDescription\n",
		},
	}
	for _, testcase := range tests {
		t.Run(testcase.name, func(t *testing.T) {
			assert.Equal(t, testcase.want, createStepName(testcase.input))
		})
	}
}

func TestCreateDescriptionSection(t *testing.T) {
	CustomLibrarySteps = []CustomLibrary{{
		Name:        "TestLibrary",
		BinaryName:  "myBinary",
		LibraryName: "myLibrary",
		Steps:       []string{"myCustomStep"},
	}}

	tests := []struct {
		name  string
		input *config.StepData
		want  string
	}{
		{
			name: "simple step description section",
			input: &config.StepData{
				Metadata: config.StepMetadata{Name: "teststep", LongDescription: "TestDescription"},
			},
			want: headlineDescription + "TestDescription" + "\n\n" +
				headlineUsage + configRecommendation + "\n\n" +
				"!!! tip \"\"" + "\n\n" +
				headlineJenkinsPipeline + "        ```groovy\n        library('piper-lib-os')\n\n        teststep script: this\n        ```" + "\n\n" +
				headlineCommandLine + "        ```sh\n        piper teststep\n        ```" + "\n\n",
		},
		{
			name: "custom step description section",
			input: &config.StepData{
				Metadata: config.StepMetadata{Name: "myCustomStep", LongDescription: "TestDescription"},
			},
			want: headlineDescription + "TestDescription" + "\n\n" +
				headlineUsage + configRecommendation + "\n\n" +
				"!!! tip \"\"" + "\n\n" +
				headlineJenkinsPipeline + "        ```groovy\n        library('myLibrary')\n\n        myCustomStep script: this\n        ```" + "\n\n" +
				headlineCommandLine + "        ```sh\n        myBinary myCustomStep\n        ```" + "\n\n",
		},
	}
	for _, testcase := range tests {
		t.Run(testcase.name, func(t *testing.T) {
			assert.Equal(t, testcase.want, createDescriptionSection(testcase.input))
		})
	}
}