Skip to content
This repository was archived by the owner on Jan 13, 2026. It is now read-only.

Commit 4a7ab79

Browse files
antgamdiaantgamdia
authored
Consistent log/error capitalization (#6673)
### Description of the change The log traces and the error messages have an inconsistent capitalization across the codebase; this PR is to fix it. I have used some regexes like `fmt.(New|Debug|Warn||Warning|Info|Error|Fatal|Panic)(f?)(S?)\(("|')\p{Ll}`, `connect\.\w+, fmt.(New|Debug|Warn||Warning|Info|Error|Fatal|Panic)(f?)(S?)\(("|')\p{Ll}` to find any possible offending occurrence. The rationale behind the transformation is: - fmt.errorf -> lowercase - exception: those errors using connect.... will be returned to the user, these ones remain capitalized (converted some existing ones which wasn't) - log.xxxx -> uppercase ### Benefits Consistent capitalization. ### Possible drawbacks Some tests might fail, but will fix them straight away. ### Applicable issues - fixes #6672 ### Additional information The next step would be unifying the actual messages, but this is another yak to shave... --------- Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
1 parent 5f1b3d1 commit 4a7ab79

52 files changed

Lines changed: 358 additions & 424 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎cmd/apprepository-controller/cmd/root.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func newRootCmd() *cobra.Command {
3131
Short: "Apprepository-controller is a Kubernetes controller for managing package repositories added to Kubeapps.",
3232
PreRun: func(cmd *cobra.Command, args []string) {
3333
initServerOpts()
34-
log.Infof("Apprepository-controller has been configured with: %#v", serveOpts)
34+
log.InfoS("The component 'apprepository-controller' has been configured with", "serverOptions", serveOpts)
3535
},
3636
RunE: func(cmd *cobra.Command, args []string) error {
3737

‎cmd/apprepository-controller/server/controller.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ func NewController(
139139
},
140140
})
141141
if err != nil {
142-
log.Warningf("error adding AppRepository event handler: %v", err)
142+
log.Warningf("Error adding AppRepository event handler: %v", err)
143143
}
144144

145145
controller.setBatchLister(conf.V1Beta1CronJobs, kubeInformerFactory)

‎cmd/asset-syncer/cmd/root.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ func newRootCmd() *cobra.Command {
2929
serveOpts.UserAgent = server.GetUserAgent(version, serveOpts.UserAgentComment)
3030
serveOptsCopy := serveOpts
3131
serveOptsCopy.DatabasePassword = "REDACTED"
32-
log.Infof("asset-syncer has been configured with: %#v", serveOptsCopy)
32+
log.InfoS("The component 'asset-syncer' has been configured with", "serverOptions", serveOptsCopy)
3333
},
3434
Version: "devel",
3535
}

‎cmd/asset-syncer/server/delete.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,17 @@ func Delete(serveOpts Config, args []string) error {
1919
dbConfig := dbutils.Config{URL: serveOpts.DatabaseURL, Database: serveOpts.DatabaseName, Username: serveOpts.DatabaseUser, Password: serveOpts.DatabasePassword}
2020
manager, err := newManager(dbConfig, serveOpts.GlobalPackagingNamespace)
2121
if err != nil {
22-
return fmt.Errorf("Error file creating a manager: %v", err)
22+
return fmt.Errorf("error file creating a manager: %v", err)
2323
}
2424
err = manager.Init()
2525
if err != nil {
26-
return fmt.Errorf("Error file initializing the manager: %v", err)
26+
return fmt.Errorf("error file initializing the manager: %v", err)
2727
}
2828
defer manager.Close()
2929

3030
repo := models.Repo{Name: args[0], Namespace: serveOpts.Namespace}
3131
if err = manager.Delete(repo); err != nil {
32-
return fmt.Errorf("Can't delete chart repository %s from database: %v", args[0], err)
32+
return fmt.Errorf("can't delete chart repository %s from database: %v", args[0], err)
3333
}
3434

3535
log.Infof("Successfully deleted the chart repository %s from database", args[0])

‎cmd/asset-syncer/server/invalidate-cache.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,23 @@ import (
1212

1313
func InvalidateCache(serveOpts Config, args []string) error {
1414
if len(args) != 0 {
15-
return fmt.Errorf("This command does not take any arguments (got %v)", len(args))
15+
return fmt.Errorf("this command does not take any arguments (got %v)", len(args))
1616
}
1717

1818
dbConfig := dbutils.Config{URL: serveOpts.DatabaseURL, Database: serveOpts.DatabaseName, Username: serveOpts.DatabaseUser, Password: serveOpts.DatabasePassword}
1919
manager, err := newManager(dbConfig, serveOpts.GlobalPackagingNamespace)
2020
if err != nil {
21-
return fmt.Errorf("Error: %v", err)
21+
return fmt.Errorf("error: %v", err)
2222
}
2323
err = manager.Init()
2424
if err != nil {
25-
return fmt.Errorf("Error: %v", err)
25+
return fmt.Errorf("error: %v", err)
2626
}
2727
defer manager.Close()
2828

2929
err = manager.InvalidateCache()
3030
if err != nil {
31-
return fmt.Errorf("Error: %v", err)
31+
return fmt.Errorf("error: %v", err)
3232
}
3333
log.Infof("Successfully invalidated cache")
3434
return nil

‎cmd/asset-syncer/server/sync.go‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,24 @@ import (
1717

1818
func Sync(serveOpts Config, version string, args []string) error {
1919
if len(args) != 3 {
20-
return fmt.Errorf("Need exactly three arguments: [REPO NAME] [REPO URL] [REPO TYPE] (got %v)", len(args))
20+
return fmt.Errorf("need exactly three arguments: [REPO NAME] [REPO URL] [REPO TYPE] (got %v)", len(args))
2121
}
2222

2323
dbConfig := dbutils.Config{URL: serveOpts.DatabaseURL, Database: serveOpts.DatabaseName, Username: serveOpts.DatabaseUser, Password: serveOpts.DatabasePassword}
2424
globalPackagingNamespace := serveOpts.GlobalPackagingNamespace
2525
manager, err := newManager(dbConfig, globalPackagingNamespace)
2626
if err != nil {
27-
return fmt.Errorf("Error: %v", err)
27+
return fmt.Errorf("error: %v", err)
2828
}
2929
err = manager.Init()
3030
if err != nil {
31-
return fmt.Errorf("Error: %v", err)
31+
return fmt.Errorf("error: %v", err)
3232
}
3333
defer manager.Close()
3434

3535
netClient, err := httpclient.NewWithCertFile(additionalCAFile, serveOpts.TlsInsecureSkipVerify)
3636
if err != nil {
37-
return fmt.Errorf("Error: %v", err)
37+
return fmt.Errorf("error: %v", err)
3838
}
3939

4040
authorizationHeader := serveOpts.AuthorizationHeader
@@ -43,17 +43,17 @@ func Sync(serveOpts Config, version string, args []string) error {
4343
dockerConfig := &kube.DockerConfigJSON{}
4444
err = json.Unmarshal([]byte(serveOpts.DockerConfigJson), dockerConfig)
4545
if err != nil {
46-
return fmt.Errorf("Error: %v", err)
46+
return fmt.Errorf("error: %v", err)
4747
}
4848
authorizationHeader, err = kube.GetAuthHeaderFromDockerConfig(dockerConfig)
4949
if err != nil {
50-
return fmt.Errorf("Error: %v", err)
50+
return fmt.Errorf("error: %v", err)
5151
}
5252
}
5353

5454
filters, err := parseFilters(serveOpts.FilterRules)
5555
if err != nil {
56-
return fmt.Errorf("Error: %v", err)
56+
return fmt.Errorf("error: %v", err)
5757
}
5858

5959
var repoIface Repo
@@ -63,12 +63,12 @@ func Sync(serveOpts Config, version string, args []string) error {
6363
repoIface, err = getOCIRepo(serveOpts.Namespace, args[0], args[1], authorizationHeader, filters, serveOpts.OciRepositories, netClient)
6464
}
6565
if err != nil {
66-
return fmt.Errorf("Error: %v", err)
66+
return fmt.Errorf("error: %v", err)
6767
}
6868
repo := repoIface.Repo()
6969
checksum, err := repoIface.Checksum()
7070
if err != nil {
71-
return fmt.Errorf("Error: %v", err)
71+
return fmt.Errorf("error: %v", err)
7272
}
7373

7474
// Check if the repo has been already processed
@@ -92,14 +92,14 @@ func Sync(serveOpts Config, version string, args []string) error {
9292
for _, fetchLatestOnly := range fetchLatestOnlySlice {
9393
charts, err := repoIface.Charts(fetchLatestOnly)
9494
if err != nil {
95-
return fmt.Errorf("Error: %v", err)
95+
return fmt.Errorf("error: %v", err)
9696
}
9797
if len(charts) == 0 {
9898
log.Infof("No charts in repository to be synced, repo.URL= %v", repo.URL)
9999
return nil
100100
}
101101
if err = manager.Sync(models.Repo{Name: repo.Name, Namespace: repo.Namespace}, charts); err != nil {
102-
return fmt.Errorf("Can't add chart repository to database: %v", err)
102+
return fmt.Errorf("can't add chart repository to database: %v", err)
103103
}
104104

105105
// Fetch and store chart icons
@@ -111,7 +111,7 @@ func Sync(serveOpts Config, version string, args []string) error {
111111

112112
// Update cache in the database
113113
if err = manager.UpdateLastCheck(repo.Namespace, repo.Name, checksum, time.Now()); err != nil {
114-
return fmt.Errorf("Error: %v", err)
114+
return fmt.Errorf("error: %v", err)
115115
}
116116

117117
log.Infof("Stored repository update in cache, repo.URL= %v", repo.URL)

0 commit comments

Comments
 (0)