Skip to content

🌱 (chore): consistently wrap and enrich error messages across test utils #4755

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
merged 1 commit into from
Apr 4, 2025
Merged

🌱 (chore): consistently wrap and enrich error messages across test utils #4755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 15 additions & 12 deletions docs/book/src/cronjob-tutorial/testdata/project/test/utils/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ func GetNonEmptyLines(output string) []string {
func GetProjectDir() (string, error) {
wd, err := os.Getwd()
if err != nil {
return wd, err
return wd, fmt.Errorf("failed to get current working directory: %w", err)
}
wd = strings.Replace(wd, "/test/e2e", "", -1)
return wd, nil
Expand All @@ -208,7 +208,7 @@ func UncommentCode(filename, target, prefix string) error {
// nolint:gosec
content, err := os.ReadFile(filename)
if err != nil {
return err
return fmt.Errorf("failed to read file %q: %w", filename, err)
}
strContent := string(content)

Expand All @@ -220,32 +220,35 @@ func UncommentCode(filename, target, prefix string) error {
out := new(bytes.Buffer)
_, err = out.Write(content[:idx])
if err != nil {
return err
return fmt.Errorf("failed to write to output: %w", err)
}

scanner := bufio.NewScanner(bytes.NewBufferString(target))
if !scanner.Scan() {
return nil
}
for {
_, err := out.WriteString(strings.TrimPrefix(scanner.Text(), prefix))
if err != nil {
return err
if _, err = out.WriteString(strings.TrimPrefix(scanner.Text(), prefix)); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}
// Avoid writing a newline in case the previous line was the last in target.
if !scanner.Scan() {
break
}
if _, err := out.WriteString("\n"); err != nil {
return err
if _, err = out.WriteString("\n"); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}
}

_, err = out.Write(content[idx+len(target):])
if err != nil {
return err
if _, err = out.Write(content[idx+len(target):]); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}

// false positive
// nolint:gosec
return os.WriteFile(filename, out.Bytes(), 0644)
if err = os.WriteFile(filename, out.Bytes(), 0644); err != nil {
return fmt.Errorf("failed to write file %q: %w", filename, err)
}

return nil
}
27 changes: 15 additions & 12 deletions docs/book/src/getting-started/testdata/project/test/utils/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ func GetNonEmptyLines(output string) []string {
func GetProjectDir() (string, error) {
wd, err := os.Getwd()
if err != nil {
return wd, err
return wd, fmt.Errorf("failed to get current working directory: %w", err)
}
wd = strings.Replace(wd, "/test/e2e", "", -1)
return wd, nil
Expand All @@ -208,7 +208,7 @@ func UncommentCode(filename, target, prefix string) error {
// nolint:gosec
content, err := os.ReadFile(filename)
if err != nil {
return err
return fmt.Errorf("failed to read file %q: %w", filename, err)
}
strContent := string(content)

Expand All @@ -220,32 +220,35 @@ func UncommentCode(filename, target, prefix string) error {
out := new(bytes.Buffer)
_, err = out.Write(content[:idx])
if err != nil {
return err
return fmt.Errorf("failed to write to output: %w", err)
}

scanner := bufio.NewScanner(bytes.NewBufferString(target))
if !scanner.Scan() {
return nil
}
for {
_, err := out.WriteString(strings.TrimPrefix(scanner.Text(), prefix))
if err != nil {
return err
if _, err = out.WriteString(strings.TrimPrefix(scanner.Text(), prefix)); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}
// Avoid writing a newline in case the previous line was the last in target.
if !scanner.Scan() {
break
}
if _, err := out.WriteString("\n"); err != nil {
return err
if _, err = out.WriteString("\n"); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}
}

_, err = out.Write(content[idx+len(target):])
if err != nil {
return err
if _, err = out.Write(content[idx+len(target):]); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}

// false positive
// nolint:gosec
return os.WriteFile(filename, out.Bytes(), 0644)
if err = os.WriteFile(filename, out.Bytes(), 0644); err != nil {
return fmt.Errorf("failed to write file %q: %w", filename, err)
}

return nil
}
27 changes: 15 additions & 12 deletions docs/book/src/multiversion-tutorial/testdata/project/test/utils/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ func GetNonEmptyLines(output string) []string {
func GetProjectDir() (string, error) {
wd, err := os.Getwd()
if err != nil {
return wd, err
return wd, fmt.Errorf("failed to get current working directory: %w", err)
}
wd = strings.Replace(wd, "/test/e2e", "", -1)
return wd, nil
Expand All @@ -208,7 +208,7 @@ func UncommentCode(filename, target, prefix string) error {
// nolint:gosec
content, err := os.ReadFile(filename)
if err != nil {
return err
return fmt.Errorf("failed to read file %q: %w", filename, err)
}
strContent := string(content)

Expand All @@ -220,32 +220,35 @@ func UncommentCode(filename, target, prefix string) error {
out := new(bytes.Buffer)
_, err = out.Write(content[:idx])
if err != nil {
return err
return fmt.Errorf("failed to write to output: %w", err)
}

scanner := bufio.NewScanner(bytes.NewBufferString(target))
if !scanner.Scan() {
return nil
}
for {
_, err := out.WriteString(strings.TrimPrefix(scanner.Text(), prefix))
if err != nil {
return err
if _, err = out.WriteString(strings.TrimPrefix(scanner.Text(), prefix)); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}
// Avoid writing a newline in case the previous line was the last in target.
if !scanner.Scan() {
break
}
if _, err := out.WriteString("\n"); err != nil {
return err
if _, err = out.WriteString("\n"); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}
}

_, err = out.Write(content[idx+len(target):])
if err != nil {
return err
if _, err = out.Write(content[idx+len(target):]); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}

// false positive
// nolint:gosec
return os.WriteFile(filename, out.Bytes(), 0644)
if err = os.WriteFile(filename, out.Bytes(), 0644); err != nil {
return fmt.Errorf("failed to write file %q: %w", filename, err)
}

return nil
}
28 changes: 15 additions & 13 deletions pkg/plugins/golang/v4/scaffolds/internal/templates/test/utils/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,21 +222,20 @@ func GetNonEmptyLines(output string) []string {
func GetProjectDir() (string, error) {
wd, err := os.Getwd()
if err != nil {
return wd, err
return wd, fmt.Errorf("failed to get current working directory: %w", err)
}
wd = strings.Replace(wd, "/test/e2e", "", -1)
return wd, nil
}


// UncommentCode searches for target in the file and remove the comment prefix
// of the target content. The target content may span multiple lines.
func UncommentCode(filename, target, prefix string) error {
// false positive
// nolint:gosec
content, err := os.ReadFile(filename)
if err != nil {
return err
return fmt.Errorf("failed to read file %q: %w", filename, err)
}
strContent := string(content)

Expand All @@ -248,33 +247,36 @@ func UncommentCode(filename, target, prefix string) error {
out := new(bytes.Buffer)
_, err = out.Write(content[:idx])
if err != nil {
return err
return fmt.Errorf("failed to write to output: %w", err)
}

scanner := bufio.NewScanner(bytes.NewBufferString(target))
if !scanner.Scan() {
return nil
}
for {
_, err := out.WriteString(strings.TrimPrefix(scanner.Text(), prefix))
if err != nil {
return err
if _, err = out.WriteString(strings.TrimPrefix(scanner.Text(), prefix)); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}
// Avoid writing a newline in case the previous line was the last in target.
if !scanner.Scan() {
break
}
if _, err := out.WriteString("\n"); err != nil {
return err
if _, err = out.WriteString("\n"); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}
}

_, err = out.Write(content[idx+len(target):])
if err != nil {
return err
if _, err = out.Write(content[idx+len(target):]); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}

// false positive
// nolint:gosec
return os.WriteFile(filename, out.Bytes(), 0644)
if err = os.WriteFile(filename, out.Bytes(), 0644); err != nil {
return fmt.Errorf("failed to write file %q: %w", filename, err)
}

return nil
}
`
27 changes: 15 additions & 12 deletions testdata/project-v4-multigroup/test/utils/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ func GetNonEmptyLines(output string) []string {
func GetProjectDir() (string, error) {
wd, err := os.Getwd()
if err != nil {
return wd, err
return wd, fmt.Errorf("failed to get current working directory: %w", err)
}
wd = strings.Replace(wd, "/test/e2e", "", -1)
return wd, nil
Expand All @@ -208,7 +208,7 @@ func UncommentCode(filename, target, prefix string) error {
// nolint:gosec
content, err := os.ReadFile(filename)
if err != nil {
return err
return fmt.Errorf("failed to read file %q: %w", filename, err)
}
strContent := string(content)

Expand All @@ -220,32 +220,35 @@ func UncommentCode(filename, target, prefix string) error {
out := new(bytes.Buffer)
_, err = out.Write(content[:idx])
if err != nil {
return err
return fmt.Errorf("failed to write to output: %w", err)
}

scanner := bufio.NewScanner(bytes.NewBufferString(target))
if !scanner.Scan() {
return nil
}
for {
_, err := out.WriteString(strings.TrimPrefix(scanner.Text(), prefix))
if err != nil {
return err
if _, err = out.WriteString(strings.TrimPrefix(scanner.Text(), prefix)); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}
// Avoid writing a newline in case the previous line was the last in target.
if !scanner.Scan() {
break
}
if _, err := out.WriteString("\n"); err != nil {
return err
if _, err = out.WriteString("\n"); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}
}

_, err = out.Write(content[idx+len(target):])
if err != nil {
return err
if _, err = out.Write(content[idx+len(target):]); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}

// false positive
// nolint:gosec
return os.WriteFile(filename, out.Bytes(), 0644)
if err = os.WriteFile(filename, out.Bytes(), 0644); err != nil {
return fmt.Errorf("failed to write file %q: %w", filename, err)
}

return nil
}
27 changes: 15 additions & 12 deletions testdata/project-v4-with-plugins/test/utils/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ func GetNonEmptyLines(output string) []string {
func GetProjectDir() (string, error) {
wd, err := os.Getwd()
if err != nil {
return wd, err
return wd, fmt.Errorf("failed to get current working directory: %w", err)
}
wd = strings.Replace(wd, "/test/e2e", "", -1)
return wd, nil
Expand All @@ -208,7 +208,7 @@ func UncommentCode(filename, target, prefix string) error {
// nolint:gosec
content, err := os.ReadFile(filename)
if err != nil {
return err
return fmt.Errorf("failed to read file %q: %w", filename, err)
}
strContent := string(content)

Expand All @@ -220,32 +220,35 @@ func UncommentCode(filename, target, prefix string) error {
out := new(bytes.Buffer)
_, err = out.Write(content[:idx])
if err != nil {
return err
return fmt.Errorf("failed to write to output: %w", err)
}

scanner := bufio.NewScanner(bytes.NewBufferString(target))
if !scanner.Scan() {
return nil
}
for {
_, err := out.WriteString(strings.TrimPrefix(scanner.Text(), prefix))
if err != nil {
return err
if _, err = out.WriteString(strings.TrimPrefix(scanner.Text(), prefix)); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}
// Avoid writing a newline in case the previous line was the last in target.
if !scanner.Scan() {
break
}
if _, err := out.WriteString("\n"); err != nil {
return err
if _, err = out.WriteString("\n"); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}
}

_, err = out.Write(content[idx+len(target):])
if err != nil {
return err
if _, err = out.Write(content[idx+len(target):]); err != nil {
return fmt.Errorf("failed to write to output: %w", err)
}

// false positive
// nolint:gosec
return os.WriteFile(filename, out.Bytes(), 0644)
if err = os.WriteFile(filename, out.Bytes(), 0644); err != nil {
return fmt.Errorf("failed to write file %q: %w", filename, err)
}

return nil
}
Loading