Skip to content

🌱 Add filename to clusterctl error about bad YAML #12189

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
May 13, 2025
Merged

🌱 Add filename to clusterctl error about bad YAML #12189

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
2 changes: 1 addition & 1 deletion cmd/clusterctl/cmd/version_checker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ func (v *versionChecker) getLatestRelease(ctx context.Context) (*ReleaseInfo, er
// NOTE: local state file is ignored if older than 1d.
vs, err := readStateFile(v.versionFilePath)
if err != nil {
return nil, errors.Wrap(err, "unable to read version state file")
return nil, errors.Wrapf(err, "unable to read version state file %s", v.versionFilePath)
}
if vs != nil {
return &vs.LatestRelease, nil
Expand Down
28 changes: 28 additions & 0 deletions cmd/clusterctl/cmd/version_checker_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,34 @@ func TestVersionChecker_ReadFromStateFileWithin24Hrs(t *testing.T) {
g.Expect(release.URL).To(Equal("https://github.com/foo/bar/releases/v0.3.10"))
}

func TestVersionChecker_ReadFromCorruptedStateFile(t *testing.T) {
g := NewWithT(t)

ctx := context.Background()

tmpVersionFile, cleanDir := generateTempVersionFilePath(g)
defer cleanDir()

// Create a corrupted YAML state file
corruptedVersionState := []byte(`LastCheck: "2025-02-11T09:56:59.8701-07:00"
LatestRelease:
URL: sigs.k8s.io/cluster-api
Version: 1.9.4
4
`)
g.Expect(os.MkdirAll(filepath.Dir(tmpVersionFile), 0750)).To(Succeed())
g.Expect(os.WriteFile(tmpVersionFile, corruptedVersionState, 0600)).To(Succeed())

versionChecker, err := newVersionChecker(ctx, test.NewFakeVariableClient())
g.Expect(err).ToNot(HaveOccurred())
versionChecker.versionFilePath = tmpVersionFile

// Expect the checker to raise an error containing the state file path
_, err = versionChecker.Check(ctx)
g.Expect(err).To(HaveOccurred())
g.Expect(err.Error()).To(ContainSubstring(versionChecker.versionFilePath))
}

func generateTempVersionFilePath(g *WithT) (string, func()) {
dir, err := os.MkdirTemp("", "clusterctl")
g.Expect(err).ToNot(HaveOccurred())
Expand Down