Skip to content

fix: add error log on invalid yaml #3042

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zakisk merged 2 commits into from
Oct 26, 2026
Merged

fix: add error log on invalid yaml #3042

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f350f7
fix: add error log on invalid yaml
zakisk Oct 21, 2026
fad9332
Merge branch 'main' into error-log-on-bad-yaml
chmouel Oct 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions pkg/resolve/logging.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ func debugf(log *zap.SugaredLogger, format string, args ...any) {
log.Debugf(format, args...)
}

func warnf(log *zap.SugaredLogger, format string, args ...any) {
if log != nil {
log.Warnf(format, args...)
}
}

func logInfo(log *zap.SugaredLogger, msg string) {
if log == nil {
return
Expand Down
2 changes: 1 addition & 1 deletion pkg/resolve/resolve.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ func ReadTektonTypes(ctx context.Context, log *zap.SugaredLogger, data string) (
obj, _, err := decoder.Decode([]byte(doc), nil, nil)
if err != nil {
dt, dv := detectAtleastNameOrGenerateNameAndSchemaFromPipelineRun(doc)
debugf(log, "ReadTektonTypes: decode error for doc name=%s schema=%s err=%v", dt, dv, err)
warnf(log, "ReadTektonTypes: decode error for doc name=%s schema=%s err=%v", dt, dv, err)
types.ValidationErrors = append(types.ValidationErrors, &pacerrors.PacYamlValidations{
Name: dt,
Err: fmt.Errorf("error decoding yaml document: %w", err),
Expand Down
16 changes: 12 additions & 4 deletions pkg/resolve/resolve_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,9 +416,11 @@ func TestReportBadTektonYaml(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
observer, _ := zapobserver.New(zap.InfoLevel)
Comment thread
zakisk marked this conversation as resolved.
Resolved
logger := zap.New(observer).Sugar()
data, err := os.ReadFile("testdata/" + tt.filename + ".yaml")
assert.NilError(t, err)
types, err := ReadTektonTypes(context.TODO(), nil, string(data))
types, err := ReadTektonTypes(context.TODO(), logger, string(data))
assert.NilError(t, err)

// Find the validation error by name
Expand Down Expand Up @@ -510,7 +512,9 @@ spec:
taskSpec:
invalid-field: "this should cause an error"`

types, err := ReadTektonTypes(context.TODO(), nil, testYaml)
observer, _ := zapobserver.New(zap.InfoLevel)
logger := zap.New(observer).Sugar()
types, err := ReadTektonTypes(context.TODO(), logger, testYaml)
assert.NilError(t, err)

// Each validation error should have the proper structure
Expand Down Expand Up @@ -599,7 +603,9 @@ func TestErrorMessageFormat(t *testing.T) {
- this: should
cause: [an error`

types, err := ReadTektonTypes(context.TODO(), nil, testYaml)
observer, _ := zapobserver.New(zap.InfoLevel)
logger := zap.New(observer).Sugar()
types, err := ReadTektonTypes(context.TODO(), logger, testYaml)
assert.NilError(t, err)

// Should have at least one validation error
Expand Down Expand Up @@ -793,7 +799,9 @@ func TestV1Beta1ConversionFixturesAreAcceptedByReadTektonTypes(t *testing.T) {
data, err := os.ReadFile("testdata/" + tt.filename + ".yaml")
assert.NilError(t, err)

types, err := ReadTektonTypes(context.TODO(), nil, string(data))
observer, _ := zapobserver.New(zap.InfoLevel)
logger := zap.New(observer).Sugar()
types, err := ReadTektonTypes(context.TODO(), logger, string(data))
assert.NilError(t, err)
assert.Equal(t, len(types.PipelineRuns), tt.pipelineRuns)
assert.Equal(t, len(types.Pipelines), tt.pipelines)
Expand Down
Loading